@fedify/relay 2.2.0-pr.695.16 → 2.2.0-pr.695.23

package/dist/litepub.test.js

@@ -1,11 +1,10 @@
 import "@js-temporal/polyfill";
 import "urlpattern-polyfill";
 globalThis.addEventListener = () => {};
-import { t as isRelayFollowerData } from "./types-BcFcxptW.js";
+import { n as exportSpki, r as getDocumentLoader, t as isRelayFollowerData } from "./types-CepXNn7F.js";
 import { MemoryKvStore, signRequest } from "@fedify/fedify";
 import { createRelay } from "@fedify/relay";
 import { Accept, Announce, Create, Delete, Follow, Move, Note, Person, Undo, Update } from "@fedify/vocab";
-import { exportSpki, getDocumentLoader } from "@fedify/vocab-runtime";
 import { ok, strictEqual } from "node:assert";
 import test, { describe } from "node:test";
 //#region src/litepub.test.ts

package/dist/mastodon.test.js

@@ -1,11 +1,10 @@
 import "@js-temporal/polyfill";
 import "urlpattern-polyfill";
 globalThis.addEventListener = () => {};
-import { t as isRelayFollowerData } from "./types-BcFcxptW.js";
+import { n as exportSpki, r as getDocumentLoader, t as isRelayFollowerData } from "./types-CepXNn7F.js";
 import { MemoryKvStore, signRequest } from "@fedify/fedify";
 import { createRelay } from "@fedify/relay";
 import { Create, Delete, Follow, Move, Note, Person, Undo, Update } from "@fedify/vocab";
-import { exportSpki, getDocumentLoader } from "@fedify/vocab-runtime";
 import { ok, strictEqual } from "node:assert";
 import test, { describe } from "node:test";
 //#region src/mastodon.test.ts

package/dist/mod.d.cts

@@ -1,7 +1,123 @@
 import { Context, KvStore, MessageQueue } from "@fedify/fedify";
 import { Actor } from "@fedify/vocab";
-import { AuthenticatedDocumentLoaderFactory, DocumentLoaderFactory } from "@fedify/vocab-runtime";
-
+//#region ../vocab-runtime/dist/mod.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;
+  /**
+  * The maximum number of redirections to follow.
+  * @default `20`
+  * @since 2.2.0
+  */
+  maxRedirection?: number;
+}
+/**
+* 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
+*/
+//#endregion
 //#region src/types.d.ts
 declare const RELAY_SERVER_ACTOR = "relay";
 /**

package/dist/mod.d.ts

@@ -1,8 +1,124 @@
 import { Temporal } from "@js-temporal/polyfill";
 import { Context, KvStore, MessageQueue } from "@fedify/fedify";
 import { Actor } from "@fedify/vocab";
-import { AuthenticatedDocumentLoaderFactory, DocumentLoaderFactory } from "@fedify/vocab-runtime";
-
+//#region ../vocab-runtime/dist/mod.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;
+  /**
+  * The maximum number of redirections to follow.
+  * @default `20`
+  * @since 2.2.0
+  */
+  maxRedirection?: number;
+}
+/**
+* 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
+*/
+//#endregion
 //#region src/types.d.ts
 declare const RELAY_SERVER_ACTOR = "relay";
 /**