@fedify/fedify 1.1.0-dev.428 → 1.1.0-dev.429

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/fedify",
-  "version": "1.1.0-dev.428+95c3e7d5",
+  "version": "1.1.0-dev.429+15184ca4",
   "description": "An ActivityPub server framework",
   "keywords": [
     "ActivityPub",

package/types/vocab/vocab.d.ts

@@ -1575,6 +1575,146 @@ export declare class PropertyValue {
     }): Promise<PropertyValue>;
     protected _getCustomInspectProxy(): Record<string, unknown>;
 }
+/** Means of communicating or interacting with the DID subject or associated
+ * entities via one or more service endpoints. Examples include discovery
+ * services, agent services, social networking services, file storage services,
+ * and verifiable credential repository services.
+ */
+export declare class DidService {
+    #private;
+    readonly id: URL | null;
+    protected get _documentLoader(): DocumentLoader | undefined;
+    protected get _contextLoader(): DocumentLoader | undefined;
+    /**
+     * The type URI of {@link DidService}: `https://www.w3.org/ns/did#Service`.
+     */
+    static get typeId(): URL;
+    /**
+     * Constructs a new instance of DidService 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;
+        endpoint?: URL | null;
+        endpoints?: (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;
+        endpoint?: URL | null;
+        endpoints?: (URL)[];
+    }, options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    }): DidService;
+    /** A network address, such as an HTTP URL, at which services operate on behalf
+     * of a DID subject.
+     */
+    get endpoint(): URL | null;
+    /** A network address, such as an HTTP URL, at which services operate on behalf
+     * of a DID subject.
+     */
+    get endpoints(): (URL)[];
+    /**
+     * Converts this object to a JSON-LD structure.
+     * @param options The options to use.
+     *                - `format`: The format of the output: `compact` or
+                        `expand`.
+     *                - `contextLoader`: The loader for remote JSON-LD contexts.
+     *                - `context`: The JSON-LD context to use.  Not applicable
+                        when `format` is set to `'expand'`.
+     * @returns The JSON-LD representation of this object.
+     */
+    toJsonLd(options?: {
+        format?: "compact" | "expand";
+        contextLoader?: DocumentLoader;
+        context?: string | Record<string, string> | (string | Record<string, string>)[];
+    }): Promise<unknown>;
+    protected isCompactable(): boolean;
+    /**
+     * 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<DidService>;
+    protected _getCustomInspectProxy(): Record<string, unknown>;
+}
+/** "Export Actor" service.
+ */
+export declare class Export extends DidService {
+    #private;
+    /**
+     * The type URI of {@link Export}: `https://w3id.org/fep/9091#Export`.
+     */
+    static get typeId(): URL;
+    /**
+     * Constructs a new instance of Export 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;
+        endpoint?: URL | null;
+        endpoints?: (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;
+        endpoint?: URL | null;
+        endpoints?: (URL)[];
+    }, options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    }): Export;
+    /**
+     * Converts this object to a JSON-LD structure.
+     * @param options The options to use.
+     *                - `format`: The format of the output: `compact` or
+                        `expand`.
+     *                - `contextLoader`: The loader for remote JSON-LD contexts.
+     *                - `context`: The JSON-LD context to use.  Not applicable
+                        when `format` is set to `'expand'`.
+     * @returns The JSON-LD representation of this object.
+     */
+    toJsonLd(options?: {
+        format?: "compact" | "expand";
+        contextLoader?: DocumentLoader;
+        context?: string | Record<string, string> | (string | Record<string, string>)[];
+    }): Promise<unknown>;
+    protected isCompactable(): boolean;
+    /**
+     * 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<Export>;
+    protected _getCustomInspectProxy(): Record<string, unknown>;
+}
 /** A proof that can be added to any activity or object, allowing recipients to
  * verify the identity of the actor and the integrity of the data.
  */
@@ -2460,6 +2600,8 @@ export declare class Application extends Object {
         indexable?: boolean | null;
         alias?: Application | Group | Organization | Person | Service | URL | null;
         aliases?: (Application | Group | Organization | Person | Service | URL)[];
+        service?: DidService | URL | null;
+        services?: (DidService | URL)[];
         cat?: boolean | null;
     }, { documentLoader, contextLoader, }?: {
         documentLoader?: DocumentLoader;
@@ -2540,6 +2682,8 @@ export declare class Application extends Object {
         indexable?: boolean | null;
         alias?: Application | Group | Organization | Person | Service | URL | null;
         aliases?: (Application | Group | Organization | Person | Service | URL)[];
+        service?: DidService | URL | null;
+        services?: (DidService | URL)[];
         cat?: boolean | null;
     }, options?: {
         documentLoader?: DocumentLoader;
@@ -2820,6 +2964,38 @@ export declare class Application extends Object {
         contextLoader?: DocumentLoader;
         suppressError?: boolean;
     }): AsyncIterable<Application | Group | Organization | Person | Service>;
+    /**
+     * Similar to
+     * {@link Application.getService},
+     * but returns its `@id` URL instead of the object itself.
+     */
+    get serviceId(): URL | null;
+    /** Means of communicating or interacting with the DID subject or associated
+     * entities via one or more service endpoints. Examples include discovery
+     * services, agent services, social networking services, file storage services,
+     * and verifiable credential repository services.
+     */
+    getService(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+        suppressError?: boolean;
+    }): Promise<DidService | null>;
+    /**
+     * Similar to
+     * {@link Application.getServices},
+     * but returns their `@id`s instead of the objects themselves.
+     */
+    get serviceIds(): URL[];
+    /** Means of communicating or interacting with the DID subject or associated
+     * entities via one or more service endpoints. Examples include discovery
+     * services, agent services, social networking services, file storage services,
+     * and verifiable credential repository services.
+     */
+    getServices(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+        suppressError?: boolean;
+    }): AsyncIterable<DidService>;
     /** Used on actors to indicate that they in some way identify as a cat,
      * expressed as a boolean value. If this property is set to `true`,
      * displaying the actor or their notes will have some special effects
@@ -5679,6 +5855,8 @@ export declare class Group extends Object {
         indexable?: boolean | null;
         alias?: Application | Group | Organization | Person | Service | URL | null;
         aliases?: (Application | Group | Organization | Person | Service | URL)[];
+        service?: DidService | URL | null;
+        services?: (DidService | URL)[];
         cat?: boolean | null;
     }, { documentLoader, contextLoader, }?: {
         documentLoader?: DocumentLoader;
@@ -5759,6 +5937,8 @@ export declare class Group extends Object {
         indexable?: boolean | null;
         alias?: Application | Group | Organization | Person | Service | URL | null;
         aliases?: (Application | Group | Organization | Person | Service | URL)[];
+        service?: DidService | URL | null;
+        services?: (DidService | URL)[];
         cat?: boolean | null;
     }, options?: {
         documentLoader?: DocumentLoader;
@@ -6039,6 +6219,38 @@ export declare class Group extends Object {
         contextLoader?: DocumentLoader;
         suppressError?: boolean;
     }): AsyncIterable<Application | Group | Organization | Person | Service>;
+    /**
+     * Similar to
+     * {@link Group.getService},
+     * but returns its `@id` URL instead of the object itself.
+     */
+    get serviceId(): URL | null;
+    /** Means of communicating or interacting with the DID subject or associated
+     * entities via one or more service endpoints. Examples include discovery
+     * services, agent services, social networking services, file storage services,
+     * and verifiable credential repository services.
+     */
+    getService(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+        suppressError?: boolean;
+    }): Promise<DidService | null>;
+    /**
+     * Similar to
+     * {@link Group.getServices},
+     * but returns their `@id`s instead of the objects themselves.
+     */
+    get serviceIds(): URL[];
+    /** Means of communicating or interacting with the DID subject or associated
+     * entities via one or more service endpoints. Examples include discovery
+     * services, agent services, social networking services, file storage services,
+     * and verifiable credential repository services.
+     */
+    getServices(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+        suppressError?: boolean;
+    }): AsyncIterable<DidService>;
     /** Used on actors to indicate that they in some way identify as a cat,
      * expressed as a boolean value. If this property is set to `true`,
      * displaying the actor or their notes will have some special effects
@@ -8359,6 +8571,8 @@ export declare class Organization extends Object {
         indexable?: boolean | null;
         alias?: Application | Group | Organization | Person | Service | URL | null;
         aliases?: (Application | Group | Organization | Person | Service | URL)[];
+        service?: DidService | URL | null;
+        services?: (DidService | URL)[];
         cat?: boolean | null;
     }, { documentLoader, contextLoader, }?: {
         documentLoader?: DocumentLoader;
@@ -8439,6 +8653,8 @@ export declare class Organization extends Object {
         indexable?: boolean | null;
         alias?: Application | Group | Organization | Person | Service | URL | null;
         aliases?: (Application | Group | Organization | Person | Service | URL)[];
+        service?: DidService | URL | null;
+        services?: (DidService | URL)[];
         cat?: boolean | null;
     }, options?: {
         documentLoader?: DocumentLoader;
@@ -8719,6 +8935,38 @@ export declare class Organization extends Object {
         contextLoader?: DocumentLoader;
         suppressError?: boolean;
     }): AsyncIterable<Application | Group | Organization | Person | Service>;
+    /**
+     * Similar to
+     * {@link Organization.getService},
+     * but returns its `@id` URL instead of the object itself.
+     */
+    get serviceId(): URL | null;
+    /** Means of communicating or interacting with the DID subject or associated
+     * entities via one or more service endpoints. Examples include discovery
+     * services, agent services, social networking services, file storage services,
+     * and verifiable credential repository services.
+     */
+    getService(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+        suppressError?: boolean;
+    }): Promise<DidService | null>;
+    /**
+     * Similar to
+     * {@link Organization.getServices},
+     * but returns their `@id`s instead of the objects themselves.
+     */
+    get serviceIds(): URL[];
+    /** Means of communicating or interacting with the DID subject or associated
+     * entities via one or more service endpoints. Examples include discovery
+     * services, agent services, social networking services, file storage services,
+     * and verifiable credential repository services.
+     */
+    getServices(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+        suppressError?: boolean;
+    }): AsyncIterable<DidService>;
     /** Used on actors to indicate that they in some way identify as a cat,
      * expressed as a boolean value. If this property is set to `true`,
      * displaying the actor or their notes will have some special effects
@@ -8988,6 +9236,8 @@ export declare class Person extends Object {
         indexable?: boolean | null;
         alias?: Application | Group | Organization | Person | Service | URL | null;
         aliases?: (Application | Group | Organization | Person | Service | URL)[];
+        service?: DidService | URL | null;
+        services?: (DidService | URL)[];
         cat?: boolean | null;
     }, { documentLoader, contextLoader, }?: {
         documentLoader?: DocumentLoader;
@@ -9068,6 +9318,8 @@ export declare class Person extends Object {
         indexable?: boolean | null;
         alias?: Application | Group | Organization | Person | Service | URL | null;
         aliases?: (Application | Group | Organization | Person | Service | URL)[];
+        service?: DidService | URL | null;
+        services?: (DidService | URL)[];
         cat?: boolean | null;
     }, options?: {
         documentLoader?: DocumentLoader;
@@ -9348,6 +9600,38 @@ export declare class Person extends Object {
         contextLoader?: DocumentLoader;
         suppressError?: boolean;
     }): AsyncIterable<Application | Group | Organization | Person | Service>;
+    /**
+     * Similar to
+     * {@link Person.getService},
+     * but returns its `@id` URL instead of the object itself.
+     */
+    get serviceId(): URL | null;
+    /** Means of communicating or interacting with the DID subject or associated
+     * entities via one or more service endpoints. Examples include discovery
+     * services, agent services, social networking services, file storage services,
+     * and verifiable credential repository services.
+     */
+    getService(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+        suppressError?: boolean;
+    }): Promise<DidService | null>;
+    /**
+     * Similar to
+     * {@link Person.getServices},
+     * but returns their `@id`s instead of the objects themselves.
+     */
+    get serviceIds(): URL[];
+    /** Means of communicating or interacting with the DID subject or associated
+     * entities via one or more service endpoints. Examples include discovery
+     * services, agent services, social networking services, file storage services,
+     * and verifiable credential repository services.
+     */
+    getServices(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+        suppressError?: boolean;
+    }): AsyncIterable<DidService>;
     /** Used on actors to indicate that they in some way identify as a cat,
      * expressed as a boolean value. If this property is set to `true`,
      * displaying the actor or their notes will have some special effects
@@ -10820,6 +11104,8 @@ export declare class Service extends Object {
         indexable?: boolean | null;
         alias?: Application | Group | Organization | Person | Service | URL | null;
         aliases?: (Application | Group | Organization | Person | Service | URL)[];
+        service?: DidService | URL | null;
+        services?: (DidService | URL)[];
         cat?: boolean | null;
     }, { documentLoader, contextLoader, }?: {
         documentLoader?: DocumentLoader;
@@ -10900,6 +11186,8 @@ export declare class Service extends Object {
         indexable?: boolean | null;
         alias?: Application | Group | Organization | Person | Service | URL | null;
         aliases?: (Application | Group | Organization | Person | Service | URL)[];
+        service?: DidService | URL | null;
+        services?: (DidService | URL)[];
         cat?: boolean | null;
     }, options?: {
         documentLoader?: DocumentLoader;
@@ -11180,6 +11468,38 @@ export declare class Service extends Object {
         contextLoader?: DocumentLoader;
         suppressError?: boolean;
     }): AsyncIterable<Application | Group | Organization | Person | Service>;
+    /**
+     * Similar to
+     * {@link Service.getService},
+     * but returns its `@id` URL instead of the object itself.
+     */
+    get serviceId(): URL | null;
+    /** Means of communicating or interacting with the DID subject or associated
+     * entities via one or more service endpoints. Examples include discovery
+     * services, agent services, social networking services, file storage services,
+     * and verifiable credential repository services.
+     */
+    getService(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+        suppressError?: boolean;
+    }): Promise<DidService | null>;
+    /**
+     * Similar to
+     * {@link Service.getServices},
+     * but returns their `@id`s instead of the objects themselves.
+     */
+    get serviceIds(): URL[];
+    /** Means of communicating or interacting with the DID subject or associated
+     * entities via one or more service endpoints. Examples include discovery
+     * services, agent services, social networking services, file storage services,
+     * and verifiable credential repository services.
+     */
+    getServices(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+        suppressError?: boolean;
+    }): AsyncIterable<DidService>;
     /** Used on actors to indicate that they in some way identify as a cat,
      * expressed as a boolean value. If this property is set to `true`,
      * displaying the actor or their notes will have some special effects