@warp-drive/holodeck 0.1.0-alpha.13 → 0.1.0-alpha.14

package/declarations/index.d.ts

@@ -3,21 +3,56 @@ import type { RequestContext, StructuredDataDocument } from "@warp-drive/core/ty
 import type { MinimumAdapterInterface } from "@warp-drive/legacy/compat";
 import type { Store } from "@warp-drive/legacy/store";
 import type { ScaffoldGenerator } from "./mock.js";
+/**
+* @public
+*/
 export declare function setConfig({ host }: {
 	host: string;
 }): void;
+/**
+* @public
+*/
 export declare function setTestId(context: object, str: string | null): void;
+/**
+* @public
+*/
 export declare function setIsRecording(value: boolean): void;
+/**
+* @public
+*/
 export 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.
+*/
 export declare class MockServerHandler implements Handler {
 	owner: object;
 	constructor(owner: object);
 	request<T>(context: RequestContext, next: NextFn<T>): Promise<StructuredDataDocument<T>>;
 }
-interface AdapterForFn {
+interface HasAdapterForFn {
 	adapterFor(this: Store, modelName: string): MinimumAdapterInterface;
 	adapterFor(this: Store, modelName: string, _allowMissing?: true): MinimumAdapterInterface | undefined;
 }
-export declare function createAdapterFor(owner: object, fn: AdapterForFn): AdapterForFn;
+/**
+* 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.
+*/
+export declare function createAdapterFor(owner: object, store: HasAdapterForFn): HasAdapterForFn["adapterFor"];
+/**
+* Mock a request by sending the scaffold to the mock server.
+*
+* @public
+*/
 export declare function mock(owner: object, generate: ScaffoldGenerator, isRecording?: boolean): Promise<void>;
 export {};

package/declarations/mock.d.ts

@@ -1,3 +1,6 @@
+/**
+* @public
+*/
 export interface Scaffold {
 	status: number;
 	statusText?: string;
@@ -7,7 +10,13 @@ export interface Scaffold {
 	url: string;
 	response: Record<string, unknown>;
 }
+/**
+* @public
+*/
 export type ScaffoldGenerator = () => Scaffold;
+/**
+* @public
+*/
 export type ResponseGenerator = () => Record<string, unknown>;
 /**
 * Sets up Mocking for a GET request on the mock server
@@ -29,15 +38,28 @@ export type ResponseGenerator = () => Record<string, unknown>;
 export declare function GET(owner: object, url: string, response: ResponseGenerator, options?: Partial<Omit<Scaffold, "response" | "url" | "method">> & {
 	RECORD?: boolean;
 }): Promise<void>;
+/**
+* Mock a POST request
+*/
 export declare function POST(owner: object, url: string, response: ResponseGenerator, options?: Partial<Omit<Scaffold, "response" | "url" | "method">> & {
 	RECORD?: boolean;
 }): Promise<void>;
+/**
+* mock a PUT request
+*/
 export declare function PUT(owner: object, url: string, response: ResponseGenerator, options?: Partial<Omit<Scaffold, "response" | "url" | "method">> & {
 	RECORD?: boolean;
 }): Promise<void>;
+/**
+* mock a PATCH request
+*
+*/
 export declare function PATCH(owner: object, url: string, response: ResponseGenerator, options?: Partial<Omit<Scaffold, "response" | "url" | "method">> & {
 	RECORD?: boolean;
 }): Promise<void>;
+/**
+* mock a DELETE request
+*/
 export declare function DELETE(owner: object, url: string, response: ResponseGenerator, options?: Partial<Omit<Scaffold, "response" | "url" | "method">> & {
 	RECORD?: boolean;
 }): Promise<void>;

package/dist/index.js

@@ -1,12 +1,26 @@
 import { SHOULD_RECORD } from '@warp-drive/core/build-config/env';
 
+/**
+ * @module
+ * @mergeModuleWith <project>
+ */
 const TEST_IDS = new WeakMap();
 let HOST = 'https://localhost:1135/';
+
+/**
+ * @public
+ */
+
 function setConfig({
   host
 }) {
   HOST = host.endsWith('/') ? host : `${host}/`;
 }
+
+/**
+ * @public
+ */
+
 function setTestId(context, str) {
   if (str && TEST_IDS.has(context)) {
     throw new Error(`MockServerHandler is already configured with a testId.`);
@@ -45,12 +59,32 @@ function setTestId(context, str) {
 }
 const shouldRecord = SHOULD_RECORD ? true : false;
 let IS_RECORDING = null;
+
+/**
+ * @public
+ */
 function setIsRecording(value) {
   IS_RECORDING = value === null ? value : Boolean(value);
 }
+
+/**
+ * @public
+ */
 function getIsRecording() {
   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;
@@ -100,9 +134,19 @@ function setupHolodeckFetch(owner, request) {
     queryForTest
   };
 }
-function createAdapterFor(owner, fn) {
+
+/**
+ * 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 createAdapterFor(owner, store) {
+  // eslint-disable-next-line @typescript-eslint/unbound-method
+  const adapterFor = store.adapterFor;
   return function holodeckAdapterFor(modelName, _allowMissing) {
-    const adapter = fn.adapterFor.call(this, modelName, _allowMissing);
+    const adapter = adapterFor.call(this, modelName, _allowMissing);
     if (adapter) {
       if (!adapter.hasOverriddenFetch) {
         adapter.hasOverriddenFetch = true;
@@ -122,6 +166,12 @@ function createAdapterFor(owner, fn) {
     return adapter;
   };
 }
+
+/**
+ * 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);

package/dist/mock.js

@@ -1,5 +1,17 @@
 import { mock, getIsRecording } from './index.js';
 
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+
 /**
  * Sets up Mocking for a GET request on the mock server
  * for the supplied url.
@@ -29,6 +41,10 @@ function GET(owner, url, response, options) {
   }), getIsRecording() || (options?.RECORD ?? false));
 }
 const STATUS_TEXT_FOR = new Map([[200, 'OK'], [201, 'Created'], [202, 'Accepted'], [203, 'Non-Authoritative Information'], [204, 'No Content'], [205, 'Reset Content'], [206, 'Partial Content'], [207, 'Multi-Status'], [208, 'Already Reported'], [226, 'IM Used'], [300, 'Multiple Choices'], [301, 'Moved Permanently'], [302, 'Found'], [303, 'See Other'], [304, 'Not Modified'], [307, 'Temporary Redirect'], [308, 'Permanent Redirect'], [400, 'Bad Request'], [401, 'Unauthorized'], [402, 'Payment Required'], [403, 'Forbidden'], [404, 'Not Found'], [405, 'Method Not Allowed'], [406, 'Not Acceptable'], [407, 'Proxy Authentication Required'], [408, 'Request Timeout'], [409, 'Conflict'], [410, 'Gone'], [411, 'Length Required'], [412, 'Precondition Failed'], [413, 'Payload Too Large'], [414, 'URI Too Long'], [415, 'Unsupported Media Type'], [416, 'Range Not Satisfiable'], [417, 'Expectation Failed'], [419, 'Page Expired'], [420, 'Enhance Your Calm'], [421, 'Misdirected Request'], [422, 'Unprocessable Entity'], [423, 'Locked'], [424, 'Failed Dependency'], [425, 'Too Early'], [426, 'Upgrade Required'], [428, 'Precondition Required'], [429, 'Too Many Requests'], [430, 'Request Header Fields Too Large'], [431, 'Request Header Fields Too Large'], [450, 'Blocked By Windows Parental Controls'], [451, 'Unavailable For Legal Reasons'], [500, 'Internal Server Error'], [501, 'Not Implemented'], [502, 'Bad Gateway'], [503, 'Service Unavailable'], [504, 'Gateway Timeout'], [505, 'HTTP Version Not Supported'], [506, 'Variant Also Negotiates'], [507, 'Insufficient Storage'], [508, 'Loop Detected'], [509, 'Bandwidth Limit Exceeded'], [510, 'Not Extended'], [511, 'Network Authentication Required']]);
+
+/**
+ * Mock a POST request
+ */
 function POST(owner, url, response, options) {
   return mock(owner, () => {
     const body = response();
@@ -44,6 +60,10 @@ function POST(owner, url, response, options) {
     };
   }, getIsRecording() || (options?.RECORD ?? false));
 }
+
+/**
+ * mock a PUT request
+ */
 function PUT(owner, url, response, options) {
   return mock(owner, () => {
     const body = response();
@@ -59,6 +79,10 @@ function PUT(owner, url, response, options) {
     };
   }, getIsRecording() || (options?.RECORD ?? false));
 }
+/**
+ * mock a PATCH request
+ *
+ */
 function PATCH(owner, url, response, options) {
   return mock(owner, () => {
     const body = response();
@@ -74,6 +98,9 @@ function PATCH(owner, url, response, options) {
     };
   }, getIsRecording() || (options?.RECORD ?? false));
 }
+/**
+ * mock a DELETE request
+ */
 function DELETE(owner, url, response, options) {
   return mock(owner, () => {
     const body = response();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@warp-drive/holodeck",
   "description": "⚡️ Simple, Fast HTTP Mocking for Tests",
-  "version": "0.1.0-alpha.13",
+  "version": "0.1.0-alpha.14",
   "license": "MIT",
   "author": "Chris Thoburn <runspired@users.noreply.github.com>",
   "repository": {
@@ -39,9 +39,9 @@
     "ensure-cert": "./server/ensure-cert.js"
   },
   "peerDependencies": {
-    "@warp-drive/utilities": "5.8.0-alpha.13",
-    "@warp-drive/legacy": "5.8.0-alpha.13",
-    "@warp-drive/core": "5.8.0-alpha.13"
+    "@warp-drive/utilities": "5.8.0-alpha.14",
+    "@warp-drive/legacy": "5.8.0-alpha.14",
+    "@warp-drive/core": "5.8.0-alpha.14"
   },
   "peerDependenciesMeta": {
     "@warp-drive/utilities": {
@@ -57,10 +57,10 @@
     "@babel/preset-env": "^7.28.3",
     "@babel/preset-typescript": "^7.27.1",
     "@babel/runtime": "^7.28.3",
-    "@warp-drive/utilities": "5.8.0-alpha.13",
-    "@warp-drive/legacy": "5.8.0-alpha.13",
-    "@warp-drive/core": "5.8.0-alpha.13",
-    "@warp-drive/internal-config": "5.8.0-alpha.13",
+    "@warp-drive/utilities": "5.8.0-alpha.14",
+    "@warp-drive/legacy": "5.8.0-alpha.14",
+    "@warp-drive/core": "5.8.0-alpha.14",
+    "@warp-drive/internal-config": "5.8.0-alpha.14",
     "vite": "^7.1.3"
   },
   "exports": {

package/server/ensure-cert.js

@@ -11,6 +11,10 @@ function getShellConfigFilePath() {
       return path.join(homedir(), '.zshrc');
     case '/bin/bash':
       return path.join(homedir(), '.bashrc');
+    case '/opt/homebrew/bin/fish':
+    case '/usr/local/bin/fish':
+    case '/bin/fish':
+      return path.join(homedir(), '.config', 'fish', 'config.fish');
     default:
       throw Error(
         `Unable to determine configuration file for shell: ${shell}. Manual SSL Cert Setup Required for Holodeck.`