@warp-drive/holodeck 0.1.0-beta.1 → 0.1.0-beta.3

package/CHANGELOG.md

@@ -0,0 +1,139 @@
+# @warp-drive/holodeck Changelog
+
+## v5.8.0 (2025-10-07)
+
+#### :rocket: Enhancement
+
+* [#10121](https://github.com/warp-drive-data/warp-drive/pull/10121) feat: legacy ModelFragments support ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
+
+#### :house: Internal
+
+* [#10377](https://github.com/warp-drive-data/warp-drive/pull/10377) chore: refactor holodeck to use node ([@runspired](https://github.com/runspired))
+* [#10376](https://github.com/warp-drive-data/warp-drive/pull/10376) chore: prepare holodeck for publishing ([@runspired](https://github.com/runspired))
+* [#10375](https://github.com/warp-drive-data/warp-drive/pull/10375) chore: make non-GET holodeck replay work ([@runspired](https://github.com/runspired))
+* [#10373](https://github.com/warp-drive-data/warp-drive/pull/10373) chore: add holodeck client support for PUT/PATCH/POST/DELETE ([@runspired](https://github.com/runspired))
+* [#10372](https://github.com/warp-drive-data/warp-drive/pull/10372) Missing Context Param in Code Example for setTestId ([@lucasxzh](https://github.com/lucasxzh))
+* [#10349](https://github.com/warp-drive-data/warp-drive/pull/10349) chore: update all emberjs/data links to warp-drive-data/warp-drive ([@runspired](https://github.com/runspired))
+
+#### Committers: (3)
+
+Robbie Wagner ([@RobbieTheWagner](https://github.com/RobbieTheWagner))
+Chris Thoburn ([@runspired](https://github.com/runspired))
+[@lucasxzh](https://github.com/lucasxzh)
+
+## v5.7.0 (2025-08-26)
+
+#### :house: Internal
+
+* [#10279](https://github.com/warp-drive-data/warp-drive/pull/10279) chore: add support for LegacyNetworkHandler to holodeck ([@runspired](https://github.com/runspired))
+* [#10226](https://github.com/warp-drive-data/warp-drive/pull/10226) chore: use https for diagnostic by default, print url last ([@runspired](https://github.com/runspired))
+* [#10124](https://github.com/warp-drive-data/warp-drive/pull/10124) chore: mark a few types as private ([@runspired](https://github.com/runspired))
+
+#### Committers: (1)
+
+Chris Thoburn ([@runspired](https://github.com/runspired))
+
+## v5.6.0 (2025-07-01)
+
+#### :memo: Documentation
+
+* [#9991](https://github.com/warp-drive-data/warp-drive/pull/9991) chore: improve output of typedoc ([@runspired](https://github.com/runspired))
+
+#### :house: Internal
+
+* [#10042](https://github.com/warp-drive-data/warp-drive/pull/10042) chore: upgrade to vite7 ([@runspired](https://github.com/runspired))
+* [#10040](https://github.com/warp-drive-data/warp-drive/pull/10040) chore: isolated declarations ([@runspired](https://github.com/runspired))
+
+#### Committers: (1)
+
+Chris Thoburn ([@runspired](https://github.com/runspired))
+
+## v5.4.0 (2025-04-11)
+
+#### :memo: Documentation
+
+* [#9648](https://github.com/warp-drive-data/warp-drive/pull/9648) docs: cleanup usage pattern for RequestManager configuration on store ([@runspired](https://github.com/runspired))
+
+#### :rocket: Enhancement
+
+* [#9530](https://github.com/warp-drive-data/warp-drive/pull/9530) feat: <:idle> state for Requests ([@runspired](https://github.com/runspired))
+* [#9503](https://github.com/warp-drive-data/warp-drive/pull/9503) feat: request deduping & <Request /> invalidate subscriptions ([@runspired](https://github.com/runspired))
+
+#### :bug: Bug Fix
+
+* [#9530](https://github.com/warp-drive-data/warp-drive/pull/9530) feat: <:idle> state for Requests ([@runspired](https://github.com/runspired))
+
+#### :house: Internal
+
+* [#9759](https://github.com/warp-drive-data/warp-drive/pull/9759) chore: Improve contributing experience ([@runspired](https://github.com/runspired))
+* [#9758](https://github.com/warp-drive-data/warp-drive/pull/9758) chore: update contributing docs ([@runspired](https://github.com/runspired))
+* [#9752](https://github.com/warp-drive-data/warp-drive/pull/9752) chore: tooling upgrades to support WarpDrive package unification ([@runspired](https://github.com/runspired))
+* [#9705](https://github.com/warp-drive-data/warp-drive/pull/9705) chore: make diagnostic shutdown safer, use bun for holodeck server ([@runspired](https://github.com/runspired))
+* [#9699](https://github.com/warp-drive-data/warp-drive/pull/9699) chore: update to pnpm 10 ([@runspired](https://github.com/runspired))
+* [#9629](https://github.com/warp-drive-data/warp-drive/pull/9629) fix: restore * versions and setup publish to not overwrite them ([@runspired](https://github.com/runspired))
+* [#9620](https://github.com/warp-drive-data/warp-drive/pull/9620) Starwars ([@NullVoxPopuli](https://github.com/NullVoxPopuli))
+* [#9543](https://github.com/warp-drive-data/warp-drive/pull/9543) Improvement: Setting Up The Project ([@leoeuclids](https://github.com/leoeuclids))
+
+#### Committers: (3)
+
+Chris Thoburn ([@runspired](https://github.com/runspired))
+[@NullVoxPopuli](https://github.com/NullVoxPopuli)
+Leo Euclides ([@leoeuclids](https://github.com/leoeuclids))
+
+## v0.0.0-alpha.71 (2024-06-15)
+
+#### :memo: Documentation
+
+* [#9328](https://github.com/warp-drive-data/warp-drive/pull/9328) chore: update READMEs with status and dist tag info ([@runspired](https://github.com/runspired))
+
+#### :rocket: Enhancement
+
+* [#9471](https://github.com/warp-drive-data/warp-drive/pull/9471) feat: npx warp-drive ([@runspired](https://github.com/runspired))
+* [#9366](https://github.com/warp-drive-data/warp-drive/pull/9366) feat: typed Model ([@runspired](https://github.com/runspired))
+* [#9260](https://github.com/warp-drive-data/warp-drive/pull/9260) feat: ember specific data utils ([@runspired](https://github.com/runspired))
+
+#### :bug: Bug Fix
+
+* [#9383](https://github.com/warp-drive-data/warp-drive/pull/9383) fix: ensure cache-handler clones full errors ([@runspired](https://github.com/runspired))
+
+#### :house: Internal
+
+* [#9292](https://github.com/warp-drive-data/warp-drive/pull/9292) feat: add new build-config package ([@runspired](https://github.com/runspired))
+
+#### Committers: (1)
+
+Chris Thoburn ([@runspired](https://github.com/runspired))
+
+For the full project changelog see [https://github.com/warp-drive-data/warp-drive/blob/main/CHANGELOG.md](https://github.com/warp-drive-data/warp-drive/blob/main/CHANGELOG.md)
+
+## v0.0.0-alpha.9 (2024-02-24)
+
+#### :rocket: Enhancement
+
+* [#8921](https://github.com/warp-drive-data/warp-drive/pull/8921) feat: Improved Fetch Errors ([@runspired](https://github.com/runspired))
+
+#### :house: Internal
+
+* [#9125](https://github.com/warp-drive-data/warp-drive/pull/9125) Configure ESLint for test packages ([@gitKrystan](https://github.com/gitKrystan))
+* [#8994](https://github.com/warp-drive-data/warp-drive/pull/8994) chore: fix recursive pnpm on node 18.18 ([@runspired](https://github.com/runspired))
+* [#9084](https://github.com/warp-drive-data/warp-drive/pull/9084) Add import types ([@gitKrystan](https://github.com/gitKrystan))
+* [#8989](https://github.com/warp-drive-data/warp-drive/pull/8989) chore(private): concurrent mode ([@runspired](https://github.com/runspired))
+* [#9058](https://github.com/warp-drive-data/warp-drive/pull/9058) Switch from eslint-plugin-prettier to running prettier directly ([@gitKrystan](https://github.com/gitKrystan))
+* [#9057](https://github.com/warp-drive-data/warp-drive/pull/9057) Add eslint-plugin-n to eslint config for node files ([@gitKrystan](https://github.com/gitKrystan))
+* [#9055](https://github.com/warp-drive-data/warp-drive/pull/9055) Fix ESLint for VSCode ([@gitKrystan](https://github.com/gitKrystan))
+* [#9051](https://github.com/warp-drive-data/warp-drive/pull/9051) chore: use references for tsc, add checks to schema-record, bun to run scripts ([@runspired](https://github.com/runspired))
+* [#9032](https://github.com/warp-drive-data/warp-drive/pull/9032) chore(types): split out lint and type commands to be per-package ([@runspired](https://github.com/runspired))
+* [#9050](https://github.com/warp-drive-data/warp-drive/pull/9050) chore: use composite mode for tsc ([@runspired](https://github.com/runspired))
+* [#9049](https://github.com/warp-drive-data/warp-drive/pull/9049) chore: incremental tsc builds ([@runspired](https://github.com/runspired))
+* [#9046](https://github.com/warp-drive-data/warp-drive/pull/9046) chore: reduce number of things turbo builds for build ([@runspired](https://github.com/runspired))
+* [#9025](https://github.com/warp-drive-data/warp-drive/pull/9025) chore: reconfigure request package type location ([@runspired](https://github.com/runspired))
+* [#8972](https://github.com/warp-drive-data/warp-drive/pull/8972) chore: use new test runner for request tests ([@runspired](https://github.com/runspired))
+* [#8931](https://github.com/warp-drive-data/warp-drive/pull/8931) chore: package infra for schema-record ([@runspired](https://github.com/runspired))
+* [#8912](https://github.com/warp-drive-data/warp-drive/pull/8912) chore: docs for holodeck ([@runspired](https://github.com/runspired))
+* [#8906](https://github.com/warp-drive-data/warp-drive/pull/8906) feat: expand mock-server capabilities, add to main tests ([@runspired](https://github.com/runspired))
+
+#### Committers: (2)
+
+Chris Thoburn ([@runspired](https://github.com/runspired))
+Krystan HuffMenne ([@gitKrystan](https://github.com/gitKrystan))
+

package/dist/index.d.ts

@@ -0,0 +1,56 @@
+import { ScaffoldGenerator } from "./mock.js";
+import { Handler, NextFn } from "@warp-drive/core/request";
+import { RequestContext, StructuredDataDocument } from "@warp-drive/core/types/request";
+import { Store } from "@warp-drive/legacy/store";
+//#region src/index.d.ts
+/**
+ * @public
+ */
+declare function setConfig({ host }: {
+  host: string;
+}): void;
+/**
+ * @public
+ */
+declare function setTestId(context: object, str: string | null): void;
+/**
+ * @public
+ */
+declare function setIsRecording(value: boolean): void;
+/**
+ * @public
+ */
+declare function getIsRecording(): boolean;
+/**
+ * A request handler that intercepts requests and routes them through
+ * the Holodeck mock server.
+ *
+ * This handler modifies the request URL to include test identifiers
+ * and manages request counts for accurate mocking.
+ *
+ * Requires that the test context be configured with a testId using `setTestId`.
+ *
+ * @param owner - the test context object used to retrieve the test ID.
+ */
+declare class MockServerHandler implements Handler {
+  owner: object;
+  constructor(owner: object);
+  request<T>(context: RequestContext, next: NextFn<T>): Promise<StructuredDataDocument<T>>;
+}
+/**
+ * Creates an adapterFor function that wraps the provided adapterFor function
+ * to override the adapter's _fetchRequest method to route requests through
+ * the Holodeck mock server.
+ *
+ * @param owner - The test context object used to retrieve the test ID.
+ */
+declare function installAdapterFor(owner: object, store: Store): void;
+/**
+ * Mock a request by sending the scaffold to the mock server.
+ *
+ * @public
+ */
+declare function mock(owner: object, generate: ScaffoldGenerator, isRecording?: boolean): Promise<void>;
+//#endregion
+export { MockServerHandler, getIsRecording, installAdapterFor, mock, setConfig, setIsRecording, setTestId };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"mappings":";;;;;;;;iBAuIgB,YAAY;EAAU;;;;;iBAQtB,UAAU,iBAAiB;;;;iBA2C3B,eAAe;;;;iBAOf;;;;;;;;;;;;cAeH,6BAA6B;EACxC;EACA,YAAY;EAGZ,QAAc,GAAG,SAAS,gBAAgB,MAAM,OAAO,KAAK,QAAQ,uBAAuB;;;;;;;;;iBAkG7E,kBAAkB,eAAe,OAAO;;;;;;iBAuClC,KAAK,eAAe,UAAU,mBAAmB,wBAAwB"}

package/dist/index.js

@@ -1,237 +1,181 @@
-import { SHOULD_RECORD } from '@warp-drive/core/build-config/env';
+import { getGlobalConfig, macroCondition } from "@embroider/macros";
 
+//#region src/index.ts
 /**
- * @module
- * @mergeModuleWith <project>
- */
-const TEST_IDS = new WeakMap();
-let HOST = '/';
-
+* @module
+* @mergeModuleWith <project>
+*/
+const TEST_IDS = /* @__PURE__ */ new WeakMap();
+let HOST = "/";
 /**
- * @public
- */
-
-function setConfig({
-  host
-}) {
-  HOST = host.endsWith('/') ? host : `${host}/`;
+* @public
+*/
+function setConfig({ host }) {
+	HOST = host.endsWith("/") ? host : `${host}/`;
 }
-
 /**
- * @public
- */
-
+* @public
+*/
 function setTestId(context, str) {
-  if (str && TEST_IDS.has(context)) {
-    throw new Error(`MockServerHandler is already configured with a testId.`);
-  }
-  if (str) {
-    TEST_IDS.set(context, {
-      id: str,
-      mock: {
-        GET: {},
-        PUT: {},
-        PATCH: {},
-        DELETE: {},
-        POST: {},
-        QUERY: {},
-        OPTIONS: {},
-        HEAD: {},
-        CONNECT: {},
-        TRACE: {}
-      },
-      request: {
-        GET: {},
-        PUT: {},
-        PATCH: {},
-        DELETE: {},
-        POST: {},
-        QUERY: {},
-        OPTIONS: {},
-        HEAD: {},
-        CONNECT: {},
-        TRACE: {}
-      }
-    });
-  } else {
-    TEST_IDS.delete(context);
-  }
+	if (str && TEST_IDS.has(context)) throw new Error(`MockServerHandler is already configured with a testId.`);
+	if (str) TEST_IDS.set(context, {
+		id: str,
+		mock: {
+			GET: {},
+			PUT: {},
+			PATCH: {},
+			DELETE: {},
+			POST: {},
+			QUERY: {},
+			OPTIONS: {},
+			HEAD: {},
+			CONNECT: {},
+			TRACE: {}
+		},
+		request: {
+			GET: {},
+			PUT: {},
+			PATCH: {},
+			DELETE: {},
+			POST: {},
+			QUERY: {},
+			OPTIONS: {},
+			HEAD: {},
+			CONNECT: {},
+			TRACE: {}
+		}
+	});
+	else TEST_IDS.delete(context);
 }
-const shouldRecord = SHOULD_RECORD ? true : false;
+const shouldRecord = macroCondition(getGlobalConfig().WarpDrive.env.SHOULD_RECORD) ? true : false;
 let IS_RECORDING = null;
-
 /**
- * @public
- */
+* @public
+*/
 function setIsRecording(value) {
-  IS_RECORDING = value === null ? value : Boolean(value);
+	IS_RECORDING = value === null ? value : Boolean(value);
 }
-
 /**
- * @public
- */
+* @public
+*/
 function getIsRecording() {
-  return IS_RECORDING === null ? shouldRecord : IS_RECORDING;
+	return IS_RECORDING === null ? shouldRecord : IS_RECORDING;
 }
-
 /**
- * A request handler that intercepts requests and routes them through
- * the Holodeck mock server.
- *
- * This handler modifies the request URL to include test identifiers
- * and manages request counts for accurate mocking.
- *
- * Requires that the test context be configured with a testId using `setTestId`.
- *
- * @param owner - the test context object used to retrieve the test ID.
- */
-class MockServerHandler {
-  constructor(owner) {
-    this.owner = owner;
-  }
-  async request(context, next) {
-    const {
-      request,
-      queryForTest
-    } = setupHolodeckFetch(this.owner, Object.assign({}, context.request));
-    try {
-      const future = next(request);
-      context.setStream(future.getStream());
-      return await future;
-    } catch (e) {
-      if (e instanceof Error && !(e instanceof DOMException)) {
-        e.message = e.message.replace(queryForTest, '');
-      }
-      throw e;
-    }
-  }
-}
+* A request handler that intercepts requests and routes them through
+* the Holodeck mock server.
+*
+* This handler modifies the request URL to include test identifiers
+* and manages request counts for accurate mocking.
+*
+* Requires that the test context be configured with a testId using `setTestId`.
+*
+* @param owner - the test context object used to retrieve the test ID.
+*/
+var MockServerHandler = class {
+	constructor(owner) {
+		this.owner = owner;
+	}
+	async request(context, next) {
+		const { request, queryForTest } = setupHolodeckFetch(this.owner, Object.assign({}, context.request));
+		try {
+			const future = next(request);
+			context.setStream(future.getStream());
+			return await future;
+		} catch (e) {
+			if (e instanceof Error && !(e instanceof DOMException)) e.message = e.message.replace(queryForTest, "");
+			throw e;
+		}
+	}
+};
 function setupHolodeckFetch(owner, request) {
-  const test = TEST_IDS.get(owner);
-  if (!test) {
-    throw new Error(`MockServerHandler is not configured with a testId. Use setTestId to set the testId for each test`);
-  }
-  const url = request.url;
-  const firstChar = url.includes('?') ? '&' : '?';
-  const method = request.method?.toUpperCase() ?? 'GET';
-
-  // enable custom methods
-  if (!test.request[method]) {
-    // eslint-disable-next-line no-console
-    console.log(`⚠️ Using custom HTTP method ${method} for response to request ${url}`);
-    test.request[method] = {};
-  }
-  if (!(url in test.request[method])) {
-    test.request[method][url] = 0;
-  }
-  const queryForTest = `${firstChar}__xTestId=${test.id}&__xTestRequestNumber=${test.request[method][url]++}`;
-  request.url = url + queryForTest;
-  request.method = method;
-  request.mode = 'cors';
-  request.credentials = 'omit';
-  request.referrerPolicy = '';
-
-  // since holodeck currently runs on a separate port
-  // and we don't want to trigger cors pre-flight
-  // we convert PUT to POST to keep the request in the
-  // "simple" cors category.
-  // if (request.method === 'PUT') {
-  //   request.method = 'POST';
-  // }
-
-  const headers = new Headers(request.headers);
-  if (headers.has('Content-Type')) {
-    // under the rules of simple-cors, content-type can only be
-    // one of three things, none of which are what folks typically
-    // set this to. Since holodeck always expects body to be JSON
-    // this "just works".
-    headers.set('Content-Type', 'text/plain');
-    request.headers = headers;
-  }
-  return {
-    request,
-    queryForTest
-  };
+	const test = TEST_IDS.get(owner);
+	if (!test) throw new Error(`MockServerHandler is not configured with a testId. Use setTestId to set the testId for each test`);
+	const url = request.url;
+	const firstChar = url.includes("?") ? "&" : "?";
+	const method = request.method?.toUpperCase() ?? "GET";
+	if (!test.request[method]) {
+		console.log(`⚠️ Using custom HTTP method ${method} for response to request ${url}`);
+		test.request[method] = {};
+	}
+	if (!(url in test.request[method])) test.request[method][url] = 0;
+	const queryForTest = `${firstChar}__xTestId=${test.id}&__xTestRequestNumber=${test.request[method][url]++}`;
+	request.url = url + queryForTest;
+	request.method = method;
+	request.mode = "cors";
+	request.credentials = "omit";
+	request.referrerPolicy = "";
+	const headers = new Headers(request.headers);
+	if (headers.has("Content-Type")) {
+		headers.set("Content-Type", "text/plain");
+		request.headers = headers;
+	}
+	return {
+		request,
+		queryForTest
+	};
 }
 function upgradeStore(store) {
-  if (typeof store.adapterFor !== 'function') {
-    throw new Error('Store is not compatible with Holodeck. Missing adapterFor method.');
-  }
+	if (typeof store.adapterFor !== "function") throw new Error("Store is not compatible with Holodeck. Missing adapterFor method.");
 }
-
 /**
- * Creates an adapterFor function that wraps the provided adapterFor function
- * to override the adapter's _fetchRequest method to route requests through
- * the Holodeck mock server.
- *
- * @param owner - The test context object used to retrieve the test ID.
- */
+* Creates an adapterFor function that wraps the provided adapterFor function
+* to override the adapter's _fetchRequest method to route requests through
+* the Holodeck mock server.
+*
+* @param owner - The test context object used to retrieve the test ID.
+*/
 function installAdapterFor(owner, store) {
-  upgradeStore(store);
-  const fn = store.adapterFor;
-  function holodeckAdapterFor(modelName, _allowMissing) {
-    const adapter = fn.call(this, modelName, _allowMissing);
-    if (adapter) {
-      if (!adapter.hasOverriddenFetch) {
-        adapter.hasOverriddenFetch = true;
-        adapter.useFetch = true;
-        const originalFetch = adapter._fetchRequest?.bind(adapter);
-        adapter._fetchRequest = function (options) {
-          if (!originalFetch) {
-            throw new Error(`Adapter ${String(modelName)} does not implement _fetchRequest`);
-          }
-          const {
-            request
-          } = setupHolodeckFetch(owner, options);
-          return originalFetch(request);
-        };
-      }
-    }
-    return adapter;
-  }
-  store.adapterFor = holodeckAdapterFor;
+	upgradeStore(store);
+	const fn = store.adapterFor;
+	function holodeckAdapterFor(modelName, _allowMissing) {
+		const adapter = fn.call(this, modelName, _allowMissing);
+		if (adapter) {
+			if (!adapter.hasOverriddenFetch) {
+				adapter.hasOverriddenFetch = true;
+				adapter.useFetch = true;
+				const originalFetch = adapter._fetchRequest?.bind(adapter);
+				adapter._fetchRequest = function(options) {
+					if (!originalFetch) throw new Error(`Adapter ${String(modelName)} does not implement _fetchRequest`);
+					const { request } = setupHolodeckFetch(owner, options);
+					return originalFetch(request);
+				};
+			}
+		}
+		return adapter;
+	}
+	store.adapterFor = holodeckAdapterFor;
 }
-
 /**
- * Mock a request by sending the scaffold to the mock server.
- *
- * @public
- */
+* Mock a request by sending the scaffold to the mock server.
+*
+* @public
+*/
 async function mock(owner, generate, isRecording) {
-  if (getIsRecording() || isRecording) {
-    const test = TEST_IDS.get(owner);
-    if (!test) {
-      throw new Error(`Cannot call "mock" before configuring a testId. Use setTestId to set the testId for each test`);
-    }
-    const requestToMock = generate();
-    const {
-      url: mockUrl,
-      method
-    } = requestToMock;
-    if (!mockUrl || !method) {
-      throw new Error(`MockError: Cannot mock a request without providing a URL and Method`);
-    }
-    const mockMethod = method?.toUpperCase() ?? 'GET';
-
-    // enable custom methods
-    if (!test.mock[mockMethod]) {
-      // eslint-disable-next-line no-console
-      console.log(`⚠️ Using custom HTTP method ${mockMethod} for response to request ${mockUrl}`);
-      test.mock[mockMethod] = {};
-    }
-    if (!(mockUrl in test.mock[mockMethod])) {
-      test.mock[mockMethod][mockUrl] = 0;
-    }
-    const testMockNum = test.mock[mockMethod][mockUrl]++;
-    const url = `${HOST}__record?__xTestId=${test.id}&__xTestRequestNumber=${testMockNum}`;
-    await fetch(url, {
-      method: 'POST',
-      body: JSON.stringify(requestToMock),
-      mode: 'cors',
-      credentials: 'omit',
-      referrerPolicy: ''
-    });
-  }
+	if (getIsRecording() || isRecording) {
+		const test = TEST_IDS.get(owner);
+		if (!test) throw new Error(`Cannot call "mock" before configuring a testId. Use setTestId to set the testId for each test`);
+		const requestToMock = generate();
+		const { url: mockUrl, method } = requestToMock;
+		if (!mockUrl || !method) throw new Error(`MockError: Cannot mock a request without providing a URL and Method`);
+		const mockMethod = method?.toUpperCase() ?? "GET";
+		if (!test.mock[mockMethod]) {
+			console.log(`⚠️ Using custom HTTP method ${mockMethod} for response to request ${mockUrl}`);
+			test.mock[mockMethod] = {};
+		}
+		if (!(mockUrl in test.mock[mockMethod])) test.mock[mockMethod][mockUrl] = 0;
+		const testMockNum = test.mock[mockMethod][mockUrl]++;
+		const url = `${HOST}__record?__xTestId=${test.id}&__xTestRequestNumber=${testMockNum}`;
+		await fetch(url, {
+			method: "POST",
+			body: JSON.stringify(requestToMock),
+			mode: "cors",
+			credentials: "omit",
+			referrerPolicy: ""
+		});
+	}
 }
 
+//#endregion
 export { MockServerHandler, getIsRecording, installAdapterFor, mock, setConfig, setIsRecording, setTestId };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["getGlobalConfig","macroCondition","TEST_IDS","WeakMap","HOST","setConfig","host","endsWith","setTestId","context","str","has","Error","set","id","mock","GET","PUT","PATCH","DELETE","POST","QUERY","OPTIONS","HEAD","CONNECT","TRACE","request","delete","shouldRecord","WarpDrive","env","SHOULD_RECORD","IS_RECORDING","setIsRecording","value","Boolean","getIsRecording","MockServerHandler","constructor","owner","next","queryForTest","setupHolodeckFetch","Object","assign","future","setStream","getStream","e","DOMException","message","replace","test","get","url","firstChar","includes","method","toUpperCase","console","log","mode","credentials","referrerPolicy","headers","Headers","upgradeAdapter","adapter","upgradeStore","store","adapterFor","installAdapterFor","fn","holodeckAdapterFor","modelName","_allowMissing","call","hasOverriddenFetch","useFetch","originalFetch","_fetchRequest","bind","options","String","generate","isRecording","requestToMock","mockUrl","mockMethod","testMockNum","fetch","body","JSON","stringify"],"sources":["../src/index.ts"],"sourcesContent":["/**\n * @module\n * @mergeModuleWith <project>\n */\nimport { SHOULD_RECORD } from '@warp-drive/core/build-config/env';\nimport type { Handler, NextFn } from '@warp-drive/core/request';\nimport type { HTTPMethod, RequestContext, RequestInfo, StructuredDataDocument } from '@warp-drive/core/types/request';\nimport type { MinimumAdapterInterface } from '@warp-drive/legacy/compat';\nimport type { Store } from '@warp-drive/legacy/store';\n\nimport type { ScaffoldGenerator } from './mock';\n\nconst TEST_IDS = new WeakMap<\n  object,\n  {\n    id: string;\n    /**\n     * keeps track of the count of calls to record a mock\n     */\n    mock: {\n      /**\n       * For each GET, we keep track of the count\n       * for a specific URL\n       */\n      GET: Record<string, number>;\n      /**\n       * For each PUT, we keep track of the count\n       * for a specific URL\n       */\n      PUT: Record<string, number>;\n      /**\n       * For each PATCH, we keep track of the count\n       * for a specific URL\n       */\n      PATCH: Record<string, number>;\n      /**\n       * For each DELETE, we keep track of the count\n       * for a specific URL\n       */\n      DELETE: Record<string, number>;\n      /**\n       * For each POST, we keep track of the count\n       * for a specific URL\n       */\n      POST: Record<string, number>;\n      /**\n       * For each OPTIONS, we keep track of the count\n       * for a specific URL\n       */\n      OPTIONS: Record<string, number>;\n      /**\n       * For each QUERY, we keep track of the count\n       * for a specific URL\n       */\n      QUERY: Record<string, number>;\n      /**\n       * for each HEAD, we keep track of the count\n       * for a specific URL\n       */\n      HEAD: Record<string, number>;\n      /**\n       * for each CONNECT, we keep track of the count\n       * for a specific URL\n       */\n      CONNECT: Record<string, number>;\n      /**\n       * for each TRACE, we keep track of the count\n       * for a specific URL\n       */\n      TRACE: Record<string, number>;\n    };\n    /**\n     * keeps track of the count of calls to make a request\n     */\n    request: {\n      /**\n       * For each GET, we keep track of the count\n       * for a specific URL\n       */\n      GET: Record<string, number>;\n      /**\n       * For each PUT, we keep track of the count\n       * for a specific URL\n       */\n      PUT: Record<string, number>;\n      /**\n       * For each PATCH, we keep track of the count\n       * for a specific URL\n       */\n      PATCH: Record<string, number>;\n      /**\n       * For each DELETE, we keep track of the count\n       * for a specific URL\n       */\n      DELETE: Record<string, number>;\n      /**\n       * For each POST, we keep track of the count\n       * for a specific URL\n       */\n      POST: Record<string, number>;\n      /**\n       * For each OPTIONS, we keep track of the count\n       * for a specific URL\n       */\n      OPTIONS: Record<string, number>;\n      /**\n       * For each QUERY, we keep track of the count\n       * for a specific URL\n       */\n      QUERY: Record<string, number>;\n      /**\n       * for each HEAD, we keep track of the count\n       * for a specific URL\n       */\n      HEAD: Record<string, number>;\n      /**\n       * for each CONNECT, we keep track of the count\n       * for a specific URL\n       */\n      CONNECT: Record<string, number>;\n      /**\n       * for each TRACE, we keep track of the count\n       * for a specific URL\n       */\n      TRACE: Record<string, number>;\n    };\n  }\n>();\n\nlet HOST = '/';\n\n/**\n * @public\n */\n\nexport function setConfig({ host }: { host: string }): void {\n  HOST = host.endsWith('/') ? host : `${host}/`;\n}\n\n/**\n * @public\n */\n\nexport function setTestId(context: object, str: string | null): void {\n  if (str && TEST_IDS.has(context)) {\n    throw new Error(`MockServerHandler is already configured with a testId.`);\n  }\n  if (str) {\n    TEST_IDS.set(context, {\n      id: str,\n      mock: {\n        GET: {},\n        PUT: {},\n        PATCH: {},\n        DELETE: {},\n        POST: {},\n        QUERY: {},\n        OPTIONS: {},\n        HEAD: {},\n        CONNECT: {},\n        TRACE: {},\n      },\n      request: {\n        GET: {},\n        PUT: {},\n        PATCH: {},\n        DELETE: {},\n        POST: {},\n        QUERY: {},\n        OPTIONS: {},\n        HEAD: {},\n        CONNECT: {},\n        TRACE: {},\n      },\n    });\n  } else {\n    TEST_IDS.delete(context);\n  }\n}\n\nconst shouldRecord = SHOULD_RECORD ? true : false;\nlet IS_RECORDING: boolean | null = null;\n\n/**\n * @public\n */\nexport function setIsRecording(value: boolean): void {\n  IS_RECORDING = value === null ? value : Boolean(value);\n}\n\n/**\n * @public\n */\nexport function getIsRecording(): boolean {\n  return IS_RECORDING === null ? shouldRecord : IS_RECORDING;\n}\n\n/**\n * A request handler that intercepts requests and routes them through\n * the Holodeck mock server.\n *\n * This handler modifies the request URL to include test identifiers\n * and manages request counts for accurate mocking.\n *\n * Requires that the test context be configured with a testId using `setTestId`.\n *\n * @param owner - the test context object used to retrieve the test ID.\n */\nexport class MockServerHandler implements Handler {\n  declare owner: object;\n  constructor(owner: object) {\n    this.owner = owner;\n  }\n  async request<T>(context: RequestContext, next: NextFn<T>): Promise<StructuredDataDocument<T>> {\n    const { request, queryForTest } = setupHolodeckFetch(this.owner, Object.assign({}, context.request));\n\n    try {\n      const future = next(request);\n      context.setStream(future.getStream());\n      return await future;\n    } catch (e) {\n      if (e instanceof Error && !(e instanceof DOMException)) {\n        e.message = e.message.replace(queryForTest, '');\n      }\n      throw e;\n    }\n  }\n}\n\nfunction setupHolodeckFetch(owner: object, request: RequestInfo): { request: RequestInfo; queryForTest: string } {\n  const test = TEST_IDS.get(owner);\n  if (!test) {\n    throw new Error(`MockServerHandler is not configured with a testId. Use setTestId to set the testId for each test`);\n  }\n\n  const url = request.url!;\n  const firstChar = url.includes('?') ? '&' : '?';\n  const method = (request.method?.toUpperCase() ?? 'GET') as HTTPMethod;\n\n  // enable custom methods\n  if (!test.request[method]) {\n    // oxlint-disable-next-line no-console\n    console.log(`⚠️ Using custom HTTP method ${method} for response to request ${url}`);\n\n    test.request[method] = {};\n  }\n  if (!(url in test.request[method])) {\n    test.request[method][url] = 0;\n  }\n\n  const queryForTest = `${firstChar}__xTestId=${test.id}&__xTestRequestNumber=${test.request[method][url]++}`;\n  request.url = url + queryForTest;\n  request.method = method;\n\n  request.mode = 'cors';\n  request.credentials = 'omit';\n  request.referrerPolicy = '';\n\n  // since holodeck currently runs on a separate port\n  // and we don't want to trigger cors pre-flight\n  // we convert PUT to POST to keep the request in the\n  // \"simple\" cors category.\n  // if (request.method === 'PUT') {\n  //   request.method = 'POST';\n  // }\n\n  const headers = new Headers(request.headers);\n  if (headers.has('Content-Type')) {\n    // under the rules of simple-cors, content-type can only be\n    // one of three things, none of which are what folks typically\n    // set this to. Since holodeck always expects body to be JSON\n    // this \"just works\".\n    headers.set('Content-Type', 'text/plain');\n    request.headers = headers;\n  }\n\n  return { request, queryForTest };\n}\n\ninterface HasAdapterForFn {\n  adapterFor(this: Store, modelName: string): MinimumAdapterInterface;\n  adapterFor(this: Store, modelName: string, _allowMissing?: true): MinimumAdapterInterface | undefined;\n}\n\n/*\n  _fetchRequest(options: FetchRequestInit): Promise<Response> {\n    const fetchFunction = fetch();\n\n    return fetchFunction(options.url, options);\n  }\n*/\ninterface PrivateAdapter {\n  _fetchRequest(options: RequestInfo): Promise<Response>;\n  hasOverriddenFetch: boolean;\n  useFetch: boolean;\n}\n\nfunction upgradeAdapter(adapter: unknown): asserts adapter is PrivateAdapter {}\nfunction upgradeStore(store: Store): asserts store is Store & { adapterFor: HasAdapterForFn['adapterFor'] } {\n  if (typeof store.adapterFor !== 'function') {\n    throw new Error('Store is not compatible with Holodeck. Missing adapterFor method.');\n  }\n}\n\n/**\n * Creates an adapterFor function that wraps the provided adapterFor function\n * to override the adapter's _fetchRequest method to route requests through\n * the Holodeck mock server.\n *\n * @param owner - The test context object used to retrieve the test ID.\n */\nexport function installAdapterFor(owner: object, store: Store): void {\n  upgradeStore(store);\n  const fn = store.adapterFor;\n  function holodeckAdapterFor(\n    this: Store,\n    modelName: string,\n    _allowMissing?: true\n  ): MinimumAdapterInterface | undefined {\n    const adapter = fn.call(this, modelName, _allowMissing);\n\n    if (adapter) {\n      upgradeAdapter(adapter);\n\n      if (!adapter.hasOverriddenFetch) {\n        adapter.hasOverriddenFetch = true;\n        adapter.useFetch = true;\n        const originalFetch = adapter._fetchRequest?.bind(adapter);\n\n        adapter._fetchRequest = function (options: RequestInfo) {\n          if (!originalFetch) {\n            throw new Error(`Adapter ${String(modelName)} does not implement _fetchRequest`);\n          }\n          const { request } = setupHolodeckFetch(owner, options);\n\n          return originalFetch(request);\n        };\n      }\n    }\n\n    return adapter;\n  }\n  store.adapterFor = holodeckAdapterFor as HasAdapterForFn['adapterFor'];\n}\n\n/**\n * Mock a request by sending the scaffold to the mock server.\n *\n * @public\n */\nexport async function mock(owner: object, generate: ScaffoldGenerator, isRecording?: boolean): Promise<void> {\n  if (getIsRecording() || isRecording) {\n    const test = TEST_IDS.get(owner);\n    if (!test) {\n      throw new Error(`Cannot call \"mock\" before configuring a testId. Use setTestId to set the testId for each test`);\n    }\n    const requestToMock = generate();\n    const { url: mockUrl, method } = requestToMock;\n    if (!mockUrl || !method) {\n      throw new Error(`MockError: Cannot mock a request without providing a URL and Method`);\n    }\n    const mockMethod = (method?.toUpperCase() ?? 'GET') as HTTPMethod;\n\n    // enable custom methods\n    if (!test.mock[mockMethod]) {\n      // oxlint-disable-next-line no-console\n      console.log(`⚠️ Using custom HTTP method ${mockMethod} for response to request ${mockUrl}`);\n      test.mock[mockMethod] = {};\n    }\n    if (!(mockUrl in test.mock[mockMethod])) {\n      test.mock[mockMethod][mockUrl] = 0;\n    }\n    const testMockNum = test.mock[mockMethod][mockUrl]++;\n    const url = `${HOST}__record?__xTestId=${test.id}&__xTestRequestNumber=${testMockNum}`;\n    await fetch(url, {\n      method: 'POST',\n      body: JSON.stringify(requestToMock),\n      mode: 'cors',\n      credentials: 'omit',\n      referrerPolicy: '',\n    });\n  }\n}\n"],"mappings":";;;;;;;AAYA,MAAME,2BAAW,IAAIC,QAmHnB;AAEF,IAAIC,OAAO;;;;AAMX,SAAgBC,UAAU,EAAEC,QAAgC;CAC1DF,OAAOE,KAAKC,SAAS,GAAG,IAAID,OAAO,GAAGA,KAAI;AAC5C;;;;AAMA,SAAgBE,UAAUC,SAAiBC,KAA0B;CACnE,IAAIA,OAAOR,SAASS,IAAIF,OAAO,GAC7B,MAAM,IAAIG,MAAM,wDAAwD;CAE1E,IAAIF,KACFR,SAASW,IAAIJ,SAAS;EACpBK,IAAIJ;EACJK,MAAM;GACJC,KAAK,CAAC;GACNC,KAAK,CAAC;GACNC,OAAO,CAAC;GACRC,QAAQ,CAAC;GACTC,MAAM,CAAC;GACPC,OAAO,CAAC;GACRC,SAAS,CAAC;GACVC,MAAM,CAAC;GACPC,SAAS,CAAC;GACVC,OAAO,CAAC;EACV;EACAC,SAAS;GACPV,KAAK,CAAC;GACNC,KAAK,CAAC;GACNC,OAAO,CAAC;GACRC,QAAQ,CAAC;GACTC,MAAM,CAAC;GACPC,OAAO,CAAC;GACRC,SAAS,CAAC;GACVC,MAAM,CAAC;GACPC,SAAS,CAAC;GACVC,OAAO,CAAC;EACV;CACF,CAAC;MAEDvB,SAASyB,OAAOlB,OAAO;AAE3B;AAEA,MAAMmB,eAAe3B,eAAAD,gBAAA,CAAA,CAAA6B,UAAAC,IAAAC,aAAA,IAAgB,OAAO;AAC5C,IAAIC,eAA+B;;;;AAKnC,SAAgBC,eAAeC,OAAsB;CACnDF,eAAeE,UAAU,OAAOA,QAAQC,QAAQD,KAAK;AACvD;;;;AAKA,SAAgBE,iBAA0B;CACxC,OAAOJ,iBAAiB,OAAOJ,eAAeI;AAChD;;;;;;;;;;;;AAaA,IAAaK,oBAAb,MAAkD;CAEhDC,YAAYC,OAAe;EACzB,KAAKA,QAAQA;CACf;CACA,MAAMb,QAAWjB,SAAyB+B,MAAqD;EAC7F,MAAM,EAAEd,SAASe,iBAAiBC,mBAAmB,KAAKH,OAAOI,OAAOC,OAAO,CAAC,GAAGnC,QAAQiB,OAAO,CAAC;EAEnG,IAAI;GACF,MAAMmB,SAASL,KAAKd,OAAO;GAC3BjB,QAAQqC,UAAUD,OAAOE,UAAU,CAAC;GACpC,OAAO,MAAMF;EACf,SAASG,GAAG;GACV,IAAIA,aAAapC,SAAS,EAAEoC,aAAaC,eACvCD,EAAEE,UAAUF,EAAEE,QAAQC,QAAQV,cAAc,EAAE;GAEhD,MAAMO;EACR;CACF;AACF;AAEA,SAASN,mBAAmBH,OAAeb,SAAsE;CAC/G,MAAM0B,OAAOlD,SAASmD,IAAId,KAAK;CAC/B,IAAI,CAACa,MACH,MAAM,IAAIxC,MAAM,kGAAkG;CAGpH,MAAM0C,MAAM5B,QAAQ4B;CACpB,MAAMC,YAAYD,IAAIE,SAAS,GAAG,IAAI,MAAM;CAC5C,MAAMC,SAAU/B,QAAQ+B,QAAQC,YAAY,KAAK;CAGjD,IAAI,CAACN,KAAK1B,QAAQ+B,SAAS;EAEzBE,QAAQC,IAAI,+BAA+BH,OAAM,2BAA4BH,KAAK;EAElFF,KAAK1B,QAAQ+B,UAAU,CAAC;CAC1B;CACA,IAAI,EAAEH,OAAOF,KAAK1B,QAAQ+B,UACxBL,KAAK1B,QAAQ+B,OAAO,CAACH,OAAO;CAG9B,MAAMb,eAAe,GAAGc,UAAS,YAAaH,KAAKtC,GAAE,wBAAyBsC,KAAK1B,QAAQ+B,OAAO,CAACH,IAAI;CACvG5B,QAAQ4B,MAAMA,MAAMb;CACpBf,QAAQ+B,SAASA;CAEjB/B,QAAQmC,OAAO;CACfnC,QAAQoC,cAAc;CACtBpC,QAAQqC,iBAAiB;CAUzB,MAAMC,UAAU,IAAIC,QAAQvC,QAAQsC,OAAO;CAC3C,IAAIA,QAAQrD,IAAI,cAAc,GAAG;EAK/BqD,QAAQnD,IAAI,gBAAgB,YAAY;EACxCa,QAAQsC,UAAUA;CACpB;CAEA,OAAO;EAAEtC;EAASe;CAAa;AACjC;AAqBA,SAAS2B,aAAaC,OAAsF;CAC1G,IAAI,OAAOA,MAAMC,eAAe,YAC9B,MAAM,IAAI1D,MAAM,mEAAmE;AAEvF;;;;;;;;AASA,SAAgB2D,kBAAkBhC,OAAe8B,OAAoB;CACnED,aAAaC,KAAK;CAClB,MAAMG,KAAKH,MAAMC;CACjB,SAASG,mBAEPC,WACAC,eACqC;EACrC,MAAMR,UAAUK,GAAGI,KAAK,MAAMF,WAAWC,aAAa;EAEtD,IAAIR,SAGF;OAAI,CAACA,QAAQU,oBAAoB;IAC/BV,QAAQU,qBAAqB;IAC7BV,QAAQW,WAAW;IACnB,MAAMC,gBAAgBZ,QAAQa,eAAeC,KAAKd,OAAO;IAEzDA,QAAQa,gBAAgB,SAAUE,SAAsB;KACtD,IAAI,CAACH,eACH,MAAM,IAAInE,MAAM,WAAWuE,OAAOT,SAAS,EAAC,kCAAmC;KAEjF,MAAM,EAAEhD,YAAYgB,mBAAmBH,OAAO2C,OAAO;KAErD,OAAOH,cAAcrD,OAAO;IAC9B;GACF;;EAGF,OAAOyC;CACT;CACAE,MAAMC,aAAaG;AACrB;;;;;;AAOA,eAAsB1D,KAAKwB,OAAe6C,UAA6BC,aAAsC;CAC3G,IAAIjD,eAAe,KAAKiD,aAAa;EACnC,MAAMjC,OAAOlD,SAASmD,IAAId,KAAK;EAC/B,IAAI,CAACa,MACH,MAAM,IAAIxC,MAAM,+FAA+F;EAEjH,MAAM0E,gBAAgBF,SAAS;EAC/B,MAAM,EAAE9B,KAAKiC,SAAS9B,WAAW6B;EACjC,IAAI,CAACC,WAAW,CAAC9B,QACf,MAAM,IAAI7C,MAAM,qEAAqE;EAEvF,MAAM4E,aAAc/B,QAAQC,YAAY,KAAK;EAG7C,IAAI,CAACN,KAAKrC,KAAKyE,aAAa;GAE1B7B,QAAQC,IAAI,+BAA+B4B,WAAU,2BAA4BD,SAAS;GAC1FnC,KAAKrC,KAAKyE,cAAc,CAAC;EAC3B;EACA,IAAI,EAAED,WAAWnC,KAAKrC,KAAKyE,cACzBpC,KAAKrC,KAAKyE,WAAW,CAACD,WAAW;EAEnC,MAAME,cAAcrC,KAAKrC,KAAKyE,WAAW,CAACD,QAAQ;EAClD,MAAMjC,MAAM,GAAGlD,KAAI,qBAAsBgD,KAAKtC,GAAE,wBAAyB2E;EACzE,MAAMC,MAAMpC,KAAK;GACfG,QAAQ;GACRkC,MAAMC,KAAKC,UAAUP,aAAa;GAClCzB,MAAM;GACNC,aAAa;GACbC,gBAAgB;EAClB,CAAC;CACH;AACF"}