@koine/api 1.0.78 → 1.0.82

package/package.json

@@ -4,14 +4,15 @@
   "main": "./node/index.js",
   "typings": "./index.d.ts",
   "dependencies": {
-    "@koine/utils": "1.0.78",
+    "@koine/utils": "1.0.82",
+    "ts-debounce": "^4.0.0",
     "date-fns-tz": "^1.3.7",
     "swr": "^2.0.0-beta.6",
     "next": "^12.2.5",
     "tslib": "^2.4.0"
   },
   "peerDependencies": {},
-  "version": "1.0.78",
+  "version": "1.0.82",
   "module": "./index.js",
   "types": "./index.d.ts"
 }

package/core/index.d.ts

@@ -1,17 +0,0 @@
-/**
- * Custom `ApiError` class extending `Error` to throw in failed response.
- *
- * @see https://eslint.org/docs/rules/no-throw-literal
- * @see https://github.com/sindresorhus/ky/blob/main/source/errors/HTTPError.ts
- *
- */
-export declare class ApiError<TResponseFail extends Koine.Api.ResponseFail = unknown> extends Error {
-    constructor(result: Koine.Api.ResultFail<TResponseFail>);
-}
-/**
- * Create api client
- *
- * @param apiName Short name to use in debug logs
- * @param baseUrl Either relativ eor absolute, it must end without trailing slash
- */
-export declare const createApi: <TEndpoints extends Koine.Api.Endpoints>(apiName: string, baseUrl: string, options?: Koine.Api.ClientOptions) => Koine.Api.Client<TEndpoints>;

package/core/index.js

@@ -1,137 +0,0 @@
-import { __assign, __awaiter, __extends, __generator } from "tslib";
-import { buildUrlQueryString, isFullObject } from "@koine/utils";
-/**
- * Custom `ApiError` class extending `Error` to throw in failed response.
- *
- * @see https://eslint.org/docs/rules/no-throw-literal
- * @see https://github.com/sindresorhus/ky/blob/main/source/errors/HTTPError.ts
- *
- */
-var ApiError = /** @class */ (function (_super) {
-    __extends(ApiError, _super);
-    function ApiError(result) {
-        var _this = _super.call(this, "Request failed with ".concat(result.status, " ").concat(result.msg)) || this;
-        _this.name = "ApiError";
-        Object.assign(_this, result);
-        return _this;
-    }
-    return ApiError;
-}(Error));
-export { ApiError };
-/**
- * Create api client
- *
- * @param apiName Short name to use in debug logs
- * @param baseUrl Either relativ eor absolute, it must end without trailing slash
- */
-export var createApi = function (apiName, baseUrl, options) {
-    var _a = options || {}, _b = _a.headers, headersBase = _b === void 0 ? {} : _b, _c = _a.request, requestBase = _c === void 0 ? {
-        credentials: "include",
-        referrerPolicy: "no-referrer",
-        // mode: "cors",
-        // redirect: "follow",
-        // cache: "no-cache",
-    } : _c, shouldThrowBase = _a.shouldThrow, _d = _a.timeout, timeoutBase = _d === void 0 ? 10000 : _d, transformRequestBase = _a.transformRequest, transformResponseBase = _a.transformResponse;
-    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, params, json, query, _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 || {}, params = _a.params, json = _a.json, query = _a.query, _b = _a.request, request = _b === void 0 ? requestBase : _b, _c = _a.headers, headers = _c === void 0 ? headersBase : _c, _d = _a.timeout, timeout = _d === void 0 ? timeoutBase : _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 (isFullObject(params)) {
-                            for (key in params) {
-                                endpoint = endpoint.replace("{".concat(key, "}"), params[key].toString());
-                            }
-                        }
-                        timeoutNumber = Number(timeout);
-                        url = "".concat(baseUrl, "/").concat(endpoint + "".replace(/^\/*/, ""));
-                        if (method !== "get" && json) {
-                            requestInit.body = JSON.stringify(json);
-                        }
-                        if (timeoutNumber > 0) {
-                            controller = new AbortController();
-                            timeoutId = setTimeout(function () { return controller.abort(); }, timeoutNumber);
-                            requestInit.signal = controller.signal;
-                        }
-                        if (transformRequest) {
-                            requestInit = transformRequest(requestInit);
-                        }
-                        if (query) {
-                            // FIXME: ts-expect-error this assertion is not the best, but nevermind for now
-                            url += buildUrlQueryString(query);
-                        }
-                        if (!shouldThrow) return [3 /*break*/, 5];
-                        _h.label = 1;
-                    case 1:
-                        _h.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, fetch(url, requestInit)];
-                    case 2:
-                        response = _h.sent();
-                        return [3 /*break*/, 4];
-                    case 3:
-                        e_1 = _h.sent();
-                        // eslint-disable-next-line no-throw-literal
-                        throw { e: e_1 };
-                    case 4: return [3 /*break*/, 7];
-                    case 5: return [4 /*yield*/, fetch(url, requestInit)];
-                    case 6:
-                        response = _h.sent();
-                        _h.label = 7;
-                    case 7:
-                        if (timeoutId) {
-                            clearTimeout(timeoutId);
-                        }
-                        if (!shouldThrow) return [3 /*break*/, 15];
-                        _h.label = 8;
-                    case 8:
-                        _h.trys.push([8, 13, , 14]);
-                        if (!transformResponse) return [3 /*break*/, 10];
-                        return [4 /*yield*/, transformResponse(response, options || {})];
-                    case 9:
-                        result = _h.sent();
-                        return [3 /*break*/, 12];
-                    case 10: return [4 /*yield*/, response.json()];
-                    case 11:
-                        result = _h.sent();
-                        _h.label = 12;
-                    case 12: return [3 /*break*/, 14];
-                    case 13:
-                        e_2 = _h.sent();
-                        // eslint-disable-next-line no-throw-literal
-                        throw { e: e_2 };
-                    case 14: return [3 /*break*/, 19];
-                    case 15:
-                        if (!transformResponse) return [3 /*break*/, 17];
-                        return [4 /*yield*/, transformResponse(response, options || {})];
-                    case 16:
-                        result = _h.sent();
-                        return [3 /*break*/, 19];
-                    case 17: return [4 /*yield*/, response.json()];
-                    case 18:
-                        result = _h.sent();
-                        _h.label = 19;
-                    case 19:
-                        if (shouldThrow && result.fail) {
-                            // throw new ApiError<Failed>(result);
-                            // I prefer to throw an object literal despite what eslint says
-                            // eslint-disable-next-line no-throw-literal
-                            throw result;
-                        }
-                        if (process.env["NODE_ENV"] !== "production") {
-                            msg = "".concat(result.status, ": api[").concat(apiName, "] ").concat(method.toUpperCase(), " ").concat(url);
-                            if (result.ok) {
-                                console.log("\uD83D\uDFE2 ".concat(msg));
-                            }
-                            else {
-                                console.log("\uD83D\uDD34 ".concat(msg));
-                            }
-                        }
-                        return [2 /*return*/, result];
-                }
-            });
-        }); };
-        return api;
-    }, {});
-};

package/core/package.json

@@ -1,6 +0,0 @@
-{
-  "sideEffects": false,
-  "module": "./index.js",
-  "main": "../node/core/index.js",
-  "types": "./index.d.ts"
-}

package/next/index.d.ts

@@ -1,2 +0,0 @@
-import type { NextApiResponse } from "next";
-export declare const nextApiResponse: (nextRes: NextApiResponse, result: Koine.Api.ResultOk | Koine.Api.ResultFail) => void;

package/next/index.js

@@ -1,4 +0,0 @@
-export var nextApiResponse = function (nextRes, result) {
-    // nextRes.status(result.status).json(result.data || result.msg);
-    nextRes.status(result.status).json(result);
-};

package/next/package.json

@@ -1,6 +0,0 @@
-{
-  "sideEffects": false,
-  "module": "./index.js",
-  "main": "../node/next/index.js",
-  "types": "./index.d.ts"
-}

package/swr/index.d.ts

@@ -1,14 +0,0 @@
-import { type SWRConfiguration, type SWRResponse } from "swr";
-import { type SWRMutationConfiguration, type SWRMutationResponse } from "swr/mutation";
-declare type KoineApiMethodHookSWR<THookName extends keyof Koine.Api.HooksMapsByName, TEndpoints extends Koine.Api.Endpoints> = <TEndpoint extends Koine.Api.EndpointUrl<TEndpoints>, TMethod extends Koine.Api.RequestMethod = Koine.Api.HooksMapsByName[THookName]>(endpoint: TEndpoint, options?: Koine.Api.EndpointRequestOptions<TEndpoints, TEndpoint, TMethod>, config?: THookName extends "useGet" ? SWRConfiguration<Koine.Api.EndpointResponseOk<TEndpoints, TEndpoint, TMethod>, Koine.Api.EndpointResponseFail<TEndpoints, TEndpoint, TMethod>> : SWRMutationConfiguration<Koine.Api.EndpointResponseOk<TEndpoints, TEndpoint, TMethod>, Koine.Api.EndpointResponseFail<TEndpoints, TEndpoint, TMethod>, Koine.Api.EndpointRequestOptions<TEndpoints, TEndpoint, TMethod>, TEndpoint>) => THookName extends "useGet" ? SWRResponse<Koine.Api.EndpointResponseOk<TEndpoints, TEndpoint, TMethod>, Koine.Api.EndpointResponseFail<TEndpoints, TEndpoint, TMethod>> : SWRMutationResponse<Koine.Api.EndpointResponseOk<TEndpoints, TEndpoint, TMethod>, Koine.Api.EndpointResponseFail<TEndpoints, TEndpoint, TMethod>, Koine.Api.EndpointRequestOptions<TEndpoints, TEndpoint, TMethod>, TEndpoint>;
-/**
- * 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 | undefined) => Koine.Api.Client<TEndpoints> & {
-    useGet: KoineApiMethodHookSWR<"useGet", TEndpoints>;
-    usePost: KoineApiMethodHookSWR<"usePost", TEndpoints>;
-    usePut: KoineApiMethodHookSWR<"usePut", TEndpoints>;
-    usePatch: KoineApiMethodHookSWR<"usePatch", TEndpoints>;
-    useDelete: KoineApiMethodHookSWR<"useDelete", TEndpoints>;
-};
-export {};

package/swr/index.js

@@ -1,82 +0,0 @@
-import { __assign, __awaiter, __generator } from "tslib";
-import useSWR from "swr";
-import useSWRMutation from "swr/mutation";
-import { createApi } from "../core";
-function createUseApi(api, method) {
-    return function useApi(endpoint, options, _config) {
-        var _this = this;
-        if (method === "get") {
-            // const fetcher = async (_endpoint: TEndpoint) => {
-            //   try {
-            //     const { ok, data } = await api[method](_endpoint, {
-            //         ...(options || {}),
-            //         shouldThrow: true,
-            //       });
-            //       if (ok) {
-            //         return data;
-            //       }
-            //       throw new Error() as unknown as Koine.Api.EndpointResponseFail<TEndpoints, TEndpoint, TMethod>;
-            //     } catch(e) {
-            //       throw new Error() as unknown as Koine.Api.EndpointResponseFail<TEndpoints, TEndpoint, TMethod>;;
-            //     }
-            //   };
-            // }
-            var fetcher = function () { return __awaiter(_this, void 0, void 0, function () {
-                var data;
-                return __generator(this, function (_a) {
-                    switch (_a.label) {
-                        case 0: return [4 /*yield*/, api[method](endpoint, __assign(__assign({}, (options || {})), { shouldThrow: true }))];
-                        case 1:
-                            data = (_a.sent()).data;
-                            return [2 /*return*/, data];
-                    }
-                });
-            }); };
-            var config_1 = _config;
-            // <Data = any, Error = any>(key: Key, config: SWRConfiguration<Data, Error, Fetcher<Data>> | undefined): SWRResponse<Data, Error>;
-            // eslint-disable-next-line react-hooks/rules-of-hooks
-            return useSWR(options ? [endpoint, options] : [endpoint], fetcher, config_1);
-        }
-        var config = _config;
-        var sender = function (
-        // if the first argument is an array the second tem are the base options
-        // defined when calling the usePost/Put/etc. hook, these will be overriden
-        // by the _options just here below
-        _endpoint, 
-        // these are the options arriving when calling `trigger({ json, query, etc... })
-        _options) { return __awaiter(_this, void 0, void 0, function () {
-            var endpoint, options, _a, ok, data;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        endpoint = Array.isArray(_endpoint) ? _endpoint[0] : _endpoint;
-                        options = Array.isArray(_endpoint) ? _endpoint[1] : {};
-                        return [4 /*yield*/, api[method](endpoint, __assign(__assign(__assign({}, options), (_options.arg || {})), { shouldThrow: true }))];
-                    case 1:
-                        _a = _b.sent(), ok = _a.ok, data = _a.data;
-                        return [2 /*return*/, ok ? data : data];
-                }
-            });
-        }); };
-        // config.fetcher = sender;
-        // eslint-disable-next-line react-hooks/rules-of-hooks
-        return useSWRMutation(
-        // @ts-expect-error FIXME: I can't get it...
-        options ? [endpoint, options] : endpoint, sender, config);
-    };
-}
-/**
- * It creates an api client extended with auto-generated SWR wrapper hooks
- */
-export var createSwrApi = function () {
-    var args = [];
-    for (var _i = 0; _i < arguments.length; _i++) {
-        args[_i] = arguments[_i];
-    }
-    var api = createApi.apply(void 0, args);
-    ["get", "post", "put", "patch", "delete"].forEach(function (method) {
-        var hookName = "use".concat(method.charAt(0).toUpperCase() + method.slice(1));
-        api[hookName] = createUseApi(api, method);
-    });
-    return api;
-};

package/swr/package.json

@@ -1,6 +0,0 @@
-{
-  "sideEffects": false,
-  "module": "./index.js",
-  "main": "../node/swr/index.js",
-  "types": "./index.d.ts"
-}