api-def 0.11.1 → 0.12.0-alpha.10

package/cjs/middleware/CacheMiddleware.js

@@ -9,8 +9,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 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;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    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.");

package/esm/Api.d.ts

@@ -6,26 +6,41 @@ import type RequestBackend from "./backend/RequestBackend";
 export declare const getRequestBackend: () => RequestBackend | null;
 export declare const isRequestBackendDefault: () => boolean;
 export declare const setRequestBackend: (backend: RequestBackend) => void;
-export interface ApiInfo {
+export interface ApiOptions {
     readonly name: string;
     readonly baseUrl: string;
     readonly middleware?: RequestMiddleware[];
+    /** @deprecated use `requestConfig` instead */
     readonly config?: BaseRequestConfig | (() => BaseRequestConfig);
+    readonly requestConfig?: BaseRequestConfig | (() => BaseRequestConfig);
     readonly mocking?: ApiMockingConfig;
     readonly requestBackend?: RequestBackend;
 }
+export type ApiInfo = ApiOptions & Required<Pick<ApiOptions, "middleware" | "requestBackend">>;
 export declare class Api implements ApiInfo {
-    readonly baseUrl: string;
-    readonly name: string;
-    readonly middleware: RequestMiddleware[];
-    readonly config?: BaseRequestConfig | (() => BaseRequestConfig);
-    readonly mocking?: ApiMockingConfig;
-    readonly requestBackend: RequestBackend;
+    private readonly info;
     protected readonly endpoints: Record<string, Endpoint>;
-    constructor(info: ApiInfo);
+    constructor(options: ApiOptions);
+    get requestBackend(): RequestBackend;
+    get baseUrl(): string;
+    /**
+     * @deprecated use `requestConfig` instead
+     */
+    get config(): BaseRequestConfig | (() => BaseRequestConfig) | undefined;
+    get requestConfig(): BaseRequestConfig | (() => BaseRequestConfig) | undefined;
+    get middleware(): RequestMiddleware[];
+    get mocking(): ApiMockingConfig | undefined;
+    get name(): string;
     endpoint(): EndpointBuilder;
+    /**
+     * @deprecated use `requestBackend` instead
+     */
     getRequestBackend(): RequestBackend;
+    /**
+     * @deprecated use `computeRequestConfig()` instead
+     */
     getConfig(): BaseRequestConfig;
+    computeRequestConfig(): BaseRequestConfig;
     private hotRequest;
     get: <R = unknown>(path: string, config: RequestConfig) => Promise<ApiResponse<R>>;
     post: <R = unknown>(path: string, config: RequestConfig) => Promise<ApiResponse<R>>;

package/esm/Api.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { RequestMethod } from "./ApiConstants";
 import EndpointBuilder from "./EndpointBuilder";
-import { computeRequestConfig } from "./RequestConfig";
+import { processRequestConfigs } from "./RequestConfig";
 import * as Requester from "./Requester";
 import * as Utils from "./Utils";
 import FetchRequestBackend from "./backend/FetchRequestBackend";
@@ -38,45 +38,98 @@ class HotRequestHost {
         return this.api.baseUrl;
     }
     computeConfig(config) {
-        const apiDefaults = this.api.getConfig();
-        return computeRequestConfig([apiDefaults, config]);
+        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 {
-    constructor(info) {
+    constructor(options) {
         var _a, _b;
         this.endpoints = {};
+        /*reconfigure(info: Partial<ApiInfo>): void {
+          if (info.requestBackend) {
+            (this as any).requestBackend = info.requestBackend;
+          }
+          if (info.config) {
+            (this as any).config = info.config;
+          }
+          if (info.middleware) {
+            (this as any).middleware = info.middleware;
+          }
+          if (info.mocking) {
+            (this as any).mocking = info.mocking;
+          }
+          if (info.baseUrl) {
+            (this as any).baseUrl = info.baseUrl;
+          }
+        }*/
         this.hotRequest = (requestMethod) => (path, config) => __awaiter(this, void 0, void 0, function* () { return yield Requester.submit(new HotRequestHost(this, path, requestMethod), config, null); });
         this.get = this.hotRequest(RequestMethod.GET);
         this.post = this.hotRequest(RequestMethod.POST);
         this.put = this.hotRequest(RequestMethod.PUT);
         this.delete = this.hotRequest(RequestMethod.DELETE);
         this.patch = this.hotRequest(RequestMethod.PATCH);
-        this.name = info.name;
-        this.baseUrl = info.baseUrl;
-        this.middleware = info.middleware || [];
-        this.endpoints = {};
-        this.config = info.config;
-        this.mocking = (_a = info.mocking) !== null && _a !== void 0 ? _a : undefined;
-        const requestBackend = (_b = info.requestBackend) !== null && _b !== void 0 ? _b : getRequestBackend();
+        const requestBackend = (_a = options.requestBackend) !== null && _a !== void 0 ? _a : getRequestBackend();
         if (!requestBackend) {
             throw new Error("[api-def] No request backend provided in either Api options or globally, use `setRequestBackend()` to set one or pass one via `requestBackend`");
         }
-        this.requestBackend = requestBackend;
+        this.info = {
+            name: options.name,
+            baseUrl: options.baseUrl,
+            middleware: options.middleware || [],
+            config: options.config,
+            requestConfig: options.requestConfig,
+            mocking: (_b = options.mocking) !== null && _b !== void 0 ? _b : undefined,
+            requestBackend: requestBackend,
+        };
+        this.endpoints = {};
+    }
+    get requestBackend() {
+        return this.info.requestBackend;
+    }
+    get baseUrl() {
+        return this.info.baseUrl;
+    }
+    /**
+     * @deprecated use `requestConfig` instead
+     */
+    get config() {
+        return this.info.config;
+    }
+    get requestConfig() {
+        return this.info.requestConfig;
+    }
+    get middleware() {
+        return this.info.middleware;
+    }
+    get mocking() {
+        return this.info.mocking;
+    }
+    get name() {
+        return this.info.name;
     }
     endpoint() {
         return new EndpointBuilder(this);
     }
+    /**
+     * @deprecated use `requestBackend` instead
+     */
     getRequestBackend() {
         return this.requestBackend;
     }
+    /**
+     * @deprecated use `computeRequestConfig()` instead
+     */
     getConfig() {
-        return (typeof this.config === "function" ? this.config() : this.config) || {};
+        return this.computeRequestConfig();
+    }
+    computeRequestConfig() {
+        return (typeof this.requestConfig === "function" ? this.requestConfig() : this.requestConfig) || {};
     }
 }

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 EndpointConfig<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,21 +32,31 @@ export interface EndpointConfig<TResult, TParams extends Params | undefined, TQu
     readonly mocking?: Mocking.EndpointMockingConfig<TResult, TParams, TQuery, TBody, TState>;
     readonly validation?: Validation<TResult, TParams, TQuery, TBody, TState>;
 }
-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 EndpointConfig<TResponse, TParams, TQuery, TBody, TState>, RequestHost {
+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, 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;
-    readonly id: string;
-    readonly method: RequestMethod;
-    readonly name: string;
-    readonly description?: string;
-    readonly path: string;
-    readonly config?: BaseRequestConfig;
-    readonly responseType: ResponseType | undefined;
-    readonly mocking?: Mocking.EndpointMockingConfig<TResponse, TParams, TQuery, TBody, TState>;
-    readonly validation: Validation<TResponse, TParams, TQuery, TBody, TState>;
-    constructor(api: Api, info: EndpointConfig<TResponse, TParams, TQuery, TBody, TState>);
-    submit(config: RequestConfig<TParams, TQuery, TBody, TState>): Promise<ApiResponse<TResponse>>;
+    private readonly info;
+    constructor(api: Api, options: EndpointOptions<TResponse, TParams, TQuery, TBody, TState, TPath, TRequestHeaders, TResponseHeaders>);
+    get id(): string;
+    get method(): RequestMethod;
+    get path(): TPath;
+    get name(): string;
+    get description(): string | undefined;
+    get config(): BaseRequestConfig;
+    get responseType(): ResponseType | undefined;
+    get mocking(): Mocking.EndpointMockingConfig<TResponse, TParams, TQuery, TBody, TState> | undefined;
+    get validation(): Validation<TResponse, TParams, TQuery, TBody, TState>;
+    submit(config: RequestConfig<TParams, TQuery, TBody, TState, TRequestHeaders>): Promise<ApiResponse<TResponse>>;
     computePath(path: string, request: RequestConfig): string;
     get baseUrl(): string;
-    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>;
+    /**
+     * @deprecated Use `computeRequestConfig` instead
+     */
+    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/Endpoint.js

@@ -8,19 +8,38 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as Requester from "./Requester";
-import { computeRequestConfig } from "./RequestConfig";
+import { processRequestConfigs } from "./RequestConfig";
 export default class Endpoint {
-    constructor(api, info) {
+    constructor(api, options) {
         this.api = api;
-        this.id = info.id;
-        this.method = info.method;
-        this.name = info.name || info.id;
-        this.description = info.description;
-        this.path = info.path;
-        this.config = info.config;
-        this.responseType = info.responseType;
-        this.mocking = info.mocking;
-        this.validation = info.validation || {};
+        this.info = Object.assign(Object.assign({}, options), { name: options.name || options.id, validation: options.validation || {} });
+    }
+    get id() {
+        return this.info.id;
+    }
+    get method() {
+        return this.info.method;
+    }
+    get path() {
+        return this.info.path;
+    }
+    get name() {
+        return this.info.name;
+    }
+    get description() {
+        return this.info.description;
+    }
+    get config() {
+        return this.info.config || {};
+    }
+    get responseType() {
+        return this.info.responseType;
+    }
+    get mocking() {
+        return this.info.mocking;
+    }
+    get validation() {
+        return this.info.validation;
     }
     submit(config) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -45,10 +64,11 @@ export default class Endpoint {
             const keys = Object.keys(request.params);
             for (let i = 0; i < keys.length; i++) {
                 const argName = keys[i];
-                computedPath = computedPath.replace(`:${argName}`, request.params[argName]);
+                const argValue = request.params[argName];
+                computedPath = computedPath.replace(`:${argName}`, argValue).replace(`{${argName}}`, argValue);
             }
         }
-        if (computedPath.includes(":")) {
+        if (computedPath.includes(":") || computedPath.includes("{")) {
             throw new Error(`[api-def] Not all path params have been resolved: '${computedPath}'`);
         }
         return computedPath;
@@ -56,11 +76,17 @@ export default class Endpoint {
     get baseUrl() {
         return this.api.baseUrl;
     }
+    /**
+     * @deprecated Use `computeRequestConfig` instead
+     */
     computeConfig(config) {
-        const apiDefaults = this.api.getConfig();
-        return computeRequestConfig([apiDefaults, this.config, config]);
+        return this.computeRequestConfig(config);
+    }
+    computeRequestConfig(config) {
+        const apiDefaults = this.api.computeRequestConfig();
+        return processRequestConfigs([apiDefaults, this.config, config]);
     }
     getRequestBackend() {
-        return this.api.getRequestBackend();
+        return this.api.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, TPath, TRequestHeaders, TResponseHeaders>;
 }

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 computeRequestConfig: <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/RequestConfig.js

@@ -2,7 +2,7 @@ import { COMPUTED_CONFIG_SYMBOL, } from "./ApiTypes";
 import { DEFAULT_QUERY_PARSE, DEFAULT_QUERY_STRINGIFY } from "./QueryHandling";
 import * as Utils from "./Utils";
 const MERGED_CONFIG_KEYS = ["headers"];
-export const computeRequestConfig = (configs) => {
+export const processRequestConfigs = (configs) => {
     var _a, _b;
     const computedConfig = Utils.assign({
         [COMPUTED_CONFIG_SYMBOL]: true,

package/esm/backend/AxiosRequestBackend.js

@@ -26,9 +26,10 @@ export default class AxiosRequestBackend {
     }
     convertResponse(context, response) {
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
             return {
                 method: context.method,
-                url: response.request.res.responseUrl,
+                url: (_b = (_a = response.request.res) === null || _a === void 0 ? void 0 : _a.responseUrl) !== null && _b !== void 0 ? _b : (_d = (_c = response.request) === null || _c === void 0 ? void 0 : _c._redirectable) === null || _d === void 0 ? void 0 : _d._currentUrl,
                 data: response.data,
                 headers: response.headers,
                 status: response.status,

package/esm/index.d.ts

@@ -3,7 +3,7 @@ export * from "./ApiTypes";
 export * from "./UtilTypes";
 export * from "./ApiConstants";
 export { default as retry } from "./util/retry";
-export { type RetryOptions } from "./util/retry/interfaces";
+export type { RetryOptions } from "./util/retry/interfaces";
 export { isRequestError, type RequestError } from "./RequestError";
 export { default as Endpoint, type EndpointConfig } from "./Endpoint";
 export { clearCache, setCacheBackend } from "./cache/Caching";

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "api-def",
-  "version": "0.11.1",
+  "version": "0.12.0-alpha.10",
   "description": "Typed API definitions with middleware support",
   "main": "cjs/index.js",
   "types": "esm/index.d.ts",
   "module": "esm/index.js",
+  "bin": {
+    "api-def": "bin/index.js"
+  },
   "sideEffects": false,
   "scripts": {
     "prepublishOnly": "npm run check:fix && npm run test && npm run build",
@@ -13,37 +16,50 @@
     "check:fix": "tsc --noEmit --project tsconfig.json && npx @biomejs/biome check --write",
     "check": "tsc --noEmit --project tsconfig.json && npx @biomejs/biome check",
     "cleanup": "rimraf esm && rimraf cjs",
-    "build": "npm run cleanup && npm run build:esm && npm run build:cjs",
+    "build": "npm run cleanup && npm run build:esm && npm run build:cjs && npm run build:cli",
     "build:esm": "tsc --module es2015 --target es2016 --outDir esm --preserveWatchOutput",
     "build:cjs": "tsc --module commonjs --target es5 --outDir cjs --preserveWatchOutput",
+    "build:cli": "esbuild cli/index.ts --bundle --platform=node --outfile=bin/index.js",
     "website:dev": "cd website && npm run start",
     "website:deploy": "cd website && npm run deploy"
   },
   "keywords": ["typescript", "javascript", "node", "web", "api", "typed", "cache", "fetch", "retry", "middleware"],
   "author": "James Waterhouse <09jwater@gmail.com>",
   "license": "MIT",
-  "files": ["LICENSE", "README.md", "esm/", "cjs/"],
+  "files": ["LICENSE", "README.md", "esm/", "cjs/", "bin/"],
   "jest": {
     "transform": {
-      "^.+\\.(t|j)sx?$": "@swc/jest"
+      "^.+\\.(t|j)sx?$": [
+        "@swc/jest",
+        {
+          "env": {}
+        }
+      ]
     }
   },
   "repository": "https://github.com/Censkh/api-def",
   "devDependencies": {
-    "@biomejs/biome": "1.8.3",
-    "@swc/core": "latest",
-    "@swc/jest": "latest",
+    "@biomejs/biome": "1.9.4",
+    "@redocly/openapi-core": "^1.27.1",
+    "@swc/core": "^1.10.7",
+    "@swc/jest": "^0.2.37",
     "@types/axios": "0.14.0",
-    "@types/jest": "^29.5.12",
-    "@types/node": "22.4.0",
-    "@types/qs": "6.9.15",
-    "axios": "1.7.4",
+    "@types/jest": "^29.5.14",
+    "@types/lodash": "^4.17.14",
+    "@types/node": "22.10.5",
+    "@types/qs": "6.9.17",
+    "axios": "1.7.9",
+    "chalk": "^4.1.2",
+    "commander": "^13.0.0",
     "cross-env": "7.0.3",
+    "esbuild": "^0.24.2",
     "jest": "latest",
+    "lodash": "^4.17.21",
     "npm-run-all": "4.1.5",
-    "qs": "6.13.0",
+    "openapi-typescript": "^7.5.2",
+    "qs": "6.13.1",
     "rimraf": "6.0.1",
-    "typescript": "5.5.4",
-    "zod": "3.23.8"
+    "typescript": "^5.7.3",
+    "zod": "3.24.1"
   }
 }