@zimic/interceptor 0.19.1-canary.3 → 0.19.1-canary.5

package/dist/server.d.ts

@@ -12,93 +12,36 @@ declare class NotRunningInterceptorServerError extends Error {
     constructor();
 }
 
-/**
- * The options to create an {@link https://zimic.dev/docs/interceptor/cli/server interceptor server}.
- *
- * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
- */
+/** @see {@link https://zimic.dev/docs/interceptor/api/create-interceptor-server `createInterceptorServer` API reference} */
 interface InterceptorServerOptions {
-    /**
-     * The hostname to start the server on.
-     *
-     * @default localhost
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/create-interceptor-server `createInterceptorServer` API reference} */
     hostname?: string;
-    /** The port to start the server on. If no port is provided, a random one is chosen. */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/create-interceptor-server `createInterceptorServer` API reference} */
     port?: number;
-    /**
-     * Whether to log warnings about unhandled requests to the console.
-     *
-     * @default true
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/create-interceptor-server `createInterceptorServer` API reference} */
     logUnhandledRequests?: boolean;
-    /**
-     * The directory where the authorized interceptor authentication tokens are saved. If provided, only remote
-     * interceptors bearing a valid token will be accepted. This option is essential if you are exposing your interceptor
-     * server publicly. For local development and testing, though, `--tokens-dir` is optional.
-     *
-     * @default undefined
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/create-interceptor-server `createInterceptorServer` API reference} */
     tokensDirectory?: string;
 }
 
-/**
- * A server to intercept and handle requests. It is used in combination with
- * {@link https://zimic.dev/docs/interceptor/guides/http/remote-interceptors remote interceptors}.
- *
- * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
- */
+/** @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference} */
 interface InterceptorServer {
-    /**
-     * The hostname of the server. It can be reassigned to a new value if the server is not running.
-     *
-     * @throws {RunningInterceptorServerError} When trying to reassign a new hostname with the server still running.
-     * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference} */
     hostname: string;
-    /**
-     * The port of the server. It can be reassigned to a new value if the server is not running.
-     *
-     * @throws {RunningInterceptorServerError} When trying to reassign a new port with the server still running.
-     * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference} */
     port: number | undefined;
-    /**
-     * Whether to log warnings about unhandled requests to the console.
-     *
-     * @default true
-     * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference} */
     logUnhandledRequests: boolean;
-    /**
-     * The directory where the authorized interceptor authentication tokens are saved. If provided, only remote
-     * interceptors bearing a valid token will be accepted. This option is essential if you are exposing your interceptor
-     * server publicly. For local development and testing, though, `--tokens-dir` is optional.
-     *
-     * @default undefined
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference} */
     tokensDirectory?: string;
     /**
-     * Whether the server is running.
-     *
      * @readonly
-     * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
+     * @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference}
      */
     get isRunning(): boolean;
-    /**
-     * Starts the server.
-     *
-     * The server is automatically stopped if a process exit event is detected, such as SIGINT, SIGTERM, or an uncaught
-     * exception.
-     *
-     * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference} */
     start: () => Promise<void>;
-    /**
-     * Stops the server.
-     *
-     * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
-     */
+    /** @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference} */
     stop: () => Promise<void>;
 }
 
@@ -113,14 +56,7 @@ declare const DEFAULT_ACCESS_CONTROL_HEADERS: Readonly<{
 /** The default status code for the preflight request. */
 declare const DEFAULT_PREFLIGHT_STATUS_CODE = 204;
 
-/**
- * Creates an {@link https://zimic.dev/docs/interceptor/cli/server interceptor server}.
- *
- * @param options The options to create the server.
- * @returns The created server.
- * @see {@link https://zimic.dev/docs/interceptor/cli/server-programmatic-usage `zimic-interceptor server` programmatic usage}
- * @see {@link https://zimic.dev/docs/interceptor/guides/http/remote-interceptors Remote HTTP Interceptors} .
- */
+/** @see {@link https://zimic.dev/docs/interceptor/api/create-interceptor-server `createInterceptorServer` API reference} */
 declare function createInterceptorServer(options?: InterceptorServerOptions): InterceptorServer;
 
 export { DEFAULT_ACCESS_CONTROL_HEADERS, DEFAULT_PREFLIGHT_STATUS_CODE, type InterceptorServer, type InterceptorServerOptions, NotRunningInterceptorServerError, RunningInterceptorServerError, createInterceptorServer };

package/dist/server.js

@@ -1,29 +1,29 @@
 'use strict';
 
-var chunkQB2A2272_js = require('./chunk-QB2A2272.js');
+var chunkPKURIUS2_js = require('./chunk-PKURIUS2.js');
 require('./chunk-WCQVDF3K.js');
 
 
 
 Object.defineProperty(exports, "DEFAULT_ACCESS_CONTROL_HEADERS", {
   enumerable: true,
-  get: function () { return chunkQB2A2272_js.DEFAULT_ACCESS_CONTROL_HEADERS; }
+  get: function () { return chunkPKURIUS2_js.DEFAULT_ACCESS_CONTROL_HEADERS; }
 });
 Object.defineProperty(exports, "DEFAULT_PREFLIGHT_STATUS_CODE", {
   enumerable: true,
-  get: function () { return chunkQB2A2272_js.DEFAULT_PREFLIGHT_STATUS_CODE; }
+  get: function () { return chunkPKURIUS2_js.DEFAULT_PREFLIGHT_STATUS_CODE; }
 });
 Object.defineProperty(exports, "NotRunningInterceptorServerError", {
   enumerable: true,
-  get: function () { return chunkQB2A2272_js.NotRunningInterceptorServerError_default; }
+  get: function () { return chunkPKURIUS2_js.NotRunningInterceptorServerError_default; }
 });
 Object.defineProperty(exports, "RunningInterceptorServerError", {
   enumerable: true,
-  get: function () { return chunkQB2A2272_js.RunningInterceptorServerError_default; }
+  get: function () { return chunkPKURIUS2_js.RunningInterceptorServerError_default; }
 });
 Object.defineProperty(exports, "createInterceptorServer", {
   enumerable: true,
-  get: function () { return chunkQB2A2272_js.createInterceptorServer; }
+  get: function () { return chunkPKURIUS2_js.createInterceptorServer; }
 });
 //# sourceMappingURL=server.js.map
 //# sourceMappingURL=server.js.map

package/dist/server.mjs

@@ -1,4 +1,4 @@
-export { DEFAULT_ACCESS_CONTROL_HEADERS, DEFAULT_PREFLIGHT_STATUS_CODE, NotRunningInterceptorServerError_default as NotRunningInterceptorServerError, RunningInterceptorServerError_default as RunningInterceptorServerError, createInterceptorServer } from './chunk-7BR57OM2.mjs';
+export { DEFAULT_ACCESS_CONTROL_HEADERS, DEFAULT_PREFLIGHT_STATUS_CODE, NotRunningInterceptorServerError_default as NotRunningInterceptorServerError, RunningInterceptorServerError_default as RunningInterceptorServerError, createInterceptorServer } from './chunk-XBLRKSEM.mjs';
 import './chunk-CGILA3WO.mjs';
 //# sourceMappingURL=server.mjs.map
 //# sourceMappingURL=server.mjs.map

package/package.json

@@ -14,7 +14,7 @@
     "api",
     "static"
   ],
-  "version": "0.19.1-canary.3",
+  "version": "0.19.1-canary.5",
   "repository": {
     "type": "git",
     "url": "https://github.com/zimicjs/zimic.git",

package/src/http/interceptor/types/public.ts

@@ -35,6 +35,15 @@ export interface HttpInterceptor<_Schema extends HttpSchema> {
    */
   requestSaving: HttpInterceptorRequestSaving;
 
+  /**
+   * The strategy to use for unhandled requests. If a request starts with the base URL of the interceptor, but no
+   * matching handler exists, this strategy will be used. If a function is provided, it will be called with the
+   * unhandled request.
+   *
+   * @see {@link https://zimic.dev/docs/interceptor/guides/http/unhandled-requests Unhandled requests}
+   */
+  onUnhandledRequest?: UnhandledRequestStrategy;
+
   /**
    * The platform the interceptor is running on.
    *
@@ -123,13 +132,6 @@ export interface LocalHttpInterceptor<Schema extends HttpSchema> extends HttpInt
   /** @readonly */
   get type(): 'local';
 
-  /**
-   * The strategy to use for unhandled requests. If a request starts with the base URL of the interceptor, but no
-   * matching handler exists, this strategy will be used. If a function is provided, it will be called with the
-   * unhandled request.
-   *
-   * @see {@link https://zimic.dev/docs/interceptor/guides/http/unhandled-requests Unhandled requests}
-   */
   onUnhandledRequest?: UnhandledRequestStrategy.Local;
 
   /**
@@ -320,13 +322,6 @@ export interface RemoteHttpInterceptor<Schema extends HttpSchema> extends HttpIn
    */
   auth?: RemoteHttpInterceptorOptions['auth'];
 
-  /**
-   * The strategy to use for unhandled requests. If a request starts with the base URL of the interceptor, but no
-   * matching handler exists, this strategy will be used. If a function is provided, it will be called with the
-   * unhandled request.
-   *
-   * @see {@link https://zimic.dev/docs/interceptor/guides/http/unhandled-requests Unhandled requests}
-   */
   onUnhandledRequest?: UnhandledRequestStrategy.Remote;
 
   /**

package/src/server/factory.ts

@@ -2,14 +2,7 @@ import InterceptorServer from './InterceptorServer';
 import { InterceptorServerOptions } from './types/options';
 import { InterceptorServer as PublicInterceptorServer } from './types/public';
 
-/**
- * Creates an {@link https://zimic.dev/docs/interceptor/cli/server interceptor server}.
- *
- * @param options The options to create the server.
- * @returns The created server.
- * @see {@link https://zimic.dev/docs/interceptor/cli/server-programmatic-usage `zimic-interceptor server` programmatic usage}
- * @see {@link https://zimic.dev/docs/interceptor/guides/http/remote-interceptors Remote HTTP Interceptors} .
- */
+/** @see {@link https://zimic.dev/docs/interceptor/api/create-interceptor-server `createInterceptorServer` API reference} */
 export function createInterceptorServer(options: InterceptorServerOptions = {}): PublicInterceptorServer {
   return new InterceptorServer(options);
 }

package/src/server/types/options.ts

@@ -1,32 +1,14 @@
-/**
- * The options to create an {@link https://zimic.dev/docs/interceptor/cli/server interceptor server}.
- *
- * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
- */
+/** @see {@link https://zimic.dev/docs/interceptor/api/create-interceptor-server `createInterceptorServer` API reference} */
 export interface InterceptorServerOptions {
-  /**
-   * The hostname to start the server on.
-   *
-   * @default localhost
-   */
+  /** @see {@link https://zimic.dev/docs/interceptor/api/create-interceptor-server `createInterceptorServer` API reference} */
   hostname?: string;
 
-  /** The port to start the server on. If no port is provided, a random one is chosen. */
+  /** @see {@link https://zimic.dev/docs/interceptor/api/create-interceptor-server `createInterceptorServer` API reference} */
   port?: number;
 
-  /**
-   * Whether to log warnings about unhandled requests to the console.
-   *
-   * @default true
-   */
+  /** @see {@link https://zimic.dev/docs/interceptor/api/create-interceptor-server `createInterceptorServer` API reference} */
   logUnhandledRequests?: boolean;
 
-  /**
-   * The directory where the authorized interceptor authentication tokens are saved. If provided, only remote
-   * interceptors bearing a valid token will be accepted. This option is essential if you are exposing your interceptor
-   * server publicly. For local development and testing, though, `--tokens-dir` is optional.
-   *
-   * @default undefined
-   */
+  /** @see {@link https://zimic.dev/docs/interceptor/api/create-interceptor-server `createInterceptorServer` API reference} */
   tokensDirectory?: string;
 }

package/src/server/types/public.ts

@@ -1,65 +1,26 @@
-/**
- * A server to intercept and handle requests. It is used in combination with
- * {@link https://zimic.dev/docs/interceptor/guides/http/remote-interceptors remote interceptors}.
- *
- * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
- */
+/** @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference} */
 export interface InterceptorServer {
-  /**
-   * The hostname of the server. It can be reassigned to a new value if the server is not running.
-   *
-   * @throws {RunningInterceptorServerError} When trying to reassign a new hostname with the server still running.
-   * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
-   */
+  /** @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference} */
   hostname: string;
 
-  /**
-   * The port of the server. It can be reassigned to a new value if the server is not running.
-   *
-   * @throws {RunningInterceptorServerError} When trying to reassign a new port with the server still running.
-   * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
-   */
+  /** @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference} */
   port: number | undefined;
 
-  /**
-   * Whether to log warnings about unhandled requests to the console.
-   *
-   * @default true
-   * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
-   */
+  /** @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference} */
   logUnhandledRequests: boolean;
 
-  /**
-   * The directory where the authorized interceptor authentication tokens are saved. If provided, only remote
-   * interceptors bearing a valid token will be accepted. This option is essential if you are exposing your interceptor
-   * server publicly. For local development and testing, though, `--tokens-dir` is optional.
-   *
-   * @default undefined
-   */
+  /** @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference} */
   tokensDirectory?: string;
 
   /**
-   * Whether the server is running.
-   *
    * @readonly
-   * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
+   * @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference}
    */
   get isRunning(): boolean;
 
-  /**
-   * Starts the server.
-   *
-   * The server is automatically stopped if a process exit event is detected, such as SIGINT, SIGTERM, or an uncaught
-   * exception.
-   *
-   * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
-   */
+  /** @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference} */
   start: () => Promise<void>;
 
-  /**
-   * Stops the server.
-   *
-   * @see {@link https://zimic.dev/docs/interceptor/cli/server `zimic-interceptor server` API reference}
-   */
+  /** @see {@link https://zimic.dev/docs/interceptor/api/interceptor-server `InterceptorServer` API reference} */
   stop: () => Promise<void>;
 }

package/src/utils/processes.ts

@@ -69,11 +69,11 @@ export class CommandError extends Error {
   }
 }
 
-export async function runCommand(command: string, commandArguments: string[]) {
+export async function runCommand(commandEntry: string, commandArguments: string[]) {
   const { execa: $, ExecaError } = await importExeca();
 
   try {
-    await $(command, commandArguments, { stdio: 'inherit' });
+    await $(commandEntry, commandArguments, { stdio: 'inherit' });
   } catch (error) {
     /* istanbul ignore if -- @preserve
      * This is a safeguard if the error is not an ExecaError. It is not expected to run. */
@@ -81,8 +81,8 @@ export async function runCommand(command: string, commandArguments: string[]) {
       throw error;
     }
 
-    const commandError = new CommandError(command, {
-      command: [command, ...commandArguments],
+    const commandError = new CommandError(commandEntry, {
+      command: [commandEntry, ...commandArguments],
       exitCode: error.exitCode,
       signal: error.signal,
       originalMessage: error.originalMessage,