@fedify/fedify 2.0.0-dev.1690 → 2.0.0-dev.170

package/dist/mod-DlU8ISoa.d.ts

@@ -1,309 +0,0 @@
-import { Temporal } from "@js-temporal/polyfill";
-import { URLPattern } from "urlpattern-polyfill";
-import { DocumentLoader, GetUserAgentOptions } from "./docloader-CxWcuWqQ.js";
-import { Collection, Link, Object as Object$1 } from "./vocab-BI0Ak5lL.js";
-import { TracerProvider } from "@opentelemetry/api";
-
-//#region src/vocab/lookup.d.ts
-/**
- * Options for the {@link lookupObject} function.
- *
- * @since 0.2.0
- */
-interface LookupObjectOptions {
-  /**
-   * The document loader for loading remote JSON-LD documents.
-   */
-  documentLoader?: DocumentLoader;
-  /**
-   * The context loader for loading remote JSON-LD contexts.
-   * @since 0.8.0
-   */
-  contextLoader?: DocumentLoader;
-  /**
-   * Whether to allow fetching an object with an `@id` having a different
-   * origin than the object's URL.  This is not recommended, as it may
-   * lead to security issues.  Only use this option if you know what you
-   * are doing.
-   *
-   * How to handle the case when an object's `@id` has a different origin
-   * than the object's URL:
-   *
-   *  -  `"ignore"` (default): Do not return the object, and log a warning.
-   *  -  `"throw"`: Throw an error.
-   *  -  `"trust"`: Bypass the check and return the object anyway.  This
-   *     is not recommended, as it may lead to security issues.  Only use
-   *     this option if you know what you are doing.
-   *
-   * @since 1.9.0
-   */
-  crossOrigin?: "ignore" | "throw" | "trust";
-  /**
-   * The options for making `User-Agent` header.
-   * If a string is given, it is used as the `User-Agent` header value.
-   * If an object is given, it is passed to {@link getUserAgent} to generate
-   * the `User-Agent` header value.
-   * @since 1.3.0
-   */
-  userAgent?: GetUserAgentOptions | string;
-  /**
-   * The OpenTelemetry tracer provider.  If omitted, the global tracer provider
-   * is used.
-   * @since 1.3.0
-   */
-  tracerProvider?: TracerProvider;
-  /**
-   * AbortSignal for cancelling the request.
-   * @since 1.8.0
-   */
-  signal?: AbortSignal;
-}
-/**
- * Looks up an ActivityStreams object by its URI (including `acct:` URIs)
- * or a fediverse handle (e.g., `@user@server` or `user@server`).
- *
- * @example
- * ``` typescript
- * // Look up an actor by its fediverse handle:
- * await lookupObject("@hongminhee@fosstodon.org");
- * // returning a `Person` object.
- *
- * // A fediverse handle can omit the leading '@':
- * await lookupObject("hongminhee@fosstodon.org");
- * // returning a `Person` object.
- *
- * // A `acct:` URI can be used as well:
- * await lookupObject("acct:hongminhee@fosstodon.org");
- * // returning a `Person` object.
- *
- * // Look up an object by its URI:
- * await lookupObject("https://todon.eu/@hongminhee/112060633798771581");
- * // returning a `Note` object.
- *
- * // It can be a `URL` object as well:
- * await lookupObject(new URL("https://todon.eu/@hongminhee/112060633798771581"));
- * // returning a `Note` object.
- * ```
- *
- * @param identifier The URI or fediverse handle to look up.
- * @param options Lookup options.
- * @returns The object, or `null` if not found.
- * @since 0.2.0
- */
-declare function lookupObject(identifier: string | URL, options?: LookupObjectOptions): Promise<Object$1 | null>;
-/**
- * Options for the {@link traverseCollection} function.
- * @since 1.1.0
- */
-interface TraverseCollectionOptions {
-  /**
-   * The document loader for loading remote JSON-LD documents.
-   */
-  documentLoader?: DocumentLoader;
-  /**
-   * The context loader for loading remote JSON-LD contexts.
-   */
-  contextLoader?: DocumentLoader;
-  /**
-   * Whether to suppress errors when fetching pages.  If `true`,
-   * errors will be logged but not thrown.  Defaults to `false`.
-   */
-  suppressError?: boolean;
-  /**
-   * The interval to wait between fetching pages.  Zero or negative
-   * values will disable the interval.  Disabled by default.
-   *
-   * @default `{ seconds: 0 }`
-   */
-  interval?: Temporal.Duration | Temporal.DurationLike;
-}
-/**
- * Traverses a collection, yielding each item in the collection.
- * If the collection is paginated, it will fetch the next page
- * automatically.
- *
- * @example
- * ``` typescript
- * const collection = await lookupObject(collectionUrl);
- * if (collection instanceof Collection) {
- *   for await (const item of traverseCollection(collection)) {
- *     console.log(item.id?.href);
- *   }
- * }
- * ```
- *
- * @param collection The collection to traverse.
- * @param options Options for traversing the collection.
- * @returns An async iterable of each item in the collection.
- * @since 1.1.0
- */
-declare function traverseCollection(collection: Collection, options?: TraverseCollectionOptions): AsyncIterable<Object$1 | Link>;
-//#endregion
-//#region src/vocab/constants.d.ts
-/**
- * The special public collection for [public addressing].  *Do not mutate this
- * object.*
- *
- * [public addressing]: https://www.w3.org/TR/activitypub/#public-addressing
- *
- * @since 0.7.0
- */
-declare const PUBLIC_COLLECTION: URL;
-//#endregion
-//#region src/vocab/handle.d.ts
-/**
- * Represents a fediverse handle, which consists of a username and a host.
- * The username can be alphanumeric and may include special characters,
- * while the host is typically a domain name.
- * @since 1.8.0
- */
-interface FediverseHandle {
-  /**
-   * The username part of the fediverse handle.
-   * It can include alphanumeric characters and some special characters.
-   */
-  readonly username: string;
-  /**
-   * The host part of the fediverse handle, typically a domain name.
-   * It is the part after the `@` symbol in the handle.
-   */
-  readonly host: string;
-}
-/**
- * Parses a fediverse handle in the format `@user@server` or `user@server`.
- * The `user` part can contain alphanumeric characters and some special
- * characters except `@`.  The `server` part is all characters after the `@`
- * symbol in the middle.
- *
- * @example
- * ```typescript
- * const handle = parseFediverseHandle("@username@example.com");
- * console.log(handle?.username); // "username"
- * console.log(handle?.host);     // "example.com"
- * ```
- *
- * @param handle - The fediverse handle string to parse.
- * @returns A {@link FediverseHandle} object with `username` and `host`
- *          if the input is valid; otherwise `null`.
- * @since 1.8.0
- */
-declare function parseFediverseHandle(handle: string): FediverseHandle | null;
-/**
- * Checks if a string is a valid fediverse handle in the format `@user@server`
- * or `user@server`.  The `user` part can contain alphanumeric characters and
- * some special characters except `@`.  The `server` part is all characters
- * after the `@` symbol in the middle.
- *
- * @example
- * ```typescript
- * console.log(isFediverseHandle("@username@example.com")); // true
- * console.log(isFediverseHandle("username@example.com"));  // true
- * console.log(isFediverseHandle("@username@"));            // false
- * ```
- *
- * @param handle - The string to test as a fediverse handle.
- * @returns `true` if the string matches the fediverse handle pattern;
- *          otherwise `false`.
- * @since 1.8.0
- */
-declare function isFediverseHandle(handle: string): handle is `${string}@${string}`;
-/**
- * Converts a fediverse handle in the format `@user@server` or `user@server`
- * to an `acct:` URI, which is a URL-like identifier for ActivityPub actors.
- *
- * @example
- * ```typescript
- * const identifier = toAcctUrl("@username@example.com");
- * console.log(identifier?.href); // "acct:username@example.com"
- * ```
- *
- * @param handle - The fediverse handle string to convert.
- * @returns A `URL` object representing the `acct:` URI if conversion succeeds;
- *          otherwise `null`.
- * @since 1.8.0
- */
-declare function toAcctUrl(handle: string): URL | null;
-//#endregion
-//#region src/vocab/type.d.ts
-/**
- * Returns the type URI of the given object.
- *
- * @example
- * ``` typescript
- * import { getTypeId, Person } from "@fedify/fedify";
- *
- * const obj = new Person({});
- * console.log(getTypeId(obj));
- * // => new URL("https://www.w3.org/ns/activitystreams#Person")
- * ```
- *
- * @param object The Activity Vocabulary object.
- * @returns The type URI of the object, e.g.,
- *          `new URL("https://www.w3.org/ns/activitystreams#Person")`.
- *          If the given `object` is `null` or `undefined`, returns `null` or
- *          `undefined`, respectively.
- * @since 1.3.0
- */
-declare function getTypeId(object: Object$1 | Link): URL;
-/**
- * Returns the type URI of the given object.
- *
- * @example
- * ``` typescript
- * import { getTypeId, Person } from "@fedify/fedify";
- *
- * const obj = new Person({});
- * console.log(getTypeId(obj));
- * // => new URL("https://www.w3.org/ns/activitystreams#Person")
- * ```
- *
- * @param object The Activity Vocabulary object.
- * @returns The type URI of the object, e.g.,
- *          `new URL("https://www.w3.org/ns/activitystreams#Person")`.
- *          If the given `object` is `null` or `undefined`, returns `null` or
- *          `undefined`, respectively.
- * @since 1.3.0
- */
-declare function getTypeId(object: Object$1 | Link | undefined): URL | undefined;
-/**
- * Returns the type URI of the given object.
- *
- * @example
- * ``` typescript
- * import { getTypeId, Person } from "@fedify/fedify";
- *
- * const obj = new Person({});
- * console.log(getTypeId(obj));
- * // => new URL("https://www.w3.org/ns/activitystreams#Person")
- * ```
- *
- * @param object The Activity Vocabulary object.
- * @returns The type URI of the object, e.g.,
- *          `new URL("https://www.w3.org/ns/activitystreams#Person")`.
- *          If the given `object` is `null` or `undefined`, returns `null` or
- *          `undefined`, respectively.
- * @since 1.3.0
- */
-declare function getTypeId(object: Object$1 | Link | null): URL | null;
-/**
- * Returns the type URI of the given object.
- *
- * @example
- * ``` typescript
- * import { getTypeId, Person } from "@fedify/fedify";
- *
- * const obj = new Person({});
- * console.log(getTypeId(obj));
- * // => new URL("https://www.w3.org/ns/activitystreams#Person")
- * ```
- *
- * @param object The Activity Vocabulary object.
- * @returns The type URI of the object, e.g.,
- *          `new URL("https://www.w3.org/ns/activitystreams#Person")`.
- *          If the given `object` is `null` or `undefined`, returns `null` or
- *          `undefined`, respectively.
- * @since 1.3.0
- */
-declare function getTypeId(object: Object$1 | Link | null | undefined): URL | null | undefined;
-//#endregion
-export { FediverseHandle, LookupObjectOptions, PUBLIC_COLLECTION, TraverseCollectionOptions, getTypeId, isFediverseHandle, lookupObject, parseFediverseHandle, toAcctUrl, traverseCollection };

package/dist/mod-FZd39qVq.d.cts

@@ -1 +0,0 @@
-export { };

package/dist/mod-g0xFzAP9.d.ts

@@ -1,2 +0,0 @@
-import { Temporal } from "@js-temporal/polyfill";
-import { URLPattern } from "urlpattern-polyfill";

package/dist/mod-jQ4OODsl.d.cts

@@ -1,113 +0,0 @@
-import { GetUserAgentOptions } from "./docloader-D-MrRyHl.cjs";
-import { TracerProvider } from "@opentelemetry/api";
-
-//#region src/webfinger/jrd.d.ts
-/**
- * Describes a resource.  See also
- * [RFC 7033 section 4.4](https://datatracker.ietf.org/doc/html/rfc7033#section-4.4).
- */
-interface ResourceDescriptor {
-  /**
-   * A URI that identifies the entity that this descriptor describes.
-   */
-  subject?: string;
-  /**
-   * URIs that identify the same entity as the `subject`.
-   */
-  aliases?: string[];
-  /**
-   * Conveys additional information about the `subject` of this descriptor.
-   */
-  properties?: Record<string, string>;
-  /**
-   * Links to other resources.
-   */
-  links?: Link[];
-}
-/**
- * Represents a link.  See also
- * [RFC 7033 section 4.4.4](https://datatracker.ietf.org/doc/html/rfc7033#section-4.4.4).
- */
-interface Link {
-  /**
-   * The link's relation type, which is either a URI or a registered relation
-   * type (see [RFC 5988](https://datatracker.ietf.org/doc/html/rfc5988)).
-   */
-  rel: string;
-  /**
-   * The media type of the target resource (see
-   * [RFC 6838](https://datatracker.ietf.org/doc/html/rfc6838)).
-   */
-  type?: string;
-  /**
-   * A URI pointing to the target resource.
-   */
-  href?: string;
-  /**
-   * Human-readable titles describing the link relation.  If the language is
-   * unknown or unspecified, the key is `"und"`.
-   */
-  titles?: Record<string, string>;
-  /**
-   * Conveys additional information about the link relation.
-   */
-  properties?: Record<string, string>;
-  /**
-   * A URI Template (RFC 6570) that can be used to construct URIs by
-   * substituting variables. Used primarily for subscription endpoints
-   * where parameters like account URIs need to be dynamically inserted.
-   * @since 1.9.0
-   */
-  template?: string;
-}
-//#endregion
-//#region src/webfinger/lookup.d.ts
-/**
- * Options for {@link lookupWebFinger}.
- * @since 1.3.0
- */
-interface LookupWebFingerOptions {
-  /**
-   * The options for making `User-Agent` header.
-   * If a string is given, it is used as the `User-Agent` header value.
-   * If an object is given, it is passed to {@link getUserAgent} to generate
-   * the `User-Agent` header value.
-   */
-  userAgent?: GetUserAgentOptions | string;
-  /**
-   * Whether to allow private IP addresses in the URL.
-   *
-   * Mostly useful for testing purposes.  *Do not use this in production.*
-   *
-   * Turned off by default.
-   * @since 1.4.0
-   */
-  allowPrivateAddress?: boolean;
-  /**
-   * The maximum number of redirections to follow.
-   * @default `5`
-   * @since 1.8.0
-   */
-  maxRedirection?: number;
-  /**
-   * The OpenTelemetry tracer provider.  If omitted, the global tracer provider
-   * is used.
-   */
-  tracerProvider?: TracerProvider;
-  /**
-   * AbortSignal for cancelling the request.
-   * @since 1.8.0
-   * @
-   */
-  signal?: AbortSignal;
-}
-/**
- * Looks up a WebFinger resource.
- * @param resource The resource URL to look up.
- * @param options Extra options for looking up the resource.
- * @returns The resource descriptor, or `null` if not found.
- * @since 0.2.0
- */
-declare function lookupWebFinger(resource: URL | string, options?: LookupWebFingerOptions): Promise<ResourceDescriptor | null>;
-//#endregion
-export { Link, LookupWebFingerOptions, ResourceDescriptor, lookupWebFinger };

package/dist/mq-B7R1Q-M5.d.cts

@@ -1,140 +0,0 @@
-//#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.
-   */
-  delay?: Temporal.Duration;
-}
-/**
- * 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;
-}
-/**
- * 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;
-  /**
-   * 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: 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>;
-}
-/**
- * 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;
-  /**
-   * 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: any[], options?: MessageQueueEnqueueOptions): Promise<void>;
-  listen(handler: (message: any) => Promise<void> | void, options?: MessageQueueListenOptions): Promise<void>;
-}
-/**
- * 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.
- *
- * @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;
-  /**
-   * 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: any[], options?: MessageQueueEnqueueOptions): Promise<void>;
-  listen(handler: (message: any) => Promise<void> | void, options?: MessageQueueListenOptions): Promise<void>;
-}
-//#endregion
-export { InProcessMessageQueue, InProcessMessageQueueOptions, MessageQueue, MessageQueueEnqueueOptions, MessageQueueListenOptions, ParallelMessageQueue };