@dcloudio/uni-app-x 0.5.0 → 0.5.2

package/types/uni/{ext → uts-plugin-api}/lib/uni-network/utssdk/app-ios/interface.d.ts

@@ -11,25 +11,31 @@ export type RequestOptions = {
   url: string,
   /**
    * 请求的参数 Object|String类型
-   * @type {RequestDataOptions}
+   * @type {RequestDataOptions}
+   * @defaultValue null
    */
   data?: any | null,
   /**
-   * 设置请求的 header，header 中不能设置 Referer
+   * 设置请求的 header，header 中不能设置 Referer
+   * @defaultValue null
    */
   header?: UTSJSONObject,
   /**
    * 请求类型 默认值GET	
    * GET|POST|PUT|DELETE|HEAD|OPTIONS
-   * @type {RequestMethod}
+   * @type {RequestMethod}
+   * @defaultValue "GET"
    */
-  method?: string | null,
+  method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS"| null,
   /**
-   * 超时时间，单位 ms
+   * 超时时间，单位 ms
+   * @defaultValue 60000
    */
   timeout?: number | null,
   /**
-   * 如果设为 json，会对返回的数据进行一次 JSON.parse，非 json 不会进行 JSON.parse
+   * 如果设为 json，会对返回的数据进行一次 JSON.parse，非 json 不会进行 JSON.parse
+   * @defaultValue "json"
+   * @deprecated 不支持
    */
   dataType?: string | null,
   /**
@@ -39,27 +45,47 @@ export type RequestOptions = {
    */
   responseType?: string | null,
   /**
-   * 验证 ssl 证书
+   * 验证 ssl 证书
+   * @deprecated 不支持
    */
   sslVerify?: boolean | null,
   /**
-   * 跨域请求时是否携带凭证（cookies）
+   * 跨域请求时是否携带凭证（cookies）
+   * 
+   * @uniPlatform {
+   *    "app": {
+   *        "android": {
+   *            "osVer": "4.4",
+   *  		  	 "uniVer": "√",
+   * 			 "unixVer": "x"
+   *        },
+   *        "ios": {
+   *            "osVer": "9.0",
+   *  		  	 "uniVer": "√",
+   * 			 "unixVer": "x"
+   *        }
+   *    }
+   * }
    */
   withCredentials?: boolean | null,
   /**
-   * DNS解析时优先使用ipv4
+   * DNS解析时优先使用ipv4
+   * @defaultValue false
    */
   firstIpv4?: boolean | null,
   /**
-   * 网络请求成功回调。
+   * 网络请求成功回调。
+   * @defaultValue null
    */
   success?: RequestSuccessCallback | null,
   /**
-   * 网络请求失败回调。
+   * 网络请求失败回调。
+   * @defaultValue null
    */
   fail?: RequestFailCallback | null,
   /**
-   * 网络请求完成回调，成功或者失败都会调用。
+   * 网络请求完成回调，成功或者失败都会调用。
+   * @defaultValue null
    */
   complete?: RequestCompleteCallback | null
 }
@@ -139,7 +165,22 @@ export type UploadFileOptionFiles = {
    */
   uri: string,
   /**
-   * 要上传的文件对象，仅H5（2.6.15+）支持
+   * 要上传的文件对象，仅H5（2.6.15+）支持
+   * 
+   * @uniPlatform {
+   *    "app": {
+   *        "android": {
+   *            "osVer": "4.4",
+   *  		  	 "uniVer": "√",
+   * 			 "unixVer": "x"
+   *        },
+   *        "ios": {
+   *            "osVer": "9.0",
+   *  		  	 "uniVer": "√",
+   * 			 "unixVer": "x"
+   *        }
+   *    }
+   * }
    */
   file: any | null
 };
@@ -234,7 +275,7 @@ export interface UploadTask {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -265,7 +306,7 @@ export interface UploadTask {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -358,7 +399,7 @@ export interface DownloadTask {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -389,7 +430,7 @@ export interface DownloadTask {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -475,7 +516,7 @@ export interface Uni {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -512,7 +553,7 @@ export interface Uni {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }

package/types/uni/{ext → uts-plugin-api}/lib/uni-network/utssdk/index.d.ts

@@ -2,6 +2,8 @@ import {
   Request as RequestOrigin,
   RequestOptions as RequestOptionsOrigin,
   RequestSuccess as RequestSuccessOrigin,
+  RequestMethod as RequestMethodOrigin,
+  RequestErrorCode as RequestErrorCodeOrigin,
   RequestFail as RequestFailOrigin,
   RequestSuccessCallback as RequestSuccessCallbackOrigin,
   RequestFailCallback as RequestFailCallbackOrigin,
@@ -36,6 +38,8 @@ declare global {
   type Request<T> = RequestOrigin<T>
   type RequestOptions<T> = RequestOptionsOrigin<T>
   type RequestSuccess<T> = RequestSuccessOrigin<T>
+  type RequestMethod = RequestMethodOrigin
+  type RequestErrorCode = RequestErrorCodeOrigin
   type RequestFail = RequestFailOrigin
   type RequestSuccessCallback<T> = RequestSuccessCallbackOrigin<T>
   type RequestFailCallback = RequestFailCallbackOrigin

package/types/uni/{ext → uts-plugin-api}/lib/uni-network/utssdk/interface.d.ts

@@ -1,4 +1,4 @@
-export type Request<T> = (param : RequestOptions<T>) => RequestTask | null;
+export type Request<T> = (param: RequestOptions<T>) => RequestTask | null;
 
 /**
  * 网络请求参数
@@ -10,55 +10,83 @@ export type RequestOptions<T> = {
   url: string,
   /**
    * 请求的参数 Object|String类型
-   * @type {RequestDataOptions}
+   * @type {RequestDataOptions}
+   * @defaultValue null
    */
   data?: any | null,
   /**
-   * 设置请求的 header，header 中不能设置 Referer
+   * 设置请求的 header，header 中不能设置 Referer
+   * @defaultValue null
    */
-  header?: UTSJSONObject,
+  header?: UTSJSONObject | null,
   /**
    * 请求类型 默认值GET	
    * GET|POST|PUT|DELETE|HEAD|OPTIONS
-   * @type {RequestMethod}
+   * @type {RequestMethod}
+   * @defaultValue "GET"
    */
-  method?: string | null,
+  method?: RequestMethod | null,
   /**
-   * 超时时间，单位 ms
+   * 超时时间，单位 ms
+   * @defaultValue 60000
    */
   timeout?: number | null,
   /**
-   * 如果设为 json，会对返回的数据进行一次 JSON.parse，非 json 不会进行 JSON.parse
+   * 如果设为 json，会对返回的数据进行一次 JSON.parse，非 json 不会进行 JSON.parse
+   * @defaultValue "json"
+   * @deprecated 不支持
    */
   dataType?: string | null,
   /**
-   * 设置响应的数据类型。
-   * 
+   * 设置响应的数据类型。
+   * 
    * @deprecated 不支持
    */
   responseType?: string | null,
   /**
-   * 验证 ssl 证书
+   * 验证 ssl 证书
+   * 
+   * @deprecated 不支持
    */
   sslVerify?: boolean | null,
-  /**
-   * 跨域请求时是否携带凭证（cookies）
+  /**
+   * 跨域请求时是否携带凭证（cookies）
+   * 
+   * @uniPlatform {
+   *    "app": {
+   *        "android": {
+   *            "osVer": "4.4",
+   *  		  	 "uniVer": "√",
+   * 			 "unixVer": "x"
+   *        },
+   *        "ios": {
+   *            "osVer": "9.0",
+   *  		  	 "uniVer": "√",
+   * 			 "unixVer": "x"
+   *        }
+   *    }
+   * }
+   * 
    */
   withCredentials?: boolean | null,
   /**
-   * DNS解析时优先使用ipv4
+   * DNS解析时优先使用ipv4
+   * @defaultValue false
    */
   firstIpv4?: boolean | null,
   /**
-   * 网络请求成功回调。
+   * 网络请求成功回调。
+   * @defaultValue null
    */
   success?: RequestSuccessCallback<T> | null,
   /**
-   * 网络请求失败回调。
+   * 网络请求失败回调。
+   * @defaultValue null
    */
   fail?: RequestFailCallback | null,
   /**
-   * 网络请求完成回调，成功或者失败都会调用。
+   * 网络请求完成回调，成功或者失败都会调用。
+   * @defaultValue null
    */
   complete?: RequestCompleteCallback | null
 }
@@ -81,9 +109,32 @@ export type RequestSuccess<T> = {
    * 开发者服务器返回的 cookies，格式为字符串数组
    */
   cookies: Array<string>
-}
+}
+
+/**
+ * 请求方式
+ */
+export type RequestMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS";
 
-export type RequestFail = UniError;
+/**
+ * 错误码
+ * - 5 接口超时
+ * - 1000 服务端系统错误
+ * - 100001 json数据解析错误
+ * - 100002 错误信息json解析失败
+ * - 600000 未知的网络错误
+ * - 600003 网络中断
+ * - 600009 URL格式不合法
+ * - 600010 请求的 data 序列化失败
+ * - 602001 request系统错误
+ */
+export type RequestErrorCode = 5 | 1000 | 100001 | 100002 | 600000 | 600003 | 600009 | 600010  | 602001;
+/**
+ * 网络请求失败的错误回调参数
+ */
+export interface RequestFail extends IUniError{
+	errCode: RequestErrorCode
+};
 export type RequestSuccessCallback<T> = (option: RequestSuccess<T>) => void;
 export type RequestFailCallback = (option: RequestFail) => void;
 export type RequestCompleteCallback = (option: any) => void;
@@ -123,14 +174,14 @@ export interface RequestTask {
   abort(): void
 }
 
-
 //===============================上传==================================
 
 
 export type UploadFile = (options: UploadFileOptions) => UploadTask | null;
 export type UploadFileOptionFiles = {
   /**
-   * multipart 提交时，表单的项目名，默认为 file，如果 name 不填或填的值相同，可能导致服务端读取文件时只能读取到一个文件。
+   * multipart 提交时，表单的项目名，默认为 file，如果 name 不填或填的值相同，可能导致服务端读取文件时只能读取到一个文件。
+   * @defaultValue "file"
    */
   name: string | null,
   /**
@@ -138,7 +189,21 @@ export type UploadFileOptionFiles = {
    */
   uri: string,
   /**
-   * 要上传的文件对象，仅H5（2.6.15+）支持
+   * 要上传的文件对象
+    * @uniPlatform {
+    *    "app": {
+    *        "android": {
+    *            "osVer": "4.4",
+    *  		  	 "uniVer": "√",
+    * 			 "unixVer": "x"
+    *        },
+    *        "ios": {
+    *            "osVer": "9.0",
+    *  		  	 "uniVer": "√",
+    * 			 "unixVer": "x"
+    *        }
+    *    }
+    * }
    */
   file: any | null
 };
@@ -152,8 +217,13 @@ export type UploadFileSuccess = {
    */
   statusCode: number
 };
-export type UploadFileSuccessCallback = (result: UploadFileSuccess) => void;
-export type UploadFileFail = UniError;
+export type UploadFileSuccessCallback = (result: UploadFileSuccess) => void;
+/**
+ * 上传文件失败的错误回调参数
+ */
+export interface UploadFileFail extends IUniError{
+	errCode: RequestErrorCode
+};
 export type UploadFileFailCallback = (result: UploadFileFail) => void;
 
 export type UploadFileCompleteCallback = (result: any) => void;
@@ -163,39 +233,48 @@ export type UploadFileOptions = {
    */
   url: string,
   /**
-   * 要上传文件资源的路径
+   * 要上传文件资源的路径
+   * @defaultValue null
    */
   filePath?: string | null,
   /**
-   * 文件对应的 key , 开发者在服务器端通过这个 key 可以获取到文件二进制内容
+   * 文件对应的 key , 开发者在服务器端通过这个 key 可以获取到文件二进制内容
+   * @defaultValue null
    */
   name?: string | null,
   /**
-   * 需要上传的文件列表。
+   * 需要上传的文件列表。
+   * @defaultValue null
    */
   files?: (UploadFileOptionFiles[]) | null,
   /**
-   * HTTP 请求 Header, header 中不能设置 Referer
+   * HTTP 请求 Header, header 中不能设置 Referer
+   * @defaultValue null
    */
   header?: UTSJSONObject | null,
   /**
-   * HTTP 请求中其他额外的 form data
+   * HTTP 请求中其他额外的 form data
+   * @defaultValue null
    */
   formData?: UTSJSONObject | null,
   /**
-   * 超时时间，单位 ms
+   * 超时时间，单位 ms
+   * @defaultValue 120000
    */
   timeout?: number | null,
   /**
-   * 成功返回的回调函数
+   * 成功返回的回调函数
+   * @defaultValue null
    */
   success?: UploadFileSuccessCallback | null,
   /**
-   * 失败的回调函数
+   * 失败的回调函数
+   * @defaultValue null
    */
   fail?: UploadFileFailCallback | null,
   /**
-   * 结束的回调函数（调用成功、失败都会执行）
+   * 结束的回调函数（调用成功、失败都会执行）
+   * @defaultValue null
    */
   complete?: UploadFileCompleteCallback | null
 };
@@ -233,7 +312,7 @@ export interface UploadTask {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -264,7 +343,7 @@ export interface UploadTask {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -293,8 +372,13 @@ export type DownloadFileSuccess = {
    */
   statusCode: number
 };
-export type DownloadFileSuccessCallback = (result: DownloadFileSuccess) => void;
-export type DownloadFileFail = UniError;
+export type DownloadFileSuccessCallback = (result: DownloadFileSuccess) => void;
+/**
+ * 下载文件失败的错误回调参数
+ */
+export interface DownloadFileFail extends IUniError{
+	errCode: RequestErrorCode
+};
 export type DownloadFileFailCallback = (result: DownloadFileFail) => void;
 export type DownloadFileComplete = any;
 export type DownloadFileCompleteCallback = (result: DownloadFileComplete) => void;
@@ -304,23 +388,28 @@ export type DownloadFileOptions = {
    */
   url: string,
   /**
-   * HTTP 请求 Header，header 中不能设置 Referer
+   * HTTP 请求 Header，header 中不能设置 Referer
+   * @defaultValue null
    */
   header?: UTSJSONObject | null,
   /**
-   * 超时时间，单位 ms
+   * 超时时间，单位 ms
+   * @defaultValue 120000
    */
   timeout?: number | null,
   /**
-   * 下载成功后以 tempFilePath 的形式传给页面，res = {tempFilePath: '文件的临时路径'}
+   * 下载成功后以 tempFilePath 的形式传给页面，res = {tempFilePath: '文件的临时路径'}
+   * @defaultValue null
    */
   success?: DownloadFileSuccessCallback | null,
   /**
-   * 失败的回调函数
+   * 失败的回调函数
+   * @defaultValue null
    */
   fail?: DownloadFileFailCallback | null,
   /**
-   * 结束的回调函数（调用成功、失败都会执行）
+   * 结束的回调函数（调用成功、失败都会执行）
+   * @defaultValue null
    */
   complete?: DownloadFileCompleteCallback | null
 };
@@ -357,7 +446,7 @@ export interface DownloadTask {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -388,7 +477,7 @@ export interface DownloadTask {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -456,7 +545,7 @@ export interface Uni {
             });
      ```
     */
-  request: Request<T>,
+  request<T>(param: RequestOptions<T>): RequestTask | null;
   /**
     * UploadFile()
     * @description 
@@ -474,7 +563,7 @@ export interface Uni {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -493,7 +582,7 @@ export interface Uni {
             });
      ```
     */
-  uploadFile: UploadFile,
+  uploadFile(options: UploadFileOptions): UploadTask | null;
   /**
     * DownloadFile()
     * @description 
@@ -511,7 +600,7 @@ export interface Uni {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -525,5 +614,5 @@ export interface Uni {
               });
      ```
     */
-  downloadFile: DownloadFile
+  downloadFile(options: DownloadFileOptions): DownloadTask | null;
 }

package/types/uni/{ext → uts-plugin-api}/lib/uni-openAppAuthorizeSetting/utssdk/interface.d.ts

@@ -17,7 +17,7 @@ export interface Uni {
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "x"
     *        }
     *    }
     * }
@@ -26,7 +26,7 @@ export interface Uni {
       uni.openAppAuthorizeSetting({});
      ```
     */
-  openAppAuthorizeSetting: OpenAppAuthorizeSetting;
+  openAppAuthorizeSetting(options: OpenAppAuthorizeSettingOptions): void;
 }
 
 export type OpenAppAuthorizeSetting = (options: OpenAppAuthorizeSettingOptions) => void;
@@ -53,15 +53,18 @@ export type OpenAppAuthorizeSettingComplete = {
 export type OpenAppAuthorizeSettingCompleteCallback = (result: OpenAppAuthorizeSettingComplete) => void;
 export type OpenAppAuthorizeSettingOptions = {
   /**
-   * 接口调用成功的回调函数
+   * 接口调用成功的回调函数
+   * @defaultValue null
    */
   success?: OpenAppAuthorizeSettingSuccessCallback | null,
   /**
-   * 接口调用失败的回调函数
+   * 接口调用失败的回调函数
+   * @defaultValue null
    */
   fail?: OpenAppAuthorizeSettingFailCallback | null,
   /**
-   * 接口调用结束的回调函数（调用成功、失败都会执行）
+   * 接口调用结束的回调函数（调用成功、失败都会执行）
+   * @defaultValue null
    */
   complete?: OpenAppAuthorizeSettingCompleteCallback | null
 };

package/types/uni/{ext → uts-plugin-api}/lib/uni-prompt/utssdk/interface.d.ts

@@ -443,7 +443,7 @@ export interface Uni {
    *    }
    * }
    */
-  showToast: ShowToast,
+  showToast(options: ShowToastOptions): void,
   /**
    * @description 隐藏消息提示框。
    * @example
@@ -466,7 +466,7 @@ export interface Uni {
    *    }
    * }
    */
-  hideToast: HideToast,
+  hideToast(): void,
   /**
    * @description 显示 loading 提示框, 需主动调用 uni.hideLoading 才能关闭提示框。
    * @param {ShowLoadingOptions} option
@@ -495,7 +495,7 @@ export interface Uni {
    *    }
    * }
    */
-  showLoading: ShowLoading,
+  showLoading(options: ShowLoadingOptions): void,
   /**
    * @description 隐藏 loading 提示框。
    * @example
@@ -525,7 +525,7 @@ export interface Uni {
    *    }
    * }
    */
-  hideLoading: HideLoading,
+  hideLoading():void,
   /**
    * @description 显示模态弹窗，可以只有一个确定按钮，也可以同时有确定和取消按钮。类似于一个API整合了 html 中：alert、confirm。
    * @param {ShowModalOptions} option
@@ -561,7 +561,7 @@ export interface Uni {
    *    }
    * }
    */
-  showModal: ShowModal,
+  showModal(options: ShowModalOptions) :  void,
   /**
    * @description 从底部向上弹出操作菜单
    * @param {ShowActionSheetOptions} option
@@ -593,5 +593,5 @@ export interface Uni {
    *    }
    * }
    */
-  showActionSheet: ShowActionSheet
+  showActionSheet(options: ShowActionSheetOptions) : void
 }