@fedify/fedify 2.4.0-dev.2149 → 2.4.0-dev.2157

package/dist/{context-B2C8nuN3.d.ts → context-exYu7gDU.d.ts}

@@ -490,6 +490,28 @@ type ObjectAuthorizePredicate<TContextData, TParam extends string> = (context: R
 */
 type CustomCollectionDispatcher<TItem, TParam extends string, TContext extends Context<TContextData>, TContextData> = (context: TContext, values: Record<TParam, string>, cursor: string | null) => PageItems<TItem> | null | Promise<PageItems<TItem> | null>;
 /**
+* A callback that maps a custom collection to the identifier of the actor
+* that owns it, so that the collection can be served as an [FEP-ef61]
+* portable collection through the gateway endpoint, e.g.,
+* `GET /.well-known/apgateway/did:key:z6Mk.../users/alice/bookmarks`.
+*
+* Fedify serves such a request only if the returned actor is a portable actor
+* whose ID is under the requested DID.  The owner has to come from
+* the application's data, not from the request, since the DID in the request
+* path is not evidence that this server hosts collections for it.
+*
+* [FEP-ef61]: https://w3id.org/fep/ef61
+*
+* @template TContextData The context data to pass to the {@link Context}.
+* @template TParam The parameter names of the requested URL.
+* @param context The context.
+* @param values The parameters of the requested URL.
+* @returns The internal identifier of the actor that owns the collection, or
+*          `null` if the collection is not a portable collection.
+* @since 2.4.0
+*/
+type PortableCollectionOwnerMapper<TContextData, TParam extends string> = (context: Context<TContextData>, values: Record<TParam, string>) => string | null | Promise<string | null>;
+/**
 * A callback that counts the number of items in a custom collection.
 *
 * @template TParams The parameter names of the requested URL.
@@ -2819,6 +2841,21 @@ interface CustomCollectionCallbackSetters<TParam extends string, TContext extend
   * @since 0.7.0
   */
   authorize(predicate: ObjectAuthorizePredicate<TContextData, string>): CustomCollectionCallbackSetters<TParam, TContext, TContextData>;
+  /**
+  * Maps the custom collection to the actor that owns it, so that it is also
+  * served as an [FEP-ef61] portable collection through the gateway endpoint,
+  * e.g., `GET /.well-known/apgateway/did:key:z6Mk.../users/alice/bookmarks`,
+  * if the owner is a portable actor under the requested DID.  Without it,
+  * the custom collection is not served through the gateway endpoint.
+  *
+  * [FEP-ef61]: https://w3id.org/fep/ef61
+  * @param mapper A callback that returns the identifier of the actor that
+  *               owns the collection, or `null` if the collection is not
+  *               portable.
+  * @returns The setters object so that settings can be chained.
+  * @since 2.4.0
+  */
+  mapPortableOwner(mapper: PortableCollectionOwnerMapper<TContextData, TParam>): CustomCollectionCallbackSetters<TParam, TContext, TContextData>;
 }
 /**
 * Represents an object with a type ID, which is either a constructor or an
@@ -3074,6 +3111,35 @@ interface Context<TContextData> {
   */
   getOutboxUri(identifier: string): URL;
   /**
+  * Builds the [FEP-ef61] portable ID of an actor's outbox with the given
+  * identifier under the given DID authority.
+  *
+  * The path is the same as the one {@link Context.getOutboxUri} builds, but
+  * the result is an `ap+ef61:` URI whose authority is the DID, e.g.,
+  * `ap+ef61://did:key:z6Mk.../users/alice/outbox`.  If a portable actor has
+  * it as its `outbox` and its ID is under the same DID, the collection is
+  * served through the FEP-ef61 gateway endpoint, e.g.,
+  * `/.well-known/apgateway/did:key:z6Mk.../users/alice/outbox`, by the same
+  * collection dispatcher.
+  *
+  * 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 outbox's portable ID.
+  * @throws {RouterError} If no outbox dispatcher is available.
+  * @throws {TypeError} If the authority is not a DID, or it is a `did:key`
+  *                     DID that is not encoded in base58-btc.
+  * @since 2.4.0
+  */
+  getPortableOutboxUri(identifier: string, authority: string): URL;
+  /**
   * Builds the URI of an actor's media upload endpoint with the given
   * identifier.  This is the endpoint advertised under `endpoints.uploadMedia`
   * in the actor document.
@@ -3105,6 +3171,35 @@ interface Context<TContextData> {
   */
   getFollowingUri(identifier: string): URL;
   /**
+  * Builds the [FEP-ef61] portable ID of an actor's following collection with the given
+  * identifier under the given DID authority.
+  *
+  * The path is the same as the one {@link Context.getFollowingUri} builds, but
+  * the result is an `ap+ef61:` URI whose authority is the DID, e.g.,
+  * `ap+ef61://did:key:z6Mk.../users/alice/following`.  If a portable actor has
+  * it as its `following` and its ID is under the same DID, the collection is
+  * served through the FEP-ef61 gateway endpoint, e.g.,
+  * `/.well-known/apgateway/did:key:z6Mk.../users/alice/following`, by the same
+  * collection dispatcher.
+  *
+  * 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 following collection's portable ID.
+  * @throws {RouterError} If no following collection is available.
+  * @throws {TypeError} If the authority is not a DID, or it is a `did:key`
+  *                     DID that is not encoded in base58-btc.
+  * @since 2.4.0
+  */
+  getPortableFollowingUri(identifier: string, authority: string): URL;
+  /**
   * Builds the URI of an actor's followers collection with the given
   * identifier.
   * @param identifier The actor's identifier.
@@ -3113,6 +3208,35 @@ interface Context<TContextData> {
   */
   getFollowersUri(identifier: string): URL;
   /**
+  * Builds the [FEP-ef61] portable ID of an actor's followers collection with the given
+  * identifier under the given DID authority.
+  *
+  * The path is the same as the one {@link Context.getFollowersUri} builds, but
+  * the result is an `ap+ef61:` URI whose authority is the DID, e.g.,
+  * `ap+ef61://did:key:z6Mk.../users/alice/followers`.  If a portable actor has
+  * it as its `followers` and its ID is under the same DID, the collection is
+  * served through the FEP-ef61 gateway endpoint, e.g.,
+  * `/.well-known/apgateway/did:key:z6Mk.../users/alice/followers`, by the same
+  * collection dispatcher.
+  *
+  * 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 followers collection's portable ID.
+  * @throws {RouterError} If no followers collection is available.
+  * @throws {TypeError} If the authority is not a DID, or it is a `did:key`
+  *                     DID that is not encoded in base58-btc.
+  * @since 2.4.0
+  */
+  getPortableFollowersUri(identifier: string, authority: string): URL;
+  /**
   * Builds the URI of an actor's liked collection with the given identifier.
   * @param identifier The actor's identifier.
   * @returns The actor's liked collection URI.
@@ -3121,6 +3245,35 @@ interface Context<TContextData> {
   */
   getLikedUri(identifier: string): URL;
   /**
+  * Builds the [FEP-ef61] portable ID of an actor's liked collection with the given
+  * identifier under the given DID authority.
+  *
+  * The path is the same as the one {@link Context.getLikedUri} builds, but
+  * the result is an `ap+ef61:` URI whose authority is the DID, e.g.,
+  * `ap+ef61://did:key:z6Mk.../users/alice/liked`.  If a portable actor has
+  * it as its `liked` and its ID is under the same DID, the collection is
+  * served through the FEP-ef61 gateway endpoint, e.g.,
+  * `/.well-known/apgateway/did:key:z6Mk.../users/alice/liked`, by the same
+  * collection dispatcher.
+  *
+  * 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 liked collection's portable ID.
+  * @throws {RouterError} If no liked collection is available.
+  * @throws {TypeError} If the authority is not a DID, or it is a `did:key`
+  *                     DID that is not encoded in base58-btc.
+  * @since 2.4.0
+  */
+  getPortableLikedUri(identifier: string, authority: string): URL;
+  /**
   * Builds the URI of an actor's featured collection with the given identifier.
   * @param identifier The actor's identifier.
   * @returns The actor's featured collection URI.
@@ -3129,6 +3282,35 @@ interface Context<TContextData> {
   */
   getFeaturedUri(identifier: string): URL;
   /**
+  * Builds the [FEP-ef61] portable ID of an actor's featured collection with the given
+  * identifier under the given DID authority.
+  *
+  * The path is the same as the one {@link Context.getFeaturedUri} builds, but
+  * the result is an `ap+ef61:` URI whose authority is the DID, e.g.,
+  * `ap+ef61://did:key:z6Mk.../users/alice/featured`.  If a portable actor has
+  * it as its `featured` and its ID is under the same DID, the collection is
+  * served through the FEP-ef61 gateway endpoint, e.g.,
+  * `/.well-known/apgateway/did:key:z6Mk.../users/alice/featured`, by the same
+  * collection dispatcher.
+  *
+  * 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 featured collection's portable ID.
+  * @throws {RouterError} If no featured collection is available.
+  * @throws {TypeError} If the authority is not a DID, or it is a `did:key`
+  *                     DID that is not encoded in base58-btc.
+  * @since 2.4.0
+  */
+  getPortableFeaturedUri(identifier: string, authority: string): URL;
+  /**
   * Builds the URI of an actor's featured tags collection with the given
   * identifier.
   * @param identifier The actor's identifier.
@@ -3138,6 +3320,35 @@ interface Context<TContextData> {
   */
   getFeaturedTagsUri(identifier: string): URL;
   /**
+  * Builds the [FEP-ef61] portable ID of an actor's featured tags collection with the given
+  * identifier under the given DID authority.
+  *
+  * The path is the same as the one {@link Context.getFeaturedTagsUri} builds, but
+  * the result is an `ap+ef61:` URI whose authority is the DID, e.g.,
+  * `ap+ef61://did:key:z6Mk.../users/alice/tags`.  If a portable actor has
+  * it as its `featuredTags` and its ID is under the same DID, the collection is
+  * served through the FEP-ef61 gateway endpoint, e.g.,
+  * `/.well-known/apgateway/did:key:z6Mk.../users/alice/tags`, by the same
+  * collection dispatcher.
+  *
+  * 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 featured tags collection's portable ID.
+  * @throws {RouterError} If no featured tags collection is available.
+  * @throws {TypeError} If the authority is not a DID, or it is a `did:key`
+  *                     DID that is not encoded in base58-btc.
+  * @since 2.4.0
+  */
+  getPortableFeaturedTagsUri(identifier: string, authority: string): URL;
+  /**
   * Determines the type of the URI and extracts the associated data.
   * @param uri The URI to parse.
   * @returns The result of parsing the URI.  If `null` is given or
@@ -3396,6 +3607,38 @@ interface Context<TContextData> {
   * @since 1.8.0
   */
   getCollectionUri<TParam extends Record<string, string>>(name: string | symbol, values: TParam): URL;
+  /**
+  * Builds the [FEP-ef61] portable ID of a custom collection with the given
+  * name and values under the given DID authority.
+  *
+  * The path is the same as the one {@link Context.getCollectionUri} builds,
+  * but the result is an `ap+ef61:` URI whose authority is the DID, e.g.,
+  * `ap+ef61://did:key:z6Mk.../users/alice/bookmarks`.  If the collection
+  * dispatcher maps the collection to a portable actor under the same DID
+  * with `CustomCollectionCallbackSetters.mapPortableOwner()`, the
+  * collection is served through the FEP-ef61 gateway endpoint, e.g.,
+  * `/.well-known/apgateway/did:key:z6Mk.../users/alice/bookmarks`.
+  *
+  * 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 name The name of the collection, which can be a string or a symbol.
+  * @param values The values of the URI parameters.
+  * @param authority The DID that controls the collection, e.g.,
+  *                  `did:key:z6Mk...`.  It must be a bare DID, without
+  *                  a path, query, or fragment.
+  * @returns The collection's portable ID.
+  * @throws {RouterError} If no collection dispatcher is available for
+  *                       the name.
+  * @throws {TypeError} If values are invalid, or the authority is not a DID
+  *                     or is a `did:key` DID that is not encoded in
+  *                     base58-btc.
+  * @since 2.4.0
+  */
+  getPortableCollectionUri<TParam extends Record<string, string>>(name: string | symbol, values: TParam, authority: string): URL;
 }
 /**
 * Information about an [FEP-ef61] portable object requested through
@@ -3412,7 +3655,7 @@ interface PortableRequest {
   */
   readonly authority: string;
   /**
-  * The ID of the requested portable object, e.g.,
+  * The ID of the requested portable object or collection, e.g.,
   * `ap+ef61://did:key:z6Mk.../notes/123`, without a query.  Like other
   * portable IDs, the `URL` keeps the DID authority percent-encoded; use
   * `formatIri()` from `@fedify/vocab-runtime` to get the canonical string.
@@ -3466,12 +3709,14 @@ interface RequestContext<TContextData> extends Context<TContextData> {
   * Information about the [FEP-ef61] portable object requested through
   * the gateway endpoint, e.g.,
   * `GET /.well-known/apgateway/did:key:z6Mk.../notes/123`, which is served
-  * by an object dispatcher or the actor dispatcher.  It is `undefined` for
-  * ordinary requests.
+  * by an object dispatcher, the actor dispatcher, or a collection
+  * dispatcher.  It is `undefined` for ordinary requests.
   *
   * The authority comes from the request path, so it is not evidence that
   * this server hosts objects for the DID.  An object dispatcher or the actor
-  * dispatcher has to check that by itself.
+  * dispatcher has to check that by itself.  A portable collection is served
+  * only if its owner, which the actor dispatcher looks up without this
+  * property, is a portable actor under the DID.
   *
   * It describes the incoming request, so it stays the same in contexts
   * derived from this one, e.g., by {@link RequestContext.getObject}.
@@ -3554,6 +3799,150 @@ interface RequestContext<TContextData> extends Context<TContextData> {
   */
   getPortableInboxUri(identifier: string, authority?: string): URL;
   /**
+  * Builds the [FEP-ef61] portable ID of an actor's outbox with the given
+  * identifier.  It works the same as {@link Context.getPortableOutboxUri}, except that
+  * the authority can be omitted while handling a portable gateway request.
+  * In that case, the DID in {@link RequestContext.portableRequest} is used.
+  *
+  * [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...`.  Defaults to the DID of the requested
+  *                  portable object or collection.
+  * @returns The outbox's portable ID.
+  * @throws {RouterError} If no outbox dispatcher is available.
+  * @throws {TypeError} If the authority is not a DID, it is a `did:key` DID
+  *                     that is not encoded in base58-btc, or the authority
+  *                     is omitted outside a portable gateway request.
+  * @since 2.4.0
+  */
+  getPortableOutboxUri(identifier: string, authority?: string): URL;
+  /**
+  * Builds the [FEP-ef61] portable ID of an actor's following collection with the given
+  * identifier.  It works the same as {@link Context.getPortableFollowingUri}, except that
+  * the authority can be omitted while handling a portable gateway request.
+  * In that case, the DID in {@link RequestContext.portableRequest} is used.
+  *
+  * [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...`.  Defaults to the DID of the requested
+  *                  portable object or collection.
+  * @returns The following collection's portable ID.
+  * @throws {RouterError} If no following collection is available.
+  * @throws {TypeError} If the authority is not a DID, it is a `did:key` DID
+  *                     that is not encoded in base58-btc, or the authority
+  *                     is omitted outside a portable gateway request.
+  * @since 2.4.0
+  */
+  getPortableFollowingUri(identifier: string, authority?: string): URL;
+  /**
+  * Builds the [FEP-ef61] portable ID of an actor's followers collection with the given
+  * identifier.  It works the same as {@link Context.getPortableFollowersUri}, except that
+  * the authority can be omitted while handling a portable gateway request.
+  * In that case, the DID in {@link RequestContext.portableRequest} is used.
+  *
+  * [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...`.  Defaults to the DID of the requested
+  *                  portable object or collection.
+  * @returns The followers collection's portable ID.
+  * @throws {RouterError} If no followers collection is available.
+  * @throws {TypeError} If the authority is not a DID, it is a `did:key` DID
+  *                     that is not encoded in base58-btc, or the authority
+  *                     is omitted outside a portable gateway request.
+  * @since 2.4.0
+  */
+  getPortableFollowersUri(identifier: string, authority?: string): URL;
+  /**
+  * Builds the [FEP-ef61] portable ID of an actor's liked collection with the given
+  * identifier.  It works the same as {@link Context.getPortableLikedUri}, except that
+  * the authority can be omitted while handling a portable gateway request.
+  * In that case, the DID in {@link RequestContext.portableRequest} is used.
+  *
+  * [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...`.  Defaults to the DID of the requested
+  *                  portable object or collection.
+  * @returns The liked collection's portable ID.
+  * @throws {RouterError} If no liked collection is available.
+  * @throws {TypeError} If the authority is not a DID, it is a `did:key` DID
+  *                     that is not encoded in base58-btc, or the authority
+  *                     is omitted outside a portable gateway request.
+  * @since 2.4.0
+  */
+  getPortableLikedUri(identifier: string, authority?: string): URL;
+  /**
+  * Builds the [FEP-ef61] portable ID of an actor's featured collection with the given
+  * identifier.  It works the same as {@link Context.getPortableFeaturedUri}, except that
+  * the authority can be omitted while handling a portable gateway request.
+  * In that case, the DID in {@link RequestContext.portableRequest} is used.
+  *
+  * [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...`.  Defaults to the DID of the requested
+  *                  portable object or collection.
+  * @returns The featured collection's portable ID.
+  * @throws {RouterError} If no featured collection is available.
+  * @throws {TypeError} If the authority is not a DID, it is a `did:key` DID
+  *                     that is not encoded in base58-btc, or the authority
+  *                     is omitted outside a portable gateway request.
+  * @since 2.4.0
+  */
+  getPortableFeaturedUri(identifier: string, authority?: string): URL;
+  /**
+  * Builds the [FEP-ef61] portable ID of an actor's featured tags collection with the given
+  * identifier.  It works the same as {@link Context.getPortableFeaturedTagsUri}, except that
+  * the authority can be omitted while handling a portable gateway request.
+  * In that case, the DID in {@link RequestContext.portableRequest} is used.
+  *
+  * [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...`.  Defaults to the DID of the requested
+  *                  portable object or collection.
+  * @returns The featured tags collection's portable ID.
+  * @throws {RouterError} If no featured tags collection is available.
+  * @throws {TypeError} If the authority is not a DID, it is a `did:key` DID
+  *                     that is not encoded in base58-btc, or the authority
+  *                     is omitted outside a portable gateway request.
+  * @since 2.4.0
+  */
+  getPortableFeaturedTagsUri(identifier: string, authority?: string): URL;
+  /**
+  * Builds the [FEP-ef61] portable ID of a custom collection with the given
+  * name and values.  It works the same as
+  * {@link Context.getPortableCollectionUri}, except that the authority can
+  * be omitted while handling a portable gateway request.  In that case,
+  * the DID in {@link RequestContext.portableRequest} is used.
+  *
+  * [FEP-ef61]: https://w3id.org/fep/ef61
+  *
+  * @param name The name of the collection, which can be a string or a symbol.
+  * @param values The values of the URI parameters.
+  * @param authority The DID that controls the collection, e.g.,
+  *                  `did:key:z6Mk...`.  Defaults to the DID of the requested
+  *                  portable object or collection.
+  * @returns The collection's portable ID.
+  * @throws {RouterError} If no collection dispatcher is available for
+  *                       the name.
+  * @throws {TypeError} If values are invalid, the authority is not a DID,
+  *                     it is a `did:key` DID that is not encoded in
+  *                     base58-btc, or the authority is omitted outside
+  *                     a portable gateway request.
+  * @since 2.4.0
+  */
+  getPortableCollectionUri<TParam extends Record<string, string>>(name: string | symbol, values: TParam, authority?: string): URL;
+  /**
   * Creates a new context with the same properties as this one,
   * but with the given data.
   * @param data The new data to associate with the context.
@@ -4077,4 +4466,4 @@ interface ActorKeyPair extends CryptoKeyPair {
   readonly multikey: Multikey;
 }
 //#endregion
-export { InProcessMessageQueue as $, MediaUploaderSetters as A, HashlinkMediaRequest as At, createFederationBuilder as B, OutboxPermanentFailureHandler as Bt, FederationFetchOptions as C, CollectionCounter as Ct, IdempotencyStrategy as D, CustomCollectionCursor as Dt, IdempotencyKeyCallback as E, CustomCollectionCounter as Et, FederationKvPrefixes as F, ObjectAuthorizePredicate as Ft, TaskRegistry as G, WebFingerLinksDispatcher as Gt, TaskDefinitionOptions as H, SharedInboxKeyDispatcher as Ht, FederationOrigin as I, ObjectDispatcher as It, RetryPolicy as J, PageItems as Jt, CreateExponentialBackoffPolicyOptions as K, SendActivityError as Kt, FederationQueueOptions as L, OutboxErrorHandler as Lt, OutboxListenerSetters as M, InboxListener as Mt, PortableInboxForwardingOptions as N, MediaUploaderCallback as Nt, InboxChallengePolicy as O, CustomCollectionDispatcher as Ot, Rfc6570Expression as P, NodeInfoDispatcher as Pt, respondWithObjectIfAcceptable as Q, createFederation as R, OutboxListener as Rt, FederationBuilder as S, AuthorizePredicate as St, FederationStartQueueOptions as T, CollectionDispatcher as Tt, TaskEnqueueOptions as U, UnverifiedActivityHandler as Ut, TaskDefinition as V, PortableActorIdMapper as Vt, TaskHandler as W, UnverifiedActivityReason as Wt, RespondWithObjectOptions as X, digest as Xt, createExponentialBackoffPolicy as Y, buildCollectionSynchronizationHeader as Yt, respondWithObject as Z, ActivityTransformer as Zt, ConstructorWithTypeId as _, parseCircuitBreakerKvState as _t, GetObjectOptions as a, ParallelMessageQueue as at, Federation as b, ActorHandleMapper as bt, OutboxContext as c, CircuitBreakerBeforeSendDecision as ct, RequestContext as d, CircuitBreakerKvState as dt, InProcessMessageQueueOptions as et, RouteActivityOptions as f, CircuitBreakerOptions as ft, CollectionCallbackSetters as g, normalizeCircuitBreakerOptions as gt, ActorCallbackSetters as h, NormalizedCircuitBreakerOptions as ht, GetActorOptions as i, MessageQueueListenOptions as it, ObjectCallbackSetters as j, InboxErrorHandler as jt, InboxListenerSetters as k, HashlinkMediaDispatcher as kt, ParseUriResult as l, CircuitBreakerCreateOptions as lt, SendActivityOptionsForCollection as m, CircuitBreakerStateChange as mt, Context as n, MessageQueueDepth as nt, GetSignedKeyOptions as o, CircuitBreaker as ot, SendActivityOptions as p, CircuitBreakerState as pt, RetryContext as q, SenderKeyPair as qt, ForwardActivityOptions as r, MessageQueueEnqueueOptions as rt, InboxContext as s, CircuitBreakerActivityDrop as st, ActorKeyPair as t, MessageQueue as tt, PortableRequest as u, CircuitBreakerFailurePolicy as ut, CustomCollectionCallbackSetters as v, ActorAliasMapper as vt, FederationOptions as w, CollectionCursor as wt, FederationBenchmarkOptions as x, ActorKeyPairsDispatcher as xt, Federatable as y, ActorDispatcher as yt, Message as z, OutboxListenerErrorHandler as zt };
+export { InProcessMessageQueue as $, MediaUploaderSetters as A, HashlinkMediaRequest as At, createFederationBuilder as B, OutboxPermanentFailureHandler as Bt, FederationFetchOptions as C, CollectionCounter as Ct, IdempotencyStrategy as D, CustomCollectionCursor as Dt, IdempotencyKeyCallback as E, CustomCollectionCounter as Et, FederationKvPrefixes as F, ObjectAuthorizePredicate as Ft, TaskRegistry as G, UnverifiedActivityReason as Gt, TaskDefinitionOptions as H, PortableCollectionOwnerMapper as Ht, FederationOrigin as I, ObjectDispatcher as It, RetryPolicy as J, SenderKeyPair as Jt, CreateExponentialBackoffPolicyOptions as K, WebFingerLinksDispatcher as Kt, FederationQueueOptions as L, OutboxErrorHandler as Lt, OutboxListenerSetters as M, InboxListener as Mt, PortableInboxForwardingOptions as N, MediaUploaderCallback as Nt, InboxChallengePolicy as O, CustomCollectionDispatcher as Ot, Rfc6570Expression as P, NodeInfoDispatcher as Pt, respondWithObjectIfAcceptable as Q, ActivityTransformer as Qt, createFederation as R, OutboxListener as Rt, FederationBuilder as S, AuthorizePredicate as St, FederationStartQueueOptions as T, CollectionDispatcher as Tt, TaskEnqueueOptions as U, SharedInboxKeyDispatcher as Ut, TaskDefinition as V, PortableActorIdMapper as Vt, TaskHandler as W, UnverifiedActivityHandler as Wt, RespondWithObjectOptions as X, buildCollectionSynchronizationHeader as Xt, createExponentialBackoffPolicy as Y, PageItems as Yt, respondWithObject as Z, digest as Zt, ConstructorWithTypeId as _, parseCircuitBreakerKvState as _t, GetObjectOptions as a, ParallelMessageQueue as at, Federation as b, ActorHandleMapper as bt, OutboxContext as c, CircuitBreakerBeforeSendDecision as ct, RequestContext as d, CircuitBreakerKvState as dt, InProcessMessageQueueOptions as et, RouteActivityOptions as f, CircuitBreakerOptions as ft, CollectionCallbackSetters as g, normalizeCircuitBreakerOptions as gt, ActorCallbackSetters as h, NormalizedCircuitBreakerOptions as ht, GetActorOptions as i, MessageQueueListenOptions as it, ObjectCallbackSetters as j, InboxErrorHandler as jt, InboxListenerSetters as k, HashlinkMediaDispatcher as kt, ParseUriResult as l, CircuitBreakerCreateOptions as lt, SendActivityOptionsForCollection as m, CircuitBreakerStateChange as mt, Context as n, MessageQueueDepth as nt, GetSignedKeyOptions as o, CircuitBreaker as ot, SendActivityOptions as p, CircuitBreakerState as pt, RetryContext as q, SendActivityError as qt, ForwardActivityOptions as r, MessageQueueEnqueueOptions as rt, InboxContext as s, CircuitBreakerActivityDrop as st, ActorKeyPair as t, MessageQueue as tt, PortableRequest as u, CircuitBreakerFailurePolicy as ut, CustomCollectionCallbackSetters as v, ActorAliasMapper as vt, FederationOptions as w, CollectionCursor as wt, FederationBenchmarkOptions as x, ActorKeyPairsDispatcher as xt, Federatable as y, ActorDispatcher as yt, Message as z, OutboxListenerErrorHandler as zt };

package/dist/{deno-yXpYZm4K.mjs → deno-D1gcWWqB.mjs}

@@ -3,6 +3,6 @@ import "urlpattern-polyfill";
 globalThis.addEventListener = () => {};
 //#region deno.json
 var name = "@fedify/fedify";
-var version = "2.4.0-dev.2149+e2302034";
+var version = "2.4.0-dev.2157+b76e5888";
 //#endregion
 export { version as n, name as t };

package/dist/{dist-BQvArojP.mjs → dist-DJQM4u7i.mjs}

@@ -6,6 +6,7 @@ import { configure, getConsoleSink, getLogger, reset } from "@logtape/logtape";
 import "@opentelemetry/sdk-trace-base";
 import "@opentelemetry/core";
 //#region ../fixture/dist/mod.js
+const fixtureFetch = globalThis.fetch.bind(globalThis);
 const logger = getLogger(["fixture", "docloader"]);
 /**
 * A mock of the document loader.  This does not make any actual HTTP requests
@@ -20,7 +21,7 @@ async function mockDocumentLoader(resource, _options) {
 	if ("navigator" in globalThis && navigator.userAgent === "Cloudflare-Workers") {
 		const testUrl = new URL(url);
 		testUrl.hostname += ".test";
-		const resp = await fetch(testUrl);
+		const resp = await fixtureFetch(testUrl);
 		if (resp.ok) {
 			const document = await resp.json();
 			logger.debug("Successfully fetched fixture {resource}: {status} {statusText}\n{body}", {

package/dist/docloader-BMqr3hji.mjs

@@ -0,0 +1,79 @@
+import "temporal-polyfill";
+import "urlpattern-polyfill";
+globalThis.addEventListener = () => {};
+import { c as validateCryptoKey } from "./key-CPM4r6tP.mjs";
+import { n as doubleKnock } from "./http-CGcLv8rh.mjs";
+import { getLogger } from "@logtape/logtape";
+import { curry } from "es-toolkit";
+import { FetchError, UrlError, createActivityPubRequest, getRemoteDocument, logRequest, validatePublicUrl } from "@fedify/vocab-runtime";
+//#region src/utils/docloader.ts
+const logger = getLogger([
+	"fedify",
+	"utils",
+	"docloader"
+]);
+const DEFAULT_MAX_REDIRECTION = 20;
+/**
+* Gets an authenticated {@link DocumentLoader} for the given identity.
+* Note that an authenticated document loader intentionally does not cache
+* the fetched documents.
+* At most 20 HTTP redirects and alternate document links are followed in total
+* per call.  Revisiting a URL within that chain throws a {@link FetchError}.
+* @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
+*/
+function getAuthenticatedDocumentLoader(identity, { allowPrivateAddress, maxRedirection, userAgent, specDeterminer, tracerProvider } = {}) {
+	validateCryptoKey(identity.privateKey);
+	async function load(url, options, redirected = 0, visited = /* @__PURE__ */ new Set()) {
+		options?.signal?.throwIfAborted();
+		let currentUrl = new URL(url).href;
+		await validateUrl(currentUrl, options);
+		visited.add(currentUrl);
+		const originalRequest = createActivityPubRequest(currentUrl, { userAgent });
+		function follow(nextUrl) {
+			options?.signal?.throwIfAborted();
+			if (redirected >= DEFAULT_MAX_REDIRECTION) throw new FetchError(currentUrl, `Too many redirections (${redirected + 1})`);
+			if (visited.has(nextUrl)) throw new FetchError(currentUrl, `Redirect loop detected: ${nextUrl}`);
+			redirected++;
+		}
+		const response = await doubleKnock(originalRequest, identity, {
+			maxRedirection,
+			specDeterminer,
+			log: curry(logRequest)(logger),
+			tracerProvider,
+			signal: options?.signal,
+			validateRedirect: async (nextUrl) => {
+				follow(nextUrl);
+				await validateUrl(nextUrl, options);
+				visited.add(nextUrl);
+				currentUrl = nextUrl;
+			}
+		});
+		return getRemoteDocument(currentUrl, response, (alternateUrl) => {
+			follow(alternateUrl);
+			return load(alternateUrl, options, redirected, visited);
+		}, options);
+	}
+	async function validateUrl(url, options) {
+		if (!allowPrivateAddress) try {
+			await validatePublicUrl(url);
+		} catch (error) {
+			if (error instanceof UrlError) if (error.reason === "dns") logger.debug("DNS lookup failed for {url}", {
+				url,
+				error
+			});
+			else logger[options?.suppressError ? "warn" : "error"]("Disallowed private URL: {url}", {
+				url,
+				error
+			});
+			throw error;
+		}
+	}
+	return (url, options) => load(url, options);
+}
+//#endregion
+export { getAuthenticatedDocumentLoader as t };

package/dist/federation/builder.test.mjs

@@ -6,7 +6,7 @@ import { t as assertEquals } from "../assert_equals-Z6IcEbWU.mjs";
 import { t as assertExists } from "../assert_exists-cffSpJ7X.mjs";
 import { t as assertThrows } from "../assert_throws-BYITOvPO.mjs";
 import "../std__assert-DvMDRPes.mjs";
-import { r as createFederationBuilder } from "../builder-W2fIPRjv.mjs";
+import { r as createFederationBuilder } from "../builder-CLaS4-yA.mjs";
 import { DisallowedOperatorError, DisallowedVarSpecModifierError, DuplicateRouteVariableError, RouteTemplateOptionsNotMatchedError, RouterError } from "@fedify/uri-template";
 import { Activity, Note, Person } from "@fedify/vocab";
 import { test } from "@fedify/fixture";

package/dist/federation/compound-fanout.test.mjs

@@ -6,11 +6,11 @@ import { t as MemoryKvStore } from "../kv-DCHkaJ9-.mjs";
 import { t as assertEquals } from "../assert_equals-Z6IcEbWU.mjs";
 import "../std__assert-DvMDRPes.mjs";
 import { t as assert } from "../assert-D1Eafmd_.mjs";
-import { n as exportJwk } from "../key-BtO7WCfP.mjs";
+import { n as exportJwk } from "../key-CPM4r6tP.mjs";
 import { r as normalizeOutgoingActivityJsonLd } from "../outgoing-jsonld-4IJqPYos.mjs";
-import { i as signObject, u as verifyProof } from "../proof-DWkXfZIU.mjs";
+import { a as signObject, d as verifyProof } from "../proof-C2YwD8a_.mjs";
 import { i as rsaPrivateKey2, n as ed25519PrivateKey, r as ed25519PublicKey, s as rsaPublicKey2 } from "../keys-DIJNHW-Y.mjs";
-import { n as FederationImpl } from "../middleware-CBGR92fz.mjs";
+import { n as FederationImpl } from "../middleware-xdukzV3x.mjs";
 import { Create, DataIntegrityProof, Note } from "@fedify/vocab";
 import { mockDocumentLoader, test } from "@fedify/fixture";
 import { exportDidKey, parseIri } from "@fedify/vocab-runtime";

package/dist/federation/handler-compound-proof.test.mjs

@@ -1,14 +1,14 @@
 import "temporal-polyfill";
 import "urlpattern-polyfill";
 globalThis.addEventListener = () => {};
-import { r as createRequestContext, t as createInboxContext } from "../context-DfSVPcJ8.mjs";
+import { r as createRequestContext, t as createInboxContext } from "../context-B2rlkkyJ.mjs";
 import { t as MemoryKvStore } from "../kv-DCHkaJ9-.mjs";
 import { t as assertEquals } from "../assert_equals-Z6IcEbWU.mjs";
 import "../std__assert-DvMDRPes.mjs";
-import { a as compactJsonLd, m as verifyCompactJsonLd, p as signJsonLd } from "../ld-YYBfDbe_.mjs";
-import { l as signRequest } from "../http-BoH-e8sR.mjs";
+import { a as compactJsonLd, m as verifyCompactJsonLd, p as signJsonLd } from "../ld-lU_ZqzsQ.mjs";
+import { l as signRequest } from "../http-CGcLv8rh.mjs";
 import { a as rsaPrivateKey3, c as rsaPublicKey3, n as ed25519PrivateKey, r as ed25519PublicKey, s as rsaPublicKey2 } from "../keys-DIJNHW-Y.mjs";
-import { f as handleInbox, o as createFederation } from "../middleware-CBGR92fz.mjs";
+import { f as handleInbox, o as createFederation } from "../middleware-xdukzV3x.mjs";
 import { t as ActivityListenerSet } from "../activity-listener-C-BSbKI7.mjs";
 import { t as map_local_create_note_default } from "../map-local-create-note-B0SeXJms.mjs";
 import { Create, CryptographicKey, Multikey, Person, Update } from "@fedify/vocab";