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

package/src/typegen/openapi/generate.ts

@@ -1,9 +1,8 @@
+import isDefined from '@zimic/utils/data/isDefined';
 import filesystem from 'fs/promises';
 import path from 'path';
 import ts from 'typescript';
 
-import { isDefined } from '@/utils/data';
-
 import {
   isComponentsDeclaration,
   normalizeComponents,

package/src/typegen/openapi/transform/components.ts

@@ -1,8 +1,7 @@
+import isDefined from '@zimic/utils/data/isDefined';
+import { Override } from '@zimic/utils/types';
 import ts from 'typescript';
 
-import { Override } from '@/types/utils';
-import { isDefined } from '@/utils/data';
-
 import { isNeverType, isUnknownType } from '../utils/types';
 import { ComponentPath, TypeTransformContext } from './context';
 import { normalizeContentType, normalizeResponse } from './methods';

package/src/typegen/openapi/transform/filters.ts

@@ -1,11 +1,11 @@
+import isNonEmpty from '@zimic/utils/data/isNonEmpty';
+import createRegExpFromWildcardPath from '@zimic/utils/url/createRegExpFromWildcardPath';
 import chalk from 'chalk';
 import filesystem from 'fs/promises';
 import path from 'path';
 
 import { HTTP_METHODS } from '@/types/schema';
 import { logWithPrefix } from '@/utils/console';
-import { isNonEmpty } from '@/utils/data';
-import { createRegexFromWildcardPath } from '@/utils/urls';
 
 import { TypePathFilters } from './context';
 
@@ -36,7 +36,7 @@ export function parseRawFilter(rawFilter: string): ParsedTypePathFilter | undefi
   const isNegativeMatch = filterModifier === '!';
 
   return {
-    expression: createRegexFromWildcardPath(filteredPath, { prefix: methodFilterGroup }),
+    expression: createRegExpFromWildcardPath(filteredPath, { prefix: methodFilterGroup }),
     isNegativeMatch,
   };
 }

package/src/typegen/openapi/transform/io.ts

@@ -1,10 +1,8 @@
+import createCachedDynamicImport from '@zimic/utils/import/createCachedDynamicImport';
 import type { SchemaObject } from 'openapi-typescript';
 import path from 'path';
 import ts from 'typescript';
 
-import { createCachedDynamicImport } from '@/utils/imports';
-import { createFileURL, createURL } from '@/utils/urls';
-
 import { createBlobType, createNullType } from '../utils/types';
 
 const importOpenapiTypeScript = createCachedDynamicImport(() => import('openapi-typescript'));
@@ -24,9 +22,9 @@ function transformSchemaObject(schemaObject: SchemaObject) {
 
 function convertFilePathOrURLToURL(filePathOrURL: string) {
   try {
-    return createURL(filePathOrURL);
+    return new URL(filePathOrURL);
   } catch {
-    return createFileURL(path.resolve(filePathOrURL));
+    return new URL(`file://${path.resolve(filePathOrURL)}`);
   }
 }
 

package/src/typegen/openapi/transform/methods.ts

@@ -1,10 +1,10 @@
+import isDefined from '@zimic/utils/data/isDefined';
+import { Override } from '@zimic/utils/types';
 import chalk from 'chalk';
 import ts from 'typescript';
 
 import { HTTP_METHODS, HttpMethod } from '@/types/schema';
-import { Override } from '@/types/utils';
 import { logWithPrefix } from '@/utils/console';
-import { isDefined } from '@/utils/data';
 
 import { isUnknownType, isNeverType, isNullType } from '../utils/types';
 import { renameComponentReferences } from './components';
@@ -332,9 +332,8 @@ export function normalizeContentType(
     return [];
   });
 
-  if (newBodyMembers.length <= 1) {
-    const newBodyMemberPropertySignatures = newBodyMembers.map((bodyMember) => bodyMember.propertySignature);
-    const newMembers = [newHeader, ...newBodyMemberPropertySignatures].filter(isDefined);
+  if (newBodyMembers.length === 0) {
+    const newMembers = [newHeader].filter(isDefined);
 
     return ts.factory.updateTypeLiteralNode(contentType, ts.factory.createNodeArray(newMembers));
   } else {

package/src/typegen/openapi/transform/operations.ts

@@ -1,8 +1,7 @@
+import isDefined from '@zimic/utils/data/isDefined';
+import { Override } from '@zimic/utils/types';
 import ts from 'typescript';
 
-import { Override } from '@/types/utils';
-import { isDefined } from '@/utils/data';
-
 import { TypeTransformContext } from './context';
 import { normalizeTypeLiteralMethodType } from './methods';
 

package/src/typegen/openapi/transform/paths.ts

@@ -1,8 +1,7 @@
+import isDefined from '@zimic/utils/data/isDefined';
+import { Override } from '@zimic/utils/types';
 import ts from 'typescript';
 
-import { Override } from '@/types/utils';
-import { isDefined } from '@/utils/data';
-
 import { renameComponentReferences } from './components';
 import { TypeTransformContext } from './context';
 import { normalizeMethod } from './methods';

package/src/types/requests.ts

@@ -1,6 +1,7 @@
+import { Default, DefaultNoExclude, IfNever, ReplaceBy } from '@zimic/utils/types';
+
 import { JSONSerialized, JSONValue } from '@/types/json';
-import { HttpStatusCode } from '@/types/schema';
-import { ReplaceBy } from '@/types/utils';
+import { HttpMethodSchema, HttpStatusCode } from '@/types/schema';
 
 import HttpFormData from '../formData/HttpFormData';
 import { HttpFormDataSchema } from '../formData/types';
@@ -94,3 +95,35 @@ export interface HttpResponse<
   >;
   clone: () => this;
 }
+
+export type HttpRequestHeadersSchema<MethodSchema extends HttpMethodSchema> = Default<
+  Default<MethodSchema['request']>['headers']
+>;
+
+export type HttpRequestSearchParamsSchema<MethodSchema extends HttpMethodSchema> = Default<
+  Default<MethodSchema['request']>['searchParams']
+>;
+
+export type HttpRequestBodySchema<MethodSchema extends HttpMethodSchema> = ReplaceBy<
+  ReplaceBy<IfNever<DefaultNoExclude<Default<MethodSchema['request']>['body']>, null>, undefined, null>,
+  ArrayBuffer,
+  Blob
+>;
+
+export type HttpResponseHeadersSchema<
+  MethodSchema extends HttpMethodSchema,
+  StatusCode extends HttpStatusCode,
+> = Default<DefaultNoExclude<Default<Default<MethodSchema['response']>[StatusCode]>['headers']>>;
+
+export type HttpResponseBodySchema<
+  MethodSchema extends HttpMethodSchema,
+  StatusCode extends HttpStatusCode,
+> = ReplaceBy<
+  ReplaceBy<
+    IfNever<DefaultNoExclude<Default<Default<MethodSchema['response']>[StatusCode]>['body']>, null>,
+    undefined,
+    null
+  >,
+  ArrayBuffer,
+  Blob
+>;

package/src/types/schema.ts

@@ -1,4 +1,4 @@
-import { IfAny, UnionToIntersection, UnionHasMoreThanOneType, Prettify, NonEmptyArray } from '@/types/utils';
+import { IfAny, UnionToIntersection, UnionHasMoreThanOneType, Prettify, NonEmptyArray } from '@zimic/utils/types';
 
 import { HttpFormDataSchema, HttpFormDataSerialized } from '../formData/types';
 import { HttpHeadersSchema, HttpHeadersSerialized } from '../headers/types';
@@ -29,7 +29,7 @@ export 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}
  */
 export interface HttpRequestSchema {
   headers?: HttpHeadersSchema.Loose;
@@ -50,7 +50,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}
  */
 export interface HttpResponseSchema {
   headers?: HttpHeadersSchema.Loose;
@@ -204,7 +204,7 @@ export 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}
  */
 export type HttpResponseSchemaByStatusCode =
   HttpResponseSchemaByStatusCode.ConvertToStrict<HttpResponseSchemaByStatusCode.Loose>;
@@ -216,7 +216,7 @@ 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}
  */
 export type HttpResponseSchemaStatusCode<ResponseSchemaByStatusCode extends HttpResponseSchemaByStatusCode> =
   keyof ResponseSchemaByStatusCode & HttpStatusCode;
@@ -224,7 +224,7 @@ export type HttpResponseSchemaStatusCode<ResponseSchemaByStatusCode extends Http
 /**
  * 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}
  */
 export interface HttpMethodSchema {
   request?: HttpRequestSchema;
@@ -257,7 +257,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}
  */
 export interface HttpMethodsSchema {
   GET?: HttpMethodSchema.NoRequestBody;
@@ -284,9 +284,6 @@ export 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';
  *
@@ -317,7 +314,7 @@ export 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}
  */
 export type HttpSchema<Schema extends BaseHttpSchema = BaseHttpSchema> = ConvertToStrictHttpSchema<Schema>;
 
@@ -325,9 +322,6 @@ export 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';
    *
@@ -348,9 +342,6 @@ export 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';
    *
@@ -371,9 +362,6 @@ export 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';
    *
@@ -398,9 +386,6 @@ export 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';
    *
@@ -423,9 +408,6 @@ export 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';
    *
@@ -581,7 +563,7 @@ export 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}
  */
 export type HttpSchemaMethod<Schema extends HttpSchema> = IfAny<
   Schema,
@@ -621,7 +603,7 @@ export type AllowAnyStringInPathParams<Path extends string> = Path extends `${in
  *   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}
  */
 export namespace HttpSchemaPath {
   type LooseLiteral<Schema extends HttpSchema, Method extends HttpMethod = HttpMethod> = {
@@ -654,7 +636,7 @@ export 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,
@@ -687,7 +669,7 @@ export 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,
@@ -746,7 +728,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 } };
@@ -755,7 +737,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

package/src/utils/console.ts

@@ -3,5 +3,5 @@ import chalk from 'chalk';
 export function logWithPrefix(message: string, options: { method: 'log' | 'warn' | 'error' }) {
   const { method } = options;
 
-  console[method](chalk.cyan('[zimic]'), message);
+  console[method](chalk.cyan('[@zimic/http]'), message);
 }

package/src/utils/files.ts

@@ -1,28 +1,8 @@
-import { blobEquals } from './data';
-import { createCachedDynamicImport } from './imports';
-
-export const importBuffer = createCachedDynamicImport(
-  /* istanbul ignore next -- @preserve
-   * Ignoring as Node.js >=20 provides a global file and the buffer import won't run. */
-  () => import('buffer'),
-);
-
-let FileSingleton: typeof File | undefined;
-
-export async function importFile() {
-  /* istanbul ignore if -- @preserve
-   * Ignoring as this will only run if this function is called more than once. */
-  if (FileSingleton) {
-    return FileSingleton;
-  }
+import createCachedDynamicImport from '@zimic/utils/import/createCachedDynamicImport';
 
+export const importFile = createCachedDynamicImport(
   /* istanbul ignore next -- @preserve
    * Ignoring as Node.js >=20 provides a global File and the import fallback won't run. */
   // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-  FileSingleton = globalThis.File ?? (await importBuffer()).File;
-  return FileSingleton;
-}
-
-export async function fileEquals(file: File, otherFile: File) {
-  return file.name === otherFile.name && (await blobEquals(file, otherFile));
-}
+  async () => globalThis.File ?? (await import('buffer')).File,
+);

package/src/utils/prettier.ts

@@ -1,4 +1,4 @@
-import prettier, { Options } from 'prettier'; // eslint-disable-line import/no-extraneous-dependencies
+import prettier, { Options } from 'prettier';
 
 export async function resolvedPrettierConfig(fileName: string): Promise<Options> {
   const config = await prettier.resolveConfig(fileName);

package/src/utils/time.ts

@@ -1,4 +1,4 @@
-import { PossiblePromise } from '@/types/utils';
+import { PossiblePromise } from '@zimic/utils/types';
 
 export async function usingElapsedTime<ReturnType>(callback: () => PossiblePromise<ReturnType>) {
   const startTimeInMilliseconds = performance.now();