@fedify/testing 2.1.0-dev.405 → 2.1.0-dev.408

package/dist/mod.d.cts

@@ -3,48 +3,51 @@ import { Activity } from "@fedify/vocab";
 import { MessageQueue } from "@fedify/fedify";
 
 //#region src/context.d.ts
+// NOTE: Copied from @fedify/fedify/testing/context.ts
+// Not exported - used internally only. Public API is in mock.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
- */
+* 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
- */
+* 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
- */
+* 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>;
+// Export for internal use by mock.ts only
 //#endregion
 //#region src/mock.d.ts
 /**
- * Represents a sent activity with metadata about how it was sent.
- * @since 1.8.0
- */
+* 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;
@@ -56,12 +59,14 @@ interface SentActivity {
   sentOrder: number;
 }
 /**
- * A mock Context interface for testing purposes.
- * Extends the standard Context interface with additional testing utilities.
- * @since 1.9.1
- */
+* 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"> {
+  // Override clone to return TestContext
   clone(data: TContextData): TestContext<TContextData>;
+  // Test-specific methods
   getSentActivities(): Array<{
     sender: any;
     recipients: any;
@@ -70,54 +75,57 @@ interface TestContext<TContextData> extends Omit<Context<TContextData>, "clone">
   reset(): void;
 }
 /**
- * A mock Federation interface for testing purposes.
- * Extends the standard Federation interface with additional testing utilities.
- * @since 1.9.1
- */
+* 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"> {
+  // Test-specific properties
   sentActivities: SentActivity[];
   queueStarted: boolean;
   sentCounter: number;
+  // Test-specific methods
   receiveActivity(activity: Activity): Promise<void>;
   reset(): void;
+  // Override createContext to return TestContext
   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);
- * ```
- */
+* 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;
@@ -126,62 +134,62 @@ declare function createFederation<TContextData>(options?: {
 //#endregion
 //#region src/mq-tester.d.ts
 /**
- * Options for {@link testMessageQueue}.
- */
+* Options for {@link testMessageQueue}.
+*/
 interface TestMessageQueueOptions {
   /**
-   * Whether to test ordering key support.  If `true`, tests will verify that
-   * messages with the same ordering key are processed in order, while messages
-   * with different ordering keys can be processed in parallel.
-   *
-   * Set this to `true` only if your message queue implementation supports
-   * the `orderingKey` option.
-   *
-   * @default false
-   */
+  * Whether to test ordering key support.  If `true`, tests will verify that
+  * messages with the same ordering key are processed in order, while messages
+  * with different ordering keys can be processed in parallel.
+  *
+  * Set this to `true` only if your message queue implementation supports
+  * the `orderingKey` option.
+  *
+  * @default false
+  */
   readonly testOrderingKey?: boolean;
 }
 /**
- * Tests a {@link MessageQueue} implementation with a standard set of tests.
- *
- * This function runs tests for:
- * - `enqueue()`: Basic message enqueueing
- * - `enqueue()` with delay: Delayed message enqueueing
- * - `enqueueMany()`: Bulk message enqueueing
- * - `enqueueMany()` with delay: Delayed bulk message enqueueing
- * - Multiple listeners: Ensures messages are processed by only one listener
- * - Ordering key support (optional): Ensures messages with the same ordering
- *   key are processed in order
- *
- * @example
- * ```typescript ignore
- * import { test } from "@fedify/fixture";
- * import { testMessageQueue } from "@fedify/testing";
- * import { MyMessageQueue } from "./my-mq.ts";
- *
- * test("MyMessageQueue", () =>
- *   testMessageQueue(
- *     () => new MyMessageQueue(),
- *     async ({ mq1, mq2, controller }) => {
- *       controller.abort();
- *       await mq1.close();
- *       await mq2.close();
- *     },
- *     { testOrderingKey: true },  // Enable ordering key tests
- *   )
- * );
- * ```
- *
- * @param getMessageQueue A factory function that creates a new message queue
- *                        instance.  It should return a new instance each time
- *                        to ensure test isolation, but both instances should
- *                        share the same underlying storage/channel.
- * @param onFinally A cleanup function called after all tests complete.
- *                  It receives both message queue instances and the abort
- *                  controller used for the listeners.
- * @param options Optional configuration for the test suite.
- * @returns A promise that resolves when all tests pass.
- */
+* Tests a {@link MessageQueue} implementation with a standard set of tests.
+*
+* This function runs tests for:
+* - `enqueue()`: Basic message enqueueing
+* - `enqueue()` with delay: Delayed message enqueueing
+* - `enqueueMany()`: Bulk message enqueueing
+* - `enqueueMany()` with delay: Delayed bulk message enqueueing
+* - Multiple listeners: Ensures messages are processed by only one listener
+* - Ordering key support (optional): Ensures messages with the same ordering
+*   key are processed in order
+*
+* @example
+* ```typescript ignore
+* import { test } from "@fedify/fixture";
+* import { testMessageQueue } from "@fedify/testing";
+* import { MyMessageQueue } from "./my-mq.ts";
+*
+* test("MyMessageQueue", () =>
+*   testMessageQueue(
+*     () => new MyMessageQueue(),
+*     async ({ mq1, mq2, controller }) => {
+*       controller.abort();
+*       await mq1.close();
+*       await mq2.close();
+*     },
+*     { testOrderingKey: true },  // Enable ordering key tests
+*   )
+* );
+* ```
+*
+* @param getMessageQueue A factory function that creates a new message queue
+*                        instance.  It should return a new instance each time
+*                        to ensure test isolation, but both instances should
+*                        share the same underlying storage/channel.
+* @param onFinally A cleanup function called after all tests complete.
+*                  It receives both message queue instances and the abort
+*                  controller used for the listeners.
+* @param options Optional configuration for the test suite.
+* @returns A promise that resolves when all tests pass.
+*/
 declare function testMessageQueue<MQ extends MessageQueue>(getMessageQueue: () => MQ | Promise<MQ>, onFinally: ({
   mq1,
   mq2,

package/dist/mod.d.ts

@@ -4,48 +4,51 @@ import { Context, Federation, InboxContext, RequestContext } from "@fedify/fedif
 import { MessageQueue } from "@fedify/fedify";
 
 //#region src/context.d.ts
+// NOTE: Copied from @fedify/fedify/testing/context.ts
+// Not exported - used internally only. Public API is in mock.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
- */
+* 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
- */
+* 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
- */
+* 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>;
+// Export for internal use by mock.ts only
 //#endregion
 //#region src/mock.d.ts
 /**
- * Represents a sent activity with metadata about how it was sent.
- * @since 1.8.0
- */
+* 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;
@@ -57,12 +60,14 @@ interface SentActivity {
   sentOrder: number;
 }
 /**
- * A mock Context interface for testing purposes.
- * Extends the standard Context interface with additional testing utilities.
- * @since 1.9.1
- */
+* 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"> {
+  // Override clone to return TestContext
   clone(data: TContextData): TestContext<TContextData>;
+  // Test-specific methods
   getSentActivities(): Array<{
     sender: any;
     recipients: any;
@@ -71,54 +76,57 @@ interface TestContext<TContextData> extends Omit<Context<TContextData>, "clone">
   reset(): void;
 }
 /**
- * A mock Federation interface for testing purposes.
- * Extends the standard Federation interface with additional testing utilities.
- * @since 1.9.1
- */
+* 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"> {
+  // Test-specific properties
   sentActivities: SentActivity[];
   queueStarted: boolean;
   sentCounter: number;
+  // Test-specific methods
   receiveActivity(activity: Activity): Promise<void>;
   reset(): void;
+  // Override createContext to return TestContext
   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);
- * ```
- */
+* 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;
@@ -127,62 +135,62 @@ declare function createFederation<TContextData>(options?: {
 //#endregion
 //#region src/mq-tester.d.ts
 /**
- * Options for {@link testMessageQueue}.
- */
+* Options for {@link testMessageQueue}.
+*/
 interface TestMessageQueueOptions {
   /**
-   * Whether to test ordering key support.  If `true`, tests will verify that
-   * messages with the same ordering key are processed in order, while messages
-   * with different ordering keys can be processed in parallel.
-   *
-   * Set this to `true` only if your message queue implementation supports
-   * the `orderingKey` option.
-   *
-   * @default false
-   */
+  * Whether to test ordering key support.  If `true`, tests will verify that
+  * messages with the same ordering key are processed in order, while messages
+  * with different ordering keys can be processed in parallel.
+  *
+  * Set this to `true` only if your message queue implementation supports
+  * the `orderingKey` option.
+  *
+  * @default false
+  */
   readonly testOrderingKey?: boolean;
 }
 /**
- * Tests a {@link MessageQueue} implementation with a standard set of tests.
- *
- * This function runs tests for:
- * - `enqueue()`: Basic message enqueueing
- * - `enqueue()` with delay: Delayed message enqueueing
- * - `enqueueMany()`: Bulk message enqueueing
- * - `enqueueMany()` with delay: Delayed bulk message enqueueing
- * - Multiple listeners: Ensures messages are processed by only one listener
- * - Ordering key support (optional): Ensures messages with the same ordering
- *   key are processed in order
- *
- * @example
- * ```typescript ignore
- * import { test } from "@fedify/fixture";
- * import { testMessageQueue } from "@fedify/testing";
- * import { MyMessageQueue } from "./my-mq.ts";
- *
- * test("MyMessageQueue", () =>
- *   testMessageQueue(
- *     () => new MyMessageQueue(),
- *     async ({ mq1, mq2, controller }) => {
- *       controller.abort();
- *       await mq1.close();
- *       await mq2.close();
- *     },
- *     { testOrderingKey: true },  // Enable ordering key tests
- *   )
- * );
- * ```
- *
- * @param getMessageQueue A factory function that creates a new message queue
- *                        instance.  It should return a new instance each time
- *                        to ensure test isolation, but both instances should
- *                        share the same underlying storage/channel.
- * @param onFinally A cleanup function called after all tests complete.
- *                  It receives both message queue instances and the abort
- *                  controller used for the listeners.
- * @param options Optional configuration for the test suite.
- * @returns A promise that resolves when all tests pass.
- */
+* Tests a {@link MessageQueue} implementation with a standard set of tests.
+*
+* This function runs tests for:
+* - `enqueue()`: Basic message enqueueing
+* - `enqueue()` with delay: Delayed message enqueueing
+* - `enqueueMany()`: Bulk message enqueueing
+* - `enqueueMany()` with delay: Delayed bulk message enqueueing
+* - Multiple listeners: Ensures messages are processed by only one listener
+* - Ordering key support (optional): Ensures messages with the same ordering
+*   key are processed in order
+*
+* @example
+* ```typescript ignore
+* import { test } from "@fedify/fixture";
+* import { testMessageQueue } from "@fedify/testing";
+* import { MyMessageQueue } from "./my-mq.ts";
+*
+* test("MyMessageQueue", () =>
+*   testMessageQueue(
+*     () => new MyMessageQueue(),
+*     async ({ mq1, mq2, controller }) => {
+*       controller.abort();
+*       await mq1.close();
+*       await mq2.close();
+*     },
+*     { testOrderingKey: true },  // Enable ordering key tests
+*   )
+* );
+* ```
+*
+* @param getMessageQueue A factory function that creates a new message queue
+*                        instance.  It should return a new instance each time
+*                        to ensure test isolation, but both instances should
+*                        share the same underlying storage/channel.
+* @param onFinally A cleanup function called after all tests complete.
+*                  It receives both message queue instances and the abort
+*                  controller used for the listeners.
+* @param options Optional configuration for the test suite.
+* @returns A promise that resolves when all tests pass.
+*/
 declare function testMessageQueue<MQ extends MessageQueue>(getMessageQueue: () => MQ | Promise<MQ>, onFinally: ({
   mq1,
   mq2,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/testing",
-  "version": "2.1.0-dev.405+f4e278ae",
+  "version": "2.1.0-dev.408+5c3c9d78",
   "description": "Testing utilities for Fedify applications",
   "keywords": [
     "fedify",
@@ -50,7 +50,7 @@
     "package.json"
   ],
   "peerDependencies": {
-    "@fedify/fedify": "^2.1.0-dev.405+f4e278ae"
+    "@fedify/fedify": "^2.1.0-dev.408+5c3c9d78"
   },
   "dependencies": {
     "es-toolkit": "1.43.0"