@koine/api 2.0.0-beta.2 → 2.0.0-beta.20

package/ApiError.d.ts

@@ -1,10 +1,4 @@
-/**
- * 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
- *
- */
+/// <reference types="./typings.d.ts" />
 export declare class ApiError<TResponseFail extends Koine.Api.ResponseFail = unknown> extends Error {
     constructor(result: Koine.Api.ResultFail<TResponseFail>);
 }

package/ApiError.js

@@ -1,16 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiError = void 0;
-var tslib_1 = require("tslib");
-/**
- * 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) {
-    tslib_1.__extends(ApiError, _super);
+import { __extends } from "tslib";
+var ApiError = (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";
@@ -19,5 +9,5 @@ var ApiError = /** @class */ (function (_super) {
     }
     return ApiError;
 }(Error));
-exports.ApiError = ApiError;
-exports.default = ApiError;
+export { ApiError };
+export default ApiError;

package/cjs/ApiError.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="./typings.d.ts" />
+export declare class ApiError<TResponseFail extends Koine.Api.ResponseFail = unknown> extends Error {
+    constructor(result: Koine.Api.ResultFail<TResponseFail>);
+}
+export default ApiError;

package/cjs/ApiError.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiError = void 0;
+var tslib_1 = require("tslib");
+var ApiError = (function (_super) {
+    tslib_1.__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));
+exports.ApiError = ApiError;
+exports.default = ApiError;

package/cjs/createApi.d.ts

@@ -0,0 +1,2 @@
+export declare const createApi: <TEndpoints extends Koine.Api.Endpoints>(apiName: string, baseUrl: string, options?: Koine.Api.ClientOptions) => Koine.Api.Client<TEndpoints>;
+export default createApi;

package/{createApi.mjs → cjs/createApi.js}

@@ -1,32 +1,20 @@
-import { __assign, __awaiter, __generator } from "tslib";
-import buildUrlQueryString from "@koine/utils/buildUrlQueryString";
-import isFullObject from "@koine/utils/isFullObject";
-import errorToString from "@koine/utils/errorToString";
-/**
- * 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 ? {
-        referrerPolicy: "no-referrer",
-        // credentials: "include",
-        // mode: "cors",
-        // redirect: "follow",
-        // cache: "no-cache",
-    } : _c, throwErrBase = _a.throwErr, _d = _a.timeout, timeoutBase = _d === void 0 ? 10000 : _d, processReqBase = _a.processReq, processResBase = _a.processRes, processErrBase = _a.processErr;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createApi = void 0;
+var tslib_1 = require("tslib");
+var utils_1 = require("@koine/utils");
+var createApi = function (apiName, baseUrl, options) {
+    var _a = options || {}, _b = _a.headers, headersBase = _b === void 0 ? {} : _b, _c = _a.request, requestBase = _c === void 0 ? {} : _c, throwErrBase = _a.throwErr, _d = _a.timeout, timeoutBase = _d === void 0 ? 10000 : _d, processReqBase = _a.processReq, processResBase = _a.processRes, processErrBase = _a.processErr;
     return ["get", "post", "put", "patch", "delete"].reduce(function (api, method) {
-        // @ts-expect-error FIXME: type
-        api[method] = function (endpoint, options) { return __awaiter(void 0, void 0, void 0, function () {
+        api[method] = function (endpoint, options) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
             var _a, _b, request, _c, headers, _d, timeout, processReq, _e, processRes, _f, processErr, _g, throwErr, _h, params, json, query, url, requestInit, transformed, transformed, key, timeoutNumber, controller, timeoutId, response, result, msg, e_1, e_2, logMsg;
-            return __generator(this, function (_j) {
+            return tslib_1.__generator(this, function (_j) {
                 switch (_j.label) {
                     case 0:
                         _a = options || {}, _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, processReq = _a.processReq, _e = _a.processRes, processRes = _e === void 0 ? processResBase : _e, _f = _a.processErr, processErr = _f === void 0 ? processErrBase : _f, _g = _a.throwErr, throwErr = _g === void 0 ? throwErrBase : _g;
                         _h = options || {}, params = _h.params, json = _h.json, query = _h.query;
                         url = "".concat(baseUrl, "/").concat(endpoint + "".replace(/^\/*/, ""));
-                        requestInit = __assign(__assign({ method: method.toUpperCase() }, request), { headers: __assign({ "content-type": "application/json" }, headers) });
+                        requestInit = tslib_1.__assign(tslib_1.__assign({ method: method.toUpperCase() }, request), { headers: tslib_1.__assign({ "content-type": "application/json" }, headers) });
                         if (processReqBase) {
                             transformed = processReqBase(method, url, query, json, params, requestInit);
                             url = transformed[0];
@@ -43,7 +31,7 @@ export var createApi = function (apiName, baseUrl, options) {
                             params = transformed[3];
                             requestInit = transformed[4];
                         }
-                        if (isFullObject(params)) {
+                        if ((0, utils_1.isFullObject)(params)) {
                             for (key in params) {
                                 url = url.replace("{".concat(key, "}"), params[key].toString());
                             }
@@ -58,8 +46,7 @@ export var createApi = function (apiName, baseUrl, options) {
                             requestInit.signal = controller.signal;
                         }
                         if (query) {
-                            // FIXME: ts-expect-error this assertion is not the best, but nevermind for now
-                            url += buildUrlQueryString(query);
+                            url += (0, utils_1.buildUrlQueryString)(query);
                         }
                         response = null;
                         result = null;
@@ -67,49 +54,44 @@ export var createApi = function (apiName, baseUrl, options) {
                         _j.label = 1;
                     case 1:
                         _j.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, fetch(url, requestInit)];
+                        return [4, fetch(url, requestInit)];
                     case 2:
                         response = _j.sent();
-                        return [3 /*break*/, 4];
+                        return [3, 4];
                     case 3:
                         e_1 = _j.sent();
-                        msg = errorToString(e_1);
-                        return [3 /*break*/, 4];
+                        msg = (0, utils_1.errorToString)(e_1);
+                        return [3, 4];
                     case 4:
                         if (timeoutId) {
                             clearTimeout(timeoutId);
                         }
-                        if (!response) return [3 /*break*/, 11];
+                        if (!response) return [3, 11];
                         _j.label = 5;
                     case 5:
                         _j.trys.push([5, 10, , 11]);
-                        if (!processRes) return [3 /*break*/, 7];
-                        return [4 /*yield*/, processRes(response, options || {})];
+                        if (!processRes) return [3, 7];
+                        return [4, processRes(response, options || {})];
                     case 6:
                         result = _j.sent();
-                        return [3 /*break*/, 9];
-                    case 7: return [4 /*yield*/, response.json()];
+                        return [3, 9];
+                    case 7: return [4, response.json()];
                     case 8:
                         result = _j.sent();
                         _j.label = 9;
-                    case 9: return [3 /*break*/, 11];
+                    case 9: return [3, 11];
                     case 10:
                         e_2 = _j.sent();
-                        msg = errorToString(e_2);
-                        return [3 /*break*/, 11];
+                        msg = (0, utils_1.errorToString)(e_2);
+                        return [3, 11];
                     case 11:
-                        if (!(result === null)) return [3 /*break*/, 14];
-                        if (!processErr) return [3 /*break*/, 13];
-                        return [4 /*yield*/, processErr(msg, options || {})];
+                        if (!(result === null)) return [3, 14];
+                        if (!processErr) return [3, 13];
+                        return [4, processErr(msg, options || {})];
                     case 12:
                         result = _j.sent();
-                        return [3 /*break*/, 14];
+                        return [3, 14];
                     case 13:
-                        // this error should only happen on network errors or wrong API urls
-                        // there is no specific HTTP error for this, we can consider these
-                        // two statuses though:
-                        // - [100 Continue](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/100)
-                        // - [501 Not Implemented](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/501)
                         result = {
                             data: null,
                             msg: msg,
@@ -120,9 +102,6 @@ export var createApi = function (apiName, baseUrl, options) {
                         _j.label = 14;
                     case 14:
                         if (throwErr && (result === null || result === void 0 ? void 0 : 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") {
@@ -134,11 +113,12 @@ export var createApi = function (apiName, baseUrl, options) {
                                 console.info("\uD83D\uDD34 ".concat(logMsg));
                             }
                         }
-                        return [2 /*return*/, result];
+                        return [2, result];
                 }
             });
         }); };
         return api;
     }, {});
 };
-export default createApi;
+exports.createApi = createApi;
+exports.default = exports.createApi;

package/cjs/createApiResultFail.d.ts

@@ -0,0 +1,2 @@
+export declare const createApiResultFail: <T>(data?: T, msg?: string, status?: number) => Koine.Api.ResultFail<T>;
+export default createApiResultFail;

package/cjs/createApiResultFail.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createApiResultFail = void 0;
+var createApiResultFail = function (data, msg, status) {
+    if (data === void 0) { data = {}; }
+    return ({
+        fail: true,
+        data: data,
+        msg: msg || "",
+        status: status || 404,
+    });
+};
+exports.createApiResultFail = createApiResultFail;
+exports.default = exports.createApiResultFail;

package/cjs/createApiResultOk.d.ts

@@ -0,0 +1,2 @@
+export declare const createApiResultOk: <T>(data?: T, msg?: string) => Koine.Api.ResultOk<T>;
+export default createApiResultOk;

package/cjs/createApiResultOk.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createApiResultOk = void 0;
+var createApiResultOk = function (data, msg) {
+    if (data === void 0) { data = {}; }
+    return ({
+        ok: true,
+        fail: false,
+        data: data,
+        msg: msg || "",
+        status: 200,
+    });
+};
+exports.createApiResultOk = createApiResultOk;
+exports.default = exports.createApiResultOk;

package/cjs/createSwrApi.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="./typings.d.ts" />
+import { type BareFetcher, type SWRConfiguration, type SWRResponse } from "swr";
+import { type SWRMutationConfiguration, type SWRMutationResponse } from "swr/mutation";
+type SWRConfigurationExtended<Data = any, Error = any, Fn extends BareFetcher<any> = BareFetcher<any>> = SWRConfiguration<Data, Error, Fn> & {
+    when?: boolean | (() => boolean);
+};
+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.EndpointOptions<TEndpoints, TEndpoint, TMethod>, config?: THookName extends "useGet" ? SWRConfigurationExtended<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.EndpointOptions<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.EndpointOptions<TEndpoints, TEndpoint, TMethod>, TEndpoint>;
+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 default createSwrApi;

package/cjs/createSwrApi.js

@@ -0,0 +1,61 @@
+"use strict";
+"use client";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSwrApi = void 0;
+var tslib_1 = require("tslib");
+var swr_1 = require("swr");
+var mutation_1 = require("swr/mutation");
+var utils_1 = require("@koine/utils");
+var createApi_1 = require("./createApi");
+function createUseApi(api, method) {
+    return function useApi(endpoint, options, _config) {
+        var _this = this;
+        if (method === "get") {
+            var fetcher = function () { return tslib_1.__awaiter(_this, void 0, void 0, function () {
+                var data;
+                return tslib_1.__generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0: return [4, api[method](endpoint, tslib_1.__assign(tslib_1.__assign({}, (options || {})), { throwErr: true }))];
+                        case 1:
+                            data = (_a.sent()).data;
+                            return [2, data];
+                    }
+                });
+            }); };
+            var config_1 = _config;
+            var shouldNotFetch = (config_1 === null || config_1 === void 0 ? void 0 : config_1.when) === false ||
+                ((0, utils_1.isFunction)(config_1 === null || config_1 === void 0 ? void 0 : config_1.when) && (config_1 === null || config_1 === void 0 ? void 0 : config_1.when()) === false);
+            return (0, swr_1.default)(shouldNotFetch ? null : options ? [endpoint, options] : [endpoint], fetcher, config_1);
+        }
+        var config = _config;
+        var sender = function (_endpoint, _options) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
+            var endpoint, options, _a, ok, data;
+            return tslib_1.__generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        endpoint = Array.isArray(_endpoint) ? _endpoint[0] : _endpoint;
+                        options = Array.isArray(_endpoint) ? _endpoint[1] : {};
+                        return [4, api[method](endpoint, tslib_1.__assign(tslib_1.__assign(tslib_1.__assign({}, options), (_options.arg || {})), { throwErr: true }))];
+                    case 1:
+                        _a = _b.sent(), ok = _a.ok, data = _a.data;
+                        return [2, ok ? data : data];
+                }
+            });
+        }); };
+        return (0, mutation_1.default)(options ? [endpoint, options] : endpoint, sender, config);
+    };
+}
+var createSwrApi = function () {
+    var args = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        args[_i] = arguments[_i];
+    }
+    var api = createApi_1.default.apply(void 0, tslib_1.__spreadArray([], tslib_1.__read(args), false));
+    ["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;
+};
+exports.createSwrApi = createSwrApi;
+exports.default = exports.createSwrApi;

package/cjs/index.d.ts

@@ -0,0 +1,6 @@
+export { ApiError } from "./ApiError";
+export { createApi } from "./createApi";
+export { createApiResultFail } from "./createApiResultFail";
+export { createApiResultOk } from "./createApiResultOk";
+export { createSwrApi } from "./createSwrApi";
+export { nextApiResponse12 } from "./nextApiResponse12";

package/cjs/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nextApiResponse12 = exports.createSwrApi = exports.createApiResultOk = exports.createApiResultFail = exports.createApi = exports.ApiError = void 0;
+var ApiError_1 = require("./ApiError");
+Object.defineProperty(exports, "ApiError", { enumerable: true, get: function () { return ApiError_1.ApiError; } });
+var createApi_1 = require("./createApi");
+Object.defineProperty(exports, "createApi", { enumerable: true, get: function () { return createApi_1.createApi; } });
+var createApiResultFail_1 = require("./createApiResultFail");
+Object.defineProperty(exports, "createApiResultFail", { enumerable: true, get: function () { return createApiResultFail_1.createApiResultFail; } });
+var createApiResultOk_1 = require("./createApiResultOk");
+Object.defineProperty(exports, "createApiResultOk", { enumerable: true, get: function () { return createApiResultOk_1.createApiResultOk; } });
+var createSwrApi_1 = require("./createSwrApi");
+Object.defineProperty(exports, "createSwrApi", { enumerable: true, get: function () { return createSwrApi_1.createSwrApi; } });
+var nextApiResponse12_1 = require("./nextApiResponse12");
+Object.defineProperty(exports, "nextApiResponse12", { enumerable: true, get: function () { return nextApiResponse12_1.nextApiResponse12; } });

package/cjs/nextApiResponse.d.ts

@@ -0,0 +1,6 @@
+import { NextResponse } from "next/server";
+export declare const nextApiResponse: {
+    ok<T>(data: T, msg?: string): NextResponse<Koine.Api.ResultOk<T>>;
+    fail<T_1>(data: T_1, msg?: string, status?: number): NextResponse<Koine.Api.ResultFail<T_1>>;
+};
+export default nextApiResponse;

package/cjs/nextApiResponse.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nextApiResponse = void 0;
+var server_1 = require("next/server");
+var createApiResultFail_1 = require("./createApiResultFail");
+var createApiResultOk_1 = require("./createApiResultOk");
+exports.nextApiResponse = {
+    ok: function (data, msg) {
+        return server_1.NextResponse.json((0, createApiResultOk_1.default)(data, msg));
+    },
+    fail: function (data, msg, status) {
+        return server_1.NextResponse.json((0, createApiResultFail_1.default)(data, msg, status));
+    },
+};
+exports.default = exports.nextApiResponse;

package/cjs/nextApiResponse12.d.ts

@@ -0,0 +1,6 @@
+import type { NextApiResponse } from "next";
+export declare const nextApiResponse12: (nextRes: NextApiResponse) => {
+    ok<T>(data: T, msg?: string): void;
+    fail<T_1>(data: T_1, msg?: string, status?: number): void;
+};
+export default nextApiResponse12;

package/cjs/nextApiResponse12.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nextApiResponse12 = void 0;
+var createApiResultFail_1 = require("./createApiResultFail");
+var createApiResultOk_1 = require("./createApiResultOk");
+var nextApiResponse12 = function (nextRes) {
+    return {
+        ok: function (data, msg) {
+            nextRes.status(200).json((0, createApiResultOk_1.default)(data, msg));
+        },
+        fail: function (data, msg, status) {
+            nextRes
+                .status(status || 404)
+                .json((0, createApiResultFail_1.default)(data, msg, status));
+        },
+    };
+};
+exports.nextApiResponse12 = nextApiResponse12;
+exports.default = exports.nextApiResponse12;

package/cjs/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@koine/api",
+  "sideEffects": false,
+  "dependencies": {
+    "@koine/utils": "*"
+  },
+  "peerDependenciesMeta": {
+    "next": {
+      "optional": true
+    },
+    "swr": {
+      "optional": true
+    }
+  },
+  "main": "./index.js",
+  "types": "./index.d.ts"
+}

package/createApi.d.ts

@@ -1,8 +1,2 @@
-/**
- * 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>;
 export default createApi;

package/createApi.js

@@ -1,35 +1,17 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createApi = void 0;
-var tslib_1 = require("tslib");
-var buildUrlQueryString_1 = require("@koine/utils/buildUrlQueryString");
-var isFullObject_1 = require("@koine/utils/isFullObject");
-var errorToString_1 = require("@koine/utils/errorToString");
-/**
- * Create api client
- *
- * @param apiName Short name to use in debug logs
- * @param baseUrl Either relativ eor absolute, it must end without trailing slash
- */
-var createApi = function (apiName, baseUrl, options) {
-    var _a = options || {}, _b = _a.headers, headersBase = _b === void 0 ? {} : _b, _c = _a.request, requestBase = _c === void 0 ? {
-        referrerPolicy: "no-referrer",
-        // credentials: "include",
-        // mode: "cors",
-        // redirect: "follow",
-        // cache: "no-cache",
-    } : _c, throwErrBase = _a.throwErr, _d = _a.timeout, timeoutBase = _d === void 0 ? 10000 : _d, processReqBase = _a.processReq, processResBase = _a.processRes, processErrBase = _a.processErr;
+import { __assign, __awaiter, __generator } from "tslib";
+import { buildUrlQueryString, errorToString, isFullObject, } from "@koine/utils";
+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 ? {} : _c, throwErrBase = _a.throwErr, _d = _a.timeout, timeoutBase = _d === void 0 ? 10000 : _d, processReqBase = _a.processReq, processResBase = _a.processRes, processErrBase = _a.processErr;
     return ["get", "post", "put", "patch", "delete"].reduce(function (api, method) {
-        // @ts-expect-error FIXME: type
-        api[method] = function (endpoint, options) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
+        api[method] = function (endpoint, options) { return __awaiter(void 0, void 0, void 0, function () {
             var _a, _b, request, _c, headers, _d, timeout, processReq, _e, processRes, _f, processErr, _g, throwErr, _h, params, json, query, url, requestInit, transformed, transformed, key, timeoutNumber, controller, timeoutId, response, result, msg, e_1, e_2, logMsg;
-            return tslib_1.__generator(this, function (_j) {
+            return __generator(this, function (_j) {
                 switch (_j.label) {
                     case 0:
                         _a = options || {}, _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, processReq = _a.processReq, _e = _a.processRes, processRes = _e === void 0 ? processResBase : _e, _f = _a.processErr, processErr = _f === void 0 ? processErrBase : _f, _g = _a.throwErr, throwErr = _g === void 0 ? throwErrBase : _g;
                         _h = options || {}, params = _h.params, json = _h.json, query = _h.query;
                         url = "".concat(baseUrl, "/").concat(endpoint + "".replace(/^\/*/, ""));
-                        requestInit = tslib_1.__assign(tslib_1.__assign({ method: method.toUpperCase() }, request), { headers: tslib_1.__assign({ "content-type": "application/json" }, headers) });
+                        requestInit = __assign(__assign({ method: method.toUpperCase() }, request), { headers: __assign({ "content-type": "application/json" }, headers) });
                         if (processReqBase) {
                             transformed = processReqBase(method, url, query, json, params, requestInit);
                             url = transformed[0];
@@ -46,7 +28,7 @@ var createApi = function (apiName, baseUrl, options) {
                             params = transformed[3];
                             requestInit = transformed[4];
                         }
-                        if ((0, isFullObject_1.default)(params)) {
+                        if (isFullObject(params)) {
                             for (key in params) {
                                 url = url.replace("{".concat(key, "}"), params[key].toString());
                             }
@@ -61,8 +43,7 @@ var createApi = function (apiName, baseUrl, options) {
                             requestInit.signal = controller.signal;
                         }
                         if (query) {
-                            // FIXME: ts-expect-error this assertion is not the best, but nevermind for now
-                            url += (0, buildUrlQueryString_1.default)(query);
+                            url += buildUrlQueryString(query);
                         }
                         response = null;
                         result = null;
@@ -70,49 +51,44 @@ var createApi = function (apiName, baseUrl, options) {
                         _j.label = 1;
                     case 1:
                         _j.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, fetch(url, requestInit)];
+                        return [4, fetch(url, requestInit)];
                     case 2:
                         response = _j.sent();
-                        return [3 /*break*/, 4];
+                        return [3, 4];
                     case 3:
                         e_1 = _j.sent();
-                        msg = (0, errorToString_1.default)(e_1);
-                        return [3 /*break*/, 4];
+                        msg = errorToString(e_1);
+                        return [3, 4];
                     case 4:
                         if (timeoutId) {
                             clearTimeout(timeoutId);
                         }
-                        if (!response) return [3 /*break*/, 11];
+                        if (!response) return [3, 11];
                         _j.label = 5;
                     case 5:
                         _j.trys.push([5, 10, , 11]);
-                        if (!processRes) return [3 /*break*/, 7];
-                        return [4 /*yield*/, processRes(response, options || {})];
+                        if (!processRes) return [3, 7];
+                        return [4, processRes(response, options || {})];
                     case 6:
                         result = _j.sent();
-                        return [3 /*break*/, 9];
-                    case 7: return [4 /*yield*/, response.json()];
+                        return [3, 9];
+                    case 7: return [4, response.json()];
                     case 8:
                         result = _j.sent();
                         _j.label = 9;
-                    case 9: return [3 /*break*/, 11];
+                    case 9: return [3, 11];
                     case 10:
                         e_2 = _j.sent();
-                        msg = (0, errorToString_1.default)(e_2);
-                        return [3 /*break*/, 11];
+                        msg = errorToString(e_2);
+                        return [3, 11];
                     case 11:
-                        if (!(result === null)) return [3 /*break*/, 14];
-                        if (!processErr) return [3 /*break*/, 13];
-                        return [4 /*yield*/, processErr(msg, options || {})];
+                        if (!(result === null)) return [3, 14];
+                        if (!processErr) return [3, 13];
+                        return [4, processErr(msg, options || {})];
                     case 12:
                         result = _j.sent();
-                        return [3 /*break*/, 14];
+                        return [3, 14];
                     case 13:
-                        // this error should only happen on network errors or wrong API urls
-                        // there is no specific HTTP error for this, we can consider these
-                        // two statuses though:
-                        // - [100 Continue](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/100)
-                        // - [501 Not Implemented](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/501)
                         result = {
                             data: null,
                             msg: msg,
@@ -123,9 +99,6 @@ var createApi = function (apiName, baseUrl, options) {
                         _j.label = 14;
                     case 14:
                         if (throwErr && (result === null || result === void 0 ? void 0 : 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") {
@@ -137,12 +110,11 @@ var createApi = function (apiName, baseUrl, options) {
                                 console.info("\uD83D\uDD34 ".concat(logMsg));
                             }
                         }
-                        return [2 /*return*/, result];
+                        return [2, result];
                 }
             });
         }); };
         return api;
     }, {});
 };
-exports.createApi = createApi;
-exports.default = exports.createApi;
+export default createApi;

package/createApiResultFail.d.ts

@@ -0,0 +1,2 @@
+export declare const createApiResultFail: <T>(data?: T, msg?: string, status?: number) => Koine.Api.ResultFail<T>;
+export default createApiResultFail;

package/createApiResultFail.js

@@ -0,0 +1,10 @@
+export var createApiResultFail = function (data, msg, status) {
+    if (data === void 0) { data = {}; }
+    return ({
+        fail: true,
+        data: data,
+        msg: msg || "",
+        status: status || 404,
+    });
+};
+export default createApiResultFail;

package/createApiResultOk.d.ts

@@ -0,0 +1,2 @@
+export declare const createApiResultOk: <T>(data?: T, msg?: string) => Koine.Api.ResultOk<T>;
+export default createApiResultOk;

package/createApiResultOk.js

@@ -0,0 +1,11 @@
+export var createApiResultOk = function (data, msg) {
+    if (data === void 0) { data = {}; }
+    return ({
+        ok: true,
+        fail: false,
+        data: data,
+        msg: msg || "",
+        status: 200,
+    });
+};
+export default createApiResultOk;