@fedify/fedify 2.4.0-dev.1668 → 2.4.0-dev.1740

package/dist/compat/mod.js

@@ -1,4 +1,4 @@
 import { Temporal } from "temporal-polyfill";
 import { URLPattern } from "urlpattern-polyfill";
-import { n as autoIdAssigner, r as getDefaultActivityTransformers, t as actorDehydrator } from "../transformers-DXze6FUB.js";
+import { n as autoIdAssigner, r as getDefaultActivityTransformers, t as actorDehydrator } from "../transformers-DAtXl_Kc.js";
 export { actorDehydrator, autoIdAssigner, getDefaultActivityTransformers };

package/dist/compat/outgoing-jsonld.test.mjs

@@ -1,9 +1,9 @@
 import "temporal-polyfill";
 import "urlpattern-polyfill";
 globalThis.addEventListener = () => {};
-import { t as assertEquals } from "../assert_equals-BV7oLMxm.mjs";
-import { t as assertStrictEquals } from "../assert_strict_equals-Ec20AUwa.mjs";
-import { n as normalizeAttachmentArrays, r as normalizeOutgoingActivityJsonLd, t as isPreloadedContextAttachmentSafe } from "../outgoing-jsonld-URuqsICz.mjs";
+import { t as assertEquals } from "../assert_equals-CBlRfA-_.mjs";
+import { t as assertStrictEquals } from "../assert_strict_equals-Bpjl4Psw.mjs";
+import { n as normalizeAttachmentArrays, r as normalizeOutgoingActivityJsonLd, t as isPreloadedContextAttachmentSafe } from "../outgoing-jsonld-BQSHRLhg.mjs";
 import { Create, Document, Note, PUBLIC_COLLECTION } from "@fedify/vocab";
 import { mockDocumentLoader, test } from "@fedify/fixture";
 //#region src/compat/outgoing-jsonld.test.ts

package/dist/compat/public-audience.test.mjs

@@ -1,9 +1,9 @@
 import "temporal-polyfill";
 import "urlpattern-polyfill";
 globalThis.addEventListener = () => {};
-import { t as assertEquals } from "../assert_equals-BV7oLMxm.mjs";
-import { t as assertNotEquals } from "../assert_not_equals-EPJPoxuf.mjs";
-import { t as normalizePublicAudience } from "../public-audience-Cr5MsnMq.mjs";
+import { t as assertEquals } from "../assert_equals-CBlRfA-_.mjs";
+import { t as assertNotEquals } from "../assert_not_equals-BN7yDMWe.mjs";
+import { t as normalizePublicAudience } from "../public-audience--9hx7IGx.mjs";
 import { Create, Note, PUBLIC_COLLECTION } from "@fedify/vocab";
 import { test } from "@fedify/fixture";
 import { getDocumentLoader, preloadedContexts } from "@fedify/vocab-runtime";

package/dist/compat/transformers.test.mjs

@@ -1,11 +1,11 @@
 import "temporal-polyfill";
 import "urlpattern-polyfill";
 globalThis.addEventListener = () => {};
-import { t as MemoryKvStore } from "../kv-CXBAok3k.mjs";
-import { t as assertEquals } from "../assert_equals-BV7oLMxm.mjs";
-import { t as assertInstanceOf } from "../assert_instance_of-Q9KTBnrf.mjs";
-import { t as assert } from "../assert-CJ1KXcvv.mjs";
-import { b as autoIdAssigner, n as FederationImpl, y as actorDehydrator } from "../middleware-DrroX3aD.mjs";
+import { t as MemoryKvStore } from "../kv-DCHkaJ9-.mjs";
+import { t as assertEquals } from "../assert_equals-CBlRfA-_.mjs";
+import { t as assertInstanceOf } from "../assert_instance_of-g3WcyYNR.mjs";
+import { t as assert } from "../assert-CebeUf0C.mjs";
+import { b as autoIdAssigner, n as FederationImpl, y as actorDehydrator } from "../middleware-DPIS4fsB.mjs";
 import { Follow, Person } from "@fedify/vocab";
 import { test } from "@fedify/fixture";
 //#region src/compat/transformers.test.ts

package/dist/{context-C05Rgxmu.d.cts → context-B-dsBjZ9.d.cts}

@@ -1,9 +1,8 @@
 /// <reference lib="esnext.temporal" />
-import { o as JsonValue, s as NodeInfo, t as GetNodeInfoOptions } from "./client-CAM_bQXx.cjs";
-import { o as VerifyRequestFailureReason, t as HttpMessageSignaturesSpec } from "./http-VyDTd4G3.cjs";
-import { n as GetKeyOwnerOptions } from "./owner-DEvZuyOE.cjs";
-import { n as KvStore, t as KvKey } from "./kv-gJ8LYbxX.cjs";
-import { i as MessageQueue } from "./metrics-DN13mCAw.cjs";
+import { o as JsonValue, s as NodeInfo, t as GetNodeInfoOptions } from "./client-D-XP_Ccb.cjs";
+import { o as VerifyRequestFailureReason, t as HttpMessageSignaturesSpec } from "./http-6TI0tI03.cjs";
+import { n as GetKeyOwnerOptions } from "./owner-r_waTiQj.cjs";
+import { n as KvStore, t as KvKey } from "./kv-BhNbN8Ed.cjs";
 import { Activity, Actor, Collection, CryptographicKey, Hashtag, Link, LookupObjectOptions, Multikey, Object as Object$1, Recipient, Tombstone, TraverseCollectionOptions } from "@fedify/vocab";
 import { AuthenticatedDocumentLoaderFactory, DocumentLoader, DocumentLoaderFactory, GetUserAgentOptions } from "@fedify/vocab-runtime";
 import { Link as Link$1, LookupWebFingerOptions, ResourceDescriptor } from "@fedify/webfinger";
@@ -507,6 +506,16 @@ type CircuitBreakerOptions = CircuitBreakerFailurePolicy & {
   */
   readonly releaseInterval?: Temporal.Duration | Temporal.DurationLike;
   /**
+  * How long Fedify keeps circuit breaker state in the configured key-value
+  * store.
+  *
+  * When omitted, Fedify derives this from `failureWindow`, `recoveryDelay`, and
+  * `heldActivityTtl` for the default numeric failure policy.  Custom `failure`
+  * callbacks do not have an inspectable time window, so custom policies do not
+  * expire their stored state unless this option is provided.
+  */
+  readonly stateTtl?: Temporal.Duration | Temporal.DurationLike;
+  /**
   * Called whenever the circuit state changes.
   */
   readonly onStateChange?: (remoteHost: string, previousState: CircuitBreakerState, newState: CircuitBreakerState) => void | Promise<void>;
@@ -525,6 +534,7 @@ interface NormalizedCircuitBreakerOptions {
   readonly recoveryDelay: Temporal.Duration;
   readonly heldActivityTtl: Temporal.Duration;
   readonly releaseInterval: Temporal.Duration;
+  readonly stateTtl: Temporal.Duration | undefined;
   readonly onStateChange?: CircuitBreakerOptions["onStateChange"];
   readonly onActivityDrop?: CircuitBreakerOptions["onActivityDrop"];
 }
@@ -585,6 +595,11 @@ declare class CircuitBreaker {
   recordFailure(remoteHost: string): Promise<CircuitBreakerStateChange | undefined>;
   dropActivity(remoteHost: string, details: CircuitBreakerActivityDrop): Promise<void>;
   getState(remoteHost: string): Promise<CircuitBreakerKvState | undefined>;
+  /**
+  * The currently running background legacy sweep, if any.
+  * @internal
+  */
+  get pendingSweep(): Promise<void> | undefined;
 }
 /**
 * Normalizes user-provided circuit breaker options into the internal policy
@@ -593,7 +608,8 @@ declare class CircuitBreaker {
 * @param options The public circuit breaker options supplied to Fedify.
 * @returns The normalized failure predicate, failure pruning function,
 * duration values, and optional callbacks with defaults applied.
-* @throws {RangeError} If any configured duration is not positive.
+* @throws {RangeError} If any configured duration is not positive, or if
+* `stateTtl` is shorter than `recoveryDelay`.
 * @throws {TypeError} If `failureThreshold` is not a positive integer.
 */
 declare function normalizeCircuitBreakerOptions(options: CircuitBreakerOptions): NormalizedCircuitBreakerOptions;
@@ -606,6 +622,264 @@ declare function normalizeCircuitBreakerOptions(options: CircuitBreakerOptions):
 */
 declare function parseCircuitBreakerKvState(value: unknown): CircuitBreakerKvState | undefined;
 //#endregion
+//#region src/federation/mq.d.ts
+/**
+* Additional options for enqueuing a message in a queue.
+*
+* @since 0.5.0
+*/
+interface MessageQueueEnqueueOptions {
+  /**
+  * The delay before the message is enqueued.  No delay by default.
+  *
+  * It must not be negative.
+  */
+  readonly delay?: Temporal.Duration;
+  /**
+  * An optional key that ensures messages with the same ordering key are
+  * processed sequentially (one at a time).  Messages with different ordering
+  * keys (or no ordering key) may be processed in parallel.
+  *
+  * This is useful for ensuring that related messages are processed in order,
+  * such as ensuring that a `Delete` activity is processed after a `Create`
+  * activity for the same object.
+  *
+  * @since 2.0.0
+  */
+  readonly orderingKey?: string;
+  /**
+  * An optional key requesting at-most-once enqueue semantics for messages
+  * that share it.  A backend that declares
+  * {@link MessageQueue.nativeDeduplication} `true` owns the check: a message
+  * whose `deduplicationKey` was already seen within the backend's
+  * deduplication window is dropped instead of enqueued.  Backends without
+  * native deduplication ignore this field; Fedify performs its own
+  * best-effort deduplication before reaching them on the paths that support
+  * it.
+  *
+  * @since 2.4.0
+  */
+  readonly deduplicationKey?: string;
+}
+/**
+* Additional options for listening to a message queue.
+*
+* @since 1.0.0
+*/
+interface MessageQueueListenOptions {
+  /**
+  * The signal to abort listening to the message queue.
+  */
+  signal?: AbortSignal;
+}
+/**
+* The number of messages waiting in a message queue.
+*
+* @since 2.3.0
+*/
+interface MessageQueueDepth {
+  /**
+  * The total number of messages still waiting in the backend queue.
+  *
+  * This does not include messages that have already been handed to a worker
+  * for processing.
+  */
+  readonly queued: number;
+  /**
+  * The number of queued messages eligible for immediate processing.
+  *
+  * Queue backends that cannot cheaply distinguish ready and delayed messages
+  * may omit this field.
+  */
+  readonly ready?: number;
+  /**
+  * The number of queued messages scheduled for later delivery.
+  *
+  * Queue backends that cannot cheaply distinguish ready and delayed messages
+  * may omit this field.
+  */
+  readonly delayed?: number;
+}
+/**
+* An abstract interface for a message queue.
+*
+* @since 0.5.0
+*/
+interface MessageQueue {
+  /**
+  * Whether the message queue backend provides native retry mechanisms.
+  * When `true`, Fedify will skip its own retry logic and rely on the backend
+  * to handle retries. When `false` or omitted, Fedify will handle retries
+  * using its own retry policies.
+  *
+  * @default `false`
+  * @since 1.7.0
+  */
+  readonly nativeRetrial?: boolean;
+  /**
+  * Whether the message queue backend deduplicates messages that share a
+  * {@link MessageQueueEnqueueOptions.deduplicationKey} natively.  When `true`,
+  * Fedify forwards the `deduplicationKey` and relies on the backend to drop
+  * duplicates; when `false` or omitted, Fedify applies its own best-effort
+  * key–value deduplication on the paths that request it.
+  *
+  * @default `false`
+  * @since 2.4.0
+  */
+  readonly nativeDeduplication?: boolean;
+  /**
+  * Whether {@link enqueueMany} accepts either every message or no messages.
+  * Backends that implement `enqueueMany()` by sending messages individually
+  * must set this to `false`, so Fedify does not use that method for a batch
+  * governed by one `deduplicationKey`.  `true` by default when `enqueueMany`
+  * is implemented.
+  *
+  * @default `true`
+  * @since 2.4.0
+  */
+  readonly atomicEnqueueMany?: boolean;
+  /**
+  * Enqueues a message in the queue.
+  * @param message The message to enqueue.
+  * @param options Additional options for enqueuing the message.
+  */
+  enqueue(message: any, options?: MessageQueueEnqueueOptions): Promise<void>;
+  /**
+  * Enqueues multiple messages in the queue.  This operation is optional,
+  * and may not be supported by all implementations.  If not supported,
+  * Fedify will invoke {@link enqueue} for each message.  An implementation
+  * that may accept only part of a batch before rejecting must declare
+  * {@link atomicEnqueueMany} `false`.
+  *
+  * @param messages The messages to enqueue.
+  * @param options Additional options for enqueuing the messages.
+  */
+  enqueueMany?: (messages: readonly any[], options?: MessageQueueEnqueueOptions) => Promise<void>;
+  /**
+  * Listens for messages in the queue.
+  * @param handler The handler for messages in the queue.
+  * @param options Additional options for listening to the message queue.
+  * @returns A promise that resolves when the listening is done.  It never
+  *          rejects, and is resolved when the signal is aborted.  If no
+  *          signal is provided, it never resolves.
+  */
+  listen(handler: (message: any) => Promise<void> | void, options?: MessageQueueListenOptions): Promise<void>;
+  /**
+  * Gets the number of messages waiting in the queue.
+  *
+  * This operation is optional, and may not be supported by all
+  * implementations.  The returned counts exclude messages currently being
+  * handled by a worker.
+  *
+  * @since 2.3.0
+  */
+  getDepth?(): Promise<MessageQueueDepth>;
+}
+/**
+* Additional options for {@link InProcessMessageQueue}.
+* @since 1.0.0
+*/
+interface InProcessMessageQueueOptions {
+  /**
+  * The interval to poll for messages in the queue.  5 seconds by default.
+  * @default `{ seconds: 5 }`
+  */
+  pollInterval?: Temporal.Duration | Temporal.DurationLike;
+}
+/**
+* A message queue that processes messages in the same process.
+* Do not use this in production as it does neither persist messages nor
+* distribute them across multiple processes.
+*
+* @since 0.5.0
+*/
+declare class InProcessMessageQueue implements MessageQueue {
+  #private;
+  /**
+  * In-process message queue does not provide native retry mechanisms.
+  * @since 1.7.0
+  */
+  readonly nativeRetrial = false;
+  /**
+  * In-process message queue does not deduplicate messages natively.
+  * @since 2.4.0
+  */
+  readonly nativeDeduplication = false;
+  /**
+  * Constructs a new {@link InProcessMessageQueue} with the given options.
+  * @param options Additional options for the in-process message queue.
+  */
+  constructor(options?: InProcessMessageQueueOptions);
+  enqueue(message: any, options?: MessageQueueEnqueueOptions): Promise<void>;
+  enqueueMany(messages: readonly any[], options?: MessageQueueEnqueueOptions): Promise<void>;
+  listen(handler: (message: any) => Promise<void> | void, options?: MessageQueueListenOptions): Promise<void>;
+  getDepth(): Promise<MessageQueueDepth>;
+}
+/**
+* A message queue that processes messages in parallel.  It takes another
+* {@link MessageQueue}, and processes messages in parallel up to a certain
+* number of workers.
+*
+* Actually, it's rather a decorator than a queue itself.
+*
+* Note that the workers do not run in truly parallel, in the sense that they
+* are not running in separate threads or processes.  They are running in the
+* same process, but are scheduled to run in parallel.  Hence, this is useful
+* for I/O-bound tasks, but not for CPU-bound tasks, which is okay for Fedify's
+* workloads.
+*
+* When using `ParallelMessageQueue`, the ordering guarantee is preserved
+* *only if* the underlying queue implementation delivers messages in a wrapper
+* format that includes the `__fedify_ordering_key__` property.  Currently,
+* only `DenoKvMessageQueue` and `WorkersMessageQueue` use this format.
+* For other queue implementations (e.g., `InProcessMessageQueue`,
+* `RedisMessageQueue`, `PostgresMessageQueue`, `SqliteMessageQueue`,
+* `AmqpMessageQueue`), the ordering key cannot be detected by
+* `ParallelMessageQueue`, so ordering guarantees are handled by those
+* implementations directly rather than at the `ParallelMessageQueue` level.
+*
+* Messages with the same ordering key will never be processed concurrently
+* by different workers, ensuring sequential processing within each key.
+* Messages with different ordering keys (or no ordering key) can still be
+* processed in parallel.
+*
+* @since 1.0.0
+*/
+declare class ParallelMessageQueue implements MessageQueue {
+  #private;
+  readonly queue: MessageQueue;
+  readonly workers: number;
+  /**
+  * Inherits the native retry capability from the wrapped queue.
+  * @since 1.7.0
+  */
+  readonly nativeRetrial?: boolean;
+  /**
+  * Inherits the native deduplication capability from the wrapped queue.
+  * @since 2.4.0
+  */
+  readonly nativeDeduplication?: boolean;
+  /**
+  * Inherits the atomic batch capability from the wrapped queue.
+  * @since 2.4.0
+  */
+  readonly atomicEnqueueMany?: boolean;
+  readonly getDepth?: () => Promise<MessageQueueDepth>;
+  /**
+  * Constructs a new {@link ParallelMessageQueue} with the given queue and
+  * number of workers.
+  * @param queue The message queue to use under the hood.  Note that
+  *              {@link ParallelMessageQueue} cannot be nested.
+  * @param workers The number of workers to process messages in parallel.
+  * @throws {TypeError} If the given queue is an instance of
+  *                     {@link ParallelMessageQueue}.
+  */
+  constructor(queue: MessageQueue, workers: number);
+  enqueue(message: any, options?: MessageQueueEnqueueOptions): Promise<void>;
+  enqueueMany(messages: readonly any[], options?: MessageQueueEnqueueOptions): Promise<void>;
+  listen(handler: (message: any) => Promise<void> | void, options?: MessageQueueListenOptions): Promise<void>;
+}
+//#endregion
 //#region src/federation/handler.d.ts
 /**
 * Options for the {@link respondWithObject} and
@@ -3248,4 +3522,4 @@ interface ActorKeyPair extends CryptoKeyPair {
   readonly multikey: Multikey;
 }
 //#endregion
-export { CircuitBreakerCreateOptions as $, OutboxListenerSetters as A, UnverifiedActivityHandler as At, TaskEnqueueOptions as B, FederationStartQueueOptions as C, ObjectAuthorizePredicate as Ct, InboxListenerSetters as D, OutboxListenerErrorHandler as Dt, InboxChallengePolicy as E, OutboxListener as Et, createFederation as F, PageItems as Ft, RetryPolicy as G, TaskRegistry as H, Message as I, buildCollectionSynchronizationHeader as It, respondWithObject as J, createExponentialBackoffPolicy as K, createFederationBuilder as L, digest as Lt, FederationKvPrefixes as M, WebFingerLinksDispatcher as Mt, FederationOrigin as N, SendActivityError as Nt, MediaUploaderSetters as O, OutboxPermanentFailureHandler as Ot, FederationQueueOptions as P, SenderKeyPair as Pt, CircuitBreakerBeforeSendDecision as Q, TaskDefinition as R, ActivityTransformer as Rt, FederationOptions as S, NodeInfoDispatcher as St, IdempotencyStrategy as T, OutboxErrorHandler as Tt, CreateExponentialBackoffPolicyOptions as U, TaskHandler as V, RetryContext as W, CircuitBreaker as X, respondWithObjectIfAcceptable as Y, CircuitBreakerActivityDrop as Z, Federatable as _, CustomCollectionCursor as _t, GetSignedKeyOptions as a, NormalizedCircuitBreakerOptions as at, FederationBuilder as b, InboxListener as bt, ParseUriResult as c, ActorAliasMapper as ct, SendActivityOptions as d, ActorKeyPairsDispatcher as dt, CircuitBreakerFailurePolicy as et, SendActivityOptionsForCollection as f, AuthorizePredicate as ft, CustomCollectionCallbackSetters as g, CustomCollectionCounter as gt, ConstructorWithTypeId as h, CollectionDispatcher as ht, GetActorOptions as i, CircuitBreakerStateChange as it, Rfc6570Expression as j, UnverifiedActivityReason as jt, ObjectCallbackSetters as k, SharedInboxKeyDispatcher as kt, RequestContext as l, ActorDispatcher as lt, CollectionCallbackSetters as m, CollectionCursor as mt, Context as n, CircuitBreakerOptions as nt, InboxContext as o, normalizeCircuitBreakerOptions as ot, ActorCallbackSetters as p, CollectionCounter as pt, RespondWithObjectOptions as q, ForwardActivityOptions as r, CircuitBreakerState as rt, OutboxContext as s, parseCircuitBreakerKvState as st, ActorKeyPair as t, CircuitBreakerKvState as tt, RouteActivityOptions as u, ActorHandleMapper as ut, Federation as v, CustomCollectionDispatcher as vt, IdempotencyKeyCallback as w, ObjectDispatcher as wt, FederationFetchOptions as x, MediaUploaderCallback as xt, FederationBenchmarkOptions as y, InboxErrorHandler as yt, TaskDefinitionOptions as z };
+export { MessageQueueDepth as $, OutboxListenerSetters as A, ObjectAuthorizePredicate as At, TaskEnqueueOptions as B, SendActivityError as Bt, FederationStartQueueOptions as C, CustomCollectionCounter as Ct, InboxListenerSetters as D, InboxListener as Dt, InboxChallengePolicy as E, InboxErrorHandler as Et, createFederation as F, OutboxPermanentFailureHandler as Ft, RetryPolicy as G, ActivityTransformer as Gt, TaskRegistry as H, PageItems as Ht, Message as I, SharedInboxKeyDispatcher as It, respondWithObject as J, createExponentialBackoffPolicy as K, createFederationBuilder as L, UnverifiedActivityHandler as Lt, FederationKvPrefixes as M, OutboxErrorHandler as Mt, FederationOrigin as N, OutboxListener as Nt, MediaUploaderSetters as O, MediaUploaderCallback as Ot, FederationQueueOptions as P, OutboxListenerErrorHandler as Pt, MessageQueue as Q, TaskDefinition as R, UnverifiedActivityReason as Rt, FederationOptions as S, CollectionDispatcher as St, IdempotencyStrategy as T, CustomCollectionDispatcher as Tt, CreateExponentialBackoffPolicyOptions as U, buildCollectionSynchronizationHeader as Ut, TaskHandler as V, SenderKeyPair as Vt, RetryContext as W, digest as Wt, InProcessMessageQueue as X, respondWithObjectIfAcceptable as Y, InProcessMessageQueueOptions as Z, Federatable as _, ActorHandleMapper as _t, GetSignedKeyOptions as a, CircuitBreakerBeforeSendDecision as at, FederationBuilder as b, CollectionCounter as bt, ParseUriResult as c, CircuitBreakerKvState as ct, SendActivityOptions as d, CircuitBreakerStateChange as dt, MessageQueueEnqueueOptions as et, SendActivityOptionsForCollection as f, NormalizedCircuitBreakerOptions as ft, CustomCollectionCallbackSetters as g, ActorDispatcher as gt, ConstructorWithTypeId as h, ActorAliasMapper as ht, GetActorOptions as i, CircuitBreakerActivityDrop as it, Rfc6570Expression as j, ObjectDispatcher as jt, ObjectCallbackSetters as k, NodeInfoDispatcher as kt, RequestContext as l, CircuitBreakerOptions as lt, CollectionCallbackSetters as m, parseCircuitBreakerKvState as mt, Context as n, ParallelMessageQueue as nt, InboxContext as o, CircuitBreakerCreateOptions as ot, ActorCallbackSetters as p, normalizeCircuitBreakerOptions as pt, RespondWithObjectOptions as q, ForwardActivityOptions as r, CircuitBreaker as rt, OutboxContext as s, CircuitBreakerFailurePolicy as st, ActorKeyPair as t, MessageQueueListenOptions as tt, RouteActivityOptions as u, CircuitBreakerState as ut, Federation as v, ActorKeyPairsDispatcher as vt, IdempotencyKeyCallback as w, CustomCollectionCursor as wt, FederationFetchOptions as x, CollectionCursor as xt, FederationBenchmarkOptions as y, AuthorizePredicate as yt, TaskDefinitionOptions as z, WebFingerLinksDispatcher as zt };