@koine/api 2.0.0-beta.21 → 2.0.0-beta.210
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/ApiError.cjs.default.js +1 -0
- package/ApiError.cjs.js +8 -0
- package/ApiError.cjs.mjs +2 -0
- package/ApiError.d.ts +10 -3
- package/ApiError.esm.js +3 -0
- package/README.md +1 -0
- package/createApi.cjs.default.js +1 -0
- package/createApi.cjs.js +10 -0
- package/createApi.cjs.mjs +2 -0
- package/createApi.d.ts +8 -1
- package/createApi.esm.js +5 -0
- package/createApiResultFail.cjs.default.js +1 -0
- package/createApiResultFail.cjs.js +8 -0
- package/createApiResultFail.cjs.mjs +2 -0
- package/createApiResultFail.d.ts +2 -1
- package/createApiResultFail.esm.js +3 -0
- package/createApiResultOk.cjs.default.js +1 -0
- package/createApiResultOk.cjs.js +8 -0
- package/createApiResultOk.cjs.mjs +2 -0
- package/createApiResultOk.d.ts +2 -1
- package/createApiResultOk.esm.js +3 -0
- package/index.cjs.default.js +1 -0
- package/index.cjs.js +13 -0
- package/index.cjs.mjs +2 -0
- package/index.d.ts +5 -6
- package/index.esm.js +4 -0
- package/next/nextApiResponse.cjs.js +12 -0
- package/next/nextApiResponse.d.ts +6 -0
- package/next/nextApiResponse.esm.js +7 -0
- package/next/nextApiResponse12.cjs.js +11 -0
- package/next/nextApiResponse12.d.ts +6 -0
- package/next/nextApiResponse12.esm.js +6 -0
- package/next.cjs.default.js +1 -0
- package/next.cjs.js +9 -0
- package/next.cjs.mjs +2 -0
- package/next.d.ts +2 -0
- package/next.esm.js +2 -0
- package/package.json +76 -36
- package/swr/createSwrApi.cjs.js +13 -0
- package/swr/createSwrApi.d.ts +41 -0
- package/swr/createSwrApi.esm.js +7 -0
- package/swr-mutation/createSwrMutationApi.cjs.js +12 -0
- package/swr-mutation/createSwrMutationApi.d.ts +19 -0
- package/swr-mutation/createSwrMutationApi.esm.js +7 -0
- package/swr-mutation.cjs.default.js +1 -0
- package/swr-mutation.cjs.js +7 -0
- package/swr-mutation.cjs.mjs +2 -0
- package/swr-mutation.d.ts +1 -0
- package/swr-mutation.esm.js +1 -0
- package/swr.cjs.default.js +1 -0
- package/swr.cjs.js +7 -0
- package/swr.cjs.mjs +2 -0
- package/swr.d.ts +1 -0
- package/swr.esm.js +1 -0
- package/types.cjs.default.js +1 -0
- package/types.cjs.js +2 -0
- package/types.cjs.mjs +2 -0
- package/types.d.ts +313 -0
- package/types.esm.js +1 -0
- package/typings.d.ts +12 -533
- package/vite.config.d.ts +2 -0
- package/ApiError.js +0 -13
- package/cjs/ApiError.d.ts +0 -5
- package/cjs/ApiError.js +0 -16
- package/cjs/createApi.d.ts +0 -2
- package/cjs/createApi.js +0 -124
- package/cjs/createApiResultFail.d.ts +0 -2
- package/cjs/createApiResultFail.js +0 -14
- package/cjs/createApiResultOk.d.ts +0 -2
- package/cjs/createApiResultOk.js +0 -15
- package/cjs/createSwrApi.d.ts +0 -15
- package/cjs/createSwrApi.js +0 -61
- package/cjs/index.d.ts +0 -6
- package/cjs/index.js +0 -15
- package/cjs/nextApiResponse.d.ts +0 -6
- package/cjs/nextApiResponse.js +0 -15
- package/cjs/nextApiResponse12.d.ts +0 -6
- package/cjs/nextApiResponse12.js +0 -19
- package/cjs/package.json +0 -17
- package/createApi.js +0 -120
- package/createApiResultFail.js +0 -10
- package/createApiResultOk.js +0 -11
- package/createSwrApi.d.ts +0 -15
- package/createSwrApi.js +0 -57
- package/index.js +0 -6
- package/nextApiResponse.d.ts +0 -6
- package/nextApiResponse.js +0 -12
- package/nextApiResponse12.d.ts +0 -6
- package/nextApiResponse12.js +0 -15
|
@@ -0,0 +1 @@
|
|
|
1
|
+
exports._default = require('./ApiError.cjs.js').default;
|
package/ApiError.cjs.js
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
|
+
|
|
5
|
+
class ApiError extends Error{constructor(r){super(`Request failed with ${r.status} ${r.msg}`),this.name="ApiError",Object.assign(this,r);}}
|
|
6
|
+
|
|
7
|
+
exports.ApiError = ApiError;
|
|
8
|
+
exports.default = ApiError;
|
package/ApiError.cjs.mjs
ADDED
package/ApiError.d.ts
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
import type { Api } from "./types";
|
|
2
|
+
/**
|
|
3
|
+
* Custom `ApiError` class extending `Error` to throw in failed response.
|
|
4
|
+
*
|
|
5
|
+
* @see https://eslint.org/docs/rules/no-throw-literal
|
|
6
|
+
* @see https://github.com/sindresorhus/ky/blob/main/source/errors/HTTPError.ts
|
|
7
|
+
*
|
|
8
|
+
*/
|
|
9
|
+
export declare class ApiError<TResponseFail extends Api.ResponseFail = unknown> extends Error {
|
|
10
|
+
constructor(result: Api.ResultFail<TResponseFail>);
|
|
4
11
|
}
|
|
5
12
|
export default ApiError;
|
package/ApiError.esm.js
ADDED
package/README.md
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
# @koine/api
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
exports._default = require('./createApi.cjs.js').default;
|
package/createApi.cjs.js
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
|
+
|
|
5
|
+
var utils = require('@koine/utils');
|
|
6
|
+
|
|
7
|
+
let r=["get","post","put","patch","delete"];let createApi=(l,a,i)=>{let{fetchFn:s=fetch,headers:n={},request:p={},throwErr:c,timeout:u=1e4,processReq:f,processRes:h,processErr:d,log:$=0}=i||{};return r.reduce((r,i)=>(r[i]=async(r,m)=>{let w,y,{fetchFn:g=s,request:b=p,headers:E={},timeout:N=u,processReq:k,processRes:A=h,processErr:C=d,throwErr:j=c,log:q=$}=m||{},{params:v,json:x,query:O}=m||{},R=`${a}/${r+"".replace(/^\/*/,"")}`,T={method:i.toUpperCase(),...b,headers:{"content-type":"application/json",...E,...n}};if(f){let e=f(i,R,O,x,v,T);R=e[0],O=e[1],x=e[2],v=e[3],T=e[4];}if(k){let e=k(i,R,O,x,v,T);R=e[0],O=e[1],x=e[2],v=e[3],T=e[4];}if(utils.isFullObject(v))for(let e in v)R=R.replace(`{${e}}`,v[e]);let U=Number(N);x&&(T.body=JSON.stringify(x)),U>0&&(w=new AbortController,y=setTimeout(()=>w.abort(),U),T.signal=w.signal),O&&(R+=utils.buildUrlQueryString(O));let D=null,F=null,J="";try{D=await g(R,T);}catch(e){J=utils.errorToString(e);}if(y&&clearTimeout(y),D)try{F=A?await A(D,m||{}):await D.json();}catch(e){J=utils.errorToString(e);}if(null===F&&(F=C?await C(J,m||{}):{data:null,msg:J,status:100,fail:true,ok:false}),j&&F?.fail)throw F;if("development"===process.env.NODE_ENV&&q>=1){let e=`${F?.status}: api[${l}] ${i.toUpperCase()} ${R}`;F?.ok?console.info(`🟢 ${e}`):console.info(`🔴 ${e}`);}return F},r),{})};
|
|
8
|
+
|
|
9
|
+
exports.createApi = createApi;
|
|
10
|
+
exports.default = createApi;
|
package/createApi.d.ts
CHANGED
|
@@ -1,2 +1,9 @@
|
|
|
1
|
-
|
|
1
|
+
import type { Api } from "./types";
|
|
2
|
+
/**
|
|
3
|
+
* Create api client
|
|
4
|
+
*
|
|
5
|
+
* @param apiName Short name to use in debug logs
|
|
6
|
+
* @param baseUrl Either relative or absolute, it must end without trailing slash
|
|
7
|
+
*/
|
|
8
|
+
export declare let createApi: <TEndpoints extends Api.Endpoints>(apiName: string, baseUrl: string, defaultOptions?: Api.ClientOptions) => Api.Client<TEndpoints>;
|
|
2
9
|
export default createApi;
|
package/createApi.esm.js
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { isFullObject, buildUrlQueryString, errorToString } from '@koine/utils';
|
|
2
|
+
|
|
3
|
+
let r=["get","post","put","patch","delete"];let createApi=(l,a,i)=>{let{fetchFn:s=fetch,headers:n={},request:p={},throwErr:c,timeout:u=1e4,processReq:f,processRes:h,processErr:d,log:$=0}=i||{};return r.reduce((r,i)=>(r[i]=async(r,m)=>{let w,y,{fetchFn:g=s,request:b=p,headers:E={},timeout:N=u,processReq:k,processRes:A=h,processErr:C=d,throwErr:j=c,log:q=$}=m||{},{params:v,json:x,query:O}=m||{},R=`${a}/${r+"".replace(/^\/*/,"")}`,T={method:i.toUpperCase(),...b,headers:{"content-type":"application/json",...E,...n}};if(f){let e=f(i,R,O,x,v,T);R=e[0],O=e[1],x=e[2],v=e[3],T=e[4];}if(k){let e=k(i,R,O,x,v,T);R=e[0],O=e[1],x=e[2],v=e[3],T=e[4];}if(isFullObject(v))for(let e in v)R=R.replace(`{${e}}`,v[e]);let U=Number(N);x&&(T.body=JSON.stringify(x)),U>0&&(w=new AbortController,y=setTimeout(()=>w.abort(),U),T.signal=w.signal),O&&(R+=buildUrlQueryString(O));let D=null,F=null,J="";try{D=await g(R,T);}catch(e){J=errorToString(e);}if(y&&clearTimeout(y),D)try{F=A?await A(D,m||{}):await D.json();}catch(e){J=errorToString(e);}if(null===F&&(F=C?await C(J,m||{}):{data:null,msg:J,status:100,fail:true,ok:false}),j&&F?.fail)throw F;if("development"===process.env.NODE_ENV&&q>=1){let e=`${F?.status}: api[${l}] ${i.toUpperCase()} ${R}`;F?.ok?console.info(`🟢 ${e}`):console.info(`🔴 ${e}`);}return F},r),{})};
|
|
4
|
+
|
|
5
|
+
export { createApi, createApi as default };
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
exports._default = require('./createApiResultFail.cjs.js').default;
|
package/createApiResultFail.d.ts
CHANGED
|
@@ -1,2 +1,3 @@
|
|
|
1
|
-
|
|
1
|
+
import type { Api } from "./types";
|
|
2
|
+
export declare let createApiResultFail: <T>(data?: T, msg?: string, status?: number) => Api.ResultFail<T>;
|
|
2
3
|
export default createApiResultFail;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
exports._default = require('./createApiResultOk.cjs.js').default;
|
package/createApiResultOk.d.ts
CHANGED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
exports._default = require('./index.cjs.js').default;
|
package/index.cjs.js
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var ApiError = require('./ApiError.cjs.js');
|
|
4
|
+
var createApi = require('./createApi.cjs.js');
|
|
5
|
+
var createApiResultFail = require('./createApiResultFail.cjs.js');
|
|
6
|
+
var createApiResultOk = require('./createApiResultOk.cjs.js');
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
exports.ApiError = ApiError.ApiError;
|
|
11
|
+
exports.createApi = createApi.createApi;
|
|
12
|
+
exports.createApiResultFail = createApiResultFail.createApiResultFail;
|
|
13
|
+
exports.createApiResultOk = createApiResultOk.createApiResultOk;
|
package/index.cjs.mjs
ADDED
package/index.d.ts
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
export { ApiError } from "./ApiError
|
|
2
|
-
export { createApi } from "./createApi
|
|
3
|
-
export { createApiResultFail } from "./createApiResultFail
|
|
4
|
-
export { createApiResultOk } from "./createApiResultOk
|
|
5
|
-
export {
|
|
6
|
-
export { nextApiResponse12 } from "./nextApiResponse12.js";
|
|
1
|
+
export { ApiError } from "./ApiError";
|
|
2
|
+
export { createApi } from "./createApi";
|
|
3
|
+
export { createApiResultFail } from "./createApiResultFail";
|
|
4
|
+
export { createApiResultOk } from "./createApiResultOk";
|
|
5
|
+
export type { Api } from "./types";
|
package/index.esm.js
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
|
+
|
|
5
|
+
var server = require('next/server');
|
|
6
|
+
var createApiResultFail = require('../createApiResultFail.cjs.js');
|
|
7
|
+
var createApiResultOk = require('../createApiResultOk.cjs.js');
|
|
8
|
+
|
|
9
|
+
let nextApiResponse={ok:(t,r)=>server.NextResponse.json(createApiResultOk.createApiResultOk(t,r)),fail:(o,r,p)=>server.NextResponse.json(createApiResultFail.createApiResultFail(o,r,p))};
|
|
10
|
+
|
|
11
|
+
exports.default = nextApiResponse;
|
|
12
|
+
exports.nextApiResponse = nextApiResponse;
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { NextResponse } from "next/server";
|
|
2
|
+
export declare let nextApiResponse: {
|
|
3
|
+
ok<T>(data: T, msg?: string): NextResponse<import("..").Api.ResultOk<T>>;
|
|
4
|
+
fail<T>(data: T, msg?: string, status?: number): NextResponse<import("..").Api.ResultFail<T>>;
|
|
5
|
+
};
|
|
6
|
+
export default nextApiResponse;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { NextResponse } from 'next/server';
|
|
2
|
+
import { createApiResultFail } from '../createApiResultFail.esm.js';
|
|
3
|
+
import { createApiResultOk } from '../createApiResultOk.esm.js';
|
|
4
|
+
|
|
5
|
+
let nextApiResponse={ok:(t,r)=>NextResponse.json(createApiResultOk(t,r)),fail:(o,r,p)=>NextResponse.json(createApiResultFail(o,r,p))};
|
|
6
|
+
|
|
7
|
+
export { nextApiResponse as default, nextApiResponse };
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
|
+
|
|
5
|
+
var createApiResultFail = require('../createApiResultFail.cjs.js');
|
|
6
|
+
var createApiResultOk = require('../createApiResultOk.cjs.js');
|
|
7
|
+
|
|
8
|
+
let nextApiResponse12=s=>({ok(e,o){s.status(200).json(createApiResultOk.createApiResultOk(e,o));},fail(t,o,p){s.status(p||404).json(createApiResultFail.createApiResultFail(t,o,p));}});
|
|
9
|
+
|
|
10
|
+
exports.default = nextApiResponse12;
|
|
11
|
+
exports.nextApiResponse12 = nextApiResponse12;
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { createApiResultFail } from '../createApiResultFail.esm.js';
|
|
2
|
+
import { createApiResultOk } from '../createApiResultOk.esm.js';
|
|
3
|
+
|
|
4
|
+
let nextApiResponse12=s=>({ok(e,o){s.status(200).json(createApiResultOk(e,o));},fail(t,o,p){s.status(p||404).json(createApiResultFail(t,o,p));}});
|
|
5
|
+
|
|
6
|
+
export { nextApiResponse12 as default, nextApiResponse12 };
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
exports._default = require('./next.cjs.js').default;
|
package/next.cjs.js
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var nextApiResponse = require('./next/nextApiResponse.cjs.js');
|
|
4
|
+
var nextApiResponse12 = require('./next/nextApiResponse12.cjs.js');
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
exports.nextApiResponse = nextApiResponse.nextApiResponse;
|
|
9
|
+
exports.nextApiResponse12 = nextApiResponse12.nextApiResponse12;
|
package/next.cjs.mjs
ADDED
package/next.d.ts
ADDED
package/next.esm.js
ADDED
package/package.json
CHANGED
|
@@ -1,55 +1,95 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@koine/api",
|
|
3
3
|
"sideEffects": false,
|
|
4
|
-
"dependencies": {
|
|
5
|
-
"@koine/utils": "2.0.0-beta.21"
|
|
6
|
-
},
|
|
7
|
-
"peerDependenciesMeta": {
|
|
8
|
-
"next": {
|
|
9
|
-
"optional": true
|
|
10
|
-
},
|
|
11
|
-
"swr": {
|
|
12
|
-
"optional": true
|
|
13
|
-
}
|
|
14
|
-
},
|
|
15
|
-
"main": "./cjs/index.js",
|
|
16
|
-
"types": "./index.d.ts",
|
|
17
|
-
"type": "module",
|
|
18
|
-
"module": "./index.js",
|
|
19
4
|
"exports": {
|
|
5
|
+
"./typings": {
|
|
6
|
+
"types": "./typings.d.ts"
|
|
7
|
+
},
|
|
8
|
+
"./swr/createSwrApi": {
|
|
9
|
+
"module": "./swr/createSwrApi.esm.js",
|
|
10
|
+
"types": "./swr/createSwrApi.d.ts",
|
|
11
|
+
"import": "./swr/createSwrApi.esm.js",
|
|
12
|
+
"default": "./swr/createSwrApi.cjs.js"
|
|
13
|
+
},
|
|
14
|
+
"./swr-mutation/createSwrApi": {
|
|
15
|
+
"module": "./swr-mutation/createSwrMutationApi.esm.js",
|
|
16
|
+
"types": "./swr-mutation/createSwrMutationApi.d.ts",
|
|
17
|
+
"import": "./swr-mutation/createSwrMutationApi.esm.js",
|
|
18
|
+
"default": "./swr-mutation/createSwrMutationApi.cjs.js"
|
|
19
|
+
},
|
|
20
|
+
"./package.json": "./package.json",
|
|
20
21
|
".": {
|
|
21
|
-
"
|
|
22
|
-
"
|
|
22
|
+
"module": "./index.esm.js",
|
|
23
|
+
"types": "./index.d.ts",
|
|
24
|
+
"import": "./index.cjs.mjs",
|
|
25
|
+
"default": "./index.cjs.js"
|
|
23
26
|
},
|
|
24
27
|
"./ApiError": {
|
|
25
|
-
"
|
|
26
|
-
"
|
|
28
|
+
"module": "./ApiError.esm.js",
|
|
29
|
+
"types": "./ApiError.d.ts",
|
|
30
|
+
"import": "./ApiError.cjs.mjs",
|
|
31
|
+
"default": "./ApiError.cjs.js"
|
|
27
32
|
},
|
|
28
33
|
"./createApi": {
|
|
29
|
-
"
|
|
30
|
-
"
|
|
34
|
+
"module": "./createApi.esm.js",
|
|
35
|
+
"types": "./createApi.d.ts",
|
|
36
|
+
"import": "./createApi.cjs.mjs",
|
|
37
|
+
"default": "./createApi.cjs.js"
|
|
31
38
|
},
|
|
32
39
|
"./createApiResultFail": {
|
|
33
|
-
"
|
|
34
|
-
"
|
|
40
|
+
"module": "./createApiResultFail.esm.js",
|
|
41
|
+
"types": "./createApiResultFail.d.ts",
|
|
42
|
+
"import": "./createApiResultFail.cjs.mjs",
|
|
43
|
+
"default": "./createApiResultFail.cjs.js"
|
|
35
44
|
},
|
|
36
45
|
"./createApiResultOk": {
|
|
37
|
-
"
|
|
38
|
-
"
|
|
46
|
+
"module": "./createApiResultOk.esm.js",
|
|
47
|
+
"types": "./createApiResultOk.d.ts",
|
|
48
|
+
"import": "./createApiResultOk.cjs.mjs",
|
|
49
|
+
"default": "./createApiResultOk.cjs.js"
|
|
39
50
|
},
|
|
40
|
-
"./
|
|
41
|
-
"
|
|
42
|
-
"
|
|
51
|
+
"./next": {
|
|
52
|
+
"module": "./next.esm.js",
|
|
53
|
+
"types": "./next.d.ts",
|
|
54
|
+
"import": "./next.cjs.mjs",
|
|
55
|
+
"default": "./next.cjs.js"
|
|
43
56
|
},
|
|
44
|
-
"./
|
|
45
|
-
"
|
|
46
|
-
"
|
|
57
|
+
"./swr-mutation": {
|
|
58
|
+
"module": "./swr-mutation.esm.js",
|
|
59
|
+
"types": "./swr-mutation.d.ts",
|
|
60
|
+
"import": "./swr-mutation.cjs.mjs",
|
|
61
|
+
"default": "./swr-mutation.cjs.js"
|
|
47
62
|
},
|
|
48
|
-
"./
|
|
49
|
-
"
|
|
50
|
-
"
|
|
63
|
+
"./swr": {
|
|
64
|
+
"module": "./swr.esm.js",
|
|
65
|
+
"types": "./swr.d.ts",
|
|
66
|
+
"import": "./swr.cjs.mjs",
|
|
67
|
+
"default": "./swr.cjs.js"
|
|
68
|
+
},
|
|
69
|
+
"./types": {
|
|
70
|
+
"module": "./types.esm.js",
|
|
71
|
+
"types": "./types.d.ts",
|
|
72
|
+
"import": "./types.cjs.mjs",
|
|
73
|
+
"default": "./types.cjs.js"
|
|
51
74
|
}
|
|
52
75
|
},
|
|
53
|
-
"
|
|
54
|
-
|
|
76
|
+
"dependencies": {
|
|
77
|
+
"@koine/utils": "2.0.0-beta.210"
|
|
78
|
+
},
|
|
79
|
+
"peerDependencies": {
|
|
80
|
+
"next": "^13 || ^14 || ^15 || ^16",
|
|
81
|
+
"swr": "^2.2.4"
|
|
82
|
+
},
|
|
83
|
+
"peerDependenciesMeta": {
|
|
84
|
+
"next": {
|
|
85
|
+
"optional": true
|
|
86
|
+
},
|
|
87
|
+
"swr": {
|
|
88
|
+
"optional": true
|
|
89
|
+
}
|
|
90
|
+
},
|
|
91
|
+
"module": "./index.esm.js",
|
|
92
|
+
"main": "./index.cjs.js",
|
|
93
|
+
"types": "./index.d.ts",
|
|
94
|
+
"version": "2.0.0-beta.210"
|
|
55
95
|
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
|
+
|
|
5
|
+
var e = require('swr');
|
|
6
|
+
var utils = require('@koine/utils');
|
|
7
|
+
var createApi = require('../createApi.cjs.js');
|
|
8
|
+
|
|
9
|
+
let createUseApi=(t,i)=>(o,p,a)=>{let l={...i||{},...a||{}},n=async()=>{let{data:e}=await t.get(o,{...p||{},throwErr:true});return e};return e(l?.when===false||utils.isFunction(l?.when)&&l?.when()===false?null:p?[o,p]:[o],n,l)};let createSwrApi=(e,r,i,o)=>{let p=createApi.createApi(e,r,i);return p.use=createUseApi(p,o),p};
|
|
10
|
+
|
|
11
|
+
exports.createSwrApi = createSwrApi;
|
|
12
|
+
exports.createUseApi = createUseApi;
|
|
13
|
+
exports.default = createSwrApi;
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { type BareFetcher, type SWRConfiguration, type SWRResponse } from "swr";
|
|
2
|
+
import type { Api } from "../types";
|
|
3
|
+
export declare namespace ApiSWR {
|
|
4
|
+
type ConfigurationExtended<Data = any, Error = any, Fn extends BareFetcher<any> = BareFetcher<any>> = SWRConfiguration<Data, Error, Fn> & {
|
|
5
|
+
/**
|
|
6
|
+
* Conditional fetching as option
|
|
7
|
+
*
|
|
8
|
+
* Moving this to an option allows us to keep the endpoints typed dictionary,
|
|
9
|
+
* e.g. we can write:
|
|
10
|
+
*
|
|
11
|
+
* ```js
|
|
12
|
+
* const { data, mutate } = myApi.use("User/{id}",
|
|
13
|
+
* { params: { id: aVariableMaybeContainingAnId || "" }, },
|
|
14
|
+
* { when: !!aVariableMaybeContainingAnId }
|
|
15
|
+
* );
|
|
16
|
+
*
|
|
17
|
+
* // we still have typed `data`, `mutate`
|
|
18
|
+
* ```
|
|
19
|
+
* @see https://swr.vercel.app/docs/conditional-fetching
|
|
20
|
+
*/
|
|
21
|
+
when?: boolean | (() => boolean);
|
|
22
|
+
};
|
|
23
|
+
/**
|
|
24
|
+
* The `api` interface generated by `createApi`
|
|
25
|
+
*/
|
|
26
|
+
type Client<TEndpoints extends Api.Endpoints> = Api.Client<TEndpoints> & {
|
|
27
|
+
use: ReturnType<typeof createUseApi<TEndpoints>>;
|
|
28
|
+
};
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* @private
|
|
32
|
+
*/
|
|
33
|
+
export declare let createUseApi: <TEndpoints extends Api.Endpoints>(api: Api.Client<TEndpoints>, defaultSwrConfig?: ApiSWR.ConfigurationExtended) => <TEndpoint extends Api.EndpointUrl<TEndpoints>>(endpoint: TEndpoint, options?: Api.EndpointOptions<TEndpoints, TEndpoint, "get">, swrConfig?: ApiSWR.ConfigurationExtended<Api.EndpointResponseOk<TEndpoints, TEndpoint, "get">, Api.EndpointResponseFail<TEndpoints, TEndpoint, "get">>) => SWRResponse<Api.EndpointResponseOk<TEndpoints, TEndpoint, "get">, Api.EndpointResponseFail<TEndpoints, TEndpoint, "get">>;
|
|
34
|
+
/**
|
|
35
|
+
* It creates an api client extended with auto-generated SWR wrapper hooks
|
|
36
|
+
*
|
|
37
|
+
* @param apiName Short name to use in debug logs
|
|
38
|
+
* @param baseUrl Either relative or absolute, it must end without trailing slash
|
|
39
|
+
*/
|
|
40
|
+
export declare let createSwrApi: <TEndpoints extends Api.Endpoints>(apiName: string, baseUrl: string, defaultOptions?: Api.ClientOptions, defaultSwrConfig?: ApiSWR.ConfigurationExtended) => ApiSWR.Client<TEndpoints>;
|
|
41
|
+
export default createSwrApi;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import e from 'swr';
|
|
2
|
+
import { isFunction } from '@koine/utils';
|
|
3
|
+
import { createApi } from '../createApi.esm.js';
|
|
4
|
+
|
|
5
|
+
let createUseApi=(t,i)=>(o,p,a)=>{let l={...i||{},...a||{}},n=async()=>{let{data:e}=await t.get(o,{...p||{},throwErr:true});return e};return e(l?.when===false||isFunction(l?.when)&&l?.when()===false?null:p?[o,p]:[o],n,l)};let createSwrApi=(e,r,i,o)=>{let p=createApi(e,r,i);return p.use=createUseApi(p,o),p};
|
|
6
|
+
|
|
7
|
+
export { createSwrApi, createUseApi, createSwrApi as default };
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
|
+
|
|
5
|
+
var r = require('swr/mutation');
|
|
6
|
+
var createApi = require('../createApi.cjs.js');
|
|
7
|
+
var createSwrApi = require('../swr/createSwrApi.cjs.js');
|
|
8
|
+
|
|
9
|
+
let createSwrMutationApi=(...a)=>{let o=createApi.createApi(...a);return o.use=createSwrApi.createUseApi(o),["post","put","patch","delete"].forEach(t=>{o[`use${t.charAt(0).toUpperCase()+t.slice(1)}`]=(e,a,i)=>r(a?[e,a]:e,async(r,e)=>{let a=Array.isArray(r)?r[0]:r,i=Array.isArray(r)?r[1]:{},{ok:p,data:s}=await o[t](a,{...i,...e.arg||{},throwErr:true});return s},i);}),o};
|
|
10
|
+
|
|
11
|
+
exports.createSwrMutationApi = createSwrMutationApi;
|
|
12
|
+
exports.default = createSwrMutationApi;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { type SWRMutationConfiguration, type SWRMutationResponse } from "swr/mutation";
|
|
2
|
+
import { createApi } from "../createApi";
|
|
3
|
+
import { createUseApi } from "../swr/createSwrApi";
|
|
4
|
+
import type { Api } from "../types";
|
|
5
|
+
type MutationRequestMethod = Exclude<Api.RequestMethod, "get">;
|
|
6
|
+
type MutationHookName = Exclude<keyof Api.HooksMapsByName, "use">;
|
|
7
|
+
type KoineApiMethodHookSWR<THookName extends MutationHookName, TEndpoints extends Api.Endpoints> = <TEndpoint extends Api.EndpointUrl<TEndpoints>, TMethod extends MutationRequestMethod = Api.HooksMapsByName[THookName]>(endpoint: TEndpoint, options?: Api.EndpointOptions<TEndpoints, TEndpoint, TMethod>, config?: SWRMutationConfiguration<Api.EndpointResponseOk<TEndpoints, TEndpoint, TMethod>, Api.EndpointResponseFail<TEndpoints, TEndpoint, TMethod>, TEndpoint, Api.EndpointOptions<TEndpoints, TEndpoint, TMethod>>) => SWRMutationResponse<Api.EndpointResponseOk<TEndpoints, TEndpoint, TMethod>, Api.EndpointResponseFail<TEndpoints, TEndpoint, TMethod>, TEndpoint, Api.EndpointOptions<TEndpoints, TEndpoint, TMethod>>;
|
|
8
|
+
/**
|
|
9
|
+
* It creates an api client extended with auto-generated SWR wrapper hooks
|
|
10
|
+
*/
|
|
11
|
+
export declare let createSwrMutationApi: <TEndpoints extends Api.Endpoints>(...args: Parameters<typeof createApi>) => Api.Client<TEndpoints> & {
|
|
12
|
+
usePost: KoineApiMethodHookSWR<"usePost", TEndpoints>;
|
|
13
|
+
usePut: KoineApiMethodHookSWR<"usePut", TEndpoints>;
|
|
14
|
+
usePatch: KoineApiMethodHookSWR<"usePatch", TEndpoints>;
|
|
15
|
+
useDelete: KoineApiMethodHookSWR<"useDelete", TEndpoints>;
|
|
16
|
+
} & {
|
|
17
|
+
use: ReturnType<typeof createUseApi<TEndpoints>>;
|
|
18
|
+
};
|
|
19
|
+
export default createSwrMutationApi;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import r from 'swr/mutation';
|
|
2
|
+
import { createApi } from '../createApi.esm.js';
|
|
3
|
+
import { createUseApi } from '../swr/createSwrApi.esm.js';
|
|
4
|
+
|
|
5
|
+
let createSwrMutationApi=(...a)=>{let o=createApi(...a);return o.use=createUseApi(o),["post","put","patch","delete"].forEach(t=>{o[`use${t.charAt(0).toUpperCase()+t.slice(1)}`]=(e,a,i)=>r(a?[e,a]:e,async(r,e)=>{let a=Array.isArray(r)?r[0]:r,i=Array.isArray(r)?r[1]:{},{ok:p,data:s}=await o[t](a,{...i,...e.arg||{},throwErr:true});return s},i);}),o};
|
|
6
|
+
|
|
7
|
+
export { createSwrMutationApi, createSwrMutationApi as default };
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
exports._default = require('./swr-mutation.cjs.js').default;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { createSwrMutationApi } from "./swr-mutation/createSwrMutationApi";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { createSwrMutationApi } from './swr-mutation/createSwrMutationApi.esm.js';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
exports._default = require('./swr.cjs.js').default;
|
package/swr.cjs.js
ADDED
package/swr.cjs.mjs
ADDED
package/swr.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { createSwrApi, type ApiSWR } from "./swr/createSwrApi";
|
package/swr.esm.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { createSwrApi } from './swr/createSwrApi.esm.js';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
exports._default = require('./types.cjs.js').default;
|
package/types.cjs.js
ADDED
package/types.cjs.mjs
ADDED