@zimic/http 0.1.0-canary.2 → 0.1.0-canary.20

package/dist/index.d.ts

@@ -66,6 +66,7 @@ type JSONSerialized<Type> = Type extends JSONValue ? Type : Type extends string
 } : never;
 
 type Default<Type, IfEmpty = never> = [undefined | void] extends [Type] ? IfEmpty : Exclude<Type, undefined | void>;
+type DefaultNoExclude<Type, IfEmpty = never> = [undefined | void] extends Type ? IfEmpty : Type;
 type IfAny<Type, Yes, No = Type> = 0 extends 1 & Type ? Yes : No;
 type IfNever<Type, Yes, No = Type> = [Type] extends [never] ? Yes : No;
 type UnionToIntersection<Union> = (Union extends unknown ? (union: Union) => void : never) extends (intersectedUnion: infer IntersectedUnion) => void ? IntersectedUnion : never;
@@ -380,9 +381,9 @@ type HttpHeadersSerialized<Type> = HttpPathParamsSerialized<Type>;
 declare class HttpHeaders<Schema extends HttpHeadersSchema = HttpHeadersSchema> extends Headers {
     constructor(init?: HttpHeadersInit<Schema>);
     /** @see {@link https://developer.mozilla.org/docs/Web/API/Headers/set MDN Reference} */
-    set<Name extends HttpHeadersSchemaName<Schema>>(name: Name, value: NonNullable<Schema[Name]>): void;
+    set<Name extends HttpHeadersSchemaName<Schema>>(name: Name, value: NonNullable<Schema[Name]> & string): void;
     /** @see {@link https://developer.mozilla.org/docs/Web/API/Headers/append MDN Reference} */
-    append<Name extends HttpHeadersSchemaName<Schema>>(name: Name, value: NonNullable<Schema[Name]>): void;
+    append<Name extends HttpHeadersSchemaName<Schema>>(name: Name, value: NonNullable<Schema[Name]> & string): void;
     /** @see {@link https://developer.mozilla.org/docs/Web/API/Headers/get MDN Reference} */
     get<Name extends HttpHeadersSchemaName<Schema>>(name: Name): ReplaceBy<Schema[Name], undefined, null>;
     /** @see {@link https://developer.mozilla.org/docs/Web/API/Headers/has MDN Reference} */
@@ -391,16 +392,19 @@ declare class HttpHeaders<Schema extends HttpHeadersSchema = HttpHeadersSchema>
     has<Name extends HttpHeadersSchemaName<Schema>>(name: Name): boolean;
     /** @see {@link https://developer.mozilla.org/docs/Web/API/Headers/delete MDN Reference} */
     delete<Name extends HttpHeadersSchemaName<Schema>>(name: Name): void;
-    forEach<This extends HttpHeaders<Schema>>(callback: <Key extends HttpHeadersSchemaName<Schema>>(value: NonNullable<Schema[Key]>, key: Key, parent: Headers) => void, thisArg?: This): void;
+    forEach<This extends HttpHeaders<Schema>>(callback: <Key extends HttpHeadersSchemaName<Schema>>(value: NonNullable<Schema[Key]> & string, key: Key, parent: Headers) => void, thisArg?: This): void;
     /** @see {@link https://developer.mozilla.org/docs/Web/API/Headers/keys MDN Reference} */
     keys(): HeadersIterator<HttpHeadersSchemaName<Schema>>;
     /** @see {@link https://developer.mozilla.org/docs/Web/API/Headers/values MDN Reference} */
-    values(): HeadersIterator<NonNullable<Schema[HttpHeadersSchemaName<Schema>]>>;
+    values(): HeadersIterator<NonNullable<Schema[HttpHeadersSchemaName<Schema>]> & string>;
     /** @see {@link https://developer.mozilla.org/docs/Web/API/Headers/entries MDN Reference} */
-    entries(): HeadersIterator<[HttpHeadersSchemaName<Schema>, NonNullable<Schema[HttpHeadersSchemaName<Schema>]>]>;
+    entries(): HeadersIterator<[
+        HttpHeadersSchemaName<Schema>,
+        NonNullable<Schema[HttpHeadersSchemaName<Schema>]> & string
+    ]>;
     [Symbol.iterator](): HeadersIterator<[
         HttpHeadersSchemaName<Schema>,
-        NonNullable<Schema[HttpHeadersSchemaName<Schema>]>
+        NonNullable<Schema[HttpHeadersSchemaName<Schema>]> & string
     ]>;
     /**
      * Checks if this headers object is equal to another set of headers. Equality is defined as having the same keys and
@@ -638,7 +642,7 @@ type HttpMethod = (typeof HTTP_METHODS)[number];
 /**
  * A schema representing the structure of an HTTP request.
  *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http‐schemas Declaring HTTP interceptor schemas}
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas Declaring HTTP interceptor schemas}
  */
 interface HttpRequestSchema {
     headers?: HttpHeadersSchema.Loose;
@@ -651,7 +655,7 @@ type ConvertToStrictHttpRequestSchema<Schema> = {
 /**
  * A schema representing the structure of an HTTP response.
  *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http‐schemas Declaring HTTP interceptor schemas}
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas Declaring HTTP interceptor schemas}
  */
 interface HttpResponseSchema {
     headers?: HttpHeadersSchema.Loose;
@@ -727,7 +731,7 @@ declare namespace HttpResponseSchemaByStatusCode {
 /**
  * A schema representing the structure of HTTP responses by status code.
  *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http‐schemas Declaring HTTP interceptor schemas}
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas Declaring HTTP interceptor schemas}
  */
 type HttpResponseSchemaByStatusCode = HttpResponseSchemaByStatusCode.ConvertToStrict<HttpResponseSchemaByStatusCode.Loose>;
 type ConvertToStrictHttpResponseSchemaByStatusCode<Schema> = {
@@ -736,13 +740,13 @@ type ConvertToStrictHttpResponseSchemaByStatusCode<Schema> = {
 /**
  * Extracts the status codes used in a response schema by status code.
  *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http‐schemas Declaring HTTP interceptor schemas}
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas Declaring HTTP interceptor schemas}
  */
 type HttpResponseSchemaStatusCode<ResponseSchemaByStatusCode extends HttpResponseSchemaByStatusCode> = keyof ResponseSchemaByStatusCode & HttpStatusCode;
 /**
  * A schema representing the structure of an HTTP request and response for a given method.
  *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http‐schemas Declaring HTTP interceptor schemas}
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas Declaring HTTP interceptor schemas}
  */
 interface HttpMethodSchema {
     request?: HttpRequestSchema;
@@ -769,7 +773,7 @@ type ConvertToStrictMethod<Schema> = {
 /**
  * A schema representing the structure of HTTP request and response by method.
  *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http‐schemas Declaring HTTP interceptor schemas}
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas Declaring HTTP interceptor schemas}
  */
 interface HttpMethodsSchema {
     GET?: HttpMethodSchema.NoRequestBody;
@@ -792,9 +796,6 @@ type ConvertToStrictHttpSchema<Schema extends HttpSchema> = {
 /**
  * Declares an HTTP service schema.
  *
- * **IMPORTANT**: the input of `HttpSchema` and all of its internal types, except bodies, must be declared inline or as
- * a type aliases (`type`). Types other than bodies cannot be interfaces.
- *
  * @example
  *   import { type HttpSchema } from '@zimic/http';
  *
@@ -825,16 +826,13 @@ type ConvertToStrictHttpSchema<Schema extends HttpSchema> = {
  *     };
  *   }>;
  *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http‐schemas Declaring HTTP interceptor schemas}
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas Declaring HTTP interceptor schemas}
  */
 type HttpSchema<Schema extends BaseHttpSchema = BaseHttpSchema> = ConvertToStrictHttpSchema<Schema>;
 declare namespace HttpSchema {
     /**
      * Declares an HTTP service methods schema.
      *
-     * **IMPORTANT**: the input of `HttpSchema.Methods` and all of its internal types, except bodies, must be declared
-     * inline or as a type aliases (`type`). Types other than bodies cannot be interfaces.
-     *
      * @example
      *   import { type HttpSchema } from '@zimic/http';
      *
@@ -854,9 +852,6 @@ declare namespace HttpSchema {
     /**
      * Declares an HTTP service method schema.
      *
-     * **IMPORTANT**: the input of `HttpSchema.Method` and all of its internal types, except bodies, must be declared
-     * inline or as a type aliases (`type`). Types other than bodies cannot be interfaces.
-     *
      * @example
      *   import { type HttpSchema } from '@zimic/http';
      *
@@ -876,9 +871,6 @@ declare namespace HttpSchema {
     /**
      * Declares an HTTP service request schema.
      *
-     * **IMPORTANT**: the input of `HttpSchema.Request` and all of its internal types, except bodies, must be declared
-     * inline or as a type aliases (`type`). Types other than bodies cannot be interfaces.
-     *
      * @example
      *   import { type HttpSchema } from '@zimic/http';
      *
@@ -902,9 +894,6 @@ declare namespace HttpSchema {
     /**
      * Declares an HTTP service response schema by status code.
      *
-     * **IMPORTANT**: the input of `HttpSchema.ResponseByStatusCode` and all of its internal types, except bodies, must be
-     * declared inline or as a type aliases (`type`). Types other than bodies cannot be interfaces.
-     *
      * @example
      *   import { type HttpSchema } from '@zimic/http';
      *
@@ -925,9 +914,6 @@ declare namespace HttpSchema {
     /**
      * Declares an HTTP service response schema.
      *
-     * **IMPORTANT**: the input of `HttpSchema.Response` and all of its internal types, except bodies, must be declared
-     * inline or as a type aliases (`type`). Types other than bodies cannot be interfaces.
-     *
      * @example
      *   import { type HttpSchema } from '@zimic/http';
      *
@@ -1077,7 +1063,7 @@ declare namespace HttpSchema {
 /**
  * Extracts the methods from an HTTP service schema.
  *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http‐schemas Declaring HTTP interceptor schemas}
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas Declaring HTTP interceptor schemas}
  */
 type HttpSchemaMethod<Schema extends HttpSchema> = IfAny<Schema, any, // eslint-disable-line @typescript-eslint/no-explicit-any
 // eslint-disable-line @typescript-eslint/no-explicit-any
@@ -1109,7 +1095,7 @@ type AllowAnyStringInPathParams<Path extends string> = Path extends `${infer Pre
  *   type GetPath = HttpSchemaPath<Schema, 'GET'>;
  *   // "/users"
  *
- * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http‐schemas Declaring HTTP interceptor schemas}
+ * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas Declaring HTTP interceptor schemas}
  */
 declare namespace HttpSchemaPath {
     type LooseLiteral<Schema extends HttpSchema, Method extends HttpMethod = HttpMethod> = {
@@ -1141,7 +1127,7 @@ declare namespace HttpSchemaPath {
      *   type LiteralGetPath = HttpSchemaPath.Literal<Schema, 'GET'>;
      *   // "/users"
      *
-     * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http‐schemas Declaring HTTP interceptor schemas}
+     * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas Declaring HTTP interceptor schemas}
      */
     export type Literal<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema> = HttpSchemaMethod<Schema>> = LooseLiteral<Schema, Method>;
     /**
@@ -1170,7 +1156,7 @@ declare namespace HttpSchemaPath {
      *   type NonLiteralGetPath = HttpSchemaPath.NonLiteral<Schema, 'GET'>;
      *   // "/users"
      *
-     * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐interceptor‐http‐schemas Declaring HTTP interceptor schemas}
+     * @see {@link https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas Declaring HTTP interceptor schemas}
      */
     export type NonLiteral<Schema extends HttpSchema, Method extends HttpSchemaMethod<Schema> = HttpSchemaMethod<Schema>> = AllowAnyStringInPathParams<Literal<Schema, Method>>;
     export {  };
@@ -1195,7 +1181,7 @@ type RecursiveInferPathParams<Path extends string> = Path extends `${infer _Pref
  * @example
  *   import { HttpSchema, InferPathParams } from '@zimic/http';
  *
- *   type MySchema = HttpSchema<{
+ *   type Schema = HttpSchema<{
  *     '/users/:userId': {
  *       GET: {
  *         response: { 200: { body: User } };
@@ -1204,7 +1190,7 @@ type RecursiveInferPathParams<Path extends string> = Path extends `${infer _Pref
  *   }>;
  *
  *   // Using a schema to validate the path (recommended):
- *   type PathParams = InferPathParams<MySchema, '/users/:userId'>;
+ *   type PathParams = InferPathParams<Schema, '/users/:userId'>;
  *   // { userId: string }
  *
  * @example
@@ -1302,5 +1288,10 @@ interface HttpResponse<StrictBody extends HttpBody.Loose = HttpBody, StatusCode
     formData: () => Promise<StrictBody extends HttpFormData<infer HttpFormDataSchema> ? StrictFormData<HttpFormDataSchema> : StrictBody extends HttpSearchParams<infer HttpSearchParamsSchema> ? StrictFormData<HttpSearchParamsSchema> : FormData>;
     clone: () => this;
 }
+type HttpRequestHeadersSchema<MethodSchema extends HttpMethodSchema> = Default<Default<MethodSchema['request']>['headers']>;
+type HttpRequestSearchParamsSchema<MethodSchema extends HttpMethodSchema> = Default<Default<MethodSchema['request']>['searchParams']>;
+type HttpRequestBodySchema<MethodSchema extends HttpMethodSchema> = ReplaceBy<ReplaceBy<IfNever<DefaultNoExclude<Default<MethodSchema['request']>['body']>, null>, undefined, null>, ArrayBuffer, Blob>;
+type HttpResponseHeadersSchema<MethodSchema extends HttpMethodSchema, StatusCode extends HttpStatusCode> = Default<DefaultNoExclude<Default<Default<MethodSchema['response']>[StatusCode]>['headers']>>;
+type HttpResponseBodySchema<MethodSchema extends HttpMethodSchema, StatusCode extends HttpStatusCode> = ReplaceBy<ReplaceBy<IfNever<DefaultNoExclude<Default<Default<MethodSchema['response']>[StatusCode]>['body']>, null>, undefined, null>, ArrayBuffer, Blob>;
 
-export { type AllowAnyStringInPathParams, HTTP_METHODS, HTTP_METHODS_WITH_REQUEST_BODY, HTTP_METHODS_WITH_RESPONSE_BODY, HttpBody, HttpFormData, HttpFormDataSchema, HttpFormDataSchemaName, type HttpFormDataSerialized, HttpHeaders, type HttpHeadersInit, HttpHeadersSchema, type HttpHeadersSchemaName, type HttpHeadersSchemaTuple, type HttpHeadersSerialized, type HttpMethod, HttpMethodSchema, type HttpMethodWithRequestBody, type HttpMethodWithResponseBody, type HttpMethodsSchema, HttpPathParamsSchema, type HttpPathParamsSerialized, type HttpRequest, type HttpRequestSchema, type HttpResponse, HttpResponseSchema, HttpResponseSchemaByStatusCode, type HttpResponseSchemaStatusCode, HttpSchema, type HttpSchemaMethod, HttpSchemaPath, HttpSearchParams, type HttpSearchParamsInit, HttpSearchParamsSchema, HttpSearchParamsSchemaName, type HttpSearchParamsSchemaTuple, type HttpSearchParamsSerialized, HttpStatusCode, type InferPathParams, type JSONSerialized, JSONValue, type LiteralHttpSchemaPathFromNonLiteral, type MergeHttpResponsesByStatusCode, type StrictFormData, type StrictHeaders, type StrictURLSearchParams };
+export { type AllowAnyStringInPathParams, HTTP_METHODS, HTTP_METHODS_WITH_REQUEST_BODY, HTTP_METHODS_WITH_RESPONSE_BODY, HttpBody, HttpFormData, HttpFormDataSchema, HttpFormDataSchemaName, type HttpFormDataSerialized, HttpHeaders, type HttpHeadersInit, HttpHeadersSchema, type HttpHeadersSchemaName, type HttpHeadersSchemaTuple, type HttpHeadersSerialized, type HttpMethod, HttpMethodSchema, type HttpMethodWithRequestBody, type HttpMethodWithResponseBody, type HttpMethodsSchema, HttpPathParamsSchema, type HttpPathParamsSerialized, type HttpRequest, type HttpRequestBodySchema, type HttpRequestHeadersSchema, type HttpRequestSchema, type HttpRequestSearchParamsSchema, type HttpResponse, type HttpResponseBodySchema, type HttpResponseHeadersSchema, HttpResponseSchema, HttpResponseSchemaByStatusCode, type HttpResponseSchemaStatusCode, HttpSchema, type HttpSchemaMethod, HttpSchemaPath, HttpSearchParams, type HttpSearchParamsInit, HttpSearchParamsSchema, HttpSearchParamsSchemaName, type HttpSearchParamsSchemaTuple, type HttpSearchParamsSerialized, HttpStatusCode, type InferPathParams, type JSONSerialized, JSONValue, type LiteralHttpSchemaPathFromNonLiteral, type MergeHttpResponsesByStatusCode, type StrictFormData, type StrictHeaders, type StrictURLSearchParams };

package/dist/index.js

@@ -3,27 +3,25 @@
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 
-// src/utils/data.ts
+// ../zimic-utils/dist/chunk-PAWJFY3S.mjs
+var __defProp2 = Object.defineProperty;
+var __name2 = /* @__PURE__ */ __name((target, value) => __defProp2(target, "name", { value, configurable: true }), "__name");
+
+// ../zimic-utils/dist/chunk-HVLEF6VF.mjs
 async function blobEquals(blob, otherBlob) {
   return blob.type === otherBlob.type && blob.size === otherBlob.size && await blob.text() === await otherBlob.text();
 }
 __name(blobEquals, "blobEquals");
+__name2(blobEquals, "blobEquals");
+var blobEquals_default = blobEquals;
 
-// src/utils/imports.ts
-function createCachedDynamicImport(importModuleDynamically) {
-  let cachedImportResult;
-  return /* @__PURE__ */ __name(async function importModuleDynamicallyWithCache() {
-    if (cachedImportResult === undefined) {
-      cachedImportResult = await importModuleDynamically();
-    }
-    return cachedImportResult;
-  }, "importModuleDynamicallyWithCache");
-}
-__name(createCachedDynamicImport, "createCachedDynamicImport");
+// ../zimic-utils/dist/data/fileEquals.mjs
 async function fileEquals(file, otherFile) {
-  return file.name === otherFile.name && await blobEquals(file, otherFile);
+  return file.name === otherFile.name && await blobEquals_default(file, otherFile);
 }
 __name(fileEquals, "fileEquals");
+__name2(fileEquals, "fileEquals");
+var fileEquals_default = fileEquals;
 
 // src/formData/HttpFormData.ts
 var HttpFormData = class extends FormData {
@@ -31,14 +29,14 @@ var HttpFormData = class extends FormData {
     __name(this, "HttpFormData");
   }
   set(name, blobOrValue, fileName) {
-    if (fileName === undefined) {
+    if (fileName === void 0) {
       super.set(name, blobOrValue);
     } else {
       super.set(name, blobOrValue, fileName);
     }
   }
   append(name, blobOrValue, fileName) {
-    if (fileName === undefined) {
+    if (fileName === void 0) {
       super.append(name, blobOrValue);
     } else {
       super.append(name, blobOrValue, fileName);
@@ -111,7 +109,7 @@ var HttpFormData = class extends FormData {
       }
       let valueExists = false;
       for (const value of values) {
-        if (value === otherValue || value instanceof Blob && otherValue instanceof Blob && await fileEquals(value, otherValue)) {
+        if (value === otherValue || value instanceof Blob && otherValue instanceof Blob && await fileEquals_default(value, otherValue)) {
           valueExists = true;
           break;
         }
@@ -145,7 +143,7 @@ var HttpFormData = class extends FormData {
       }
       let valueExists = false;
       for (const value of values) {
-        if (value === otherValue || typeof value === "string" && typeof otherValue === "string" && value === otherValue || value instanceof Blob && otherValue instanceof Blob && await fileEquals(value, otherValue)) {
+        if (value === otherValue || typeof value === "string" && typeof otherValue === "string" && value === otherValue || value instanceof Blob && otherValue instanceof Blob && await fileEquals_default(value, otherValue)) {
           valueExists = true;
           break;
         }
@@ -202,7 +200,7 @@ var HttpFormData_default = HttpFormData;
 // src/headers/HttpHeaders.ts
 function pickPrimitiveProperties(schema) {
   return Object.entries(schema).reduce((accumulated, [key, value]) => {
-    if (value !== undefined) {
+    if (value !== void 0) {
       accumulated[key] = value;
     }
     return accumulated;
@@ -353,7 +351,7 @@ var HttpHeaders_default = HttpHeaders;
 function pickPrimitiveProperties2(schema) {
   const schemaWithPrimitiveProperties = Object.entries(schema).reduce(
     (accumulated, [key, value]) => {
-      if (value !== undefined && !Array.isArray(value)) {
+      if (value !== void 0 && !Array.isArray(value)) {
         accumulated[key] = value;
       }
       return accumulated;