@sockethub/platform-xmpp 5.0.0-alpha.12 → 5.0.0-alpha.13

package/dist/schema.d.ts

@@ -0,0 +1,2 @@
+import type { PlatformSchemaStruct } from "@sockethub/schemas";
+export declare const PlatformSchema: PlatformSchemaStruct;

package/dist/types.d.ts

@@ -0,0 +1,33 @@
+import type { ActivityActor, CredentialsObject, Logger, PlatformSendToClient, PlatformSession } from "@sockethub/schemas";
+export interface XmppPlatformSession extends PlatformSession {
+    id: string;
+}
+export interface XmppCredentialsObject extends CredentialsObject {
+    object: {
+        type: string;
+        userAddress: string;
+        password: string;
+        server?: string;
+        port?: number;
+        resource: string;
+    };
+}
+export interface XmppBuiltCredentials {
+    service: string;
+    username: string;
+    password: string;
+    resource?: string;
+}
+/**
+ * Narrow interface for what IncomingHandlers uses from the XMPP platform instance.
+ * Avoids a circular import between incoming-handlers.ts and index.ts.
+ */
+export interface XmppHandlerSession {
+    log: Logger;
+    sendToClient: PlatformSendToClient;
+    __knownRooms: Set<string>;
+    actor?: ActivityActor;
+    connection?: {
+        disconnect?: () => void;
+    };
+}

package/dist/utils.d.ts

@@ -0,0 +1,19 @@
+import type { XmppElement } from "@xmpp/client";
+import type { XmppBuiltCredentials, XmppCredentialsObject } from "./types.js";
+interface XDataFieldResult {
+    var: string;
+    field: {
+        type: string;
+        label?: string;
+        value: string | number | boolean | string[] | null;
+        options?: Array<{
+            label: string;
+            value: string;
+        }>;
+    };
+}
+export declare const utils: {
+    buildXmppCredentials: (credentials: XmppCredentialsObject) => XmppBuiltCredentials;
+    parseXDataField: (field: XmppElement) => XDataFieldResult | null;
+};
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sockethub/platform-xmpp",
   "description": "A sockethub platform module implementing XMPP functionality",
-  "version": "5.0.0-alpha.12",
+  "version": "5.0.0-alpha.13",
   "private": false,
   "type": "module",
   "author": "Nick Jennings <nick@silverbucket.net>",
@@ -12,17 +12,16 @@
   "main": "dist/index.js",
   "exports": {
     ".": {
-      "bun": "./src/index.js",
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "default": "./dist/index.js"
     }
   },
   "files": [
-    "src/",
     "dist/"
   ],
   "engines": {
-    "bun": ">=1.2"
+    "node": ">=20"
   },
   "keywords": [
     "sockethub",
@@ -40,27 +39,31 @@
   },
   "homepage": "https://github.com/sockethub/sockethub/tree/master/packages/platform-xmpp",
   "scripts": {
-    "build": "bun build src/index.js --outdir dist --target node --format esm --sourcemap=external",
+    "build": "bun build src/index.ts --outdir dist --target node --format esm --sourcemap=external",
     "clean": "rm -rf dist",
     "clean:deps": "rm -rf node_modules",
-    "doc": "jsdoc2md --no-gfm --heading-depth 1 src/index.js > API.md"
+    "doc": "typedoc --options typedoc.json"
   },
   "dependencies": {
+    "@sockethub/util": "^1.0.0-alpha.1",
     "@xmpp/client": "^0.13.6"
   },
   "devDependencies": {
-    "@sockethub/schemas": "^3.0.0-alpha.12",
+    "@sockethub/schemas": "^3.0.0-alpha.13",
+    "@types/bun": "latest",
     "@xmpp/xml": "^0.13.2",
-    "jsdoc-to-markdown": "^8.0.3",
-    "sinon": "^17.0.2"
+    "ajv": "^8.17.1",
+    "sinon": "^17.0.2",
+    "typedoc": "^0.28.14"
   },
   "peerDependencies": {
-    "@sockethub/server": "^5.0.0-alpha.12"
+    "@sockethub/server": "^5.0.0-alpha.13"
   },
   "peerDependenciesMeta": {
     "@sockethub/server": {
       "optional": true
     }
   },
-  "gitHead": "f039dab3c3f67cbbf204476fc397532e973f82a8"
+  "gitHead": "864733e5b34449ef39542eceb4ff11aa308081bc",
+  "types": "./dist/index.d.ts"
 }

package/src/incoming-handlers.js

@@ -1,355 +0,0 @@
-import { buildCanonicalContext } from "@sockethub/schemas";
-import { PlatformSchema } from "./schema.js";
-
-const XMPP_CONTEXT = buildCanonicalContext(PlatformSchema.contextUrl);
-
-function getMessageBody(stanza) {
-    for (const elem of stanza.children) {
-        if (elem.name === "body") {
-            return elem.children.join(" ");
-        }
-    }
-}
-
-function getMessageTimestamp(stanza) {
-    try {
-        const delay = stanza.children.find((c) => c.name === "delay");
-        return delay.attrs.stamp;
-    } catch (_e) {
-        // no timestamp
-        return null;
-    }
-}
-
-function getMessageId(stanza) {
-    try {
-        return stanza.attrs.id;
-    } catch (_e) {
-        // no message id
-        return null;
-    }
-}
-
-function getMessageStanzaId(stanza) {
-    try {
-        const stanzaId = stanza.children.find((c) => c.name === "stanza-id");
-        return stanzaId.attrs.id;
-    } catch (_e) {
-        // no stanza id
-        return null;
-    }
-}
-
-function getMessageReplaceId(stanza) {
-    try {
-        const replaceEl = stanza.children.find((c) => c.name === "replace");
-        return replaceEl.attrs.id;
-    } catch (_e) {
-        // no origin id
-        return null;
-    }
-}
-
-function getPresence(stanza) {
-    if (stanza.getChild("show")) {
-        return stanza.getChild("show").getText();
-    }
-    return stanza.attrs.type === "unavailable" ? "offline" : "online";
-}
-
-export class IncomingHandlers {
-    constructor(session) {
-        this.session = session;
-    }
-
-    close() {
-        if (!this.session) {
-            console.debug("close event received but session is undefined");
-            return;
-        }
-
-        this.session.log.debug(
-            "received close event with no handler specified",
-        );
-        if (this.session.actor && this.session.sendToClient) {
-            this.session.sendToClient({
-                "@context": XMPP_CONTEXT,
-                type: "close",
-                actor: this.session.actor,
-                target: this.session.actor,
-            });
-            this.session.log.debug(
-                `**** xmpp this.session.for ${this.session.actor.id} closed`,
-            );
-        }
-        if (
-            this.session.connection &&
-            typeof this.session.connection.disconnect === "function"
-        ) {
-            this.session.connection.disconnect();
-        }
-    }
-
-    error(err) {
-        try {
-            this.session.sendToClient({
-                "@context": XMPP_CONTEXT,
-                type: "error",
-                error: err.text || err.toString(),
-                object: {
-                    type: "message",
-                    condition: err.condition || "unknown",
-                },
-            });
-        } catch (e) {
-            this.session.log.debug("*** XMPP ERROR (rl catch): ", e);
-        }
-    }
-
-    presence(stanza) {
-        const obj = {
-            "@context": XMPP_CONTEXT,
-            type: "update",
-            actor: {
-                type: "person",
-                id: stanza.attrs.from,
-            },
-            object: {
-                type: "presence",
-            },
-        };
-        if (stanza.getChildText("status")) {
-            obj.object.content = stanza.getChildText("status");
-        }
-        obj.object.presence = getPresence(stanza);
-        if (stanza.attrs.to) {
-            obj.target = { id: stanza.attrs.to, type: "person" };
-        } else {
-            obj.actor.name = stanza.attrs.from.split("/")[1];
-        }
-        this.session.log.debug(
-            `received contact presence update from ${stanza.attrs.from}`,
-        );
-        this.session.sendToClient(obj);
-    }
-
-    subscribe(to, from, name) {
-        this.session.log.debug(`received subscribe request from ${from}`);
-        const actor = { id: from, type: "person" };
-        if (name) {
-            actor.name = name;
-        }
-        this.session.sendToClient({
-            "@context": XMPP_CONTEXT,
-            type: "request-friend",
-            actor: actor,
-            target: to,
-        });
-    }
-
-    // unsubscribe(from) {
-    //   this.session.log.debug('received unsubscribe request from ' + from);
-    //   this.session.sendToClient({
-    //     type: "remove-friend",
-    //     actor: { id: from },
-    //     target: this.session.actor
-    //   });
-    // }
-
-    notifyChatMessage(stanza) {
-        const message = getMessageBody(stanza);
-        if (!message) {
-            return;
-        }
-        const from = stanza.attrs.from;
-        const timestamp = getMessageTimestamp(stanza);
-        const messageId = getMessageId(stanza);
-        const type = stanza.attrs.type === "groupchat" ? "room" : "person";
-
-        const activity = {
-            "@context": XMPP_CONTEXT,
-            type: "send",
-            actor: {
-                type: "person",
-                id: from,
-            },
-            target: {
-                type: type,
-                id: stanza.attrs.to,
-            },
-            object: {
-                type: "message",
-                id: messageId,
-                content: message,
-            },
-        };
-
-        const messageStanzaId = getMessageStanzaId(stanza);
-        if (messageStanzaId) {
-            activity.object["xmpp:stanza-id"] = messageStanzaId;
-        }
-
-        const messageReplaceId = getMessageReplaceId(stanza);
-        if (messageReplaceId) {
-            activity.object["xmpp:replace"] = { id: messageReplaceId };
-        }
-
-        if (type === "room") {
-            [activity.target.id, activity.actor.name] = from.split("/");
-        }
-
-        if (timestamp) {
-            activity.published = new Date(timestamp).toISOString();
-        }
-
-        this.session.sendToClient(activity);
-    }
-
-    notifyError(stanza) {
-        const error = stanza.getChild("error");
-        let message = stanza.toString();
-        let type = "message";
-        if (stanza.is("presence")) {
-            type = "update";
-        }
-
-        if (error) {
-            message = error.toString();
-            if (error.getChild("remote-server-not-found")) {
-                // when we get this.session.type of return message, we know it was a response from a join
-                type = "join";
-                message = `remote server not found ${stanza.attrs.from}`;
-            }
-        }
-
-        this.session.sendToClient({
-            "@context": XMPP_CONTEXT,
-            type: type,
-            actor: {
-                id: stanza.attrs.from,
-                type: "room",
-            },
-            error: message,
-            target: {
-                id: stanza.attrs.to,
-                type: "person",
-            },
-        });
-    }
-
-    notifyRoomAttendance(stanza) {
-        const query = stanza.getChild("query");
-        if (query) {
-            const members = [];
-            const entries = query.getChildren("item");
-            for (const e in entries) {
-                if (!Object.hasOwn(entries, e)) {
-                    continue;
-                }
-                members.push(entries[e].attrs.name);
-            }
-
-            this.session.sendToClient({
-                "@context": XMPP_CONTEXT,
-                type: "query",
-                actor: {
-                    id: stanza.attrs.from,
-                    type: "room",
-                },
-                target: {
-                    id: stanza.attrs.to,
-                    type: "person",
-                },
-                object: {
-                    type: "attendance",
-                    members: members,
-                },
-            });
-        }
-    }
-
-    online() {
-        this.session.log.debug("online");
-    }
-
-    /**
-     * Handles all unknown conditions that we don't have an explicit handler for
-     **/
-    stanza(stanza) {
-        // console.log("incoming stanza ", stanza);
-        if (stanza.attrs.type === "error") {
-            this.notifyError(stanza);
-        } else if (stanza.is("message")) {
-            this.notifyChatMessage(stanza);
-        } else if (stanza.is("presence")) {
-            this.presence(stanza);
-        } else if (stanza.is("iq")) {
-            if (
-                stanza.attrs.id === "muc_id" &&
-                stanza.attrs.type === "result"
-            ) {
-                this.session.log.debug("got room attendance list");
-                return this.notifyRoomAttendance(stanza);
-            }
-
-            // todo: clean up this area, unsure of what these are
-            const query = stanza.getChild("query");
-            if (query) {
-                const entries = query.getChildren("item");
-                for (const e in entries) {
-                    if (!entries.hasOwn(e)) {
-                        continue;
-                    }
-                    this.session.log.debug("STANZA ATTRS: ", entries[e].attrs);
-                    if (entries[e].attrs.subscription === "both") {
-                        this.session.sendToClient({
-                            "@context": XMPP_CONTEXT,
-                            type: "update",
-                            actor: {
-                                id: entries[e].attrs.jid,
-                                name: entries[e].attrs.name,
-                            },
-                            target: this.session.actor,
-                            object: {
-                                type: "presence",
-                                status: "",
-                                presence: getPresence(entries[e]),
-                            },
-                        });
-                    } else if (
-                        entries[e].attrs.subscription === "from" &&
-                        entries[e].attrs.ask &&
-                        entries[e].attrs.ask === "subscribe"
-                    ) {
-                        this.session.sendToClient({
-                            "@context": XMPP_CONTEXT,
-                            type: "update",
-                            actor: {
-                                id: entries[e].attrs.jid,
-                                name: entries[e].attrs.name,
-                            },
-                            target: this.session.actor,
-                            object: {
-                                type: "presence",
-                                statusText: "",
-                                presence: "notauthorized",
-                            },
-                        });
-                    } else {
-                        /**
-                         * can't figure out how to know if one of these query stanzas are from
-                         * added contacts or pending requests
-                         */
-                        this.subscribe(
-                            this.session.actor,
-                            entries[e].attrs.jid,
-                            entries[e].attrs.name,
-                        );
-                    }
-                }
-            }
-        } else {
-            this.session.log.debug(`got XMPP unknown stanza... ${stanza}`);
-        }
-    }
-}