@yu-packages/request 0.0.0-stage → 1.0.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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2021-present Archer
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,21 @@
1
- # Temporary Holding Version
1
+ # @yu-packages/request
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ UI-independent Axios client for shared request behavior.
4
+
5
+ ```ts
6
+ import { createRequest } from '@yu-packages/request'
7
+
8
+ const request = createRequest({
9
+ axiosConfig: { baseURL: '/api', timeout: 60_000 },
10
+ beforeRequest: (config) => ({
11
+ ...config,
12
+ headers: { ...config.headers, Authorization: getToken() }
13
+ }),
14
+ transformResponse: (response) => response.data,
15
+ onError: (error) => reportError(error)
16
+ })
17
+
18
+ const user = await request.get<User>({ url: '/users/1' })
19
+ ```
20
+
21
+ Use `AbortSignal` for local cancellation, `cancelRequest` for a request key and `cancelAllRequest` for application-wide teardown. Authentication stores, UI messages, business success codes and logout behavior belong to the consuming application.
@@ -0,0 +1,28 @@
1
+ import { CreateAxiosDefaults, AxiosRequestConfig, AxiosResponse, AxiosInstance } from 'axios';
2
+ export { AxiosError, AxiosRequestConfig, AxiosResponse, InternalAxiosRequestConfig, RawAxiosRequestHeaders, isCancel } from 'axios';
3
+
4
+ type MaybePromise<Value> = Value | Promise<Value>;
5
+ interface RequestConfig<Data = unknown> extends AxiosRequestConfig<Data> {
6
+ requestKey?: string;
7
+ }
8
+ interface CreateRequestOptions {
9
+ axiosConfig?: CreateAxiosDefaults;
10
+ beforeRequest?: <Data>(config: RequestConfig<Data>) => MaybePromise<RequestConfig<Data>>;
11
+ transformResponse?: (response: AxiosResponse) => MaybePromise<unknown>;
12
+ onError?: (error: unknown) => MaybePromise<void>;
13
+ getRequestKey?: <Data>(config: RequestConfig<Data>) => string;
14
+ }
15
+ interface RequestClient {
16
+ instance: AxiosInstance;
17
+ request: <Response = unknown, Data = unknown>(config: RequestConfig<Data>) => Promise<Response>;
18
+ get: <Response = unknown>(config: RequestConfig) => Promise<Response>;
19
+ post: <Response = unknown, Data = unknown>(config: RequestConfig<Data>) => Promise<Response>;
20
+ put: <Response = unknown, Data = unknown>(config: RequestConfig<Data>) => Promise<Response>;
21
+ delete: <Response = unknown, Data = unknown>(config: RequestConfig<Data>) => Promise<Response>;
22
+ cancelRequest: (key: string | readonly string[]) => void;
23
+ cancelAllRequest: () => void;
24
+ }
25
+ declare const createRequest: (options?: CreateRequestOptions) => RequestClient;
26
+
27
+ export { createRequest };
28
+ export type { CreateRequestOptions, RequestClient, RequestConfig };
package/dist/index.js ADDED
@@ -0,0 +1,77 @@
1
+ // src/index.ts
2
+ import axios from "axios";
3
+ import { isCancel } from "axios";
4
+ var createRequest = (options = {}) => {
5
+ const instance = axios.create(options.axiosConfig);
6
+ const controllers = /* @__PURE__ */ new Set();
7
+ const controllersByKey = /* @__PURE__ */ new Map();
8
+ const track = (controller, key) => {
9
+ controllers.add(controller);
10
+ if (!key) return;
11
+ const keyedControllers = controllersByKey.get(key) ?? /* @__PURE__ */ new Set();
12
+ keyedControllers.add(controller);
13
+ controllersByKey.set(key, keyedControllers);
14
+ };
15
+ const untrack = (controller, key) => {
16
+ controllers.delete(controller);
17
+ if (!key) return;
18
+ const keyedControllers = controllersByKey.get(key);
19
+ keyedControllers?.delete(controller);
20
+ if (keyedControllers?.size === 0) controllersByKey.delete(key);
21
+ };
22
+ const request = async (config) => {
23
+ let prepared = config;
24
+ try {
25
+ prepared = options.beforeRequest ? await options.beforeRequest(config) : config;
26
+ } catch (error) {
27
+ await options.onError?.(error);
28
+ throw error;
29
+ }
30
+ const key = prepared.requestKey ?? options.getRequestKey?.(prepared) ?? prepared.url ?? "";
31
+ const externalSignal = prepared.signal;
32
+ const controller = new AbortController();
33
+ const abort = () => controller.abort(externalSignal?.reason);
34
+ if (externalSignal?.aborted) abort();
35
+ else externalSignal?.addEventListener("abort", abort, { once: true });
36
+ const axiosConfig = { ...prepared };
37
+ delete axiosConfig.requestKey;
38
+ track(controller, key);
39
+ try {
40
+ const response = await instance.request({ ...axiosConfig, signal: controller.signal });
41
+ return options.transformResponse ? await options.transformResponse(response) : response.data;
42
+ } catch (error) {
43
+ await options.onError?.(error);
44
+ throw error;
45
+ } finally {
46
+ externalSignal?.removeEventListener("abort", abort);
47
+ untrack(controller, key);
48
+ }
49
+ };
50
+ const cancelRequest = (key) => {
51
+ const keys = Array.isArray(key) ? key : [key];
52
+ keys.forEach((item) => {
53
+ controllersByKey.get(item)?.forEach((controller) => controller.abort());
54
+ controllersByKey.delete(item);
55
+ });
56
+ };
57
+ const cancelAllRequest = () => {
58
+ controllers.forEach((controller) => controller.abort());
59
+ controllers.clear();
60
+ controllersByKey.clear();
61
+ };
62
+ return {
63
+ instance,
64
+ request,
65
+ get: (config) => request({ ...config, method: "get" }),
66
+ post: (config) => request({ ...config, method: "post" }),
67
+ put: (config) => request({ ...config, method: "put" }),
68
+ delete: (config) => request({ ...config, method: "delete" }),
69
+ cancelRequest,
70
+ cancelAllRequest
71
+ };
72
+ };
73
+ export {
74
+ createRequest,
75
+ isCancel
76
+ };
77
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/index.ts"],"sourcesContent":["import axios, {\n type AxiosInstance,\n type AxiosRequestConfig,\n type AxiosResponse,\n type CreateAxiosDefaults\n} from 'axios'\n\ntype MaybePromise<Value> = Value | Promise<Value>\n\nexport interface RequestConfig<Data = unknown> extends AxiosRequestConfig<Data> {\n requestKey?: string\n}\n\nexport interface CreateRequestOptions {\n axiosConfig?: CreateAxiosDefaults\n beforeRequest?: <Data>(config: RequestConfig<Data>) => MaybePromise<RequestConfig<Data>>\n transformResponse?: (response: AxiosResponse) => MaybePromise<unknown>\n onError?: (error: unknown) => MaybePromise<void>\n getRequestKey?: <Data>(config: RequestConfig<Data>) => string\n}\n\nexport interface RequestClient {\n instance: AxiosInstance\n request: <Response = unknown, Data = unknown>(config: RequestConfig<Data>) => Promise<Response>\n get: <Response = unknown>(config: RequestConfig) => Promise<Response>\n post: <Response = unknown, Data = unknown>(config: RequestConfig<Data>) => Promise<Response>\n put: <Response = unknown, Data = unknown>(config: RequestConfig<Data>) => Promise<Response>\n delete: <Response = unknown, Data = unknown>(config: RequestConfig<Data>) => Promise<Response>\n cancelRequest: (key: string | readonly string[]) => void\n cancelAllRequest: () => void\n}\n\nexport const createRequest = (options: CreateRequestOptions = {}): RequestClient => {\n const instance = axios.create(options.axiosConfig)\n const controllers = new Set<AbortController>()\n const controllersByKey = new Map<string, Set<AbortController>>()\n\n const track = (controller: AbortController, key: string) => {\n controllers.add(controller)\n if (!key) return\n const keyedControllers = controllersByKey.get(key) ?? new Set<AbortController>()\n keyedControllers.add(controller)\n controllersByKey.set(key, keyedControllers)\n }\n\n const untrack = (controller: AbortController, key: string) => {\n controllers.delete(controller)\n if (!key) return\n const keyedControllers = controllersByKey.get(key)\n keyedControllers?.delete(controller)\n if (keyedControllers?.size === 0) controllersByKey.delete(key)\n }\n\n const request = async <Response = unknown, Data = unknown>(\n config: RequestConfig<Data>\n ): Promise<Response> => {\n let prepared: RequestConfig<Data> = config\n try {\n prepared = options.beforeRequest ? await options.beforeRequest(config) : config\n } catch (error) {\n await options.onError?.(error)\n throw error\n }\n\n const key = prepared.requestKey ?? options.getRequestKey?.(prepared) ?? prepared.url ?? ''\n const externalSignal = prepared.signal as AbortSignal | undefined\n const controller = new AbortController()\n const abort = () => controller.abort(externalSignal?.reason)\n\n if (externalSignal?.aborted) abort()\n else externalSignal?.addEventListener('abort', abort, { once: true })\n\n const axiosConfig = { ...prepared }\n delete axiosConfig.requestKey\n track(controller, key)\n try {\n const response = await instance.request({ ...axiosConfig, signal: controller.signal })\n return (\n options.transformResponse ? await options.transformResponse(response) : response.data\n ) as Response\n } catch (error) {\n await options.onError?.(error)\n throw error\n } finally {\n externalSignal?.removeEventListener('abort', abort)\n untrack(controller, key)\n }\n }\n\n const cancelRequest = (key: string | readonly string[]) => {\n const keys = Array.isArray(key) ? key : [key]\n keys.forEach((item) => {\n controllersByKey.get(item)?.forEach((controller) => controller.abort())\n controllersByKey.delete(item)\n })\n }\n\n const cancelAllRequest = () => {\n controllers.forEach((controller) => controller.abort())\n controllers.clear()\n controllersByKey.clear()\n }\n\n return {\n instance,\n request,\n get: (config) => request({ ...config, method: 'get' }),\n post: (config) => request({ ...config, method: 'post' }),\n put: (config) => request({ ...config, method: 'put' }),\n delete: (config) => request({ ...config, method: 'delete' }),\n cancelRequest,\n cancelAllRequest\n }\n}\n\nexport type {\n AxiosError,\n AxiosRequestConfig,\n AxiosResponse,\n InternalAxiosRequestConfig,\n RawAxiosRequestHeaders\n} from 'axios'\nexport { isCancel } from 'axios'\n"],"mappings":";AAAA,OAAO,WAKA;AAqHP,SAAS,gBAAgB;AA1FlB,IAAM,gBAAgB,CAAC,UAAgC,CAAC,MAAqB;AAClF,QAAM,WAAW,MAAM,OAAO,QAAQ,WAAW;AACjD,QAAM,cAAc,oBAAI,IAAqB;AAC7C,QAAM,mBAAmB,oBAAI,IAAkC;AAE/D,QAAM,QAAQ,CAAC,YAA6B,QAAgB;AAC1D,gBAAY,IAAI,UAAU;AAC1B,QAAI,CAAC,IAAK;AACV,UAAM,mBAAmB,iBAAiB,IAAI,GAAG,KAAK,oBAAI,IAAqB;AAC/E,qBAAiB,IAAI,UAAU;AAC/B,qBAAiB,IAAI,KAAK,gBAAgB;AAAA,EAC5C;AAEA,QAAM,UAAU,CAAC,YAA6B,QAAgB;AAC5D,gBAAY,OAAO,UAAU;AAC7B,QAAI,CAAC,IAAK;AACV,UAAM,mBAAmB,iBAAiB,IAAI,GAAG;AACjD,sBAAkB,OAAO,UAAU;AACnC,QAAI,kBAAkB,SAAS,EAAG,kBAAiB,OAAO,GAAG;AAAA,EAC/D;AAEA,QAAM,UAAU,OACd,WACsB;AACtB,QAAI,WAAgC;AACpC,QAAI;AACF,iBAAW,QAAQ,gBAAgB,MAAM,QAAQ,cAAc,MAAM,IAAI;AAAA,IAC3E,SAAS,OAAO;AACd,YAAM,QAAQ,UAAU,KAAK;AAC7B,YAAM;AAAA,IACR;AAEA,UAAM,MAAM,SAAS,cAAc,QAAQ,gBAAgB,QAAQ,KAAK,SAAS,OAAO;AACxF,UAAM,iBAAiB,SAAS;AAChC,UAAM,aAAa,IAAI,gBAAgB;AACvC,UAAM,QAAQ,MAAM,WAAW,MAAM,gBAAgB,MAAM;AAE3D,QAAI,gBAAgB,QAAS,OAAM;AAAA,QAC9B,iBAAgB,iBAAiB,SAAS,OAAO,EAAE,MAAM,KAAK,CAAC;AAEpE,UAAM,cAAc,EAAE,GAAG,SAAS;AAClC,WAAO,YAAY;AACnB,UAAM,YAAY,GAAG;AACrB,QAAI;AACF,YAAM,WAAW,MAAM,SAAS,QAAQ,EAAE,GAAG,aAAa,QAAQ,WAAW,OAAO,CAAC;AACrF,aACE,QAAQ,oBAAoB,MAAM,QAAQ,kBAAkB,QAAQ,IAAI,SAAS;AAAA,IAErF,SAAS,OAAO;AACd,YAAM,QAAQ,UAAU,KAAK;AAC7B,YAAM;AAAA,IACR,UAAE;AACA,sBAAgB,oBAAoB,SAAS,KAAK;AAClD,cAAQ,YAAY,GAAG;AAAA,IACzB;AAAA,EACF;AAEA,QAAM,gBAAgB,CAAC,QAAoC;AACzD,UAAM,OAAO,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC,GAAG;AAC5C,SAAK,QAAQ,CAAC,SAAS;AACrB,uBAAiB,IAAI,IAAI,GAAG,QAAQ,CAAC,eAAe,WAAW,MAAM,CAAC;AACtE,uBAAiB,OAAO,IAAI;AAAA,IAC9B,CAAC;AAAA,EACH;AAEA,QAAM,mBAAmB,MAAM;AAC7B,gBAAY,QAAQ,CAAC,eAAe,WAAW,MAAM,CAAC;AACtD,gBAAY,MAAM;AAClB,qBAAiB,MAAM;AAAA,EACzB;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,KAAK,CAAC,WAAW,QAAQ,EAAE,GAAG,QAAQ,QAAQ,MAAM,CAAC;AAAA,IACrD,MAAM,CAAC,WAAW,QAAQ,EAAE,GAAG,QAAQ,QAAQ,OAAO,CAAC;AAAA,IACvD,KAAK,CAAC,WAAW,QAAQ,EAAE,GAAG,QAAQ,QAAQ,MAAM,CAAC;AAAA,IACrD,QAAQ,CAAC,WAAW,QAAQ,EAAE,GAAG,QAAQ,QAAQ,SAAS,CAAC;AAAA,IAC3D;AAAA,IACA;AAAA,EACF;AACF;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,35 @@
1
1
  {
2
2
  "name": "@yu-packages/request",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
3
+ "version": "1.0.0",
4
+ "description": "UI-independent Axios request client",
5
+ "type": "module",
6
+ "main": "./dist/index.js",
7
+ "module": "./dist/index.js",
8
+ "types": "./dist/index.d.ts",
9
+ "exports": {
10
+ ".": {
11
+ "import": "./dist/index.js",
12
+ "types": "./dist/index.d.ts"
13
+ }
14
+ },
15
+ "files": [
16
+ "dist"
17
+ ],
18
+ "sideEffects": false,
19
+ "dependencies": {
20
+ "axios": "^1.19.0"
21
+ },
22
+ "devDependencies": {
23
+ "tsup": "^9.0.0",
24
+ "typescript": "npm:@typescript/typescript6@^6.0.2"
25
+ },
26
+ "publishConfig": {
27
+ "access": "public"
28
+ },
29
+ "license": "MIT",
30
+ "scripts": {
31
+ "build": "tsup src/index.ts --format esm --dts --sourcemap --clean",
32
+ "typecheck": "tsc6 --noEmit -p tsconfig.json",
33
+ "test": "pnpm --workspace-root exec esno packages/request/test/request.test.ts"
34
+ }
6
35
  }