@zimic/interceptor 0.14.0-canary.21 → 0.14.0-canary.23

package/dist/http.d.ts

@@ -1,5 +1,5 @@
-import { HttpMethodSchema, HttpStatusCode, HttpRequest, HttpHeaders, HttpRequestHeadersSchema, InferPathParams, HttpSearchParams, HttpRequestSearchParamsSchema, HttpRequestBodySchema, HttpResponse, HttpResponseHeadersSchema, HttpResponseBodySchema, HttpResponseSchema, HttpHeadersInit, HttpSchema, HttpBody, HttpSchemaPath, HttpSchemaMethod, HttpHeadersSchema, HttpSearchParamsSchema, HttpFormData, HttpResponseSchemaStatusCode, HttpMethod, LiteralHttpSchemaPathFromNonLiteral } from '@zimic/http';
-import { Default, PossiblePromise, ReplaceBy, IfNever, DeepPartial, Range } from '@zimic/utils/types';
+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';
+import { Default, PossiblePromise, ReplaceBy, PartialByKey, IfNever, DeepPartial, Range } from '@zimic/utils/types';
 
 type HttpRequestHandlerResponseWithBody<ResponseSchema extends HttpResponseSchema> = unknown extends ResponseSchema['body'] ? {
     body?: null;
@@ -8,10 +8,13 @@ type HttpRequestHandlerResponseWithBody<ResponseSchema extends HttpResponseSchem
 } : {
     body: ReplaceBy<ResponseSchema['body'], ArrayBuffer, Blob>;
 };
+type HttpRequestHandlerResponseHeaders<ResponseSchema extends HttpResponseSchema> = HttpHeadersInit<PartialByKey<Default<ResponseSchema['headers']>, 'content-type'>>;
 type HttpRequestHandlerResponseWithHeaders<ResponseSchema extends HttpResponseSchema> = undefined extends ResponseSchema['headers'] ? {
-    headers?: undefined;
+    headers?: HttpRequestHandlerResponseHeaders<ResponseSchema>;
+} : keyof ResponseSchema['headers'] extends 'content-type' ? {
+    headers?: HttpRequestHandlerResponseHeaders<ResponseSchema>;
 } : {
-    headers: HttpHeadersInit<Default<ResponseSchema['headers']>>;
+    headers: HttpRequestHandlerResponseHeaders<ResponseSchema>;
 };
 /** A declaration of an HTTP response for an intercepted request. */
 type HttpRequestHandlerResponseDeclaration<MethodSchema extends HttpMethodSchema = HttpMethodSchema, StatusCode extends HttpStatusCode = HttpStatusCode> = StatusCode extends StatusCode ? {
@@ -237,42 +240,42 @@ type PartialHttpHeadersOrSchema<Schema extends HttpHeadersSchema> = IfNever<Sche
  *
  * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http#http-handlerwithrestriction `handler.with()` API reference}
  */
-type HttpRequestHandlerHeadersStaticRestriction<Schema extends HttpSchema, Path extends HttpSchemaPath<Schema, Method>, Method extends HttpSchemaMethod<Schema>> = PartialHttpHeadersOrSchema<HttpRequestHeadersSchema<Default<Schema[Path][Method]>>>;
+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, Path extends HttpSchemaPath<Schema, Method>, Method extends HttpSchemaMethod<Schema>> = PartialHttpSearchParamsOrSchema<HttpRequestSearchParamsSchema<Default<Schema[Path][Method]>>>;
+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, Path extends HttpSchemaPath<Schema, Method>, Method extends HttpSchemaMethod<Schema>> = PartialBodyOrSchema<HttpRequestBodySchema<Default<Schema[Path][Method]>>>;
+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, Path extends HttpSchemaPath<Schema, Method>, Method extends HttpSchemaMethod<Schema>> {
+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, Path, Method>;
+    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, Path, Method>;
+    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, Path, Method>;
+    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.
@@ -290,7 +293,7 @@ type HttpRequestHandlerComputedRestriction<Schema extends HttpSchema, Method ext
  *
  * @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, Path, Method> | HttpRequestHandlerComputedRestriction<Schema, Method, Path>;
+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;
@@ -1104,9 +1107,9 @@ interface RemoteHttpInterceptor<Schema extends HttpSchema> extends HttpIntercept
  * @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<HttpSchema<Schema>>;
-declare function createHttpInterceptor<Schema extends HttpSchema>(options: RemoteHttpInterceptorOptions): RemoteHttpInterceptor<HttpSchema<Schema>>;
-declare function createHttpInterceptor<Schema extends HttpSchema>(options: HttpInterceptorOptions): LocalHttpInterceptor<HttpSchema<Schema>> | RemoteHttpInterceptor<HttpSchema<Schema>>;
+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>;
 
 /** Default HTTP interceptor settings. */
 declare class HttpInterceptorNamespaceDefault {