@fedify/fedify 0.11.0-dev.223 → 0.11.0-dev.229

package/CHANGES.md

@@ -22,7 +22,11 @@ To be released.
      -  The default `rules` for `kvCache()` function are now 5 minutes for all
         URLs.
 
+ -  Added `Offer` class to Activity Vocabulary API.
+    [[#65], [#76] by Lee Dogeon]
+
 [#74]: https://github.com/dahlia/fedify/issues/74
+[#76]: https://github.com/dahlia/fedify/pull/76
 
 
 Version 0.10.0
@@ -755,4 +759,4 @@ Version 0.1.0
 
 Initial release.  Released on March 8, 2024.
 
-<!-- cSpell: ignore Wressell -->
+<!-- cSpell: ignore Dogeon Wressell -->

package/FEDERATION.md

@@ -57,6 +57,7 @@ lists the activity types that Fedify provides:
  -  [`Follow`](https://jsr.io/@fedify/fedify/doc/vocab/~/Follow)
  -  [`Ignore`](https://jsr.io/@fedify/fedify/doc/vocab/~/Ignore)
  -  [`Like`](https://jsr.io/@fedify/fedify/doc/vocab/~/Like)
+ -  [`Offer`](https://jsr.io/@fedify/fedify/doc/vocab/~/Offer)
  -  [`Question`](https://jsr.io/@fedify/fedify/doc/vocab/~/Question)
  -  [`Reject`](https://jsr.io/@fedify/fedify/doc/vocab/~/Reject)
  -  [`Remove`](https://jsr.io/@fedify/fedify/doc/vocab/~/Remove)

package/README.md

@@ -8,7 +8,7 @@ Fedify: an ActivityPub server framework
 [![npm][npm badge]][npm]
 [![GitHub Actions][GitHub Actions badge]][GitHub Actions]
 [![Matrix][Matrix badge]][Matrix]
-[![Follow @hongminhee@todon.eu][@hongminhee.todon.eu badge]][@hongminhee.todon.eu]
+[![Follow @hongminhee@fosstodon.org][@hongminhee@fosstodon.org badge]][@hongminhee@fosstodon.org]
 
 > [!NOTE]
 > Looking for a quick demo?  Here it is: [Fedify Demo] on Deno Playground.
@@ -54,8 +54,8 @@ join our [Matrix chat space][Matrix] or [GitHub Discussions].  Or tag
 [GitHub Actions badge]: https://github.com/dahlia/fedify/actions/workflows/build.yaml/badge.svg
 [Matrix]: https://matrix.to/#/#fedify:matrix.org
 [Matrix badge]: https://img.shields.io/matrix/fedify%3Amatrix.org
-[@hongminhee.todon.eu badge]: https://fedi-badge.deno.dev/@hongminhee@todon.eu/followers.svg
-[@hongminhee.todon.eu]: https://todon.eu/@hongminhee
+[@hongminhee@fosstodon.org badge]: https://fedi-badge.deno.dev/@hongminhee@fosstodon.org/followers.svg
+[@hongminhee@fosstodon.org]: https://fosstodon.org/@hongminhee
 [Fedify Demo]: https://dash.deno.com/playground/fedify-demo
 [ActivityPub]: https://www.w3.org/TR/activitypub/
 [fediverse]: https://en.wikipedia.org/wiki/Fediverse

package/esm/vocab/actor.js

@@ -59,11 +59,11 @@ export function getActorClassByTypeName(typeName) {
  * ``` typescript
  * // Get the handle of an actor object:
  * await getActorHandle(
- *   new Person({ id: new URL("https://todon.eu/users/hongminhee") })
+ *   new Person({ id: new URL("https://fosstodon.org/users/hongminhee") })
  * );
  *
  * // Get the handle of an actor URI:
- * await getActorHandle(new URL("https://todon.eu/users/hongminhee"));
+ * await getActorHandle(new URL("https://fosstodon.org/users/hongminhee"));
  * ```
  *
  * @param actor The actor or actor URI to get the handle from.

package/esm/vocab/lookup.js

@@ -11,15 +11,15 @@ const handleRegexp = /^@?((?:[-A-Za-z0-9._~!$&'()*+,;=]|%[A-Fa-f0-9]{2})+)@([^@]
  * @example
  * ``` typescript
  * // Look up an actor by its fediverse handle:
- * await lookupObject("@hongminhee@todon.eu");
+ * await lookupObject("@hongminhee@fosstodon.org");
  * // returning a `Person` object.
  *
  * // A fediverse handle can omit the leading '@':
- * await lookupObject("hongminhee@todon.eu");
+ * await lookupObject("hongminhee@fosstodon.org");
  * // returning a `Person` object.
  *
  * // A `acct:` URI can be used as well:
- * await lookupObject("acct:hongminhee@todon.eu");
+ * await lookupObject("acct:hongminhee@fosstodon.org");
  * // returning a `Person` object.
  *
  * // Look up an object by its URI:

package/esm/vocab/offer.yaml

@@ -0,0 +1,13 @@
+$schema: ../codegen/schema.yaml
+name: Offer
+uri: "https://www.w3.org/ns/activitystreams#Offer"
+extends: "https://www.w3.org/ns/activitystreams#Activity"
+entity: true
+description: |
+  Indicates that the actor is offering the object.
+  If specified, the target indicates the entity to which
+  the object is being offered.
+defaultContext:
+- "https://www.w3.org/ns/activitystreams"
+- "https://w3id.org/security/data-integrity/v1"
+properties: []

package/esm/vocab/vocab.js

@@ -2210,6 +2210,10 @@ export class Object {
                 delete values["@type"];
                 return await Like.fromJsonLd(values, options);
             }
+            if (values["@type"].includes("https://www.w3.org/ns/activitystreams#Offer")) {
+                delete values["@type"];
+                return await Offer.fromJsonLd(values, options);
+            }
             if (values["@type"].includes("https://www.w3.org/ns/activitystreams#Reject")) {
                 delete values["@type"];
                 return await Reject.fromJsonLd(values, options);
@@ -2345,6 +2349,7 @@ export class Object {
                     "https://www.w3.org/ns/activitystreams#Arrive",
                     "https://www.w3.org/ns/activitystreams#Question",
                     "https://www.w3.org/ns/activitystreams#Like",
+                    "https://www.w3.org/ns/activitystreams#Offer",
                     "https://www.w3.org/ns/activitystreams#Reject",
                     "https://www.w3.org/ns/activitystreams#Remove",
                     "https://www.w3.org/ns/activitystreams#Undo",
@@ -2484,6 +2489,7 @@ export class Object {
                     "https://www.w3.org/ns/activitystreams#Arrive",
                     "https://www.w3.org/ns/activitystreams#Question",
                     "https://www.w3.org/ns/activitystreams#Like",
+                    "https://www.w3.org/ns/activitystreams#Offer",
                     "https://www.w3.org/ns/activitystreams#Reject",
                     "https://www.w3.org/ns/activitystreams#Remove",
                     "https://www.w3.org/ns/activitystreams#Undo",
@@ -2578,6 +2584,7 @@ export class Object {
                     "https://www.w3.org/ns/activitystreams#Arrive",
                     "https://www.w3.org/ns/activitystreams#Question",
                     "https://www.w3.org/ns/activitystreams#Like",
+                    "https://www.w3.org/ns/activitystreams#Offer",
                     "https://www.w3.org/ns/activitystreams#Reject",
                     "https://www.w3.org/ns/activitystreams#Remove",
                     "https://www.w3.org/ns/activitystreams#Undo",
@@ -2672,6 +2679,7 @@ export class Object {
                     "https://www.w3.org/ns/activitystreams#Arrive",
                     "https://www.w3.org/ns/activitystreams#Question",
                     "https://www.w3.org/ns/activitystreams#Like",
+                    "https://www.w3.org/ns/activitystreams#Offer",
                     "https://www.w3.org/ns/activitystreams#Reject",
                     "https://www.w3.org/ns/activitystreams#Remove",
                     "https://www.w3.org/ns/activitystreams#Undo",
@@ -2742,6 +2750,7 @@ export class Object {
                     "https://www.w3.org/ns/activitystreams#Arrive",
                     "https://www.w3.org/ns/activitystreams#Question",
                     "https://www.w3.org/ns/activitystreams#Like",
+                    "https://www.w3.org/ns/activitystreams#Offer",
                     "https://www.w3.org/ns/activitystreams#Reject",
                     "https://www.w3.org/ns/activitystreams#Remove",
                     "https://www.w3.org/ns/activitystreams#Undo",
@@ -2820,6 +2829,7 @@ export class Object {
                         "https://www.w3.org/ns/activitystreams#Arrive",
                         "https://www.w3.org/ns/activitystreams#Question",
                         "https://www.w3.org/ns/activitystreams#Like",
+                        "https://www.w3.org/ns/activitystreams#Offer",
                         "https://www.w3.org/ns/activitystreams#Reject",
                         "https://www.w3.org/ns/activitystreams#Remove",
                         "https://www.w3.org/ns/activitystreams#Undo",
@@ -2925,6 +2935,7 @@ export class Object {
                     "https://www.w3.org/ns/activitystreams#Arrive",
                     "https://www.w3.org/ns/activitystreams#Question",
                     "https://www.w3.org/ns/activitystreams#Like",
+                    "https://www.w3.org/ns/activitystreams#Offer",
                     "https://www.w3.org/ns/activitystreams#Reject",
                     "https://www.w3.org/ns/activitystreams#Remove",
                     "https://www.w3.org/ns/activitystreams#Undo",
@@ -5229,6 +5240,10 @@ export class Activity extends Object {
                 delete values["@type"];
                 return await Like.fromJsonLd(values, options);
             }
+            if (values["@type"].includes("https://www.w3.org/ns/activitystreams#Offer")) {
+                delete values["@type"];
+                return await Offer.fromJsonLd(values, options);
+            }
             if (values["@type"].includes("https://www.w3.org/ns/activitystreams#Reject")) {
                 delete values["@type"];
                 return await Reject.fromJsonLd(values, options);
@@ -8403,6 +8418,7 @@ export class Collection extends Object {
                     "https://www.w3.org/ns/activitystreams#Arrive",
                     "https://www.w3.org/ns/activitystreams#Question",
                     "https://www.w3.org/ns/activitystreams#Like",
+                    "https://www.w3.org/ns/activitystreams#Offer",
                     "https://www.w3.org/ns/activitystreams#Reject",
                     "https://www.w3.org/ns/activitystreams#Remove",
                     "https://www.w3.org/ns/activitystreams#Undo",
@@ -11801,6 +11817,7 @@ export class Link {
                         "https://www.w3.org/ns/activitystreams#Arrive",
                         "https://www.w3.org/ns/activitystreams#Question",
                         "https://www.w3.org/ns/activitystreams#Like",
+                        "https://www.w3.org/ns/activitystreams#Offer",
                         "https://www.w3.org/ns/activitystreams#Reject",
                         "https://www.w3.org/ns/activitystreams#Remove",
                         "https://www.w3.org/ns/activitystreams#Undo",
@@ -12505,6 +12522,118 @@ export class Note extends Object {
         return "Note " + inspect(proxy, options);
     }
 }
+/** Indicates that the actor is offering the object.
+ * If specified, the target indicates the entity to which
+ * the object is being offered.
+ */
+export class Offer extends Activity {
+    /**
+     * The type URI of {@link Offer}: `https://www.w3.org/ns/activitystreams#Offer`.
+     */
+    static get typeId() {
+        return new URL("https://www.w3.org/ns/activitystreams#Offer");
+    }
+    /**
+     * Constructs a new instance of Offer 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"] = ["https://www.w3.org/ns/activitystreams#Offer"];
+        if (this.id)
+            values["@id"] = this.id.href;
+        if (options.expand) {
+            return await jsonld.expand(values, { documentLoader: options.contextLoader });
+        }
+        return await jsonld.compact(values, options.context ??
+            [
+                "https://www.w3.org/ns/activitystreams",
+                "https://w3id.org/security/data-integrity/v1",
+            ], { documentLoader: options.contextLoader });
+    }
+    /**
+     * 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("https://www.w3.org/ns/activitystreams#Offer")) {
+                throw new TypeError("Invalid type: " + values["@type"]);
+            }
+        }
+        const instance = await super.fromJsonLd(values, options);
+        if (!(instance instanceof Offer)) {
+            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 "Offer " + inspect(proxy, options);
+    }
+    [Symbol.for("nodejs.util.inspect.custom")](_depth, options, inspect) {
+        const proxy = this._getCustomInspectProxy();
+        return "Offer " + inspect(proxy, options);
+    }
+}
 /** A subtype of {@link Collection} in which members of the logical collection
  * are assumed to always be strictly ordered.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/fedify",
-  "version": "0.11.0-dev.223+fd936aeb",
+  "version": "0.11.0-dev.229+584cc819",
   "description": "An ActivityPub server framework",
   "keywords": [
     "ActivityPub",

package/types/vocab/actor.d.ts

@@ -35,11 +35,11 @@ export declare function getActorClassByTypeName(typeName: ActorTypeName): typeof
  * ``` typescript
  * // Get the handle of an actor object:
  * await getActorHandle(
- *   new Person({ id: new URL("https://todon.eu/users/hongminhee") })
+ *   new Person({ id: new URL("https://fosstodon.org/users/hongminhee") })
  * );
  *
  * // Get the handle of an actor URI:
- * await getActorHandle(new URL("https://todon.eu/users/hongminhee"));
+ * await getActorHandle(new URL("https://fosstodon.org/users/hongminhee"));
  * ```
  *
  * @param actor The actor or actor URI to get the handle from.

package/types/vocab/lookup.d.ts

@@ -24,15 +24,15 @@ export interface LookupObjectOptions {
  * @example
  * ``` typescript
  * // Look up an actor by its fediverse handle:
- * await lookupObject("@hongminhee@todon.eu");
+ * await lookupObject("@hongminhee@fosstodon.org");
  * // returning a `Person` object.
  *
  * // A fediverse handle can omit the leading '@':
- * await lookupObject("hongminhee@todon.eu");
+ * await lookupObject("hongminhee@fosstodon.org");
  * // returning a `Person` object.
  *
  * // A `acct:` URI can be used as well:
- * await lookupObject("acct:hongminhee@todon.eu");
+ * await lookupObject("acct:hongminhee@fosstodon.org");
  * // returning a `Person` object.
  *
  * // Look up an object by its URI:

package/types/vocab/vocab.d.ts

@@ -5612,6 +5612,155 @@ export declare class Note extends Object {
     }): Promise<Note>;
     protected _getCustomInspectProxy(): Record<string, unknown>;
 }
+/** Indicates that the actor is offering the object.
+ * If specified, the target indicates the entity to which
+ * the object is being offered.
+ */
+export declare class Offer extends Activity {
+    /**
+     * The type URI of {@link Offer}: `https://www.w3.org/ns/activitystreams#Offer`.
+     */
+    static get typeId(): URL;
+    /**
+     * Constructs a new instance of Offer 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)[];
+        actor?: Application | Group | Organization | Person | Service | URL | null;
+        actors?: (Application | Group | Organization | Person | Service | URL)[];
+        object?: Object | URL | null;
+        objects?: (Object | 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)[];
+        actor?: Application | Group | Organization | Person | Service | URL | null;
+        actors?: (Application | Group | Organization | Person | Service | URL)[];
+        object?: Object | URL | null;
+        objects?: (Object | URL)[];
+    }, options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    }): Offer;
+    /**
+     * 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<Offer>;
+    protected _getCustomInspectProxy(): Record<string, unknown>;
+}
 /** A subtype of {@link Collection} in which members of the logical collection
  * are assumed to always be strictly ordered.
  */