api-def 0.11.1 → 0.12.0-alpha.2

package/bin/OpenApiToSourceCode.js

@@ -0,0 +1,174 @@
+"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;

package/bin/index.js

@@ -0,0 +1,98 @@
+"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 };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var fs = __importStar(require("node:fs"));
+var path = __importStar(require("node:path"));
+var commander_1 = require("commander");
+var OpenApiToSourceCode_1 = require("./OpenApiToSourceCode");
+commander_1.program.name("api-def");
+var packageJson = JSON.parse(fs.readFileSync("package.json", "utf-8"));
+commander_1.program.version(packageJson.version);
+commander_1.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(function (inPath, outPath) { return __awaiter(void 0, void 0, void 0, function () {
+    var output;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, (0, OpenApiToSourceCode_1.openApiToSourceCode)({
+                    openApiPath: path.resolve(inPath),
+                })];
+            case 1:
+                output = _a.sent();
+                fs.writeFileSync(path.resolve(outPath), output);
+                return [2 /*return*/];
+        }
+    });
+}); });
+commander_1.program.parse(process.argv);

package/cjs/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/cjs/Api.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.");
@@ -76,7 +76,7 @@ var HotRequestHost = /** @class */ (function () {
     });
     HotRequestHost.prototype.computeConfig = function (config) {
         var apiDefaults = this.api.getConfig();
-        return (0, RequestConfig_1.computeRequestConfig)([apiDefaults, config]);
+        return (0, RequestConfig_1.processRequestConfigs)([apiDefaults, config]);
     };
     HotRequestHost.prototype.computePath = function (path, config) {
         return path.startsWith("/") ? path : "/".concat(path);
@@ -87,10 +87,27 @@ var HotRequestHost = /** @class */ (function () {
     return HotRequestHost;
 }());
 var Api = /** @class */ (function () {
-    function Api(info) {
+    function Api(options) {
         var _this = this;
         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 = function (requestMethod) {
             return function (path, config) { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
                 switch (_a.label) {
@@ -104,26 +121,90 @@ var Api = /** @class */ (function () {
         this.put = this.hotRequest(ApiConstants_1.RequestMethod.PUT);
         this.delete = this.hotRequest(ApiConstants_1.RequestMethod.DELETE);
         this.patch = this.hotRequest(ApiConstants_1.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;
-        var requestBackend = (_b = info.requestBackend) !== null && _b !== void 0 ? _b : (0, exports.getRequestBackend)();
+        var requestBackend = (_a = options.requestBackend) !== null && _a !== void 0 ? _a : (0, exports.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 = {};
     }
+    Object.defineProperty(Api.prototype, "requestBackend", {
+        get: function () {
+            return this.info.requestBackend;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Api.prototype, "baseUrl", {
+        get: function () {
+            return this.info.baseUrl;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Api.prototype, "config", {
+        /**
+         * @deprecated use `requestConfig` instead
+         */
+        get: function () {
+            return this.info.config;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Api.prototype, "requestConfig", {
+        get: function () {
+            return this.info.requestConfig;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Api.prototype, "middleware", {
+        get: function () {
+            return this.info.middleware;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Api.prototype, "mocking", {
+        get: function () {
+            return this.info.mocking;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Api.prototype, "name", {
+        get: function () {
+            return this.info.name;
+        },
+        enumerable: false,
+        configurable: true
+    });
     Api.prototype.endpoint = function () {
         return new EndpointBuilder_1.default(this);
     };
+    /**
+     * @deprecated use `requestBackend` instead
+     */
     Api.prototype.getRequestBackend = function () {
         return this.requestBackend;
     };
+    /**
+     * @deprecated use `computeRequestConfig()` instead
+     */
     Api.prototype.getConfig = function () {
-        return (typeof this.config === "function" ? this.config() : this.config) || {};
+        return this.computeRequestConfig();
+    };
+    Api.prototype.computeRequestConfig = function () {
+        return (typeof this.requestConfig === "function" ? this.requestConfig() : this.requestConfig) || {};
     };
     return Api;
 }());

package/cjs/Endpoint.d.ts

@@ -4,7 +4,7 @@ import type { ApiResponse, BaseRequestConfig, Body, ComputedRequestConfig, Param
 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> {
     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> = EndpointOptions<TResult, TParams, TQuery, TBody, TState, TPath> & Required<Pick<EndpointOptions<TResult, TParams, TQuery, TBody, TState, TPath>, "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 {
     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>);
+    private readonly info;
+    constructor(api: Api, options: EndpointOptions<TResponse, TParams, TQuery, TBody, TState>);
+    get id(): string;
+    get method(): RequestMethod;
+    get path(): string;
+    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>): Promise<ApiResponse<TResponse>>;
     computePath(path: string, request: RequestConfig): string;
     get baseUrl(): string;
+    /**
+     * @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>;
     getRequestBackend(): RequestBackend;
 }

package/cjs/Endpoint.js

@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 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) {
@@ -9,8 +20,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.");
@@ -39,18 +50,73 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var Requester = require("./Requester");
 var RequestConfig_1 = require("./RequestConfig");
 var Endpoint = /** @class */ (function () {
-    function Endpoint(api, info) {
+    function Endpoint(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 = __assign(__assign({}, options), { name: options.name || options.id, validation: options.validation || {} });
     }
+    Object.defineProperty(Endpoint.prototype, "id", {
+        get: function () {
+            return this.info.id;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Endpoint.prototype, "method", {
+        get: function () {
+            return this.info.method;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Endpoint.prototype, "path", {
+        get: function () {
+            return this.info.path;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Endpoint.prototype, "name", {
+        get: function () {
+            return this.info.name;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Endpoint.prototype, "description", {
+        get: function () {
+            return this.info.description;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Endpoint.prototype, "config", {
+        get: function () {
+            return this.info.config || {};
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Endpoint.prototype, "responseType", {
+        get: function () {
+            return this.info.responseType;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Endpoint.prototype, "mocking", {
+        get: function () {
+            return this.info.mocking;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Endpoint.prototype, "validation", {
+        get: function () {
+            return this.info.validation;
+        },
+        enumerable: false,
+        configurable: true
+    });
     Endpoint.prototype.submit = function (config) {
         return __awaiter(this, void 0, void 0, function () {
             var mock, apiMocking, mockingEnabled;
@@ -92,12 +158,18 @@ var Endpoint = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    /**
+     * @deprecated Use `computeRequestConfig` instead
+     */
     Endpoint.prototype.computeConfig = function (config) {
-        var apiDefaults = this.api.getConfig();
-        return (0, RequestConfig_1.computeRequestConfig)([apiDefaults, this.config, config]);
+        return this.computeRequestConfig(config);
+    };
+    Endpoint.prototype.computeRequestConfig = function (config) {
+        var apiDefaults = this.api.computeRequestConfig();
+        return (0, RequestConfig_1.processRequestConfigs)([apiDefaults, this.config, config]);
     };
     Endpoint.prototype.getRequestBackend = function () {
-        return this.api.getRequestBackend();
+        return this.api.requestBackend;
     };
     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 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>;
+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>;

package/cjs/RequestConfig.js

@@ -9,12 +9,12 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.computeRequestConfig = void 0;
+exports.processRequestConfigs = void 0;
 var ApiTypes_1 = require("./ApiTypes");
 var QueryHandling_1 = require("./QueryHandling");
 var Utils = require("./Utils");
 var MERGED_CONFIG_KEYS = ["headers"];
-var computeRequestConfig = function (configs) {
+var processRequestConfigs = function (configs) {
     var _a;
     var _b, _c;
     var computedConfig = Utils.assign.apply(Utils, __spreadArray([(_a = {},
@@ -74,4 +74,4 @@ var computeRequestConfig = function (configs) {
     }
     return computedConfig;
 };
-exports.computeRequestConfig = computeRequestConfig;
+exports.processRequestConfigs = processRequestConfigs;

package/cjs/RequestContext.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/cjs/Requester.js

@@ -20,8 +20,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/cjs/backend/AxiosRequestBackend.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.");
@@ -59,10 +59,11 @@ var AxiosRequestBackend = /** @class */ (function () {
     };
     AxiosRequestBackend.prototype.convertResponse = function (context, response) {
         return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
+            var _a, _b, _c, _d;
+            return __generator(this, function (_e) {
                 return [2 /*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/cjs/backend/FetchRequestBackend.js

@@ -24,8 +24,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/cjs/backend/MockRequestBackend.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/cjs/cache/Caching.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/cjs/cache/LocalStorageCacheBackend.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/cjs/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/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";
@@ -39,7 +39,7 @@ class HotRequestHost {
     }
     computeConfig(config) {
         const apiDefaults = this.api.getConfig();
-        return computeRequestConfig([apiDefaults, config]);
+        return processRequestConfigs([apiDefaults, config]);
     }
     computePath(path, config) {
         return path.startsWith("/") ? path : `/${path}`;
@@ -49,34 +49,87 @@ class HotRequestHost {
     }
 }
 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/Endpoint.d.ts

@@ -4,7 +4,7 @@ import type { ApiResponse, BaseRequestConfig, Body, ComputedRequestConfig, Param
 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> {
     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> = EndpointOptions<TResult, TParams, TQuery, TBody, TState, TPath> & Required<Pick<EndpointOptions<TResult, TParams, TQuery, TBody, TState, TPath>, "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 {
     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>);
+    private readonly info;
+    constructor(api: Api, options: EndpointOptions<TResponse, TParams, TQuery, TBody, TState>);
+    get id(): string;
+    get method(): RequestMethod;
+    get path(): string;
+    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>): Promise<ApiResponse<TResponse>>;
     computePath(path: string, request: RequestConfig): string;
     get baseUrl(): string;
+    /**
+     * @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>;
     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* () {
@@ -56,11 +75,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/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>;
+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>;

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.2",
   "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,49 @@
     "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": "tsc cli/index.ts --module commonjs --target es5 --outDir bin --preserveWatchOutput --esModuleInterop --skipLibCheck",
     "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",
     "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"
   }
 }