@shipworthy/openapi-fetch 0.0.2 → 1.0.0

package/dist/index.d.cts

@@ -1,4 +1,3 @@
-//#region src/helpers.d.ts
 type HttpMethod = "get" | "put" | "post" | "delete" | "options" | "head" | "patch" | "trace";
 /** 2XX statuses */
 type OkStatus = 200 | 201 | 202 | 203 | 204 | 206 | 207 | "2XX";
@@ -190,8 +189,29 @@ type Readable<T> = T extends $Write<any> ? never : T extends $Read<infer U> ? Re
  * - object → recursively resolve
  */
 type Writable<T> = T extends $Read<any> ? never : T extends $Write<infer U> ? Writable<U> : T extends (infer E)[] ? Writable<E>[] : T extends object ? { [K in keyof T as NonNullable<T[K]> extends $Read<any> ? never : K]: Writable<T[K]>; } & { [K in keyof T as NonNullable<T[K]> extends $Read<any> ? K : never]?: never; } : T;
-//#endregion
-//#region src/types.d.ts
+interface CaseSchema {
+  readonly ref?: string;
+  readonly properties?: Readonly<Record<string, {
+    readonly name: string;
+    readonly schema?: CaseSchema;
+  }>>;
+  readonly declared?: readonly string[];
+  readonly items?: CaseSchema;
+  readonly prefixItems?: readonly (CaseSchema | null)[];
+  readonly additionalProperties?: CaseSchema;
+  readonly patternProperties?: Readonly<Record<string, CaseSchema | null>>;
+  readonly variants?: readonly CaseSchema[];
+}
+type CaseMediaMap = Readonly<Record<string, CaseSchema | null>>;
+interface CaseOperation {
+  readonly parameters?: Readonly<Partial<Record<"path" | "query" | "header" | "cookie", CaseSchema>>>;
+  readonly requestBodies?: CaseMediaMap;
+  readonly responses?: Readonly<Record<string, CaseMediaMap | null>>;
+}
+interface CaseMapping {
+  readonly schemas?: Readonly<Record<string, CaseSchema>>;
+  readonly operations?: Readonly<Record<string, CaseOperation>>;
+}
 /** Options for each client instance */
 interface ClientOptions extends Omit<RequestInit, "headers"> {
   /** set the common root URL for all API requests */
@@ -206,6 +226,8 @@ interface ClientOptions extends Omit<RequestInit, "headers"> {
   bodySerializer?: BodySerializer<unknown>;
   /** global pathSerializer */
   pathSerializer?: PathSerializer;
+  /** schema-based field mapping applied to every request and parsed result */
+  caseMapping?: CaseMapping;
   headers?: HeadersOptions;
   /** RequestInit extension object to pass as 2nd argument to fetch when supported (defaults to undefined) */
   requestInitExt?: Record<string, unknown>;
@@ -301,10 +323,28 @@ type MergedOptions<T = unknown> = {
 };
 interface MiddlewareRequestParams {
   query?: Record<string, unknown>;
-  header?: Record<string, unknown>;
+  header?: HeadersOptions;
   path?: Record<string, unknown>;
   cookie?: Record<string, unknown>;
 }
+interface MiddlewareRequestInput {
+  readonly params: MiddlewareRequestParams;
+  readonly body: unknown;
+}
+interface MiddlewareRequestInitParams {
+  readonly schemaPath: string;
+  readonly method: string;
+  readonly input: MiddlewareRequestInput;
+  /** Client, request, and parameter headers merged before serialization. */
+  readonly headers: Headers;
+  readonly id: string;
+  readonly options: MergedOptions;
+}
+interface MiddlewareResult {
+  readonly data?: unknown;
+  readonly error?: unknown;
+  readonly response: Response;
+}
 interface MiddlewareCallbackParams {
   /** Current Request object */
   request: Request;
@@ -317,6 +357,12 @@ interface MiddlewareCallbackParams {
   /** createClient options (read-only) */
   readonly options: MergedOptions;
 }
+interface MiddlewareResultParams extends MiddlewareCallbackParams {
+  /** The method requested through the client, before HTTP middleware can replace the Request. */
+  readonly method: string;
+  readonly result: MiddlewareResult;
+}
+type MiddlewareOnRequestInit = (options: MiddlewareRequestInitParams) => void | MiddlewareRequestInput | Promise<MiddlewareRequestInput | void>;
 type MiddlewareOnRequest = (options: MiddlewareCallbackParams) => void | Request | Response | undefined | Promise<Request | Response | undefined | void>;
 type MiddlewareOnResponse = (options: MiddlewareCallbackParams & {
   response: Response;
@@ -324,19 +370,25 @@ type MiddlewareOnResponse = (options: MiddlewareCallbackParams & {
 type MiddlewareOnError = (options: MiddlewareCallbackParams & {
   error: unknown;
 }) => void | Response | Error | Promise<void | Response | Error>;
-type Middleware = {
-  onRequest: MiddlewareOnRequest;
+type MiddlewareOnResult = (options: MiddlewareResultParams) => void | Partial<Pick<MiddlewareResult, "data" | "error">> | Promise<Partial<Pick<MiddlewareResult, "data" | "error">> | void>;
+interface MiddlewareHooks {
+  onRequestInit?: MiddlewareOnRequestInit;
+  onRequest?: MiddlewareOnRequest;
   onResponse?: MiddlewareOnResponse;
   onError?: MiddlewareOnError;
+  onResult?: MiddlewareOnResult;
+}
+type Middleware = MiddlewareHooks & ({
+  onRequestInit: MiddlewareOnRequestInit;
+} | {
+  onRequest: MiddlewareOnRequest;
 } | {
-  onRequest?: MiddlewareOnRequest;
   onResponse: MiddlewareOnResponse;
-  onError?: MiddlewareOnError;
 } | {
-  onRequest?: MiddlewareOnRequest;
-  onResponse?: MiddlewareOnResponse;
   onError: MiddlewareOnError;
-};
+} | {
+  onResult: MiddlewareOnResult;
+});
 /** This type helper makes the 2nd function param required if params/requestBody are required; otherwise, optional */
 type MaybeOptionalInit<Params, Location extends keyof Params> = RequiredKeysOf<FetchOptions<FilterKeys<Params, Location>>> extends never ? FetchOptions<FilterKeys<Params, Location>> | undefined : FetchOptions<FilterKeys<Params, Location>>;
 type InitParam<Init> = RequiredKeysOf<Init> extends never ? [(Init & {
@@ -375,14 +427,10 @@ type MethodResponse<CreatedClient extends Client<any, any>, Method extends HttpM
   [key: string]: any;
 }, infer Media extends MediaType> ? NonNullable<FetchResponse<Paths[Path][Method], Options, Media>["data"]> : never;
 type PathBasedClient<Paths extends Record<string | number, any>, Media extends MediaType = MediaType> = { [Path in keyof Paths]: ClientForPath<Paths[Path], Media>; };
-//#endregion
-//#region src/client.d.ts
 /**
  * Create an openapi-fetch client.
  */
 export default function createClient<Paths extends {}, Media extends MediaType = MediaType>(clientOptions?: ClientOptions): Client<Paths, Media>;
-//#endregion
-//#region src/path-client.d.ts
 /**
  * Wrap openapi-fetch client to support a path based API.
  */
@@ -392,12 +440,8 @@ export declare function wrapAsPathBasedClient<Paths extends {}, Media extends Me
  * Strictly equivalent to `wrapAsPathBasedClient(createClient(...))`.
  */
 export declare function createPathBasedClient<Paths extends {}, Media extends MediaType = MediaType>(clientOptions?: ClientOptions): PathBasedClient<Paths, Media>;
-//#endregion
-//#region src/headers.d.ts
 /** Merge headers a and b, with b taking priority */
 export declare function mergeHeaders(...allHeaders: (HeadersOptions | undefined)[]): Headers;
-//#endregion
-//#region src/serializers/param.d.ts
 type SerializePrimitiveOptions = {
   allowReserved?: boolean;
 };
@@ -417,23 +461,15 @@ type SerializeArrayOptions = {
 };
 /** Serialize array param (shallow only) */
 export declare function serializeArrayParam(name: string, value: unknown[], options: SerializeArrayOptions): string;
-//#endregion
-//#region src/serializers/query.d.ts
 /** Serialize query params to string */
 export declare function createQuerySerializer<T = unknown>(options?: QuerySerializerOptions): (queryParams: T) => string;
-//#endregion
-//#region src/serializers/path.d.ts
 /**
  * Handle different OpenAPI 3.x serialization styles
  * @see https://swagger.io/docs/specification/serialization/#path
  */
 export declare function defaultPathSerializer(pathname: string, pathParams: Record<string, unknown>): string;
-//#endregion
-//#region src/serializers/body.d.ts
 /** Serialize body object to string */
 export declare function defaultBodySerializer<T>(body: T, headers?: Headers | Record<string, unknown>): string | FormData;
-//#endregion
-//#region src/serializers/url.d.ts
 /** Construct URL string from baseUrl and handle path and query params */
 export declare function createFinalURL<O>(pathname: string, options: {
   baseUrl: string;
@@ -446,5 +482,4 @@ export declare function createFinalURL<O>(pathname: string, options: {
 }): string;
 /** Remove trailing slash from url */
 export declare function removeTrailingSlash(url: string): string;
-//#endregion
-export { type $Read, type $Write, type BodySerializer, type Client, type ClientForPath, type ClientMethod, type ClientOptions, type ClientPathsWithMethod, type ClientRequestMethod, type DefaultParamsOption, type ErrorResponse, type ErrorResponseJSON, type ErrorStatus, type FetchOptions, type FetchResponse, type FilterKeys, type FirstErrorStatus, type GetResponseContent, type HeadersOptions, type HttpMethod, type IsOperationRequestBodyOptional, type JSONLike, type MaybeOptionalInit, type MediaType, type MergedOptions, type MethodResponse, type Middleware, type MiddlewareCallbackParams, type MiddlewareRequestParams, type OKStatusUnion, type OkStatus, type OperationObject, type OperationRequestBody, type OperationRequestBodyContent, type OperationRequestBodyMediaContent, type ParamsOption, type ParseAs, type ParseAsResponse, type PathBasedClient, type PathItemObject, type PathSerializer, type PathsWithMethod, type QuerySerializer, type QuerySerializerOptions, type Readable, type RequestBodyJSON, type RequestBodyOption, type RequestOptions, type RequiredKeysOf, type ResponseContent, type ResponseObjectMap, type SuccessResponse, type SuccessResponseJSON, type Writable, createClient };
+export { type $Read, type $Write, type BodySerializer, type Client, type ClientForPath, type ClientMethod, type ClientOptions, type ClientPathsWithMethod, type ClientRequestMethod, type DefaultParamsOption, type ErrorResponse, type ErrorResponseJSON, type ErrorStatus, type FetchOptions, type FetchResponse, type FilterKeys, type FirstErrorStatus, type GetResponseContent, type HeadersOptions, type HttpMethod, type IsOperationRequestBodyOptional, type JSONLike, type MaybeOptionalInit, type MediaType, type MergedOptions, type MethodResponse, type Middleware, type MiddlewareCallbackParams, type MiddlewareRequestInitParams, type MiddlewareRequestInput, type MiddlewareRequestParams, type MiddlewareResult, type MiddlewareResultParams, type OKStatusUnion, type OkStatus, type OperationObject, type OperationRequestBody, type OperationRequestBodyContent, type OperationRequestBodyMediaContent, type ParamsOption, type ParseAs, type ParseAsResponse, type PathBasedClient, type PathItemObject, type PathSerializer, type PathsWithMethod, type QuerySerializer, type QuerySerializerOptions, type Readable, type RequestBodyJSON, type RequestBodyOption, type RequestOptions, type RequiredKeysOf, type ResponseContent, type ResponseObjectMap, type SuccessResponse, type SuccessResponseJSON, type Writable, createClient };

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-//#region src/helpers.d.ts
 type HttpMethod = "get" | "put" | "post" | "delete" | "options" | "head" | "patch" | "trace";
 /** 2XX statuses */
 type OkStatus = 200 | 201 | 202 | 203 | 204 | 206 | 207 | "2XX";
@@ -190,8 +189,29 @@ type Readable<T> = T extends $Write<any> ? never : T extends $Read<infer U> ? Re
  * - object → recursively resolve
  */
 type Writable<T> = T extends $Read<any> ? never : T extends $Write<infer U> ? Writable<U> : T extends (infer E)[] ? Writable<E>[] : T extends object ? { [K in keyof T as NonNullable<T[K]> extends $Read<any> ? never : K]: Writable<T[K]>; } & { [K in keyof T as NonNullable<T[K]> extends $Read<any> ? K : never]?: never; } : T;
-//#endregion
-//#region src/types.d.ts
+interface CaseSchema {
+  readonly ref?: string;
+  readonly properties?: Readonly<Record<string, {
+    readonly name: string;
+    readonly schema?: CaseSchema;
+  }>>;
+  readonly declared?: readonly string[];
+  readonly items?: CaseSchema;
+  readonly prefixItems?: readonly (CaseSchema | null)[];
+  readonly additionalProperties?: CaseSchema;
+  readonly patternProperties?: Readonly<Record<string, CaseSchema | null>>;
+  readonly variants?: readonly CaseSchema[];
+}
+type CaseMediaMap = Readonly<Record<string, CaseSchema | null>>;
+interface CaseOperation {
+  readonly parameters?: Readonly<Partial<Record<"path" | "query" | "header" | "cookie", CaseSchema>>>;
+  readonly requestBodies?: CaseMediaMap;
+  readonly responses?: Readonly<Record<string, CaseMediaMap | null>>;
+}
+interface CaseMapping {
+  readonly schemas?: Readonly<Record<string, CaseSchema>>;
+  readonly operations?: Readonly<Record<string, CaseOperation>>;
+}
 /** Options for each client instance */
 interface ClientOptions extends Omit<RequestInit, "headers"> {
   /** set the common root URL for all API requests */
@@ -206,6 +226,8 @@ interface ClientOptions extends Omit<RequestInit, "headers"> {
   bodySerializer?: BodySerializer<unknown>;
   /** global pathSerializer */
   pathSerializer?: PathSerializer;
+  /** schema-based field mapping applied to every request and parsed result */
+  caseMapping?: CaseMapping;
   headers?: HeadersOptions;
   /** RequestInit extension object to pass as 2nd argument to fetch when supported (defaults to undefined) */
   requestInitExt?: Record<string, unknown>;
@@ -301,10 +323,28 @@ type MergedOptions<T = unknown> = {
 };
 interface MiddlewareRequestParams {
   query?: Record<string, unknown>;
-  header?: Record<string, unknown>;
+  header?: HeadersOptions;
   path?: Record<string, unknown>;
   cookie?: Record<string, unknown>;
 }
+interface MiddlewareRequestInput {
+  readonly params: MiddlewareRequestParams;
+  readonly body: unknown;
+}
+interface MiddlewareRequestInitParams {
+  readonly schemaPath: string;
+  readonly method: string;
+  readonly input: MiddlewareRequestInput;
+  /** Client, request, and parameter headers merged before serialization. */
+  readonly headers: Headers;
+  readonly id: string;
+  readonly options: MergedOptions;
+}
+interface MiddlewareResult {
+  readonly data?: unknown;
+  readonly error?: unknown;
+  readonly response: Response;
+}
 interface MiddlewareCallbackParams {
   /** Current Request object */
   request: Request;
@@ -317,6 +357,12 @@ interface MiddlewareCallbackParams {
   /** createClient options (read-only) */
   readonly options: MergedOptions;
 }
+interface MiddlewareResultParams extends MiddlewareCallbackParams {
+  /** The method requested through the client, before HTTP middleware can replace the Request. */
+  readonly method: string;
+  readonly result: MiddlewareResult;
+}
+type MiddlewareOnRequestInit = (options: MiddlewareRequestInitParams) => void | MiddlewareRequestInput | Promise<MiddlewareRequestInput | void>;
 type MiddlewareOnRequest = (options: MiddlewareCallbackParams) => void | Request | Response | undefined | Promise<Request | Response | undefined | void>;
 type MiddlewareOnResponse = (options: MiddlewareCallbackParams & {
   response: Response;
@@ -324,19 +370,25 @@ type MiddlewareOnResponse = (options: MiddlewareCallbackParams & {
 type MiddlewareOnError = (options: MiddlewareCallbackParams & {
   error: unknown;
 }) => void | Response | Error | Promise<void | Response | Error>;
-type Middleware = {
-  onRequest: MiddlewareOnRequest;
+type MiddlewareOnResult = (options: MiddlewareResultParams) => void | Partial<Pick<MiddlewareResult, "data" | "error">> | Promise<Partial<Pick<MiddlewareResult, "data" | "error">> | void>;
+interface MiddlewareHooks {
+  onRequestInit?: MiddlewareOnRequestInit;
+  onRequest?: MiddlewareOnRequest;
   onResponse?: MiddlewareOnResponse;
   onError?: MiddlewareOnError;
+  onResult?: MiddlewareOnResult;
+}
+type Middleware = MiddlewareHooks & ({
+  onRequestInit: MiddlewareOnRequestInit;
+} | {
+  onRequest: MiddlewareOnRequest;
 } | {
-  onRequest?: MiddlewareOnRequest;
   onResponse: MiddlewareOnResponse;
-  onError?: MiddlewareOnError;
 } | {
-  onRequest?: MiddlewareOnRequest;
-  onResponse?: MiddlewareOnResponse;
   onError: MiddlewareOnError;
-};
+} | {
+  onResult: MiddlewareOnResult;
+});
 /** This type helper makes the 2nd function param required if params/requestBody are required; otherwise, optional */
 type MaybeOptionalInit<Params, Location extends keyof Params> = RequiredKeysOf<FetchOptions<FilterKeys<Params, Location>>> extends never ? FetchOptions<FilterKeys<Params, Location>> | undefined : FetchOptions<FilterKeys<Params, Location>>;
 type InitParam<Init> = RequiredKeysOf<Init> extends never ? [(Init & {
@@ -375,14 +427,10 @@ type MethodResponse<CreatedClient extends Client<any, any>, Method extends HttpM
   [key: string]: any;
 }, infer Media extends MediaType> ? NonNullable<FetchResponse<Paths[Path][Method], Options, Media>["data"]> : never;
 type PathBasedClient<Paths extends Record<string | number, any>, Media extends MediaType = MediaType> = { [Path in keyof Paths]: ClientForPath<Paths[Path], Media>; };
-//#endregion
-//#region src/client.d.ts
 /**
  * Create an openapi-fetch client.
  */
 export default function createClient<Paths extends {}, Media extends MediaType = MediaType>(clientOptions?: ClientOptions): Client<Paths, Media>;
-//#endregion
-//#region src/path-client.d.ts
 /**
  * Wrap openapi-fetch client to support a path based API.
  */
@@ -392,12 +440,8 @@ export declare function wrapAsPathBasedClient<Paths extends {}, Media extends Me
  * Strictly equivalent to `wrapAsPathBasedClient(createClient(...))`.
  */
 export declare function createPathBasedClient<Paths extends {}, Media extends MediaType = MediaType>(clientOptions?: ClientOptions): PathBasedClient<Paths, Media>;
-//#endregion
-//#region src/headers.d.ts
 /** Merge headers a and b, with b taking priority */
 export declare function mergeHeaders(...allHeaders: (HeadersOptions | undefined)[]): Headers;
-//#endregion
-//#region src/serializers/param.d.ts
 type SerializePrimitiveOptions = {
   allowReserved?: boolean;
 };
@@ -417,23 +461,15 @@ type SerializeArrayOptions = {
 };
 /** Serialize array param (shallow only) */
 export declare function serializeArrayParam(name: string, value: unknown[], options: SerializeArrayOptions): string;
-//#endregion
-//#region src/serializers/query.d.ts
 /** Serialize query params to string */
 export declare function createQuerySerializer<T = unknown>(options?: QuerySerializerOptions): (queryParams: T) => string;
-//#endregion
-//#region src/serializers/path.d.ts
 /**
  * Handle different OpenAPI 3.x serialization styles
  * @see https://swagger.io/docs/specification/serialization/#path
  */
 export declare function defaultPathSerializer(pathname: string, pathParams: Record<string, unknown>): string;
-//#endregion
-//#region src/serializers/body.d.ts
 /** Serialize body object to string */
 export declare function defaultBodySerializer<T>(body: T, headers?: Headers | Record<string, unknown>): string | FormData;
-//#endregion
-//#region src/serializers/url.d.ts
 /** Construct URL string from baseUrl and handle path and query params */
 export declare function createFinalURL<O>(pathname: string, options: {
   baseUrl: string;
@@ -446,5 +482,4 @@ export declare function createFinalURL<O>(pathname: string, options: {
 }): string;
 /** Remove trailing slash from url */
 export declare function removeTrailingSlash(url: string): string;
-//#endregion
-export { type $Read, type $Write, type BodySerializer, type Client, type ClientForPath, type ClientMethod, type ClientOptions, type ClientPathsWithMethod, type ClientRequestMethod, type DefaultParamsOption, type ErrorResponse, type ErrorResponseJSON, type ErrorStatus, type FetchOptions, type FetchResponse, type FilterKeys, type FirstErrorStatus, type GetResponseContent, type HeadersOptions, type HttpMethod, type IsOperationRequestBodyOptional, type JSONLike, type MaybeOptionalInit, type MediaType, type MergedOptions, type MethodResponse, type Middleware, type MiddlewareCallbackParams, type MiddlewareRequestParams, type OKStatusUnion, type OkStatus, type OperationObject, type OperationRequestBody, type OperationRequestBodyContent, type OperationRequestBodyMediaContent, type ParamsOption, type ParseAs, type ParseAsResponse, type PathBasedClient, type PathItemObject, type PathSerializer, type PathsWithMethod, type QuerySerializer, type QuerySerializerOptions, type Readable, type RequestBodyJSON, type RequestBodyOption, type RequestOptions, type RequiredKeysOf, type ResponseContent, type ResponseObjectMap, type SuccessResponse, type SuccessResponseJSON, type Writable, createClient };
+export { type $Read, type $Write, type BodySerializer, type Client, type ClientForPath, type ClientMethod, type ClientOptions, type ClientPathsWithMethod, type ClientRequestMethod, type DefaultParamsOption, type ErrorResponse, type ErrorResponseJSON, type ErrorStatus, type FetchOptions, type FetchResponse, type FilterKeys, type FirstErrorStatus, type GetResponseContent, type HeadersOptions, type HttpMethod, type IsOperationRequestBodyOptional, type JSONLike, type MaybeOptionalInit, type MediaType, type MergedOptions, type MethodResponse, type Middleware, type MiddlewareCallbackParams, type MiddlewareRequestInitParams, type MiddlewareRequestInput, type MiddlewareRequestParams, type MiddlewareResult, type MiddlewareResultParams, type OKStatusUnion, type OkStatus, type OperationObject, type OperationRequestBody, type OperationRequestBodyContent, type OperationRequestBodyMediaContent, type ParamsOption, type ParseAs, type ParseAsResponse, type PathBasedClient, type PathItemObject, type PathSerializer, type PathsWithMethod, type QuerySerializer, type QuerySerializerOptions, type Readable, type RequestBodyJSON, type RequestBodyOption, type RequestOptions, type RequiredKeysOf, type ResponseContent, type ResponseObjectMap, type SuccessResponse, type SuccessResponseJSON, type Writable, createClient };