@koine/api 2.0.0-beta.10 → 2.0.0-beta.12

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.mjs

@@ -0,0 +1,7 @@
+export const createApiResultFail = (data = {}, msg, status)=>({
+        fail: true,
+        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.mjs

@@ -0,0 +1,8 @@
+export const createApiResultOk = (data = {}, msg)=>({
+        ok: true,
+        fail: false,
+        data,
+        msg: msg || "",
+        status: 200
+    });
+export default createApiResultOk;

package/index.d.ts

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

package/index.mjs

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

package/nextApiResponse.d.ts

@@ -1,3 +1,5 @@
-import type { NextApiResponse } from "next";
-export declare const nextApiResponse: (nextRes: NextApiResponse, result: Koine.Api.ResultOk | Koine.Api.ResultFail) => void;
+export declare const nextApiResponse: {
+    ok<T>(data: T, msg?: string): void;
+    fail<T_1>(data: T_1, msg?: string, status?: number): void;
+};
 export default nextApiResponse;

package/nextApiResponse.mjs

@@ -1,5 +1,12 @@
-export const nextApiResponse = (nextRes, result)=>{
-    // nextRes.status(result.status).json(result.data || result.msg);
-    nextRes.status(result.status).json(result);
+import { NextResponse } from "next/server";
+import createApiResultFail from "./createApiResultFail";
+import createApiResultOk from "./createApiResultOk";
+export const nextApiResponse = {
+    ok (data, msg) {
+        NextResponse.json(createApiResultOk(data, msg));
+    },
+    fail (data, msg, status) {
+        NextResponse.json(createApiResultFail(data, msg, status));
+    }
 };
 export default nextApiResponse;

package/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/nextApiResponse12.mjs

@@ -0,0 +1,13 @@
+import createApiResultFail from "./createApiResultFail";
+import createApiResultOk from "./createApiResultOk";
+export const nextApiResponse12 = (nextRes)=>{
+    return {
+        ok (data, msg) {
+            nextRes.status(200).json(createApiResultOk(data, msg));
+        },
+        fail (data, msg, status) {
+            nextRes.status(status || 404).json(createApiResultFail(data, msg, status));
+        }
+    };
+};
+export default nextApiResponse12;

package/package.json

@@ -10,15 +10,15 @@
     }
   },
   "dependencies": {
-    "@koine/utils": "2.0.0-beta.10"
+    "@koine/utils": "2.0.0-beta.12"
   },
   "module": "./index.mjs",
   "main": "./index.js",
   "types": "./index.d.ts",
   "peerDependencies": {
-    "next": "^13.4.7",
+    "next": "^13.4.12",
     "swr": "^2.2.0",
-    "type-fest": "^3.12.0"
+    "type-fest": "^4.1.0"
   },
-  "version": "2.0.0-beta.10"
+  "version": "2.0.0-beta.12"
 }

package/typings.d.ts

@@ -424,6 +424,30 @@ declare namespace Koine.Api {
     [K in keyof _ShortcutsMaps as _ShortcutsMaps[K]]: K;
   };
 
+  /**
+   * @example
+   * ```ts
+   * // define the type on your `API` types:
+   * type Result = Koine.Api.GenerateResultShortcuts<Endpoints>;
+   *
+   * // consume the type wherever in your app:
+   * type MyResult = API.Result["get"]["my/endpoint"];
+   *
+   * MyResult["ok"];
+   * ^
+   * MyResult["fail"];
+   * ^
+   * ```
+   */
+  type GenerateResultShortcuts<TEndpoints extends Endpoints> = {
+    [TMethod in RequestMethod]: {
+      [TEndpointUrl in keyof TEndpoints]: {
+        ok: TEndpoints[TEndpointUrl][Uppercase<TMethod>]["ok"];
+        fail: TEndpoints[TEndpointUrl][Uppercase<TMethod>]["fail"];
+      };
+    };
+  };
+
   /**
    * @example
    * ```ts

package/ApiError.js

@@ -1,32 +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
- *
- */ "use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: all[name]
-    });
-}
-_export(exports, {
-    ApiError: function() {
-        return ApiError;
-    },
-    default: function() {
-        return _default;
-    }
-});
-let ApiError = class ApiError extends Error {
-    constructor(result){
-        super(`Request failed with ${result.status} ${result.msg}`);
-        this.name = "ApiError";
-        Object.assign(this, result);
-    }
-};
-const _default = ApiError;

package/createApi.js

@@ -1,142 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: all[name]
-    });
-}
-_export(exports, {
-    createApi: function() {
-        return createApi;
-    },
-    default: function() {
-        return _default;
-    }
-});
-const _interop_require_default = require("@swc/helpers/_/_interop_require_default");
-const _buildUrlQueryString = /*#__PURE__*/ _interop_require_default._(require("@koine/utils/buildUrlQueryString"));
-const _errorToString = /*#__PURE__*/ _interop_require_default._(require("@koine/utils/errorToString"));
-const _isFullObject = /*#__PURE__*/ _interop_require_default._(require("@koine/utils/isFullObject"));
-const createApi = (apiName, baseUrl, options)=>{
-    const { headers: headersBase = {}, request: requestBase = {
-        referrerPolicy: "no-referrer"
-    }, throwErr: throwErrBase, timeout: timeoutBase = 10000, processReq: processReqBase, processRes: processResBase, processErr: processErrBase } = options || {};
-    return [
-        "get",
-        "post",
-        "put",
-        "patch",
-        "delete"
-    ].reduce((api, method)=>{
-        // @ts-expect-error FIXME: type
-        api[method] = async (endpoint, options)=>{
-            const { request = requestBase, headers = headersBase, timeout = timeoutBase, processReq, processRes = processResBase, processErr = processErrBase, throwErr = throwErrBase } = options || {};
-            let { params, json, query } = options || {};
-            let url = `${baseUrl}/${endpoint + "".replace(/^\/*/, "")}`;
-            let requestInit = {
-                method: method.toUpperCase(),
-                ...request,
-                headers: {
-                    "content-type": "application/json",
-                    ...headers
-                }
-            };
-            if (processReqBase) {
-                const transformed = processReqBase(method, url, query, json, params, requestInit);
-                url = transformed[0];
-                query = transformed[1];
-                json = transformed[2];
-                params = transformed[3];
-                requestInit = transformed[4];
-            }
-            if (processReq) {
-                const transformed = processReq(method, url, query, json, params, requestInit);
-                url = transformed[0];
-                query = transformed[1];
-                json = transformed[2];
-                params = transformed[3];
-                requestInit = transformed[4];
-            }
-            if ((0, _isFullObject.default)(params)) {
-                for(const key in params){
-                    url = url.replace(`{${key}}`, params[key].toString());
-                }
-            }
-            const timeoutNumber = Number(timeout);
-            let controller;
-            let timeoutId;
-            if (json) {
-                requestInit.body = JSON.stringify(json);
-            }
-            if (timeoutNumber > 0) {
-                controller = new AbortController();
-                timeoutId = setTimeout(()=>controller.abort(), timeoutNumber);
-                requestInit.signal = controller.signal;
-            }
-            if (query) {
-                // FIXME: ts-expect-error this assertion is not the best, but nevermind for now
-                url += (0, _buildUrlQueryString.default)(query);
-            }
-            let response = null;
-            let result = null;
-            let msg = "";
-            try {
-                response = await fetch(url, requestInit);
-            } catch (e) {
-                msg = (0, _errorToString.default)(e);
-            }
-            if (timeoutId) {
-                clearTimeout(timeoutId);
-            }
-            if (response) {
-                try {
-                    if (processRes) {
-                        result = await processRes(response, options || {});
-                    } else {
-                        result = await response.json();
-                    }
-                } catch (e) {
-                    msg = (0, _errorToString.default)(e);
-                }
-            }
-            if (result === null) {
-                if (processErr) {
-                    result = await processErr(msg, options || {});
-                } else {
-                    // 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,
-                        status: 100,
-                        fail: true,
-                        ok: false
-                    };
-                }
-            }
-            if (throwErr && 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") {
-                const logMsg = `${result?.status}: api[${apiName}] ${method.toUpperCase()} ${url}`;
-                if (result?.ok) {
-                    console.info(`🟢 ${logMsg}`);
-                } else {
-                    console.info(`🔴 ${logMsg}`);
-                }
-            }
-            return result;
-        };
-        return api;
-    }, {});
-};
-const _default = createApi;

package/createSwrApi.js

@@ -1,99 +0,0 @@
-"use client";
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: all[name]
-    });
-}
-_export(exports, {
-    createSwrApi: function() {
-        return createSwrApi;
-    },
-    default: function() {
-        return _default;
-    }
-});
-const _interop_require_default = require("@swc/helpers/_/_interop_require_default");
-const _swr = /*#__PURE__*/ _interop_require_default._(require("swr"));
-const _mutation = /*#__PURE__*/ _interop_require_default._(require("swr/mutation"));
-const _isFunction = /*#__PURE__*/ _interop_require_default._(require("@koine/utils/isFunction"));
-const _createApi = /*#__PURE__*/ _interop_require_default._(require("./createApi"));
-function createUseApi(api, method) {
-    return function useApi(endpoint, options, _config) {
-        if (method === "get") {
-            // const fetcher = async (_endpoint: TEndpoint) => {
-            //   try {
-            //     const { ok, data } = await api[method](_endpoint, {
-            //         ...(options || {}),
-            //         throwErr: 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>;;
-            //     }
-            //   };
-            // }
-            const fetcher = async ()=>{
-                const { data } = await api[method](endpoint, {
-                    ...options || {},
-                    throwErr: true
-                });
-                return data;
-            };
-            const config = _config;
-            const shouldNotFetch = config?.when === false || (0, _isFunction.default)(config?.when) && config?.when() === false;
-            // <Data = any, Error = any>(key: Key, config: SWRConfigurationExtended<Data, Error, Fetcher<Data>> | undefined): SWRResponse<Data, Error>;
-            // eslint-disable-next-line react-hooks/rules-of-hooks
-            return (0, _swr.default)(shouldNotFetch ? null : options ? [
-                endpoint,
-                options
-            ] : [
-                endpoint
-            ], fetcher, config);
-        }
-        const config = _config;
-        const sender = async (// 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)=>{
-            const endpoint = Array.isArray(_endpoint) ? _endpoint[0] : _endpoint;
-            const options = Array.isArray(_endpoint) ? _endpoint[1] : {};
-            const { ok, data } = await api[method](endpoint, {
-                ...options,
-                ..._options.arg || {},
-                throwErr: true
-            });
-            return ok ? data : data;
-        };
-        // config.fetcher = sender;
-        // eslint-disable-next-line react-hooks/rules-of-hooks
-        return (0, _mutation.default)(// @ts-expect-error FIXME: I can't get it...
-        options ? [
-            endpoint,
-            options
-        ] : endpoint, sender, config);
-    };
-}
-const createSwrApi = (...args)=>{
-    const api = (0, _createApi.default)(...args);
-    [
-        "get",
-        "post",
-        "put",
-        "patch",
-        "delete"
-    ].forEach((method)=>{
-        const hookName = `use${method.charAt(0).toUpperCase() + method.slice(1)}`;
-        api[hookName] = createUseApi(api, method);
-    });
-    return api;
-};
-const _default = createSwrApi;

package/index.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: all[name]
-    });
-}
-_export(exports, {
-    ApiError: function() {
-        return _ApiError.ApiError;
-    },
-    createApi: function() {
-        return _createApi.createApi;
-    },
-    createSwrApi: function() {
-        return _createSwrApi.createSwrApi;
-    },
-    nextApiResponse: function() {
-        return _nextApiResponse.nextApiResponse;
-    }
-});
-const _ApiError = require("./ApiError");
-const _createApi = require("./createApi");
-const _createSwrApi = require("./createSwrApi");
-const _nextApiResponse = require("./nextApiResponse");

package/nextApiResponse.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: all[name]
-    });
-}
-_export(exports, {
-    nextApiResponse: function() {
-        return nextApiResponse;
-    },
-    default: function() {
-        return _default;
-    }
-});
-const nextApiResponse = (nextRes, result)=>{
-    // nextRes.status(result.status).json(result.data || result.msg);
-    nextRes.status(result.status).json(result);
-};
-const _default = nextApiResponse;