@fedify/fedify 1.8.1-pr.331.1178 → 1.8.1-pr.332.1179

package/dist/testing/mod.d.ts

@@ -7062,6 +7062,45 @@ type AuthorizePredicate<TContextData> = (context: RequestContext<TContextData>,
  * @since 0.7.0
  */
 type ObjectAuthorizePredicate<TContextData, TParam extends string> = (context: RequestContext<TContextData>, values: Record<TParam, string>, signedKey: CryptographicKey | null, signedKeyOwner: Actor | null) => boolean | Promise<boolean>;
+/**
+ * A callback that dispatches a custom collection.
+ *
+ * @typeParam TItem The type of items in the collection.
+ * @typeParam TParams The parameter names of the requested URL.
+ * @typeParam TContext The type of the context. {@link Context} or
+ *                     {@link RequestContext}.
+ * @typeParam TContextData The context data to pass to the `TContext`.
+ * @typeParam TFilter The type of the filter, if any.
+ * @param context The context.
+ * @param values The parameters of the requested URL.
+ * @param cursor The cursor to start the collection from, or `null` to dispatch
+ *               the entire collection without pagination.
+ * @since 1.8.0
+ */
+type CustomCollectionDispatcher<TItem, TParams extends Record<string, string>, TContext extends Context<TContextData>, TContextData> = (context: TContext, values: TParams, cursor: string | null) => PageItems<TItem> | null | Promise<PageItems<TItem> | null>;
+/**
+ * A callback that counts the number of items in a custom collection.
+ *
+ * @typeParam TParams The parameter names of the requested URL.
+ * @typeParam TContextData The context data to pass to the {@link Context}.
+ * @param context The context.
+ * @param values The parameters of the requested URL.
+ * @since 1.8.0
+ */
+type CustomCollectionCounter<TParams extends Record<string, string>, TContextData> = (context: RequestContext<TContextData>, values: TParams) => number | bigint | null | Promise<number | bigint | null>;
+/**
+ * A callback that returns a cursor for a custom collection.
+ *
+ * @typeParam TParams The parameter names of the requested URL.
+ * @typeParam TContext The type of the context. {@link Context} or
+ *                     {@link RequestContext}.
+ * @typeParam TContextData The context data to pass to the {@link Context}.
+ * @typeParam TFilter The type of the filter, if any.
+ * @param context The context.
+ * @param values The parameters of the requested URL.
+ * @since 1.8.0
+ */
+type CustomCollectionCursor<TParams extends Record<string, string>, TContext extends Context<TContextData>, TContextData> = (context: TContext, values: TParams) => string | null | Promise<string | null>;
 //#endregion
 //#region federation/queue.d.ts
 interface SenderKeyJwkPair {
@@ -7400,6 +7439,36 @@ interface Federatable<TContextData> {
    * @throws {RouteError} Thrown if the path pattern is invalid.
    */
   setInboxListeners(inboxPath: `${string}{identifier}${string}` | `${string}{handle}${string}`, sharedInboxPath?: string): InboxListenerSetters<TContextData>;
+  /**
+   * Registers a collection of objects dispatcher.
+   *
+   * @typeParam TContextData The context data to pass to the {@link Context}.
+   * @typeParam TObject The type of objects to dispatch.
+   * @typeParam TParam The parameter names of the requested URL.
+   * @param name A unique name for the collection dispatcher.
+   * @param itemType The Activity Vocabulary class of the object to dispatch.
+   * @param path The URI path pattern for the collection dispatcher.
+   *             The syntax is based on URI Template
+   *             ([RFC 6570](https://tools.ietf.org/html/rfc6570)).
+   *             The path must have one or more variables.
+   * @param dispatcher A collection dispatcher callback to register.
+   */
+  setCollectionDispatcher<TObject extends Object$1, TParams extends Record<string, string>>(name: string | symbol, itemType: ConstructorWithTypeId<TObject>, path: ParamsKeyPath<TParams>, dispatcher: CustomCollectionDispatcher<TObject, TParams, RequestContext<TContextData>, TContextData>): CustomCollectionCallbackSetters<TParams, RequestContext<TContextData>, TContextData>;
+  /**
+   * Registers an ordered collection of objects dispatcher.
+   *
+   * @typeParam TContextData The context data to pass to the {@link Context}.
+   * @typeParam TObject The type of objects to dispatch.
+   * @typeParam TParam The parameter names of the requested URL.
+   * @param name A unique name for the collection dispatcher.
+   * @param itemType The Activity Vocabulary class of the object to dispatch.
+   * @param path The URI path pattern for the collection dispatcher.
+   *             The syntax is based on URI Template
+   *             ([RFC 6570](https://tools.ietf.org/html/rfc6570)).
+   *             The path must have one or more variables.
+   * @param dispatcher A collection dispatcher callback to register.
+   */
+  setOrderedCollectionDispatcher<TObject extends Object$1, TParams extends Record<string, string>>(name: string | symbol, itemType: ConstructorWithTypeId<TObject>, path: ParamsKeyPath<TParams>, dispatcher: CustomCollectionDispatcher<TObject, TParams, RequestContext<TContextData>, TContextData>): CustomCollectionCallbackSetters<TParams, RequestContext<TContextData>, TContextData>;
 }
 /**
  * An object that registers federation-related business logic and dispatches
@@ -7635,6 +7704,119 @@ interface FederationFetchOptions<TContextData> {
    */
   onUnauthorized?: (request: Request) => Response | Promise<Response>;
 }
+/**
+ * Additional settings for a custom collection dispatcher.
+ *
+ * @typeParam TParams The type of the parameters in the URL path.
+ * @typeParam TContext The type of the context.  {@link Context} or
+ *                     {@link RequestContext}.
+ * @typeParam TContextData The context data to pass to the {@link Context}.
+ * @typeParam TFilter The type of filter for the collection.
+ */
+interface CustomCollectionCallbackSetters<TParams extends Record<string, string>, TContext extends Context<TContextData>, TContextData> {
+  /**
+   * Sets the counter for the custom collection.
+   * @param counter A callback that returns the number of items in the custom collection.
+   * @returns The setters object so that settings can be chained.
+   */
+  setCounter(counter: CustomCollectionCounter<TParams, TContextData>): CustomCollectionCallbackSetters<TParams, TContext, TContextData>;
+  /**
+   * Sets the first cursor for the custom collection.
+   * @param cursor The cursor for the first item in the custom collection.
+   * @returns The setters object so that settings can be chained.
+   */
+  setFirstCursor(cursor: CustomCollectionCursor<TParams, TContext, TContextData>): CustomCollectionCallbackSetters<TParams, TContext, TContextData>;
+  /**
+   * Sets the last cursor for the custom collection.
+   * @param cursor The cursor for the last item in the custom collection.
+   * @returns The setters object so that settings can be chained.
+   */
+  setLastCursor(cursor: CustomCollectionCursor<TParams, TContext, TContextData>): CustomCollectionCallbackSetters<TParams, TContext, TContextData>;
+  /**
+   * Specifies the conditions under which requests are authorized.
+   * @param predicate A callback that returns whether a request is authorized.
+   * @returns The setters object so that settings can be chained.
+   * @since 0.7.0
+   */
+  authorize(predicate: ObjectAuthorizePredicate<TContextData, string>): CustomCollectionCallbackSetters<TParams, TContext, TContextData>;
+}
+/**
+ * Represents an object with a type ID, which is either a constructor or an
+ * instance of the object.
+ *
+ * @typeParam TObject The type of the object.
+ */
+type ConstructorWithTypeId<TObject extends Object$1> = (new (...args: any[]) => TObject) & {
+  typeId: URL;
+};
+/**
+ * Represents a path from the key of parameter objects.
+ * @param Params - A record of parameters where keys are parameter names and
+ *                 values are their string representations.
+ * @returns A string representing the path with all parameters.
+ * @example
+ * ```ts
+ * type UserPostPath = ParamsKeyPath<{ userId: string; postId: string }>;
+ * let userPostPath: UserPostPath;
+ * // userPostPath = "/posts/{postId}"; // invalid - does not contain `{userId}`
+ * // userPostPath = "/users/{userId}"; // invalid - does not contain `{postId}`
+ * userPostPath = "/users/{userId}/posts/{postId}"; // valid
+ * userPostPath = "/posts/{postId}/users/{userId}"; // valid
+ * ```
+ */
+type ParamsKeyPath<Params extends Record<string, string>> = ParamsPath<Extract<keyof Params, string>> & string;
+/**
+ * Represents a path with multiple parameters.
+ * All permutations of the parameters are included in the union type.
+ * The path must have all parameters in the form of `{paramName}`.
+ * @param Params - A union of parameter names.
+ * @returns A string representing the path with all parameters.
+ * @example
+ * ```ts
+ * type UserPostPath = ParamsPath<"userId" | "postId">;
+ * // = `${string}{userId}${string}` & `${string}{postId}${string}`
+ * // =
+ * //  | `${string}{userId}${string}{postId}${string}`
+ * //  | `${string}{postId}${string}{userId}${string}`
+ * let userPostPath: UserPostPath;
+ * userPostPath = "/users/posts"; // ❌ invalid
+ * userPostPath = "/users/{userId}"; // ❌ invalid
+ * userPostPath = "/posts/{postId}"; // ❌ invalid
+ * userPostPath = "/users/{userId}/posts/{postId}"; // ✅ valid
+ * userPostPath = "/posts/{postId}/users/{userId}"; // ✅ valid
+ */
+type ParamsPath<Params extends string> = UnionToIntersection<ParamPath<Params>>;
+/**
+ * Represents a path with a single parameter.
+ * The path must have at least one of the parameters in the form of `{paramName}`.
+ * @param Param - The name of the parameter.
+ * @returns A string representing the path with the parameter.
+ * @example
+ * ```ts
+ * type UserPostPath = ParamPath<"userId" | "postId">;
+ * // = `${string}{userId}${string}` | `${string}{postId}${string}`
+ * let userPostPath: UserPostPath;
+ * userPostPath = "/users/posts"; // ❌ invalid
+ * userPostPath = "/users/{userId}"; // ✅ valid
+ * userPostPath = "/posts/{postId}"; // ✅ valid
+ * userPostPath = "/users/{userId}/posts/{postId}"; // ✅ valid
+ * userPostPath = "/posts/{postId}/users/{userId}"; // ✅ valid
+ */
+type ParamPath<Param extends string> = `${string}{${Param}}${string}`;
+/**
+ * Converts union types to intersection types.
+ *
+ * @typeParam U - The union type to convert.
+ * @returns The intersection type of the union.
+ * @example
+ * ```ts
+ * type A = { a: string };
+ * type B = { b: number };
+ * type AorB = A | B;
+ * type AandB = UnionToIntersection<AorB>;
+ * // AandB = { a: string; b: number }
+ */
+type UnionToIntersection<U> = (U extends unknown ? (x: U) => void : never) extends ((x: infer I) => void) ? I : never;
 //#endregion
 //#region federation/context.d.ts
 /**
@@ -7989,6 +8171,16 @@ interface Context<TContextData> {
    * @since 1.3.0
    */
   routeActivity(recipient: string | null, activity: Activity, options?: RouteActivityOptions): Promise<boolean>;
+  /**
+   * Builds the URI of a collection of objects with the given name and values.
+   * @param name The name of the collection, which can be a string or a symbol.
+   * @param values The values of the URI parameters.
+   * @return The URI of the collection.
+   * @throws {RouteError} If no object dispatcher is available for the name.
+   * @throws {TypeError} If values are invalid.
+   * @since 1.8.0
+   */
+  getCollectionUri<TParam extends Record<string, string>>(name: string | symbol, values: TParam): URL;
 }
 /**
  * A context for a request.
@@ -8239,6 +8431,26 @@ type ParseUriResult =
   readonly type: "featuredTags";
   readonly identifier: string;
   readonly handle: string;
+}
+/**
+ * The case of a custom collection URI.
+ * @since 1.8.0
+ */ | {
+  readonly type: "collection";
+  readonly name: string | symbol;
+  readonly class: ConstructorWithTypeId<Object$1>;
+  readonly typeId: URL;
+  readonly values: Record<string, string>;
+}
+/**
+ * The case of a custom ordered collection URI.
+ * @since 1.8.0
+ */ | {
+  readonly type: "orderedCollection";
+  readonly name: string | symbol;
+  readonly class: ConstructorWithTypeId<Object$1>;
+  readonly typeId: URL;
+  readonly values: Record<string, string>;
 };
 /**
  * Options for {@link Context.sendActivity} method.

package/dist/testing/mod.js

@@ -3,8 +3,8 @@
       import { URLPattern } from "urlpattern-polyfill";
       globalThis.addEventListener = () => {};
     
-import "../type-6aat8vwp.js";
-import "../lookup-DYSWakdP.js";
-import { createInboxContext, createRequestContext, test, testDefinitions } from "../testing-BYK226ka.js";
+import "../type-Dn3B2sdm.js";
+import "../lookup-S2xtiVK9.js";
+import { createInboxContext, createRequestContext, test, testDefinitions } from "../testing-dG4K85Rn.js";
 
 export { createInboxContext, createRequestContext, test, testDefinitions };

package/dist/{testing-BYK226ka.js → testing-dG4K85Rn.js}

@@ -3,8 +3,8 @@
       import { URLPattern } from "urlpattern-polyfill";
       globalThis.addEventListener = () => {};
     
-import { __require, lookupWebFinger } from "./type-6aat8vwp.js";
-import { RouterError, lookupObject, traverseCollection } from "./lookup-DYSWakdP.js";
+import { __require, lookupWebFinger } from "./type-Dn3B2sdm.js";
+import { RouterError, lookupObject, traverseCollection } from "./lookup-S2xtiVK9.js";
 import { configure, getConsoleSink, getLogger, reset } from "@logtape/logtape";
 import { trace } from "@opentelemetry/api";
 
@@ -70,7 +70,7 @@ async function mockDocumentLoader(resource) {
 //#endregion
 //#region testing/context.ts
 function createContext(values) {
-	const { federation, url = new URL("http://example.com/"), canonicalOrigin, data, documentLoader, contextLoader, tracerProvider, clone, getNodeInfoUri, getActorUri, getObjectUri, getOutboxUri, getInboxUri, getFollowingUri, getFollowersUri, getLikedUri, getFeaturedUri, getFeaturedTagsUri, parseUri, getActorKeyPairs, getDocumentLoader, lookupObject: lookupObject$1, traverseCollection: traverseCollection$1, lookupNodeInfo, lookupWebFinger: lookupWebFinger$1, sendActivity, routeActivity } = values;
+	const { federation, url = new URL("http://example.com/"), canonicalOrigin, data, documentLoader, contextLoader, tracerProvider, clone, getNodeInfoUri, getActorUri, getObjectUri, getCollectionUri, getOutboxUri, getInboxUri, getFollowingUri, getFollowersUri, getLikedUri, getFeaturedUri, getFeaturedTagsUri, parseUri, getActorKeyPairs, getDocumentLoader, lookupObject: lookupObject$1, traverseCollection: traverseCollection$1, lookupNodeInfo, lookupWebFinger: lookupWebFinger$1, sendActivity, routeActivity } = values;
 	function throwRouteError() {
 		throw new RouterError("Not implemented");
 	}
@@ -91,6 +91,7 @@ function createContext(values) {
 		getNodeInfoUri: getNodeInfoUri ?? throwRouteError,
 		getActorUri: getActorUri ?? throwRouteError,
 		getObjectUri: getObjectUri ?? throwRouteError,
+		getCollectionUri: getCollectionUri ?? throwRouteError,
 		getOutboxUri: getOutboxUri ?? throwRouteError,
 		getInboxUri: getInboxUri ?? throwRouteError,
 		getFollowingUri: getFollowingUri ?? throwRouteError,