@fedify/fedify 2.4.0-dev.2071 → 2.4.0-dev.2073

package/dist/testing/mod.d.mts

@@ -1418,6 +1418,16 @@ interface FederationKvPrefixes {
    * @since 2.4.0
    */
   readonly taskDeduplication: KvKey;
+  /**
+   * The key prefix used for remembering which activities received in
+   * [FEP-ef61] portable inboxes have been forwarded to which gateways, so that
+   * each activity is forwarded at most once.
+   *
+   * [FEP-ef61]: https://w3id.org/fep/ef61
+   * @default `["_fedify", "portableInboxForwarding"]`
+   * @since 2.4.0
+   */
+  readonly portableInboxForwarding: KvKey;
 }
 /**
  * Options for {@link FederationOptions.origin} when it is not a string.
@@ -1996,6 +2006,44 @@ interface Federation<TContextData> extends Federatable<TContextData> {
    */
   fetch(request: Request, options: FederationFetchOptions<TContextData>): Promise<Response>;
 }
+/**
+ * Options for forwarding activities received in [FEP-ef61] portable inboxes to
+ * the other gateways of their actors.  See
+ * {@link FederationOptions.portableInboxForwarding}.
+ *
+ * [FEP-ef61]: https://w3id.org/fep/ef61
+ * @since 2.4.0
+ */
+interface PortableInboxForwardingOptions {
+  /**
+   * The maximum number of other gateways that a single delivery is forwarded
+   * to.  Gateways beyond it are skipped with a warning.  `0` turns off
+   * forwarding.
+   * @default `10`
+   */
+  maxTargets?: number;
+  /**
+   * How long Fedify remembers that it has forwarded an activity from
+   * a portable inbox to a gateway, under
+   * {@link FederationKvPrefixes.portableInboxForwarding}.  Within it, the same
+   * activity is never forwarded to the same gateway again; once it expires,
+   * a redelivery of the activity may be forwarded again.  It cannot have
+   * calendar units, i.e., weeks, months, or years.
+   * @default `{ days: 30 }`
+   */
+  ttl?: Temporal.DurationLike;
+  /**
+   * How long a delivery waits for forwarding requests made immediately, i.e.,
+   * when no outbox queue is configured, before Fedify responds to it.
+   * Requests still running afterwards continue in the background.  It does
+   * not apply when forwarding is queued.  It cannot have calendar units,
+   * i.e., weeks, months, or years, and cannot be longer than
+   * 2,147,483,647 milliseconds (about 24.8 days), the longest delay timers
+   * support.
+   * @default `{ seconds: 10 }`
+   */
+  deadline?: Temporal.DurationLike;
+}
 /**
  * Policy for emitting `Accept-Signature` challenges on inbox `401`
  * responses, as defined in
@@ -2090,6 +2138,14 @@ interface FederationOptions<TContextData> {
    * @since 2.4.0
    */
   httpMessageSignaturesSpecTtl?: Temporal.DurationLike;
+  /**
+   * Options for forwarding activities received in [FEP-ef61] portable inboxes
+   * to the other gateways of their actors.
+   *
+   * [FEP-ef61]: https://w3id.org/fep/ef61
+   * @since 2.4.0
+   */
+  portableInboxForwarding?: PortableInboxForwardingOptions;
   /**
    * The message queue for sending and receiving activities.  If not provided,
    * activities will not be queued and will be processed immediately.
@@ -2873,6 +2929,35 @@ interface Context<TContextData> {
    * @since 2.4.0
    */
   getPortableObjectUri<TObject extends Object$1>(cls: ConstructorWithTypeId<TObject>, values: Record<string, string>, authority: string): URL;
+  /**
+   * Builds the [FEP-ef61] portable ID of an actor's inbox with the given
+   * identifier under the given DID authority.
+   *
+   * The path is the same as the one {@link Context.getInboxUri} builds from
+   * the inbox path, but the result is an `ap+ef61:` URI whose authority is
+   * the DID, e.g., `ap+ef61://did:key:z6Mk.../users/alice/inbox`.  If
+   * a portable actor has it as its `inbox` and lists this server in its
+   * `gateways`, this server accepts deliveries to the inbox through
+   * the FEP-ef61 gateway endpoint, e.g.,
+   * `POST /.well-known/apgateway/did:key:z6Mk.../users/alice/inbox`, and
+   * dispatches them to the inbox listeners.
+   *
+   * The returned `URL` keeps the DID authority percent-encoded, because
+   * the `URL` class cannot represent the canonical form.  Use `formatIri()`
+   * from `@fedify/vocab-runtime` to get the canonical string.
+   *
+   * [FEP-ef61]: https://w3id.org/fep/ef61
+   *
+   * @param identifier The actor's identifier.
+   * @param authority The DID that controls the actor, e.g.,
+   *                  `did:key:z6Mk...`.  It must be a bare DID, without
+   *                  a path, query, or fragment.
+   * @returns The inbox's portable ID.
+   * @throws {RouterError} If no inbox path is registered.
+   * @throws {TypeError} If the authority is not a DID.
+   * @since 2.4.0
+   */
+  getPortableInboxUri(identifier: string, authority: string): URL;
   /**
    * Builds the URI of an actor's outbox with the given identifier.
    * @param identifier The actor's identifier.
@@ -3287,6 +3372,29 @@ interface RequestContext<TContextData> extends Context<TContextData> {
    * @since 2.4.0
    */
   getPortableObjectUri<TObject extends Object$1>(cls: ConstructorWithTypeId<TObject>, values: Record<string, string>, authority?: string): URL;
+  /**
+   * Builds the [FEP-ef61] portable ID of an actor's inbox with the given
+   * identifier.  It works the same as {@link Context.getPortableInboxUri},
+   * except that the authority can be omitted while handling a portable object
+   * request, i.e., when {@link RequestContext.portableRequest} is set.  In
+   * that case, its DID is used.  Deliveries to portable inboxes do not set
+   * {@link RequestContext.portableRequest}, so pass the authority explicitly
+   * while handling them.
+   *
+   * [FEP-ef61]: https://w3id.org/fep/ef61
+   *
+   * @param identifier The actor's identifier.
+   * @param authority The DID that controls the actor, e.g.,
+   *                  `did:key:z6Mk...`.  It must be a bare DID, without
+   *                  a path, query, or fragment.  Defaults to the DID of
+   *                  the requested portable object, if any.
+   * @returns The inbox's portable ID.
+   * @throws {RouterError} If no inbox path is registered.
+   * @throws {TypeError} If the authority is not a DID, or the authority is
+   *                     omitted outside a portable gateway request.
+   * @since 2.4.0
+   */
+  getPortableInboxUri(identifier: string, authority?: string): URL;
   /**
    * Creates a new context with the same properties as this one,
    * but with the given data.

package/dist/testing/mod.mjs

@@ -2,8 +2,8 @@ import "temporal-polyfill";
 import "urlpattern-polyfill";
 globalThis.addEventListener = () => {};
 import { r as testDefinitions } from "../dist-BQvArojP.mjs";
-import { n as createOutboxContext, r as createRequestContext, t as createInboxContext } from "../context-DG5QeQ8W.mjs";
+import { n as createOutboxContext, r as createRequestContext, t as createInboxContext } from "../context-DlZhxdFT.mjs";
 import { t as ManualClockKvStore } from "../kv-DBRWVx3Q.mjs";
 import { a as numberSchema, i as makeSchema, n as baseOptions, o as stringSchema, r as envelopeSchema, t as MockQueue } from "../tasks-dbCShlCb.mjs";
-import "../testing-By1YYsIK.mjs";
+import "../testing-CO_cEvQc.mjs";
 export { ManualClockKvStore, MockQueue, baseOptions, createInboxContext, createOutboxContext, createRequestContext, envelopeSchema, makeSchema, numberSchema, stringSchema, testDefinitions };

package/dist/{testing-By1YYsIK.mjs → testing-CO_cEvQc.mjs}

@@ -2,7 +2,7 @@ import "temporal-polyfill";
 import "urlpattern-polyfill";
 globalThis.addEventListener = () => {};
 import "./dist-BQvArojP.mjs";
-import "./context-DG5QeQ8W.mjs";
+import "./context-DlZhxdFT.mjs";
 import "./kv-DBRWVx3Q.mjs";
 import "./tasks-dbCShlCb.mjs";
 export {};

package/dist/utils/docloader.test.mjs

@@ -5,9 +5,9 @@ import { t as esm_default } from "../esm-BHXXx4Wx.mjs";
 import { t as assertEquals } from "../assert_equals-Z6IcEbWU.mjs";
 import "../std__assert-DvMDRPes.mjs";
 import { t as assertRejects } from "../assert_rejects-CTptdYck.mjs";
-import { l as verifyRequest } from "../http-DKWi8RjI.mjs";
+import { l as verifyRequest } from "../http-C7qHlv-b.mjs";
 import { i as rsaPrivateKey2 } from "../keys-DIJNHW-Y.mjs";
-import { t as getAuthenticatedDocumentLoader } from "../docloader-C6yOVoaF.mjs";
+import { t as getAuthenticatedDocumentLoader } from "../docloader-C0SWQylk.mjs";
 import { mockDocumentLoader, test } from "@fedify/fixture";
 import { FetchError, UrlError } from "@fedify/vocab-runtime";
 //#region src/utils/docloader.test.ts

package/dist/utils/kv-cache.test.mjs

@@ -1,7 +1,7 @@
 import { Temporal } from "temporal-polyfill";
 import { URLPattern } from "urlpattern-polyfill";
 globalThis.addEventListener = () => {};
-import { n as kvCache, t as MockKvStore } from "../kv-cache-d8EjO29d.mjs";
+import { n as kvCache, t as MockKvStore } from "../kv-cache-DEH5jyND.mjs";
 import { deepStrictEqual, throws } from "node:assert";
 import { createTestMeterProvider, mockDocumentLoader, test } from "@fedify/fixture";
 import { preloadedContexts } from "@fedify/vocab-runtime";

package/dist/utils/mod.cjs

@@ -1,5 +1,5 @@
 const { URLPattern } = require("urlpattern-polyfill");
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_kv_cache = require("../kv-cache-DE8kSNQU.cjs");
+const require_kv_cache = require("../kv-cache-DvqkKNIj.cjs");
 exports.getAuthenticatedDocumentLoader = require_kv_cache.getAuthenticatedDocumentLoader;
 exports.kvCache = require_kv_cache.kvCache;

package/dist/utils/mod.js

@@ -1,4 +1,4 @@
 import { Temporal } from "temporal-polyfill";
 import { URLPattern } from "urlpattern-polyfill";
-import { n as getAuthenticatedDocumentLoader, t as kvCache } from "../kv-cache-BdnmnAVc.js";
+import { n as getAuthenticatedDocumentLoader, t as kvCache } from "../kv-cache-DCJuwdnB.js";
 export { getAuthenticatedDocumentLoader, kvCache };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/fedify",
-  "version": "2.4.0-dev.2071+8b9dccb9",
+  "version": "2.4.0-dev.2073+2152dfc6",
   "description": "An ActivityPub server framework",
   "keywords": [
     "ActivityPub",
@@ -151,10 +151,10 @@
     "structured-field-values": "^2.0.4",
     "temporal-polyfill": "^1.0.1",
     "urlpattern-polyfill": "^10.1.0",
-    "@fedify/uri-template": "2.4.0-dev.2071+8b9dccb9",
-    "@fedify/vocab": "2.4.0-dev.2071+8b9dccb9",
-    "@fedify/vocab-runtime": "2.4.0-dev.2071+8b9dccb9",
-    "@fedify/webfinger": "2.4.0-dev.2071+8b9dccb9"
+    "@fedify/uri-template": "2.4.0-dev.2073+2152dfc6",
+    "@fedify/vocab": "2.4.0-dev.2073+2152dfc6",
+    "@fedify/webfinger": "2.4.0-dev.2073+2152dfc6",
+    "@fedify/vocab-runtime": "2.4.0-dev.2073+2152dfc6"
   },
   "devDependencies": {
     "@std/assert": "npm:@jsr/std__assert@^0.226.0",
@@ -167,7 +167,7 @@
     "typescript": "^6.0.0",
     "wrangler": "^4.17.0",
     "@fedify/fixture": "2.0.0",
-    "@fedify/vocab-tools": "^2.4.0-dev.2071+8b9dccb9"
+    "@fedify/vocab-tools": "^2.4.0-dev.2073+2152dfc6"
   },
   "scripts": {
     "build:self": "tsdown",