@fedify/testing 2.0.0-dev.1561 → 2.0.0-dev.158

package/dist/mod.d.cts

@@ -0,0 +1,126 @@
+import { Context, Federation, InboxContext, RequestContext } from "@fedify/fedify/federation";
+import { Activity } from "@fedify/vocab";
+
+//#region src/context.d.ts
+declare function createContext<TContextData>(values: Partial<Context<TContextData>> & {
+  url?: URL;
+  data: TContextData;
+  federation: Federation<TContextData>;
+}): Context<TContextData>;
+/**
+ * Creates a RequestContext for testing purposes.
+ * Not exported - used internally only. Public API is in mock.ts
+ * @param args Partial RequestContext properties
+ * @returns A RequestContext instance
+ * @since 1.8.0
+ */
+declare function createRequestContext<TContextData>(args: Partial<RequestContext<TContextData>> & {
+  url: URL;
+  data: TContextData;
+  federation: Federation<TContextData>;
+}): RequestContext<TContextData>;
+/**
+ * Test-specific InboxContext type alias.
+ * This indirection helps avoid JSR type analyzer issues.
+ * @since 1.9.1
+ */
+type TestInboxContext<TContextData> = InboxContext<TContextData>;
+/**
+ * Creates an InboxContext for testing purposes.
+ * Not exported - used internally only. Public API is in mock.ts
+ * @param args Partial InboxContext properties
+ * @returns An InboxContext instance
+ * @since 1.8.0
+ */
+declare function createInboxContext<TContextData>(args: Partial<InboxContext<TContextData>> & {
+  url?: URL;
+  data: TContextData;
+  recipient?: string | null;
+  federation: Federation<TContextData>;
+}): TestInboxContext<TContextData>;
+//#endregion
+//#region src/mock.d.ts
+/**
+ * Represents a sent activity with metadata about how it was sent.
+ * @since 1.8.0
+ */
+interface SentActivity {
+  /** Whether the activity was queued or sent immediately. */
+  queued: boolean;
+  /** Which queue was used (if queued). */
+  queue?: "inbox" | "outbox" | "fanout";
+  /** The activity that was sent. */
+  activity: Activity;
+  /** The order in which the activity was sent (auto-incrementing counter). */
+  sentOrder: number;
+}
+/**
+ * A mock Context interface for testing purposes.
+ * Extends the standard Context interface with additional testing utilities.
+ * @since 1.9.1
+ */
+interface TestContext<TContextData> extends Omit<Context<TContextData>, "clone">, Pick<RequestContext<TContextData>, "request" | "url" | "getActor" | "getObject" | "getSignedKey" | "getSignedKeyOwner" | "sendActivity" | "routeActivity"> {
+  clone(data: TContextData): TestContext<TContextData>;
+  getSentActivities(): Array<{
+    sender: any;
+    recipients: any;
+    activity: Activity;
+  }>;
+  reset(): void;
+}
+/**
+ * A mock Federation interface for testing purposes.
+ * Extends the standard Federation interface with additional testing utilities.
+ * @since 1.9.1
+ */
+interface TestFederation<TContextData> extends Omit<Federation<TContextData>, "createContext"> {
+  sentActivities: SentActivity[];
+  queueStarted: boolean;
+  sentCounter: number;
+  receiveActivity(activity: Activity): Promise<void>;
+  reset(): void;
+  createContext(baseUrlOrRequest: URL | Request, contextData: TContextData): TestContext<TContextData>;
+}
+/**
+ * Creates a mock Federation instance for testing purposes.
+ *
+ * @template TContextData The type of context data to use
+ * @param options Optional configuration for the mock federation
+ * @returns A Federation instance that can be used for testing
+ * @since 1.9.1
+ *
+ * @example
+ * ```typescript
+ * import { Create } from "@fedify/vocab";
+ * import { createFederation } from "@fedify/testing";
+ *
+ * // Create a mock federation with contextData
+ * const federation = createFederation<{ userId: string }>({
+ *   contextData: { userId: "test-user" }
+ * });
+ *
+ * // Set up inbox listeners
+ * federation
+ *   .setInboxListeners("/users/{identifier}/inbox")
+ *   .on(Create, async (ctx, activity) => {
+ *     console.log("Received:", activity);
+ *   });
+ *
+ * // Simulate receiving an activity
+ * const createActivity = new Create({
+ *   id: new URL("https://example.com/create/1"),
+ *   actor: new URL("https://example.com/users/alice")
+ * });
+ * await federation.receiveActivity(createActivity);
+ *
+ * // Check sent activities
+ * console.log(federation.sentActivities);
+ * ```
+ */
+declare function createFederation<TContextData>(options?: {
+  contextData?: TContextData;
+  origin?: string;
+  tracerProvider?: any;
+}): TestFederation<TContextData>;
+//#endregion
+export { createContext, createFederation, createInboxContext, createRequestContext };

package/dist/mod.d.ts

@@ -1,12 +1,45 @@
-import { TracerProvider } from "@opentelemetry/api";
-import { ActorCallbackSetters, ActorDispatcher, ActorKeyPair, CollectionCallbackSetters, CollectionDispatcher, Context, Federation, FederationFetchOptions, FederationStartQueueOptions, InboxContext, InboxListenerSetters, Message, NodeInfoDispatcher, ObjectCallbackSetters, ObjectDispatcher, ParseUriResult, RequestContext, RouteActivityOptions, SendActivityOptions, SendActivityOptionsForCollection, SenderKeyPair, WebFingerLinksDispatcher } from "@fedify/fedify/federation";
-import { Activity, Actor, Collection, Hashtag, LookupObjectOptions, Object as Object$1, Recipient, TraverseCollectionOptions } from "@fedify/fedify/vocab";
-import { ResourceDescriptor } from "@fedify/fedify/webfinger";
-import { JsonValue, NodeInfo } from "@fedify/fedify/nodeinfo";
-import { DocumentLoader } from "@fedify/fedify/runtime";
+import { Context, Federation, InboxContext, RequestContext } from "@fedify/fedify/federation";
+import { Activity } from "@fedify/vocab";
 
+//#region src/context.d.ts
+declare function createContext<TContextData>(values: Partial<Context<TContextData>> & {
+  url?: URL;
+  data: TContextData;
+  federation: Federation<TContextData>;
+}): Context<TContextData>;
+/**
+ * Creates a RequestContext for testing purposes.
+ * Not exported - used internally only. Public API is in mock.ts
+ * @param args Partial RequestContext properties
+ * @returns A RequestContext instance
+ * @since 1.8.0
+ */
+declare function createRequestContext<TContextData>(args: Partial<RequestContext<TContextData>> & {
+  url: URL;
+  data: TContextData;
+  federation: Federation<TContextData>;
+}): RequestContext<TContextData>;
+/**
+ * Test-specific InboxContext type alias.
+ * This indirection helps avoid JSR type analyzer issues.
+ * @since 1.9.1
+ */
+type TestInboxContext<TContextData> = InboxContext<TContextData>;
+/**
+ * Creates an InboxContext for testing purposes.
+ * Not exported - used internally only. Public API is in mock.ts
+ * @param args Partial InboxContext properties
+ * @returns An InboxContext instance
+ * @since 1.8.0
+ */
+declare function createInboxContext<TContextData>(args: Partial<InboxContext<TContextData>> & {
+  url?: URL;
+  data: TContextData;
+  recipient?: string | null;
+  federation: Federation<TContextData>;
+}): TestInboxContext<TContextData>;
+//#endregion
 //#region src/mock.d.ts
-
 /**
  * Represents a sent activity with metadata about how it was sent.
  * @since 1.8.0
@@ -22,17 +55,47 @@ interface SentActivity {
   sentOrder: number;
 }
 /**
- * A mock implementation of the {@link Federation} interface for unit testing.
- * This class provides a way to test Fedify applications without needing
- * a real federation setup.
+ * A mock Context interface for testing purposes.
+ * Extends the standard Context interface with additional testing utilities.
+ * @since 1.9.1
+ */
+interface TestContext<TContextData> extends Omit<Context<TContextData>, "clone">, Pick<RequestContext<TContextData>, "request" | "url" | "getActor" | "getObject" | "getSignedKey" | "getSignedKeyOwner" | "sendActivity" | "routeActivity"> {
+  clone(data: TContextData): TestContext<TContextData>;
+  getSentActivities(): Array<{
+    sender: any;
+    recipients: any;
+    activity: Activity;
+  }>;
+  reset(): void;
+}
+/**
+ * A mock Federation interface for testing purposes.
+ * Extends the standard Federation interface with additional testing utilities.
+ * @since 1.9.1
+ */
+interface TestFederation<TContextData> extends Omit<Federation<TContextData>, "createContext"> {
+  sentActivities: SentActivity[];
+  queueStarted: boolean;
+  sentCounter: number;
+  receiveActivity(activity: Activity): Promise<void>;
+  reset(): void;
+  createContext(baseUrlOrRequest: URL | Request, contextData: TContextData): TestContext<TContextData>;
+}
+/**
+ * Creates a mock Federation instance for testing purposes.
+ *
+ * @template TContextData The type of context data to use
+ * @param options Optional configuration for the mock federation
+ * @returns A Federation instance that can be used for testing
+ * @since 1.9.1
  *
  * @example
  * ```typescript
- * import { Create } from "@fedify/fedify/vocab";
- * import { MockFederation } from "@fedify/testing";
+ * import { Create } from "@fedify/vocab";
+ * import { createFederation } from "@fedify/testing";
  *
  * // Create a mock federation with contextData
- * const federation = new MockFederation<{ userId: string }>({
+ * const federation = createFederation<{ userId: string }>({
  *   contextData: { userId: "test-user" }
  * });
  *
@@ -49,249 +112,15 @@ interface SentActivity {
  *   actor: new URL("https://example.com/users/alice")
  * });
  * await federation.receiveActivity(createActivity);
- * ```
- *
- * @template TContextData The context data to pass to the {@link Context}.
- * @since 1.8.0
- */
-declare class MockFederation<TContextData> implements Federation<TContextData> {
-  private options;
-  sentActivities: SentActivity[];
-  queueStarted: boolean;
-  private activeQueues;
-  sentCounter: number;
-  private nodeInfoDispatcher?;
-  private webFingerDispatcher?;
-  private actorDispatchers;
-  actorPath?: string;
-  inboxPath?: string;
-  outboxPath?: string;
-  followingPath?: string;
-  followersPath?: string;
-  likedPath?: string;
-  featuredPath?: string;
-  featuredTagsPath?: string;
-  nodeInfoPath?: string;
-  sharedInboxPath?: string;
-  objectPaths: Map<string, string>;
-  private objectDispatchers;
-  private inboxDispatcher?;
-  private outboxDispatcher?;
-  private followingDispatcher?;
-  private followersDispatcher?;
-  private likedDispatcher?;
-  private featuredDispatcher?;
-  private featuredTagsDispatcher?;
-  private inboxListeners;
-  private contextData?;
-  private receivedActivities;
-  constructor(options?: {
-    contextData?: TContextData;
-    origin?: string;
-    tracerProvider?: TracerProvider;
-  });
-  setNodeInfoDispatcher(path: string, dispatcher: NodeInfoDispatcher<TContextData>): void;
-  setWebFingerLinksDispatcher(dispatcher: WebFingerLinksDispatcher<TContextData>): void;
-  setActorDispatcher(path: `${string}{identifier}${string}` | `${string}{handle}${string}`, dispatcher: ActorDispatcher<TContextData>): ActorCallbackSetters<TContextData>;
-  setObjectDispatcher<TObject extends Object$1, TParam extends string>(cls: (new (...args: any[]) => TObject) & {
-    typeId: URL;
-  }, path: string, dispatcher: ObjectDispatcher<TContextData, TObject, TParam>): ObjectCallbackSetters<TContextData, TObject, TParam>;
-  setInboxDispatcher(_path: `${string}{identifier}${string}` | `${string}{handle}${string}`, dispatcher: CollectionDispatcher<Activity, RequestContext<TContextData>, TContextData, void>): CollectionCallbackSetters<RequestContext<TContextData>, TContextData, void>;
-  setOutboxDispatcher(path: `${string}{identifier}${string}` | `${string}{handle}${string}`, dispatcher: CollectionDispatcher<Activity, RequestContext<TContextData>, TContextData, void>): CollectionCallbackSetters<RequestContext<TContextData>, TContextData, void>;
-  setFollowingDispatcher(path: `${string}{identifier}${string}` | `${string}{handle}${string}`, dispatcher: CollectionDispatcher<Actor | URL, RequestContext<TContextData>, TContextData, void>): CollectionCallbackSetters<RequestContext<TContextData>, TContextData, void>;
-  setFollowersDispatcher(path: `${string}{identifier}${string}` | `${string}{handle}${string}`, dispatcher: CollectionDispatcher<Recipient, Context<TContextData>, TContextData, URL>): CollectionCallbackSetters<Context<TContextData>, TContextData, URL>;
-  setLikedDispatcher(path: `${string}{identifier}${string}` | `${string}{handle}${string}`, dispatcher: CollectionDispatcher<Object$1 | URL, RequestContext<TContextData>, TContextData, void>): CollectionCallbackSetters<RequestContext<TContextData>, TContextData, void>;
-  setFeaturedDispatcher(path: `${string}{identifier}${string}` | `${string}{handle}${string}`, dispatcher: CollectionDispatcher<Object$1, RequestContext<TContextData>, TContextData, void>): CollectionCallbackSetters<RequestContext<TContextData>, TContextData, void>;
-  setFeaturedTagsDispatcher(path: `${string}{identifier}${string}` | `${string}{handle}${string}`, dispatcher: CollectionDispatcher<Hashtag, RequestContext<TContextData>, TContextData, void>): CollectionCallbackSetters<RequestContext<TContextData>, TContextData, void>;
-  setInboxListeners(inboxPath: `${string}{identifier}${string}` | `${string}{handle}${string}`, sharedInboxPath?: string): InboxListenerSetters<TContextData>;
-  startQueue(contextData: TContextData, options?: FederationStartQueueOptions): Promise<void>;
-  processQueuedTask(contextData: TContextData, _message: Message): Promise<void>;
-  createContext(baseUrl: URL, contextData: TContextData): Context<TContextData>;
-  createContext(request: Request, contextData: TContextData): RequestContext<TContextData>;
-  fetch(request: Request, options: FederationFetchOptions<TContextData>): Promise<Response>;
-  /**
-   * Simulates receiving an activity. This method is specific to the mock
-   * implementation and is used for testing purposes.
-   *
-   * @param activity The activity to receive.
-   * @returns A promise that resolves when the activity has been processed.
-   * @since 1.8.0
-   */
-  receiveActivity(activity: Activity): Promise<void>;
-  /**
-   * Clears all sent activities from the mock federation.
-   * This method is specific to the mock implementation and is used for
-   * testing purposes.
-   *
-   * @since 1.8.0
-   */
-  reset(): void;
-  setCollectionDispatcher<TObject extends Object$1, TParams extends Record<string, string>>(_name: string | symbol, _itemType: any, _path: any, _dispatcher: any): any;
-  setOrderedCollectionDispatcher<TObject extends Object$1, TParams extends Record<string, string>>(_name: string | symbol, _itemType: any, _path: any, _dispatcher: any): any;
-}
-/**
- * A mock implementation of the {@link Context} interface for unit testing.
- * This class provides a way to test Fedify applications without needing
- * a real federation context.
- *
- * @example
- * ```typescript
- * import { Person, Create } from "@fedify/fedify/vocab";
- * import { MockContext, MockFederation } from "@fedify/testing";
- *
- * // Create a mock context
- * const mockFederation = new MockFederation<{ userId: string }>();
- * const context = new MockContext({
- *   url: new URL("https://example.com"),
- *   data: { userId: "test-user" },
- *   federation: mockFederation
- * });
- *
- * // Send an activity
- * const recipient = new Person({ id: new URL("https://example.com/users/bob") });
- * const activity = new Create({
- *   id: new URL("https://example.com/create/1"),
- *   actor: new URL("https://example.com/users/alice")
- * });
- * await context.sendActivity(
- *   { identifier: "alice" },
- *   recipient,
- *   activity
- * );
  *
  * // Check sent activities
- * const sent = context.getSentActivities();
- * console.log(sent[0].activity);
+ * console.log(federation.sentActivities);
  * ```
- *
- * @template TContextData The context data to pass to the {@link Context}.
- * @since 1.8.0
  */
-declare class MockContext<TContextData> implements Context<TContextData> {
-  readonly origin: string;
-  readonly canonicalOrigin: string;
-  readonly host: string;
-  readonly hostname: string;
-  readonly data: TContextData;
-  readonly federation: Federation<TContextData>;
-  readonly documentLoader: DocumentLoader;
-  readonly contextLoader: DocumentLoader;
-  readonly tracerProvider: TracerProvider;
-  private sentActivities;
-  constructor(options: {
-    url?: URL;
-    data: TContextData;
-    federation: Federation<TContextData>;
-    documentLoader?: DocumentLoader;
-    contextLoader?: DocumentLoader;
-    tracerProvider?: TracerProvider;
-  });
-  clone(data: TContextData): Context<TContextData>;
-  getNodeInfoUri(): URL;
-  getActorUri(identifier: string): URL;
-  getObjectUri<TObject extends Object$1>(cls: (new (...args: any[]) => TObject) & {
-    typeId: URL;
-  }, values: Record<string, string>): URL;
-  getOutboxUri(identifier: string): URL;
-  getInboxUri(identifier: string): URL;
-  getInboxUri(): URL;
-  getFollowingUri(identifier: string): URL;
-  getFollowersUri(identifier: string): URL;
-  getLikedUri(identifier: string): URL;
-  getFeaturedUri(identifier: string): URL;
-  getFeaturedTagsUri(identifier: string): URL;
-  getCollectionUri<TParam extends Record<string, string>>(_name: string | symbol, values: TParam): URL;
-  parseUri(uri: URL): ParseUriResult | null;
-  getActorKeyPairs(_identifier: string): Promise<ActorKeyPair[]>;
-  getDocumentLoader(params: {
-    handle: string;
-  } | {
-    identifier: string;
-  }): Promise<DocumentLoader>;
-  getDocumentLoader(params: {
-    keyId: URL;
-    privateKey: CryptoKey;
-  }): DocumentLoader;
-  lookupObject(_uri: URL | string, _options?: LookupObjectOptions): Promise<Object$1 | null>;
-  traverseCollection<TItem, TContext extends Context<TContextData>>(_collection: Collection | URL | null, _options?: TraverseCollectionOptions): AsyncIterable<TItem>;
-  lookupNodeInfo(url: URL | string, options?: {
-    parse?: "strict" | "best-effort";
-  } & any): Promise<NodeInfo | undefined>;
-  lookupNodeInfo(url: URL | string, options?: {
-    parse: "none";
-  } & any): Promise<JsonValue | undefined>;
-  lookupWebFinger(_resource: URL | `acct:${string}@${string}` | string, _options?: any): Promise<ResourceDescriptor | null>;
-  sendActivity(sender: SenderKeyPair | SenderKeyPair[] | {
-    identifier: string;
-  } | {
-    username: string;
-  } | {
-    handle: string;
-  }, recipients: Recipient | Recipient[], activity: Activity, options?: SendActivityOptions): Promise<void>;
-  sendActivity(sender: {
-    identifier: string;
-  } | {
-    username: string;
-  } | {
-    handle: string;
-  }, recipients: "followers", activity: Activity, options?: SendActivityOptionsForCollection): Promise<void>;
-  sendActivity(sender: SenderKeyPair | SenderKeyPair[] | {
-    identifier: string;
-  } | {
-    username: string;
-  } | {
-    handle: string;
-  }, recipients: Recipient | Recipient[], activity: Activity, options?: SendActivityOptions): Promise<void>;
-  sendActivity(sender: {
-    identifier: string;
-  } | {
-    username: string;
-  } | {
-    handle: string;
-  }, recipients: "followers", activity: Activity, options?: SendActivityOptionsForCollection): Promise<void>;
-  routeActivity(_recipient: string | null, _activity: Activity, _options?: RouteActivityOptions): Promise<boolean>;
-  /**
-   * Gets all activities that have been sent through this mock context.
-   * This method is specific to the mock implementation and is used for
-   * testing purposes.
-   *
-   * @returns An array of sent activity records.
-   */
-  getSentActivities(): Array<{
-    sender: SenderKeyPair | SenderKeyPair[] | {
-      identifier: string;
-    } | {
-      username: string;
-    } | {
-      handle: string;
-    };
-    recipients: Recipient | Recipient[] | "followers";
-    activity: Activity;
-  }>;
-  /**
-   * Clears all sent activities from the mock context.
-   * This method is specific to the mock implementation and is used for
-   * testing purposes.
-   */
-  reset(): void;
-}
-//#endregion
-//#region src/context.d.ts
-declare function createContext<TContextData>(values: Partial<Context<TContextData>> & {
-  url?: URL;
-  data: TContextData;
-  federation: Federation<TContextData>;
-}): Context<TContextData>;
-declare function createRequestContext<TContextData>(args: Partial<RequestContext<TContextData>> & {
-  url: URL;
-  data: TContextData;
-  federation: Federation<TContextData>;
-}): RequestContext<TContextData>;
-declare function createInboxContext<TContextData>(args: Partial<InboxContext<TContextData>> & {
-  url?: URL;
-  data: TContextData;
-  recipient?: string | null;
-  federation: Federation<TContextData>;
-}): InboxContext<TContextData>;
+declare function createFederation<TContextData>(options?: {
+  contextData?: TContextData;
+  origin?: string;
+  tracerProvider?: any;
+}): TestFederation<TContextData>;
 //#endregion
-export { MockContext, MockFederation, SentActivity, createContext, createInboxContext, createRequestContext };
+export { createContext, createFederation, createInboxContext, createRequestContext };