kbfetch 0.0.27 → 1.0.1

package/README.md

@@ -6,16 +6,26 @@
 import kbfetch from 'kbfetch'
 kbfetch.get('https://api.example.com/data', { id: 1 })
 // OR
-kbfetch.g('https://api.example.com/data', {
-    params: { id: 1 }
-    // 其他kbFetchInit属性
-})
+kbfetch.g('https://api.example.com/data', { params: { id: 1 } })
 ```
 
 发起 POST 请求的示例：
 
 ```js
 kbfetch.post('https://api.example.com/data', { id: 1 })
+// OR需要query参数
+kbfetch.post('https://api.example.com/data', { id: 1 }, { params: { qa: 1 } })
+// OR
+kbfetch.p('https://api.example.com/data', { params: { qa: 1 }, body: { id: 1 } })
+```
+
+发起 其他method 请求的示例：
+
+```js
+// e.g. 1
+kbfetch.p('https://baidu.com', { method: 'PUT' })
+// e.g. 2
+kbfetch.g('https://baidu.com', { method: 'PATCH' })
 ```
 
 取消请求示例：
@@ -26,23 +36,55 @@ const ft = kbfetch.post('https://api.example.com/data', { id: 1 }, { canAbort: t
 ft.abort()
 ```
 
+`or`
+
 ```js
 const ft = kbfetch.g('https://api.example.com/data', { params: { id: 1 }, timeout: 0 })
 ft.abort()
 ```
 
+设置公共参数比如token
+
+```js
+kbfetch.baseHeaders = { token: 'XXX' }
+
+kbfetch.baseParams = { access_token: 'xxx' }
+
+kbfetch.baseBody = { access_token: 'xxx' }
+```
+
+### 方法汇总
+
+```
+get: (url: string, params?: Record<string, any>, init?: KbFetchInit)
+
+g: (url: string, init?: KbFetchInit & { params?: Record<string, any> })
+
+post: (url: string, body?: Record<string, any>, init?: KbFetchInit)
+
+p: (url: string, init?: KbFetchInit)
+
+uploadFile: (url: string, file: File, init?: KbFetchInit)
+
+其他method可以通过p方法或者g方法,实现
+```
+
 ### 自定义选项
 
 `KbFetchInit` 类型扩展了标准的 `RequestInit`,添加了一些可选的便捷属性:
 
-- `baseUrl` - API的基础网址
+- `baseUrl` - API地址的公共前缀
+- `baseHeaders` - 公共的header,如token
+- `baseParams` - 公共的params,如企业微信的access_token,没有放在header里面,可以在这里设置
+- `baseBody` - 公共body
 - `timeout` - 请求超时时间(毫秒)
 - `before` - 修改/记录请求参数的回调函数
 - `parser` - 在返回resolve前解析响应的回调函数
 - `after` - 响应结果的回调函数
 
 ```typescript
-import kbfetch, { createKbFetch } from 'kbfetch'
+import kbfetch, { createKbFetch, kbfc } from 'kbfetch'
+// kbfc等同于kbfetch
 // 请求单独配置
 kbfetch.post(url, data, kbFetchInit)
 kbfetch.get(url, params, kbFetchInit)

package/dist/index.js

@@ -18,57 +18,83 @@ var help = {
     const headers = new Headers;
     Object.entries(obj).forEach(([k, v]) => headers.append(k, v));
     return headers;
-  }
+  },
+  urlWithProtocol: (url) => url.startsWith("http://") || url.startsWith("https://"),
+  addProtocol: (url) => !url || !global.location || help.urlWithProtocol(url) ? url : location.protocol + url,
+  objPick: (obj, keys) => Object.fromEntries(keys.map((key) => [key, obj[key]])),
+  objSetDefVal: (obj, key, def) => def && (obj[key] = Object.assign({}, def, obj[key]))
 };
 var help_default = help;
 
 // index.ts
 var defaultKbFetch = {
-  baseUrl: "",
   before: (init) => init,
   after: (res) => res.then((res2) => res2.data),
   parser: help_default.parseResBody,
   timeout: -1,
   do: function(url, init) {
-    const _t = this;
-    let { before = _t.before, ..._init } = init || {};
-    _init = before(_init);
-    let { parser = _t.parser, after = _t.after, baseUrl = _t.baseUrl, timeout = _t.timeout, canAbort, headers, ...requestInit } = _init;
+    const { baseUrl, baseHeaders, baseParams, baseBody } = this;
+    const defOpts = help_default.objPick(this, ["before", "parser", "after", "timeout"]);
+    const _init = Object.assign(defOpts, init);
+    help_default.objSetDefVal(_init, "headers", baseHeaders);
+    help_default.objSetDefVal(_init, "params", baseParams);
+    baseBody && _init.headers?.["Content-Type"] === "application/json" && help_default.objSetDefVal(_init, "body", baseBody);
+    let { parser, after, timeout, canAbort, ...requestInit } = _init.before(_init) || _init;
     let abortController;
     let timeoutIns;
     if (timeout > 0 || canAbort) {
       abortController = new AbortController;
+      Object.assign(requestInit, { signal: abortController.signal });
       abortController.signal.onabort = () => clearTimeout(timeoutIns);
       timeoutIns = setTimeout(() => {
         abortController.abort();
       }, timeout);
     }
-    abortController && Object.assign(requestInit, { signal: abortController.signal });
-    headers && Object.assign(requestInit, { headers: help_default.obj2header(headers) });
-    if (!url.startsWith("http://") && !url.startsWith("https://"))
-      url = baseUrl + url;
+    if (requestInit.params)
+      url = help_default.synthesizeUrlWithParams(url, requestInit.params);
+    if (requestInit.body && requestInit.body.constructor.name === "Object" && requestInit.headers?.["Content-Type"] !== "application/json") {
+      requestInit.headers ||= {};
+      requestInit.headers["Content-Type"] == "application/json";
+      requestInit.body = JSON.stringify(requestInit.body);
+    }
+    requestInit.headers && (requestInit.headers = help_default.obj2header(requestInit.headers));
+    url = help_default.urlWithProtocol(url) ? url : help_default.addProtocol(baseUrl) + url;
     const response = fetch(url, requestInit).then(async (respnse) => Object.assign(respnse, { data: await parser(respnse) })).finally(() => clearTimeout(timeoutIns));
     return Object.assign(after(response), {
       abort: () => abortController?.abort()
     });
   },
   get: function(url, params, init) {
-    return this.do(help_default.synthesizeUrlWithParams(url, params), init);
+    params && (init ||= {}, init.params = params);
+    return this.do(url, init);
   },
   g: function(url, init) {
-    const { params, ..._init } = init || {};
-    return this.get(url, params, _init);
+    return this.do(url, init);
+  },
+  post: function(url, body, init) {
+    const _init = Object.assign({}, init, { method: "POST", body });
+    return this.do(url, _init);
+  },
+  p: function(url, init) {
+    const _init = Object.assign({}, { method: "POST" }, init);
+    return this.do(url, _init);
   },
-  post: function(url, params, init) {
-    const _init = Object.assign({}, init, { method: "POST", body: JSON.stringify(params) });
-    _init.headers = Object.assign({}, _init.headers, { "Content-Type": "application/json" });
+  uploadFile: function(url, file, init) {
+    const form = new FormData;
+    form.append("file", file);
+    const _init = Object.assign({}, init, { method: "POST", body: form });
     return this.do(url, _init);
   }
 };
-var createKbFetch = (config) => ({ ...defaultKbFetch, ...config });
+var createKbFetch = (config) => ({
+  ...defaultKbFetch,
+  ...config
+});
 var kbfetch = defaultKbFetch;
 var kbfetch_default = kbfetch;
+var kbfc = kbfetch;
 export {
+  kbfc,
   kbfetch_default as default,
   createKbFetch
 };

package/dist/typings/help.d.ts

@@ -1,21 +1,21 @@
-type _KbFetchInit = {
-    before?: DefaultKbFetch['before'];
-    parser?: DefaultKbFetch['parser'];
-    after?: DefaultKbFetch['after'];
-    baseUrl?: string;
-    canAbort?: boolean;
-    flags?: Record<string, any>;
+type _KbFetchInit = Pick<DefaultKbFetch, 'baseUrl' | 'baseParams' | 'baseBody' | 'before' | 'parser' | 'after' | 'timeout'> & {
+    canAbort: boolean;
+    flags: Record<string, any>;
+    params: Record<string, any>;
+    body: Record<string, any>;
 };
 export type KbFetchInit = Omit<RequestInit, 'timeout' | 'headers'> & {
-    timeout?: number;
-    headers?: Record<string, string>;
-} & _KbFetchInit;
+    headers?: Object;
+} & Partial<_KbFetchInit>;
 type Res<T> = Promise<T> & {
     abort: () => void;
 };
 export interface DefaultKbFetch {
-    baseUrl: string;
-    before: (init: KbFetchInit) => KbFetchInit;
+    baseUrl?: string;
+    baseHeaders?: Record<string, any>;
+    baseParams?: Record<string, any>;
+    baseBody?: Record<string, any>;
+    before: <T extends any>(init: T) => T | void;
     after: (res: Promise<Response & {
         data: any;
     }>) => any;
@@ -26,11 +26,17 @@ export interface DefaultKbFetch {
     g: <T = any>(url: string, init?: KbFetchInit & {
         params?: Record<string, any>;
     }) => Res<T>;
-    post: <T = any>(url: string, params?: Record<string, any>, init?: KbFetchInit) => Res<T>;
+    post: <T = any>(url: string, body?: Record<string, any>, init?: KbFetchInit) => Res<T>;
+    p: <T = any>(url: string, init?: KbFetchInit) => Res<T>;
+    uploadFile: <T = any>(url: string, file: File, init?: KbFetchInit) => Res<T>;
 }
 declare const help: {
     synthesizeUrlWithParams: (url: string, params?: Record<string, any>) => string;
     parseResBody: (res: Response) => Promise<any>;
-    obj2header: (obj: Record<string, string>) => Headers;
+    obj2header: (obj: Object) => Headers;
+    urlWithProtocol: (url: string) => boolean;
+    addProtocol: (url?: string) => string;
+    objPick: <T extends Object, K extends keyof T>(obj: T, keys: K[]) => Pick<T, K>;
+    objSetDefVal: <O extends Object, K extends keyof O, D extends Object>(obj: O, key: K, def?: D) => {} & D & O[K];
 };
 export default help;

package/dist/typings/index.d.ts

@@ -1,38 +1,36 @@
-import { DefaultKbFetch, KbFetchInit } from './help';
-export declare const createKbFetch: (config: Partial<Pick<DefaultKbFetch, 'baseUrl' | 'timeout' | 'before' | 'parser' | 'after'>>) => {
+import { DefaultKbFetch } from './help';
+export declare const createKbFetch: (config: Partial<Pick<DefaultKbFetch, "baseUrl" | "baseParams" | "baseBody" | "timeout" | "before" | "parser" | "after">>) => {
     after: (res: Promise<Response & {
         data: any;
     }>) => any;
-    before: (init: KbFetchInit) => KbFetchInit;
+    before: <T extends any>(init: T) => T | void;
     timeout: number;
+    baseUrl?: string;
+    baseParams?: Record<string, any>;
+    baseBody?: Record<string, any>;
     parser: (res: Response) => any;
-    baseUrl: string;
-    do: <T>(url: string, init?: KbFetchInit) => Promise<T> & {
+    baseHeaders?: Record<string, any>;
+    do: <T>(url: string, init?: import("./help").KbFetchInit) => Promise<T> & {
         abort: () => void;
     };
-    get: <T_1 = any>(url: string, params?: Record<string, any>, init?: KbFetchInit) => Promise<T_1> & {
+    get: <T = any>(url: string, params?: Record<string, any>, init?: import("./help").KbFetchInit) => Promise<T> & {
         abort: () => void;
     };
-    g: <T_2 = any>(url: string, init?: Omit<RequestInit, "timeout" | "headers"> & {
-        timeout?: number;
-        headers?: Record<string, string>;
-    } & {
-        before?: (init: KbFetchInit) => KbFetchInit;
-        parser?: (res: Response) => any;
-        after?: (res: Promise<Response & {
-            data: any;
-        }>) => any;
-        baseUrl?: string;
-        canAbort?: boolean;
-        flags?: Record<string, any>;
-    } & {
+    g: <T = any>(url: string, init?: import("./help").KbFetchInit & {
         params?: Record<string, any>;
-    }) => Promise<T_2> & {
+    }) => Promise<T> & {
         abort: () => void;
     };
-    post: <T_3 = any>(url: string, params?: Record<string, any>, init?: KbFetchInit) => Promise<T_3> & {
+    post: <T = any>(url: string, body?: Record<string, any>, init?: import("./help").KbFetchInit) => Promise<T> & {
+        abort: () => void;
+    };
+    p: <T = any>(url: string, init?: import("./help").KbFetchInit) => Promise<T> & {
+        abort: () => void;
+    };
+    uploadFile: <T = any>(url: string, file: File, init?: import("./help").KbFetchInit) => Promise<T> & {
         abort: () => void;
     };
 };
 declare const kbfetch: Omit<DefaultKbFetch, "do">;
 export default kbfetch;
+export declare const kbfc: Omit<DefaultKbFetch, "do">;

package/package.json

@@ -1,31 +1,32 @@
 {
-    "name": "kbfetch",
-    "main": "./dist/index.js",
-    "module": "./dist/index.js",
-    "description": "一个轻量基于fetch封装的API请求工具库",
-    "keywords": [
-        "fetch",
-        "ajax"
-    ],
-    "type": "module",
-    "version": "0.0.27",
-    "license": "MIT",
-    "types": "./dist/typings/index.d.ts",
-    "files": [
-        "dist"
-    ],
-    "scripts": {
-        "pub": "bun bld && bun tsc && bun patch && npm publish --registry https://registry.npmjs.org/ ; bun updatetaobao ",
-        "patch": "git stash && npm version patch && git stash pop",
-        "updatetaobao": "cnpm sync kbfetch",
-        "tsc": "tsc index.ts -d --emitDeclarationOnly --declarationDir ./dist/typings",
-        "bld": "bun build ./index.ts --outdir ./dist"
-    },
-    "devDependencies": {
-        "bun-types": "latest",
-        "typescript": "^5.2.2"
-    },
-    "peerDependencies": {
-        "typescript": "^5.0.0"
-    }
+  "name": "kbfetch",
+  "version": "1.0.1",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "devDependencies": {
+    "@types/node": "^20.14.10",
+    "bun-types": "latest",
+    "typescript": "^5.5.3"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "description": "一个轻量基于fetch封装的API请求工具库",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "fetch",
+    "ajax"
+  ],
+  "license": "MIT",
+  "scripts": {
+    "pub": "bun bld && bun tsc  && npm publish --registry https://registry.npmjs.org/ ; bun updatetaobao ",
+    "patch": "git stash && npm version patch && git stash pop",
+    "updatetaobao": "cnpm sync kbfetch",
+    "tsc": "tsc index.ts -d --emitDeclarationOnly --declarationDir ./dist/typings",
+    "bld": "bun build ./index.ts --outdir ./dist"
+  },
+  "type": "module",
+  "types": "./dist/typings/index.d.ts"
 }