@koine/api 2.0.0-beta.9 → 2.0.0-beta.91

package/ApiError.mjs

@@ -1,14 +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 class ApiError extends Error {
-    constructor(result){
-        super(`Request failed with ${result.status} ${result.msg}`);
-        this.name = "ApiError";
-        Object.assign(this, result);
-    }
-}
-export 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/createApi.mjs

@@ -1,128 +0,0 @@
-import buildUrlQueryString from "@koine/utils/buildUrlQueryString";
-import errorToString from "@koine/utils/errorToString";
-import isFullObject from "@koine/utils/isFullObject";
-/**
- * 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 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 (isFullObject(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 += buildUrlQueryString(query);
-            }
-            let response = null;
-            let result = null;
-            let msg = "";
-            try {
-                response = await fetch(url, requestInit);
-            } catch (e) {
-                msg = errorToString(e);
-            }
-            if (timeoutId) {
-                clearTimeout(timeoutId);
-            }
-            if (response) {
-                try {
-                    if (processRes) {
-                        result = await processRes(response, options || {});
-                    } else {
-                        result = await response.json();
-                    }
-                } catch (e) {
-                    msg = errorToString(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;
-    }, {});
-};
-export default createApi;

package/createSwrApi.d.ts

@@ -1,34 +0,0 @@
-import { type BareFetcher, // type Fetcher,
-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> & {
-    /**
-     * Conditional fetching as option
-     *
-     * Moving this to an option allows us to keep the endpoints typed dictionary,
-     * e.g. we can write:
-     *
-     * ```js
-     * const { data, mutate } = myApi.useGet("User/{id}",
-     *  { params: { id: aVariableMaybeContainingAnId || "" }, },
-     *  { when: !!aVariableMaybeContainingAnId }
-     * );
-     *
-     * // we still have typed `data`, `mutate`
-     * ```
-     * @see https://swr.vercel.app/docs/conditional-fetching
-     */
-    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>;
-/**
- * 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 default createSwrApi;

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

@@ -1,82 +0,0 @@
-"use client";
-import useSWR from "swr";
-import useSWRMutation from "swr/mutation";
-import isFunction from "@koine/utils/isFunction";
-import createApi from "./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 || isFunction(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 useSWR(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 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 const createSwrApi = (...args)=>{
-    const api = createApi(...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;
-};
-export 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/index.mjs

@@ -1,4 +0,0 @@
-export { ApiError } from "./ApiError";
-export { createApi } from "./createApi";
-export { createSwrApi } from "./createSwrApi";
-export { nextApiResponse } from "./nextApiResponse";

package/nextApiResponse.d.ts

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

package/nextApiResponse.mjs

@@ -1,5 +0,0 @@
-export const nextApiResponse = (nextRes, result)=>{
-    // nextRes.status(result.status).json(result.data || result.msg);
-    nextRes.status(result.status).json(result);
-};
-export default nextApiResponse;