@zimic/interceptor 0.16.0-canary.2 → 0.16.0-canary.3

package/dist/http.d.ts

@@ -1,4 +1,77 @@
-import { HttpMethodSchema, HttpRequest, HttpHeaders, HttpRequestHeadersSchema, InferPathParams, HttpSearchParams, HttpRequestSearchParamsSchema, HttpRequestBodySchema, HttpStatusCode, HttpResponseSchema, HttpHeadersInit, HttpResponse, HttpResponseHeadersSchema, HttpResponseBodySchema, HttpSchema, HttpBody, HttpSchemaMethod, HttpSchemaPath, HttpHeadersSchema, HttpSearchParamsSchema, HttpFormData, HttpResponseSchemaStatusCode, HttpMethod, LiteralHttpSchemaPathFromNonLiteral } from '@zimic/http';
+import { HttpMethodSchema, HttpRequest, HttpHeaders, HttpRequestHeadersSchema, InferPathParams, HttpSearchParams, HttpRequestSearchParamsSchema, HttpRequestBodySchema, HttpStatusCode, HttpResponseSchema, HttpHeadersInit, HttpResponse, HttpResponseHeadersSchema, HttpResponseBodySchema, HttpSchema, HttpSchemaMethod, HttpSchemaPath, HttpHeadersSchema, HttpSearchParamsSchema, HttpBody, HttpFormData, HttpResponseSchemaStatusCode, HttpMethod, LiteralHttpSchemaPathFromNonLiteral } from '@zimic/http';
+
+/**
+ * Error thrown when a value is not valid JSON. HTTP interceptors might throw this error when trying to parse the body
+ * of a request or response with the header `'content-type': 'application/json'`, if the content cannot be parsed to
+ * JSON.
+ */
+declare class InvalidJSONError extends SyntaxError {
+    constructor(value: string);
+}
+
+/**
+ * Error thrown when a value is not valid {@link https://developer.mozilla.org/docs/Web/API/FormData FormData}. HTTP
+ * interceptors might throw this error when trying to parse the body of a request or response with the header
+ * `'content-type': 'multipart/form-data'`, if the content cannot be parsed to form data.
+ */
+declare class InvalidFormDataError extends SyntaxError {
+    constructor(value: string);
+}
+
+/**
+ * An error thrown when the interceptor is running and some operation requires it to be stopped first.
+ *
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorstart `interceptor.start()` API reference}
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorstop `interceptor.stop()` API reference}
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorisrunning `interceptor.isRunning` API reference}
+ */
+declare class RunningHttpInterceptorError extends Error {
+    constructor(additionalMessage: string);
+}
+
+/**
+ * An error thrown when the interceptor is not running and it's not possible to use the mocking utilities.
+ *
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorstart `interceptor.start()` API reference}
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorstop `interceptor.stop()` API reference}
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorisrunning `interceptor.isRunning` API reference}
+ */
+declare class NotRunningHttpInterceptorError extends Error {
+    constructor();
+}
+
+/**
+ * An error thrown when an unknown interceptor platform is detected. Currently, the platforms `node` and `browser` are
+ * supported.
+ *
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorplatform `interceptor.platform` API reference}
+ */
+declare class UnknownHttpInterceptorPlatformError extends Error {
+    constructor();
+}
+
+declare class UnknownHttpInterceptorTypeError extends TypeError {
+    constructor(unknownType: unknown);
+}
+
+/**
+ * An error thrown when the browser mock service worker is not found.
+ *
+ * @see {@link https://github.com/zimicjs/zimic/wiki/cli‐zimic‐browser#zimic-browser-init `zimic-interceptor browser init` API reference}
+ */
+declare class UnregisteredBrowserServiceWorkerError extends Error {
+    constructor();
+    static matchesRawError(error: unknown): boolean;
+}
+
+/**
+ * Error thrown when trying to access requests when the interceptor is not configured to do so.
+ *
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests Saving intercepted requests}
+ */
+declare class DisabledRequestSavingError extends TypeError {
+    constructor();
+}
 
 type Default<Type, IfEmpty = never> = [undefined | void] extends [Type] ? IfEmpty : Exclude<Type, undefined | void>;
 type IfNever<Type, Yes, No = Type> = [Type] extends [never] ? Yes : No;
@@ -78,6 +151,97 @@ interface InterceptedHttpInterceptorRequest<Path extends string, MethodSchema ex
     response: StatusCode extends [never] ? never : HttpInterceptorResponse<MethodSchema, StatusCode>;
 }
 
+type PartialHttpHeadersOrSchema<Schema extends HttpHeadersSchema> = IfNever<Schema, never, Partial<Schema> | HttpHeaders<Partial<Schema>> | HttpHeaders<Schema>>;
+/**
+ * A static headers restriction to match intercepted requests.
+ *
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerwithrestriction `handler.with()` API reference}
+ */
+type HttpRequestHandlerHeadersStaticRestriction<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema>, Path extends HttpSchemaPath<Schema, Method>> = PartialHttpHeadersOrSchema<HttpRequestHeadersSchema<Default<Schema[Path][Method]>>>;
+type PartialHttpSearchParamsOrSchema<Schema extends HttpSearchParamsSchema> = IfNever<Schema, never, Partial<Schema> | HttpSearchParams<Partial<Schema>> | HttpSearchParams<Schema>>;
+/**
+ * A static search params restriction to match intercepted requests.
+ *
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerwithrestriction `handler.with()` API reference}
+ */
+type HttpRequestHandlerSearchParamsStaticRestriction<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema>, Path extends HttpSchemaPath<Schema, Method>> = PartialHttpSearchParamsOrSchema<HttpRequestSearchParamsSchema<Default<Schema[Path][Method]>>>;
+type PartialBodyOrSchema<Body extends HttpBody> = Body extends HttpFormData<infer Schema> ? HttpFormData<Partial<Schema>> | HttpFormData<Schema> : Body extends HttpSearchParams<infer Schema> ? HttpSearchParams<Partial<Schema>> | HttpSearchParams<Schema> : Body extends Blob ? Body : DeepPartial<Body>;
+/**
+ * A static body restriction to match intercepted requests.
+ *
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerwithrestriction `handler.with()` API reference}
+ */
+type HttpRequestHandlerBodyStaticRestriction<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema>, Path extends HttpSchemaPath<Schema, Method>> = PartialBodyOrSchema<HttpRequestBodySchema<Default<Schema[Path][Method]>>>;
+/**
+ * A static restriction to match intercepted requests.
+ *
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerwithrestriction `handler.with()` API reference}
+ */
+interface HttpRequestHandlerStaticRestriction<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema>, Path extends HttpSchemaPath<Schema, Method>> {
+    /**
+     * A set of headers that the intercepted request must contain to match the handler. If exact is `true`, the request
+     * must contain exactly these headers and no others.
+     */
+    headers?: HttpRequestHandlerHeadersStaticRestriction<Schema, Method, Path>;
+    /**
+     * A set of search params that the intercepted request must contain to match the handler. If exact is `true`, the
+     * request must contain exactly these search params and no others.
+     */
+    searchParams?: HttpRequestHandlerSearchParamsStaticRestriction<Schema, Method, Path>;
+    /**
+     * The body that the intercepted request must contain to match the handler. If exact is `true`, the request must
+     * contain exactly this body and no other.
+     */
+    body?: HttpRequestHandlerBodyStaticRestriction<Schema, Method, Path>;
+    /**
+     * If `true`, the request must contain **exactly** the headers, search params, and body declared in this restriction.
+     * Otherwise, the request must contain **at least** them.
+     */
+    exact?: boolean;
+}
+/**
+ * A computed restriction to match intercepted requests.
+ *
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerwithrestriction `handler.with()` API reference}
+ */
+type HttpRequestHandlerComputedRestriction<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema>, Path extends HttpSchemaPath<Schema, Method>> = (request: HttpInterceptorRequest<Path, Default<Schema[Path][Method]>>) => PossiblePromise<boolean>;
+/**
+ * A restriction to match intercepted requests.
+ *
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerwithrestriction `handler.with()` API reference}
+ */
+type HttpRequestHandlerRestriction<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema>, Path extends HttpSchemaPath<Schema, Method>> = HttpRequestHandlerStaticRestriction<Schema, Method, Path> | HttpRequestHandlerComputedRestriction<Schema, Method, Path>;
+interface RestrictionDiff<Value> {
+    expected: Value;
+    received: Value;
+}
+interface RestrictionDiffs {
+    computed?: RestrictionDiff<boolean>;
+    headers?: RestrictionDiff<HttpHeaders<never>>;
+    searchParams?: RestrictionDiff<HttpSearchParams<never>>;
+    body?: RestrictionDiff<unknown>;
+}
+interface UnmatchedHttpInterceptorRequestGroup {
+    request: HttpInterceptorRequest<string, never>;
+    diff: RestrictionDiffs;
+}
+
+declare class TimesDeclarationPointer extends Error {
+    constructor(minNumberOfRequests: number, maxNumberOfRequests?: number);
+}
+
+interface TimesCheckErrorOptions {
+    requestLimits: Range<number>;
+    numberOfMatchedRequests: number;
+    declarationPointer: TimesDeclarationPointer | undefined;
+    unmatchedRequestGroups: UnmatchedHttpInterceptorRequestGroup[];
+    hasRestrictions: boolean;
+    hasSavedRequests: boolean;
+}
+declare class TimesCheckError extends TypeError {
+    constructor(options: TimesCheckErrorOptions);
+}
+
 type UnhandledHttpInterceptorRequestMethodSchema = HttpSchema.Method<{
     request: {
         headers: Record<string, string>;
@@ -240,85 +404,10 @@ interface RemoteHttpInterceptorOptions extends SharedHttpInterceptorOptions {
  * The options to create an
  * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#httpinterceptor HTTP interceptor}.
  *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#httpinterceptorcreateoptions `httpInterceptor.create(options)` API reference}
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#createhttpinterceptoroptions `createHttpInterceptor(options)` API reference}
  */
 type HttpInterceptorOptions = LocalHttpInterceptorOptions | RemoteHttpInterceptorOptions;
 
-type PartialHttpHeadersOrSchema<Schema extends HttpHeadersSchema> = IfNever<Schema, never, Partial<Schema> | HttpHeaders<Partial<Schema>> | HttpHeaders<Schema>>;
-/**
- * A static headers restriction to match intercepted requests.
- *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerwithrestriction `handler.with()` API reference}
- */
-type HttpRequestHandlerHeadersStaticRestriction<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema>, Path extends HttpSchemaPath<Schema, Method>> = PartialHttpHeadersOrSchema<HttpRequestHeadersSchema<Default<Schema[Path][Method]>>>;
-type PartialHttpSearchParamsOrSchema<Schema extends HttpSearchParamsSchema> = IfNever<Schema, never, Partial<Schema> | HttpSearchParams<Partial<Schema>> | HttpSearchParams<Schema>>;
-/**
- * A static search params restriction to match intercepted requests.
- *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerwithrestriction `handler.with()` API reference}
- */
-type HttpRequestHandlerSearchParamsStaticRestriction<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema>, Path extends HttpSchemaPath<Schema, Method>> = PartialHttpSearchParamsOrSchema<HttpRequestSearchParamsSchema<Default<Schema[Path][Method]>>>;
-type PartialBodyOrSchema<Body extends HttpBody> = Body extends HttpFormData<infer Schema> ? HttpFormData<Partial<Schema>> | HttpFormData<Schema> : Body extends HttpSearchParams<infer Schema> ? HttpSearchParams<Partial<Schema>> | HttpSearchParams<Schema> : Body extends Blob ? Body : DeepPartial<Body>;
-/**
- * A static body restriction to match intercepted requests.
- *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerwithrestriction `handler.with()` API reference}
- */
-type HttpRequestHandlerBodyStaticRestriction<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema>, Path extends HttpSchemaPath<Schema, Method>> = PartialBodyOrSchema<HttpRequestBodySchema<Default<Schema[Path][Method]>>>;
-/**
- * A static restriction to match intercepted requests.
- *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerwithrestriction `handler.with()` API reference}
- */
-interface HttpRequestHandlerStaticRestriction<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema>, Path extends HttpSchemaPath<Schema, Method>> {
-    /**
-     * A set of headers that the intercepted request must contain to match the handler. If exact is `true`, the request
-     * must contain exactly these headers and no others.
-     */
-    headers?: HttpRequestHandlerHeadersStaticRestriction<Schema, Method, Path>;
-    /**
-     * A set of search params that the intercepted request must contain to match the handler. If exact is `true`, the
-     * request must contain exactly these search params and no others.
-     */
-    searchParams?: HttpRequestHandlerSearchParamsStaticRestriction<Schema, Method, Path>;
-    /**
-     * The body that the intercepted request must contain to match the handler. If exact is `true`, the request must
-     * contain exactly this body and no other.
-     */
-    body?: HttpRequestHandlerBodyStaticRestriction<Schema, Method, Path>;
-    /**
-     * If `true`, the request must contain **exactly** the headers, search params, and body declared in this restriction.
-     * Otherwise, the request must contain **at least** them.
-     */
-    exact?: boolean;
-}
-/**
- * A computed restriction to match intercepted requests.
- *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerwithrestriction `handler.with()` API reference}
- */
-type HttpRequestHandlerComputedRestriction<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema>, Path extends HttpSchemaPath<Schema, Method>> = (request: HttpInterceptorRequest<Path, Default<Schema[Path][Method]>>) => PossiblePromise<boolean>;
-/**
- * A restriction to match intercepted requests.
- *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerwithrestriction `handler.with()` API reference}
- */
-type HttpRequestHandlerRestriction<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema>, Path extends HttpSchemaPath<Schema, Method>> = HttpRequestHandlerStaticRestriction<Schema, Method, Path> | HttpRequestHandlerComputedRestriction<Schema, Method, Path>;
-interface RestrictionDiff<Value> {
-    expected: Value;
-    received: Value;
-}
-interface RestrictionDiffs {
-    computed?: RestrictionDiff<boolean>;
-    headers?: RestrictionDiff<HttpHeaders<never>>;
-    searchParams?: RestrictionDiff<HttpSearchParams<never>>;
-    body?: RestrictionDiff<unknown>;
-}
-interface UnmatchedHttpInterceptorRequestGroup {
-    request: HttpInterceptorRequest<string, never>;
-    diff: RestrictionDiffs;
-}
-
 /**
  * An HTTP request handler to declare responses for intercepted requests.
  *
@@ -423,7 +512,7 @@ interface LocalHttpRequestHandler<Schema extends HttpSchema, Method extends Http
      * that was not satisfied.
      *
      * When
-     * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#httpinterceptorcreateoptions `saveRequests: true`}
+     * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#createhttpinterceptoroptions `saveRequests: true`}
      * is enabled in your interceptor, the `TimesCheckError` errors will also list each unmatched request with diff of the
      * expected and received data. This is useful for debugging requests that did not match a handler with
      * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerwithrestriction restrictions}.
@@ -538,7 +627,7 @@ interface SyncedRemoteHttpRequestHandler<Schema extends HttpSchema, Method exten
      * that was not satisfied.
      *
      * When
-     * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#httpinterceptorcreateoptions `saveRequests: true`}
+     * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#createhttpinterceptoroptions `saveRequests: true`}
      * is enabled in your interceptor, the `TimesCheckError` errors will also list each unmatched request with diff of the
      * expected and received data. This is useful for debugging requests that did not match a handler with
      * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerwithrestriction restrictions}.
@@ -695,7 +784,7 @@ interface HttpInterceptor<_Schema extends HttpSchema> {
      * of each test.
      *
      * When
-     * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#httpinterceptorcreateoptions `saveRequests: true`}
+     * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#createhttpinterceptoroptions `saveRequests: true`}
      * is enabled in your interceptor, the `TimesCheckError` errors will also list each unmatched request with diff of the
      * expected and received data. This is useful for debugging requests that did not match a handler with
      * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerwithrestriction restrictions}.
@@ -1152,134 +1241,14 @@ interface RemoteHttpInterceptor<Schema extends HttpSchema> extends HttpIntercept
     clear: () => Promise<void>;
 }
 
-/**
- * Creates an HTTP interceptor.
- *
- * @param options The options for the interceptor.
- * @returns The created HTTP interceptor.
- * @throws {InvalidURLError} If the base URL is invalid.
- * @throws {UnsupportedURLProtocolError} If the base URL protocol is not either `http` or `https`.
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#httpinterceptorcreateoptions `httpInterceptor.create(options)` API reference}
- */
-declare function createHttpInterceptor<Schema extends HttpSchema>(options: LocalHttpInterceptorOptions): LocalHttpInterceptor<Schema>;
-declare function createHttpInterceptor<Schema extends HttpSchema>(options: RemoteHttpInterceptorOptions): RemoteHttpInterceptor<Schema>;
-declare function createHttpInterceptor<Schema extends HttpSchema>(options: HttpInterceptorOptions): LocalHttpInterceptor<Schema> | RemoteHttpInterceptor<Schema>;
-
-/**
- * A namespace of interceptor resources for mocking HTTP requests.
- *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#httpinterceptor `HttpInterceptor` API reference}
- */
-declare class HttpInterceptorNamespace {
-    /**
-     * Creates an HTTP interceptor.
-     *
-     * @param options The options for the interceptor.
-     * @returns The created HTTP interceptor.
-     * @throws {InvalidURLError} If the base URL is invalid.
-     * @throws {UnsupportedURLProtocolError} If the base URL protocol is not either `http` or `https`.
-     * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#httpinterceptorcreateoptions `httpInterceptor.create(options)` API reference}
-     */
-    create: typeof createHttpInterceptor;
-}
-
-/**
- * Error thrown when a value is not valid JSON. HTTP interceptors might throw this error when trying to parse the body
- * of a request or response with the header `'content-type': 'application/json'`, if the content cannot be parsed to
- * JSON.
- */
-declare class InvalidJSONError extends SyntaxError {
-    constructor(value: string);
-}
-
-/**
- * Error thrown when a value is not valid {@link https://developer.mozilla.org/docs/Web/API/FormData FormData}. HTTP
- * interceptors might throw this error when trying to parse the body of a request or response with the header
- * `'content-type': 'multipart/form-data'`, if the content cannot be parsed to form data.
- */
-declare class InvalidFormDataError extends SyntaxError {
-    constructor(value: string);
-}
-
-/**
- * An error thrown when the interceptor is running and some operation requires it to be stopped first.
- *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorstart `interceptor.start()` API reference}
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorstop `interceptor.stop()` API reference}
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorisrunning `interceptor.isRunning` API reference}
- */
-declare class RunningHttpInterceptorError extends Error {
-    constructor(additionalMessage: string);
-}
-
-/**
- * An error thrown when the interceptor is not running and it's not possible to use the mocking utilities.
- *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorstart `interceptor.start()` API reference}
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorstop `interceptor.stop()` API reference}
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorisrunning `interceptor.isRunning` API reference}
- */
-declare class NotRunningHttpInterceptorError extends Error {
-    constructor();
-}
-
-/**
- * An error thrown when an unknown interceptor platform is detected. Currently, the platforms `node` and `browser` are
- * supported.
- *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorplatform `interceptor.platform` API reference}
- */
-declare class UnknownHttpInterceptorPlatformError extends Error {
-    constructor();
-}
-
-declare class UnknownHttpInterceptorTypeError extends TypeError {
-    constructor(unknownType: unknown);
-}
-
-/**
- * An error thrown when the browser mock service worker is not found.
- *
- * @see {@link https://github.com/zimicjs/zimic/wiki/cli‐zimic‐browser#zimic-browser-init `zimic-interceptor browser init` API reference}
- */
-declare class UnregisteredBrowserServiceWorkerError extends Error {
-    constructor();
-    static matchesRawError(error: unknown): boolean;
-}
-
-/**
- * Error thrown when trying to access requests when the interceptor is not configured to do so.
- *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests Saving intercepted requests}
- */
-declare class DisabledRequestSavingError extends TypeError {
-    constructor();
-}
-
-declare class TimesDeclarationPointer extends Error {
-    constructor(minNumberOfRequests: number, maxNumberOfRequests?: number);
-}
-
-interface TimesCheckErrorOptions {
-    requestLimits: Range<number>;
-    numberOfMatchedRequests: number;
-    declarationPointer: TimesDeclarationPointer | undefined;
-    unmatchedRequestGroups: UnmatchedHttpInterceptorRequestGroup[];
-    hasRestrictions: boolean;
-    hasSavedRequests: boolean;
-}
-declare class TimesCheckError extends TypeError {
-    constructor(options: TimesCheckErrorOptions);
-}
-
 /**
  * Infers the schema of an
  * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#httpinterceptor `HttpInterceptor`}.
  *
  * @example
- *   import { httpInterceptor, type InferHttpInterceptorSchema } from '@zimic/http';
+ *   import { type InferHttpInterceptorSchema } from '@zimic/http';
  *
- *   const interceptor = httpInterceptor.create<{
+ *   const interceptor = createHttpInterceptor<{
  *     '/users': {
  *       GET: {
  *         response: { 200: { body: User[] } };
@@ -1304,10 +1273,16 @@ declare class TimesCheckError extends TypeError {
 type InferHttpInterceptorSchema<Interceptor> = Interceptor extends LocalHttpInterceptor<infer Schema> ? Schema : Interceptor extends RemoteHttpInterceptor<infer Schema> ? Schema : never;
 
 /**
- * A namespace of interceptor resources for mocking HTTP requests.
+ * Creates an HTTP interceptor.
  *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#httpinterceptor `HttpInterceptor` API reference}
+ * @param options The options for the interceptor.
+ * @returns The created HTTP interceptor.
+ * @throws {InvalidURLError} If the base URL is invalid.
+ * @throws {UnsupportedURLProtocolError} If the base URL protocol is not either `http` or `https`.
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#createhttpinterceptoroptions `createHttpInterceptor(options)` API reference}
  */
-declare const httpInterceptor: Readonly<HttpInterceptorNamespace>;
+declare function createHttpInterceptor<Schema extends HttpSchema>(options: LocalHttpInterceptorOptions): LocalHttpInterceptor<Schema>;
+declare function createHttpInterceptor<Schema extends HttpSchema>(options: RemoteHttpInterceptorOptions): RemoteHttpInterceptor<Schema>;
+declare function createHttpInterceptor<Schema extends HttpSchema>(options: HttpInterceptorOptions): LocalHttpInterceptor<Schema> | RemoteHttpInterceptor<Schema>;
 
-export { DisabledRequestSavingError, type HttpInterceptor, HttpInterceptorNamespace, type HttpInterceptorOptions, type HttpInterceptorPlatform, type HttpInterceptorRequest, type HttpInterceptorResponse, type HttpInterceptorType, type HttpRequestHandler, type HttpRequestHandlerBodyStaticRestriction, type HttpRequestHandlerComputedRestriction, type HttpRequestHandlerHeadersStaticRestriction, type HttpRequestHandlerResponseDeclaration, type HttpRequestHandlerResponseDeclarationFactory, type HttpRequestHandlerRestriction, type HttpRequestHandlerSearchParamsStaticRestriction, type HttpRequestHandlerStaticRestriction, type InferHttpInterceptorSchema, type InterceptedHttpInterceptorRequest, InvalidFormDataError, InvalidJSONError, type LocalHttpInterceptor, type LocalHttpInterceptorOptions, type LocalHttpRequestHandler, NotRunningHttpInterceptorError, type PendingRemoteHttpRequestHandler, type RemoteHttpInterceptor, type RemoteHttpInterceptorOptions, type RemoteHttpRequestHandler, RunningHttpInterceptorError, type SyncedRemoteHttpRequestHandler, TimesCheckError, type UnhandledHttpInterceptorRequest, UnhandledRequestStrategy, UnknownHttpInterceptorPlatformError, UnknownHttpInterceptorTypeError, UnregisteredBrowserServiceWorkerError, httpInterceptor };
+export { DisabledRequestSavingError, type HttpInterceptor, type HttpInterceptorOptions, type HttpInterceptorPlatform, type HttpInterceptorRequest, type HttpInterceptorResponse, type HttpInterceptorType, type HttpRequestHandler, type HttpRequestHandlerBodyStaticRestriction, type HttpRequestHandlerComputedRestriction, type HttpRequestHandlerHeadersStaticRestriction, type HttpRequestHandlerResponseDeclaration, type HttpRequestHandlerResponseDeclarationFactory, type HttpRequestHandlerRestriction, type HttpRequestHandlerSearchParamsStaticRestriction, type HttpRequestHandlerStaticRestriction, type InferHttpInterceptorSchema, type InterceptedHttpInterceptorRequest, InvalidFormDataError, InvalidJSONError, type LocalHttpInterceptor, type LocalHttpInterceptorOptions, type LocalHttpRequestHandler, NotRunningHttpInterceptorError, type PendingRemoteHttpRequestHandler, type RemoteHttpInterceptor, type RemoteHttpInterceptorOptions, type RemoteHttpRequestHandler, RunningHttpInterceptorError, type SyncedRemoteHttpRequestHandler, TimesCheckError, type UnhandledHttpInterceptorRequest, UnhandledRequestStrategy, UnknownHttpInterceptorPlatformError, UnknownHttpInterceptorTypeError, UnregisteredBrowserServiceWorkerError, createHttpInterceptor };