@fedify/fedify 0.11.0-dev.260 → 0.12.0-dev.262

package/CHANGES.md

@@ -3,11 +3,21 @@
 Fedify changelog
 ================
 
-Version 0.11.0
+Version 0.12.0
 --------------
 
 To be released.
 
+ -  Added `ChatMessage` class to Activity Vocabulary API.  [[#85]]
+
+[#85]: https://github.com/dahlia/fedify/issues/85
+
+
+Version 0.11.0
+--------------
+
+Released on June 29, 2024.
+
  -  Improved runtime type error messages for Activity Vocabulary API.  [[#79]]
 
  -  Added `suppressError` option to dereferencing accessors of Activity

package/README.md

@@ -129,7 +129,7 @@ Fedify is an ESM-only package, so you need to add `"type": "module"` to the
 {
   "type": "module",
   "dependencies": {
-    "@fedify/fedify": "^0.11.0"
+    "@fedify/fedify": "^0.12.0"
   }
 }
 ~~~~

package/esm/vocab/chatmessage.yaml

@@ -0,0 +1,18 @@
+$schema: ../codegen/schema.yaml
+name: ChatMessage
+uri: "http://litepub.social/ns#ChatMessage"
+extends: "https://www.w3.org/ns/activitystreams#Object"
+entity: true
+description: |
+  `ChatMessage`s are the messages sent in 1-on-1 chats.  They are similar to
+  {@link Note}s, but the addressing is done by having a single AP actor in
+  the `to` field.  Addressing multiple actors is not allowed.  These messages
+  are always private, there is no public version of them.  They are created with
+  a {@link Create} activity.
+defaultContext:
+- "https://www.w3.org/ns/activitystreams"
+- "https://w3id.org/security/data-integrity/v1"
+- toot: "http://joinmastodon.org/ns#"
+  Emoji: "toot:Emoji"
+  ChatMessage: "http://litepub.social/ns#ChatMessage"
+properties: []

package/esm/vocab/create.yaml

@@ -11,4 +11,5 @@ defaultContext:
   sensitive: "as:sensitive"
   Emoji: "toot:Emoji"
   Hashtag: "as:Hashtag"
+  ChatMessage: "http://litepub.social/ns#ChatMessage"
 properties: []

package/esm/vocab/delete.yaml

@@ -9,4 +9,5 @@ description: |
 defaultContext:
 - "https://www.w3.org/ns/activitystreams"
 - "https://w3id.org/security/data-integrity/v1"
+- ChatMessage: "http://litepub.social/ns#ChatMessage"
 properties: []

package/esm/vocab/update.yaml

@@ -16,4 +16,5 @@ defaultContext:
   sensitive: "as:sensitive"
   Emoji: "toot:Emoji"
   Hashtag: "as:Hashtag"
+  ChatMessage: "http://litepub.social/ns#ChatMessage"
 properties: []

package/esm/vocab/vocab.js

@@ -3102,6 +3102,10 @@ export class Object {
                 delete values["@type"];
                 return await Emoji.fromJsonLd(values, options);
             }
+            if (values["@type"].includes("http://litepub.social/ns#ChatMessage")) {
+                delete values["@type"];
+                return await ChatMessage.fromJsonLd(values, options);
+            }
             if (values["@type"].includes("https://www.w3.org/ns/activitystreams#Activity")) {
                 delete values["@type"];
                 return await Activity.fromJsonLd(values, options);
@@ -3307,6 +3311,7 @@ export class Object {
                 [
                     "https://www.w3.org/ns/activitystreams#Object",
                     "http://joinmastodon.org/ns#Emoji",
+                    "http://litepub.social/ns#ChatMessage",
                     "https://www.w3.org/ns/activitystreams#Activity",
                     "https://www.w3.org/ns/activitystreams#Accept",
                     "https://www.w3.org/ns/activitystreams#Add",
@@ -3474,6 +3479,7 @@ export class Object {
                 [
                     "https://www.w3.org/ns/activitystreams#Object",
                     "http://joinmastodon.org/ns#Emoji",
+                    "http://litepub.social/ns#ChatMessage",
                     "https://www.w3.org/ns/activitystreams#Activity",
                     "https://www.w3.org/ns/activitystreams#Accept",
                     "https://www.w3.org/ns/activitystreams#Add",
@@ -3591,6 +3597,7 @@ export class Object {
                 [
                     "https://www.w3.org/ns/activitystreams#Object",
                     "http://joinmastodon.org/ns#Emoji",
+                    "http://litepub.social/ns#ChatMessage",
                     "https://www.w3.org/ns/activitystreams#Activity",
                     "https://www.w3.org/ns/activitystreams#Accept",
                     "https://www.w3.org/ns/activitystreams#Add",
@@ -3708,6 +3715,7 @@ export class Object {
                 [
                     "https://www.w3.org/ns/activitystreams#Object",
                     "http://joinmastodon.org/ns#Emoji",
+                    "http://litepub.social/ns#ChatMessage",
                     "https://www.w3.org/ns/activitystreams#Activity",
                     "https://www.w3.org/ns/activitystreams#Accept",
                     "https://www.w3.org/ns/activitystreams#Add",
@@ -3789,6 +3797,7 @@ export class Object {
                 [
                     "https://www.w3.org/ns/activitystreams#Object",
                     "http://joinmastodon.org/ns#Emoji",
+                    "http://litepub.social/ns#ChatMessage",
                     "https://www.w3.org/ns/activitystreams#Activity",
                     "https://www.w3.org/ns/activitystreams#Accept",
                     "https://www.w3.org/ns/activitystreams#Add",
@@ -3878,6 +3887,7 @@ export class Object {
                     [
                         "https://www.w3.org/ns/activitystreams#Object",
                         "http://joinmastodon.org/ns#Emoji",
+                        "http://litepub.social/ns#ChatMessage",
                         "https://www.w3.org/ns/activitystreams#Activity",
                         "https://www.w3.org/ns/activitystreams#Accept",
                         "https://www.w3.org/ns/activitystreams#Add",
@@ -4018,6 +4028,7 @@ export class Object {
                 [
                     "https://www.w3.org/ns/activitystreams#Object",
                     "http://joinmastodon.org/ns#Emoji",
+                    "http://litepub.social/ns#ChatMessage",
                     "https://www.w3.org/ns/activitystreams#Activity",
                     "https://www.w3.org/ns/activitystreams#Accept",
                     "https://www.w3.org/ns/activitystreams#Add",
@@ -4792,6 +4803,141 @@ export class Emoji extends Object {
         return "Emoji " + inspect(proxy, options);
     }
 }
+/** `ChatMessage`s are the messages sent in 1-on-1 chats.  They are similar to
+ * {@link Note}s, but the addressing is done by having a single AP actor in
+ * the `to` field.  Addressing multiple actors is not allowed.  These messages
+ * are always private, there is no public version of them.  They are created with
+ * a {@link Create} activity.
+ */
+export class ChatMessage extends Object {
+    /**
+     * The type URI of {@link ChatMessage}: `http://litepub.social/ns#ChatMessage`.
+     */
+    static get typeId() {
+        return new URL("http://litepub.social/ns#ChatMessage");
+    }
+    /**
+     * Constructs a new instance of ChatMessage with the given values.
+     * @param values The values to initialize the instance with.
+     * @param options The options to use for initialization.
+     */
+    constructor(values, { documentLoader, contextLoader, } = {}) {
+        super(values, { documentLoader, contextLoader });
+    }
+    /**
+     * Clones this instance, optionally updating it with the given values.
+     * @param values The values to update the clone with.
+     * @options The options to use for cloning.
+     * @returns The cloned instance.
+     */
+    clone(values = {}, options = {}) {
+        const clone = super.clone(values, options);
+        return clone;
+    }
+    /**
+     * Converts this object to a JSON-LD structure.
+     * @returns The JSON-LD representation of this object.
+     */
+    async toJsonLd(options = {}) {
+        options = {
+            ...options,
+            contextLoader: options.contextLoader ?? fetchDocumentLoader,
+        };
+        // deno-lint-ignore no-unused-vars prefer-const
+        let array;
+        const baseValues = await super.toJsonLd({
+            ...options,
+            expand: true,
+        });
+        const values = baseValues[0];
+        values["@type"] = ["http://litepub.social/ns#ChatMessage"];
+        if (this.id)
+            values["@id"] = this.id.href;
+        if (options.expand) {
+            return await jsonld.expand(values, { documentLoader: options.contextLoader });
+        }
+        const docContext = options.context ??
+            [
+                "https://www.w3.org/ns/activitystreams",
+                "https://w3id.org/security/data-integrity/v1",
+                {
+                    "toot": "http://joinmastodon.org/ns#",
+                    "Emoji": "toot:Emoji",
+                    "ChatMessage": "http://litepub.social/ns#ChatMessage",
+                },
+            ];
+        const compacted = await jsonld.compact(values, docContext, { documentLoader: options.contextLoader });
+        if (docContext != null) {
+            // Embed context
+            if ("proof" in compacted &&
+                compacted.proof != null) {
+                if (Array.isArray(compacted.proof)) {
+                    for (const element of compacted.proof) {
+                        element["@context"] = docContext;
+                    }
+                }
+                else {
+                    compacted.proof["@context"] = docContext;
+                }
+            }
+        }
+        return compacted;
+    }
+    /**
+     * Converts a JSON-LD structure to an object of this type.
+     * @param json The JSON-LD structure to convert.
+     * @returns The object of this type.
+     * @throws {TypeError} If the given `json` is invalid.
+     */
+    static async fromJsonLd(json, options = {}) {
+        if (typeof json === "undefined") {
+            throw new TypeError("Invalid JSON-LD: undefined.");
+        }
+        else if (json === null)
+            throw new TypeError("Invalid JSON-LD: null.");
+        options = {
+            ...options,
+            documentLoader: options.documentLoader ?? fetchDocumentLoader,
+            contextLoader: options.contextLoader ?? fetchDocumentLoader,
+        };
+        // deno-lint-ignore no-explicit-any
+        let values;
+        if (globalThis.Object.keys(json).length == 0) {
+            values = {};
+        }
+        else {
+            const expanded = await jsonld.expand(json, {
+                documentLoader: options.contextLoader,
+                keepFreeFloatingNodes: true,
+            });
+            values =
+                // deno-lint-ignore no-explicit-any
+                (expanded[0] ?? {});
+        }
+        if ("@type" in values) {
+            if (!values["@type"].includes("http://litepub.social/ns#ChatMessage")) {
+                throw new TypeError("Invalid type: " + values["@type"]);
+            }
+        }
+        const instance = await super.fromJsonLd(values, options);
+        if (!(instance instanceof ChatMessage)) {
+            throw new TypeError("Unexpected type: " + instance.constructor.name);
+        }
+        return instance;
+    }
+    _getCustomInspectProxy() {
+        const proxy = super._getCustomInspectProxy();
+        return proxy;
+    }
+    [Symbol.for("Deno.customInspect")](inspect, options) {
+        const proxy = this._getCustomInspectProxy();
+        return "ChatMessage " + inspect(proxy, options);
+    }
+    [Symbol.for("nodejs.util.inspect.custom")](_depth, options, inspect) {
+        const proxy = this._getCustomInspectProxy();
+        return "ChatMessage " + inspect(proxy, options);
+    }
+}
 /** A pair of property name and value.
  */
 export class PropertyValue {
@@ -11833,6 +11979,7 @@ export class Collection extends Object {
                 [
                     "https://www.w3.org/ns/activitystreams#Object",
                     "http://joinmastodon.org/ns#Emoji",
+                    "http://litepub.social/ns#ChatMessage",
                     "https://www.w3.org/ns/activitystreams#Activity",
                     "https://www.w3.org/ns/activitystreams#Accept",
                     "https://www.w3.org/ns/activitystreams#Add",
@@ -12512,6 +12659,7 @@ export class Create extends Activity {
                     "sensitive": "as:sensitive",
                     "Emoji": "toot:Emoji",
                     "Hashtag": "as:Hashtag",
+                    "ChatMessage": "http://litepub.social/ns#ChatMessage",
                 },
             ];
         const compacted = await jsonld.compact(values, docContext, { documentLoader: options.contextLoader });
@@ -12640,6 +12788,7 @@ export class Delete extends Activity {
             [
                 "https://www.w3.org/ns/activitystreams",
                 "https://w3id.org/security/data-integrity/v1",
+                { "ChatMessage": "http://litepub.social/ns#ChatMessage" },
             ];
         const compacted = await jsonld.compact(values, docContext, { documentLoader: options.contextLoader });
         if (docContext != null) {
@@ -16449,6 +16598,7 @@ export class Link {
                     [
                         "https://www.w3.org/ns/activitystreams#Object",
                         "http://joinmastodon.org/ns#Emoji",
+                        "http://litepub.social/ns#ChatMessage",
                         "https://www.w3.org/ns/activitystreams#Activity",
                         "https://www.w3.org/ns/activitystreams#Accept",
                         "https://www.w3.org/ns/activitystreams#Add",
@@ -18113,6 +18263,7 @@ export class OrderedCollection extends Collection {
                 [
                     "https://www.w3.org/ns/activitystreams#Object",
                     "http://joinmastodon.org/ns#Emoji",
+                    "http://litepub.social/ns#ChatMessage",
                     "https://www.w3.org/ns/activitystreams#Activity",
                     "https://www.w3.org/ns/activitystreams#Accept",
                     "https://www.w3.org/ns/activitystreams#Add",
@@ -18487,6 +18638,7 @@ export class OrderedCollectionPage extends CollectionPage {
                 [
                     "https://www.w3.org/ns/activitystreams#Object",
                     "http://joinmastodon.org/ns#Emoji",
+                    "http://litepub.social/ns#ChatMessage",
                     "https://www.w3.org/ns/activitystreams#Activity",
                     "https://www.w3.org/ns/activitystreams#Accept",
                     "https://www.w3.org/ns/activitystreams#Add",
@@ -27110,6 +27262,7 @@ export class Update extends Activity {
                     "sensitive": "as:sensitive",
                     "Emoji": "toot:Emoji",
                     "Hashtag": "as:Hashtag",
+                    "ChatMessage": "http://litepub.social/ns#ChatMessage",
                 },
             ];
         const compacted = await jsonld.compact(values, docContext, { documentLoader: options.contextLoader });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/fedify",
-  "version": "0.11.0-dev.260+31b0b19c",
+  "version": "0.12.0-dev.262+0b8a9121",
   "description": "An ActivityPub server framework",
   "keywords": [
     "ActivityPub",

package/types/vocab/vocab.d.ts

@@ -775,6 +775,149 @@ export declare class Emoji extends Object {
     }): Promise<Emoji>;
     protected _getCustomInspectProxy(): Record<string, unknown>;
 }
+/** `ChatMessage`s are the messages sent in 1-on-1 chats.  They are similar to
+ * {@link Note}s, but the addressing is done by having a single AP actor in
+ * the `to` field.  Addressing multiple actors is not allowed.  These messages
+ * are always private, there is no public version of them.  They are created with
+ * a {@link Create} activity.
+ */
+export declare class ChatMessage extends Object {
+    /**
+     * The type URI of {@link ChatMessage}: `http://litepub.social/ns#ChatMessage`.
+     */
+    static get typeId(): URL;
+    /**
+     * Constructs a new instance of ChatMessage with the given values.
+     * @param values The values to initialize the instance with.
+     * @param options The options to use for initialization.
+     */
+    constructor(values: {
+        id?: URL | null;
+        attachments?: (Object | Link | PropertyValue | URL)[];
+        attribution?: Application | Group | Organization | Person | Service | URL | null;
+        attributions?: (Application | Group | Organization | Person | Service | URL)[];
+        audience?: Object | URL | null;
+        audiences?: (Object | URL)[];
+        content?: string | LanguageString | null;
+        contents?: ((string | LanguageString))[];
+        contexts?: (Object | Link | URL)[];
+        name?: string | LanguageString | null;
+        names?: ((string | LanguageString))[];
+        endTime?: dntShim.Temporal.Instant | null;
+        generators?: (Object | Link | URL)[];
+        icon?: Image | URL | null;
+        icons?: (Image | URL)[];
+        image?: Image | URL | null;
+        images?: (Image | URL)[];
+        replyTarget?: Object | Link | URL | null;
+        replyTargets?: (Object | Link | URL)[];
+        location?: Object | Link | URL | null;
+        locations?: (Object | Link | URL)[];
+        preview?: Link | Object | URL | null;
+        previews?: (Link | Object | URL)[];
+        published?: dntShim.Temporal.Instant | null;
+        replies?: Collection | URL | null;
+        startTime?: dntShim.Temporal.Instant | null;
+        summary?: string | LanguageString | null;
+        summaries?: ((string | LanguageString))[];
+        tags?: (Object | Link | URL)[];
+        updated?: dntShim.Temporal.Instant | null;
+        url?: URL | Link | null;
+        urls?: ((URL | Link))[];
+        to?: Object | URL | null;
+        tos?: (Object | URL)[];
+        bto?: Object | URL | null;
+        btos?: (Object | URL)[];
+        cc?: Object | URL | null;
+        ccs?: (Object | URL)[];
+        bcc?: Object | URL | null;
+        bccs?: (Object | URL)[];
+        mediaType?: string | null;
+        duration?: dntShim.Temporal.Duration | null;
+        sensitive?: boolean | null;
+        proof?: DataIntegrityProof | URL | null;
+        proofs?: (DataIntegrityProof | URL)[];
+    }, { documentLoader, contextLoader, }?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    });
+    /**
+     * Clones this instance, optionally updating it with the given values.
+     * @param values The values to update the clone with.
+     * @options The options to use for cloning.
+     * @returns The cloned instance.
+     */
+    clone(values?: {
+        id?: URL | null;
+        attachments?: (Object | Link | PropertyValue | URL)[];
+        attribution?: Application | Group | Organization | Person | Service | URL | null;
+        attributions?: (Application | Group | Organization | Person | Service | URL)[];
+        audience?: Object | URL | null;
+        audiences?: (Object | URL)[];
+        content?: string | LanguageString | null;
+        contents?: ((string | LanguageString))[];
+        contexts?: (Object | Link | URL)[];
+        name?: string | LanguageString | null;
+        names?: ((string | LanguageString))[];
+        endTime?: dntShim.Temporal.Instant | null;
+        generators?: (Object | Link | URL)[];
+        icon?: Image | URL | null;
+        icons?: (Image | URL)[];
+        image?: Image | URL | null;
+        images?: (Image | URL)[];
+        replyTarget?: Object | Link | URL | null;
+        replyTargets?: (Object | Link | URL)[];
+        location?: Object | Link | URL | null;
+        locations?: (Object | Link | URL)[];
+        preview?: Link | Object | URL | null;
+        previews?: (Link | Object | URL)[];
+        published?: dntShim.Temporal.Instant | null;
+        replies?: Collection | URL | null;
+        startTime?: dntShim.Temporal.Instant | null;
+        summary?: string | LanguageString | null;
+        summaries?: ((string | LanguageString))[];
+        tags?: (Object | Link | URL)[];
+        updated?: dntShim.Temporal.Instant | null;
+        url?: URL | Link | null;
+        urls?: ((URL | Link))[];
+        to?: Object | URL | null;
+        tos?: (Object | URL)[];
+        bto?: Object | URL | null;
+        btos?: (Object | URL)[];
+        cc?: Object | URL | null;
+        ccs?: (Object | URL)[];
+        bcc?: Object | URL | null;
+        bccs?: (Object | URL)[];
+        mediaType?: string | null;
+        duration?: dntShim.Temporal.Duration | null;
+        sensitive?: boolean | null;
+        proof?: DataIntegrityProof | URL | null;
+        proofs?: (DataIntegrityProof | URL)[];
+    }, options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    }): ChatMessage;
+    /**
+     * Converts this object to a JSON-LD structure.
+     * @returns The JSON-LD representation of this object.
+     */
+    toJsonLd(options?: {
+        expand?: boolean;
+        contextLoader?: DocumentLoader;
+        context?: string | Record<string, string> | (string | Record<string, string>)[];
+    }): Promise<unknown>;
+    /**
+     * Converts a JSON-LD structure to an object of this type.
+     * @param json The JSON-LD structure to convert.
+     * @returns The object of this type.
+     * @throws {TypeError} If the given `json` is invalid.
+     */
+    static fromJsonLd(json: unknown, options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    }): Promise<ChatMessage>;
+    protected _getCustomInspectProxy(): Record<string, unknown>;
+}
 /** A pair of property name and value.
  */
 export declare class PropertyValue {