npm - @koine/api - Versions diffs - 1.0.37 → 1.0.40 - Mend

@koine/api 1.0.37 → 1.0.40

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/core/index.js CHANGED Viewed

@@ -34,12 +34,17 @@ export var createApi = function (apiName, baseUrl, options) {
     } : _b, shouldThrowBase = _a.shouldThrow;
     return ["get", "post", "put", "patch", "delete"].reduce(function (api, method) {
         api[method] = function (endpoint, options) { return __awaiter(void 0, void 0, void 0, function () {
-            var _a, json, params, _b, request, _c, headers, _d, timeout, _e, transformRequest, _f, transformResponse, _g, shouldThrow, requestInit, timeoutNumber, controller, timeoutId, url, response, e_1, result, e_2, msg;
+            var _a, json, path, params, _b, request, _c, headers, _d, timeout, _e, transformRequest, _f, transformResponse, _g, shouldThrow, requestInit, key, timeoutNumber, controller, timeoutId, url, response, e_1, result, e_2, msg;
             return __generator(this, function (_h) {
                 switch (_h.label) {
                     case 0:
-                        _a = options || {}, json = _a.json, params = _a.params, _b = _a.request, request = _b === void 0 ? requestBase : _b, _c = _a.headers, headers = _c === void 0 ? {} : _c, _d = _a.timeout, timeout = _d === void 0 ? 10000 : _d, _e = _a.transformRequest, transformRequest = _e === void 0 ? transformRequestBase : _e, _f = _a.transformResponse, transformResponse = _f === void 0 ? transformResponseBase : _f, _g = _a.shouldThrow, shouldThrow = _g === void 0 ? shouldThrowBase : _g;
+                        _a = options || {}, json = _a.json, path = _a.path, params = _a.params, _b = _a.request, request = _b === void 0 ? requestBase : _b, _c = _a.headers, headers = _c === void 0 ? {} : _c, _d = _a.timeout, timeout = _d === void 0 ? 10000 : _d, _e = _a.transformRequest, transformRequest = _e === void 0 ? transformRequestBase : _e, _f = _a.transformResponse, transformResponse = _f === void 0 ? transformResponseBase : _f, _g = _a.shouldThrow, shouldThrow = _g === void 0 ? shouldThrowBase : _g;
                         requestInit = __assign(__assign({ method: method.toUpperCase() }, request), { headers: __assign({ "content-type": "application/json" }, headers) });
+                        if (path && Object.keys(path).length) {
+                            for (key in path) {
+                                endpoint.replace("{".concat(key, "}"), path[key].toString());
+                            }
+                        }
                         timeoutNumber = Number(timeout);
                         url = "".concat(baseUrl, "/").concat(endpoint + "".replace(/^\/*/, ""));
                         if (method !== "get" && json) {

package/node/core/index.js CHANGED Viewed

@@ -37,12 +37,17 @@ var createApi = function (apiName, baseUrl, options) {
     } : _b, shouldThrowBase = _a.shouldThrow;
     return ["get", "post", "put", "patch", "delete"].reduce(function (api, method) {
         api[method] = function (endpoint, options) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
-            var _a, json, params, _b, request, _c, headers, _d, timeout, _e, transformRequest, _f, transformResponse, _g, shouldThrow, requestInit, timeoutNumber, controller, timeoutId, url, response, e_1, result, e_2, msg;
+            var _a, json, path, params, _b, request, _c, headers, _d, timeout, _e, transformRequest, _f, transformResponse, _g, shouldThrow, requestInit, key, timeoutNumber, controller, timeoutId, url, response, e_1, result, e_2, msg;
             return tslib_1.__generator(this, function (_h) {
                 switch (_h.label) {
                     case 0:
-                        _a = options || {}, json = _a.json, params = _a.params, _b = _a.request, request = _b === void 0 ? requestBase : _b, _c = _a.headers, headers = _c === void 0 ? {} : _c, _d = _a.timeout, timeout = _d === void 0 ? 10000 : _d, _e = _a.transformRequest, transformRequest = _e === void 0 ? transformRequestBase : _e, _f = _a.transformResponse, transformResponse = _f === void 0 ? transformResponseBase : _f, _g = _a.shouldThrow, shouldThrow = _g === void 0 ? shouldThrowBase : _g;
+                        _a = options || {}, json = _a.json, path = _a.path, params = _a.params, _b = _a.request, request = _b === void 0 ? requestBase : _b, _c = _a.headers, headers = _c === void 0 ? {} : _c, _d = _a.timeout, timeout = _d === void 0 ? 10000 : _d, _e = _a.transformRequest, transformRequest = _e === void 0 ? transformRequestBase : _e, _f = _a.transformResponse, transformResponse = _f === void 0 ? transformResponseBase : _f, _g = _a.shouldThrow, shouldThrow = _g === void 0 ? shouldThrowBase : _g;
                         requestInit = tslib_1.__assign(tslib_1.__assign({ method: method.toUpperCase() }, request), { headers: tslib_1.__assign({ "content-type": "application/json" }, headers) });
+                        if (path && Object.keys(path).length) {
+                            for (key in path) {
+                                endpoint.replace("{".concat(key, "}"), path[key].toString());
+                            }
+                        }
                         timeoutNumber = Number(timeout);
                         url = "".concat(baseUrl, "/").concat(endpoint + "".replace(/^\/*/, ""));
                         if (method !== "get" && json) {

package/package.json CHANGED Viewed

@@ -5,12 +5,12 @@
   "typings": "./index.d.ts",
   "dependencies": {},
   "peerDependencies": {
-    "@koine/utils": "1.0.37",
+    "@koine/utils": "1.0.40",
     "next": "^12.1.6",
     "swr": "^2.0.0-beta.5",
     "tslib": "^2.4.0"
   },
-  "version": "1.0.37",
+  "version": "1.0.40",
   "module": "./index.js",
   "types": "./index.d.ts"
 }

package/swr/index.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@ declare type KoineApiMethodHookSWR<THookName extends keyof Koine.Api.HooksMapsBy
 /**
  * It creates an api client extended with auto-generated SWR wrapper hooks
  */
-export declare const createSwrApi: <TEndpoints extends Koine.Api.Endpoints>(apiName: string, baseUrl: string, options?: Koine.Api.ClientOptions) => Koine.Api.Client<TEndpoints> & {
+export declare const createSwrApi: <TEndpoints extends Koine.Api.Endpoints>(apiName: string, baseUrl: string, options?: Koine.Api.ClientOptions | undefined) => Koine.Api.Client<TEndpoints> & {
     useGet: KoineApiMethodHookSWR<"useGet", TEndpoints>;
     usePost: KoineApiMethodHookSWR<"usePost", TEndpoints>;
     usePut: KoineApiMethodHookSWR<"usePut", TEndpoints>;

package/typings.d.ts CHANGED Viewed

@@ -204,6 +204,15 @@ declare namespace Koine.Api {
      * @default { credentials: "include", referrerPolicy: "no-referrer" }
      */
     request?: Omit<RequestInit, "body" | "headers" | "method">;
+    /**
+     * A dictionary to dynamically interpolate endpoint url values, e.g.:
+     *
+     * ```
+     * "user/{id}" endpoint with { path: { id: "12" }} results in a call
+     * to the endpoint "user/12"
+     * ```
+     */
+    path?: Record<string, string | number>;
   };
   /**