@fedify/testing 1.8.12 → 1.8.14-dev.1853

package/dist/mod.d.ts

@@ -1,12 +1,38 @@
-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 } 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 { ActorCallbackSetters, ActorDispatcher, CollectionCallbackSetters, CollectionDispatcher, Context, Federation, FederationFetchOptions, FederationStartQueueOptions, InboxContext, InboxListenerSetters, Message, NodeInfoDispatcher, ObjectCallbackSetters, ObjectDispatcher, RequestContext } from "@fedify/fedify/federation";
+import { Activity, Actor, Hashtag, Object as Object$1, Recipient } from "@fedify/fedify/vocab";
+import "@fedify/fedify/runtime";
 
+//#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.
+ * @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>;
+/**
+ * Creates an InboxContext for testing purposes.
+ * @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>;
+}): InboxContext<TContextData>;
+//#endregion
 //#region src/mock.d.ts
-
 /**
  * Represents a sent activity with metadata about how it was sent.
  * @since 1.8.0
@@ -87,7 +113,7 @@ declare class MockFederation<TContextData> implements Federation<TContextData> {
   constructor(options?: {
     contextData?: TContextData;
     origin?: string;
-    tracerProvider?: TracerProvider;
+    tracerProvider?: any;
   });
   setNodeInfoDispatcher(path: string, dispatcher: NodeInfoDispatcher<TContextData>): void;
   setActorDispatcher(path: `${string}{identifier}${string}` | `${string}{handle}${string}`, dispatcher: ActorDispatcher<TContextData>): ActorCallbackSetters<TContextData>;
@@ -104,8 +130,7 @@ declare class MockFederation<TContextData> implements Federation<TContextData> {
   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>;
+  createContext(baseUrlOrRequest: any, contextData: TContextData): any;
   fetch(request: Request, options: FederationFetchOptions<TContextData>): Promise<Response>;
   /**
    * Simulates receiving an activity. This method is specific to the mock
@@ -132,18 +157,20 @@ declare class MockFederation<TContextData> implements Federation<TContextData> {
  * This class provides a way to test Fedify applications without needing
  * a real federation context.
  *
+ * Note: This class is not exported from the public API. Use
+ * {@link MockFederation.createContext} instead.
+ *
  * @example
  * ```typescript
  * import { Person, Create } from "@fedify/fedify/vocab";
- * import { MockContext, MockFederation } from "@fedify/testing";
+ * import { MockFederation } from "@fedify/testing";
  *
- * // Create a mock context
+ * // Create a mock federation and context
  * const mockFederation = new MockFederation<{ userId: string }>();
- * const context = new MockContext({
- *   url: new URL("https://example.com"),
- *   data: { userId: "test-user" },
- *   federation: mockFederation
- * });
+ * const context = mockFederation.createContext(
+ *   new URL("https://example.com"),
+ *   { userId: "test-user" }
+ * );
  *
  * // Send an activity
  * const recipient = new Person({ id: new URL("https://example.com/users/bob") });
@@ -157,139 +184,13 @@ declare class MockFederation<TContextData> implements Federation<TContextData> {
  *   activity
  * );
  *
- * // Check sent activities
- * const sent = context.getSentActivities();
+ * // Check sent activities from the federation
+ * const sent = mockFederation.sentActivities;
  * console.log(sent[0].activity);
  * ```
  *
  * @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>;
 //#endregion
-export { MockContext, MockFederation, SentActivity, createContext, createInboxContext, createRequestContext };
+export { MockFederation, SentActivity, createContext, createInboxContext, createRequestContext };

package/dist/mod.js

@@ -1,4 +1,3 @@
-import { trace } from "@opentelemetry/api";
 import { RouterError } from "@fedify/fedify/federation";
 import { lookupObject, traverseCollection } from "@fedify/fedify/vocab";
 import { lookupWebFinger } from "@fedify/fedify/webfinger";
@@ -12,6 +11,10 @@ const mockDocumentLoader = async (url) => ({
 
 //#endregion
 //#region src/context.ts
+const noopTracerProvider$1 = { getTracer: () => ({
+	startActiveSpan: () => void 0,
+	startSpan: () => void 0
+}) };
 function createContext(values) {
 	const { federation, url = new URL("http://example.com/"), canonicalOrigin, data, documentLoader, contextLoader, tracerProvider, clone, getNodeInfoUri, getActorUri, getObjectUri, getCollectionUri, getOutboxUri, getInboxUri, getFollowingUri, getFollowersUri, getLikedUri, getFeaturedUri, getFeaturedTagsUri, parseUri, getActorKeyPairs, getDocumentLoader, lookupObject: lookupObject$1, traverseCollection: traverseCollection$1, lookupNodeInfo, lookupWebFinger: lookupWebFinger$1, sendActivity, routeActivity } = values;
 	function throwRouteError() {
@@ -26,7 +29,7 @@ function createContext(values) {
 		hostname: url.hostname,
 		documentLoader: documentLoader ?? mockDocumentLoader,
 		contextLoader: contextLoader ?? mockDocumentLoader,
-		tracerProvider: tracerProvider ?? trace.getTracerProvider(),
+		tracerProvider: tracerProvider ?? noopTracerProvider$1,
 		clone: clone ?? ((data$1) => createContext({
 			...values,
 			data: data$1
@@ -75,6 +78,12 @@ function createContext(values) {
 		})
 	};
 }
+/**
+* Creates a RequestContext for testing purposes.
+* @param args Partial RequestContext properties
+* @returns A RequestContext instance
+* @since 1.8.0
+*/
 function createRequestContext(args) {
 	return {
 		...createContext(args),
@@ -93,6 +102,12 @@ function createRequestContext(args) {
 		})
 	};
 }
+/**
+* Creates an InboxContext for testing purposes.
+* @param args Partial InboxContext properties
+* @returns An InboxContext instance
+* @since 1.8.0
+*/
 function createInboxContext(args) {
 	return {
 		...createContext(args),
@@ -109,6 +124,10 @@ function createInboxContext(args) {
 
 //#endregion
 //#region src/mock.ts
+const noopTracerProvider = { getTracer: () => ({
+	startActiveSpan: () => void 0,
+	startSpan: () => void 0
+}) };
 /**
 * Helper function to expand URI templates with values.
 * Supports simple placeholders like {identifier}, {handle}, etc.
@@ -122,6 +141,25 @@ function expandUriTemplate(template, values) {
 	});
 }
 /**
+* Creates an InboxContext for testing purposes.
+* @param args Partial InboxContext properties
+* @returns An InboxContext instance
+* @since 1.8.0
+*/
+function createInboxContext$1(args) {
+	return {
+		...createContext(args),
+		clone: args.clone ?? ((data) => createInboxContext$1({
+			...args,
+			data
+		})),
+		recipient: args.recipient ?? null,
+		forwardActivity: args.forwardActivity ?? ((_params) => {
+			throw new Error("Not implemented");
+		})
+	};
+}
+/**
 * 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.
@@ -309,22 +347,9 @@ var MockFederation = class {
 	}
 	createContext(baseUrlOrRequest, contextData) {
 		const mockFederation = this;
-		if (baseUrlOrRequest instanceof Request) return createRequestContext({
-			url: new URL(baseUrlOrRequest.url),
-			request: baseUrlOrRequest,
-			data: contextData,
-			federation: mockFederation,
-			sendActivity: async (sender, recipients, activity, options) => {
-				const tempContext = new MockContext({
-					url: new URL(baseUrlOrRequest.url),
-					data: contextData,
-					federation: mockFederation
-				});
-				await tempContext.sendActivity(sender, recipients, activity, options);
-			}
-		});
-		else return new MockContext({
-			url: baseUrlOrRequest,
+		const url = baseUrlOrRequest instanceof Request ? new URL(baseUrlOrRequest.url) : baseUrlOrRequest;
+		return new MockContext({
+			url,
 			data: contextData,
 			federation: mockFederation
 		});
@@ -347,7 +372,7 @@ var MockFederation = class {
 		const listeners = this.inboxListeners.get(typeName) || [];
 		if (listeners.length > 0 && this.contextData === void 0) throw new Error("MockFederation.receiveActivity(): contextData is not initialized. Please provide contextData through the constructor or call startQueue() before receiving activities.");
 		for (const listener of listeners) {
-			const context = createInboxContext({
+			const context = createInboxContext$1({
 				data: this.contextData,
 				federation: this
 			});
@@ -386,18 +411,20 @@ var MockFederation = class {
 * This class provides a way to test Fedify applications without needing
 * a real federation context.
 *
+* Note: This class is not exported from the public API. Use
+* {@link MockFederation.createContext} instead.
+*
 * @example
 * ```typescript
 * import { Person, Create } from "@fedify/fedify/vocab";
-* import { MockContext, MockFederation } from "@fedify/testing";
+* import { MockFederation } from "@fedify/testing";
 *
-* // Create a mock context
+* // Create a mock federation and context
 * const mockFederation = new MockFederation<{ userId: string }>();
-* const context = new MockContext({
-*   url: new URL("https://example.com"),
-*   data: { userId: "test-user" },
-*   federation: mockFederation
-* });
+* const context = mockFederation.createContext(
+*   new URL("https://example.com"),
+*   { userId: "test-user" }
+* );
 *
 * // Send an activity
 * const recipient = new Person({ id: new URL("https://example.com/users/bob") });
@@ -411,8 +438,8 @@ var MockFederation = class {
 *   activity
 * );
 *
-* // Check sent activities
-* const sent = context.getSentActivities();
+* // Check sent activities from the federation
+* const sent = mockFederation.sentActivities;
 * console.log(sent[0].activity);
 * ```
 *
@@ -444,7 +471,7 @@ var MockContext = class MockContext {
 			documentUrl: url$1
 		}));
 		this.contextLoader = options.contextLoader ?? this.documentLoader;
-		this.tracerProvider = options.tracerProvider ?? trace.getTracerProvider();
+		this.tracerProvider = options.tracerProvider ?? noopTracerProvider;
 	}
 	clone(data) {
 		return new MockContext({
@@ -630,4 +657,4 @@ var MockContext = class MockContext {
 };
 
 //#endregion
-export { MockContext, MockFederation, createContext, createInboxContext, createRequestContext };
+export { MockFederation, createContext, createInboxContext, createRequestContext };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/testing",
-  "version": "1.8.12",
+  "version": "1.8.14-dev.1853+21177540",
   "description": "Testing utilities for Fedify applications",
   "keywords": [
     "fedify",
@@ -45,10 +45,7 @@
     "package.json"
   ],
   "peerDependencies": {
-    "@fedify/fedify": "^1.8.12"
-  },
-  "dependencies": {
-    "@opentelemetry/api": "^1.9.0"
+    "@fedify/fedify": "^1.8.14-dev.1853+21177540"
   },
   "devDependencies": {
     "@js-temporal/polyfill": "^0.5.1",