Feature: Allow pinning conversations to the top (XEP-0469)

CHANGES.md

@@ -26,6 +26,7 @@
 - #3941: add adhoc completed command result and text-multi as merged lines of text
 - #3989: properly display occupant hats in details dialog
 - Don't render unfurls for retracted messages.
+- #3949: Allow pinning bookmarked conversations to the top (XEP-0469)
 
 ## 12.0.0 (2025-08-28)
 

src/headless/plugins/bookmarks/collection.js

@@ -82,6 +82,7 @@ class Bookmarks extends Collection {
             const groupchat = await api.rooms.create(bookmark.get('jid'), {
                 nick: bookmark.get('nick'),
                 password: bookmark.get('password'),
+                pinned: bookmark.get('pinned'),
             });
             groupchat.maybeShow();
         }
@@ -250,7 +251,7 @@ class Bookmarks extends Collection {
     markRoomAsBookmarked(bookmark) {
         const { chatboxes } = _converse.state;
         const groupchat = chatboxes.get(bookmark.get('jid'));
-        groupchat?.save('bookmarked', true);
+        groupchat?.setBookmark(bookmark);
     }
 
     /**
@@ -334,6 +335,48 @@ class Bookmarks extends Collection {
         const { chatboxes } = _converse.state;
         return this.filter((b) => !chatboxes.get(b.get('jid')));
     }
+
+    /**
+     * 
+     * @param {Bookmark} bookmark
+     */
+    pinBookmark(bookmark) {
+        const extensions = [...bookmark.get('extensions'), `<pinned xmlns="${Strophe.NS.BOOKMARKS_PINNING}"/>`];
+
+        bookmark.set('pinned', true);
+
+        try {
+            api.bookmarks.set({
+                jid: bookmark.get('jid'),
+                extensions,
+            });
+        } catch (error) {
+            bookmark.set('pinned', false);
+            log.error('Error while trying to pin bookmark');
+            log.error(error);
+        }
+    }
+
+    /**
+     * 
+     * @param {Bookmark} bookmark
+     */
+    unpinBookmark(bookmark) {
+        const extensions = bookmark.get('extensions').filter(/** @param {String} e */ e => !(e.includes('<pinned')));
+
+        bookmark.set('pinned', false);
+
+        try {
+            api.bookmarks.set({
+                jid: bookmark.get('jid'),
+                extensions,
+            });
+        } catch (error) {
+            bookmark.set('pinned', true);
+            log.error('Error while trying to unpin bookmark');
+            log.error(error);
+        }
+    }
 }
 
 export default Bookmarks;

src/headless/plugins/bookmarks/model.js

@@ -4,6 +4,11 @@ import converse from '../../shared/api/public.js';
 const { Strophe } = converse.env;
 
 class Bookmark extends Model {
+    initialize() {
+        super.initialize();
+        this.attributes.pinned = this.get('extensions')?.some(/** @param {String} e */ e => e.includes('<pinned') && e.includes(Strophe.NS.BOOKMARKS_PINNING)) || false;
+    }
+
     get idAttribute() {
         return 'jid';
     }

src/headless/plugins/bookmarks/plugin.js

@@ -16,6 +16,7 @@ const { Strophe } = converse.env;
 
 Strophe.addNamespace('BOOKMARKS', 'storage:bookmarks');
 Strophe.addNamespace('BOOKMARKS2', 'urn:xmpp:bookmarks:1');
+Strophe.addNamespace('BOOKMARKS_PINNING', 'urn:xmpp:bookmarks-pinning:0');
 
 converse.plugins.add('converse-bookmarks', {
     dependencies: ['converse-chatboxes', 'converse-muc'],