utils-uniapp 1.1.15 → 1.1.16
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/lib/http/index.d.ts +35 -18
- package/lib/http/index.js +1 -1
- package/package.json +1 -1
package/lib/http/index.d.ts
CHANGED
|
@@ -31,7 +31,7 @@ type UniRequestResult = UniApp.RequestSuccessCallbackResult;
|
|
|
31
31
|
/** @internal */
|
|
32
32
|
type UniUploadResult = UniApp.UploadFileSuccessCallbackResult;
|
|
33
33
|
/** @internal */
|
|
34
|
-
type UniDownloadResult = UniApp.
|
|
34
|
+
type UniDownloadResult = UniApp.DownloadSuccessData;
|
|
35
35
|
/** @internal */
|
|
36
36
|
type UniAnyResult = UniRequestResult | UniUploadResult | UniDownloadResult;
|
|
37
37
|
|
|
@@ -93,7 +93,7 @@ export interface CacheConfigInput {
|
|
|
93
93
|
*/
|
|
94
94
|
adapter?: CacheAdapter | null | ((ctx: {
|
|
95
95
|
url: string;
|
|
96
|
-
config: Partial<UniApp.RequestOptions | UniApp.
|
|
96
|
+
config: Partial<UniApp.RequestOptions | UniApp.UploadFileOption | UniApp.DownloadFileOption>;
|
|
97
97
|
options: RequestOptions;
|
|
98
98
|
cacheConfig: CacheConfig;
|
|
99
99
|
}) => CacheAdapter | null);
|
|
@@ -114,32 +114,49 @@ interface CacheConfig {
|
|
|
114
114
|
|
|
115
115
|
/**
|
|
116
116
|
* 请求前置拦截器【标准化后】
|
|
117
|
-
* @param
|
|
118
|
-
* @param
|
|
117
|
+
* @param payload 拦截器入参对象
|
|
118
|
+
* @param payload.config 组装完成即将传给uni的请求参数(原invokeArgs)
|
|
119
|
+
* @param payload.opts normalizeOpts合并后的完整配置
|
|
119
120
|
* @returns 处理后的请求参数
|
|
120
121
|
*/
|
|
121
122
|
type ReqInterceptor = (
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
123
|
+
payload: {
|
|
124
|
+
config: Partial<UniApp.RequestOptions | UniApp.UploadFileOption | UniApp.DownloadFileOption>;
|
|
125
|
+
opts: RequestOptions;
|
|
126
|
+
}
|
|
127
|
+
) => Promise<Partial<UniApp.RequestOptions | UniApp.UploadFileOption | UniApp.DownloadFileOption>> | Partial<UniApp.RequestOptions | UniApp.UploadFileOption | UniApp.DownloadFileOption>;
|
|
125
128
|
|
|
126
129
|
/**
|
|
127
130
|
* 响应拦截器【标准化后】
|
|
128
|
-
* @param
|
|
129
|
-
* @param
|
|
130
|
-
* @param
|
|
131
|
+
* @param payload 拦截器入参对象
|
|
132
|
+
* @param payload.res uni原始响应对象,实际类型为 UniAnyResult
|
|
133
|
+
* @param payload.config 组装完成即将传给uni的请求参数
|
|
134
|
+
* @param payload.options normalizeOpts合并后的完整配置
|
|
135
|
+
* @param payload.reloadFn 重发当前请求函数,可为null
|
|
131
136
|
* @returns 处理后业务数据
|
|
132
137
|
*/
|
|
133
|
-
type ResInterceptor = (
|
|
138
|
+
type ResInterceptor = (payload: {
|
|
139
|
+
res: unknown;
|
|
140
|
+
config: Partial<UniApp.RequestOptions | UniApp.UploadFileOption | UniApp.DownloadFileOption>;
|
|
141
|
+
options: RequestOptions;
|
|
142
|
+
reloadFn: (() => Promise<unknown>) | null;
|
|
143
|
+
}) => Promise<unknown> | unknown;
|
|
134
144
|
|
|
135
145
|
/**
|
|
136
146
|
* 错误拦截器【标准化后】
|
|
137
|
-
* @param
|
|
138
|
-
* @param
|
|
139
|
-
* @param
|
|
147
|
+
* @param payload 拦截器入参对象
|
|
148
|
+
* @param payload.err 捕获到的异常对象,可能为接口回调失败载荷 RequestFailPayload 或 JS运行异常 Error
|
|
149
|
+
* @param payload.config 组装完成即将传给uni的请求参数
|
|
150
|
+
* @param payload.options normalizeOpts合并后的完整配置
|
|
151
|
+
* @param payload.reloadFn 重发当前请求函数,可为null
|
|
140
152
|
* @returns 返回非undefined代表错误已接管;返回undefined会继续抛出异常
|
|
141
153
|
*/
|
|
142
|
-
type ErrInterceptor = (
|
|
154
|
+
type ErrInterceptor = (payload: {
|
|
155
|
+
err: RequestFailPayload | Error;
|
|
156
|
+
config: Partial<UniApp.RequestOptions | UniApp.UploadFileOption | UniApp.DownloadFileOption>;
|
|
157
|
+
options: RequestOptions;
|
|
158
|
+
reloadFn: (() => Promise<unknown>) | null;
|
|
159
|
+
}) => Promise<unknown> | unknown;
|
|
143
160
|
|
|
144
161
|
/**
|
|
145
162
|
* 用户传入拦截器:支持单个函数 / 函数数组,交由 normalizeInterceptor + composeAsync合并
|
|
@@ -250,7 +267,7 @@ export type HttpRequestConfig = Partial<Omit<UniApp.RequestOptions, 'url' | 'hea
|
|
|
250
267
|
* 上传config:uni.uploadFile配置,排除内部强制覆盖字段
|
|
251
268
|
* @note baseURL 为库自定义字段,非uni.uploadFile原生API字段
|
|
252
269
|
*/
|
|
253
|
-
export type UploadConfig = Partial<Omit<UniApp.
|
|
270
|
+
export type UploadConfig = Partial<Omit<UniApp.UploadFileOption, 'url' | 'header' | 'filePath' | 'name' | 'formData' | 'cancelToken'>> & {
|
|
254
271
|
/** 库自定义:请求基础地址 */
|
|
255
272
|
baseURL?: string;
|
|
256
273
|
/** 库自定义:headers支持对象或者返回对象的工厂函数 */
|
|
@@ -262,7 +279,7 @@ export type UploadConfig = Partial<Omit<UniApp.UploadFileOptions, 'url' | 'heade
|
|
|
262
279
|
* 下载config:uni.downloadFile配置,排除内部强制覆盖字段
|
|
263
280
|
* @note baseURL 为库自定义字段,非uni.downloadFile原生API字段
|
|
264
281
|
*/
|
|
265
|
-
export type DownloadConfig = Partial<Omit<UniApp.
|
|
282
|
+
export type DownloadConfig = Partial<Omit<UniApp.DownloadFileOption, 'url' | 'header' | 'cancelToken'>> & {
|
|
266
283
|
/** 库自定义:请求基础地址 */
|
|
267
284
|
baseURL?: string;
|
|
268
285
|
/** 库自定义:headers支持对象或者返回对象的工厂函数 */
|
|
@@ -316,7 +333,7 @@ export declare const CancelToken: {
|
|
|
316
333
|
*/
|
|
317
334
|
export declare function promisifyRequest(
|
|
318
335
|
type: 'request' | 'uploadFile' | 'downloadFile',
|
|
319
|
-
opts: Partial<UniApp.RequestOptions | UniApp.
|
|
336
|
+
opts: Partial<UniApp.RequestOptions | UniApp.UploadFileOption | UniApp.DownloadFileOption>
|
|
320
337
|
): Promise<UniAnyResult>;
|
|
321
338
|
|
|
322
339
|
/**
|
package/lib/http/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("../_rollupPluginBabelHelpers-fa19b5b2.js"),H=require("../object/index.js"),U=require("../magic/index.js");var M=["cancelToken"],G=["headers"],J=["adapter"],x=["keyName","filePath"],S=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"}),C=Object.seal(function(){var e=Object.create(null);function o(a){var
|
|
1
|
+
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("../_rollupPluginBabelHelpers-fa19b5b2.js"),H=require("../object/index.js"),U=require("../magic/index.js");var M=["cancelToken"],G=["headers"],J=["adapter"],x=["keyName","filePath"],S=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"}),C=Object.seal(function(){var e=Object.create(null);function o(a){var r=e[a];typeof(r==null?void 0:r.abort)=="function"&&r.abort()}return Object.seal({add:function(r,n){e[r]=n},delete:function(r){Reflect.deleteProperty(e,r)},_cancel:o,cancelAll:function(){Object.values(e).forEach(function(r){typeof(r==null?void 0:r.abort)=="function"&&r.abort()}),Object.keys(e).forEach(function(r){return delete e[r]})},source:function(){var r="".concat(Date.now(),"-").concat(U.getRandomStr(16));return{token:r,cancel:function(){return o(r)}}}})}());function w(e,o){return new Promise(function(a,r){var n=o.cancelToken,c=t._objectWithoutProperties(o,M),l=uni[e](t._objectSpread2(t._objectSpread2({},c),{},{success:function(i){if(i.statusCode>=200&&i.statusCode<300)return a(i);var f=new Error("HTTP status ".concat(i.statusCode));r(Object.assign(f,{type:"fail",res:i}))},fail:function(i){var f=new Error(i.errMsg||"request fail");r(Object.assign(f,{type:"fail",res:i}))},complete:function(){n&&C.delete(n)}}));n&&C.add(n,l)})}var T=0,O=!1;function D(e){O||(O=!0,uni.showLoading({title:e,mask:!0}))}function W(){O&&(O=!1,uni.hideLoading())}function z(){var e=arguments.length>0&&arguments[0]!==void 0?arguments[0]:"加载中...";T++,T===1&&D(e)}function $(){T>0&&T--,T===0&&W()}function N(e,o){return function(a,r,n,c){return e(a,o,r,n,c)}}function I(e){return typeof e=="function"?e:function(){return e||{}}}function E(e){var o=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{},a=arguments.length>2&&arguments[2]!==void 0?arguments[2]:{},r=I(o.headers)(),n=I(a.headers)(),c=t._objectSpread2(t._objectSpread2(t._objectSpread2({},o),a),{},{headers:t._objectSpread2(t._objectSpread2({},r),n)}),l=c.headers,s=t._objectWithoutProperties(c,G),i=e.startsWith("http")?e:c.baseURL?"".concat(c.baseURL.replace(/\/+$/,""),"/").concat(e.replace(/^\/+/,"")):e;return{urlRes:i,headers:l,configRes:s}}function P(e){return typeof e=="function"?[e]:Array.isArray(e)?e.filter(function(o){return typeof o=="function"}):[]}function Y(e){var o=e.url,a=e.invokeArgs,r=a===void 0?{}:a,n=e.options,c=n===void 0?{}:n,l=e.cacheConfig,s=l===void 0?{}:l,i=s.adapter,f=t._objectWithoutProperties(s,J),d=t._objectSpread2({enable:!1,key:"",prefix:"api",expire:60*60,adapter:null},f);if(!d.key){var v=(d.prefix||"api").replace(/:$/,"");d.key="".concat(v,":").concat(o)}if(d.enable&&(typeof i=="function"&&(i=i({url:o,config:r,options:c,cacheConfig:d})),!(i&&typeof i.get=="function"&&typeof i.set=="function")))throw new Error("开启缓存(cacheConfig.enable=true)时,请在cacheConfig传入对应adapter的适配器,适配器必须实现 get(key)、set(key,value,expire) 方法");return Object.freeze(t._objectSpread2(t._objectSpread2({},d),{},{adapter:i}))}function F(e){var o=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{},a=arguments.length>2&&arguments[2]!==void 0?arguments[2]:{},r=t._objectSpread2(t._objectSpread2({qs:!0,showError:!0,cacheConfig:{},loadingText:e,loading:!0,reqInterceptor:function(c){return c},resInterceptor:function(c){return c},errInterceptor:function(){}},o),a);return["reqInterceptor","resInterceptor","errInterceptor"].forEach(function(n){var c=[].concat(t._toConsumableArray(P(o[n])),t._toConsumableArray(P(a[n])));r[n]=c.length?U.composeAsync.apply(void 0,t._toConsumableArray(c)):function(l){return l}}),r}function q(e,o){var a=Array.from(o);return function(){return e.apply(void 0,t._toConsumableArray(H.cloneDeepWithDescriptors(a)))}}function L(e,o,a,r,n){return A.apply(this,arguments)}function A(){return A=t._asyncToGenerator(t._regenerator().m(function e(o,a,r,n,c){var l,s,i,f,d,v,h;return t._regenerator().w(function(u){for(;;)switch(u.p=u.n){case 0:return l=null,n.loading&&(z(n.loadingText),l=function(){$(),l=null}),u.p=1,u.n=2,n.reqInterceptor({config:r,opts:n});case 2:return s=u.v,u.n=3,o(a,s);case 3:return i=u.v,u.n=4,n.resInterceptor({res:i,config:r,options:n,reloadFn:c});case 4:return f=u.v,u.a(2,f);case 5:return u.p=5,h=u.v,u.n=6,n.errInterceptor({err:h,config:r,options:n,reloadFn:c});case 6:if(d=u.v,d===void 0){u.n=7;break}return u.a(2,d);case 7:return u.a(2,Promise.reject(h));case 8:return u.p=8,(v=l)===null||v===void 0||v(),u.f(8);case 9:return u.a(2)}},e,null,[[1,5,8,9]])})),A.apply(this,arguments)}function B(e,o){function a(r,n,c,l,s){var i=C.source(),f=q(a,arguments),d=E(r,e,l),v=d.urlRes,h=d.headers,u=d.configRes,g=F("加载中...",o,s),k=n.toUpperCase()==="GET",R=k?S.JSON:g.qs?S.FORM_URLENCODED:S.JSON,m=t._objectSpread2({cancelToken:i.token,method:n,url:v,data:c,header:t._objectSpread2({"Content-Type":R},h)},u),p=Y({url:r,invokeArgs:m,options:g,cacheConfig:t._objectSpread2(t._objectSpread2({},o.cacheConfig),s==null?void 0:s.cacheConfig)}),b=p.enable;if(b){var _=p.adapter.get(p.key);if(_)return Promise.resolve(_)}var y=L(w,"request",m,t._objectSpread2(t._objectSpread2({},g),{},{cacheConfig:p}),f).then(function(j){return b&&p.adapter.set(p.key,j,p.expire),j});return y.cancel=i.cancel,y.token=i.token,y}return a.get=N(a,"get"),a.post=N(a,"post"),a}function V(e,o){return function a(r,n,c,l){var s=C.source(),i=q(a,arguments),f=E(r,e,c),d=f.urlRes,v=f.headers,h=f.configRes,u=F("上传中...",o,l),g=t._objectSpread2({keyName:"file"},n),k=g.keyName,R=k===void 0?"file":k,m=g.filePath,p=t._objectWithoutProperties(g,x);function b(j){return j?!!(j.startsWith("wxfile://tmp")||j.startsWith("http://tmp")||j.startsWith("http://temp")||j.startsWith("blob:")||j.startsWith("_doc/")):!1}if(!b(m))return Promise.resolve({data:m});var _=t._objectSpread2({cancelToken:s.token,url:d,filePath:m,name:R,formData:p,header:t._objectSpread2({},v)},h),y=L(w,"uploadFile",_,u,i);return y.cancel=s.cancel,y.token=s.token,y}}function X(e,o){return function a(r,n,c,l){var s=C.source(),i=q(a,arguments),f=E(r,e,c),d=f.urlRes,v=f.headers,h=f.configRes,u=F("下载中...",o,l),g=d;if(n&&t._typeof(n)==="object"&&!Array.isArray(n)){var k=Object.entries(n).filter(function(p){var b=t._slicedToArray(p,2),_=b[1];return _!=null&&_!==""}).map(function(p){var b=t._slicedToArray(p,2),_=b[0],y=b[1];return"".concat(encodeURIComponent(_),"=").concat(encodeURIComponent(y))}).join("&");k&&(g+=(g.includes("?")?"&":"?")+k)}var R=t._objectSpread2({cancelToken:s.token,url:g,header:t._objectSpread2({},v)},h),m=L(w,"downloadFile",R,u,i);return m.cancel=s.cancel,m.token=s.token,m}}exports.CONTENT_TYPES=S;exports.CancelToken=C;exports.createDownloadFile=X;exports.createRequest=B;exports.createUploadFile=V;exports.endLoading=$;exports.hideLoading=W;exports.promisifyRequest=w;exports.showLoading=D;exports.startLoading=z;
|