@fedify/fedify 2.0.0-dev.1561 → 2.0.0-dev.158

package/dist/middleware-DSz6sI16.js

@@ -0,0 +1,26 @@
+
+      import { Temporal } from "@js-temporal/polyfill";
+      import { URLPattern } from "urlpattern-polyfill";
+      globalThis.addEventListener = () => {};
+    
+import "./deno-CQV858ip.js";
+import { ContextImpl, FederationImpl, InboxContextImpl, KvSpecDeterminer, createFederation } from "./middleware-ClkhKNXU.js";
+import "./client-CgMTXmAD.js";
+import "./router-D9eI0s4b.js";
+import "./types-BEdCLHqP.js";
+import "./key-C27c_yHR.js";
+import "./http-CXG5ZFqn.js";
+import "./ld-D_Jn1aGa.js";
+import "./owner-Dc8rUE-H.js";
+import "./proof-BdNM3iSl.js";
+import "./docloader-Csc8gQux.js";
+import "./kv-cache-BEeqyGER.js";
+import "./inbox-B7ybw6fk.js";
+import "./builder-BnWso6VP.js";
+import "./collection-CcnIw1qY.js";
+import "./keycache-DRxpZ5r9.js";
+import "./negotiation-5NPJL6zp.js";
+import "./retry-D4GJ670a.js";
+import "./send-DBRRqVMa.js";
+
+export { FederationImpl };

package/dist/middleware-OcaFHSk8.js

@@ -0,0 +1,12 @@
+
+          import { Temporal } from "@js-temporal/polyfill";
+          import { URLPattern } from "urlpattern-polyfill";
+        
+import "./transformers-N_ip_y4P.js";
+import "./http-BizGfAHd.js";
+import { ContextImpl, FederationImpl, InboxContextImpl, KvSpecDeterminer, createFederation } from "./middleware-BjS6_zkf.js";
+import "./proof-CTYnbjx5.js";
+import "./types-hKTi53FO.js";
+import "./kv-cache-B7dwGQFA.js";
+
+export { FederationImpl };

package/dist/mod-BrS8tiad.d.cts

@@ -0,0 +1,266 @@
+import { KeyCache } from "./http-ClB3pLcL.cjs";
+import { CryptographicKey, DataIntegrityProof, Multikey, Object as Object$1 } from "@fedify/vocab";
+import { DocumentLoader } from "@fedify/vocab-runtime";
+import { TracerProvider } from "@opentelemetry/api";
+
+//#region src/sig/ld.d.ts
+/**
+ * A signature of a JSON-LD document.
+ * @since 1.0.0
+ */
+interface Signature {
+  "@context"?: "https://w3id.org/identity/v1";
+  type: "RsaSignature2017";
+  id?: string;
+  creator: string;
+  created: string;
+  signatureValue: string;
+}
+/**
+ * Attaches a LD signature to the given JSON-LD document.
+ * @param jsonLd The JSON-LD document to attach the signature to.  It is not
+ *               modified.
+ * @param signature The signature to attach.
+ * @returns The JSON-LD document with the attached signature.
+ * @throws {TypeError} If the input document is not a valid JSON-LD document.
+ * @since 1.0.0
+ */
+declare function attachSignature(jsonLd: unknown, signature: Signature): {
+  signature: Signature;
+};
+/**
+ * Options for creating Linked Data Signatures.
+ * @since 1.0.0
+ */
+interface CreateSignatureOptions {
+  /**
+   * The context loader for loading remote JSON-LD contexts.
+   */
+  contextLoader?: DocumentLoader;
+  /**
+   * The time when the signature was created.  If not specified, the current
+   * time will be used.
+   */
+  created?: Temporal.Instant;
+}
+/**
+ * Creates a LD signature for the given JSON-LD document.
+ * @param jsonLd The JSON-LD document to sign.
+ * @param privateKey The private key to sign the document.
+ * @param keyId The ID of the public key that corresponds to the private key.
+ * @param options Additional options for creating the signature.
+ *                See also {@link CreateSignatureOptions}.
+ * @return The created signature.
+ * @throws {TypeError} If the private key is invalid or unsupported.
+ * @since 1.0.0
+ */
+declare function createSignature(jsonLd: unknown, privateKey: CryptoKey, keyId: URL, {
+  contextLoader,
+  created
+}?: CreateSignatureOptions): Promise<Signature>;
+/**
+ * Options for signing JSON-LD documents.
+ * @since 1.0.0
+ */
+interface SignJsonLdOptions extends CreateSignatureOptions {
+  /**
+   * The OpenTelemetry tracer provider for tracing the signing process.
+   * If omitted, the global tracer provider is used.
+   * @since 1.3.0
+   */
+  tracerProvider?: TracerProvider;
+}
+/**
+ * Signs the given JSON-LD document with the private key and returns the signed
+ * JSON-LD document.
+ * @param jsonLd The JSON-LD document to sign.
+ * @param privateKey The private key to sign the document.
+ * @param keyId The key ID to use in the signature.  It will be used by the
+ *              verifier to fetch the corresponding public key.
+ * @param options Additional options for signing the document.
+ *                See also {@link SignJsonLdOptions}.
+ * @returns The signed JSON-LD document.
+ * @throws {TypeError} If the private key is invalid or unsupported.
+ * @since 1.0.0
+ */
+declare function signJsonLd(jsonLd: unknown, privateKey: CryptoKey, keyId: URL, options: SignJsonLdOptions): Promise<{
+  signature: Signature;
+}>;
+/**
+ * Detaches Linked Data Signatures from the given JSON-LD document.
+ * @param jsonLd The JSON-LD document to modify.
+ * @returns The modified JSON-LD document.  If the input document does not
+ *          contain a signature, the original document is returned.
+ * @since 1.0.0
+ */
+declare function detachSignature(jsonLd: unknown): unknown;
+/**
+ * Options for verifying Linked Data Signatures.
+ * @since 1.0.0
+ */
+interface VerifySignatureOptions {
+  /**
+   * The document loader to use for fetching the public key.
+   */
+  documentLoader?: DocumentLoader;
+  /**
+   * The context loader to use for JSON-LD context retrieval.
+   */
+  contextLoader?: DocumentLoader;
+  /**
+   * The key cache to use for caching public keys.
+   */
+  keyCache?: KeyCache;
+  /**
+   * The OpenTelemetry tracer provider for tracing the verification process.
+   * If omitted, the global tracer provider is used.
+   * @since 1.3.0
+   */
+  tracerProvider?: TracerProvider;
+}
+/**
+ * Verifies Linked Data Signatures of the given JSON-LD document.
+ * @param jsonLd The JSON-LD document to verify.
+ * @param options Options for verifying the signature.
+ * @returns The public key that signed the document or `null` if the signature
+ *          is invalid or the key is not found.
+ * @since 1.0.0
+ */
+declare function verifySignature(jsonLd: unknown, options?: VerifySignatureOptions): Promise<CryptographicKey | null>;
+/**
+ * Options for verifying JSON-LD documents.
+ */
+interface VerifyJsonLdOptions extends VerifySignatureOptions {}
+/**
+ * Verify the authenticity of the given JSON-LD document using Linked Data
+ * Signatures.  If the document is signed, this function verifies the signature
+ * and checks if the document is attributed to the owner of the public key.
+ * If the document is not signed, this function returns `false`.
+ * @param jsonLd The JSON-LD document to verify.
+ * @param options Options for verifying the document.
+ * @returns `true` if the document is authentic; `false` otherwise.
+ */
+declare function verifyJsonLd(jsonLd: unknown, options?: VerifyJsonLdOptions): Promise<boolean>;
+//#endregion
+//#region src/sig/proof.d.ts
+/**
+ * Options for {@link createProof}.
+ * @since 0.10.0
+ */
+interface CreateProofOptions {
+  /**
+   * The context loader for loading remote JSON-LD contexts.
+   */
+  contextLoader?: DocumentLoader;
+  /**
+   * The JSON-LD context to use for serializing the object to sign.
+   */
+  context?: string | Record<string, string> | (string | Record<string, string>)[];
+  /**
+   * The time when the proof was created.  If not specified, the current time
+   * will be used.
+   */
+  created?: Temporal.Instant;
+}
+/**
+ * Creates a proof for the given object.
+ * @param object The object to create a proof for.
+ * @param privateKey The private key to sign the proof with.
+ * @param keyId The key ID to use in the proof. It will be used by the verifier.
+ * @param options Additional options.  See also {@link CreateProofOptions}.
+ * @returns The created proof.
+ * @throws {TypeError} If the private key is invalid or unsupported.
+ * @since 0.10.0
+ */
+declare function createProof(object: Object$1, privateKey: CryptoKey, keyId: URL, {
+  contextLoader,
+  context,
+  created
+}?: CreateProofOptions): Promise<DataIntegrityProof>;
+/**
+ * Options for {@link signObject}.
+ * @since 0.10.0
+ */
+interface SignObjectOptions extends CreateProofOptions {
+  /**
+   * The document loader for loading remote JSON-LD documents.
+   */
+  documentLoader?: DocumentLoader;
+  /**
+   * The OpenTelemetry tracer provider.  If omitted, the global tracer provider
+   * is used.
+   * @since 1.3.0
+   */
+  tracerProvider?: TracerProvider;
+}
+/**
+ * Signs the given object with the private key and returns the signed object.
+ * @param object The object to create a proof for.
+ * @param privateKey The private key to sign the proof with.
+ * @param keyId The key ID to use in the proof. It will be used by the verifier.
+ * @param options Additional options.  See also {@link SignObjectOptions}.
+ * @returns The signed object.
+ * @throws {TypeError} If the private key is invalid or unsupported.
+ * @since 0.10.0
+ */
+declare function signObject<T extends Object$1>(object: T, privateKey: CryptoKey, keyId: URL, options?: SignObjectOptions): Promise<T>;
+/**
+ * Options for {@link verifyProof}.
+ * @since 0.10.0
+ */
+interface VerifyProofOptions {
+  /**
+   * The context loader for loading remote JSON-LD contexts.
+   */
+  contextLoader?: DocumentLoader;
+  /**
+   * The document loader for loading remote JSON-LD documents.
+   */
+  documentLoader?: DocumentLoader;
+  /**
+   * The key cache to use for caching public keys.
+   * @since 0.12.0
+   */
+  keyCache?: KeyCache;
+  /**
+   * The OpenTelemetry tracer provider.  If omitted, the global tracer provider
+   * is used.
+   * @since 1.3.0
+   */
+  tracerProvider?: TracerProvider;
+}
+/**
+ * Verifies the given proof for the object.
+ * @param jsonLd The JSON-LD object to verify the proof for.  If it contains
+ *               any proofs, they will be ignored.
+ * @param proof The proof to verify.
+ * @param options Additional options.  See also {@link VerifyProofOptions}.
+ * @returns The public key that was used to sign the proof, or `null` if the
+ *          proof is invalid.
+ * @since 0.10.0
+ */
+declare function verifyProof(jsonLd: unknown, proof: DataIntegrityProof, options?: VerifyProofOptions): Promise<Multikey | null>;
+/**
+ * Options for {@link verifyObject}.
+ * @since 0.10.0
+ */
+interface VerifyObjectOptions extends VerifyProofOptions {}
+/**
+ * Verifies the given object.  It will verify all the proofs in the object,
+ * and succeed only if all the proofs are valid and all attributions and
+ * actors are authenticated by the proofs.
+ * @template T The type of the object to verify.
+ * @param cls The class of the object to verify.  It must be a subclass of
+ *            the {@link Object}.
+ * @param jsonLd The JSON-LD object to verify.  It's assumed that the object
+ *               is a compacted JSON-LD representation of a `T` with `@context`.
+ * @param options Additional options.  See also {@link VerifyObjectOptions}.
+ * @returns The object if it's verified, or `null` if it's not.
+ * @throws {TypeError} If the object is invalid or unsupported.
+ * @since 0.10.0
+ */
+declare function verifyObject<T extends Object$1>(cls: (new (...args: any[]) => T) & {
+  fromJsonLd(jsonLd: unknown, options: VerifyObjectOptions): Promise<T>;
+}, jsonLd: unknown, options?: VerifyObjectOptions): Promise<T | null>;
+//#endregion
+export { CreateProofOptions, CreateSignatureOptions, SignJsonLdOptions, SignObjectOptions, VerifyJsonLdOptions, VerifyObjectOptions, VerifyProofOptions, VerifySignatureOptions, attachSignature, createProof, createSignature, detachSignature, signJsonLd, signObject, verifyJsonLd, verifyObject, verifyProof, verifySignature };

package/dist/mod-C81L6_lQ.d.cts

@@ -0,0 +1 @@
+export { };

package/dist/mod-CJgbdSqb.d.ts

@@ -0,0 +1,109 @@
+import { Temporal } from "@js-temporal/polyfill";
+import { URLPattern } from "urlpattern-polyfill";
+import { HttpMessageSignaturesSpecDeterminer } from "./http-DLBDPal9.js";
+import { KvKey, KvStore } from "./kv-CtOmTRNc.js";
+import { TracerProvider } from "@opentelemetry/api";
+import { DocumentLoader, DocumentLoaderFactoryOptions } from "@fedify/vocab-runtime";
+
+//#region src/utils/docloader.d.ts
+/**
+ * Options for {@link getAuthenticatedDocumentLoader}.
+ * @see {@link getAuthenticatedDocumentLoader}
+ * @since 1.3.0
+ */
+interface GetAuthenticatedDocumentLoaderOptions extends DocumentLoaderFactoryOptions {
+  /**
+   * An optional spec determiner for HTTP Message Signatures.
+   * It determines the spec to use for signing requests.
+   * It is used for double-knocking
+   * (see <https://swicg.github.io/activitypub-http-signature/#how-to-upgrade-supported-versions>).
+   * @since 1.6.0
+   */
+  specDeterminer?: HttpMessageSignaturesSpecDeterminer;
+  /**
+   * The OpenTelemetry tracer provider.  If omitted, the global tracer provider
+   * is used.
+   * @since 1.6.0
+   */
+  tracerProvider?: TracerProvider;
+}
+/**
+ * Gets an authenticated {@link DocumentLoader} for the given identity.
+ * Note that an authenticated document loader intentionally does not cache
+ * the fetched documents.
+ * @param identity The identity to get the document loader for.
+ *                 The actor's key pair.
+ * @param options The options for the document loader.
+ * @returns The authenticated document loader.
+ * @throws {TypeError} If the key is invalid or unsupported.
+ * @since 0.4.0
+ */
+declare function getAuthenticatedDocumentLoader(identity: {
+  keyId: URL;
+  privateKey: CryptoKey;
+}, {
+  allowPrivateAddress,
+  userAgent,
+  specDeterminer,
+  tracerProvider
+}?: GetAuthenticatedDocumentLoaderOptions): DocumentLoader;
+/**
+ * A JSON-LD document loader that utilizes the browser's `fetch` API.
+ *
+ * This loader preloads the below frequently used contexts:
+ *
+ * - <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 url The URL of the document to load.
+ * @param allowPrivateAddress Whether to allow fetching private network
+ *                            addresses.  Turned off by default.
+ * @returns The remote document.
+ * @deprecated Use {@link getDocumentLoader} instead.
+ */
+//#endregion
+//#region src/utils/kv-cache.d.ts
+/**
+ * The parameters for {@link kvCache} function.
+ */
+interface KvCacheParameters {
+  /**
+   * The document loader to decorate with a cache.
+   */
+  loader: DocumentLoader;
+  /**
+   * The key–value store to use for backing the cache.
+   */
+  kv: KvStore;
+  /**
+   * The key prefix to use for namespacing the cache.
+   * `["_fedify", "remoteDocument"]` by default.
+   */
+  prefix?: KvKey;
+  /**
+   * The per-URL cache rules in the array of `[urlPattern, duration]` pairs
+   * where `urlPattern` is either a string, a {@link URL}, or
+   * a {@link URLPattern} and `duration` is a {@link Temporal.DurationLike}.
+   * The `duration` is allowed to be at most 30 days.
+   *
+   * By default, 5 minutes for all URLs.
+   */
+  rules?: [string | URL | URLPattern, Temporal.Duration | Temporal.DurationLike][];
+}
+/**
+ * Decorates a {@link DocumentLoader} with a cache backed by a {@link Deno.Kv}.
+ * @param parameters The parameters for the cache.
+ * @returns The decorated document loader which is cache-enabled.
+ */
+declare function kvCache({
+  loader,
+  kv,
+  prefix,
+  rules
+}: KvCacheParameters): DocumentLoader;
+//#endregion
+export { getAuthenticatedDocumentLoader, kvCache };

package/dist/mod-CNNTHyBC.d.cts

@@ -0,0 +1,80 @@
+import { ActivityTransformer, Context } from "./context-D2MrtLch.cjs";
+import { Activity } from "@fedify/vocab";
+
+//#region src/compat/transformers.d.ts
+
+/**
+ * An activity transformer that assigns a new random ID to an activity if it
+ * does not already have one.  This is useful for ensuring that activities
+ * have an ID before they are sent to other servers.
+ *
+ * The generated ID is an origin URI with a fragment which contains an activity
+ * type name with a random UUID:
+ *
+ * ```
+ * https://example.com/#Follow/12345678-1234-5678-1234-567812345678
+ * ```
+ *
+ * @template TContextData The type of the context data.
+ * @param activity The activity to assign an ID to.
+ * @param context The context of the activity.
+ * @return The activity with an ID assigned.
+ * @since 1.4.0
+ */
+declare function autoIdAssigner<TContextData>(activity: Activity, context: Context<TContextData>): Activity;
+/**
+ * An activity transformer that dehydrates the actor property of an activity
+ * so that it only contains the actor's URI.  For example, suppose we have an
+ * activity like this:
+ *
+ * ```typescript
+ * import { Follow, Person } from "@fedify/vocab";
+ * const input = new Follow({
+ *   id: new URL("http://example.com/activities/1"),
+ *   actor: new Person({
+ *     id: new URL("http://example.com/actors/1"),
+ *     name: "Alice",
+ *     preferredUsername: "alice",
+ *   }),
+ *   object: new Person({
+ *     id: new URL("http://example.com/actors/2"),
+ *     name: "Bob",
+ *     preferredUsername: "bob",
+ *   }),
+ * });
+ * ```
+ *
+ * The result of applying this transformer would be:
+ *
+ * ```typescript
+ * import { Follow, Person } from "@fedify/vocab";
+ * const output = new Follow({
+ *   id: new URL("http://example.com/activities/1"),
+ *   actor: new URL("http://example.com/actors/1"),
+ *   object: new Person({
+ *     id: new URL("http://example.com/actors/2"),
+ *     name: "Bob",
+ *     preferredUsername: "bob",
+ *   }),
+ * });
+ * ```
+ *
+ * As some ActivityPub implementations like Threads fail to deal with inlined
+ * actor objects, this transformer can be used to work around this issue.
+ * @template TContextData The type of the context data.
+ * @param activity The activity to dehydrate the actor property of.
+ * @param context The context of the activity.
+ * @returns The dehydrated activity.
+ * @since 1.4.0
+ */
+declare function actorDehydrator<TContextData>(activity: Activity, _context: Context<TContextData>): Activity;
+/**
+ * Gets the default activity transformers that are applied to all outgoing
+ * activities.
+ * @template TContextData The type of the context data.
+ * @returns The default activity transformers.
+ * @since 1.4.0
+ */
+declare function getDefaultActivityTransformers<TContextData>(): readonly ActivityTransformer<TContextData>[];
+//#endregion
+export { actorDehydrator, autoIdAssigner, getDefaultActivityTransformers };

package/dist/mod-CS-MS7gZ.d.cts

@@ -0,0 +1,62 @@
+import { ActorAliasMapper, ActorDispatcher, ActorHandleMapper, RequestContext, WebFingerLinksDispatcher } from "./context-D2MrtLch.cjs";
+import { Span, Tracer } from "@opentelemetry/api";
+
+//#region src/federation/webfinger.d.ts
+/**
+ * Parameters for {@link handleWebFinger}.
+ */
+interface WebFingerHandlerParameters<TContextData> {
+  /**
+   * The request context.
+   */
+  context: RequestContext<TContextData>;
+  /**
+   * The canonical hostname of the server, if it's explicitly configured.
+   * @since 1.5.0
+   */
+  host?: string;
+  /**
+   * The callback for dispatching the actor.
+   */
+  actorDispatcher?: ActorDispatcher<TContextData>;
+  /**
+   * The callback for mapping a WebFinger username to the corresponding actor's
+   * internal identifier, or `null` if the username is not found.
+   * @since 0.15.0
+   */
+  actorHandleMapper?: ActorHandleMapper<TContextData>;
+  /**
+   * The callback for mapping a WebFinger query to the corresponding actor's
+   * internal identifier or username, or `null` if the query is not found.
+   * @since 1.4.0
+   */
+  actorAliasMapper?: ActorAliasMapper<TContextData>;
+  /**
+   * The callback for dispatching the Links of webFinger.
+   */
+  webFingerLinksDispatcher?: WebFingerLinksDispatcher<TContextData>;
+  /**
+   * The function to call when the actor is not found.
+   */
+  onNotFound(request: Request): Response | Promise<Response>;
+  /**
+   * The OpenTelemetry tracer.
+   * @since 1.3.0
+   */
+  tracer?: Tracer;
+  /**
+   * The span for the request.
+   * @since 1.3.0
+   */
+  span?: Span;
+}
+/**
+ * Handles a WebFinger request.  You would not typically call this function
+ * directly, but instead use {@link Federation.fetch} method.
+ * @param request The WebFinger request to handle.
+ * @param parameters The parameters for handling the request.
+ * @returns The response to the request.
+ */
+declare function handleWebFinger<TContextData>(request: Request, options: WebFingerHandlerParameters<TContextData>): Promise<Response>;
+//#endregion
+export { WebFingerHandlerParameters, handleWebFinger };

package/dist/{mod-Bqxcp7eN.d.ts → mod-D_cmv2il.d.ts}

@@ -1,7 +1,7 @@
 import { Temporal } from "@js-temporal/polyfill";
 import { URLPattern } from "urlpattern-polyfill";
-import { Activity } from "./vocab-SOE1ifCr.js";
-import { ActivityTransformer, Context } from "./context-9gCpIkiz.js";
+import { ActivityTransformer, Context } from "./context-CYZ2i00R.js";
+import { Activity } from "@fedify/vocab";
 
 //#region src/compat/transformers.d.ts
 
@@ -30,7 +30,7 @@ declare function autoIdAssigner<TContextData>(activity: Activity, context: Conte
  * activity like this:
  *
  * ```typescript
- * import { Follow, Person } from "@fedify/fedify/vocab";
+ * import { Follow, Person } from "@fedify/vocab";
  * const input = new Follow({
  *   id: new URL("http://example.com/activities/1"),
  *   actor: new Person({
@@ -49,7 +49,7 @@ declare function autoIdAssigner<TContextData>(activity: Activity, context: Conte
  * The result of applying this transformer would be:
  *
  * ```typescript
- * import { Follow, Person } from "@fedify/fedify/vocab";
+ * import { Follow, Person } from "@fedify/vocab";
  * const output = new Follow({
  *   id: new URL("http://example.com/activities/1"),
  *   actor: new URL("http://example.com/actors/1"),