@chzky/reqwest 0.0.1 → 0.1.0

package/esm/lib/utils/request/baseConf.js

@@ -0,0 +1,37 @@
+import { Ok } from '@chzky/core';
+/** ## `header` : 修改请求头数据
+@param head `AxiosRequestHeaders` - 请求头数据
+@type `Interceptor` - `Request`
+@category `Request`
+ */
+export function header(head) {
+    return conf => {
+        for (const key in head) {
+            if (Object.hasOwn(head, key))
+                conf.headers.set(String(key), head[key]);
+        }
+        return Ok();
+    };
+}
+/** ## `response_type` : 修改响应数据类型
+@param type `ResponseType` - 响应数据类型
+@type `Interceptor` - `Request`
+@category `Request`
+*/
+export function response_type(type) {
+    return conf => {
+        conf.responseType = type;
+        return Ok();
+    };
+}
+/** ## `timeout` : 修改请求超时时间
+@param time `PositiveInteger<N>` - 请求超时时间
+@type `Interceptor` - `Request`
+@category `Request`
+*/
+export function timeout(time) {
+    return conf => {
+        conf.timeout = time;
+        return Ok();
+    };
+}

package/esm/lib/utils/request/factors.d.ts

@@ -0,0 +1,30 @@
+import type { Fn, JsonXObject, zod } from '@chzky/core';
+import type { RequestInterceptor } from '../../../mod.js';
+import { CheckingError } from '@chzky/core';
+type Methods = 'get' | 'post' | 'put' | 'delete' | 'form';
+/** ## `restful_request` : `url配置` + `类型校验` + `数据输入`
++ 对于`get`请求 , data传数据到`query`上
++ 对于`post`|`put`|`delete`|`form`请求 , data传数据到`body`上
+@example Usage
+```ts
+// GET请求 - 验证
+const get_user = restful_request('get', '/api/users', z.object({ id: z.number() }))
+get_user({ id: 1 }) // params: { id: 1 }
+
+// POST请求 - 验证
+const create_user = restful_request('post', '/api/users', z.object({ name: z.string() }))
+create_user({ name: 'john' }) // body: { name: 'john' }
+
+// PUT请求 - 无验证
+const update_user = restful_request('put', '/api/users')
+update_user({ name: 'john' }) // body: { name: 'john' }
+
+// 表单请求 - 无验证
+const upload = restful_request('form', '/api/upload')
+upload(new FormData()) // body: FormData
+```
+@cataegory Reqwest - Helper
+ */
+export declare function restful_request<T extends JsonXObject & Record<string | number, string | Blob> = never>(method: Methods, url: string, validate?: zod.Schema<T>): Fn<T, RequestInterceptor<T extends never ? never : CheckingError>>;
+export {};
+//# sourceMappingURL=factors.d.ts.map

package/esm/lib/utils/request/factors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factors.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/request/factors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AACvD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAEzD,OAAO,EAAE,aAAa,EAAS,MAAM,aAAa,CAAA;AAGlD,KAAK,OAAO,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAA;AAGzD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,eAAe,CAC9B,CAAC,SAAS,WAAW,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,GAAG,KAAK,EAEtE,MAAM,EAAE,OAAO,EACf,GAAG,EAAE,MAAM,EACX,QAAQ,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GACtB,EAAE,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,GAAG,aAAa,CAAC,CAAC,CAYpE"}

package/esm/lib/utils/request/factors.js

@@ -0,0 +1,39 @@
+import { CheckingError, match } from '@chzky/core';
+import { del, form, get, input_validate, merge_request, post, put } from '../../../mod.js';
+const ERROR_MSG = `param checktype must be 'data' or 'params`;
+/** ## `restful_request` : `url配置` + `类型校验` + `数据输入`
++ 对于`get`请求 , data传数据到`query`上
++ 对于`post`|`put`|`delete`|`form`请求 , data传数据到`body`上
+@example Usage
+```ts
+// GET请求 - 验证
+const get_user = restful_request('get', '/api/users', z.object({ id: z.number() }))
+get_user({ id: 1 }) // params: { id: 1 }
+
+// POST请求 - 验证
+const create_user = restful_request('post', '/api/users', z.object({ name: z.string() }))
+create_user({ name: 'john' }) // body: { name: 'john' }
+
+// PUT请求 - 无验证
+const update_user = restful_request('put', '/api/users')
+update_user({ name: 'john' }) // body: { name: 'john' }
+
+// 表单请求 - 无验证
+const upload = restful_request('form', '/api/upload')
+upload(new FormData()) // body: FormData
+```
+@cataegory Reqwest - Helper
+ */
+export function restful_request(method, url, validate) {
+    return ((data) => {
+        const METHOD = match(method)
+            .case('delete', del)
+            .case('get', get)
+            .case('post', post)
+            .case('put', put)
+            .case('form', form)
+            .done()
+            .expect(CheckingError.new(ERROR_MSG));
+        return validate ? merge_request(METHOD(url, data), input_validate(validate)) : METHOD(url, data);
+    });
+}

package/esm/lib/{helper → utils}/request/input.d.ts

@@ -1,11 +1,12 @@
-import { CheckingError, type zod } from '@chzky/fp';
+import type { zod } from '@chzky/core';
 import type { RequestInterceptor } from '../../../mod.js';
-/** ## `input` : 使用`zod`对输入的data数据进行校验
+import { CheckingError } from '@chzky/core';
+/** ## `input_validate` : 使用`zod`对输入的data数据进行解析校验(使用`zod.parse`)
 + 该方法会返回一个`RequestInterceptor`拦截器,如果校验失败会返回`CheckingError`
 @param schema `zod.Schema<unknown>` - 校验规则
 @param [checktype] `'data' | 'params'` - 校验类型,如果是`get`请求则默认为`params`,其他类型的请求默认为`data`,
 @type `Interceptor` - `Request`
 @category `Request`
 */
-export declare function input(schema: zod.Schema<unknown>, checktype?: 'data' | 'params'): RequestInterceptor<CheckingError>;
+export declare function input_validate(schema: zod.Schema<unknown>, checktype?: 'data' | 'params'): RequestInterceptor<CheckingError>;
 //# sourceMappingURL=input.d.ts.map

package/esm/lib/utils/request/input.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"input.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/request/input.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AACtC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAEzD,OAAO,EAAE,aAAa,EAAM,MAAM,aAAa,CAAA;AAI/C;;;;;;EAME;AACF,wBAAgB,cAAc,CAC7B,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,EAC3B,SAAS,CAAC,EAAE,MAAM,GAAG,QAAQ,GAC3B,kBAAkB,CAAC,aAAa,CAAC,CAYnC"}

package/esm/lib/utils/request/input.js

@@ -0,0 +1,24 @@
+import { CheckingError, Ok } from '@chzky/core';
+const ERROR_MSG = `param checktype must be 'data' or 'params'`;
+/** ## `input_validate` : 使用`zod`对输入的data数据进行解析校验(使用`zod.parse`)
++ 该方法会返回一个`RequestInterceptor`拦截器,如果校验失败会返回`CheckingError`
+@param schema `zod.Schema<unknown>` - 校验规则
+@param [checktype] `'data' | 'params'` - 校验类型,如果是`get`请求则默认为`params`,其他类型的请求默认为`data`,
+@type `Interceptor` - `Request`
+@category `Request`
+*/
+export function input_validate(schema, checktype) {
+    return conf => {
+        conf.timeout;
+        const ct = checktype || conf.method === 'get' ? 'params' : 'data';
+        if (ct !== 'data' && ct !== 'params')
+            return CheckingError.err(ERROR_MSG);
+        try {
+            schema.parse(ct === 'data' ? conf.data : conf.params);
+            return Ok();
+        }
+        catch (e) {
+            return CheckingError.err(e);
+        }
+    };
+}

package/esm/lib/utils/request/mod.d.ts

@@ -0,0 +1,7 @@
+export * from './baseConf.js';
+export * from './factors.js';
+export * from './input.js';
+export * from './process.js';
+export * from './RESTful.js';
+export * from './wait.js';
+//# sourceMappingURL=mod.d.ts.map

package/esm/lib/utils/request/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/request/mod.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,cAAc,CAAA;AAC5B,cAAc,cAAc,CAAA;AAC5B,cAAc,WAAW,CAAA"}

package/esm/lib/utils/request/mod.js

@@ -0,0 +1,6 @@
+export * from './baseConf.js'; /* 提供基础配置 */
+export * from './factors.js'; /* 请求集合 */
+export * from './input.js'; /* 请求参数校验 */
+export * from './process.js'; /* 进度 */
+export * from './RESTful.js'; /* 提供restful配置 */
+export * from './wait.js'; /* 请求等待 */

package/esm/lib/utils/request/process.d.ts

@@ -0,0 +1,16 @@
+import { RequestInterceptor } from '../../../mod.js';
+/** ## `upload_process` : 上传进度查询(浏览器专属)
++ 进度只保留两位小数,即`xx.yy%`
++ 存在两种情况,进度不可计算时,返回`-1%`
+  + `event.lengthComputable`为`false` (长度不可计算)
+  + `event.total`为`0`(数据的总大小不可知)
+*/
+export default function upload_process(progress: (percent: number) => void): RequestInterceptor<never>;
+/** ## `download_process` : 下载进度查询(浏览器专属)
++ 进度只保留两位小数,即`xx.yy%`
++ 存在两种情况,进度不可计算时,返回`-1%`
+  + `event.lengthComputable`为`false` (长度不可计算)
+  + `event.total`为`0`(数据的总大小不可知)
+*/
+export declare function download_process(progress: (percent: number) => void): RequestInterceptor<never>;
+//# sourceMappingURL=process.d.ts.map

package/esm/lib/utils/request/process.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"process.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/request/process.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAEpD;;;;;EAKE;AACF,MAAM,CAAC,OAAO,UAAU,cAAc,CACrC,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,GACjC,kBAAkB,CAAC,KAAK,CAAC,CAS3B;AAED;;;;;EAKE;AACF,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAU/F"}

package/esm/lib/utils/request/process.js

@@ -0,0 +1,37 @@
+import { Ok } from '@chzky/core';
+/** ## `upload_process` : 上传进度查询(浏览器专属)
++ 进度只保留两位小数,即`xx.yy%`
++ 存在两种情况,进度不可计算时,返回`-1%`
+  + `event.lengthComputable`为`false` (长度不可计算)
+  + `event.total`为`0`(数据的总大小不可知)
+*/
+export default function upload_process(progress) {
+    return conf => {
+        conf.onUploadProgress = event => {
+            if (event.lengthComputable && event.total) {
+                progress(Number.parseFloat(((event.loaded * 100) / event.total).toFixed(2)));
+            }
+            else
+                progress(-1);
+        };
+        return Ok();
+    };
+}
+/** ## `download_process` : 下载进度查询(浏览器专属)
++ 进度只保留两位小数,即`xx.yy%`
++ 存在两种情况,进度不可计算时,返回`-1%`
+  + `event.lengthComputable`为`false` (长度不可计算)
+  + `event.total`为`0`(数据的总大小不可知)
+*/
+export function download_process(progress) {
+    return conf => {
+        conf.onDownloadProgress = event => {
+            if (event.lengthComputable && event.total) {
+                progress(Number.parseFloat(((event.loaded * 100) / event.total).toFixed(2)));
+            }
+            else
+                progress(-1);
+        };
+        return Ok();
+    };
+}

package/esm/lib/utils/request/wait.d.ts

@@ -0,0 +1,10 @@
+import type { PositiveInteger } from '@chzky/core';
+import type { RequestInterceptor } from '../../../mod.js';
+/** ## `wait` : 等待指定时间后继续执行请求
+ * @param time `PositiveInteger<N>` - The time to wait in milliseconds (must be a positive integer)
+ * @type `RequestInterceptor` - `Request`
+ * @category `Request`
+ * @returns A Promise that resolves after the specified time delay
+ */
+export declare function wait<N extends number>(time: PositiveInteger<N>): RequestInterceptor<never>;
+//# sourceMappingURL=wait.d.ts.map

package/esm/lib/utils/request/wait.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wait.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/request/wait.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAIzD;;;;;GAKG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAO1F"}

package/esm/lib/utils/request/wait.js

@@ -0,0 +1,14 @@
+import { Ok } from '@chzky/core';
+/** ## `wait` : 等待指定时间后继续执行请求
+ * @param time `PositiveInteger<N>` - The time to wait in milliseconds (must be a positive integer)
+ * @type `RequestInterceptor` - `Request`
+ * @category `Request`
+ * @returns A Promise that resolves after the specified time delay
+ */
+export function wait(time) {
+    return () => new Promise(res => {
+        setTimeout(() => {
+            res(Ok());
+        }, time);
+    });
+}

package/esm/lib/utils/response/blobToUrl.d.ts

@@ -0,0 +1,10 @@
+import type { ResponseInterceptor } from '../../../mod.js';
+/** ## blob2url : `blob`转化成`url`,赋值在`src`字段上
++ 一般用于
+1. 图片显示
+2. 显示PDF
+@returns [`revoke`:用于取消对`ObjectURL`对象的引用, `interceptor`:拦截器]
+@category ResponseInterceptor
+*/
+export declare function blob2url(): [() => void, ResponseInterceptor<Blob, string, never>];
+//# sourceMappingURL=blobToUrl.d.ts.map

package/esm/lib/utils/response/blobToUrl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"blobToUrl.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/response/blobToUrl.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AAI1D;;;;;;EAME;AACF,wBAAgB,QAAQ,IAAI,CAAC,MAAM,IAAI,EAAE,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAWjF"}

package/esm/lib/utils/response/blobToUrl.js

@@ -0,0 +1,21 @@
+import { Ok } from '@chzky/core';
+/** ## blob2url : `blob`转化成`url`,赋值在`src`字段上
++ 一般用于
+1. 图片显示
+2. 显示PDF
+@returns [`revoke`:用于取消对`ObjectURL`对象的引用, `interceptor`:拦截器]
+@category ResponseInterceptor
+*/
+export function blob2url() {
+    let object_url;
+    return [
+        () => {
+            if (object_url)
+                URL.revokeObjectURL(object_url);
+        },
+        blob => {
+            object_url = URL.createObjectURL(blob);
+            return Ok(object_url);
+        },
+    ];
+}

package/esm/lib/utils/response/mod.d.ts

@@ -0,0 +1,5 @@
+export * from './blobToUrl.js';
+export * from './openLink.js';
+export * from './output.js';
+export * from './pick.js';
+//# sourceMappingURL=mod.d.ts.map

package/esm/lib/utils/response/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/response/mod.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA"}

package/esm/lib/utils/response/mod.js

@@ -0,0 +1,4 @@
+export * from './blobToUrl.js'; /* blob赋值src */
+export * from './openLink.js'; /* blob下载 */
+export * from './output.js'; /* 输出校验|输出map */
+export * from './pick.js'; /* 字段提取 */

package/esm/lib/utils/response/openLink.d.ts

@@ -0,0 +1,7 @@
+import type { ResponseInterceptor } from '../../../mod.js';
+/** ### `open_link` : 将获取到的blob文件直接进行下载
+@tips : 只能在浏览器环境下使用,在非浏览器环境下会直接返回blob
+@category ResponseInterceptor
+*/
+export declare function open_link(name: string): ResponseInterceptor<Blob, Blob, never>;
+//# sourceMappingURL=openLink.d.ts.map

package/esm/lib/utils/response/openLink.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openLink.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/response/openLink.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AAI1D;;;EAGE;AACF,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,mBAAmB,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAY9E"}

package/esm/lib/utils/response/openLink.js

@@ -0,0 +1,20 @@
+import * as dntShim from "../../../_dnt.shims.js";
+import { Ok } from '@chzky/core';
+/** ### `open_link` : 将获取到的blob文件直接进行下载
+@tips : 只能在浏览器环境下使用,在非浏览器环境下会直接返回blob
+@category ResponseInterceptor
+*/
+export function open_link(name) {
+    return blob => {
+        var _a;
+        if (typeof dntShim.dntGlobalThis === 'undefined' || !((_a = dntShim.dntGlobalThis) === null || _a === void 0 ? void 0 : _a.document))
+            return Ok(blob);
+        // biome-ignore lint/suspicious/noExplicitAny: <>
+        const a = dntShim.dntGlobalThis.document.createElement('a');
+        a.href = URL.createObjectURL(blob);
+        a.download = name;
+        a.click();
+        a.remove();
+        return Ok(blob);
+    };
+}

package/esm/lib/utils/response/output.d.ts

@@ -0,0 +1,16 @@
+import type { Fn, Result, zod } from '@chzky/core';
+import type { ResponseInterceptor } from '../../../mod.js';
+import { CheckingError } from '@chzky/core';
+/** ### `output_validate` : 对输出类型进行类型校验
++ 会自动将放回类型进行校验(使用`zod.parse`)，如果校验失败，则返回 `CheckingError`
+@category `Request`
+@category ResponseInterceptor
+*/
+export declare function output_validate<T>(schema: zod.Schema<T>): ResponseInterceptor<unknown, zod.infer<typeof schema>, CheckingError>;
+/** ## `response_map` : 对返回类型进行`map`操作
++ 用于`AxiosResponse`的业务场景映射
++ 用于返回数据映射
+@category ResponseInterceptor
+*/
+export declare function response_map<T, R, E>(fn: Fn<T, Result<R, E>>): ResponseInterceptor<T, R, E>;
+//# sourceMappingURL=output.d.ts.map

package/esm/lib/utils/response/output.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"output.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/response/output.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AAE1D,OAAO,EAAE,aAAa,EAAM,MAAM,aAAa,CAAA;AAE/C;;;;EAIE;AACF,wBAAgB,eAAe,CAAC,CAAC,EAChC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GACnB,mBAAmB,CAAC,OAAO,EAAE,GAAG,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,EAAE,aAAa,CAAC,CAQvE;AAED;;;;EAIE;AACF,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAE3F"}

package/esm/lib/utils/response/output.js

@@ -0,0 +1,24 @@
+import { CheckingError, Ok } from '@chzky/core';
+/** ### `output_validate` : 对输出类型进行类型校验
++ 会自动将放回类型进行校验(使用`zod.parse`)，如果校验失败，则返回 `CheckingError`
+@category `Request`
+@category ResponseInterceptor
+*/
+export function output_validate(schema) {
+    return response => {
+        try {
+            return Ok(schema.parse(response));
+        }
+        catch (e) {
+            return CheckingError.err(e);
+        }
+    };
+}
+/** ## `response_map` : 对返回类型进行`map`操作
++ 用于`AxiosResponse`的业务场景映射
++ 用于返回数据映射
+@category ResponseInterceptor
+*/
+export function response_map(fn) {
+    return response => fn(response);
+}

package/esm/lib/utils/response/pick.d.ts

@@ -0,0 +1,23 @@
+import type { ResponseInterceptor } from '../../../mod.js';
+import type { AxiosResponse } from 'axios';
+type AxiosResponseKey = 'data' | 'status' | 'statusText' | 'headers' | 'config' | 'request';
+/** ### `pick` : 提取`Axios`请求返回字段
++ 默认返回`data`字段
+一般来说axios返回的数据是一个AxiosResponse对象,而我们只需要其中的data字段作为业务数据需要的字段
+@example Usage
+```ts
+    const mock_reqwest = Reqwest.new().conf({ baseURL: 'https://jsonplaceholder.typicode.com/todos/' })
+
+    const result = await mock_reqwest
+        .request(get('/1'))
+        .response(pick<{ userId: number; id: number; title: string; completed: boolean }>('data'))
+        .dispatch()
+
+    assert.not(result.unwrap().completed)
+
+```
+@category ResponseInterceptor
+*/
+export declare function pick<T = never>(key: AxiosResponseKey): ResponseInterceptor<AxiosResponse, T extends never ? AxiosResponse[typeof key] : T, never>;
+export {};
+//# sourceMappingURL=pick.d.ts.map

package/esm/lib/utils/response/pick.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pick.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/response/pick.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AAC1D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAI1C,KAAK,gBAAgB,GAAG,MAAM,GAAG,QAAQ,GAAG,YAAY,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAA;AAE3F;;;;;;;;;;;;;;;;EAgBE;AACF,wBAAgB,IAAI,CAAC,CAAC,GAAG,KAAK,EAC7B,GAAG,EAAE,gBAAgB,GACnB,mBAAmB,CAAC,aAAa,EAAE,CAAC,SAAS,KAAK,GAAG,aAAa,CAAC,OAAO,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAK5F"}

package/esm/lib/utils/response/pick.js

@@ -0,0 +1,25 @@
+import { Ok } from '@chzky/core';
+/** ### `pick` : 提取`Axios`请求返回字段
++ 默认返回`data`字段
+一般来说axios返回的数据是一个AxiosResponse对象,而我们只需要其中的data字段作为业务数据需要的字段
+@example Usage
+```ts
+    const mock_reqwest = Reqwest.new().conf({ baseURL: 'https://jsonplaceholder.typicode.com/todos/' })
+
+    const result = await mock_reqwest
+        .request(get('/1'))
+        .response(pick<{ userId: number; id: number; title: string; completed: boolean }>('data'))
+        .dispatch()
+
+    assert.not(result.unwrap().completed)
+
+```
+@category ResponseInterceptor
+*/
+export function pick(key) {
+    return response => {
+        if (key in response && Object.hasOwn(response, key))
+            return Ok(response[key]);
+        throw new Error(`Key '${key}' does not exist on AxiosResponse`);
+    };
+}

package/esm/lib/utils/use/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/use/mod.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA"}

package/esm/lib/utils/use/mod.js

@@ -0,0 +1,2 @@
+export * from './useCancel.js'; /* 取消控制 */
+export * from './useLoading.js'; /* loading控制 */

package/esm/lib/utils/use/useCancel.d.ts

@@ -0,0 +1,33 @@
+import type { RequestInterceptor } from '../../../mod.js';
+import { AbortedError, PromiseOr, Result } from '@chzky/core';
+type CancelInterceptor = [
+    AbortController,
+    {
+        request: RequestInterceptor<AbortedError>;
+        response: <O>(response: O) => PromiseOr<Result<O, AbortedError>>;
+    }
+];
+/** ### `cancel` : 允许取消操作
++ 在请求时取消,会直接取消请求
++ 在响应时取消,会直接丢弃响应值
+@example Usage
+```ts
+    const [abort_controler, interceptor] = cancel()
+
+    const reqwest = mock_reqwest.clone().request(wait(2000), get('/1')).use(interceptor)
+
+    const mock_cause = 'mock abort'
+    abort_controler.abort(mock_cause)
+
+    const result = await reqwest.dispatch()
+
+    const error = result.unwrap_err()
+    assert(error.instance_of(AbortedError))
+    assert.equal(error.cause, mock_cause)
+```
+@returns [ `abort_controler` - 控制取消的`AbortController` , `interceptor` - 拦截器 ]
+@category ReqwestInterceptor
+ */
+export declare function cancel(control?: AbortController): CancelInterceptor;
+export {};
+//# sourceMappingURL=useCancel.d.ts.map

package/esm/lib/utils/use/useCancel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCancel.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/use/useCancel.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAEzD,OAAO,EAAE,YAAY,EAAM,SAAS,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEjE,KAAK,iBAAiB,GAAG;IACxB,eAAe;IACf;QACC,OAAO,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAA;QACzC,QAAQ,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,KAAK,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAA;KAChE;CACD,CAAA;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,MAAM,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,iBAAiB,CAgBnE"}

package/esm/lib/utils/use/useCancel.js

@@ -0,0 +1,41 @@
+import { AbortedError, Ok } from '@chzky/core';
+/** ### `cancel` : 允许取消操作
++ 在请求时取消,会直接取消请求
++ 在响应时取消,会直接丢弃响应值
+@example Usage
+```ts
+    const [abort_controler, interceptor] = cancel()
+
+    const reqwest = mock_reqwest.clone().request(wait(2000), get('/1')).use(interceptor)
+
+    const mock_cause = 'mock abort'
+    abort_controler.abort(mock_cause)
+
+    const result = await reqwest.dispatch()
+
+    const error = result.unwrap_err()
+    assert(error.instance_of(AbortedError))
+    assert.equal(error.cause, mock_cause)
+```
+@returns [ `abort_controler` - 控制取消的`AbortController` , `interceptor` - 拦截器 ]
+@category ReqwestInterceptor
+ */
+export function cancel(control) {
+    const abort_control = control || new AbortController();
+    const signal = abort_control.signal;
+    return [
+        abort_control,
+        {
+            request: () => {
+                if (signal.aborted)
+                    return AbortedError.err(signal.reason);
+                return Ok();
+            },
+            response: (response) => {
+                if (signal.aborted)
+                    return AbortedError.err(signal.reason);
+                return Ok(response);
+            },
+        },
+    ];
+}

package/esm/lib/utils/use/useLoading.d.ts

@@ -0,0 +1,34 @@
+import { ReqwestInterceptor } from '../../../mod.js';
+import { Ref } from 'vue-demi';
+type LoadingConfig = {
+    /** 最大等待时间,超时之后loding状态会变为false,默认值是`Axios.timeout`
+    如果设置为`0`,即永不超时,需要手动取消或等待请求完成
+     */
+    maximum?: number;
+    /** 超时回调 */
+    maximun_handler?: () => void;
+};
+type LoadingControlReturn = [AbortController, ReqwestInterceptor<unknown, never>];
+/**  ## `loading_control` : loading控制器
+使用` Ref<boolean, boolean>`	来控制loading状态 ,当reqwest开始执行的时候启动loading.当reqwest结束的时候关闭loading
++ 如果请求时间超过`maximum`时间,loading状态会变为false,并执行`maximun_handler`回调
+@example Usage
+```ts
+    const loading = ref(false)
+    const [_cnacel_controler, interceptor] = loading_control(loading, { maximum: 2000 })
+
+    let change_count = 0
+    watch(loading, nval => {
+        if (change_count === 0) assert(nval) //先变true(开始执行)
+        if (change_count === 1) assert(!nval) //后变false(执行结束)
+        change_count++
+    })
+
+    await mock_reqwest.clone().use(interceptor).dispatch()
+```
+@returns [ `controller` - 控制取消的`AbortController` , `interceptor` - 拦截器 ]
+@category ReqwestInterceptor
+ */
+export declare function loading_control(ref: Ref<boolean, boolean>, conf?: LoadingConfig): LoadingControlReturn;
+export {};
+//# sourceMappingURL=useLoading.d.ts.map

package/esm/lib/utils/use/useLoading.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLoading.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/use/useLoading.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAEpD,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAA;AAE9B,KAAK,aAAa,GAAG;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW;IACX,eAAe,CAAC,EAAE,MAAM,IAAI,CAAA;CAC5B,CAAA;AAED,KAAK,oBAAoB,GAAG,CAAC,eAAe,EAAE,kBAAkB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAA;AAEjF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,eAAe,CAC9B,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,EAC1B,IAAI,CAAC,EAAE,aAAa,GAClB,oBAAoB,CAqCtB"}