@fedify/fedify 2.4.0-pr.936.41 → 2.5.0-dev.2271

package/dist/metrics-CoUJLQhZ.d.cts

@@ -1,276 +0,0 @@
-/// <reference lib="esnext.temporal" />
-import { DocumentLoader } from "@fedify/vocab-runtime";
-import { MeterProvider } from "@opentelemetry/api";
-
-//#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;
-  /**
-  * 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.
-  *
-  * @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;
-  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/metrics.d.ts
-/**
-* The kind of remote ActivityPub lookup, recorded as
-* `activitypub.lookup.kind` on the public-key lookup and remote document
-* fetch metric families.
-*
-*  -  `public_key`: a public key lookup performed by `fetchKey` /
-*     `fetchKeyDetailed` (always recorded on `activitypub.key.lookup*`).
-*  -  `actor`: a document fetch whose resolved value is an Actor.  The
-*     bucket exists in the taxonomy for future actor-aware call sites;
-*     today, actor documents fetched through Fedify's generic document
-*     loader are still classified as `object` because the kind is decided
-*     at the loader boundary, before the response is parsed.
-*  -  `object`: a generic ActivityPub object fetch through Fedify's
-*     document loader.  This is the default classification for
-*     `documentLoader` invocations that do not match a more specific
-*     bucket.
-*  -  `context`: a JSON-LD `@context` document fetch through Fedify's
-*     context loader.
-*  -  `other`: a fetch that does not fit any of the above classifications.
-* @since 2.3.0
-*/
-type LookupKind = "public_key" | "actor" | "object" | "context" | "other";
-/**
-* The {@link LookupKind} values that can appear on remote document fetch
-* metrics.  `public_key` lookups are reported on the
-* `activitypub.key.lookup` metric family instead, so it is excluded here.
-* @since 2.3.0
-*/
-type DocumentFetchKind = Exclude<LookupKind, "public_key">;
-//#endregion
-export { MessageQueueDepth as a, ParallelMessageQueue as c, MessageQueue as i, InProcessMessageQueue as n, MessageQueueEnqueueOptions as o, InProcessMessageQueueOptions as r, MessageQueueListenOptions as s, DocumentFetchKind as t };

package/dist/metrics-Dc4jR-IC.d.ts

@@ -1,276 +0,0 @@
-/// <reference lib="esnext.temporal" />
-import { MeterProvider } from "@opentelemetry/api";
-import { DocumentLoader } from "@fedify/vocab-runtime";
-
-//#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;
-  /**
-  * 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.
-  *
-  * @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;
-  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/metrics.d.ts
-/**
-* The kind of remote ActivityPub lookup, recorded as
-* `activitypub.lookup.kind` on the public-key lookup and remote document
-* fetch metric families.
-*
-*  -  `public_key`: a public key lookup performed by `fetchKey` /
-*     `fetchKeyDetailed` (always recorded on `activitypub.key.lookup*`).
-*  -  `actor`: a document fetch whose resolved value is an Actor.  The
-*     bucket exists in the taxonomy for future actor-aware call sites;
-*     today, actor documents fetched through Fedify's generic document
-*     loader are still classified as `object` because the kind is decided
-*     at the loader boundary, before the response is parsed.
-*  -  `object`: a generic ActivityPub object fetch through Fedify's
-*     document loader.  This is the default classification for
-*     `documentLoader` invocations that do not match a more specific
-*     bucket.
-*  -  `context`: a JSON-LD `@context` document fetch through Fedify's
-*     context loader.
-*  -  `other`: a fetch that does not fit any of the above classifications.
-* @since 2.3.0
-*/
-type LookupKind = "public_key" | "actor" | "object" | "context" | "other";
-/**
-* The {@link LookupKind} values that can appear on remote document fetch
-* metrics.  `public_key` lookups are reported on the
-* `activitypub.key.lookup` metric family instead, so it is excluded here.
-* @since 2.3.0
-*/
-type DocumentFetchKind = Exclude<LookupKind, "public_key">;
-//#endregion
-export { MessageQueueDepth as a, ParallelMessageQueue as c, MessageQueue as i, InProcessMessageQueue as n, MessageQueueEnqueueOptions as o, InProcessMessageQueueOptions as r, MessageQueueListenOptions as s, DocumentFetchKind as t };