@zimic/interceptor 0.14.0 → 0.15.0-canary.1

package/dist/http.d.ts

@@ -1,4 +1,4 @@
-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, HttpStatusCode, HttpRequest, HttpHeaders, HttpRequestHeadersSchema, InferPathParams, HttpSearchParams, HttpRequestSearchParamsSchema, HttpRequestBodySchema, HttpResponse, HttpResponseHeadersSchema, HttpResponseBodySchema, HttpResponseSchema, HttpHeadersInit, HttpSchema, HttpBody, HttpSchemaMethod, HttpSchemaPath, HttpHeadersSchema, HttpSearchParamsSchema, HttpFormData, HttpResponseSchemaStatusCode, HttpMethod, LiteralHttpSchemaPathFromNonLiteral } from '@zimic/http';
 
 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;
@@ -73,7 +73,7 @@ interface HttpInterceptorResponse<MethodSchema extends HttpMethodSchema, StatusC
  * A strict representation of an intercepted HTTP request, along with its response. The body, search params and path
  * params are already parsed by default.
  */
-interface TrackedHttpInterceptorRequest<Path extends string, MethodSchema extends HttpMethodSchema, StatusCode extends HttpStatusCode = never> extends HttpInterceptorRequest<Path, MethodSchema> {
+interface InterceptedHttpInterceptorRequest<Path extends string, MethodSchema extends HttpMethodSchema, StatusCode extends HttpStatusCode = never> extends HttpInterceptorRequest<Path, MethodSchema> {
     /** The response that was returned for the intercepted request. */
     response: StatusCode extends [never] ? never : HttpInterceptorResponse<MethodSchema, StatusCode>;
 }
@@ -96,7 +96,7 @@ type HttpInterceptorType = 'local' | 'remote';
 /**
  * The platform where an HTTP interceptor is running.
  *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorplatform `interceptor.platform()` API reference}
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorplatform `interceptor.platform` API reference}
  */
 type HttpInterceptorPlatform = 'node' | 'browser';
 /**
@@ -189,9 +189,9 @@ interface SharedHttpInterceptorOptions {
     /**
      * Whether {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#httprequesthandler request handlers}
      * should save their intercepted requests in memory and make them accessible through
-     * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerrequests `handler.requests()`}.
+     * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerrequests `handler.requests`}.
      *
-     * **IMPORTANT**: Saving the intercepted requests will lead to a memory leak if not accompanied by clearing of the
+     * **Important**: Saving the intercepted requests will lead to a memory leak if not accompanied by clearing of the
      * interceptor or disposal of the handlers (i.e. garbage collection). If you plan on accessing those requests, such as
      * to assert them in your tests, set this option to `true` and make sure to regularly clear the interceptor. A common
      * practice is to call
@@ -332,16 +332,18 @@ interface UnmatchedHttpInterceptorRequestGroup {
  */
 interface HttpRequestHandler<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema>, Path extends HttpSchemaPath<Schema, Method>> {
     /**
-     * @returns The method that matches this handler.
-     * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlermethod `handler.method()` API reference}
+     * The method that matches this handler.
+     *
+     * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlermethod `handler.method` API reference}
      */
-    method: () => Method;
+    method: Method;
     /**
-     * @returns The path that matches this handler. The base URL of the interceptor is not included, but it is used when
-     *   matching requests.
-     * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerpath `handler.path()` API reference}
+     * The path that matches this handler. The base URL of the interceptor is not included, but it is used when matching
+     * requests.
+     *
+     * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerpath `handler.path` API reference}
      */
-    path: () => Path;
+    path: Path;
 }
 /**
  * A local HTTP request handler to declare responses for intercepted requests. In a local handler, the mocking
@@ -397,7 +399,7 @@ interface LocalHttpRequestHandler<Schema extends HttpSchema, Method extends Http
      * intercepted request in the
      * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptormethodpath `interceptor.<method>(path)` API reference}.
      *
-     * **IMPORTANT**: To make sure that all expected requests were made, use
+     * **Important**: To make sure that all expected requests were made, use
      * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorchecktimes `interceptor.checkTimes()`}
      * or {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlertimes `handler.times()`}.
      * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorchecktimes `interceptor.checkTimes()`}
@@ -446,18 +448,17 @@ interface LocalHttpRequestHandler<Schema extends HttpSchema, Method extends Http
      */
     clear: () => this;
     /**
-     * Returns the intercepted requests that matched this handler, along with the responses returned to each of them. This
-     * is useful for testing that the correct requests were made by your application.
+     * The intercepted requests that matched this handler, along with the responses returned to each of them. This is
+     * useful for testing that the correct requests were made by your application.
      *
-     * **IMPORTANT**: This method can only be used if `saveRequests` was set to `true` when creating the interceptor. See
+     * **Important**: This method can only be used if `saveRequests` was set to `true` when creating the interceptor. See
      * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests Saving intercepted requests}
      * for more information.
      *
-     * @returns The intercepted requests.
      * @throws {DisabledRequestSavingError} If the interceptor was not created with `saveRequests: true`.
-     * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerrequests `handler.requests()` API reference}
+     * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerrequests `handler.requests` API reference}
      */
-    requests: () => readonly TrackedHttpInterceptorRequest<Path, Default<Schema[Path][Method]>, StatusCode>[];
+    requests: readonly InterceptedHttpInterceptorRequest<Path, Default<Schema[Path][Method]>, StatusCode>[];
 }
 /**
  * A synced remote HTTP request handler. When a remote handler is synced, it is guaranteed that all of the mocking
@@ -510,7 +511,7 @@ interface SyncedRemoteHttpRequestHandler<Schema extends HttpSchema, Method exten
      * intercepted request in the
      * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptormethodpath `interceptor.<method>(path)` API reference}.
      *
-     * **IMPORTANT**: To make sure that all expected requests were made, use
+     * **Important**: To make sure that all expected requests were made, use
      * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorchecktimes `interceptor.checkTimes()`}
      * or
      * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerchecktimes `handler.checkTimes()`}.
@@ -560,18 +561,17 @@ interface SyncedRemoteHttpRequestHandler<Schema extends HttpSchema, Method exten
      */
     clear: () => PendingRemoteHttpRequestHandler<Schema, Method, Path, StatusCode>;
     /**
-     * Returns the intercepted requests that matched this handler, along with the responses returned to each of them. This
-     * is useful for testing that the correct requests were made by your application.
+     * The intercepted requests that matched this handler, along with the responses returned to each of them. This is
+     * useful for testing that the correct requests were made by your application.
      *
-     * **IMPORTANT**: This method can only be used if `saveRequests` was set to `true` when creating the interceptor. See
+     * **Important**: This method can only be used if `saveRequests` was set to `true` when creating the interceptor. See
      * {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#saving-requests Saving intercepted requests}
      * for more information.
      *
-     * @returns The intercepted requests.
      * @throws {DisabledRequestSavingError} If the interceptor was not created with `saveRequests: true`.
-     * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerrequests `handler.requests()` API reference}
+     * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerrequests `handler.requests` API reference}
      */
-    requests: () => Promise<readonly TrackedHttpInterceptorRequest<Path, Default<Schema[Path][Method]>, StatusCode>[]>;
+    requests: readonly InterceptedHttpInterceptorRequest<Path, Default<Schema[Path][Method]>, StatusCode>[];
 }
 /**
  * A pending remote HTTP request handler. When a remote handler is pending, it is not guaranteed that all of the mocking
@@ -624,20 +624,23 @@ type AsyncHttpInterceptorMethodHandler<Schema extends HttpSchema, Method extends
  */
 interface HttpInterceptor<_Schema extends HttpSchema> {
     /**
-     * @returns The base URL used by the interceptor.
-     * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorbaseurl `interceptor.baseURL()` API reference}
+     * The base URL used by the interceptor.
+     *
+     * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorbaseurl `interceptor.baseURL` API reference}
      */
-    baseURL: () => string;
+    baseURL: string;
     /**
-     * @returns The platform the interceptor is running on.
-     * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorplatform `interceptor.platform()` API reference}
+     * The platform the interceptor is running on.
+     *
+     * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorplatform `interceptor.platform` API reference}
      */
-    platform: () => HttpInterceptorPlatform | null;
+    platform: HttpInterceptorPlatform | null;
     /**
-     * @returns Whether the interceptor is currently running and ready to use.
-     * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorisrunning `interceptor.isRunning()` API reference}
+     * Whether the interceptor is currently running and ready to use.
+     *
+     * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorisrunning `interceptor.isRunning` API reference}
      */
-    isRunning: () => boolean;
+    isRunning: boolean;
     /**
      * Starts the interceptor, allowing it to intercept HTTP requests.
      *
@@ -1198,7 +1201,7 @@ declare class InvalidFormDataError extends SyntaxError {
  *
  * @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}
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorisrunning `interceptor.isRunning` API reference}
  */
 declare class NotStartedHttpInterceptorError extends Error {
     constructor();
@@ -1208,7 +1211,7 @@ declare class NotStartedHttpInterceptorError extends Error {
  * 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}
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-interceptorplatform `interceptor.platform` API reference}
  */
 declare class UnknownHttpInterceptorPlatformError extends Error {
     constructor();
@@ -1284,6 +1287,12 @@ declare class TimesCheckError extends TypeError {
  */
 type InferHttpInterceptorSchema<Interceptor> = Interceptor extends LocalHttpInterceptor<infer Schema> ? Schema : Interceptor extends RemoteHttpInterceptor<infer Schema> ? Schema : never;
 
+/**
+ * @deprecated This type was renamed to {@link InterceptedHttpInterceptorRequest `InterceptedHttpInterceptorRequest`}.
+ *   Please use it instead.
+ */
+type TrackedHttpInterceptorRequest<Path extends string, MethodSchema extends HttpMethodSchema, StatusCode extends HttpStatusCode = never> = InterceptedHttpInterceptorRequest<Path, MethodSchema, StatusCode>;
+
 /**
  * A namespace of interceptor resources for mocking HTTP requests.
  *
@@ -1291,4 +1300,4 @@ type InferHttpInterceptorSchema<Interceptor> = Interceptor extends LocalHttpInte
  */
 declare const httpInterceptor: Readonly<HttpInterceptorNamespace>;
 
-export { DisabledRequestSavingError, type HttpInterceptor, HttpInterceptorNamespace, HttpInterceptorNamespaceDefault, 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, InvalidFormDataError, InvalidJSONError, type LocalHttpInterceptor, type LocalHttpInterceptorOptions, type LocalHttpRequestHandler, NotStartedHttpInterceptorError, type PendingRemoteHttpRequestHandler, type RemoteHttpInterceptor, type RemoteHttpInterceptorOptions, type RemoteHttpRequestHandler, type SyncedRemoteHttpRequestHandler, TimesCheckError, type TrackedHttpInterceptorRequest, type UnhandledHttpInterceptorRequest, UnhandledRequestStrategy, UnknownHttpInterceptorPlatformError, UnknownHttpInterceptorTypeError, UnregisteredBrowserServiceWorkerError, httpInterceptor };
+export { DisabledRequestSavingError, type HttpInterceptor, HttpInterceptorNamespace, HttpInterceptorNamespaceDefault, 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, NotStartedHttpInterceptorError, type PendingRemoteHttpRequestHandler, type RemoteHttpInterceptor, type RemoteHttpInterceptorOptions, type RemoteHttpRequestHandler, type SyncedRemoteHttpRequestHandler, TimesCheckError, type TrackedHttpInterceptorRequest, type UnhandledHttpInterceptorRequest, UnhandledRequestStrategy, UnknownHttpInterceptorPlatformError, UnknownHttpInterceptorTypeError, UnregisteredBrowserServiceWorkerError, httpInterceptor };