@fedify/fedify 0.10.0-dev.194 → 0.10.0-dev.196

package/types/runtime/key.d.ts

@@ -15,4 +15,24 @@ export declare function importSpki(pem: string): Promise<dntShim.CryptoKey>;
  * @since 0.5.0
  */
 export declare function exportSpki(key: dntShim.CryptoKey): Promise<string>;
+/**
+ * Imports a [Multibase]-encoded public key.
+ *
+ * [Multibase]: https://www.w3.org/TR/vc-data-integrity/#multibase-0
+ * @param key The Multibase-encoded public key.
+ * @returns The imported public key.
+ * @throws {TypeError} If the key is invalid or unsupported.
+ * @since 0.10.0
+ */
+export declare function importMultibaseKey(key: string): Promise<dntShim.CryptoKey>;
+/**
+ * Exports a public key in [Multibase] format.
+ *
+ * [Multibase]: https://www.w3.org/TR/vc-data-integrity/#multibase-0
+ * @param key The public key to export.
+ * @returns The exported public key in Multibase format.
+ * @throws {TypeError} If the key is invalid or unsupported.
+ * @since 0.10.0
+ */
+export declare function exportMultibaseKey(key: dntShim.CryptoKey): Promise<string>;
 //# sourceMappingURL=key.d.ts.map

package/types/runtime/key.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"key.d.ts","sourceRoot":"","sources":["../../src/runtime/key.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC;AAgB5C;;;;;;GAMG;AACH,wBAAsB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAqBxE;AAED;;;;;;GAMG;AACH,wBAAsB,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAMxE"}
+{"version":3,"file":"key.d.ts","sourceRoot":"","sources":["../../src/runtime/key.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC;AAuB5C;;;;;;GAMG;AACH,wBAAsB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAqBxE;AAED;;;;;;GAMG;AACH,wBAAsB,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAMxE;AAED;;;;;;;;GAQG;AACH,wBAAsB,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CA8BhF;AAED;;;;;;;;GAQG;AACH,wBAAsB,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAqChF"}

package/types/vocab/vocab.d.ts

@@ -849,6 +849,85 @@ export declare class CryptographicKey {
     }): Promise<CryptographicKey>;
     protected _getCustomInspectProxy(): Record<string, unknown>;
 }
+/** Represents a key owned by an actor according to [FEP-521a: Representing
+ * actor's public keys.][1]
+ *
+ * [1]: https://codeberg.org/fediverse/fep/src/branch/main/fep/521a/fep-521a.md
+ */
+export declare class Multikey {
+    #private;
+    readonly id: URL | null;
+    protected get _documentLoader(): DocumentLoader | undefined;
+    protected get _contextLoader(): DocumentLoader | undefined;
+    /**
+     * The type URI of {@link Multikey}: `https://w3id.org/security#Multikey`.
+     */
+    static get typeId(): URL;
+    /**
+     * Constructs a new instance of Multikey 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;
+        controller?: Application | Group | Organization | Person | Service | URL | null;
+        publicKey?: dntShim.CryptoKey | null;
+    }, { 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;
+        controller?: Application | Group | Organization | Person | Service | URL | null;
+        publicKey?: dntShim.CryptoKey | null;
+    }, options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    }): Multikey;
+    /**
+     * Similar to
+     * {@link Multikey.getController},
+     * but returns its `@id` URL instead of the object itself.
+     */
+    get controllerId(): URL | null;
+    /** An actor who owns this key.
+     */
+    getController(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    }): Promise<Application | Group | Organization | Person | Service | null>;
+    /** A [Multibase]-encoded value of a [Multicodec] prefix and the key.
+     *
+     * [Multibase]: https://www.w3.org/TR/vc-data-integrity/#multibase-0
+     * [Multicodec]: https://github.com/multiformats/multicodec/
+     */
+    get publicKey(): dntShim.CryptoKey | null;
+    /**
+     * Converts this object to a JSON-LD structure.
+     * @returns The JSON-LD representation of this object.
+     */
+    toJsonLd(options?: {
+        expand?: boolean;
+        contextLoader?: DocumentLoader;
+    }): 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<Multikey>;
+    protected _getCustomInspectProxy(): Record<string, unknown>;
+}
 /** An Activity is a subtype of {@link Object} that describes some form of action
  * that may happen, is currently happening, or has already happened.
  * The {@link Activity} type itself serves as an abstract base type for all types
@@ -1546,6 +1625,8 @@ export declare class Application extends Object {
         preferredUsernames?: (string | LanguageString)[];
         publicKey?: CryptographicKey | URL | null;
         publicKeys?: (CryptographicKey | URL)[];
+        assertionMethod?: Multikey | URL | null;
+        assertionMethods?: (Multikey | URL)[];
         manuallyApprovesFollowers?: boolean | null;
         inbox?: OrderedCollection | URL | null;
         outbox?: OrderedCollection | URL | null;
@@ -1616,6 +1697,8 @@ export declare class Application extends Object {
         preferredUsernames?: (string | LanguageString)[];
         publicKey?: CryptographicKey | URL | null;
         publicKeys?: (CryptographicKey | URL)[];
+        assertionMethod?: Multikey | URL | null;
+        assertionMethods?: (Multikey | URL)[];
         manuallyApprovesFollowers?: boolean | null;
         inbox?: OrderedCollection | URL | null;
         outbox?: OrderedCollection | URL | null;
@@ -1664,6 +1747,36 @@ export declare class Application extends Object {
         documentLoader?: DocumentLoader;
         contextLoader?: DocumentLoader;
     }): AsyncIterable<CryptographicKey>;
+    /**
+     * Similar to
+     * {@link Application.getAssertionMethod},
+     * but returns its `@id` URL instead of the object itself.
+     */
+    get assertionMethodId(): URL | null;
+    /** Represents this actor's public keys.  It serves as equivalent to
+     * the `publicKeys` property, but is used for [FEP-521a] compliance.
+     *
+     * [FEP-521a]: https://codeberg.org/fediverse/fep/src/branch/main/fep/521a/fep-521a.md
+     */
+    getAssertionMethod(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    }): Promise<Multikey | null>;
+    /**
+     * Similar to
+     * {@link Application.getAssertionMethods},
+     * but returns their `@id`s instead of the objects themselves.
+     */
+    get assertionMethodIds(): URL[];
+    /** Represents this actor's public keys.  It serves as equivalent to
+     * the `publicKeys` property, but is used for [FEP-521a] compliance.
+     *
+     * [FEP-521a]: https://codeberg.org/fediverse/fep/src/branch/main/fep/521a/fep-521a.md
+     */
+    getAssertionMethods(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    }): AsyncIterable<Multikey>;
     /** When `true`, conveys that for this actor, follow requests are not usually
      * automatically approved, but instead are examined by a person who may accept
      * or reject the request, at some time in the future.  Setting of `false`
@@ -3944,6 +4057,8 @@ export declare class Group extends Object {
         preferredUsernames?: (string | LanguageString)[];
         publicKey?: CryptographicKey | URL | null;
         publicKeys?: (CryptographicKey | URL)[];
+        assertionMethod?: Multikey | URL | null;
+        assertionMethods?: (Multikey | URL)[];
         manuallyApprovesFollowers?: boolean | null;
         inbox?: OrderedCollection | URL | null;
         outbox?: OrderedCollection | URL | null;
@@ -4014,6 +4129,8 @@ export declare class Group extends Object {
         preferredUsernames?: (string | LanguageString)[];
         publicKey?: CryptographicKey | URL | null;
         publicKeys?: (CryptographicKey | URL)[];
+        assertionMethod?: Multikey | URL | null;
+        assertionMethods?: (Multikey | URL)[];
         manuallyApprovesFollowers?: boolean | null;
         inbox?: OrderedCollection | URL | null;
         outbox?: OrderedCollection | URL | null;
@@ -4062,6 +4179,36 @@ export declare class Group extends Object {
         documentLoader?: DocumentLoader;
         contextLoader?: DocumentLoader;
     }): AsyncIterable<CryptographicKey>;
+    /**
+     * Similar to
+     * {@link Group.getAssertionMethod},
+     * but returns its `@id` URL instead of the object itself.
+     */
+    get assertionMethodId(): URL | null;
+    /** Represents this actor's public keys.  It serves as equivalent to
+     * the `publicKeys` property, but is used for [FEP-521a] compliance.
+     *
+     * [FEP-521a]: https://codeberg.org/fediverse/fep/src/branch/main/fep/521a/fep-521a.md
+     */
+    getAssertionMethod(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    }): Promise<Multikey | null>;
+    /**
+     * Similar to
+     * {@link Group.getAssertionMethods},
+     * but returns their `@id`s instead of the objects themselves.
+     */
+    get assertionMethodIds(): URL[];
+    /** Represents this actor's public keys.  It serves as equivalent to
+     * the `publicKeys` property, but is used for [FEP-521a] compliance.
+     *
+     * [FEP-521a]: https://codeberg.org/fediverse/fep/src/branch/main/fep/521a/fep-521a.md
+     */
+    getAssertionMethods(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    }): AsyncIterable<Multikey>;
     /** When `true`, conveys that for this actor, follow requests are not usually
      * automatically approved, but instead are examined by a person who may accept
      * or reject the request, at some time in the future.  Setting of `false`
@@ -5426,6 +5573,8 @@ export declare class Organization extends Object {
         preferredUsernames?: (string | LanguageString)[];
         publicKey?: CryptographicKey | URL | null;
         publicKeys?: (CryptographicKey | URL)[];
+        assertionMethod?: Multikey | URL | null;
+        assertionMethods?: (Multikey | URL)[];
         manuallyApprovesFollowers?: boolean | null;
         inbox?: OrderedCollection | URL | null;
         outbox?: OrderedCollection | URL | null;
@@ -5496,6 +5645,8 @@ export declare class Organization extends Object {
         preferredUsernames?: (string | LanguageString)[];
         publicKey?: CryptographicKey | URL | null;
         publicKeys?: (CryptographicKey | URL)[];
+        assertionMethod?: Multikey | URL | null;
+        assertionMethods?: (Multikey | URL)[];
         manuallyApprovesFollowers?: boolean | null;
         inbox?: OrderedCollection | URL | null;
         outbox?: OrderedCollection | URL | null;
@@ -5544,6 +5695,36 @@ export declare class Organization extends Object {
         documentLoader?: DocumentLoader;
         contextLoader?: DocumentLoader;
     }): AsyncIterable<CryptographicKey>;
+    /**
+     * Similar to
+     * {@link Organization.getAssertionMethod},
+     * but returns its `@id` URL instead of the object itself.
+     */
+    get assertionMethodId(): URL | null;
+    /** Represents this actor's public keys.  It serves as equivalent to
+     * the `publicKeys` property, but is used for [FEP-521a] compliance.
+     *
+     * [FEP-521a]: https://codeberg.org/fediverse/fep/src/branch/main/fep/521a/fep-521a.md
+     */
+    getAssertionMethod(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    }): Promise<Multikey | null>;
+    /**
+     * Similar to
+     * {@link Organization.getAssertionMethods},
+     * but returns their `@id`s instead of the objects themselves.
+     */
+    get assertionMethodIds(): URL[];
+    /** Represents this actor's public keys.  It serves as equivalent to
+     * the `publicKeys` property, but is used for [FEP-521a] compliance.
+     *
+     * [FEP-521a]: https://codeberg.org/fediverse/fep/src/branch/main/fep/521a/fep-521a.md
+     */
+    getAssertionMethods(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    }): AsyncIterable<Multikey>;
     /** When `true`, conveys that for this actor, follow requests are not usually
      * automatically approved, but instead are examined by a person who may accept
      * or reject the request, at some time in the future.  Setting of `false`
@@ -5902,6 +6083,8 @@ export declare class Person extends Object {
         preferredUsernames?: (string | LanguageString)[];
         publicKey?: CryptographicKey | URL | null;
         publicKeys?: (CryptographicKey | URL)[];
+        assertionMethod?: Multikey | URL | null;
+        assertionMethods?: (Multikey | URL)[];
         manuallyApprovesFollowers?: boolean | null;
         inbox?: OrderedCollection | URL | null;
         outbox?: OrderedCollection | URL | null;
@@ -5972,6 +6155,8 @@ export declare class Person extends Object {
         preferredUsernames?: (string | LanguageString)[];
         publicKey?: CryptographicKey | URL | null;
         publicKeys?: (CryptographicKey | URL)[];
+        assertionMethod?: Multikey | URL | null;
+        assertionMethods?: (Multikey | URL)[];
         manuallyApprovesFollowers?: boolean | null;
         inbox?: OrderedCollection | URL | null;
         outbox?: OrderedCollection | URL | null;
@@ -6020,6 +6205,36 @@ export declare class Person extends Object {
         documentLoader?: DocumentLoader;
         contextLoader?: DocumentLoader;
     }): AsyncIterable<CryptographicKey>;
+    /**
+     * Similar to
+     * {@link Person.getAssertionMethod},
+     * but returns its `@id` URL instead of the object itself.
+     */
+    get assertionMethodId(): URL | null;
+    /** Represents this actor's public keys.  It serves as equivalent to
+     * the `publicKeys` property, but is used for [FEP-521a] compliance.
+     *
+     * [FEP-521a]: https://codeberg.org/fediverse/fep/src/branch/main/fep/521a/fep-521a.md
+     */
+    getAssertionMethod(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    }): Promise<Multikey | null>;
+    /**
+     * Similar to
+     * {@link Person.getAssertionMethods},
+     * but returns their `@id`s instead of the objects themselves.
+     */
+    get assertionMethodIds(): URL[];
+    /** Represents this actor's public keys.  It serves as equivalent to
+     * the `publicKeys` property, but is used for [FEP-521a] compliance.
+     *
+     * [FEP-521a]: https://codeberg.org/fediverse/fep/src/branch/main/fep/521a/fep-521a.md
+     */
+    getAssertionMethods(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    }): AsyncIterable<Multikey>;
     /** When `true`, conveys that for this actor, follow requests are not usually
      * automatically approved, but instead are examined by a person who may accept
      * or reject the request, at some time in the future.  Setting of `false`
@@ -7073,6 +7288,8 @@ export declare class Service extends Object {
         preferredUsernames?: (string | LanguageString)[];
         publicKey?: CryptographicKey | URL | null;
         publicKeys?: (CryptographicKey | URL)[];
+        assertionMethod?: Multikey | URL | null;
+        assertionMethods?: (Multikey | URL)[];
         manuallyApprovesFollowers?: boolean | null;
         inbox?: OrderedCollection | URL | null;
         outbox?: OrderedCollection | URL | null;
@@ -7143,6 +7360,8 @@ export declare class Service extends Object {
         preferredUsernames?: (string | LanguageString)[];
         publicKey?: CryptographicKey | URL | null;
         publicKeys?: (CryptographicKey | URL)[];
+        assertionMethod?: Multikey | URL | null;
+        assertionMethods?: (Multikey | URL)[];
         manuallyApprovesFollowers?: boolean | null;
         inbox?: OrderedCollection | URL | null;
         outbox?: OrderedCollection | URL | null;
@@ -7191,6 +7410,36 @@ export declare class Service extends Object {
         documentLoader?: DocumentLoader;
         contextLoader?: DocumentLoader;
     }): AsyncIterable<CryptographicKey>;
+    /**
+     * Similar to
+     * {@link Service.getAssertionMethod},
+     * but returns its `@id` URL instead of the object itself.
+     */
+    get assertionMethodId(): URL | null;
+    /** Represents this actor's public keys.  It serves as equivalent to
+     * the `publicKeys` property, but is used for [FEP-521a] compliance.
+     *
+     * [FEP-521a]: https://codeberg.org/fediverse/fep/src/branch/main/fep/521a/fep-521a.md
+     */
+    getAssertionMethod(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    }): Promise<Multikey | null>;
+    /**
+     * Similar to
+     * {@link Service.getAssertionMethods},
+     * but returns their `@id`s instead of the objects themselves.
+     */
+    get assertionMethodIds(): URL[];
+    /** Represents this actor's public keys.  It serves as equivalent to
+     * the `publicKeys` property, but is used for [FEP-521a] compliance.
+     *
+     * [FEP-521a]: https://codeberg.org/fediverse/fep/src/branch/main/fep/521a/fep-521a.md
+     */
+    getAssertionMethods(options?: {
+        documentLoader?: DocumentLoader;
+        contextLoader?: DocumentLoader;
+    }): AsyncIterable<Multikey>;
     /** When `true`, conveys that for this actor, follow requests are not usually
      * automatically approved, but instead are examined by a person who may accept
      * or reject the request, at some time in the future.  Setting of `false`