api-def 0.12.0-alpha.32 → 0.12.0-alpha.33

package/README.md

@@ -4,30 +4,33 @@ Typed APIs with middleware support
 
 API def provides a unified way to type your endpoints allowing for compile time checking of query, body, response and even url parameters
 
-``` npm i api-def ```
+```bash
+npm i api-def
+```
 
 - [Documentation](https://censkh.github.io/api-def/)
 
 ```typescript
-import {Api} from "api-def";
+import { Api } from "api-def";
 
 const api = new Api({
   baseUrl: "https://my-api/",
   name: "My API",
 });
 
-const fetchData = api.endpoint()
-    .queryOf<{ includeAwesome: boolean; }>()
-    .responseOf<{ data: {awesome: boolean; } }>()
-    .build({
-      id: "fetch_data",
-      method: "get",
-      path: "/data"
-    });
+const fetchData = api
+  .endpoint()
+  .queryOf<{ includeAwesome: boolean }>()
+  .responseOf<{ data: { awesome: boolean } }>()
+  .build({
+    id: "fetch_data",
+    method: "get",
+    path: "/data",
+  });
 
 // calls GET https://my-api/data?includeAwesome=true
 const res = await fetchData.submit({
-  query: {includeAwesome: true}
+  query: { includeAwesome: true },
 });
 
 console.log(res.data); // { data: { awesome: true } }

package/cjs/Api.js

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

package/cjs/ApiTypes.d.ts

@@ -101,7 +101,7 @@ export interface RequestHost {
     readonly responseType: ResponseType | undefined;
     readonly validation: Validation;
     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;
+    computePath(path: string, params: Record<string, string> | undefined): string;
     getRequestBackend(): RequestBackend;
 }
 export interface CancelledRequestError extends Error {

package/cjs/Endpoint.d.ts

@@ -51,7 +51,7 @@ export default class Endpoint<TResponse = any, TParams extends Params | undefine
     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;
+    computePath(path: string, params: Record<string, string> | undefined): string;
     get baseUrl(): string;
     /**
      * @deprecated Use `computeRequestConfig` instead

package/cjs/Endpoint.js

@@ -137,13 +137,13 @@ var Endpoint = /** @class */ (function () {
             });
         });
     };
-    Endpoint.prototype.computePath = function (path, request) {
+    Endpoint.prototype.computePath = function (path, params) {
         var computedPath = path.startsWith("/") ? path : "/".concat(path);
-        if (request.params) {
-            var keys = Object.keys(request.params);
+        if (params) {
+            var keys = Object.keys(params);
             for (var i = 0; i < keys.length; i++) {
                 var argName = keys[i];
-                var argValue = request.params[argName];
+                var argValue = params[argName];
                 computedPath = computedPath.replace(":".concat(argName), argValue).replace("{".concat(argName, "}"), argValue);
             }
         }

package/cjs/Requester.js

@@ -65,7 +65,7 @@ var submit = function (host, config, mocking) { return __awaiter(void 0, void 0,
             case 0:
                 computedConfig = host.computeConfig(config);
                 backend = mocking ? MOCK_REQUEST_BACKEND : host.getRequestBackend();
-                context = new RequestContext_1.default(backend, host, computedConfig, host.computePath(host.path, config), mocking);
+                context = new RequestContext_1.default(backend, host, computedConfig, host.computePath(host.path, config.params), mocking);
                 key = context.key;
                 lock = (context.computedConfig || {}).lock;
                 if (typeof lock === "string") {

package/esm/Api.js

@@ -41,7 +41,7 @@ class HotRequestHost {
         const apiDefaults = this.api.computeRequestConfig();
         return processRequestConfigs([apiDefaults, config]);
     }
-    computePath(path, config) {
+    computePath(path) {
         return path.startsWith("/") ? path : `/${path}`;
     }
     getRequestBackend() {

package/esm/ApiTypes.d.ts

@@ -101,7 +101,7 @@ export interface RequestHost {
     readonly responseType: ResponseType | undefined;
     readonly validation: Validation;
     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;
+    computePath(path: string, params: Record<string, string> | undefined): string;
     getRequestBackend(): RequestBackend;
 }
 export interface CancelledRequestError extends Error {

package/esm/Endpoint.d.ts

@@ -51,7 +51,7 @@ export default class Endpoint<TResponse = any, TParams extends Params | undefine
     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;
+    computePath(path: string, params: Record<string, string> | undefined): string;
     get baseUrl(): string;
     /**
      * @deprecated Use `computeRequestConfig` instead

package/esm/Endpoint.js

@@ -58,13 +58,13 @@ export default class Endpoint {
             return Requester.submit(this, config, mock ? this.mocking : null);
         });
     }
-    computePath(path, request) {
+    computePath(path, params) {
         let computedPath = path.startsWith("/") ? path : `/${path}`;
-        if (request.params) {
-            const keys = Object.keys(request.params);
+        if (params) {
+            const keys = Object.keys(params);
             for (let i = 0; i < keys.length; i++) {
                 const argName = keys[i];
-                const argValue = request.params[argName];
+                const argValue = params[argName];
                 computedPath = computedPath.replace(`:${argName}`, argValue).replace(`{${argName}}`, argValue);
             }
         }

package/esm/Requester.js

@@ -20,7 +20,7 @@ const MOCK_REQUEST_BACKEND = new MockRequestBackend();
 export const submit = (host, config, mocking) => __awaiter(void 0, void 0, void 0, function* () {
     const computedConfig = host.computeConfig(config);
     const backend = mocking ? MOCK_REQUEST_BACKEND : host.getRequestBackend();
-    const context = new RequestContext(backend, host, computedConfig, host.computePath(host.path, config), mocking);
+    const context = new RequestContext(backend, host, computedConfig, host.computePath(host.path, config.params), mocking);
     const { key } = context;
     // don't do this -- should only be for GET requests anyway and should be opt-in
     /*

package/package.json

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