@zimic/interceptor 0.19.1-canary.4 → 0.19.1-canary.6

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,