@dcloudio/uni-app-x 0.5.4 → 0.5.6

package/types/uni/uts-plugin-api/lib/uni-network/utssdk/interface.d.ts

@@ -9,83 +9,86 @@ export type RequestOptions<T> = {
    */
   url: string,
   /**
-   * 请求的参数 Object|String类型
-   * @type {RequestDataOptions}
+   * 请求的参数 UTSJSONObject|string类型
+   * @type {RequestDataOptions}
    * @defaultValue null
    */
   data?: any | null,
   /**
-   * 设置请求的 header，header 中不能设置 Referer
+   * 设置请求的 header，header 中不能设置 Referer
    * @defaultValue null
    */
   header?: UTSJSONObject | null,
   /**
-   * 请求类型 默认值GET	
-   * GET|POST|PUT|DELETE|HEAD|OPTIONS
-   * @type {RequestMethod}
+   * 请求方法
+   * 如果设置的值不在取值范围内，会以GET方法进行请求。
+   * @type {RequestMethod}
    * @defaultValue "GET"
    */
   method?: RequestMethod | null,
   /**
-   * 超时时间，单位 ms
+   * 超时时间，单位 ms
    * @defaultValue 60000
    */
   timeout?: number | null,
   /**
-   * 如果设为 json，会对返回的数据进行一次 JSON.parse，非 json 不会进行 JSON.parse
-   * @defaultValue "json"
-   * @deprecated 不支持
+   * 如果设为 json，会对返回的数据进行一次 JSON.parse，非 json 不会进行 JSON.parse
+   * @defaultValue "json"
+   * @deprecated 不支持
+   * @autodoc false
    */
   dataType?: string | null,
   /**
    * 设置响应的数据类型。
    * 
-   * @deprecated 不支持
+   * @deprecated 不支持
+   * @autodoc false
    */
   responseType?: string | null,
   /**
-   * 验证 ssl 证书
-   * 
-   * @deprecated 不支持
+   * 验证 ssl 证书
+   * 
+   * @deprecated 不支持
+   * @autodoc false
    */
   sslVerify?: boolean | null,
-  /**
-   * 跨域请求时是否携带凭证（cookies）
-   * 
-   * @uniPlatform {
-   *    "app": {
-   *        "android": {
-   *            "osVer": "4.4",
-   *  		  	 "uniVer": "√",
-   * 			 "unixVer": "x"
-   *        },
-   *        "ios": {
-   *            "osVer": "9.0",
-   *  		  	 "uniVer": "√",
-   * 			 "unixVer": "x"
-   *        }
-   *    }
-   * }
-   * 
+  /**
+   * 跨域请求时是否携带凭证（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
@@ -109,32 +112,39 @@ export type RequestSuccess<T> = {
    * 开发者服务器返回的 cookies，格式为字符串数组
    */
   cookies: Array<string>
-}
-
-/**
- * 请求方式
- */
-export type RequestMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS";
+}
+
+/**
+ * 请求方法
+ * - GET  GET方法请求一个指定资源的表示形式，使用 GET 的请求应该只被用于获取数据。
+ * - POST  POST方法用于将实体提交到指定的资源，通常导致在服务器上的状态变化或副作用。
+ * - PUT  PUT方法用有效载荷请求替换目标资源的所有当前表示。
+ * - PATCH  PATCH方法用于对资源应用部分修改。
+ * - DELETE  DELETE方法删除指定的资源。
+ * - HEAD  HEAD方法请求一个与GET请求的响应相同的响应，但没有响应体。 
+ * - OPTIONS  OPTIONS 方法用于描述目标资源的通信选项。
+ */
+export type RequestMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS";
 
-/**
- * 错误码
- * - 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;
-/**
- * 网络请求失败的错误回调参数
+/**
+ * 错误码
+ * - 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 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;
@@ -153,12 +163,12 @@ export interface RequestTask {
     *        "android": {
     *            "osVer": "4.4",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "3.9+"
     *        },
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "3.9+"
     *        }
     *    }
     * }
@@ -180,7 +190,7 @@ export interface RequestTask {
 export type UploadFile = (options: UploadFileOptions) => UploadTask | null;
 export type UploadFileOptionFiles = {
   /**
-   * multipart 提交时，表单的项目名，默认为 file，如果 name 不填或填的值相同，可能导致服务端读取文件时只能读取到一个文件。
+   * multipart 提交时，表单的项目名，默认为 file，如果 name 不填或填的值相同，可能导致服务端读取文件时只能读取到一个文件。
    * @defaultValue "file"
    */
   name: string | null,
@@ -189,7 +199,7 @@ export type UploadFileOptionFiles = {
    */
   uri: string,
   /**
-   * 要上传的文件对象
+   * 要上传的文件对象
     * @uniPlatform {
     *    "app": {
     *        "android": {
@@ -217,12 +227,12 @@ export type UploadFileSuccess = {
    */
   statusCode: number
 };
-export type UploadFileSuccessCallback = (result: UploadFileSuccess) => void;
-/**
- * 上传文件失败的错误回调参数
+export type UploadFileSuccessCallback = (result: UploadFileSuccess) => void;
+/**
+ * 上传文件失败的错误回调参数
  */
-export interface UploadFileFail extends IUniError{
-	errCode: RequestErrorCode
+export interface UploadFileFail extends IUniError{
+	errCode: RequestErrorCode
 };
 export type UploadFileFailCallback = (result: UploadFileFail) => void;
 
@@ -233,47 +243,47 @@ 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
@@ -307,7 +317,7 @@ export interface UploadTask {
     *        "android": {
     *            "osVer": "4.4",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "3.9+"
     *        },
     *        "ios": {
     *            "osVer": "9.0",
@@ -338,7 +348,7 @@ export interface UploadTask {
     *        "android": {
     *            "osVer": "4.4",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "3.9+"
     *        },
     *        "ios": {
     *            "osVer": "9.0",
@@ -372,12 +382,12 @@ export type DownloadFileSuccess = {
    */
   statusCode: number
 };
-export type DownloadFileSuccessCallback = (result: DownloadFileSuccess) => void;
-/**
- * 下载文件失败的错误回调参数
+export type DownloadFileSuccessCallback = (result: DownloadFileSuccess) => void;
+/**
+ * 下载文件失败的错误回调参数
  */
-export interface DownloadFileFail extends IUniError{
-	errCode: RequestErrorCode
+export interface DownloadFileFail extends IUniError{
+	errCode: RequestErrorCode
 };
 export type DownloadFileFailCallback = (result: DownloadFileFail) => void;
 export type DownloadFileComplete = any;
@@ -388,27 +398,36 @@ export type DownloadFileOptions = {
    */
   url: string,
   /**
-   * HTTP 请求 Header，header 中不能设置 Referer
+   * HTTP 请求 Header，header 中不能设置 Referer
    * @defaultValue null
    */
-  header?: UTSJSONObject | null,
+  header?: UTSJSONObject | null,
+  /**
+   * 指定文件下载路径
+   * 支持相对路径与绝对路径，例：
+   * `/imgs/pic.png`、`/storage/emulated/0/Android/data/io.dcloud.HBuilder/apps/HBuilder/temp/imgs/pic.png`
+   * 并且支持指定下载目录，例：
+   * `/imgs/`
+   * @defaultValue null
+   */
+  filePath?: string | 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
@@ -441,7 +460,7 @@ export interface DownloadTask {
     *        "android": {
     *            "osVer": "4.4",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "3.9+"
     *        },
     *        "ios": {
     *            "osVer": "9.0",
@@ -472,7 +491,7 @@ export interface DownloadTask {
     *        "android": {
     *            "osVer": "4.4",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "3.9+"
     *        },
     *        "ios": {
     *            "osVer": "9.0",
@@ -507,12 +526,12 @@ export interface Uni {
     *        "android": {
     *            "osVer": "4.4",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "3.9+"
     *        },
     *        "ios": {
     *            "osVer": "9.0",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "3.9+"
     *        }
     *    }
     * }
@@ -558,7 +577,7 @@ export interface Uni {
     *        "android": {
     *            "osVer": "4.4",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "3.9+"
     *        },
     *        "ios": {
     *            "osVer": "9.0",
@@ -595,7 +614,7 @@ export interface Uni {
     *        "android": {
     *            "osVer": "4.4",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "3.9+"
     *        },
     *        "ios": {
     *            "osVer": "9.0",

package/types/uni/uts-plugin-api/lib/uni-openAppAuthorizeSetting/utssdk/interface.d.ts

@@ -12,7 +12,7 @@ export interface Uni {
     *        "android": {
     *            "osVer": "4.4",
     *  		  	 "uniVer": "√",
-    * 			 "unixVer": "3.9.0"
+    * 			 "unixVer": "3.9+"
     *        },
     *        "ios": {
     *            "osVer": "9.0",
@@ -53,17 +53,17 @@ 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/uts-plugin-api/lib/uni-push/utssdk/index.d.ts

@@ -0,0 +1,55 @@
+import {
+  GetPushClientId as GetPushClientIdOrigin,
+  GetPushClientIdSuccess as GetPushClientIdSuccessOrigin,
+  GetPushClientIdSuccessCallback as GetPushClientIdSuccessCallbackOrigin,
+  GetPushClientIdFail as GetPushClientIdFailOrigin,
+  GetPushClientIdFailCallback as GetPushClientIdFailCallbackOrigin,
+  GetPushClientIdComplete as GetPushClientIdCompleteOrigin,
+  GetPushClientIdCompleteCallback as GetPushClientIdCompleteCallbackOrigin,
+  GetPushClientIdOptions as GetPushClientIdOptionsOrigin,
+  OnPushMessageType as OnPushMessageTypeOrigin,
+  OnPushMessageCallbackResult as OnPushMessageCallbackResultOrigin,
+  OnPushMessageCallback as OnPushMessageCallbackOrigin,
+  OnPushMessage as OnPushMessageOrigin,
+  OffPushMessage as OffPushMessageOrigin,
+  GetChannelManager as GetChannelManagerOrigin,
+  SetPushChannelOptions as SetPushChannelOptionsOrigin,
+  ChannelManager as ChannelManagerOrigin,
+  CreatePushMessage as CreatePushMessageOrigin,
+  CreatePushMessageSuccess as CreatePushMessageSuccessOrigin,
+  CreatePushMessageSuccessCallback as CreatePushMessageSuccessCallbackOrigin,
+  CreatePushMessageFail as CreatePushMessageFailOrigin,
+  CreatePushMessageFailCallback as CreatePushMessageFailCallbackOrigin,
+  CreatePushMessageComplete as CreatePushMessageCompleteOrigin,
+  CreatePushMessageCompleteCallback as CreatePushMessageCompleteCallbackOrigin,
+  CreatePushMessageOptions as CreatePushMessageOptionsOrigin,
+  Uni as UniOrigin
+} from './interface'
+
+declare global {
+  type GetPushClientId = GetPushClientIdOrigin
+  type GetPushClientIdSuccess = GetPushClientIdSuccessOrigin
+  type GetPushClientIdSuccessCallback = GetPushClientIdSuccessCallbackOrigin
+  type GetPushClientIdFail = GetPushClientIdFailOrigin
+  type GetPushClientIdFailCallback = GetPushClientIdFailCallbackOrigin
+  type GetPushClientIdComplete = GetPushClientIdCompleteOrigin
+  type GetPushClientIdCompleteCallback = GetPushClientIdCompleteCallbackOrigin
+  type GetPushClientIdOptions = GetPushClientIdOptionsOrigin
+  type OnPushMessageType = OnPushMessageTypeOrigin
+  type OnPushMessageCallbackResult = OnPushMessageCallbackResultOrigin
+  type OnPushMessageCallback = OnPushMessageCallbackOrigin
+  type OnPushMessage = OnPushMessageOrigin
+  type OffPushMessage = OffPushMessageOrigin
+  type GetChannelManager = GetChannelManagerOrigin
+  type SetPushChannelOptions = SetPushChannelOptionsOrigin
+  type ChannelManager = ChannelManagerOrigin
+  type CreatePushMessage = CreatePushMessageOrigin
+  type CreatePushMessageSuccess = CreatePushMessageSuccessOrigin
+  type CreatePushMessageSuccessCallback = CreatePushMessageSuccessCallbackOrigin
+  type CreatePushMessageFail = CreatePushMessageFailOrigin
+  type CreatePushMessageFailCallback = CreatePushMessageFailCallbackOrigin
+  type CreatePushMessageComplete = CreatePushMessageCompleteOrigin
+  type CreatePushMessageCompleteCallback = CreatePushMessageCompleteCallbackOrigin
+  type CreatePushMessageOptions = CreatePushMessageOptionsOrigin
+  interface Uni extends UniOrigin { }
+}