@fedify/vocab-runtime 2.0.0-pr.451.1730

package/dist/mod.d.cts

@@ -0,0 +1,274 @@
+//#region src/request.d.ts
+
+/**
+ * Options for making `User-Agent` string.
+ * @see {@link getUserAgent}
+ * @since 1.3.0
+ */
+interface GetUserAgentOptions {
+  /**
+   * An optional software name and version, e.g., `"Hollo/1.0.0"`.
+   */
+  software?: string | null;
+  /**
+   * An optional URL to append to the user agent string.
+   * Usually the URL of the ActivityPub instance.
+   */
+  url?: string | URL | null;
+}
+/**
+ * Gets the user agent string for the given application and URL.
+ * @param options The options for making the user agent string.
+ * @returns The user agent string.
+ * @since 1.3.0
+ */
+//#endregion
+//#region src/docloader.d.ts
+/**
+ * A remote JSON-LD document and its context fetched by
+ * a {@link DocumentLoader}.
+ */
+interface RemoteDocument {
+  /**
+   * The URL of the context document.
+   */
+  contextUrl: string | null;
+  /**
+   * The fetched JSON-LD document.
+   */
+  document: unknown;
+  /**
+   * The URL of the fetched document.
+   */
+  documentUrl: string;
+}
+/**
+ * Options for {@link DocumentLoader}.
+ * @since 1.8.0
+ */
+interface DocumentLoaderOptions {
+  /**
+   * An `AbortSignal` for cancellation.
+   * @since 1.8.0
+   */
+  signal?: AbortSignal;
+}
+/**
+ * A JSON-LD document loader that fetches documents from the Web.
+ * @param url The URL of the document to load.
+ * @param options The options for the document loader.
+ * @returns The loaded remote document.
+ */
+type DocumentLoader = (url: string, options?: DocumentLoaderOptions) => Promise<RemoteDocument>;
+/**
+ * A factory function that creates a {@link DocumentLoader} with options.
+ * @param options The options for the document loader.
+ * @returns The document loader.
+ * @since 1.4.0
+ */
+type DocumentLoaderFactory = (options?: DocumentLoaderFactoryOptions) => DocumentLoader;
+/**
+ * Options for {@link DocumentLoaderFactory}.
+ * @see {@link DocumentLoaderFactory}
+ * @see {@link AuthenticatedDocumentLoaderFactory}
+ * @since 1.4.0
+ */
+interface DocumentLoaderFactoryOptions {
+  /**
+   * Whether to allow fetching private network addresses.
+   * Turned off by default.
+   * @default `false``
+   */
+  allowPrivateAddress?: boolean;
+  /**
+   * Options for making `User-Agent` string.
+   * If a string is given, it is used as the `User-Agent` header value.
+   * If an object is given, it is passed to {@link getUserAgent} function.
+   */
+  userAgent?: GetUserAgentOptions | string;
+}
+/**
+ * A factory function that creates an authenticated {@link DocumentLoader} for
+ * a given identity.  This is used for fetching documents that require
+ * authentication.
+ * @param identity The identity to create the document loader for.
+ *                 The actor's key pair.
+ * @param options The options for the document loader.
+ * @returns The authenticated document loader.
+ * @since 0.4.0
+ */
+type AuthenticatedDocumentLoaderFactory = (identity: {
+  keyId: URL;
+  privateKey: CryptoKey;
+}, options?: DocumentLoaderFactoryOptions) => DocumentLoader;
+/**
+ * Gets a {@link RemoteDocument} from the given response.
+ * @param url The URL of the document to load.
+ * @param response The response to get the document from.
+ * @param fetch The function to fetch the document.
+ * @returns The loaded remote document.
+ * @throws {FetchError} If the response is not OK.
+ * @internal
+ */
+declare function getRemoteDocument(url: string, response: Response, fetch: (url: string, options?: DocumentLoaderOptions) => Promise<RemoteDocument>): Promise<RemoteDocument>;
+/**
+ * Options for {@link getDocumentLoader}.
+ * @since 1.3.0
+ */
+interface GetDocumentLoaderOptions extends DocumentLoaderFactoryOptions {
+  /**
+   * Whether to preload the frequently used contexts.
+   */
+  skipPreloadedContexts?: boolean;
+}
+/**
+ * Creates a JSON-LD document loader that utilizes the browser's `fetch` API.
+ *
+ * The created loader preloads the below frequently used contexts by default
+ * (unless `options.ignorePreloadedContexts` is set to `true`):
+ *
+ * - <https://www.w3.org/ns/activitystreams>
+ * - <https://w3id.org/security/v1>
+ * - <https://w3id.org/security/data-integrity/v1>
+ * - <https://www.w3.org/ns/did/v1>
+ * - <https://w3id.org/security/multikey/v1>
+ * - <https://purl.archive.org/socialweb/webfinger>
+ * - <http://schema.org/>
+ * @param options Options for the document loader.
+ * @returns The document loader.
+ * @since 1.3.0
+ */
+declare function getDocumentLoader({
+  allowPrivateAddress,
+  skipPreloadedContexts,
+  userAgent
+}?: GetDocumentLoaderOptions): DocumentLoader;
+//#endregion
+//#region src/key.d.ts
+/**
+ * Imports a PEM-SPKI formatted public key.
+ * @param pem The PEM-SPKI formatted public key.
+ * @returns The imported public key.
+ * @throws {TypeError} If the key is invalid or unsupported.
+ * @since 0.5.0
+ */
+declare function importSpki(pem: string): Promise<CryptoKey>;
+/**
+ * Exports a public key in PEM-SPKI format.
+ * @param key The public key to export.
+ * @returns The exported public key in PEM-SPKI format.
+ * @throws {TypeError} If the key is invalid or unsupported.
+ * @since 0.5.0
+ */
+declare function exportSpki(key: CryptoKey): Promise<string>;
+/**
+ * Imports a PEM-PKCS#1 formatted public key.
+ * @param pem The PEM-PKCS#1 formatted public key.
+ * @returns The imported public key.
+ * @throws {TypeError} If the key is invalid or unsupported.
+ * @since 1.5.0
+ */
+declare function importPkcs1(pem: string): Promise<CryptoKey>;
+/**
+ * Imports a PEM formatted public key (SPKI or PKCS#1).
+ * @param pem The PEM formatted public key to import (SPKI or PKCS#1).
+ * @returns The imported public key.
+ * @throws {TypeError} If the key is invalid or unsupported.
+ * @since 1.5.0
+ */
+declare function importPem(pem: string): Promise<CryptoKey>;
+/**
+ * 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
+ */
+declare function importMultibaseKey(key: string): Promise<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
+ */
+declare function exportMultibaseKey(key: CryptoKey): Promise<string>;
+//#endregion
+//#region src/langstr.d.ts
+/**
+ * A language-tagged string which corresponds to the `rdf:langString` type.
+ */
+declare class LanguageString extends String {
+  /**
+   * The locale of the string.
+   * @since 2.0.0
+   */
+  readonly locale: Intl.Locale;
+  /**
+   * Constructs a new `LanguageString`.
+   * @param value A string value written in the given language.
+   * @param locale The language of the string.  If a string is given, it will
+   *               be parsed as a `Intl.Locale` object.
+   */
+  constructor(value: string, language: Intl.Locale | string);
+}
+//#endregion
+//#region src/multibase/types.d.ts
+type BaseCode = "\x00" | "0" | "7" | "9" | "f" | "F" | "v" | "V" | "t" | "T" | "b" | "B" | "c" | "C" | "h" | "k" | "K" | "z" | "Z" | "m" | "M" | "u" | "U";
+
+/**
+ * - Names of the supported encodings
+ */
+type BaseName = "identity" | "base2" | "base8" | "base10" | "base16" | "base16upper" | "base32hex" | "base32hexupper" | "base32hexpad" | "base32hexpadupper" | "base32" | "base32upper" | "base32pad" | "base32padupper" | "base32z" | "base36" | "base36upper" | "base58btc" | "base58flickr" | "base64" | "base64pad" | "base64url" | "base64urlpad";
+type BaseNameOrCode = BaseCode | BaseName;
+interface Codec {
+  encode: (buffer: Uint8Array) => string;
+  decode: (hash: string) => Uint8Array;
+}
+interface CodecFactory {
+  (input: string): Codec;
+}
+//#endregion
+//#region src/multibase/base.d.ts
+/**
+ * Class to encode/decode in the supported Bases
+ */
+declare class Base {
+  name: BaseName;
+  private code;
+  private alphabet;
+  codeBuf: Uint8Array;
+  codec: Codec;
+  constructor(name: BaseName, code: BaseCode, factory: CodecFactory, alphabet: string);
+  encode(buf: Uint8Array): string;
+  decode(string: string): Uint8Array;
+}
+//#endregion
+//#region src/multibase/mod.d.ts
+/**
+ * Encode data with the specified base and add the multibase prefix.
+ *
+ * @throws {Error} Will throw if the encoding is not supported
+ */
+declare function encodeMultibase(nameOrCode: BaseNameOrCode, buf: Uint8Array): Uint8Array;
+/**
+ * Takes a Uint8Array or string encoded with multibase header, decodes it and
+ * returns the decoded buffer
+ *
+ * @throws {Error} Will throw if the encoding is not supported
+ */
+declare function decodeMultibase(data: Uint8Array | string): Uint8Array;
+/**
+ * Get encoding multibase from data
+ *
+ * @param {string|Uint8Array} data
+ * @returns {Base}
+ * @throws {Error} Will throw if the encoding is not supported
+ */
+declare function encodingFromBaseData(data: string | Uint8Array): Base;
+//#endregion
+export { AuthenticatedDocumentLoaderFactory, DocumentLoader, DocumentLoaderFactory, DocumentLoaderFactoryOptions, DocumentLoaderOptions, GetDocumentLoaderOptions, LanguageString, RemoteDocument, decodeMultibase, encodeMultibase, encodingFromBaseData, exportMultibaseKey, exportSpki, getDocumentLoader, getRemoteDocument, importMultibaseKey, importPem, importPkcs1, importSpki };

package/dist/mod.d.ts

@@ -0,0 +1,276 @@
+import "@logtape/logtape";
+
+//#region src/request.d.ts
+
+/**
+ * Options for making `User-Agent` string.
+ * @see {@link getUserAgent}
+ * @since 1.3.0
+ */
+interface GetUserAgentOptions {
+  /**
+   * An optional software name and version, e.g., `"Hollo/1.0.0"`.
+   */
+  software?: string | null;
+  /**
+   * An optional URL to append to the user agent string.
+   * Usually the URL of the ActivityPub instance.
+   */
+  url?: string | URL | null;
+}
+/**
+ * Gets the user agent string for the given application and URL.
+ * @param options The options for making the user agent string.
+ * @returns The user agent string.
+ * @since 1.3.0
+ */
+//#endregion
+//#region src/docloader.d.ts
+/**
+ * A remote JSON-LD document and its context fetched by
+ * a {@link DocumentLoader}.
+ */
+interface RemoteDocument {
+  /**
+   * The URL of the context document.
+   */
+  contextUrl: string | null;
+  /**
+   * The fetched JSON-LD document.
+   */
+  document: unknown;
+  /**
+   * The URL of the fetched document.
+   */
+  documentUrl: string;
+}
+/**
+ * Options for {@link DocumentLoader}.
+ * @since 1.8.0
+ */
+interface DocumentLoaderOptions {
+  /**
+   * An `AbortSignal` for cancellation.
+   * @since 1.8.0
+   */
+  signal?: AbortSignal;
+}
+/**
+ * A JSON-LD document loader that fetches documents from the Web.
+ * @param url The URL of the document to load.
+ * @param options The options for the document loader.
+ * @returns The loaded remote document.
+ */
+type DocumentLoader = (url: string, options?: DocumentLoaderOptions) => Promise<RemoteDocument>;
+/**
+ * A factory function that creates a {@link DocumentLoader} with options.
+ * @param options The options for the document loader.
+ * @returns The document loader.
+ * @since 1.4.0
+ */
+type DocumentLoaderFactory = (options?: DocumentLoaderFactoryOptions) => DocumentLoader;
+/**
+ * Options for {@link DocumentLoaderFactory}.
+ * @see {@link DocumentLoaderFactory}
+ * @see {@link AuthenticatedDocumentLoaderFactory}
+ * @since 1.4.0
+ */
+interface DocumentLoaderFactoryOptions {
+  /**
+   * Whether to allow fetching private network addresses.
+   * Turned off by default.
+   * @default `false``
+   */
+  allowPrivateAddress?: boolean;
+  /**
+   * Options for making `User-Agent` string.
+   * If a string is given, it is used as the `User-Agent` header value.
+   * If an object is given, it is passed to {@link getUserAgent} function.
+   */
+  userAgent?: GetUserAgentOptions | string;
+}
+/**
+ * A factory function that creates an authenticated {@link DocumentLoader} for
+ * a given identity.  This is used for fetching documents that require
+ * authentication.
+ * @param identity The identity to create the document loader for.
+ *                 The actor's key pair.
+ * @param options The options for the document loader.
+ * @returns The authenticated document loader.
+ * @since 0.4.0
+ */
+type AuthenticatedDocumentLoaderFactory = (identity: {
+  keyId: URL;
+  privateKey: CryptoKey;
+}, options?: DocumentLoaderFactoryOptions) => DocumentLoader;
+/**
+ * Gets a {@link RemoteDocument} from the given response.
+ * @param url The URL of the document to load.
+ * @param response The response to get the document from.
+ * @param fetch The function to fetch the document.
+ * @returns The loaded remote document.
+ * @throws {FetchError} If the response is not OK.
+ * @internal
+ */
+declare function getRemoteDocument(url: string, response: Response, fetch: (url: string, options?: DocumentLoaderOptions) => Promise<RemoteDocument>): Promise<RemoteDocument>;
+/**
+ * Options for {@link getDocumentLoader}.
+ * @since 1.3.0
+ */
+interface GetDocumentLoaderOptions extends DocumentLoaderFactoryOptions {
+  /**
+   * Whether to preload the frequently used contexts.
+   */
+  skipPreloadedContexts?: boolean;
+}
+/**
+ * Creates a JSON-LD document loader that utilizes the browser's `fetch` API.
+ *
+ * The created loader preloads the below frequently used contexts by default
+ * (unless `options.ignorePreloadedContexts` is set to `true`):
+ *
+ * - <https://www.w3.org/ns/activitystreams>
+ * - <https://w3id.org/security/v1>
+ * - <https://w3id.org/security/data-integrity/v1>
+ * - <https://www.w3.org/ns/did/v1>
+ * - <https://w3id.org/security/multikey/v1>
+ * - <https://purl.archive.org/socialweb/webfinger>
+ * - <http://schema.org/>
+ * @param options Options for the document loader.
+ * @returns The document loader.
+ * @since 1.3.0
+ */
+declare function getDocumentLoader({
+  allowPrivateAddress,
+  skipPreloadedContexts,
+  userAgent
+}?: GetDocumentLoaderOptions): DocumentLoader;
+//#endregion
+//#region src/key.d.ts
+/**
+ * Imports a PEM-SPKI formatted public key.
+ * @param pem The PEM-SPKI formatted public key.
+ * @returns The imported public key.
+ * @throws {TypeError} If the key is invalid or unsupported.
+ * @since 0.5.0
+ */
+declare function importSpki(pem: string): Promise<CryptoKey>;
+/**
+ * Exports a public key in PEM-SPKI format.
+ * @param key The public key to export.
+ * @returns The exported public key in PEM-SPKI format.
+ * @throws {TypeError} If the key is invalid or unsupported.
+ * @since 0.5.0
+ */
+declare function exportSpki(key: CryptoKey): Promise<string>;
+/**
+ * Imports a PEM-PKCS#1 formatted public key.
+ * @param pem The PEM-PKCS#1 formatted public key.
+ * @returns The imported public key.
+ * @throws {TypeError} If the key is invalid or unsupported.
+ * @since 1.5.0
+ */
+declare function importPkcs1(pem: string): Promise<CryptoKey>;
+/**
+ * Imports a PEM formatted public key (SPKI or PKCS#1).
+ * @param pem The PEM formatted public key to import (SPKI or PKCS#1).
+ * @returns The imported public key.
+ * @throws {TypeError} If the key is invalid or unsupported.
+ * @since 1.5.0
+ */
+declare function importPem(pem: string): Promise<CryptoKey>;
+/**
+ * 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
+ */
+declare function importMultibaseKey(key: string): Promise<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
+ */
+declare function exportMultibaseKey(key: CryptoKey): Promise<string>;
+//#endregion
+//#region src/langstr.d.ts
+/**
+ * A language-tagged string which corresponds to the `rdf:langString` type.
+ */
+declare class LanguageString extends String {
+  /**
+   * The locale of the string.
+   * @since 2.0.0
+   */
+  readonly locale: Intl.Locale;
+  /**
+   * Constructs a new `LanguageString`.
+   * @param value A string value written in the given language.
+   * @param locale The language of the string.  If a string is given, it will
+   *               be parsed as a `Intl.Locale` object.
+   */
+  constructor(value: string, language: Intl.Locale | string);
+}
+//#endregion
+//#region src/multibase/types.d.ts
+type BaseCode = "\x00" | "0" | "7" | "9" | "f" | "F" | "v" | "V" | "t" | "T" | "b" | "B" | "c" | "C" | "h" | "k" | "K" | "z" | "Z" | "m" | "M" | "u" | "U";
+
+/**
+ * - Names of the supported encodings
+ */
+type BaseName = "identity" | "base2" | "base8" | "base10" | "base16" | "base16upper" | "base32hex" | "base32hexupper" | "base32hexpad" | "base32hexpadupper" | "base32" | "base32upper" | "base32pad" | "base32padupper" | "base32z" | "base36" | "base36upper" | "base58btc" | "base58flickr" | "base64" | "base64pad" | "base64url" | "base64urlpad";
+type BaseNameOrCode = BaseCode | BaseName;
+interface Codec {
+  encode: (buffer: Uint8Array) => string;
+  decode: (hash: string) => Uint8Array;
+}
+interface CodecFactory {
+  (input: string): Codec;
+}
+//#endregion
+//#region src/multibase/base.d.ts
+/**
+ * Class to encode/decode in the supported Bases
+ */
+declare class Base {
+  name: BaseName;
+  private code;
+  private alphabet;
+  codeBuf: Uint8Array;
+  codec: Codec;
+  constructor(name: BaseName, code: BaseCode, factory: CodecFactory, alphabet: string);
+  encode(buf: Uint8Array): string;
+  decode(string: string): Uint8Array;
+}
+//#endregion
+//#region src/multibase/mod.d.ts
+/**
+ * Encode data with the specified base and add the multibase prefix.
+ *
+ * @throws {Error} Will throw if the encoding is not supported
+ */
+declare function encodeMultibase(nameOrCode: BaseNameOrCode, buf: Uint8Array): Uint8Array;
+/**
+ * Takes a Uint8Array or string encoded with multibase header, decodes it and
+ * returns the decoded buffer
+ *
+ * @throws {Error} Will throw if the encoding is not supported
+ */
+declare function decodeMultibase(data: Uint8Array | string): Uint8Array;
+/**
+ * Get encoding multibase from data
+ *
+ * @param {string|Uint8Array} data
+ * @returns {Base}
+ * @throws {Error} Will throw if the encoding is not supported
+ */
+declare function encodingFromBaseData(data: string | Uint8Array): Base;
+//#endregion
+export { AuthenticatedDocumentLoaderFactory, DocumentLoader, DocumentLoaderFactory, DocumentLoaderFactoryOptions, DocumentLoaderOptions, GetDocumentLoaderOptions, LanguageString, RemoteDocument, decodeMultibase, encodeMultibase, encodingFromBaseData, exportMultibaseKey, exportSpki, getDocumentLoader, getRemoteDocument, importMultibaseKey, importPem, importPkcs1, importSpki };