@openapi-qraft/react 1.9.0 → 1.10.0
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/CHANGELOG.md +8 -0
- package/dist/Unstable_QraftSecureRequestFn.d.ts +81 -0
- package/dist/Unstable_QraftSecureRequestFn.d.ts.map +1 -0
- package/dist/Unstable_QraftSecureRequestFn.js +187 -0
- package/dist/Unstable_QraftSecureRequestFn.js.map +1 -0
- package/dist/lib/jwt-decode/index.d.ts +29 -0
- package/dist/lib/jwt-decode/index.d.ts.map +1 -0
- package/dist/lib/jwt-decode/index.js +61 -0
- package/dist/lib/jwt-decode/index.js.map +1 -0
- package/dist/lib/jwt-decode/index.test.d.ts +2 -0
- package/dist/lib/jwt-decode/index.test.d.ts.map +1 -0
- package/dist/lib/jwt-decode/index.test.js +99 -0
- package/dist/lib/jwt-decode/index.test.js.map +1 -0
- package/dist/lib/requestFn.d.ts +3 -1
- package/dist/lib/requestFn.d.ts.map +1 -1
- package/dist/lib/requestFn.js +1 -1
- package/dist/lib/requestFn.js.map +1 -1
- package/package.json +3 -3
- package/src/Unstable_QraftSecureRequestFn.ts +365 -0
- package/src/lib/jwt-decode/index.test.ts +131 -0
- package/src/lib/jwt-decode/index.ts +105 -0
- package/src/lib/requestFn.ts +4 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# @openapi-qraft/react
|
|
2
2
|
|
|
3
|
+
## 1.10.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 67c1432: Added the `<QraftSecureRequestFn />` component to enhance secure request handling. This component supports
|
|
8
|
+
multiple authentication methods including API Key, Basic, Bearer, and Cookie authentication. Integrates seamlessly with
|
|
9
|
+
QraftContext for secure API requests.
|
|
10
|
+
|
|
3
11
|
## 1.9.0
|
|
4
12
|
|
|
5
13
|
## 1.8.0
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
import { ReactNode } from 'react';
|
|
2
|
+
import { QueryClient } from '@tanstack/react-query';
|
|
3
|
+
import type { OperationSchema, RequestFnInfo, RequestFnOptions } from './lib/requestFn.js';
|
|
4
|
+
interface QraftSecureRequestFnBaseProps {
|
|
5
|
+
requestFn<T>(schema: OperationSchema, requestInfo: RequestFnInfo, options?: RequestFnOptions): Promise<T>;
|
|
6
|
+
securitySchemes: SecuritySchemeHandlers<string>;
|
|
7
|
+
}
|
|
8
|
+
type RequestFn = QraftSecureRequestFnBaseProps['requestFn'];
|
|
9
|
+
export interface QraftSecureRequestFnProps extends QraftSecureRequestFnBaseProps {
|
|
10
|
+
children(secureRequestFn: QraftSecureRequestFnBaseProps['requestFn']): ReactNode;
|
|
11
|
+
queryClient?: QueryClient;
|
|
12
|
+
}
|
|
13
|
+
export declare function QraftSecureRequestFn({ children, requestFn, securitySchemes, queryClient: inQueryClient, }: QraftSecureRequestFnProps): import("react").FunctionComponentElement<{
|
|
14
|
+
children?: ReactNode;
|
|
15
|
+
}>;
|
|
16
|
+
export declare const useSecuritySchemeAuth: ({ securitySchemes, requestFn, queryClient, }: QraftSecureRequestFnBaseProps & {
|
|
17
|
+
queryClient: QueryClient;
|
|
18
|
+
}) => RequestFn;
|
|
19
|
+
/**
|
|
20
|
+
* Create a secure `requestFn` that manages security schemes.
|
|
21
|
+
* It will automatically fetch and refresh tokens when needed
|
|
22
|
+
* using QueryClient and the provided security schemes.
|
|
23
|
+
*
|
|
24
|
+
* @param securitySchemes OpenAPI security schemes.
|
|
25
|
+
* @param requestFn Qraft `requestFn`
|
|
26
|
+
* @param queryClient QueryClient instance.
|
|
27
|
+
*/
|
|
28
|
+
export declare function createSecureRequestFn(securitySchemes: SecuritySchemeHandlers<string>, requestFn: RequestFn, queryClient: QueryClient): RequestFn;
|
|
29
|
+
/**
|
|
30
|
+
* @internal
|
|
31
|
+
*/
|
|
32
|
+
export declare function shallowEqualObjects(newObj: Record<string, any> | string, prevObj: Record<string, any> | string | undefined): boolean;
|
|
33
|
+
type SecurityScheme = SecuritySchemeBearer | SecuritySchemeBasic | SecuritySchemeAPIKey | SecuritySchemeCookie;
|
|
34
|
+
export type SecuritySchemeBearer = string /** JWT Bearer token. **/ | {
|
|
35
|
+
/** Refresh interval in milliseconds. */
|
|
36
|
+
refreshInterval: number;
|
|
37
|
+
/** Token to be used for authentication. */
|
|
38
|
+
token: string;
|
|
39
|
+
};
|
|
40
|
+
export interface SecuritySchemeBasic {
|
|
41
|
+
/** Credentials to be used for authentication. */
|
|
42
|
+
credentials: string;
|
|
43
|
+
/** Refresh interval in milliseconds. */
|
|
44
|
+
refreshInterval: number;
|
|
45
|
+
}
|
|
46
|
+
export type SecuritySchemeAPIKey = {
|
|
47
|
+
/** Where the secret should be placed. */
|
|
48
|
+
in: 'header' | 'query';
|
|
49
|
+
/** Name of the secret key. */
|
|
50
|
+
name: string;
|
|
51
|
+
/** Secret to be used for authentication. */
|
|
52
|
+
value: string;
|
|
53
|
+
/** Refresh interval in milliseconds. */
|
|
54
|
+
refreshInterval?: number;
|
|
55
|
+
};
|
|
56
|
+
export type SecuritySchemeCookie = {
|
|
57
|
+
/** Where the secret should be placed. */
|
|
58
|
+
in: 'cookie';
|
|
59
|
+
/** Refresh interval in milliseconds. */
|
|
60
|
+
refreshInterval?: number;
|
|
61
|
+
};
|
|
62
|
+
/**
|
|
63
|
+
* Type definition for a handler function that manages security schemes.
|
|
64
|
+
* This function is invoked when a token needs to be fetched or refreshed.
|
|
65
|
+
*
|
|
66
|
+
* @param props - The properties for the handler function.
|
|
67
|
+
* @param props.isRefreshing - A boolean indicating the state of the token.
|
|
68
|
+
* It's `false` on the initial "fetch token" request, and `true` if the token is stale or updating using `refreshInterval`.
|
|
69
|
+
* @param props.signal - An AbortSignal that can be used to abort the request.
|
|
70
|
+
*
|
|
71
|
+
* @returns A SecurityScheme, which contains the necessary data for authentication.
|
|
72
|
+
*/
|
|
73
|
+
type SecuritySchemeHandler = (props: {
|
|
74
|
+
isRefreshing: boolean;
|
|
75
|
+
signal: AbortSignal;
|
|
76
|
+
}) => SecurityScheme | Promise<SecurityScheme>;
|
|
77
|
+
export type SecuritySchemeHandlers<SecuritySchemeName extends string> = {
|
|
78
|
+
[key in SecuritySchemeName]: SecuritySchemeHandler;
|
|
79
|
+
};
|
|
80
|
+
export {};
|
|
81
|
+
//# sourceMappingURL=Unstable_QraftSecureRequestFn.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Unstable_QraftSecureRequestFn.d.ts","sourceRoot":"","sources":["../src/Unstable_QraftSecureRequestFn.ts"],"names":[],"mappings":"AAEA,OAAO,EAA2B,SAAS,EAAsB,MAAM,OAAO,CAAC;AAE/E,OAAO,EACL,WAAW,EAIZ,MAAM,uBAAuB,CAAC;AAG/B,OAAO,KAAK,EACV,eAAe,EACf,aAAa,EACb,gBAAgB,EACjB,MAAM,oBAAoB,CAAC;AAE5B,UAAU,6BAA6B;IACrC,SAAS,CAAC,CAAC,EACT,MAAM,EAAE,eAAe,EACvB,WAAW,EAAE,aAAa,EAC1B,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,CAAC,CAAC,CAAC;IACd,eAAe,EAAE,sBAAsB,CAAC,MAAM,CAAC,CAAC;CACjD;AAED,KAAK,SAAS,GAAG,6BAA6B,CAAC,WAAW,CAAC,CAAC;AAE5D,MAAM,WAAW,yBACf,SAAQ,6BAA6B;IACrC,QAAQ,CACN,eAAe,EAAE,6BAA6B,CAAC,WAAW,CAAC,GAC1D,SAAS,CAAC;IACb,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED,wBAAgB,oBAAoB,CAAC,EACnC,QAAQ,EACR,SAAS,EACT,eAAe,EACf,WAAW,EAAE,aAAa,GAC3B,EAAE,yBAAyB;;GAkC3B;AAED,eAAO,MAAM,qBAAqB;iBAKnB,WAAW;MACtB,SAwBH,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CACnC,eAAe,EAAE,sBAAsB,CAAC,MAAM,CAAC,EAC/C,SAAS,EAAE,SAAS,EACpB,WAAW,EAAE,WAAW,GACvB,SAAS,CA+BX;AA6HD;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,EACpC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,GAAG,SAAS,WAmBlD;AAED,KAAK,cAAc,GACf,oBAAoB,GACpB,mBAAmB,GACnB,oBAAoB,GACpB,oBAAoB,CAAC;AAEzB,MAAM,MAAM,oBAAoB,GAC5B,MAAM,CAAC,yBAAyB,GAChC;IACE,wCAAwC;IACxC,eAAe,EAAE,MAAM,CAAC;IACxB,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEN,MAAM,WAAW,mBAAmB;IAClC,iDAAiD;IACjD,WAAW,EAAE,MAAM,CAAC;IAEpB,wCAAwC;IACxC,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,yCAAyC;IACzC,EAAE,EAAE,QAAQ,GAAG,OAAO,CAAC;IACvB,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,KAAK,EAAE,MAAM,CAAC;IACd,wCAAwC;IACxC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,yCAAyC;IACzC,EAAE,EAAE,QAAQ,CAAC;IACb,wCAAwC;IACxC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;;;;;;;;;GAUG;AACH,KAAK,qBAAqB,GAAG,CAAC,KAAK,EAAE;IACnC,YAAY,EAAE,OAAO,CAAC;IACtB,MAAM,EAAE,WAAW,CAAC;CACrB,KAAK,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;AAE/C,MAAM,MAAM,sBAAsB,CAAC,kBAAkB,SAAS,MAAM,IAAI;KACrE,GAAG,IAAI,kBAAkB,GAAG,qBAAqB;CACnD,CAAC"}
|
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
'use client';
|
|
2
|
+
import { createElement, Fragment, useEffect, useMemo } from 'react';
|
|
3
|
+
import { QueryClient, useQueries, } from '@tanstack/react-query';
|
|
4
|
+
import { jwtDecode } from './lib/jwt-decode/index.js';
|
|
5
|
+
export function QraftSecureRequestFn({ children, requestFn, securitySchemes, queryClient: inQueryClient, }) {
|
|
6
|
+
const queryClient = useMemo(() => inQueryClient ??
|
|
7
|
+
new QueryClient({
|
|
8
|
+
defaultOptions: {
|
|
9
|
+
queries: {
|
|
10
|
+
staleTime: 300_000,
|
|
11
|
+
gcTime: 300_000,
|
|
12
|
+
refetchOnWindowFocus: false,
|
|
13
|
+
refetchOnMount: false,
|
|
14
|
+
refetchOnReconnect: false,
|
|
15
|
+
},
|
|
16
|
+
},
|
|
17
|
+
}), [inQueryClient]);
|
|
18
|
+
useEffect(() => {
|
|
19
|
+
queryClient.mount();
|
|
20
|
+
return () => {
|
|
21
|
+
return void queryClient.unmount();
|
|
22
|
+
};
|
|
23
|
+
}, [queryClient]);
|
|
24
|
+
const secureRequestFn = useSecuritySchemeAuth({
|
|
25
|
+
securitySchemes,
|
|
26
|
+
requestFn,
|
|
27
|
+
queryClient,
|
|
28
|
+
});
|
|
29
|
+
return createElement(Fragment, {
|
|
30
|
+
children: children(secureRequestFn),
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
export const useSecuritySchemeAuth = ({ securitySchemes, requestFn, queryClient, }) => {
|
|
34
|
+
useQueries({
|
|
35
|
+
queries: Object.entries(securitySchemes).map(([securitySchemeName]) => {
|
|
36
|
+
const queryKey = [securitySchemeName];
|
|
37
|
+
return {
|
|
38
|
+
enabled: Boolean(queryClient.getQueryData(queryKey)),
|
|
39
|
+
queryKey: queryKey,
|
|
40
|
+
queryFn: ({ signal, }) => {
|
|
41
|
+
const securitySchemeHandler = securitySchemes[securitySchemeName];
|
|
42
|
+
return securitySchemeHandler({ signal, isRefreshing: true });
|
|
43
|
+
},
|
|
44
|
+
};
|
|
45
|
+
}),
|
|
46
|
+
}, queryClient);
|
|
47
|
+
return useMemo(() => createSecureRequestFn(securitySchemes, requestFn, queryClient), [securitySchemes, requestFn, queryClient]);
|
|
48
|
+
};
|
|
49
|
+
/**
|
|
50
|
+
* Create a secure `requestFn` that manages security schemes.
|
|
51
|
+
* It will automatically fetch and refresh tokens when needed
|
|
52
|
+
* using QueryClient and the provided security schemes.
|
|
53
|
+
*
|
|
54
|
+
* @param securitySchemes OpenAPI security schemes.
|
|
55
|
+
* @param requestFn Qraft `requestFn`
|
|
56
|
+
* @param queryClient QueryClient instance.
|
|
57
|
+
*/
|
|
58
|
+
export function createSecureRequestFn(securitySchemes, requestFn, queryClient) {
|
|
59
|
+
return async function secureRequestFn(schema, requestInfo, options) {
|
|
60
|
+
const availableSecuritySchemes = Object.keys(securitySchemes);
|
|
61
|
+
const securitySchemeName = schema.security?.find((security) => availableSecuritySchemes.includes(security));
|
|
62
|
+
if (!securitySchemeName) {
|
|
63
|
+
return requestFn(schema, requestInfo, options);
|
|
64
|
+
}
|
|
65
|
+
const securitySchemeHandler = securitySchemes[securitySchemeName];
|
|
66
|
+
return requestFn(schema, await createSecureRequestInfo(securitySchemeHandler, [securitySchemeName], requestInfo, queryClient), options);
|
|
67
|
+
};
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* Calculate the interval at which a token should be refreshed.
|
|
71
|
+
*/
|
|
72
|
+
function getJwtTokenRefreshInterval(token) {
|
|
73
|
+
const parsedToken = jwtDecode(token);
|
|
74
|
+
if (!parsedToken.iat || !parsedToken.exp) {
|
|
75
|
+
throw new Error("JWT token must contain both 'iat' and 'exp' fields.");
|
|
76
|
+
}
|
|
77
|
+
return (parsedToken.exp - parsedToken.iat) * 1000;
|
|
78
|
+
}
|
|
79
|
+
/**
|
|
80
|
+
* Refresh the token if it is about to expire
|
|
81
|
+
* @returns The string to be used as the `Authorization` header or the object to be used in the request.
|
|
82
|
+
*/
|
|
83
|
+
async function createSecureRequestInfo(handler, queryKey, requestInfo, queryClient) {
|
|
84
|
+
const prevSecurityResult = queryClient.getQueryData(queryKey);
|
|
85
|
+
const securityResult = await queryClient.fetchQuery({
|
|
86
|
+
queryKey,
|
|
87
|
+
queryFn: ({ signal }) => handler({
|
|
88
|
+
signal,
|
|
89
|
+
isRefreshing: Boolean(prevSecurityResult),
|
|
90
|
+
}),
|
|
91
|
+
});
|
|
92
|
+
if (!shallowEqualObjects(securityResult, prevSecurityResult)) {
|
|
93
|
+
const securityRefreshInterval = getSecurityRefreshInterval(securityResult);
|
|
94
|
+
if (securityRefreshInterval !== undefined && securityRefreshInterval > 0) {
|
|
95
|
+
// remove the already fetched query, before setting new defaults
|
|
96
|
+
queryClient.removeQueries({ queryKey, exact: true });
|
|
97
|
+
// set query new defaults (staleTime and gcTime)
|
|
98
|
+
setSecurityQueryDefaults(queryClient, queryKey, securityRefreshInterval);
|
|
99
|
+
// Set query data with the new token, since the old one was removed.
|
|
100
|
+
// New query data will follow the new defaults staleTime and gcTime.
|
|
101
|
+
queryClient.setQueryData(queryKey, securityResult);
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
const securityParameters = createSecureRequestParameters(securityResult);
|
|
105
|
+
if (!securityParameters)
|
|
106
|
+
return requestInfo;
|
|
107
|
+
return {
|
|
108
|
+
...requestInfo,
|
|
109
|
+
parameters: {
|
|
110
|
+
...requestInfo.parameters,
|
|
111
|
+
[securityParameters.in]: {
|
|
112
|
+
[securityParameters.name]: securityParameters.value,
|
|
113
|
+
...requestInfo.parameters?.[securityParameters.in],
|
|
114
|
+
},
|
|
115
|
+
},
|
|
116
|
+
};
|
|
117
|
+
}
|
|
118
|
+
function setSecurityQueryDefaults(queryClient, queryKey, refreshInterval) {
|
|
119
|
+
// set staleTime and gcTime based on token lifetime
|
|
120
|
+
queryClient.setQueryDefaults(queryKey, {
|
|
121
|
+
// stale the token 90% before it expires
|
|
122
|
+
staleTime: isFinite(refreshInterval)
|
|
123
|
+
? refreshInterval * 0.9
|
|
124
|
+
: refreshInterval,
|
|
125
|
+
// garbage collect the token after it expires
|
|
126
|
+
gcTime: isFinite(refreshInterval) ? refreshInterval : refreshInterval,
|
|
127
|
+
// refetch the token 80% before it expires
|
|
128
|
+
refetchInterval: isFinite(refreshInterval)
|
|
129
|
+
? refreshInterval * 0.8
|
|
130
|
+
: refreshInterval,
|
|
131
|
+
// always refetch the token, even in the background
|
|
132
|
+
refetchIntervalInBackground: true,
|
|
133
|
+
});
|
|
134
|
+
}
|
|
135
|
+
function createSecureRequestParameters(securityResult) {
|
|
136
|
+
if (typeof securityResult === 'string' || 'token' in securityResult) {
|
|
137
|
+
return {
|
|
138
|
+
in: 'header',
|
|
139
|
+
name: 'Authorization',
|
|
140
|
+
value: `Bearer ${typeof securityResult === 'string' ? securityResult : securityResult.token}`,
|
|
141
|
+
};
|
|
142
|
+
}
|
|
143
|
+
if ('credentials' in securityResult) {
|
|
144
|
+
return {
|
|
145
|
+
in: 'header',
|
|
146
|
+
name: 'Authorization',
|
|
147
|
+
value: `Basic ${securityResult.credentials}`,
|
|
148
|
+
};
|
|
149
|
+
}
|
|
150
|
+
if ('in' in securityResult && securityResult.in !== 'cookie') {
|
|
151
|
+
return securityResult;
|
|
152
|
+
}
|
|
153
|
+
throw new Error('Security scheme must be a string, an object with a token property, an object with a credentials property, or an object with an in property that is not equal to "cookie".');
|
|
154
|
+
}
|
|
155
|
+
function getSecurityRefreshInterval(securityResult) {
|
|
156
|
+
if (typeof securityResult === 'string') {
|
|
157
|
+
return getJwtTokenRefreshInterval(securityResult);
|
|
158
|
+
}
|
|
159
|
+
if ('refreshInterval' in securityResult) {
|
|
160
|
+
return securityResult.refreshInterval;
|
|
161
|
+
}
|
|
162
|
+
}
|
|
163
|
+
/**
|
|
164
|
+
* @internal
|
|
165
|
+
*/
|
|
166
|
+
export function shallowEqualObjects(newObj, prevObj) {
|
|
167
|
+
if (typeof newObj !== typeof prevObj)
|
|
168
|
+
return false;
|
|
169
|
+
if (typeof newObj === 'string')
|
|
170
|
+
return newObj === prevObj;
|
|
171
|
+
if (typeof newObj !== 'object' ||
|
|
172
|
+
newObj === null ||
|
|
173
|
+
typeof prevObj !== 'object' ||
|
|
174
|
+
prevObj === null ||
|
|
175
|
+
prevObj === undefined)
|
|
176
|
+
return false;
|
|
177
|
+
if (Object.keys(newObj).length !== Object.keys(prevObj).length)
|
|
178
|
+
return false;
|
|
179
|
+
for (const key in newObj) {
|
|
180
|
+
if (!Object.prototype.hasOwnProperty.call(newObj, key))
|
|
181
|
+
return false;
|
|
182
|
+
if (newObj[key] !== prevObj[key])
|
|
183
|
+
return false;
|
|
184
|
+
}
|
|
185
|
+
return true;
|
|
186
|
+
}
|
|
187
|
+
//# sourceMappingURL=Unstable_QraftSecureRequestFn.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Unstable_QraftSecureRequestFn.js","sourceRoot":"","sources":["../src/Unstable_QraftSecureRequestFn.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAa,SAAS,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAE/E,OAAO,EACL,WAAW,EAGX,UAAU,GACX,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AA0BtD,MAAM,UAAU,oBAAoB,CAAC,EACnC,QAAQ,EACR,SAAS,EACT,eAAe,EACf,WAAW,EAAE,aAAa,GACA;IAC1B,MAAM,WAAW,GAAG,OAAO,CACzB,GAAG,EAAE,CACH,aAAa;QACb,IAAI,WAAW,CAAC;YACd,cAAc,EAAE;gBACd,OAAO,EAAE;oBACP,SAAS,EAAE,OAAO;oBAClB,MAAM,EAAE,OAAO;oBACf,oBAAoB,EAAE,KAAK;oBAC3B,cAAc,EAAE,KAAK;oBACrB,kBAAkB,EAAE,KAAK;iBAC1B;aACF;SACF,CAAC,EACJ,CAAC,aAAa,CAAC,CAChB,CAAC;IAEF,SAAS,CAAC,GAAG,EAAE;QACb,WAAW,CAAC,KAAK,EAAE,CAAC;QACpB,OAAO,GAAG,EAAE;YACV,OAAO,KAAK,WAAW,CAAC,OAAO,EAAE,CAAC;QACpC,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IAElB,MAAM,eAAe,GAAG,qBAAqB,CAAC;QAC5C,eAAe;QACf,SAAS;QACT,WAAW;KACZ,CAAC,CAAC;IAEH,OAAO,aAAa,CAAC,QAAQ,EAAE;QAC7B,QAAQ,EAAE,QAAQ,CAAC,eAAe,CAAC;KACpC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,EACpC,eAAe,EACf,SAAS,EACT,WAAW,GAGZ,EAAa,EAAE;IACd,UAAU,CACR;QACE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,kBAAkB,CAAC,EAAE,EAAE;YACpE,MAAM,QAAQ,GAAa,CAAC,kBAAkB,CAAC,CAAC;YAChD,OAAO;gBACL,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;gBACpD,QAAQ,EAAE,QAAiB;gBAC3B,OAAO,EAAE,CAAC,EACR,MAAM,GAC+C,EAAE,EAAE;oBACzD,MAAM,qBAAqB,GAAG,eAAe,CAAC,kBAAkB,CAAC,CAAC;oBAClE,OAAO,qBAAqB,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC/D,CAAC;aACF,CAAC;QACJ,CAAC,CAAC;KACH,EACD,WAAW,CACZ,CAAC;IAEF,OAAO,OAAO,CACZ,GAAG,EAAE,CAAC,qBAAqB,CAAC,eAAe,EAAE,SAAS,EAAE,WAAW,CAAC,EACpE,CAAC,eAAe,EAAE,SAAS,EAAE,WAAW,CAAC,CAC1C,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,UAAU,qBAAqB,CACnC,eAA+C,EAC/C,SAAoB,EACpB,WAAwB;IAExB,OAAO,KAAK,UAAU,eAAe,CACnC,MAAuB,EACvB,WAA0B,EAC1B,OAA0B;QAE1B,MAAM,wBAAwB,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAE3D,CAAC;QACF,MAAM,kBAAkB,GAAG,MAAM,CAAC,QAAQ,EAAE,IAAI,CAC9C,CAAC,QAAQ,EAA4C,EAAE,CACrD,wBAAwB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAC9C,CAAC;QAEF,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxB,OAAO,SAAS,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;QACjD,CAAC;QAED,MAAM,qBAAqB,GAAG,eAAe,CAAC,kBAAkB,CAAC,CAAC;QAElE,OAAO,SAAS,CACd,MAAM,EACN,MAAM,uBAAuB,CAC3B,qBAAqB,EACrB,CAAC,kBAAkB,CAAC,EACpB,WAAW,EACX,WAAW,CACZ,EACD,OAAO,CACR,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAS,0BAA0B,CAAC,KAAa;IAC/C,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;IACrC,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;QACzC,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;IACzE,CAAC;IAED,OAAO,CAAC,WAAW,CAAC,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;AACpD,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,uBAAuB,CACpC,OAA8B,EAC9B,QAAkB,EAClB,WAA0B,EAC1B,WAAwB;IAExB,MAAM,kBAAkB,GAAG,WAAW,CAAC,YAAY,CAAiB,QAAQ,CAAC,CAAC;IAE9E,MAAM,cAAc,GAAG,MAAM,WAAW,CAAC,UAAU,CAAC;QAClD,QAAQ;QACR,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CACtB,OAAO,CAAC;YACN,MAAM;YACN,YAAY,EAAE,OAAO,CAAC,kBAAkB,CAAC;SAC1C,CAAC;KACL,CAAC,CAAC;IAEH,IAAI,CAAC,mBAAmB,CAAC,cAAc,EAAE,kBAAkB,CAAC,EAAE,CAAC;QAC7D,MAAM,uBAAuB,GAAG,0BAA0B,CAAC,cAAc,CAAC,CAAC;QAE3E,IAAI,uBAAuB,KAAK,SAAS,IAAI,uBAAuB,GAAG,CAAC,EAAE,CAAC;YACzE,gEAAgE;YAChE,WAAW,CAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YAErD,gDAAgD;YAChD,wBAAwB,CAAC,WAAW,EAAE,QAAQ,EAAE,uBAAuB,CAAC,CAAC;YAEzE,oEAAoE;YACpE,oEAAoE;YACpE,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IAED,MAAM,kBAAkB,GAAG,6BAA6B,CAAC,cAAc,CAAC,CAAC;IAEzE,IAAI,CAAC,kBAAkB;QAAE,OAAO,WAAW,CAAC;IAE5C,OAAO;QACL,GAAG,WAAW;QACd,UAAU,EAAE;YACV,GAAG,WAAW,CAAC,UAAU;YACzB,CAAC,kBAAkB,CAAC,EAAE,CAAC,EAAE;gBACvB,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,kBAAkB,CAAC,KAAK;gBACnD,GAAG,WAAW,CAAC,UAAU,EAAE,CAAC,kBAAkB,CAAC,EAAE,CAAC;aACnD;SACF;KACF,CAAC;AACJ,CAAC;AAED,SAAS,wBAAwB,CAC/B,WAAwB,EACxB,QAAkB,EAClB,eAAuB;IAEvB,mDAAmD;IACnD,WAAW,CAAC,gBAAgB,CAAC,QAAQ,EAAE;QACrC,wCAAwC;QACxC,SAAS,EAAE,QAAQ,CAAC,eAAe,CAAC;YAClC,CAAC,CAAC,eAAe,GAAG,GAAG;YACvB,CAAC,CAAC,eAAe;QACnB,6CAA6C;QAC7C,MAAM,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,eAAe;QACrE,0CAA0C;QAC1C,eAAe,EAAE,QAAQ,CAAC,eAAe,CAAC;YACxC,CAAC,CAAC,eAAe,GAAG,GAAG;YACvB,CAAC,CAAC,eAAe;QACnB,mDAAmD;QACnD,2BAA2B,EAAE,IAAI;KAClC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,6BAA6B,CAAC,cAA8B;IACnE,IAAI,OAAO,cAAc,KAAK,QAAQ,IAAI,OAAO,IAAI,cAAc,EAAE,CAAC;QACpE,OAAO;YACL,EAAE,EAAE,QAAQ;YACZ,IAAI,EAAE,eAAe;YACrB,KAAK,EAAE,UAAU,OAAO,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,EAAE;SACrF,CAAC;IACb,CAAC;IAED,IAAI,aAAa,IAAI,cAAc,EAAE,CAAC;QACpC,OAAO;YACL,EAAE,EAAE,QAAQ;YACZ,IAAI,EAAE,eAAe;YACrB,KAAK,EAAE,SAAS,cAAc,CAAC,WAAW,EAAE;SACpC,CAAC;IACb,CAAC;IAED,IAAI,IAAI,IAAI,cAAc,IAAI,cAAc,CAAC,EAAE,KAAK,QAAQ,EAAE,CAAC;QAC7D,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,MAAM,IAAI,KAAK,CACb,2KAA2K,CAC5K,CAAC;AACJ,CAAC;AAED,SAAS,0BAA0B,CAAC,cAA8B;IAChE,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;QACvC,OAAO,0BAA0B,CAAC,cAAc,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,iBAAiB,IAAI,cAAc,EAAE,CAAC;QACxC,OAAO,cAAc,CAAC,eAAe,CAAC;IACxC,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CACjC,MAAoC,EACpC,OAAiD;IAEjD,IAAI,OAAO,MAAM,KAAK,OAAO,OAAO;QAAE,OAAO,KAAK,CAAC;IACnD,IAAI,OAAO,MAAM,KAAK,QAAQ;QAAE,OAAO,MAAM,KAAK,OAAO,CAAC;IAC1D,IACE,OAAO,MAAM,KAAK,QAAQ;QAC1B,MAAM,KAAK,IAAI;QACf,OAAO,OAAO,KAAK,QAAQ;QAC3B,OAAO,KAAK,IAAI;QAChB,OAAO,KAAK,SAAS;QAErB,OAAO,KAAK,CAAC;IACf,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IAE7E,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;QACzB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QACrE,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;IACjD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
export interface JwtDecodeOptions {
|
|
2
|
+
header?: boolean;
|
|
3
|
+
}
|
|
4
|
+
export interface JwtHeader {
|
|
5
|
+
typ?: string;
|
|
6
|
+
alg?: string;
|
|
7
|
+
kid?: string;
|
|
8
|
+
}
|
|
9
|
+
export interface JwtPayload {
|
|
10
|
+
iss?: string;
|
|
11
|
+
sub?: string;
|
|
12
|
+
aud?: string[] | string;
|
|
13
|
+
exp?: number;
|
|
14
|
+
nbf?: number;
|
|
15
|
+
iat?: number;
|
|
16
|
+
jti?: string;
|
|
17
|
+
}
|
|
18
|
+
export declare class InvalidTokenError extends Error {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Decode a base64 string to a UTF-8 string.
|
|
22
|
+
* Could be used in Node.js or in the browser.
|
|
23
|
+
*/
|
|
24
|
+
export declare function b64DecodeUnicode(data: string): string;
|
|
25
|
+
export declare function jwtDecode<T = JwtHeader>(token: string, options: JwtDecodeOptions & {
|
|
26
|
+
header: true;
|
|
27
|
+
}): T;
|
|
28
|
+
export declare function jwtDecode<T = JwtPayload>(token: string, options?: JwtDecodeOptions): T;
|
|
29
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/jwt-decode/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,SAAS;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,UAAU;IACzB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,qBAAa,iBAAkB,SAAQ,KAAK;CAAG;AAI/C;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAKrD;AAwBD,wBAAgB,SAAS,CAAC,CAAC,GAAG,SAAS,EACrC,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,gBAAgB,GAAG;IAAE,MAAM,EAAE,IAAI,CAAA;CAAE,GAC3C,CAAC,CAAC;AACL,wBAAgB,SAAS,CAAC,CAAC,GAAG,UAAU,EACtC,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,gBAAgB,GACzB,CAAC,CAAC"}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
export class InvalidTokenError extends Error {
|
|
2
|
+
}
|
|
3
|
+
InvalidTokenError.prototype.name = 'InvalidTokenError';
|
|
4
|
+
/**
|
|
5
|
+
* Decode a base64 string to a UTF-8 string.
|
|
6
|
+
* Could be used in Node.js or in the browser.
|
|
7
|
+
*/
|
|
8
|
+
export function b64DecodeUnicode(data) {
|
|
9
|
+
if (typeof atob === 'function')
|
|
10
|
+
return decodeURIComponent(Array.from(atob(data), byteToPercent).join(''));
|
|
11
|
+
return Buffer.from(data, 'base64').toString('utf-8');
|
|
12
|
+
}
|
|
13
|
+
function base64UrlDecode(str) {
|
|
14
|
+
let output = str.replace(/-/g, '+').replace(/_/g, '/');
|
|
15
|
+
switch (output.length % 4) {
|
|
16
|
+
case 0:
|
|
17
|
+
break;
|
|
18
|
+
case 2:
|
|
19
|
+
output += '==';
|
|
20
|
+
break;
|
|
21
|
+
case 3:
|
|
22
|
+
output += '=';
|
|
23
|
+
break;
|
|
24
|
+
default:
|
|
25
|
+
throw new Error('base64 string is not of the correct length');
|
|
26
|
+
}
|
|
27
|
+
try {
|
|
28
|
+
return b64DecodeUnicode(output);
|
|
29
|
+
}
|
|
30
|
+
catch (err) {
|
|
31
|
+
return atob(output);
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
export function jwtDecode(token, options) {
|
|
35
|
+
if (typeof token !== 'string') {
|
|
36
|
+
throw new InvalidTokenError('Invalid token specified: must be a string');
|
|
37
|
+
}
|
|
38
|
+
options ||= {};
|
|
39
|
+
const pos = options.header === true ? 0 : 1;
|
|
40
|
+
const part = token.split('.')[pos];
|
|
41
|
+
if (typeof part !== 'string') {
|
|
42
|
+
throw new InvalidTokenError(`Invalid token specified: missing part #${pos + 1}`);
|
|
43
|
+
}
|
|
44
|
+
let decoded;
|
|
45
|
+
try {
|
|
46
|
+
decoded = base64UrlDecode(part);
|
|
47
|
+
}
|
|
48
|
+
catch (e) {
|
|
49
|
+
throw new InvalidTokenError(`Invalid token specified: invalid base64 for part #${pos + 1} (${e.message})`);
|
|
50
|
+
}
|
|
51
|
+
try {
|
|
52
|
+
return JSON.parse(decoded);
|
|
53
|
+
}
|
|
54
|
+
catch (e) {
|
|
55
|
+
throw new InvalidTokenError(`Invalid token specified: invalid json for part #${pos + 1} (${e.message})`);
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
function byteToPercent(b) {
|
|
59
|
+
return `%${`00${b.charCodeAt(0).toString(16)}`.slice(-2)}`;
|
|
60
|
+
}
|
|
61
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/jwt-decode/index.ts"],"names":[],"mappings":"AAoBA,MAAM,OAAO,iBAAkB,SAAQ,KAAK;CAAG;AAE/C,iBAAiB,CAAC,SAAS,CAAC,IAAI,GAAG,mBAAmB,CAAC;AAEvD;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAY;IAC3C,IAAI,OAAO,IAAI,KAAK,UAAU;QAC5B,OAAO,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAE5E,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AACvD,CAAC;AAED,SAAS,eAAe,CAAC,GAAW;IAClC,IAAI,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACvD,QAAQ,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,KAAK,CAAC;YACJ,MAAM;QACR,KAAK,CAAC;YACJ,MAAM,IAAI,IAAI,CAAC;YACf,MAAM;QACR,KAAK,CAAC;YACJ,MAAM,IAAI,GAAG,CAAC;YACd,MAAM;QACR;YACE,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAClE,CAAC;IAED,IAAI,CAAC;QACH,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC;AACH,CAAC;AAUD,MAAM,UAAU,SAAS,CACvB,KAAa,EACb,OAA0B;IAE1B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,IAAI,iBAAiB,CAAC,2CAA2C,CAAC,CAAC;IAC3E,CAAC;IAED,OAAO,KAAK,EAAE,CAAC;IAEf,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5C,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IAEnC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,MAAM,IAAI,iBAAiB,CACzB,0CAA0C,GAAG,GAAG,CAAC,EAAE,CACpD,CAAC;IACJ,CAAC;IAED,IAAI,OAAe,CAAC;IACpB,IAAI,CAAC;QACH,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,IAAI,iBAAiB,CACzB,qDAAqD,GAAG,GAAG,CAAC,KAAM,CAAW,CAAC,OAAO,GAAG,CACzF,CAAC;IACJ,CAAC;IAED,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAM,CAAC;IAClC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,IAAI,iBAAiB,CACzB,mDAAmD,GAAG,GAAG,CAAC,KAAM,CAAW,CAAC,OAAO,GAAG,CACvF,CAAC;IACJ,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,CAAS;IAC9B,OAAO,IAAI,KAAK,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAC7D,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../../../src/lib/jwt-decode/index.test.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
import { describe, expect, it } from 'vitest';
|
|
2
|
+
import { jwtDecode, InvalidTokenError, b64DecodeUnicode, } from './index.js';
|
|
3
|
+
const token = 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJmb28iOiJiYXIiLCJleHAiOjEzOTMyODY4OTMsImlhdCI6MTM5MzI2ODg5M30.4-iaDojEVl0pJQMjrbM1EzUIfAZgsbK_kgnVyVxFSVo';
|
|
4
|
+
describe('jwt-decode', () => {
|
|
5
|
+
it('should return default and custom claims', () => {
|
|
6
|
+
const decoded = jwtDecode(token);
|
|
7
|
+
expect(decoded.exp).toEqual(1393286893);
|
|
8
|
+
expect(decoded.iat).toEqual(1393268893);
|
|
9
|
+
expect(decoded.foo).toEqual('bar');
|
|
10
|
+
});
|
|
11
|
+
it('should return header information', () => {
|
|
12
|
+
const decoded = jwtDecode(token, { header: true });
|
|
13
|
+
expect(decoded.typ).toEqual('JWT');
|
|
14
|
+
expect(decoded.alg).toEqual('HS256');
|
|
15
|
+
});
|
|
16
|
+
it('should work with utf8 tokens', () => {
|
|
17
|
+
const utf8Token = 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiSm9zw6kiLCJpYXQiOjE0MjU2NDQ5NjZ9.1CfFtdGUPs6q8kT3OGQSVlhEMdbuX0HfNSqum0023a0';
|
|
18
|
+
const decoded = jwtDecode(utf8Token);
|
|
19
|
+
expect(decoded.name).toEqual('José');
|
|
20
|
+
});
|
|
21
|
+
it('should work with binary tokens', () => {
|
|
22
|
+
const binaryToken = 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiSm9z6SIsImlhdCI6MTQyNTY0NDk2Nn0.cpnplCBxiw7Xqz5thkqs4Mo_dymvztnI0CI4BN0d1t8';
|
|
23
|
+
const decoded = jwtDecode(binaryToken);
|
|
24
|
+
expect(decoded.name).toEqual('José');
|
|
25
|
+
});
|
|
26
|
+
it('should work with double padding', () => {
|
|
27
|
+
const utf8Token = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Ikpvc8OpIiwiaWF0IjoxNTE2MjM5MDIyfQ.7A3F5SUH2gbBSYVon5mas_Y-KCrWojorKQg7UKGVEIA';
|
|
28
|
+
const decoded = jwtDecode(utf8Token);
|
|
29
|
+
expect(decoded.name).toEqual('José');
|
|
30
|
+
});
|
|
31
|
+
it('should work with single padding', () => {
|
|
32
|
+
const utf8Token = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Ikpvc8OpZSIsImlhdCI6MTUxNjIzOTAyMn0.tbjJzDAylkKSV0_YGR5xBJBlFK01C82nZPLIcA3JX1g';
|
|
33
|
+
const decoded = jwtDecode(utf8Token);
|
|
34
|
+
expect(decoded.name).toEqual('Josée');
|
|
35
|
+
});
|
|
36
|
+
it('should throw InvalidTokenError on not a string', () => {
|
|
37
|
+
const badToken = null;
|
|
38
|
+
expect(() => {
|
|
39
|
+
jwtDecode(badToken);
|
|
40
|
+
}).toThrow(InvalidTokenError);
|
|
41
|
+
});
|
|
42
|
+
it('should throw InvalidTokenError on string that is not a token', () => {
|
|
43
|
+
const badToken = 'foobar';
|
|
44
|
+
expect(() => {
|
|
45
|
+
jwtDecode(badToken);
|
|
46
|
+
}).toThrow(InvalidTokenError);
|
|
47
|
+
});
|
|
48
|
+
it('should throw InvalidTokenErrors when token is null', () => {
|
|
49
|
+
const badToken = null;
|
|
50
|
+
expect(() => {
|
|
51
|
+
jwtDecode(badToken, { header: true });
|
|
52
|
+
}).toThrow(new InvalidTokenError('Invalid token specified: must be a string'));
|
|
53
|
+
});
|
|
54
|
+
it('should throw InvalidTokenErrors when missing part #1', () => {
|
|
55
|
+
const badToken = '.FAKE_TOKEN';
|
|
56
|
+
expect(() => {
|
|
57
|
+
jwtDecode(badToken, { header: true });
|
|
58
|
+
}).toThrow(/Invalid token specified: invalid json for part #1/);
|
|
59
|
+
});
|
|
60
|
+
it('should throw InvalidTokenErrors when part #1 is not valid base64', () => {
|
|
61
|
+
const badToken = 'TOKEN';
|
|
62
|
+
expect(() => {
|
|
63
|
+
jwtDecode(badToken, { header: true });
|
|
64
|
+
}).toThrow(/Invalid token specified: invalid base64 for part #1/);
|
|
65
|
+
});
|
|
66
|
+
it('should throw InvalidTokenErrors when part #1 is not valid JSON', () => {
|
|
67
|
+
const badToken = 'FAKE.TOKEN';
|
|
68
|
+
expect(() => {
|
|
69
|
+
jwtDecode(badToken, { header: true });
|
|
70
|
+
}).toThrow(/Invalid token specified: invalid json for part #1/);
|
|
71
|
+
});
|
|
72
|
+
it('should throw InvalidTokenErrors when missing part #2', () => {
|
|
73
|
+
const badToken = 'FAKE_TOKEN';
|
|
74
|
+
expect(() => {
|
|
75
|
+
jwtDecode(badToken);
|
|
76
|
+
}).toThrow(new InvalidTokenError('Invalid token specified: missing part #2'));
|
|
77
|
+
});
|
|
78
|
+
it('should throw InvalidTokenErrors when part #2 is not valid base64', () => {
|
|
79
|
+
const badToken = 'FAKE.TOKEN';
|
|
80
|
+
expect(() => {
|
|
81
|
+
jwtDecode(badToken);
|
|
82
|
+
}).toThrow(/Invalid token specified: invalid base64 for part #2/);
|
|
83
|
+
});
|
|
84
|
+
it('should throw InvalidTokenErrors when part #2 is not valid JSON', () => {
|
|
85
|
+
const badToken = 'FAKE.TOKEN2';
|
|
86
|
+
expect(() => {
|
|
87
|
+
jwtDecode(badToken);
|
|
88
|
+
}).toThrow(/Invalid token specified: invalid json for part #2/);
|
|
89
|
+
});
|
|
90
|
+
});
|
|
91
|
+
describe('decodeBase64', () => {
|
|
92
|
+
it('decodes base64', () => {
|
|
93
|
+
expect(b64DecodeUnicode('aGVsbG8=')).toEqual('hello');
|
|
94
|
+
});
|
|
95
|
+
it('decodes base64 non latin characters', () => {
|
|
96
|
+
expect(b64DecodeUnicode('5L2g5aW9')).toEqual('你好');
|
|
97
|
+
});
|
|
98
|
+
});
|
|
99
|
+
//# sourceMappingURL=index.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../../../src/lib/jwt-decode/index.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE9C,OAAO,EACL,SAAS,EACT,iBAAiB,EAEjB,gBAAgB,GACjB,MAAM,YAAY,CAAC;AAEpB,MAAM,KAAK,GACT,kJAAkJ,CAAC;AAErJ,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACjD,MAAM,OAAO,GAAG,SAAS,CAA+B,KAAK,CAAC,CAAC;QAC/D,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACxC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACxC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC1C,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACnD,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACnC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,MAAM,SAAS,GACb,+HAA+H,CAAC;QAClI,MAAM,OAAO,GAAG,SAAS,CAAgC,SAAS,CAAC,CAAC;QACpE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;QACxC,MAAM,WAAW,GACf,8HAA8H,CAAC;QACjI,MAAM,OAAO,GAAG,SAAS,CAAgC,WAAW,CAAC,CAAC;QACtE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACzC,MAAM,SAAS,GACb,yJAAyJ,CAAC;QAC5J,MAAM,OAAO,GAAG,SAAS,CAAgC,SAAS,CAAC,CAAC;QACpE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACzC,MAAM,SAAS,GACb,0JAA0J,CAAC;QAC7J,MAAM,OAAO,GAAG,SAAS,CAAgC,SAAS,CAAC,CAAC;QACpE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,MAAM,QAAQ,GAAG,IAAI,CAAC;QACtB,MAAM,CAAC,GAAG,EAAE;YACV,SAAS,CAAC,QAA6B,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;QACtE,MAAM,QAAQ,GAAG,QAAQ,CAAC;QAC1B,MAAM,CAAC,GAAG,EAAE;YACV,SAAS,CAAC,QAAQ,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC;QACtB,MAAM,CAAC,GAAG,EAAE;YACV,SAAS,CAAC,QAA6B,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC,OAAO,CACR,IAAI,iBAAiB,CAAC,2CAA2C,CAAC,CACnE,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,QAAQ,GAAG,aAAa,CAAC;QAC/B,MAAM,CAAC,GAAG,EAAE;YACV,SAAS,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC,OAAO,CAAC,mDAAmD,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE;QAC1E,MAAM,QAAQ,GAAG,OAAO,CAAC;QACzB,MAAM,CAAC,GAAG,EAAE;YACV,SAAS,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC,OAAO,CAAC,qDAAqD,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,MAAM,QAAQ,GAAG,YAAY,CAAC;QAC9B,MAAM,CAAC,GAAG,EAAE;YACV,SAAS,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC,OAAO,CAAC,mDAAmD,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,QAAQ,GAAG,YAAY,CAAC;QAC9B,MAAM,CAAC,GAAG,EAAE;YACV,SAAS,CAAC,QAAQ,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC,OAAO,CACR,IAAI,iBAAiB,CAAC,0CAA0C,CAAC,CAClE,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE;QAC1E,MAAM,QAAQ,GAAG,YAAY,CAAC;QAC9B,MAAM,CAAC,GAAG,EAAE;YACV,SAAS,CAAC,QAAQ,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC,OAAO,CAAC,qDAAqD,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,MAAM,QAAQ,GAAG,aAAa,CAAC;QAC/B,MAAM,CAAC,GAAG,EAAE;YACV,SAAS,CAAC,QAAQ,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC,OAAO,CAAC,mDAAmD,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,EAAE,CAAC,gBAAgB,EAAE,GAAG,EAAE;QACxB,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
package/dist/lib/requestFn.d.ts
CHANGED
|
@@ -30,6 +30,7 @@ export declare function requestFn<T>(schema: OperationSchema, requestInfo: Reque
|
|
|
30
30
|
*/
|
|
31
31
|
export declare function baseRequestFn<T>(requestSchema: OperationSchema, requestInfo: RequestFnInfo, options: WithRequired<RequestFnOptions, 'urlSerializer' | 'bodySerializer'>): Promise<T>;
|
|
32
32
|
export declare function urlSerializer(schema: OperationSchema, info: RequestFnPayload): string;
|
|
33
|
+
export declare function mergeHeaders(...allHeaders: (HeadersOptions | undefined)[]): Headers;
|
|
33
34
|
export declare function bodySerializer(schema: OperationSchema, info: RequestFnPayload): string | Blob | FormData | undefined;
|
|
34
35
|
export type HeadersOptions = HeadersInit | Record<string, string | number | boolean | null | undefined>;
|
|
35
36
|
export interface OperationSchema {
|
|
@@ -47,6 +48,7 @@ export interface OperationSchema {
|
|
|
47
48
|
* @example application/json
|
|
48
49
|
*/
|
|
49
50
|
readonly mediaType?: string;
|
|
51
|
+
readonly security?: string[];
|
|
50
52
|
}
|
|
51
53
|
export interface RequestFnPayload {
|
|
52
54
|
/**
|
|
@@ -78,7 +80,7 @@ export interface RequestFnPayload {
|
|
|
78
80
|
/** An AbortSignal to set request's signal. */
|
|
79
81
|
signal?: AbortSignal | null;
|
|
80
82
|
}
|
|
81
|
-
interface RequestFnInfo extends RequestFnPayload, Omit<RequestInit, 'headers' | 'method' | 'body' | 'signal'> {
|
|
83
|
+
export interface RequestFnInfo extends RequestFnPayload, Omit<RequestInit, 'headers' | 'method' | 'body' | 'signal'> {
|
|
82
84
|
/**
|
|
83
85
|
* Request headers
|
|
84
86
|
* @example { 'X-Auth': '123' }
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"requestFn.d.ts","sourceRoot":"","sources":["../../src/lib/requestFn.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,wBAAsB,SAAS,CAAC,CAAC,EAC/B,MAAM,EAAE,eAAe,EACvB,WAAW,EAAE,aAAa,EAC1B,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,CAAC,CAAC,CAMZ;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,aAAa,CAAC,CAAC,EACnC,aAAa,EAAE,eAAe,EAC9B,WAAW,EAAE,aAAa,EAC1B,OAAO,EAAE,YAAY,CAAC,gBAAgB,EAAE,eAAe,GAAG,gBAAgB,CAAC,GAC1E,OAAO,CAAC,CAAC,CAAC,CAoCZ;AAED,wBAAgB,aAAa,CAC3B,MAAM,EAAE,eAAe,EACvB,IAAI,EAAE,gBAAgB,GACrB,MAAM,CAqBR;
|
|
1
|
+
{"version":3,"file":"requestFn.d.ts","sourceRoot":"","sources":["../../src/lib/requestFn.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,wBAAsB,SAAS,CAAC,CAAC,EAC/B,MAAM,EAAE,eAAe,EACvB,WAAW,EAAE,aAAa,EAC1B,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,CAAC,CAAC,CAMZ;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,aAAa,CAAC,CAAC,EACnC,aAAa,EAAE,eAAe,EAC9B,WAAW,EAAE,aAAa,EAC1B,OAAO,EAAE,YAAY,CAAC,gBAAgB,EAAE,eAAe,GAAG,gBAAgB,CAAC,GAC1E,OAAO,CAAC,CAAC,CAAC,CAoCZ;AAED,wBAAgB,aAAa,CAC3B,MAAM,EAAE,eAAe,EACvB,IAAI,EAAE,gBAAgB,GACrB,MAAM,CAqBR;AAoCD,wBAAgB,YAAY,CAAC,GAAG,UAAU,EAAE,CAAC,cAAc,GAAG,SAAS,CAAC,EAAE,WAuBzE;AAED,wBAAgB,cAAc,CAC5B,MAAM,EAAE,eAAe,EACvB,IAAI,EAAE,gBAAgB,wCAwBvB;AA+ED,MAAM,MAAM,cAAc,GACtB,WAAW,GACX,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;AAEjE,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,MAAM,EACX,KAAK,GACL,KAAK,GACL,MAAM,GACN,OAAO,GACP,QAAQ,GACR,SAAS,GACT,MAAM,GACN,OAAO,CAAC;IAEZ;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAE5B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5B;;;;;;OAMG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE;QACpB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACpC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KACtC,CAAC;IAEF;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAE1D;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE/B,8CAA8C;IAC9C,MAAM,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,aACf,SAAQ,gBAAgB,EACtB,IAAI,CAAC,WAAW,EAAE,SAAS,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;IAC7D;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC;CACnC;AAED,MAAM,WAAW,gBAAgB;IAC/B,aAAa,CAAC,EAAE,OAAO,aAAa,CAAC;IACrC,cAAc,CAAC,EAAE,OAAO,cAAc,CAAC;IACvC,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;CACtB;AAED,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC;AAE/C,KAAK,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG;KAC3C,CAAC,IAAI,CAAC,GAAG,EAAE;CACb,CAAC"}
|
package/dist/lib/requestFn.js
CHANGED
|
@@ -101,7 +101,7 @@ function getQueryString(params) {
|
|
|
101
101
|
}
|
|
102
102
|
return '';
|
|
103
103
|
}
|
|
104
|
-
function mergeHeaders(...allHeaders) {
|
|
104
|
+
export function mergeHeaders(...allHeaders) {
|
|
105
105
|
const headers = new Headers();
|
|
106
106
|
for (const headerSet of allHeaders) {
|
|
107
107
|
if (!headerSet || typeof headerSet !== 'object') {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"requestFn.js","sourceRoot":"","sources":["../../src/lib/requestFn.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,MAAuB,EACvB,WAA0B,EAC1B,OAA0B;IAE1B,OAAO,aAAa,CAAC,MAAM,EAAE,WAAW,EAAE;QACxC,aAAa;QACb,cAAc;QACd,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,aAA8B,EAC9B,WAA0B,EAC1B,OAA2E;IAE3E,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,eAAe,EAAE,GAAG,WAAW,CAAC;IAEtE,MAAM,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;IAEvE,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC;IAEzC,MAAM,QAAQ,GAAG,MAAM,SAAS,CAC9B,OAAO,CAAC,aAAa,CAAC,aAAa,EAAE,WAAW,CAAC,EACjD;QACE,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,WAAW,EAAE;QAC1C,IAAI,EAAE,WAAW;QACjB,OAAO,EAAE,YAAY,CACnB;YACE,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,aAAa,CAAC,SAAS,IAAI,kBAAkB,CAAC,IAAI,CAAC;SACpE,EACD,OAAO,EACP,UAAU,EAAE,MAAM,EAClB,WAAW,YAAY,QAAQ;YAC7B,CAAC,CAAC,sHAAsH;gBACtH,EAAE,cAAc,EAAE,IAAI,EAAE;YAC1B,CAAC,CAAC,SAAS,CACd;QACD,GAAG,eAAe;KACnB,CACF,CAAC;IAEF,yCAAyC;IACzC,MAAM,cAAc,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;IAExC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,MAAM,eAAe,CAAC,cAAc,CAAC,CAAC;IAC9C,CAAC;IAED,OAAO,CAAC,MAAM,eAAe,CAAC,cAAc,CAAC,CAAM,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,aAAa,CAC3B,MAAuB,EACvB,IAAsB;IAEtB,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAC7B,UAAU,EACV,CAAC,SAAiB,EAAE,KAAa,EAAE,EAAE;QACnC,IACE,IAAI,CAAC,UAAU,EAAE,IAAI;YACrB,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,EACjE,CAAC;YACD,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACzD,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC,CACF,CAAC;IAEF,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;IAEnC,IAAI,IAAI,CAAC,UAAU,EAAE,KAAK,EAAE,CAAC;QAC3B,OAAO,GAAG,OAAO,GAAG,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;IACrE,CAAC;IAED,OAAO,GAAG,OAAO,GAAG,IAAI,EAAE,CAAC;AAC7B,CAAC;AAED,SAAS,cAAc,CAAC,MAA2B;IACjD,MAAM,EAAE,GAAa,EAAE,CAAC;IAExB,MAAM,MAAM,GAAG,CAAC,GAAW,EAAE,KAAU,EAAE,EAAE;QACzC,EAAE,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,GAAG,CAAC,IAAI,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;IAC7E,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,CAAC,GAAW,EAAE,KAAU,EAAE,EAAE;QAC1C,IAAI,OAAO,KAAK,KAAK,WAAW,IAAI,KAAK,KAAK,IAAI;YAAE,OAAO;QAE3D,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;gBAClB,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACrC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;gBACvC,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YAC7B,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC9C,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClB,OAAO,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;IAC5B,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,
|
|
1
|
+
{"version":3,"file":"requestFn.js","sourceRoot":"","sources":["../../src/lib/requestFn.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,MAAuB,EACvB,WAA0B,EAC1B,OAA0B;IAE1B,OAAO,aAAa,CAAC,MAAM,EAAE,WAAW,EAAE;QACxC,aAAa;QACb,cAAc;QACd,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,aAA8B,EAC9B,WAA0B,EAC1B,OAA2E;IAE3E,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,eAAe,EAAE,GAAG,WAAW,CAAC;IAEtE,MAAM,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;IAEvE,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC;IAEzC,MAAM,QAAQ,GAAG,MAAM,SAAS,CAC9B,OAAO,CAAC,aAAa,CAAC,aAAa,EAAE,WAAW,CAAC,EACjD;QACE,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,WAAW,EAAE;QAC1C,IAAI,EAAE,WAAW;QACjB,OAAO,EAAE,YAAY,CACnB;YACE,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,aAAa,CAAC,SAAS,IAAI,kBAAkB,CAAC,IAAI,CAAC;SACpE,EACD,OAAO,EACP,UAAU,EAAE,MAAM,EAClB,WAAW,YAAY,QAAQ;YAC7B,CAAC,CAAC,sHAAsH;gBACtH,EAAE,cAAc,EAAE,IAAI,EAAE;YAC1B,CAAC,CAAC,SAAS,CACd;QACD,GAAG,eAAe;KACnB,CACF,CAAC;IAEF,yCAAyC;IACzC,MAAM,cAAc,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;IAExC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,MAAM,eAAe,CAAC,cAAc,CAAC,CAAC;IAC9C,CAAC;IAED,OAAO,CAAC,MAAM,eAAe,CAAC,cAAc,CAAC,CAAM,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,aAAa,CAC3B,MAAuB,EACvB,IAAsB;IAEtB,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAC7B,UAAU,EACV,CAAC,SAAiB,EAAE,KAAa,EAAE,EAAE;QACnC,IACE,IAAI,CAAC,UAAU,EAAE,IAAI;YACrB,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,EACjE,CAAC;YACD,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACzD,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC,CACF,CAAC;IAEF,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;IAEnC,IAAI,IAAI,CAAC,UAAU,EAAE,KAAK,EAAE,CAAC;QAC3B,OAAO,GAAG,OAAO,GAAG,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;IACrE,CAAC;IAED,OAAO,GAAG,OAAO,GAAG,IAAI,EAAE,CAAC;AAC7B,CAAC;AAED,SAAS,cAAc,CAAC,MAA2B;IACjD,MAAM,EAAE,GAAa,EAAE,CAAC;IAExB,MAAM,MAAM,GAAG,CAAC,GAAW,EAAE,KAAU,EAAE,EAAE;QACzC,EAAE,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,GAAG,CAAC,IAAI,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;IAC7E,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,CAAC,GAAW,EAAE,KAAU,EAAE,EAAE;QAC1C,IAAI,OAAO,KAAK,KAAK,WAAW,IAAI,KAAK,KAAK,IAAI;YAAE,OAAO;QAE3D,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;gBAClB,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACrC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;gBACvC,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YAC7B,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC9C,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClB,OAAO,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;IAC5B,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,GAAG,UAA0C;IACxE,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;IAE9B,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,IAAI,CAAC,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;YAChD,SAAS;QACX,CAAC;QAED,MAAM,eAAe,GACnB,SAAS,YAAY,OAAO;YAC1B,CAAC,CAAC,SAAS,CAAC,OAAO,EAAE;YACrB,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAEhC,KAAK,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,IAAI,eAAe,EAAE,CAAC;YACvD,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;gBACzB,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAC5B,CAAC;iBAAM,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBACrC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;YACtC,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,cAAc,CAC5B,MAAuB,EACvB,IAAsB;IAEtB,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS;QAAE,OAAO;IAEpC,IACE,MAAM,CAAC,MAAM,KAAK,KAAK;QACvB,MAAM,CAAC,MAAM,KAAK,MAAM;QACxB,MAAM,CAAC,MAAM,KAAK,SAAS;QAE3B,OAAO;IAET,IAAI,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,YAAY,CAAC;QAC1C,OAAO,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAEtC,IACE,CAAC,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC;QACpC,CAAC,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ;YAC5B,IAAI,CAAC,IAAI,YAAY,IAAI;YACzB,IAAI,CAAC,IAAI,YAAY,QAAQ,CAAC,EAChC,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC;AAED,SAAS,sBAAsB,CAAC,EAC9B,IAAI,GAC2B;IAC/B,IAAI,IAAI,YAAY,QAAQ;QAAE,OAAO,IAAI,CAAC;IAC1C,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO;IAE1B,IAAI,IAAI,YAAY,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;IAC7E,IAAI,IAAI,YAAY,WAAW;QAC7B,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;IAC5D,IAAI,IAAI,YAAY,eAAe;QACjC,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,IAAI,IAAI,YAAY,cAAc;QAChC,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;IAC/D,IAAI,OAAO,IAAI,KAAK,QAAQ;QAC1B,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACvD,IAAI,OAAO,IAAI,KAAK,QAAQ;QAC1B,MAAM,IAAI,KAAK,CAAC,yBAAyB,OAAO,IAAI,gBAAgB,CAAC,CAAC;IAExE,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;IAEhC,MAAM,OAAO,GAAG,CAAC,GAAW,EAAE,KAAU,EAAE,EAAE;QAC1C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;YACvD,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC9B,CAAC;aAAM,CAAC;YACN,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;SACjB,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,WAAW,IAAI,KAAK,KAAK,IAAI,CAAC;SACtE,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACxB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;QACxC,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACtB,CAAC;IACH,CAAC,CAAC,CAAC;IAEL,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,kBAAkB,CAAC,IAA8B;IACxD,IAAI,CAAC,IAAI;QAAE,OAAO;IAClB,IAAI,IAAI,YAAY,IAAI;QAAE,OAAO,IAAI,CAAC,IAAI,IAAI,0BAA0B,CAAC;IACzE,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,YAAY,CAAC;IAClD,IAAI,CAAC,CAAC,IAAI,YAAY,QAAQ,CAAC;QAAE,OAAO,kBAAkB,CAAC;AAC7D,CAAC;AAED,KAAK,UAAU,eAAe,CAAI,QAAkB;IAClD,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,KAAK,GAAG;QAC3E,OAAO,SAAS,CAAC;IAEnB,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,WAAW,EAAE,CAAC;IACxE,MAAM,MAAM,GACV,WAAW,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,WAAW,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAEnE,IAAI,MAAM,EAAE,CAAC;QACX,iEAAiE;QACjE,IAAI,QAAQ,CAAC,EAAE;YAAE,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;QAExC,MAAM,qBAAqB,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,gCAAgC;QAEhF,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE;YAChC,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,EAAE,CAAC;gBAC3C,OAAO,CAAC,IAAI,CACV,gEAAgE,CACjE,CAAC;YACJ,CAAC;YACD,4DAA4D;YAC5D,OAAO,qBAAqB,CAAC,IAAI,EAAE,CAAC;QACtC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,QAAQ,CAAC,IAAI,EAAgB,CAAC;AACvC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openapi-qraft/react",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.10.0",
|
|
4
4
|
"description": "API client for React, providing type-safe requests and dynamic Tanstack Query React Hooks via a modular, Proxy-based architecture.",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "rimraf dist/ && tsc --project tsconfig.build.json",
|
|
@@ -15,9 +15,9 @@
|
|
|
15
15
|
"type": "module",
|
|
16
16
|
"sideEffects": false,
|
|
17
17
|
"devDependencies": {
|
|
18
|
-
"@openapi-qraft/cli": "~1.
|
|
18
|
+
"@openapi-qraft/cli": "~1.10.0",
|
|
19
19
|
"@openapi-qraft/eslint-config": "~1.0.0",
|
|
20
|
-
"@openapi-qraft/openapi-typescript-plugin": "^1.0.
|
|
20
|
+
"@openapi-qraft/openapi-typescript-plugin": "^1.0.2",
|
|
21
21
|
"@openapi-qraft/test-fixtures": "~1.0.0",
|
|
22
22
|
"@tanstack/react-query": "^5.17.3",
|
|
23
23
|
"@testing-library/jest-dom": "^5.17.0",
|
|
@@ -0,0 +1,365 @@
|
|
|
1
|
+
'use client';
|
|
2
|
+
|
|
3
|
+
import { createElement, Fragment, ReactNode, useEffect, useMemo } from 'react';
|
|
4
|
+
|
|
5
|
+
import {
|
|
6
|
+
QueryClient,
|
|
7
|
+
type QueryFunctionContext,
|
|
8
|
+
type QueryKey,
|
|
9
|
+
useQueries,
|
|
10
|
+
} from '@tanstack/react-query';
|
|
11
|
+
|
|
12
|
+
import { jwtDecode } from './lib/jwt-decode/index.js';
|
|
13
|
+
import type {
|
|
14
|
+
OperationSchema,
|
|
15
|
+
RequestFnInfo,
|
|
16
|
+
RequestFnOptions,
|
|
17
|
+
} from './lib/requestFn.js';
|
|
18
|
+
|
|
19
|
+
interface QraftSecureRequestFnBaseProps {
|
|
20
|
+
requestFn<T>(
|
|
21
|
+
schema: OperationSchema,
|
|
22
|
+
requestInfo: RequestFnInfo,
|
|
23
|
+
options?: RequestFnOptions
|
|
24
|
+
): Promise<T>;
|
|
25
|
+
securitySchemes: SecuritySchemeHandlers<string>;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
type RequestFn = QraftSecureRequestFnBaseProps['requestFn'];
|
|
29
|
+
|
|
30
|
+
export interface QraftSecureRequestFnProps
|
|
31
|
+
extends QraftSecureRequestFnBaseProps {
|
|
32
|
+
children(
|
|
33
|
+
secureRequestFn: QraftSecureRequestFnBaseProps['requestFn']
|
|
34
|
+
): ReactNode;
|
|
35
|
+
queryClient?: QueryClient;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
export function QraftSecureRequestFn({
|
|
39
|
+
children,
|
|
40
|
+
requestFn,
|
|
41
|
+
securitySchemes,
|
|
42
|
+
queryClient: inQueryClient,
|
|
43
|
+
}: QraftSecureRequestFnProps) {
|
|
44
|
+
const queryClient = useMemo(
|
|
45
|
+
() =>
|
|
46
|
+
inQueryClient ??
|
|
47
|
+
new QueryClient({
|
|
48
|
+
defaultOptions: {
|
|
49
|
+
queries: {
|
|
50
|
+
staleTime: 300_000,
|
|
51
|
+
gcTime: 300_000,
|
|
52
|
+
refetchOnWindowFocus: false,
|
|
53
|
+
refetchOnMount: false,
|
|
54
|
+
refetchOnReconnect: false,
|
|
55
|
+
},
|
|
56
|
+
},
|
|
57
|
+
}),
|
|
58
|
+
[inQueryClient]
|
|
59
|
+
);
|
|
60
|
+
|
|
61
|
+
useEffect(() => {
|
|
62
|
+
queryClient.mount();
|
|
63
|
+
return () => {
|
|
64
|
+
return void queryClient.unmount();
|
|
65
|
+
};
|
|
66
|
+
}, [queryClient]);
|
|
67
|
+
|
|
68
|
+
const secureRequestFn = useSecuritySchemeAuth({
|
|
69
|
+
securitySchemes,
|
|
70
|
+
requestFn,
|
|
71
|
+
queryClient,
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
return createElement(Fragment, {
|
|
75
|
+
children: children(secureRequestFn),
|
|
76
|
+
});
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
export const useSecuritySchemeAuth = ({
|
|
80
|
+
securitySchemes,
|
|
81
|
+
requestFn,
|
|
82
|
+
queryClient,
|
|
83
|
+
}: QraftSecureRequestFnBaseProps & {
|
|
84
|
+
queryClient: QueryClient;
|
|
85
|
+
}): RequestFn => {
|
|
86
|
+
useQueries(
|
|
87
|
+
{
|
|
88
|
+
queries: Object.entries(securitySchemes).map(([securitySchemeName]) => {
|
|
89
|
+
const queryKey: QueryKey = [securitySchemeName];
|
|
90
|
+
return {
|
|
91
|
+
enabled: Boolean(queryClient.getQueryData(queryKey)),
|
|
92
|
+
queryKey: queryKey as never,
|
|
93
|
+
queryFn: ({
|
|
94
|
+
signal,
|
|
95
|
+
}: QueryFunctionContext<[keyof typeof securitySchemes]>) => {
|
|
96
|
+
const securitySchemeHandler = securitySchemes[securitySchemeName];
|
|
97
|
+
return securitySchemeHandler({ signal, isRefreshing: true });
|
|
98
|
+
},
|
|
99
|
+
};
|
|
100
|
+
}),
|
|
101
|
+
},
|
|
102
|
+
queryClient
|
|
103
|
+
);
|
|
104
|
+
|
|
105
|
+
return useMemo(
|
|
106
|
+
() => createSecureRequestFn(securitySchemes, requestFn, queryClient),
|
|
107
|
+
[securitySchemes, requestFn, queryClient]
|
|
108
|
+
);
|
|
109
|
+
};
|
|
110
|
+
|
|
111
|
+
/**
|
|
112
|
+
* Create a secure `requestFn` that manages security schemes.
|
|
113
|
+
* It will automatically fetch and refresh tokens when needed
|
|
114
|
+
* using QueryClient and the provided security schemes.
|
|
115
|
+
*
|
|
116
|
+
* @param securitySchemes OpenAPI security schemes.
|
|
117
|
+
* @param requestFn Qraft `requestFn`
|
|
118
|
+
* @param queryClient QueryClient instance.
|
|
119
|
+
*/
|
|
120
|
+
export function createSecureRequestFn(
|
|
121
|
+
securitySchemes: SecuritySchemeHandlers<string>,
|
|
122
|
+
requestFn: RequestFn,
|
|
123
|
+
queryClient: QueryClient
|
|
124
|
+
): RequestFn {
|
|
125
|
+
return async function secureRequestFn(
|
|
126
|
+
schema: OperationSchema,
|
|
127
|
+
requestInfo: RequestFnInfo,
|
|
128
|
+
options?: RequestFnOptions
|
|
129
|
+
) {
|
|
130
|
+
const availableSecuritySchemes = Object.keys(securitySchemes) as Array<
|
|
131
|
+
keyof typeof securitySchemes
|
|
132
|
+
>;
|
|
133
|
+
const securitySchemeName = schema.security?.find(
|
|
134
|
+
(security): security is keyof typeof securitySchemes =>
|
|
135
|
+
availableSecuritySchemes.includes(security)
|
|
136
|
+
);
|
|
137
|
+
|
|
138
|
+
if (!securitySchemeName) {
|
|
139
|
+
return requestFn(schema, requestInfo, options);
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
const securitySchemeHandler = securitySchemes[securitySchemeName];
|
|
143
|
+
|
|
144
|
+
return requestFn(
|
|
145
|
+
schema,
|
|
146
|
+
await createSecureRequestInfo(
|
|
147
|
+
securitySchemeHandler,
|
|
148
|
+
[securitySchemeName],
|
|
149
|
+
requestInfo,
|
|
150
|
+
queryClient
|
|
151
|
+
),
|
|
152
|
+
options
|
|
153
|
+
);
|
|
154
|
+
};
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
/**
|
|
158
|
+
* Calculate the interval at which a token should be refreshed.
|
|
159
|
+
*/
|
|
160
|
+
function getJwtTokenRefreshInterval(token: string) {
|
|
161
|
+
const parsedToken = jwtDecode(token);
|
|
162
|
+
if (!parsedToken.iat || !parsedToken.exp) {
|
|
163
|
+
throw new Error("JWT token must contain both 'iat' and 'exp' fields.");
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
return (parsedToken.exp - parsedToken.iat) * 1000;
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
/**
|
|
170
|
+
* Refresh the token if it is about to expire
|
|
171
|
+
* @returns The string to be used as the `Authorization` header or the object to be used in the request.
|
|
172
|
+
*/
|
|
173
|
+
async function createSecureRequestInfo(
|
|
174
|
+
handler: SecuritySchemeHandler,
|
|
175
|
+
queryKey: QueryKey,
|
|
176
|
+
requestInfo: RequestFnInfo,
|
|
177
|
+
queryClient: QueryClient
|
|
178
|
+
): Promise<RequestFnInfo> {
|
|
179
|
+
const prevSecurityResult = queryClient.getQueryData<SecurityScheme>(queryKey);
|
|
180
|
+
|
|
181
|
+
const securityResult = await queryClient.fetchQuery({
|
|
182
|
+
queryKey,
|
|
183
|
+
queryFn: ({ signal }) =>
|
|
184
|
+
handler({
|
|
185
|
+
signal,
|
|
186
|
+
isRefreshing: Boolean(prevSecurityResult),
|
|
187
|
+
}),
|
|
188
|
+
});
|
|
189
|
+
|
|
190
|
+
if (!shallowEqualObjects(securityResult, prevSecurityResult)) {
|
|
191
|
+
const securityRefreshInterval = getSecurityRefreshInterval(securityResult);
|
|
192
|
+
|
|
193
|
+
if (securityRefreshInterval !== undefined && securityRefreshInterval > 0) {
|
|
194
|
+
// remove the already fetched query, before setting new defaults
|
|
195
|
+
queryClient.removeQueries({ queryKey, exact: true });
|
|
196
|
+
|
|
197
|
+
// set query new defaults (staleTime and gcTime)
|
|
198
|
+
setSecurityQueryDefaults(queryClient, queryKey, securityRefreshInterval);
|
|
199
|
+
|
|
200
|
+
// Set query data with the new token, since the old one was removed.
|
|
201
|
+
// New query data will follow the new defaults staleTime and gcTime.
|
|
202
|
+
queryClient.setQueryData(queryKey, securityResult);
|
|
203
|
+
}
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
const securityParameters = createSecureRequestParameters(securityResult);
|
|
207
|
+
|
|
208
|
+
if (!securityParameters) return requestInfo;
|
|
209
|
+
|
|
210
|
+
return {
|
|
211
|
+
...requestInfo,
|
|
212
|
+
parameters: {
|
|
213
|
+
...requestInfo.parameters,
|
|
214
|
+
[securityParameters.in]: {
|
|
215
|
+
[securityParameters.name]: securityParameters.value,
|
|
216
|
+
...requestInfo.parameters?.[securityParameters.in],
|
|
217
|
+
},
|
|
218
|
+
},
|
|
219
|
+
};
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
function setSecurityQueryDefaults(
|
|
223
|
+
queryClient: QueryClient,
|
|
224
|
+
queryKey: QueryKey,
|
|
225
|
+
refreshInterval: number
|
|
226
|
+
) {
|
|
227
|
+
// set staleTime and gcTime based on token lifetime
|
|
228
|
+
queryClient.setQueryDefaults(queryKey, {
|
|
229
|
+
// stale the token 90% before it expires
|
|
230
|
+
staleTime: isFinite(refreshInterval)
|
|
231
|
+
? refreshInterval * 0.9
|
|
232
|
+
: refreshInterval,
|
|
233
|
+
// garbage collect the token after it expires
|
|
234
|
+
gcTime: isFinite(refreshInterval) ? refreshInterval : refreshInterval,
|
|
235
|
+
// refetch the token 80% before it expires
|
|
236
|
+
refetchInterval: isFinite(refreshInterval)
|
|
237
|
+
? refreshInterval * 0.8
|
|
238
|
+
: refreshInterval,
|
|
239
|
+
// always refetch the token, even in the background
|
|
240
|
+
refetchIntervalInBackground: true,
|
|
241
|
+
});
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
function createSecureRequestParameters(securityResult: SecurityScheme) {
|
|
245
|
+
if (typeof securityResult === 'string' || 'token' in securityResult) {
|
|
246
|
+
return {
|
|
247
|
+
in: 'header',
|
|
248
|
+
name: 'Authorization',
|
|
249
|
+
value: `Bearer ${typeof securityResult === 'string' ? securityResult : securityResult.token}`,
|
|
250
|
+
} as const;
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
if ('credentials' in securityResult) {
|
|
254
|
+
return {
|
|
255
|
+
in: 'header',
|
|
256
|
+
name: 'Authorization',
|
|
257
|
+
value: `Basic ${securityResult.credentials}`,
|
|
258
|
+
} as const;
|
|
259
|
+
}
|
|
260
|
+
|
|
261
|
+
if ('in' in securityResult && securityResult.in !== 'cookie') {
|
|
262
|
+
return securityResult;
|
|
263
|
+
}
|
|
264
|
+
|
|
265
|
+
throw new Error(
|
|
266
|
+
'Security scheme must be a string, an object with a token property, an object with a credentials property, or an object with an in property that is not equal to "cookie".'
|
|
267
|
+
);
|
|
268
|
+
}
|
|
269
|
+
|
|
270
|
+
function getSecurityRefreshInterval(securityResult: SecurityScheme) {
|
|
271
|
+
if (typeof securityResult === 'string') {
|
|
272
|
+
return getJwtTokenRefreshInterval(securityResult);
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
if ('refreshInterval' in securityResult) {
|
|
276
|
+
return securityResult.refreshInterval;
|
|
277
|
+
}
|
|
278
|
+
}
|
|
279
|
+
|
|
280
|
+
/**
|
|
281
|
+
* @internal
|
|
282
|
+
*/
|
|
283
|
+
export function shallowEqualObjects(
|
|
284
|
+
newObj: Record<string, any> | string,
|
|
285
|
+
prevObj: Record<string, any> | string | undefined
|
|
286
|
+
) {
|
|
287
|
+
if (typeof newObj !== typeof prevObj) return false;
|
|
288
|
+
if (typeof newObj === 'string') return newObj === prevObj;
|
|
289
|
+
if (
|
|
290
|
+
typeof newObj !== 'object' ||
|
|
291
|
+
newObj === null ||
|
|
292
|
+
typeof prevObj !== 'object' ||
|
|
293
|
+
prevObj === null ||
|
|
294
|
+
prevObj === undefined
|
|
295
|
+
)
|
|
296
|
+
return false;
|
|
297
|
+
if (Object.keys(newObj).length !== Object.keys(prevObj).length) return false;
|
|
298
|
+
|
|
299
|
+
for (const key in newObj) {
|
|
300
|
+
if (!Object.prototype.hasOwnProperty.call(newObj, key)) return false;
|
|
301
|
+
if (newObj[key] !== prevObj[key]) return false;
|
|
302
|
+
}
|
|
303
|
+
return true;
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
type SecurityScheme =
|
|
307
|
+
| SecuritySchemeBearer
|
|
308
|
+
| SecuritySchemeBasic
|
|
309
|
+
| SecuritySchemeAPIKey
|
|
310
|
+
| SecuritySchemeCookie;
|
|
311
|
+
|
|
312
|
+
export type SecuritySchemeBearer =
|
|
313
|
+
| string /** JWT Bearer token. **/
|
|
314
|
+
| {
|
|
315
|
+
/** Refresh interval in milliseconds. */
|
|
316
|
+
refreshInterval: number;
|
|
317
|
+
/** Token to be used for authentication. */
|
|
318
|
+
token: string;
|
|
319
|
+
};
|
|
320
|
+
|
|
321
|
+
export interface SecuritySchemeBasic {
|
|
322
|
+
/** Credentials to be used for authentication. */
|
|
323
|
+
credentials: string;
|
|
324
|
+
|
|
325
|
+
/** Refresh interval in milliseconds. */
|
|
326
|
+
refreshInterval: number;
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
export type SecuritySchemeAPIKey = {
|
|
330
|
+
/** Where the secret should be placed. */
|
|
331
|
+
in: 'header' | 'query';
|
|
332
|
+
/** Name of the secret key. */
|
|
333
|
+
name: string;
|
|
334
|
+
/** Secret to be used for authentication. */
|
|
335
|
+
value: string;
|
|
336
|
+
/** Refresh interval in milliseconds. */
|
|
337
|
+
refreshInterval?: number;
|
|
338
|
+
};
|
|
339
|
+
|
|
340
|
+
export type SecuritySchemeCookie = {
|
|
341
|
+
/** Where the secret should be placed. */
|
|
342
|
+
in: 'cookie';
|
|
343
|
+
/** Refresh interval in milliseconds. */
|
|
344
|
+
refreshInterval?: number;
|
|
345
|
+
};
|
|
346
|
+
|
|
347
|
+
/**
|
|
348
|
+
* Type definition for a handler function that manages security schemes.
|
|
349
|
+
* This function is invoked when a token needs to be fetched or refreshed.
|
|
350
|
+
*
|
|
351
|
+
* @param props - The properties for the handler function.
|
|
352
|
+
* @param props.isRefreshing - A boolean indicating the state of the token.
|
|
353
|
+
* It's `false` on the initial "fetch token" request, and `true` if the token is stale or updating using `refreshInterval`.
|
|
354
|
+
* @param props.signal - An AbortSignal that can be used to abort the request.
|
|
355
|
+
*
|
|
356
|
+
* @returns A SecurityScheme, which contains the necessary data for authentication.
|
|
357
|
+
*/
|
|
358
|
+
type SecuritySchemeHandler = (props: {
|
|
359
|
+
isRefreshing: boolean;
|
|
360
|
+
signal: AbortSignal;
|
|
361
|
+
}) => SecurityScheme | Promise<SecurityScheme>;
|
|
362
|
+
|
|
363
|
+
export type SecuritySchemeHandlers<SecuritySchemeName extends string> = {
|
|
364
|
+
[key in SecuritySchemeName]: SecuritySchemeHandler;
|
|
365
|
+
};
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
import { describe, expect, it } from 'vitest';
|
|
2
|
+
|
|
3
|
+
import {
|
|
4
|
+
jwtDecode,
|
|
5
|
+
InvalidTokenError,
|
|
6
|
+
JwtPayload,
|
|
7
|
+
b64DecodeUnicode,
|
|
8
|
+
} from './index.js';
|
|
9
|
+
|
|
10
|
+
const token =
|
|
11
|
+
'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJmb28iOiJiYXIiLCJleHAiOjEzOTMyODY4OTMsImlhdCI6MTM5MzI2ODg5M30.4-iaDojEVl0pJQMjrbM1EzUIfAZgsbK_kgnVyVxFSVo';
|
|
12
|
+
|
|
13
|
+
describe('jwt-decode', () => {
|
|
14
|
+
it('should return default and custom claims', () => {
|
|
15
|
+
const decoded = jwtDecode<JwtPayload & { foo: string }>(token);
|
|
16
|
+
expect(decoded.exp).toEqual(1393286893);
|
|
17
|
+
expect(decoded.iat).toEqual(1393268893);
|
|
18
|
+
expect(decoded.foo).toEqual('bar');
|
|
19
|
+
});
|
|
20
|
+
|
|
21
|
+
it('should return header information', () => {
|
|
22
|
+
const decoded = jwtDecode(token, { header: true });
|
|
23
|
+
expect(decoded.typ).toEqual('JWT');
|
|
24
|
+
expect(decoded.alg).toEqual('HS256');
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
it('should work with utf8 tokens', () => {
|
|
28
|
+
const utf8Token =
|
|
29
|
+
'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiSm9zw6kiLCJpYXQiOjE0MjU2NDQ5NjZ9.1CfFtdGUPs6q8kT3OGQSVlhEMdbuX0HfNSqum0023a0';
|
|
30
|
+
const decoded = jwtDecode<JwtPayload & { name: string }>(utf8Token);
|
|
31
|
+
expect(decoded.name).toEqual('José');
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
it('should work with binary tokens', () => {
|
|
35
|
+
const binaryToken =
|
|
36
|
+
'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiSm9z6SIsImlhdCI6MTQyNTY0NDk2Nn0.cpnplCBxiw7Xqz5thkqs4Mo_dymvztnI0CI4BN0d1t8';
|
|
37
|
+
const decoded = jwtDecode<JwtPayload & { name: string }>(binaryToken);
|
|
38
|
+
expect(decoded.name).toEqual('José');
|
|
39
|
+
});
|
|
40
|
+
|
|
41
|
+
it('should work with double padding', () => {
|
|
42
|
+
const utf8Token =
|
|
43
|
+
'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Ikpvc8OpIiwiaWF0IjoxNTE2MjM5MDIyfQ.7A3F5SUH2gbBSYVon5mas_Y-KCrWojorKQg7UKGVEIA';
|
|
44
|
+
const decoded = jwtDecode<JwtPayload & { name: string }>(utf8Token);
|
|
45
|
+
expect(decoded.name).toEqual('José');
|
|
46
|
+
});
|
|
47
|
+
|
|
48
|
+
it('should work with single padding', () => {
|
|
49
|
+
const utf8Token =
|
|
50
|
+
'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Ikpvc8OpZSIsImlhdCI6MTUxNjIzOTAyMn0.tbjJzDAylkKSV0_YGR5xBJBlFK01C82nZPLIcA3JX1g';
|
|
51
|
+
const decoded = jwtDecode<JwtPayload & { name: string }>(utf8Token);
|
|
52
|
+
expect(decoded.name).toEqual('Josée');
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
it('should throw InvalidTokenError on not a string', () => {
|
|
56
|
+
const badToken = null;
|
|
57
|
+
expect(() => {
|
|
58
|
+
jwtDecode(badToken as unknown as string);
|
|
59
|
+
}).toThrow(InvalidTokenError);
|
|
60
|
+
});
|
|
61
|
+
|
|
62
|
+
it('should throw InvalidTokenError on string that is not a token', () => {
|
|
63
|
+
const badToken = 'foobar';
|
|
64
|
+
expect(() => {
|
|
65
|
+
jwtDecode(badToken);
|
|
66
|
+
}).toThrow(InvalidTokenError);
|
|
67
|
+
});
|
|
68
|
+
|
|
69
|
+
it('should throw InvalidTokenErrors when token is null', () => {
|
|
70
|
+
const badToken = null;
|
|
71
|
+
expect(() => {
|
|
72
|
+
jwtDecode(badToken as unknown as string, { header: true });
|
|
73
|
+
}).toThrow(
|
|
74
|
+
new InvalidTokenError('Invalid token specified: must be a string')
|
|
75
|
+
);
|
|
76
|
+
});
|
|
77
|
+
|
|
78
|
+
it('should throw InvalidTokenErrors when missing part #1', () => {
|
|
79
|
+
const badToken = '.FAKE_TOKEN';
|
|
80
|
+
expect(() => {
|
|
81
|
+
jwtDecode(badToken, { header: true });
|
|
82
|
+
}).toThrow(/Invalid token specified: invalid json for part #1/);
|
|
83
|
+
});
|
|
84
|
+
|
|
85
|
+
it('should throw InvalidTokenErrors when part #1 is not valid base64', () => {
|
|
86
|
+
const badToken = 'TOKEN';
|
|
87
|
+
expect(() => {
|
|
88
|
+
jwtDecode(badToken, { header: true });
|
|
89
|
+
}).toThrow(/Invalid token specified: invalid base64 for part #1/);
|
|
90
|
+
});
|
|
91
|
+
|
|
92
|
+
it('should throw InvalidTokenErrors when part #1 is not valid JSON', () => {
|
|
93
|
+
const badToken = 'FAKE.TOKEN';
|
|
94
|
+
expect(() => {
|
|
95
|
+
jwtDecode(badToken, { header: true });
|
|
96
|
+
}).toThrow(/Invalid token specified: invalid json for part #1/);
|
|
97
|
+
});
|
|
98
|
+
|
|
99
|
+
it('should throw InvalidTokenErrors when missing part #2', () => {
|
|
100
|
+
const badToken = 'FAKE_TOKEN';
|
|
101
|
+
expect(() => {
|
|
102
|
+
jwtDecode(badToken);
|
|
103
|
+
}).toThrow(
|
|
104
|
+
new InvalidTokenError('Invalid token specified: missing part #2')
|
|
105
|
+
);
|
|
106
|
+
});
|
|
107
|
+
|
|
108
|
+
it('should throw InvalidTokenErrors when part #2 is not valid base64', () => {
|
|
109
|
+
const badToken = 'FAKE.TOKEN';
|
|
110
|
+
expect(() => {
|
|
111
|
+
jwtDecode(badToken);
|
|
112
|
+
}).toThrow(/Invalid token specified: invalid base64 for part #2/);
|
|
113
|
+
});
|
|
114
|
+
|
|
115
|
+
it('should throw InvalidTokenErrors when part #2 is not valid JSON', () => {
|
|
116
|
+
const badToken = 'FAKE.TOKEN2';
|
|
117
|
+
expect(() => {
|
|
118
|
+
jwtDecode(badToken);
|
|
119
|
+
}).toThrow(/Invalid token specified: invalid json for part #2/);
|
|
120
|
+
});
|
|
121
|
+
});
|
|
122
|
+
|
|
123
|
+
describe('decodeBase64', () => {
|
|
124
|
+
it('decodes base64', () => {
|
|
125
|
+
expect(b64DecodeUnicode('aGVsbG8=')).toEqual('hello');
|
|
126
|
+
});
|
|
127
|
+
|
|
128
|
+
it('decodes base64 non latin characters', () => {
|
|
129
|
+
expect(b64DecodeUnicode('5L2g5aW9')).toEqual('你好');
|
|
130
|
+
});
|
|
131
|
+
});
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
export interface JwtDecodeOptions {
|
|
2
|
+
header?: boolean;
|
|
3
|
+
}
|
|
4
|
+
|
|
5
|
+
export interface JwtHeader {
|
|
6
|
+
typ?: string;
|
|
7
|
+
alg?: string;
|
|
8
|
+
kid?: string;
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
export interface JwtPayload {
|
|
12
|
+
iss?: string;
|
|
13
|
+
sub?: string;
|
|
14
|
+
aud?: string[] | string;
|
|
15
|
+
exp?: number;
|
|
16
|
+
nbf?: number;
|
|
17
|
+
iat?: number;
|
|
18
|
+
jti?: string;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
export class InvalidTokenError extends Error {}
|
|
22
|
+
|
|
23
|
+
InvalidTokenError.prototype.name = 'InvalidTokenError';
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* Decode a base64 string to a UTF-8 string.
|
|
27
|
+
* Could be used in Node.js or in the browser.
|
|
28
|
+
*/
|
|
29
|
+
export function b64DecodeUnicode(data: string): string {
|
|
30
|
+
if (typeof atob === 'function')
|
|
31
|
+
return decodeURIComponent(Array.from(atob(data), byteToPercent).join(''));
|
|
32
|
+
|
|
33
|
+
return Buffer.from(data, 'base64').toString('utf-8');
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
function base64UrlDecode(str: string) {
|
|
37
|
+
let output = str.replace(/-/g, '+').replace(/_/g, '/');
|
|
38
|
+
switch (output.length % 4) {
|
|
39
|
+
case 0:
|
|
40
|
+
break;
|
|
41
|
+
case 2:
|
|
42
|
+
output += '==';
|
|
43
|
+
break;
|
|
44
|
+
case 3:
|
|
45
|
+
output += '=';
|
|
46
|
+
break;
|
|
47
|
+
default:
|
|
48
|
+
throw new Error('base64 string is not of the correct length');
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
try {
|
|
52
|
+
return b64DecodeUnicode(output);
|
|
53
|
+
} catch (err) {
|
|
54
|
+
return atob(output);
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
export function jwtDecode<T = JwtHeader>(
|
|
59
|
+
token: string,
|
|
60
|
+
options: JwtDecodeOptions & { header: true }
|
|
61
|
+
): T;
|
|
62
|
+
export function jwtDecode<T = JwtPayload>(
|
|
63
|
+
token: string,
|
|
64
|
+
options?: JwtDecodeOptions
|
|
65
|
+
): T;
|
|
66
|
+
export function jwtDecode<T = JwtHeader | JwtPayload>(
|
|
67
|
+
token: string,
|
|
68
|
+
options?: JwtDecodeOptions
|
|
69
|
+
): T {
|
|
70
|
+
if (typeof token !== 'string') {
|
|
71
|
+
throw new InvalidTokenError('Invalid token specified: must be a string');
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
options ||= {};
|
|
75
|
+
|
|
76
|
+
const pos = options.header === true ? 0 : 1;
|
|
77
|
+
const part = token.split('.')[pos];
|
|
78
|
+
|
|
79
|
+
if (typeof part !== 'string') {
|
|
80
|
+
throw new InvalidTokenError(
|
|
81
|
+
`Invalid token specified: missing part #${pos + 1}`
|
|
82
|
+
);
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
let decoded: string;
|
|
86
|
+
try {
|
|
87
|
+
decoded = base64UrlDecode(part);
|
|
88
|
+
} catch (e) {
|
|
89
|
+
throw new InvalidTokenError(
|
|
90
|
+
`Invalid token specified: invalid base64 for part #${pos + 1} (${(e as Error).message})`
|
|
91
|
+
);
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
try {
|
|
95
|
+
return JSON.parse(decoded) as T;
|
|
96
|
+
} catch (e) {
|
|
97
|
+
throw new InvalidTokenError(
|
|
98
|
+
`Invalid token specified: invalid json for part #${pos + 1} (${(e as Error).message})`
|
|
99
|
+
);
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
function byteToPercent(b: string) {
|
|
104
|
+
return `%${`00${b.charCodeAt(0).toString(16)}`.slice(-2)}`;
|
|
105
|
+
}
|
package/src/lib/requestFn.ts
CHANGED
|
@@ -141,7 +141,7 @@ function getQueryString(params: Record<string, any>): string {
|
|
|
141
141
|
return '';
|
|
142
142
|
}
|
|
143
143
|
|
|
144
|
-
function mergeHeaders(...allHeaders: (HeadersOptions | undefined)[]) {
|
|
144
|
+
export function mergeHeaders(...allHeaders: (HeadersOptions | undefined)[]) {
|
|
145
145
|
const headers = new Headers();
|
|
146
146
|
|
|
147
147
|
for (const headerSet of allHeaders) {
|
|
@@ -300,6 +300,8 @@ export interface OperationSchema {
|
|
|
300
300
|
* @example application/json
|
|
301
301
|
*/
|
|
302
302
|
readonly mediaType?: string;
|
|
303
|
+
|
|
304
|
+
readonly security?: string[];
|
|
303
305
|
}
|
|
304
306
|
|
|
305
307
|
export interface RequestFnPayload {
|
|
@@ -337,7 +339,7 @@ export interface RequestFnPayload {
|
|
|
337
339
|
signal?: AbortSignal | null;
|
|
338
340
|
}
|
|
339
341
|
|
|
340
|
-
interface RequestFnInfo
|
|
342
|
+
export interface RequestFnInfo
|
|
341
343
|
extends RequestFnPayload,
|
|
342
344
|
Omit<RequestInit, 'headers' | 'method' | 'body' | 'signal'> {
|
|
343
345
|
/**
|