@koine/api 2.0.0-beta.82 → 2.0.0-beta.83

package/ApiError.cjs.js

@@ -2,7 +2,13 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-class ApiError extends Error{constructor(r){super(`Request failed with ${r.status} ${r.msg}`),this.name="ApiError",Object.assign(this,r);}}
+/**
+ * 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
+ *
+ */class ApiError extends Error{constructor(r){super(`Request failed with ${r.status} ${r.msg}`),this.name="ApiError",Object.assign(this,r);}}
 
 exports.ApiError = ApiError;
 exports["default"] = ApiError;

package/ApiError.esm.js

@@ -1,3 +1,9 @@
-class ApiError extends Error{constructor(r){super(`Request failed with ${r.status} ${r.msg}`),this.name="ApiError",Object.assign(this,r);}}
+/**
+ * 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
+ *
+ */class ApiError extends Error{constructor(r){super(`Request failed with ${r.status} ${r.msg}`),this.name="ApiError",Object.assign(this,r);}}
 
 export { ApiError, ApiError as default };

package/createApi.cjs.js

@@ -4,7 +4,24 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var utils = require('@koine/utils');
 
-let o=["get","post","put","patch","delete"];let createApi=(l,a,i)=>{let{headers:s={},request:n={},throwErr:p,timeout:c=1e4,processReq:u,processRes:f,processErr:d}=i||{};return o.reduce((o,i)=>(o[i]=async(o,h)=>{let $,m;let{request:w=n,headers:y=s,timeout:g=c,processReq:b,processRes:E=f,processErr:N=d,throwErr:k=p}=h||{},{params:A,json:C,query:j}=h||{},q=`${a}/${o+"".replace(/^\/*/,"")}`,v={method:i.toUpperCase(),...w,headers:{"content-type":"application/json",...y}};if(u){let e=u(i,q,j,C,A,v);q=e[0],j=e[1],C=e[2],A=e[3],v=e[4];}if(b){let e=b(i,q,j,C,A,v);q=e[0],j=e[1],C=e[2],A=e[3],v=e[4];}if(utils.isFullObject(A))for(let e in A)q=q.replace(`{${e}}`,A[e].toString());let x=Number(g);C&&(v.body=JSON.stringify(C)),x>0&&($=new AbortController,m=setTimeout(()=>$.abort(),x),v.signal=$.signal),j&&(q+=utils.buildUrlQueryString(j));let O=null,R=null,S="";try{O=await fetch(q,v);}catch(e){S=utils.errorToString(e);}if(m&&clearTimeout(m),O)try{R=E?await E(O,h||{}):await O.json();}catch(e){S=utils.errorToString(e);}if(null===R&&(R=N?await N(S,h||{}):{data:null,msg:S,status:100,fail:!0,ok:!1}),k&&R?.fail)throw R;if("development"===process.env.NODE_ENV){let e=`${R?.status}: api[${l}] ${i.toUpperCase()} ${q}`;R?.ok?console.info(`🟢 ${e}`):console.info(`🔴 ${e}`);}return R},o),{})};
+let o=["get","post","put","patch","delete"];/**
+ * Create api client
+ *
+ * @param apiName Short name to use in debug logs
+ * @param baseUrl Either relativ eor absolute, it must end without trailing slash
+ */let createApi=(l,a,i)=>{let{headers:s={},request:n={},throwErr:p,timeout:c=1e4,processReq:u,processRes:f,processErr:d}=i||{};return o.reduce((o,i)=>(// @ts-expect-error FIXME: type
+    o[i]=async(o,h)=>{let $,m;let{request:w=n,headers:y=s,timeout:g=c,processReq:b,processRes:E=f,processErr:N=d,throwErr:k=p}=h||{},{params:A,json:C,query:j}=h||{},q=`${a}/${o+"".replace(/^\/*/,"")}`,v={method:i.toUpperCase(),...w,headers:{"content-type":"application/json",...y}};if(u){let e=u(i,q,j,C,A,v);q=e[0],j=e[1],C=e[2],A=e[3],v=e[4];}if(b){let e=b(i,q,j,C,A,v);q=e[0],j=e[1],C=e[2],A=e[3],v=e[4];}if(utils.isFullObject(A))for(let e in A)q=q.replace(`{${e}}`,A[e].toString());let x=Number(g);C&&(v.body=JSON.stringify(C)),x>0&&(// TODO: combine multiple abort signals
+    // @see https://dev.to/rashidshamloo/adding-timeout-and-multiple-abort-signals-to-fetch-typescriptreact-33bb
+    $=new AbortController,m=setTimeout(()=>$.abort(),x),v.signal=$.signal),j&&// FIXME: ts-expect-error this assertion is not the best, but nevermind for now
+    (q+=utils.buildUrlQueryString(j));let O=null,R=null,S="";try{O=await fetch(q,v);}catch(e){S=utils.errorToString(e);}if(m&&clearTimeout(m),O)try{R=E?await E(O,h||{}):await O.json();}catch(e){S=utils.errorToString(e);}if(null===R&&(R=N?await N(S,h||{}):// 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)
+    {data:null,msg:S,status:100,fail:!0,ok:!1}),k&&R?.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 R;if("development"===process.env.NODE_ENV){let e=`${R?.status}: api[${l}] ${i.toUpperCase()} ${q}`;R?.ok?console.info(`🟢 ${e}`):console.info(`🔴 ${e}`);}return R},o),{})};
 
 exports.createApi = createApi;
 exports["default"] = createApi;

package/createApi.esm.js

@@ -1,5 +1,22 @@
 import { isFullObject, buildUrlQueryString, errorToString } from '@koine/utils';
 
-let o=["get","post","put","patch","delete"];let createApi=(l,a,i)=>{let{headers:s={},request:n={},throwErr:p,timeout:c=1e4,processReq:u,processRes:f,processErr:d}=i||{};return o.reduce((o,i)=>(o[i]=async(o,h)=>{let $,m;let{request:w=n,headers:y=s,timeout:g=c,processReq:b,processRes:E=f,processErr:N=d,throwErr:k=p}=h||{},{params:A,json:C,query:j}=h||{},q=`${a}/${o+"".replace(/^\/*/,"")}`,v={method:i.toUpperCase(),...w,headers:{"content-type":"application/json",...y}};if(u){let e=u(i,q,j,C,A,v);q=e[0],j=e[1],C=e[2],A=e[3],v=e[4];}if(b){let e=b(i,q,j,C,A,v);q=e[0],j=e[1],C=e[2],A=e[3],v=e[4];}if(isFullObject(A))for(let e in A)q=q.replace(`{${e}}`,A[e].toString());let x=Number(g);C&&(v.body=JSON.stringify(C)),x>0&&($=new AbortController,m=setTimeout(()=>$.abort(),x),v.signal=$.signal),j&&(q+=buildUrlQueryString(j));let O=null,R=null,S="";try{O=await fetch(q,v);}catch(e){S=errorToString(e);}if(m&&clearTimeout(m),O)try{R=E?await E(O,h||{}):await O.json();}catch(e){S=errorToString(e);}if(null===R&&(R=N?await N(S,h||{}):{data:null,msg:S,status:100,fail:!0,ok:!1}),k&&R?.fail)throw R;if("development"===process.env.NODE_ENV){let e=`${R?.status}: api[${l}] ${i.toUpperCase()} ${q}`;R?.ok?console.info(`🟢 ${e}`):console.info(`🔴 ${e}`);}return R},o),{})};
+let o=["get","post","put","patch","delete"];/**
+ * Create api client
+ *
+ * @param apiName Short name to use in debug logs
+ * @param baseUrl Either relativ eor absolute, it must end without trailing slash
+ */let createApi=(l,a,i)=>{let{headers:s={},request:n={},throwErr:p,timeout:c=1e4,processReq:u,processRes:f,processErr:d}=i||{};return o.reduce((o,i)=>(// @ts-expect-error FIXME: type
+    o[i]=async(o,h)=>{let $,m;let{request:w=n,headers:y=s,timeout:g=c,processReq:b,processRes:E=f,processErr:N=d,throwErr:k=p}=h||{},{params:A,json:C,query:j}=h||{},q=`${a}/${o+"".replace(/^\/*/,"")}`,v={method:i.toUpperCase(),...w,headers:{"content-type":"application/json",...y}};if(u){let e=u(i,q,j,C,A,v);q=e[0],j=e[1],C=e[2],A=e[3],v=e[4];}if(b){let e=b(i,q,j,C,A,v);q=e[0],j=e[1],C=e[2],A=e[3],v=e[4];}if(isFullObject(A))for(let e in A)q=q.replace(`{${e}}`,A[e].toString());let x=Number(g);C&&(v.body=JSON.stringify(C)),x>0&&(// TODO: combine multiple abort signals
+    // @see https://dev.to/rashidshamloo/adding-timeout-and-multiple-abort-signals-to-fetch-typescriptreact-33bb
+    $=new AbortController,m=setTimeout(()=>$.abort(),x),v.signal=$.signal),j&&// FIXME: ts-expect-error this assertion is not the best, but nevermind for now
+    (q+=buildUrlQueryString(j));let O=null,R=null,S="";try{O=await fetch(q,v);}catch(e){S=errorToString(e);}if(m&&clearTimeout(m),O)try{R=E?await E(O,h||{}):await O.json();}catch(e){S=errorToString(e);}if(null===R&&(R=N?await N(S,h||{}):// 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)
+    {data:null,msg:S,status:100,fail:!0,ok:!1}),k&&R?.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 R;if("development"===process.env.NODE_ENV){let e=`${R?.status}: api[${l}] ${i.toUpperCase()} ${q}`;R?.ok?console.info(`🟢 ${e}`):console.info(`🔴 ${e}`);}return R},o),{})};
 
 export { createApi, createApi as default };

package/createSwrApi.cjs.js

@@ -8,7 +8,45 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 
 var e__default = /*#__PURE__*/_interopDefaultLegacy(e);
 
-let createUseApi=t=>(i,o,p)=>{let a=async()=>{let{data:e}=await t.get(i,{...o||{},throwErr:!0});return e};return e__default["default"](p?.when===!1||utils.isFunction(p?.when)&&p?.when()===!1?null:o?[i,o]:[i],a,p)};let createSwrApi=(...e)=>{let r=createApi.createApi(...e);return r.use=createUseApi(r),r};
+/**
+   * 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.use("User/{id}",
+   *  { params: { id: aVariableMaybeContainingAnId || "" }, },
+   *  { when: !!aVariableMaybeContainingAnId }
+   * );
+   *
+   * // we still have typed `data`, `mutate`
+   * ```
+   * @see https://swr.vercel.app/docs/conditional-fetching
+   *//**
+ * @private
+ *//**
+ * @private
+ */let createUseApi=t=>(i,o,p)=>{// const fetcher = async (_endpoint: TEndpoint) => {
+    //   try {
+    //     const { ok, data } = await api.get(_endpoint, {
+    //         ...(options || {}),
+    //         throwErr: true,
+    //       });
+    //       if (ok) {
+    //         return data;
+    //       }
+    //       throw new Error() as unknown as Api.EndpointResponseFail<TEndpoints, TEndpoint, TMethod>;
+    //     } catch(e) {
+    //       throw new Error() as unknown as Api.EndpointResponseFail<TEndpoints, TEndpoint, TMethod>;;
+    //     }
+    //   };
+    // }
+    let a=async()=>{let{data:e}=await t.get(i,{...o||{},throwErr:!0});return e};// <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 e__default["default"](p?.when===!1||utils.isFunction(p?.when)&&p?.when()===!1?null:o?[i,o]:[i],a,p)};/**
+ * It creates an api client extended with auto-generated SWR wrapper hooks
+ */let createSwrApi=(...e)=>{let r=createApi.createApi(...e);return r.use=createUseApi(r),r};
 
 exports.createSwrApi = createSwrApi;
 exports.createUseApi = createUseApi;

package/createSwrApi.esm.js

@@ -2,6 +2,44 @@ import e from 'swr';
 import { isFunction } from '@koine/utils';
 import { createApi } from './createApi.esm.js';
 
-let createUseApi=t=>(i,o,p)=>{let a=async()=>{let{data:e}=await t.get(i,{...o||{},throwErr:!0});return e};return e(p?.when===!1||isFunction(p?.when)&&p?.when()===!1?null:o?[i,o]:[i],a,p)};let createSwrApi=(...e)=>{let r=createApi(...e);return r.use=createUseApi(r),r};
+/**
+   * 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.use("User/{id}",
+   *  { params: { id: aVariableMaybeContainingAnId || "" }, },
+   *  { when: !!aVariableMaybeContainingAnId }
+   * );
+   *
+   * // we still have typed `data`, `mutate`
+   * ```
+   * @see https://swr.vercel.app/docs/conditional-fetching
+   *//**
+ * @private
+ *//**
+ * @private
+ */let createUseApi=t=>(i,o,p)=>{// const fetcher = async (_endpoint: TEndpoint) => {
+    //   try {
+    //     const { ok, data } = await api.get(_endpoint, {
+    //         ...(options || {}),
+    //         throwErr: true,
+    //       });
+    //       if (ok) {
+    //         return data;
+    //       }
+    //       throw new Error() as unknown as Api.EndpointResponseFail<TEndpoints, TEndpoint, TMethod>;
+    //     } catch(e) {
+    //       throw new Error() as unknown as Api.EndpointResponseFail<TEndpoints, TEndpoint, TMethod>;;
+    //     }
+    //   };
+    // }
+    let a=async()=>{let{data:e}=await t.get(i,{...o||{},throwErr:!0});return e};// <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 e(p?.when===!1||isFunction(p?.when)&&p?.when()===!1?null:o?[i,o]:[i],a,p)};/**
+ * It creates an api client extended with auto-generated SWR wrapper hooks
+ */let createSwrApi=(...e)=>{let r=createApi(...e);return r.use=createUseApi(r),r};
 
 export { createUseApi as a, createSwrApi as c };

package/package.json

@@ -2,7 +2,7 @@
   "name": "@koine/api",
   "sideEffects": false,
   "dependencies": {
-    "@koine/utils": "2.0.0-beta.82"
+    "@koine/utils": "2.0.0-beta.83"
   },
   "peerDependencies": {
     "next": "^14.0.4",
@@ -61,5 +61,5 @@
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",
-  "version": "2.0.0-beta.82"
+  "version": "2.0.0-beta.83"
 }

package/swr/createSwrApi.d.ts

@@ -1,5 +1,11 @@
+import { type BareFetcher, type SWRConfiguration, type SWRResponse } from "swr";
 import type { Api } from "../types";
+type SWRConfigurationExtended<Data = any, Error = any, Fn extends BareFetcher<any> = BareFetcher<any>> = SWRConfiguration<Data, Error, Fn> & {
+    when?: boolean | (() => boolean);
+};
+export type CreatedUseApi<TEndpoints extends Api.Endpoints> = ReturnType<typeof createUseApi<TEndpoints>>;
+export declare let createUseApi: <TEndpoints extends Api.Endpoints>(api: Api.Client<TEndpoints>) => <TEndpoint extends Extract<keyof TEndpoints, string>>(endpoint: TEndpoint, options?: Api.EndpointOptions<TEndpoints, TEndpoint, "get">, config?: SWRConfigurationExtended<Api.EndpointResponseOk<TEndpoints, TEndpoint, "get">, Api.EndpointResponseFail<TEndpoints, TEndpoint, "get">>) => SWRResponse<Api.GetDataType<TEndpoints, TEndpoint, "get", "ok">, Api.GetDataType<TEndpoints, TEndpoint, "get", "fail">, any>;
 export declare let createSwrApi: <TEndpoints extends Api.Endpoints>(apiName: string, baseUrl: string, options?: Api.ClientOptions | undefined) => Api.Client<TEndpoints> & {
-    use: ReturnType<typeof createUseApi<TEndpoints>>;
+    use: CreatedUseApi<TEndpoints>;
 };
 export default createSwrApi;

package/swr-mutation/createSwrMutationApi.d.ts

@@ -1,5 +1,5 @@
 import { type SWRMutationConfiguration, type SWRMutationResponse } from "swr/mutation";
-import { createUseApi } from "../swr/createSwrApi";
+import { type CreatedUseApi } from "../swr/createSwrApi";
 import type { Api } from "../types";
 type MutationRequestMethod = Exclude<Api.RequestMethod, "get">;
 type MutationHookName = Exclude<keyof Api.HooksMapsByName, "use">;
@@ -10,6 +10,6 @@ export declare let createSwrMutationApi: <TEndpoints extends Api.Endpoints>(apiN
     usePatch: KoineApiMethodHookSWR<"usePatch", TEndpoints>;
     useDelete: KoineApiMethodHookSWR<"useDelete", TEndpoints>;
 } & {
-    use: ReturnType<typeof createUseApi<TEndpoints>>;
+    use: CreatedUseApi<TEndpoints>;
 };
 export default createSwrMutationApi;

package/swr-mutation.cjs.js

@@ -12,6 +12,15 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 
 var r__default = /*#__PURE__*/_interopDefaultLegacy(r);
 
-let a=(t,e)=>(a,o,i)=>r__default["default"](o?[a,o]:a,async(r,a)=>{let o=Array.isArray(r)?r[0]:r,i=Array.isArray(r)?r[1]:{},{ok:p,data:s}=await t[e](o,{...i,...a.arg||{},throwErr:!0});return s},i);let createSwrMutationApi=(...r)=>{let o=createApi.createApi(...r);return o.use=createSwrApi.createUseApi(o),["post","put","patch","delete"].forEach(r=>{o[`use${r.charAt(0).toUpperCase()+r.slice(1)}`]=a(o,r);}),o};
+let a=(t,e)=>(a,o,i)=>// config.fetcher = sender;
+        // eslint-disable-next-line react-hooks/rules-of-hooks
+        r__default["default"](// @ts-expect-error FIXME: I can't get it...
+        o?[a,o]:a,async(// if the first argument is an array the second one are the base options
+        // defined when calling the usePost/Put/etc. hook, these will be overriden
+        // by the _options just here below
+        r,// these are the options arriving when calling `trigger({ json, query, etc... })
+        a)=>{let o=Array.isArray(r)?r[0]:r,i=Array.isArray(r)?r[1]:{},{ok:p,data:s}=await t[e](o,{...i,...a.arg||{},throwErr:!0});return s},i);/**
+ * It creates an api client extended with auto-generated SWR wrapper hooks
+ */let createSwrMutationApi=(...r)=>{let o=createApi.createApi(...r);return o.use=createSwrApi.createUseApi(o),["post","put","patch","delete"].forEach(r=>{o[`use${r.charAt(0).toUpperCase()+r.slice(1)}`]=a(o,r);}),o};
 
 exports.createSwrMutationApi = createSwrMutationApi;

package/swr-mutation.esm.js

@@ -4,6 +4,15 @@ import { a as createUseApi } from './createSwrApi.esm.js';
 import '@koine/utils';
 import 'swr';
 
-let a=(t,e)=>(a,o,i)=>r(o?[a,o]:a,async(r,a)=>{let o=Array.isArray(r)?r[0]:r,i=Array.isArray(r)?r[1]:{},{ok:p,data:s}=await t[e](o,{...i,...a.arg||{},throwErr:!0});return s},i);let createSwrMutationApi=(...r)=>{let o=createApi(...r);return o.use=createUseApi(o),["post","put","patch","delete"].forEach(r=>{o[`use${r.charAt(0).toUpperCase()+r.slice(1)}`]=a(o,r);}),o};
+let a=(t,e)=>(a,o,i)=>// config.fetcher = sender;
+        // eslint-disable-next-line react-hooks/rules-of-hooks
+        r(// @ts-expect-error FIXME: I can't get it...
+        o?[a,o]:a,async(// if the first argument is an array the second one are the base options
+        // defined when calling the usePost/Put/etc. hook, these will be overriden
+        // by the _options just here below
+        r,// these are the options arriving when calling `trigger({ json, query, etc... })
+        a)=>{let o=Array.isArray(r)?r[0]:r,i=Array.isArray(r)?r[1]:{},{ok:p,data:s}=await t[e](o,{...i,...a.arg||{},throwErr:!0});return s},i);/**
+ * It creates an api client extended with auto-generated SWR wrapper hooks
+ */let createSwrMutationApi=(...r)=>{let o=createApi(...r);return o.use=createUseApi(o),["post","put","patch","delete"].forEach(r=>{o[`use${r.charAt(0).toUpperCase()+r.slice(1)}`]=a(o,r);}),o};
 
 export { createSwrMutationApi };