utils-uniapp 1.1.2 → 1.1.4

package/lib/http/index.d.ts

@@ -63,10 +63,7 @@ type UniAnyResult = UniRequestResult | UniUploadResult | UniDownloadResult;
  * @param opts 请求参数，可以传入 cancelToken 用于请求取消
  * @returns uni接口回调结果Promise
  */
-export declare function promisifyRequest<T = UniAnyResult>(
-  type: 'request' | 'uploadFile' | 'downloadFile',
-  opts: Record<string, any>
-): Promise<T>;
+export declare function promisifyRequest<T = UniAnyResult>(type: 'request' | 'uploadFile' | 'downloadFile', opts: Record<string, any>): Promise<T>;
 
 /**
  * 开启loading计数
@@ -125,7 +122,9 @@ export interface NormalizeOpts {
   showError: boolean;
   /** 是否开启接口缓存 */
   isCache: boolean;
-  /** 缓存key名称 */
+  /** 缓存key前缀；不传/空字符串/undefined默认使用api；设置cacheKey时此配置无效 */
+  cachePrefix?: string;
+  /** 完整缓存key，传入则完全覆盖，优先级高于cachePrefix */
   cacheKey: string;
   /** 缓存过期时间，单位ms */
   cacheExpire: number;
@@ -148,16 +147,29 @@ export interface NormalizeOpts {
  * 经过内部 normalizeOpts 之后转换为 NormalizeOpts
  */
 export interface UserRequestOpts {
+  /** post请求是否使用urlencoded表单格式 */
   qs?: boolean;
+  /** 是否开启默认错误弹窗提示 */
   showError?: boolean;
+  /** 是否开启接口缓存 */
   isCache?: boolean;
+  /** 缓存key前缀；不传/空字符串/undefined默认使用api；设置cacheKey时此配置无效 */
+  cachePrefix?: string;
+  /** 完整缓存key，传入则完全覆盖，优先级高于cachePrefix */
   cacheKey?: string;
+  /** 缓存过期时间，单位ms */
   cacheExpire?: number;
+  /** loading提示文案 */
   loadingText?: string;
+  /** 是否开启loading */
   loading?: boolean;
+  /** 请求前置拦截器，支持单个函数或函数数组 */
   reqInterceptor?: UserReqInterceptor;
+  /** 响应拦截器，支持单个函数或函数数组 */
   resInterceptor?: UserResInterceptor;
+  /** 错误拦截器，支持单个函数或函数数组 */
   errInterceptor?: UserErrInterceptor;
+  /** 允许扩展自定义字段 */
   [key: string]: any;
 }
 
@@ -200,10 +212,7 @@ interface RequestInstance {
  * @param defaultOpts 全局默认扩展配置 loading、缓存、拦截器等，拦截器支持数组
  * @returns RequestInstance 请求实例
  */
-export declare function createRequest(
-  defaultConfig: Record<string, any>,
-  defaultOpts?: UserRequestOpts
-): RequestInstance;
+export declare function createRequest(defaultConfig: Record<string, any>, defaultOpts?: UserRequestOpts): RequestInstance;
 
 /**
  * 创建上传文件实例
@@ -214,12 +223,7 @@ export declare function createRequest(
 export declare function createUploadFile(
   defaultConfig: Record<string, any>,
   defaultOpts?: UserRequestOpts
-): (
-  url: string,
-  params: { filePath: string; keyName?: string; [key: string]: any },
-  config?: Record<string, any>,
-  options?: UserRequestOpts
-) => Promise<any>;
+): (url: string, params: { filePath: string; keyName?: string; [key: string]: any }, config?: Record<string, any>, options?: UserRequestOpts) => Promise<any>;
 
 /**
  * 创建下载文件实例
@@ -230,9 +234,4 @@ export declare function createUploadFile(
 export declare function createDownloadFile(
   defaultConfig: Record<string, any>,
   defaultOpts?: UserRequestOpts
-): (
-  url: string,
-  params?: Record<string, any>,
-  config?: Record<string, any>,
-  options?: UserRequestOpts
-) => Promise<any>;
+): (url: string, params?: Record<string, any>, config?: Record<string, any>, options?: UserRequestOpts) => Promise<any>;

package/lib/http/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const C=require("../index-b81565a7.js"),A=require("../object/index.js"),O=Object.freeze({JSON:"application/json;charset=UTF-8",TEXT:"text/plain;charset=UTF-8",FORM_URLENCODED:"application/x-www-form-urlencoded;charset=UTF-8",FORM_DATA:"multipart/form-data"}),m={caches:Object.create(null),add(e,t){this.caches[e]=t},delete(e){Reflect.deleteProperty(this.caches,e)},_cancel(e){const t=this.caches[e];typeof(t==null?void 0:t.abort)=="function"&&t.abort()},cancelAll(){Object.values(this.caches).forEach(e=>{typeof(e==null?void 0:e.abort)=="function"&&e.abort()}),this.caches=Object.create(null)},source(){const e=`${Date.now()}-${C.getRandomStr(16)}`;return{token:e,cancel:()=>this._cancel(e)}}};function b(e,t){return new Promise((o,n)=>{const c=uni[e]({...t,success(r){if(r.statusCode>=200&&r.statusCode<300)return o(r);n({type:"fail",res:r})},fail(r){n({type:"fail",res:r})},complete(){t.cancelToken&&m.delete(t.cancelToken)}});t.cancelToken&&m.add(t.cancelToken,c)})}let R=0,v=!1;function N(e){v||(v=!0,uni.showLoading({title:e,mask:!0}))}function S(){v&&(v=!1,uni.hideLoading())}function j(){let e=arguments.length>0&&arguments[0]!==void 0?arguments[0]:"加载中...";R++,R===1&&N(e)}function D(){R>0&&R--,R===0&&S()}function _(e,t){return function(o,n,c,r){return e(o,t,n,c,r)}}function w(e){return typeof e=="function"?e:()=>e||{}}function k(e){let t=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{},o=arguments.length>2&&arguments[2]!==void 0?arguments[2]:{};const n=w(t.headers)(),c=w(o.headers)(),r={...t,...o,headers:{...n,...c}},{headers:a,...s}=r;return{urlRes:e.startsWith("http")?e:r.baseURL?r.baseURL+e:e,headers:a,configRes:s}}function U(e){return typeof e=="function"?[e]:Array.isArray(e)?e.filter(t=>typeof t=="function"):[]}function F(e){let t=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{},o=arguments.length>2&&arguments[2]!==void 0?arguments[2]:{};const n={qs:!0,showError:!0,isCache:!1,cacheKey:`api:${e.url}`,cacheExpire:1e3*60*60*1,loadingText:e.loadingText,loading:!0,reqInterceptor:c=>c,resInterceptor:c=>c,errInterceptor:()=>{},...t,...o};return["reqInterceptor","resInterceptor","errInterceptor"].forEach(c=>{const r=[...U(t[c]),...U(o[c])];n[c]=r.length?C.composeAsync(...r):a=>a}),n}function q(e,t){const o=Array.from(t);return()=>e(...A.cloneDeepWithDescriptors(o))}function E(e,t,o,n,c){return x.apply(this,arguments)}function x(){return x=C._asyncToGenerator(function*(e,t,o,n,c){let r;n.loading&&(j(n.loadingText),r=()=>{D(),r=null});try{var a;const u=yield n.reqInterceptor(o,n),l=yield e(t,u);return(a=r)===null||a===void 0||a(),yield n.resInterceptor(l,n,c)}catch(u){var s;(s=r)===null||s===void 0||s();const l=yield n.errInterceptor(u,n);return l!==void 0?l:Promise.reject(u)}}),x.apply(this,arguments)}function L(e,t){function o(n,c,r,a,s){const u=m.source(),l=q(o,arguments),i=F({url:n,loadingText:"加载中..."},t,s),{urlRes:y,headers:T,configRes:g}=k(n,e,a);if(i.isCache){const d=C.getCache(i.cacheKey);if(d)return Promise.resolve(d)}const p=c.toUpperCase()==="GET"?O.JSON:i.qs?O.FORM_URLENCODED:O.JSON,h={cancelToken:u.token,method:c,url:y,data:r,header:{"Content-Type":p,...T},...g};return E(b,"request",h,i,l).then(d=>(i.isCache&&C.setCache(i.cacheKey,d,i.cacheExpire),d))}return o.get=_(o,"get"),o.post=_(o,"post"),o}function P(e,t){return function o(n,c,r,a){const s=m.source(),u=q(o,arguments),l=F({loadingText:"上传中..."},t,a),{urlRes:i,headers:y,configRes:T}=k(n,e,r),{keyName:g="file",filePath:f,...p}={keyName:"file",...c};if(!f||!f.startsWith("http://tmp")&&!f.startsWith("wxfile://tmp"))return Promise.resolve({data:f});const h={cancelToken:s.token,url:i,filePath:f,name:g,formData:p,header:{...y},...T};return E(b,"uploadFile",h,l,u)}}function z(e,t){return function o(n,c,r,a){const s=m.source(),u=q(o,arguments),l=F({loadingText:"下载中..."},t,a),{urlRes:i,headers:y,configRes:T}=k(n,e,r);let g=i;if(c&&typeof c=="object"){const p=Object.entries(c).filter(h=>{let[,d]=h;return d!=null&&d!==""}).map(h=>{let[d,I]=h;return`${encodeURIComponent(d)}=${encodeURIComponent(I)}`}).join("&");p&&(g+=(g.includes("?")?"&":"?")+p)}const f={cancelToken:s.token,url:g,header:{...y},...T};return E(b,"downloadFile",f,l,u)}}exports.CONTENT_TYPES=O;exports.CancelToken=m;exports.createDownloadFile=z;exports.createRequest=L;exports.createUploadFile=P;exports.endLoading=D;exports.promisifyRequest=b;exports.startLoading=j;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const C=require("../index-b81565a7.js"),A=require("../object/index.js"),O=Object.freeze({JSON:"application/json;charset=UTF-8",TEXT:"text/plain;charset=UTF-8",FORM_URLENCODED:"application/x-www-form-urlencoded;charset=UTF-8",FORM_DATA:"multipart/form-data"}),m={caches:Object.create(null),add(e,t){this.caches[e]=t},delete(e){Reflect.deleteProperty(this.caches,e)},_cancel(e){const t=this.caches[e];typeof(t==null?void 0:t.abort)=="function"&&t.abort()},cancelAll(){Object.values(this.caches).forEach(e=>{typeof(e==null?void 0:e.abort)=="function"&&e.abort()}),this.caches=Object.create(null)},source(){const e=`${Date.now()}-${C.getRandomStr(16)}`;return{token:e,cancel:()=>this._cancel(e)}}};function x(e,t){return new Promise((c,n)=>{const r=uni[e]({...t,success(o){if(o.statusCode>=200&&o.statusCode<300)return c(o);n({type:"fail",res:o})},fail(o){n({type:"fail",res:o})},complete(){t.cancelToken&&m.delete(t.cancelToken)}});t.cancelToken&&m.add(t.cancelToken,r)})}let R=0,v=!1;function N(e){v||(v=!0,uni.showLoading({title:e,mask:!0}))}function P(){v&&(v=!1,uni.hideLoading())}function j(){let e=arguments.length>0&&arguments[0]!==void 0?arguments[0]:"加载中...";R++,R===1&&N(e)}function D(){R>0&&R--,R===0&&P()}function _(e,t){return function(c,n,r,o){return e(c,t,n,r,o)}}function w(e){return typeof e=="function"?e:()=>e||{}}function k(e){let t=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{},c=arguments.length>2&&arguments[2]!==void 0?arguments[2]:{};const n=w(t.headers)(),r=w(c.headers)(),o={...t,...c,headers:{...n,...r}},{headers:a,...s}=o;return{urlRes:e.startsWith("http")?e:o.baseURL?o.baseURL+e:e,headers:a,configRes:s}}function U(e){return typeof e=="function"?[e]:Array.isArray(e)?e.filter(t=>typeof t=="function"):[]}function F(e){let t=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{},c=arguments.length>2&&arguments[2]!==void 0?arguments[2]:{};const n={qs:!0,showError:!0,isCache:!1,cacheExpire:1e3*60*60*1,loadingText:e.loadingText,loading:!0,reqInterceptor:r=>r,resInterceptor:r=>r,errInterceptor:()=>{},...t,...c};if(!n.cacheKey){const r=(n.cachePrefix||"api").replace(/:$/,"");n.cacheKey=`${r}:${e.url}`}return["reqInterceptor","resInterceptor","errInterceptor"].forEach(r=>{const o=[...U(t[r]),...U(c[r])];n[r]=o.length?C.composeAsync(...o):a=>a}),n}function q(e,t){const c=Array.from(t);return()=>e(...A.cloneDeepWithDescriptors(c))}function E(e,t,c,n,r){return b.apply(this,arguments)}function b(){return b=C._asyncToGenerator(function*(e,t,c,n,r){let o;n.loading&&(j(n.loadingText),o=()=>{D(),o=null});try{var a;const u=yield n.reqInterceptor(c,n),l=yield e(t,u);return(a=o)===null||a===void 0||a(),yield n.resInterceptor(l,n,r)}catch(u){var s;(s=o)===null||s===void 0||s();const l=yield n.errInterceptor(u,n);return l!==void 0?l:Promise.reject(u)}}),b.apply(this,arguments)}function S(e,t){function c(n,r,o,a,s){const u=m.source(),l=q(c,arguments),i=F({url:n,loadingText:"加载中..."},t,s),{urlRes:y,headers:T,configRes:h}=k(n,e,a);if(i.isCache){const d=C.getCache(i.cacheKey);if(d)return Promise.resolve(d)}const p=r.toUpperCase()==="GET"?O.JSON:i.qs?O.FORM_URLENCODED:O.JSON,g={cancelToken:u.token,method:r,url:y,data:o,header:{"Content-Type":p,...T},...h};return E(x,"request",g,i,l).then(d=>(i.isCache&&C.setCache(i.cacheKey,d,i.cacheExpire),d))}return c.get=_(c,"get"),c.post=_(c,"post"),c}function L(e,t){return function c(n,r,o,a){const s=m.source(),u=q(c,arguments),l=F({loadingText:"上传中..."},t,a),{urlRes:i,headers:y,configRes:T}=k(n,e,o),{keyName:h="file",filePath:f,...p}={keyName:"file",...r};if(!f||!f.startsWith("http://tmp")&&!f.startsWith("wxfile://tmp"))return Promise.resolve({data:f});const g={cancelToken:s.token,url:i,filePath:f,name:h,formData:p,header:{...y},...T};return E(x,"uploadFile",g,l,u)}}function $(e,t){return function c(n,r,o,a){const s=m.source(),u=q(c,arguments),l=F({loadingText:"下载中..."},t,a),{urlRes:i,headers:y,configRes:T}=k(n,e,o);let h=i;if(r&&typeof r=="object"){const p=Object.entries(r).filter(g=>{let[,d]=g;return d!=null&&d!==""}).map(g=>{let[d,I]=g;return`${encodeURIComponent(d)}=${encodeURIComponent(I)}`}).join("&");p&&(h+=(h.includes("?")?"&":"?")+p)}const f={cancelToken:s.token,url:h,header:{...y},...T};return E(x,"downloadFile",f,l,u)}}exports.CONTENT_TYPES=O;exports.CancelToken=m;exports.createDownloadFile=$;exports.createRequest=S;exports.createUploadFile=L;exports.endLoading=D;exports.promisifyRequest=x;exports.startLoading=j;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "utils-uniapp",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "aubyn's utils for uniapp",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",