Merge remote-tracking branch 'origin/master'

.eslintrc.json

@@ -184,7 +184,7 @@
         "no-underscore-dangle": "off",
         "no-unmodified-loop-condition": "error",
         "no-unneeded-ternary": "off",
-        "no-unused-vars": "error",
+        "no-unused-vars": ["error", { "argsIgnorePattern": "^_" }],
         "no-unused-expressions": "off",
         "no-use-before-define": "off",
         "no-useless-call": "error",

.github/workflows/xmpp-notify.yml

@@ -0,0 +1,44 @@
+name: 'XMPP Notifier'
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  notif-script:
+    runs-on: ubuntu-latest
+    name: job that pushes repo news to xmpp
+    steps:
+      - name: push_info_step
+        id: push
+        uses: conversejs/github-action-xmpp-notifier@master
+        if: github.event_name == 'push'
+        with: # Set the secrets as inputs
+          # jid expects the bot's bare jid (user@domain)
+          jid: ${{ secrets.jid }}
+          password: ${{ secrets.password }}
+          server_host: ${{ secrets.server_host }}
+          recipient: ${{ secrets.recipient }}
+          server_port: ${{ secrets.server_port }}
+          message: |
+            *${{ github.actor }}* pushed commits to ${{ github.event.ref }} with message(s):
+            > ${{ join(github.event.commits.*.message, '\n\n> ') }}
+
+            ${{ github.event.compare }}
+          recipient_is_room: true
+
+      - name: pr_open_info_step
+        id: pull_request_open
+        uses: conversejs/github-action-xmpp-notifier@master
+        if: github.event_name == 'pull_request' && github.event.action == 'opened'
+        with: # Set the secrets as inputs
+          jid: ${{ secrets.jid }}
+          password: ${{ secrets.password }}
+          server_host: ${{ secrets.server_host }}
+          recipient: ${{ secrets.recipient }}
+          message: |
+            *${{ github.actor }}* opened a PR ${{ github.event.pull_request.html_url }}
+            > ${{ github.event.pull_request.title }}
+          recipient_is_room: true

CHANGES.md

@@ -3,11 +3,25 @@
 ## 11.0.0 (Unreleased)
 
 - #2716: Fix issue with chat display when opening via URL
+- #3033: Add the `muc_grouped_by_domain` option to display MUCs on the same domain in collapsible groups
+- #3300: Adding the maxWait option for `debouncedPruneHistory`
+- #3302: debounce MUC sidebar rendering
+- #3307: Fix inconsistency between browsers on textarea outlines
+- Add an occupants filter to the MUC sidebar
+- Fix: MUC occupant list does not sort itself on nicknames or roles changes
+- Fix: refresh the MUC sidebar when participants collection is sorted
 
 ### Breaking changes:
 
 - Remove the old `_converse.BootstrapModal` in favor of `_converse.BaseModal` which is a web component.
 - The connection is no longer available on the `_converse` object. Instead, use `api.connection.get()`.
+- Add a new `exports` attribute on the `_converse` object which is meant for
+  providing access for 3rd party plugins to code (e.g. classes) from
+  converse.js. Some classes that were on the `_converse` object, like
+  `CustomElement` are not on `_converse.exports`.
+- The `windowStateChanged` event has been removed. If you used it, rely on the
+  `visibilitychange` event on `document` instead.
+- `api.modal.create` no longer takes a class, instead it takes the name of a custom DOM element.
 
 ## 10.1.6 (2023-08-31)
 

docs/source/builds.rst

@@ -48,8 +48,9 @@ One reason you might want to create your own bundles, is because you want to
 remove some of the core plugins of Converse, or perhaps you want to include
 your own.
 
-To add or remove plugins from the build, you need to modify the
-`src/converse.js <https://github.com/conversejs/converse.js/blob/master/src/converse.js>`_ file.
+To add or remove plugins from the build, you need to modify
+`src/index.js <https://github.com/conversejs/converse.js/blob/master/src/index.js>`_ or
+`src/headless/index.js <https://github.com/conversejs/converse.js/blob/master/src/index.js>`_.
 
 You'll find a section marked ``/* START: Removable components`` and
 ``/* END: Removable components */``.

docs/source/configuration.rst

@@ -1278,6 +1278,14 @@ By fetching member lists, Converse.js will always show these users as
 participants of the MUC, giving them a permanent "presence" in the MUC.
 
 
+muc_grouped_by_domain
+---------------------
+
+* Default: ``false``
+
+If ``true``, displays MUCS of a same domain together, in collapsible groups.
+
+
 muc_history_max_stanzas
 -----------------------
 

docs/source/plugin_development.rst

@@ -351,7 +351,7 @@ All configuration settings have default values which can be overridden when
 gets called.
 
 Plugins often need their own additional configuration settings and you can add
-these settings with the `_converse.api.settings.update </docs/html/api/-_converse.api.settings.html#.update>`_
+these settings with the `_converse.api.settings.extend </docs/html/api/-_converse.api.settings.html#.extend>`_
 method.
 
 Exposing promises
@@ -455,12 +455,13 @@ Hooks
 -----
 
 Converse has the concept of ``hooks``, which are special events that allow you
-to modify it's behaviour at runtime.
+to modify behaviour at runtime.
 
 A hook is similar to an event, but it differs in two meaningful ways:
 
 1. Converse will wait for all handlers of a hook to finish before continuing inside the function from where the hook was triggered.
-2. Each hook contains a payload, which the handlers can modify or extend, before returning it (either to the function that triggered the hook or to subsequent handlers).
+2. Each hook contains a payload, which the handlers can modify or extend, before returning it
+   (either to the function that triggered the hook or to subsequent handlers).
 
 These two properties of hooks makes it possible for 3rd party plugins to
 intercept and update data, allowing them to modify Converse without the need of

karma.conf.js

@@ -92,6 +92,7 @@ module.exports = function(config) {
       { pattern: "src/plugins/muc-views/tests/muc-registration.js", type: 'module' },
       { pattern: "src/plugins/muc-views/tests/muc.js", type: 'module' },
       { pattern: "src/plugins/muc-views/tests/nickname.js", type: 'module' },
+      { pattern: "src/plugins/muc-views/tests/occupants-filter.js", type: 'module' },
       { pattern: "src/plugins/muc-views/tests/occupants.js", type: 'module' },
       { pattern: "src/plugins/muc-views/tests/rai.js", type: 'module' },
       { pattern: "src/plugins/muc-views/tests/retractions.js", type: 'module' },
@@ -110,6 +111,7 @@ module.exports = function(config) {
       { pattern: "src/plugins/push/tests/push.js", type: 'module' },
       { pattern: "src/plugins/register/tests/register.js", type: 'module' },
       { pattern: "src/plugins/roomslist/tests/roomslist.js", type: 'module' },
+      { pattern: "src/plugins/roomslist/tests/grouplists.js", type: 'module' },
       { pattern: "src/plugins/rootview/tests/root.js", type: 'module' },
       { pattern: "src/plugins/rosterview/tests/add-contact-modal.js", type: 'module' },
       { pattern: "src/plugins/rosterview/tests/presence.js", type: 'module' },