api-def 0.12.0-alpha.4 → 0.12.0-alpha.5

package/bin/index.js

@@ -258573,11 +258573,21 @@ ${Object.entries(routes).flatMap(([path2, route]) => {
       const id = methodDef.operationId;
       const responseStatuses = Object.keys(methodDef.responses);
       const successfulResponse = responseStatuses.filter((status) => status.startsWith("2") || status.startsWith("3"));
+      let responseType = void 0;
       const responseTypes = [];
       for (const status of successfulResponse) {
         const response = methodDef.responses[status];
         if (response.$ref) {
-          responseTypes.push(`Response${response.$ref.split("/").pop()}`);
+          const responseDef = bundleResults.bundle.parsed.components.responses[response.$ref.split("/").pop()];
+          for (const mediaType in responseDef.content) {
+            const schema = responseDef.content[mediaType].schema;
+            if (!responseType) {
+              responseType = mediaType.split(";")[0];
+            }
+            if (schema?.$ref) {
+              responseTypes.push(`Schema${schema.$ref.split("/").pop()}`);
+            }
+          }
         }
       }
       const bodyTypes = [];
@@ -258603,10 +258613,32 @@ ${Object.entries(routes).flatMap(([path2, route]) => {
           queryTypes.push(`Query${(0, import_lodash.upperFirst)(id)}`);
         }
       }
+      const requestHeaderTypes = [];
+      if (methodDef.parameters?.length) {
+        const anyHeaderParams = methodDef.parameters.some((param) => {
+          if (param.in === "header") {
+            return true;
+          }
+          if (param.$ref) {
+            const ref = param.$ref;
+            const paramDef = bundleResults.bundle.parsed.components.parameters[ref.split("/").pop()];
+            return paramDef.in === "header";
+          }
+          return false;
+        });
+        if (anyHeaderParams) {
+          extraTypes += `export type Header${(0, import_lodash.upperFirst)(id)} = operations["${id}"]["parameters"]["header"];
+`;
+          requestHeaderTypes.push(`Header${(0, import_lodash.upperFirst)(id)}`);
+        }
+      }
+      const responseHeaderTypes = [];
       const endpointParts = [
-        responseTypes.length > 0 ? `.response<${responseTypes.join("|")}>()` : "",
-        bodyTypes.length > 0 ? `.body<${bodyTypes.join("|")}>()` : "",
-        queryTypes.length > 0 ? `.query<${queryTypes.join("|")}>()` : ""
+        responseTypes.length > 0 ? `.responseOf<${responseTypes.join("|")}>()` : "",
+        bodyTypes.length > 0 ? `.bodyOf<${bodyTypes.join("|")}>()` : "",
+        queryTypes.length > 0 ? `.queryOf<${queryTypes.join("|")}>()` : "",
+        requestHeaderTypes.length > 0 ? `.requestHeadersOf<${requestHeaderTypes.join("|")}>()` : "",
+        responseHeaderTypes.length > 0 ? `.responseHeadersOf<${responseHeaderTypes.join("|")}>()` : ""
       ];
       return `export const ${id} = API.endpoint()
 ${endpointParts.filter(Boolean).map((part) => `  ${part}`).join("\n")}
@@ -258636,10 +258668,17 @@ program.name("api-def");
 var packageJson = JSON.parse(fs2.readFileSync("package.json", "utf-8"));
 program.version(packageJson.version);
 program.command("generate").argument("<inPath>", "Path to the OpenAPI spec").argument("<outPath>", "Path to the output file").description("Generate an api-def from an OpenAPI spec").action(async (inPath, outPath) => {
+  const resolvedInPath = path.resolve(inPath);
+  if (!fs2.existsSync(resolvedInPath)) {
+    console.error(`File not found: ${resolvedInPath}`);
+    process.exit(1);
+  }
   const output = await openApiToSourceCode({
-    openApiPath: path.resolve(inPath)
+    openApiPath: resolvedInPath
   });
-  fs2.writeFileSync(path.resolve(outPath), output);
+  fs2.writeFileSync(path.resolve(outPath), `// Generated by 'api-def' version ${packageJson.version}
+${output}`);
+  console.log(`Generated api-def at ${outPath}`);
 });
 program.parse(process.argv);
 /*! Bundled license information:

package/cjs/Api.js

@@ -75,14 +75,14 @@ var HotRequestHost = /** @class */ (function () {
         configurable: true
     });
     HotRequestHost.prototype.computeConfig = function (config) {
-        var apiDefaults = this.api.getConfig();
+        var apiDefaults = this.api.computeRequestConfig();
         return (0, RequestConfig_1.processRequestConfigs)([apiDefaults, config]);
     };
     HotRequestHost.prototype.computePath = function (path, config) {
         return path.startsWith("/") ? path : "/".concat(path);
     };
     HotRequestHost.prototype.getRequestBackend = function () {
-        return this.api.getRequestBackend();
+        return this.api.requestBackend;
     };
     return HotRequestHost;
 }());

package/cjs/ApiTypes.d.ts

@@ -43,7 +43,7 @@ export interface BaseRequestConfig {
     queryParser?: QueryStringify;
     queryHandling?: Partial<QueryHandling>;
 }
-export type RequestConfig<TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> = (TParams extends undefined ? {
+export type RequestConfig<TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined> = (TParams extends undefined ? {
     params?: never;
 } : {
     params: Record<TParams extends Params ? TParams : never, string>;
@@ -59,9 +59,11 @@ export type RequestConfig<TParams extends Params | undefined = Params | undefine
     state?: TState;
 } : {
     state: TState;
-}) & BaseRequestConfig;
+}) & (Omit<BaseRequestConfig, "headers"> & {
+    headers?: TRequestHeaders & RawHeaders;
+});
 export declare const COMPUTED_CONFIG_SYMBOL: unique symbol;
-export type ComputedRequestConfig<TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> = Omit<RequestConfig<TParams, TQuery, TBody, TState>, "queryParser" | "query" | "queryHandling" | "state"> & {
+export type ComputedRequestConfig<TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined> = Omit<RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>, "queryParser" | "query" | "queryHandling" | "state"> & {
     [COMPUTED_CONFIG_SYMBOL]: true;
     state: TState;
     queryObject: Record<string, any> | undefined;
@@ -97,7 +99,7 @@ export interface RequestHost {
     readonly path: string;
     readonly responseType: ResponseType | undefined;
     readonly validation: Validation;
-    computeConfig<TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State>(config: RequestConfig<TParams, TQuery, TBody, TState>): ComputedRequestConfig<TParams, TQuery, TBody, TState>;
+    computeConfig<TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State, TRequestHeaders extends RawHeaders | undefined>(config: RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>): ComputedRequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>;
     computePath(path: string, config: RequestConfig): string;
     getRequestBackend(): RequestBackend;
 }

package/cjs/Endpoint.d.ts

@@ -1,10 +1,10 @@
 import type { Api } from "./Api";
 import type { RequestMethod, ResponseType } from "./ApiConstants";
-import type { ApiResponse, BaseRequestConfig, Body, ComputedRequestConfig, Params, Query, RequestConfig, RequestHost, State } from "./ApiTypes";
+import type { ApiResponse, BaseRequestConfig, Body, ComputedRequestConfig, Params, Query, RawHeaders, RequestConfig, RequestHost, State } from "./ApiTypes";
 import type * as Mocking from "./MockingTypes";
 import type { Validation } from "./Validation";
 import type RequestBackend from "./backend/RequestBackend";
-export interface EndpointOptions<TResult, TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State = State, TPath extends string = string> {
+export interface EndpointOptions<TResult, TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State = State, TPath extends string = string, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined, TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined> {
     readonly id: string;
     readonly method: RequestMethod;
     readonly path: TPath;
@@ -32,18 +32,18 @@ export interface EndpointOptions<TResult, TParams extends Params | undefined, TQ
     readonly mocking?: Mocking.EndpointMockingConfig<TResult, TParams, TQuery, TBody, TState>;
     readonly validation?: Validation<TResult, TParams, TQuery, TBody, TState>;
 }
-export type EndpointInfo<TResult, TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State = State, TPath extends string = string> = EndpointOptions<TResult, TParams, TQuery, TBody, TState, TPath> & Required<Pick<EndpointOptions<TResult, TParams, TQuery, TBody, TState, TPath>, "name" | "validation">>;
+export type EndpointInfo<TResult, TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State = State, TPath extends string = string, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined, TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined> = EndpointOptions<TResult, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders> & Required<Pick<EndpointOptions<TResult, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>, "name" | "validation">>;
 /**
  * @deprecated Use `EndpointInfo` instead
  */
-export type EndpointConfig<TResult, TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State = State, TPath extends string = string> = EndpointInfo<TResult, TParams, TQuery, TBody, TState, TPath>;
-export default class Endpoint<TResponse = any, TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> implements EndpointInfo<TResponse, TParams, TQuery, TBody, TState>, RequestHost {
+export type EndpointConfig<TResult, TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State = State, TPath extends string = string, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined, TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined> = EndpointInfo<TResult, TParams, TQuery, TBody, TState, TPath>;
+export default class Endpoint<TResponse = any, TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State, TPath extends string = string, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined, TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined> implements EndpointInfo<TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>, RequestHost {
     readonly api: Api;
     private readonly info;
-    constructor(api: Api, options: EndpointOptions<TResponse, TParams, TQuery, TBody, TState>);
+    constructor(api: Api, options: EndpointOptions<TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>);
     get id(): string;
     get method(): RequestMethod;
-    get path(): string;
+    get path(): TPath;
     get name(): string;
     get description(): string | undefined;
     get config(): BaseRequestConfig;
@@ -56,7 +56,7 @@ export default class Endpoint<TResponse = any, TParams extends Params | undefine
     /**
      * @deprecated Use `computeRequestConfig` instead
      */
-    computeConfig<TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State>(config: RequestConfig<TParams, TQuery, TBody, TState>): ComputedRequestConfig<TParams, TQuery, TBody, TState>;
-    computeRequestConfig<TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State>(config: RequestConfig<TParams, TQuery, TBody, TState>): ComputedRequestConfig<TParams, TQuery, TBody, TState>;
+    computeConfig<TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State, TRequestHeaders extends RawHeaders | undefined>(config: RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>): ComputedRequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>;
+    computeRequestConfig<TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State, TRequestHeaders extends RawHeaders | undefined>(config: RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>): ComputedRequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>;
     getRequestBackend(): RequestBackend;
 }

package/cjs/EndpointBuilder.d.ts

@@ -1,15 +1,17 @@
 import type * as zod from "zod";
 import type { Api } from "./Api";
-import type { Body, Params, Query, State } from "./ApiTypes";
-import Endpoint, { type EndpointConfig } from "./Endpoint";
-export default class EndpointBuilder<TResponse = any, TParams extends Params | undefined = undefined, TQuery extends Query | undefined = undefined, TBody extends Body | undefined = undefined, TState extends State = State> {
+import type { Body, Params, Query, RawHeaders, State } from "./ApiTypes";
+import Endpoint, { type EndpointOptions } from "./Endpoint";
+export default class EndpointBuilder<TResponse = any, TParams extends Params | undefined = undefined, TQuery extends Query | undefined = undefined, TBody extends Body | undefined = undefined, TState extends State = State, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined, TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined> {
     private api;
     private readonly validation;
     constructor(api: Api);
-    queryOf<TNewQuery extends Query>(schema?: zod.Schema<TNewQuery>): EndpointBuilder<TResponse, TParams, TNewQuery, TBody>;
-    paramsOf<TNewParams extends Params>(): EndpointBuilder<TResponse, TNewParams, TQuery, TBody, TState>;
-    bodyOf<TNewBody extends Body>(schema?: zod.Schema<TNewBody>): EndpointBuilder<TResponse, TParams, TQuery, TNewBody, TState>;
-    responseOf<TNewResponse>(schema?: zod.Schema<TNewResponse>): EndpointBuilder<TNewResponse, TParams, TQuery, TBody, TState>;
-    stateOf<TNewState extends State>(schema?: zod.Schema<TNewState>): EndpointBuilder<TResponse, TParams, TQuery, TBody, TNewState>;
-    build<TPath extends string>(config: Omit<EndpointConfig<TResponse, TParams, TQuery, TBody, TState, TPath>, "validation">): Endpoint<TResponse, TParams, TQuery, TBody, TState>;
+    queryOf<TNewQuery extends Query>(schema?: zod.Schema<TNewQuery>): EndpointBuilder<TResponse, TParams, TNewQuery, TBody, TState, TRequestHeaders, TResponseHeaders>;
+    paramsOf<TNewParams extends Params>(): EndpointBuilder<TResponse, TNewParams, TQuery, TBody, TState, TRequestHeaders, TResponseHeaders>;
+    bodyOf<TNewBody extends Body>(schema?: zod.Schema<TNewBody>): EndpointBuilder<TResponse, TParams, TQuery, TNewBody, TState, TRequestHeaders, TResponseHeaders>;
+    responseOf<TNewResponse>(schema?: zod.Schema<TNewResponse>): EndpointBuilder<TNewResponse, TParams, TQuery, TBody, TState, TRequestHeaders, TResponseHeaders>;
+    stateOf<TNewState extends State>(schema?: zod.Schema<TNewState>): EndpointBuilder<TResponse, TParams, TQuery, TBody, TNewState, TRequestHeaders, TResponseHeaders>;
+    requestHeadersOf<TNewRequestHeaders extends RawHeaders>(): EndpointBuilder<TResponse, TParams, TQuery, TBody, TState, TNewRequestHeaders, TResponseHeaders>;
+    responseHeadersOf<TNewResponseHeaders extends RawHeaders>(): EndpointBuilder<TResponse, TParams, TQuery, TBody, TState, TRequestHeaders, TNewResponseHeaders>;
+    build<TPath extends string>(options: Omit<EndpointOptions<TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>, "validation">): Endpoint<TResponse, TParams, TQuery, TBody, TState>;
 }

package/cjs/EndpointBuilder.js

@@ -40,8 +40,14 @@ var EndpointBuilder = /** @class */ (function () {
         this.validation.state = schema;
         return this;
     };
-    EndpointBuilder.prototype.build = function (config) {
-        var endpoint = new Endpoint_1.default(this.api, __assign(__assign({}, config), { validation: this.validation }));
+    EndpointBuilder.prototype.requestHeadersOf = function () {
+        return this;
+    };
+    EndpointBuilder.prototype.responseHeadersOf = function () {
+        return this;
+    };
+    EndpointBuilder.prototype.build = function (options) {
+        var endpoint = new Endpoint_1.default(this.api, __assign(__assign({}, options), { validation: this.validation }));
         this.api.endpoints[endpoint.id] = endpoint;
         return endpoint;
     };

package/cjs/RequestConfig.d.ts

@@ -1,2 +1,2 @@
-import { type BaseRequestConfig, type Body, type ComputedRequestConfig, type Params, type Query, type RequestConfig, type State } from "./ApiTypes";
-export declare const processRequestConfigs: <TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State>(configs: (RequestConfig<TParams, TQuery, TBody, TState> | BaseRequestConfig | undefined)[]) => ComputedRequestConfig<TParams, TQuery, TBody, TState>;
+import { type BaseRequestConfig, type Body, type ComputedRequestConfig, type Params, type Query, type RawHeaders, type RequestConfig, type State } from "./ApiTypes";
+export declare const processRequestConfigs: <TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State, TRequestHeaders extends RawHeaders | undefined>(configs: (RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders> | BaseRequestConfig | undefined)[]) => ComputedRequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>;

package/esm/Api.js

@@ -38,14 +38,14 @@ class HotRequestHost {
         return this.api.baseUrl;
     }
     computeConfig(config) {
-        const apiDefaults = this.api.getConfig();
+        const apiDefaults = this.api.computeRequestConfig();
         return processRequestConfigs([apiDefaults, config]);
     }
     computePath(path, config) {
         return path.startsWith("/") ? path : `/${path}`;
     }
     getRequestBackend() {
-        return this.api.getRequestBackend();
+        return this.api.requestBackend;
     }
 }
 export class Api {

package/esm/ApiTypes.d.ts

@@ -43,7 +43,7 @@ export interface BaseRequestConfig {
     queryParser?: QueryStringify;
     queryHandling?: Partial<QueryHandling>;
 }
-export type RequestConfig<TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> = (TParams extends undefined ? {
+export type RequestConfig<TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined> = (TParams extends undefined ? {
     params?: never;
 } : {
     params: Record<TParams extends Params ? TParams : never, string>;
@@ -59,9 +59,11 @@ export type RequestConfig<TParams extends Params | undefined = Params | undefine
     state?: TState;
 } : {
     state: TState;
-}) & BaseRequestConfig;
+}) & (Omit<BaseRequestConfig, "headers"> & {
+    headers?: TRequestHeaders & RawHeaders;
+});
 export declare const COMPUTED_CONFIG_SYMBOL: unique symbol;
-export type ComputedRequestConfig<TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> = Omit<RequestConfig<TParams, TQuery, TBody, TState>, "queryParser" | "query" | "queryHandling" | "state"> & {
+export type ComputedRequestConfig<TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined> = Omit<RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>, "queryParser" | "query" | "queryHandling" | "state"> & {
     [COMPUTED_CONFIG_SYMBOL]: true;
     state: TState;
     queryObject: Record<string, any> | undefined;
@@ -97,7 +99,7 @@ export interface RequestHost {
     readonly path: string;
     readonly responseType: ResponseType | undefined;
     readonly validation: Validation;
-    computeConfig<TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State>(config: RequestConfig<TParams, TQuery, TBody, TState>): ComputedRequestConfig<TParams, TQuery, TBody, TState>;
+    computeConfig<TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State, TRequestHeaders extends RawHeaders | undefined>(config: RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>): ComputedRequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>;
     computePath(path: string, config: RequestConfig): string;
     getRequestBackend(): RequestBackend;
 }

package/esm/Endpoint.d.ts

@@ -1,10 +1,10 @@
 import type { Api } from "./Api";
 import type { RequestMethod, ResponseType } from "./ApiConstants";
-import type { ApiResponse, BaseRequestConfig, Body, ComputedRequestConfig, Params, Query, RequestConfig, RequestHost, State } from "./ApiTypes";
+import type { ApiResponse, BaseRequestConfig, Body, ComputedRequestConfig, Params, Query, RawHeaders, RequestConfig, RequestHost, State } from "./ApiTypes";
 import type * as Mocking from "./MockingTypes";
 import type { Validation } from "./Validation";
 import type RequestBackend from "./backend/RequestBackend";
-export interface EndpointOptions<TResult, TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State = State, TPath extends string = string> {
+export interface EndpointOptions<TResult, TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State = State, TPath extends string = string, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined, TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined> {
     readonly id: string;
     readonly method: RequestMethod;
     readonly path: TPath;
@@ -32,18 +32,18 @@ export interface EndpointOptions<TResult, TParams extends Params | undefined, TQ
     readonly mocking?: Mocking.EndpointMockingConfig<TResult, TParams, TQuery, TBody, TState>;
     readonly validation?: Validation<TResult, TParams, TQuery, TBody, TState>;
 }
-export type EndpointInfo<TResult, TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State = State, TPath extends string = string> = EndpointOptions<TResult, TParams, TQuery, TBody, TState, TPath> & Required<Pick<EndpointOptions<TResult, TParams, TQuery, TBody, TState, TPath>, "name" | "validation">>;
+export type EndpointInfo<TResult, TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State = State, TPath extends string = string, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined, TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined> = EndpointOptions<TResult, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders> & Required<Pick<EndpointOptions<TResult, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>, "name" | "validation">>;
 /**
  * @deprecated Use `EndpointInfo` instead
  */
-export type EndpointConfig<TResult, TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State = State, TPath extends string = string> = EndpointInfo<TResult, TParams, TQuery, TBody, TState, TPath>;
-export default class Endpoint<TResponse = any, TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State> implements EndpointInfo<TResponse, TParams, TQuery, TBody, TState>, RequestHost {
+export type EndpointConfig<TResult, TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State = State, TPath extends string = string, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined, TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined> = EndpointInfo<TResult, TParams, TQuery, TBody, TState, TPath>;
+export default class Endpoint<TResponse = any, TParams extends Params | undefined = Params | undefined, TQuery extends Query | undefined = Query | undefined, TBody extends Body | undefined = Body | undefined, TState extends State = State, TPath extends string = string, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined, TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined> implements EndpointInfo<TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>, RequestHost {
     readonly api: Api;
     private readonly info;
-    constructor(api: Api, options: EndpointOptions<TResponse, TParams, TQuery, TBody, TState>);
+    constructor(api: Api, options: EndpointOptions<TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>);
     get id(): string;
     get method(): RequestMethod;
-    get path(): string;
+    get path(): TPath;
     get name(): string;
     get description(): string | undefined;
     get config(): BaseRequestConfig;
@@ -56,7 +56,7 @@ export default class Endpoint<TResponse = any, TParams extends Params | undefine
     /**
      * @deprecated Use `computeRequestConfig` instead
      */
-    computeConfig<TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State>(config: RequestConfig<TParams, TQuery, TBody, TState>): ComputedRequestConfig<TParams, TQuery, TBody, TState>;
-    computeRequestConfig<TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State>(config: RequestConfig<TParams, TQuery, TBody, TState>): ComputedRequestConfig<TParams, TQuery, TBody, TState>;
+    computeConfig<TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State, TRequestHeaders extends RawHeaders | undefined>(config: RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>): ComputedRequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>;
+    computeRequestConfig<TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State, TRequestHeaders extends RawHeaders | undefined>(config: RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>): ComputedRequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>;
     getRequestBackend(): RequestBackend;
 }

package/esm/EndpointBuilder.d.ts

@@ -1,15 +1,17 @@
 import type * as zod from "zod";
 import type { Api } from "./Api";
-import type { Body, Params, Query, State } from "./ApiTypes";
-import Endpoint, { type EndpointConfig } from "./Endpoint";
-export default class EndpointBuilder<TResponse = any, TParams extends Params | undefined = undefined, TQuery extends Query | undefined = undefined, TBody extends Body | undefined = undefined, TState extends State = State> {
+import type { Body, Params, Query, RawHeaders, State } from "./ApiTypes";
+import Endpoint, { type EndpointOptions } from "./Endpoint";
+export default class EndpointBuilder<TResponse = any, TParams extends Params | undefined = undefined, TQuery extends Query | undefined = undefined, TBody extends Body | undefined = undefined, TState extends State = State, TRequestHeaders extends RawHeaders | undefined = RawHeaders | undefined, TResponseHeaders extends RawHeaders | undefined = RawHeaders | undefined> {
     private api;
     private readonly validation;
     constructor(api: Api);
-    queryOf<TNewQuery extends Query>(schema?: zod.Schema<TNewQuery>): EndpointBuilder<TResponse, TParams, TNewQuery, TBody>;
-    paramsOf<TNewParams extends Params>(): EndpointBuilder<TResponse, TNewParams, TQuery, TBody, TState>;
-    bodyOf<TNewBody extends Body>(schema?: zod.Schema<TNewBody>): EndpointBuilder<TResponse, TParams, TQuery, TNewBody, TState>;
-    responseOf<TNewResponse>(schema?: zod.Schema<TNewResponse>): EndpointBuilder<TNewResponse, TParams, TQuery, TBody, TState>;
-    stateOf<TNewState extends State>(schema?: zod.Schema<TNewState>): EndpointBuilder<TResponse, TParams, TQuery, TBody, TNewState>;
-    build<TPath extends string>(config: Omit<EndpointConfig<TResponse, TParams, TQuery, TBody, TState, TPath>, "validation">): Endpoint<TResponse, TParams, TQuery, TBody, TState>;
+    queryOf<TNewQuery extends Query>(schema?: zod.Schema<TNewQuery>): EndpointBuilder<TResponse, TParams, TNewQuery, TBody, TState, TRequestHeaders, TResponseHeaders>;
+    paramsOf<TNewParams extends Params>(): EndpointBuilder<TResponse, TNewParams, TQuery, TBody, TState, TRequestHeaders, TResponseHeaders>;
+    bodyOf<TNewBody extends Body>(schema?: zod.Schema<TNewBody>): EndpointBuilder<TResponse, TParams, TQuery, TNewBody, TState, TRequestHeaders, TResponseHeaders>;
+    responseOf<TNewResponse>(schema?: zod.Schema<TNewResponse>): EndpointBuilder<TNewResponse, TParams, TQuery, TBody, TState, TRequestHeaders, TResponseHeaders>;
+    stateOf<TNewState extends State>(schema?: zod.Schema<TNewState>): EndpointBuilder<TResponse, TParams, TQuery, TBody, TNewState, TRequestHeaders, TResponseHeaders>;
+    requestHeadersOf<TNewRequestHeaders extends RawHeaders>(): EndpointBuilder<TResponse, TParams, TQuery, TBody, TState, TNewRequestHeaders, TResponseHeaders>;
+    responseHeadersOf<TNewResponseHeaders extends RawHeaders>(): EndpointBuilder<TResponse, TParams, TQuery, TBody, TState, TRequestHeaders, TNewResponseHeaders>;
+    build<TPath extends string>(options: Omit<EndpointOptions<TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>, "validation">): Endpoint<TResponse, TParams, TQuery, TBody, TState>;
 }

package/esm/EndpointBuilder.js

@@ -27,8 +27,14 @@ export default class EndpointBuilder {
         this.validation.state = schema;
         return this;
     }
-    build(config) {
-        const endpoint = new Endpoint(this.api, Object.assign(Object.assign({}, config), { validation: this.validation }));
+    requestHeadersOf() {
+        return this;
+    }
+    responseHeadersOf() {
+        return this;
+    }
+    build(options) {
+        const endpoint = new Endpoint(this.api, Object.assign(Object.assign({}, options), { validation: this.validation }));
         this.api.endpoints[endpoint.id] = endpoint;
         return endpoint;
     }

package/esm/RequestConfig.d.ts

@@ -1,2 +1,2 @@
-import { type BaseRequestConfig, type Body, type ComputedRequestConfig, type Params, type Query, type RequestConfig, type State } from "./ApiTypes";
-export declare const processRequestConfigs: <TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State>(configs: (RequestConfig<TParams, TQuery, TBody, TState> | BaseRequestConfig | undefined)[]) => ComputedRequestConfig<TParams, TQuery, TBody, TState>;
+import { type BaseRequestConfig, type Body, type ComputedRequestConfig, type Params, type Query, type RawHeaders, type RequestConfig, type State } from "./ApiTypes";
+export declare const processRequestConfigs: <TParams extends Params | undefined, TQuery extends Query | undefined, TBody extends Body | undefined, TState extends State, TRequestHeaders extends RawHeaders | undefined>(configs: (RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders> | BaseRequestConfig | undefined)[]) => ComputedRequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-def",
-  "version": "0.12.0-alpha.4",
+  "version": "0.12.0-alpha.5",
   "description": "Typed API definitions with middleware support",
   "main": "cjs/index.js",
   "types": "esm/index.d.ts",

package/bin/OpenApiToSourceCode.js

@@ -1,174 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
-    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.openApiToSourceCode = void 0;
-var fs = __importStar(require("node:fs"));
-var openapi_core_1 = require("@redocly/openapi-core");
-// @ts-ignore
-var chalk_1 = __importDefault(require("chalk"));
-var lodash_1 = require("lodash");
-var openapi_typescript_1 = __importStar(require("openapi-typescript"));
-var METHOD_COLORS = {
-    get: chalk_1.default.green,
-    post: chalk_1.default.blue,
-    put: chalk_1.default.yellow,
-    delete: chalk_1.default.red,
-    patch: chalk_1.default.magenta,
-};
-var openApiToSourceCode = function (options) { return __awaiter(void 0, void 0, void 0, function () {
-    var openApiPath, inContents, ast, bundleResults, _a, routes, server, extraTypes, source, types;
-    var _b;
-    return __generator(this, function (_c) {
-        switch (_c.label) {
-            case 0:
-                openApiPath = options.openApiPath;
-                inContents = fs.readFileSync(openApiPath, "utf-8");
-                return [4 /*yield*/, (0, openapi_typescript_1.default)(inContents, {
-                        rootTypes: true,
-                    })];
-            case 1:
-                ast = _c.sent();
-                _a = openapi_core_1.bundle;
-                _b = {
-                    ref: openApiPath
-                };
-                return [4 /*yield*/, (0, openapi_core_1.createConfig)({})];
-            case 2: return [4 /*yield*/, _a.apply(void 0, [(_b.config = _c.sent(),
-                        _b)])];
-            case 3:
-                bundleResults = _c.sent();
-                routes = bundleResults.bundle.parsed.paths;
-                server = bundleResults.bundle.parsed.servers[0];
-                extraTypes = "";
-                source = "import { Api } from \"api-def\";\n\nconst API = new Api({\n  name: \"".concat(bundleResults.bundle.parsed.info.title || "Generate Api", "\",\n  baseUrl: \"").concat(server.url, "\",\n});\n\n").concat(Object.entries(routes)
-                    .flatMap(function (_a) {
-                    var path = _a[0], route = _a[1];
-                    return Object.entries(route).map(function (_a) {
-                        var _b, _c;
-                        var method = _a[0], methodDef = _a[1];
-                        var id = methodDef.operationId;
-                        var responseStatuses = Object.keys(methodDef.responses);
-                        var successfulResponse = responseStatuses.filter(function (status) { return status.startsWith("2") || status.startsWith("3"); });
-                        var responseTypes = [];
-                        for (var _i = 0, successfulResponse_1 = successfulResponse; _i < successfulResponse_1.length; _i++) {
-                            var status_1 = successfulResponse_1[_i];
-                            var response = methodDef.responses[status_1];
-                            if (response.$ref) {
-                                responseTypes.push("Response".concat(response.$ref.split("/").pop()));
-                            }
-                        }
-                        var bodyTypes = [];
-                        if ((_b = methodDef.requestBody) === null || _b === void 0 ? void 0 : _b.$ref) {
-                            bodyTypes.push("RequestBody".concat(methodDef.requestBody.$ref.split("/").pop()));
-                        }
-                        var queryTypes = [];
-                        if ((_c = methodDef.parameters) === null || _c === void 0 ? void 0 : _c.length) {
-                            var anyQueryParams = methodDef.parameters.some(function (param) {
-                                if (param.in === "query") {
-                                    return true;
-                                }
-                                if (param.$ref) {
-                                    var ref = param.$ref;
-                                    var paramDef = bundleResults.bundle.parsed.components.parameters[ref.split("/").pop()];
-                                    return paramDef.in === "query";
-                                }
-                                return false;
-                            });
-                            if (anyQueryParams) {
-                                extraTypes += "export type Query".concat((0, lodash_1.upperFirst)(id), " = operations[\"").concat(id, "\"][\"parameters\"][\"query\"];\n");
-                                queryTypes.push("Query".concat((0, lodash_1.upperFirst)(id)));
-                            }
-                        }
-                        /*
-                        const methodColor = METHOD_COLORS[method] || chalk.gray;
-                        console.log(`Generating ${methodColor(method.toUpperCase())} '${id}'`);
-                         */
-                        var endpointParts = [
-                            responseTypes.length > 0 ? ".response<".concat(responseTypes.join("|"), ">()") : "",
-                            bodyTypes.length > 0 ? ".body<".concat(bodyTypes.join("|"), ">()") : "",
-                            queryTypes.length > 0 ? ".query<".concat(queryTypes.join("|"), ">()") : "",
-                        ];
-                        return "export const ".concat(id, " = API.endpoint()\n").concat(endpointParts
-                            .filter(Boolean)
-                            .map(function (part) { return "  ".concat(part); })
-                            .join("\n"), "\n  .build({\n    method: \"").concat(method, "\",\n    path: \"").concat(path, "\",\n    id: \"").concat(id, "\",\n  });");
-                    });
-                })
-                    .join("\n\n"), "\n\nexport default API;\n    ");
-                types = (0, openapi_typescript_1.astToString)(ast);
-                return [2 /*return*/, "// Type Defs\n\n".concat(types, "\n").concat(extraTypes, "\n\n//API Def\n\n").concat(source)];
-        }
-    });
-}); };
-exports.openApiToSourceCode = openApiToSourceCode;