@fedify/fedify 1.6.1-dev.869 → 1.6.1-dev.873

package/dist/federation/callback.d.ts

@@ -1,211 +0,0 @@
-import { Temporal } from "@js-temporal/polyfill";
-import { URLPattern } from "urlpattern-polyfill";
-import { NodeInfo } from "../nodeinfo/types.js";
-import { Activity$1 as Activity, CryptographicKey$1 as CryptographicKey, Object$1 } from "../vocab/vocab.js";
-import { Actor } from "../vocab/actor.js";
-import { PageItems } from "./collection.js";
-import { SenderKeyPair } from "./send.js";
-import { Context, InboxContext, RequestContext } from "./context.js";
-
-//#region federation/callback.d.ts
-/**
-* A callback that dispatches a {@link NodeInfo} object.
-*
-* @typeParam TContextData The context data to pass to the {@link Context}.
-*/
-/**
- * A callback that dispatches a {@link NodeInfo} object.
- *
- * @typeParam TContextData The context data to pass to the {@link Context}.
- */
-type NodeInfoDispatcher<TContextData> = (context: RequestContext<TContextData>) => NodeInfo | Promise<NodeInfo>;
-/**
- * A callback that dispatches an {@link Actor} object.
- *
- * @typeParam TContextData The context data to pass to the {@link Context}.
- * @param context The request context.
- * @param identifier The actor's internal identifier or username.
- */
-type ActorDispatcher<TContextData> = (context: RequestContext<TContextData>, identifier: string) => Actor | null | Promise<Actor | null>;
-/**
- * A callback that dispatches key pairs for an actor.
- *
- * @typeParam TContextData The context data to pass to the {@link Context}.
- * @param context The context.
- * @param identifier The actor's internal identifier or username.
- * @returns The key pairs.
- * @since 0.10.0
- */
-type ActorKeyPairsDispatcher<TContextData> = (context: Context<TContextData>, identifier: string) => CryptoKeyPair[] | Promise<CryptoKeyPair[]>;
-/**
- * A callback that maps a WebFinger username to the corresponding actor's
- * internal identifier, or `null` if the username is not found.
- * @typeParam TContextData The context data to pass to the {@link Context}.
- * @param context The context.
- * @param username The WebFinger username.
- * @returns The actor's internal identifier, or `null` if the username is not
- *          found.
- * @since 0.15.0
- */
-type ActorHandleMapper<TContextData> = (context: Context<TContextData>, username: string) => string | null | Promise<string | null>;
-/**
- * A callback that maps a WebFinger query to the corresponding actor's
- * internal identifier or username, or `null` if the query is not found.
- * @typeParam TContextData The context data to pass to the {@link Context}.
- * @param context The request context.
- * @param resource The URL that was queried through WebFinger.
- * @returns The actor's internal identifier or username, or `null` if the query
- *          is not found.
- * @since 1.4.0
- */
-type ActorAliasMapper<TContextData> = (context: RequestContext<TContextData>, resource: URL) => {
-  identifier: string;
-} | {
-  username: string;
-} | null | Promise<{
-  identifier: string;
-} | {
-  username: string;
-} | null>;
-/**
- * A callback that dispatches an object.
- *
- * @typeParam TContextData The context data to pass to the {@link Context}.
- * @typeParam TObject The type of object to dispatch.
- * @typeParam TParam The parameter names of the requested URL.
- * @since 0.7.0
- */
-type ObjectDispatcher<TContextData, TObject extends Object$1, TParam extends string> = (context: RequestContext<TContextData>, values: Record<TParam, string>) => TObject | null | Promise<TObject | null>;
-/**
- * A callback that dispatches a collection.
- *
- * @typeParam TItem The type of items in the collection.
- * @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 identifier The internal identifier or the username of the collection
- *                   owner.
- * @param cursor The cursor to start the collection from, or `null` to dispatch
- *               the entire collection without pagination.
- * @param filter The filter to apply to the collection, if any.
- */
-type CollectionDispatcher<TItem, TContext extends Context<TContextData>, TContextData, TFilter> = (context: TContext, identifier: string, cursor: string | null, filter?: TFilter) => PageItems<TItem> | null | Promise<PageItems<TItem> | null>;
-/**
- * A callback that counts the number of items in a collection.
- *
- * @typeParam TContextData The context data to pass to the {@link Context}.
- * @param context The context.
- * @param identifier The internal identifier or the username of the collection
- *                   owner.
- * @param filter The filter to apply to the collection, if any.
- */
-type CollectionCounter<TContextData, TFilter> = (context: RequestContext<TContextData>, identifier: string, filter?: TFilter) => number | bigint | null | Promise<number | bigint | null>;
-/**
- * A callback that returns a cursor for a collection.
- *
- * @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 identifier The internal identifier or the username of the collection
- *                   owner.
- * @param filter The filter to apply to the collection, if any.
- */
-type CollectionCursor<TContext extends Context<TContextData>, TContextData, TFilter> = (context: TContext, identifier: string, filter?: TFilter) => string | null | Promise<string | null>;
-/**
- * A callback that listens for activities in an inbox.
- *
- * @typeParam TContextData The context data to pass to the {@link Context}.
- * @typeParam TActivity The type of activity to listen for.
- * @param context The inbox context.
- * @param activity The activity that was received.
- */
-type InboxListener<TContextData, TActivity extends Activity> = (context: InboxContext<TContextData>, activity: TActivity) => void | Promise<void>;
-/**
- * A callback that handles errors in an inbox.
- *
- * @typeParam TContextData The context data to pass to the {@link Context}.
- * @param context The inbox context.
- */
-type InboxErrorHandler<TContextData> = (context: Context<TContextData>, error: Error) => void | Promise<void>;
-/**
- * A callback that dispatches the key pair for the authenticated document loader
- * of the {@link Context} passed to the shared inbox listener.
- *
- * @typeParam TContextData The context data to pass to the {@link Context}.
- * @param context The context.
- * @returns The username or the internal identifier of the actor or the key pair
- *          for the authenticated document loader of the {@link Context} passed
- *          to the shared inbox listener.  If `null` is returned, the request is
- *          not authorized.
- * @since 0.11.0
- */
-type SharedInboxKeyDispatcher<TContextData> = (context: Context<TContextData>) => SenderKeyPair | {
-  identifier: string;
-} | {
-  username: string;
-} | {
-  handle: string;
-} | null | Promise<SenderKeyPair | {
-  identifier: string;
-} | {
-  username: string;
-} | {
-  handle: string;
-} | null>;
-/**
- * A callback that handles errors during outbox processing.
- *
- * @param error The error that occurred.
- * @param activity The activity that caused the error.  If it is `null`, the
- *                 error occurred during deserializing the activity.
- * @since 0.6.0
- */
-type OutboxErrorHandler = (error: Error, activity: Activity | null) => void | Promise<void>;
-/**
- * A callback that determines if a request is authorized or not.
- *
- * @typeParam TContextData The context data to pass to the {@link Context}.
- * @param context The request context.
- * @param identifier The internal identifier of the actor that is being requested.
- * @param signedKey *Deprecated in Fedify 1.5.0 in favor of
- *                  {@link RequestContext.getSignedKey} method.*
- *                  The key that was used to sign the request, or `null` if
- *                  the request was not signed or the signature was invalid.
- * @param signedKeyOwner *Deprecated in Fedify 1.5.0 in favor of
- *                       {@link RequestContext.getSignedKeyOwner} method.*
- *                       The actor that owns the key that was used to sign the
- *                       request, or `null` if the request was not signed or the
- *                       signature was invalid, or if the key is not associated
- *                       with an actor.
- * @returns `true` if the request is authorized, `false` otherwise.
- * @since 0.7.0
- */
-type AuthorizePredicate<TContextData> = (context: RequestContext<TContextData>, identifier: string, signedKey: CryptographicKey | null, signedKeyOwner: Actor | null) => boolean | Promise<boolean>;
-/**
- * A callback that determines if a request is authorized or not.
- *
- * @typeParam TContextData The context data to pass to the {@link Context}.
- * @typeParam TParam The parameter names of the requested URL.
- * @param context The request context.
- * @param values The parameters of the requested URL.
- * @param signedKey *Deprecated in Fedify 1.5.0 in favor of
- *                  {@link RequestContext.getSignedKey} method.*
- *                  The key that was used to sign the request, or `null` if
- *                  the request was not signed or the signature was invalid.
- * @param signedKeyOwner *Deprecated in Fedify 1.5.0 in favor of
- *                       {@link RequestContext.getSignedKeyOwner} method.*
- *                       The actor that owns the key that was used to sign the
- *                       request, or `null` if the request was not signed or the
- *                       signature was invalid, or if the key is not associated
- *                       with an actor.
- * @returns `true` if the request is authorized, `false` otherwise.
- * @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>;
-
-//#endregion
-export { ActorAliasMapper, ActorDispatcher, ActorHandleMapper, ActorKeyPairsDispatcher, AuthorizePredicate, CollectionCounter, CollectionCursor, CollectionDispatcher, InboxErrorHandler, InboxListener, NodeInfoDispatcher, ObjectAuthorizePredicate, ObjectDispatcher, OutboxErrorHandler, SharedInboxKeyDispatcher };

package/dist/federation/collection.d.ts

@@ -1,36 +0,0 @@
-import { Temporal } from "@js-temporal/polyfill";
-import { URLPattern } from "urlpattern-polyfill";
-
-//#region federation/collection.d.ts
-/**
-* A page of items.
-*/
-/**
- * A page of items.
- */
-interface PageItems<TItem> {
-  prevCursor?: string | null;
-  nextCursor?: string | null;
-  items: TItem[];
-}
-/**
- * Calculates the [partial follower collection digest][1].
- *
- * [1]: https://w3id.org/fep/8fcf#partial-follower-collection-digest
- * @param uris The URIs to calculate the digest.  Duplicate URIs are ignored.
- * @returns The digest.
- */
-declare function digest(uris: Iterable<string | URL>): Promise<Uint8Array>;
-/**
- * Builds [`Collection-Synchronization`][1] header content.
- *
- * [1]: https://w3id.org/fep/8fcf#the-collection-synchronization-http-header
- *
- * @param collectionId The sender's followers collection URI.
- * @param actorIds The actor URIs to digest.
- * @returns The header content.
- */
-declare function buildCollectionSynchronizationHeader(collectionId: string | URL, actorIds: Iterable<string | URL>): Promise<string>;
-
-//#endregion
-export { PageItems, buildCollectionSynchronizationHeader as buildCollectionSynchronizationHeader$1, digest as digest$1 };