@dcloudio/uni-app-x 0.3.0 → 0.4.0

package/types/uni/ext/lib/uni-exit/utssdk/index.d.ts

@@ -0,0 +1,19 @@
+import {
+  ExitSuccess as ExitSuccessOrigin,
+  ExitSuccessCallback as ExitSuccessCallbackOrigin,
+  ExitFailCallback as ExitFailCallbackOrigin,
+  ExitCompleteCallback as ExitCompleteCallbackOrigin,
+  ExitOptions as ExitOptionsOrigin,
+  Exit as ExitOrigin,
+  Uni as UniOrigin
+} from './interface'
+
+declare global {
+  type ExitSuccess = ExitSuccessOrigin
+  type ExitSuccessCallback = ExitSuccessCallbackOrigin
+  type ExitFailCallback = ExitFailCallbackOrigin
+  type ExitCompleteCallback = ExitCompleteCallbackOrigin
+  type ExitOptions = ExitOptionsOrigin
+  type Exit = ExitOrigin
+  interface Uni extends UniOrigin { }
+}

package/types/uni/ext/lib/uni-exit/utssdk/interface.d.ts

@@ -0,0 +1,63 @@
+/**
+ * uni.exit成功回调参数
+ */
+export type ExitSuccess = {
+  errMsg: string
+}
+
+/**
+ * uni.exit成功回调函数定义
+ */
+export type ExitSuccessCallback = (res: ExitSuccess) => void
+/**
+ * uni.exit失败回调函数定义
+ */
+export type ExitFailCallback = (res: UniError) => void
+/**
+ * uni.exit完成回调函数定义
+ */
+export type ExitCompleteCallback = (res: any) => void
+
+/**
+ * uni.exit参数定义
+ */
+export type ExitOptions = {
+  /**
+   * 接口调用成功的回调函数
+   */
+  success: ExitSuccessCallback | null,
+  /**
+   * 接口调用失败的回调函数
+   */
+  fail: ExitFailCallback | null,
+  /**
+   * 接口调用结束的回调函数（调用成功、失败都会执行）
+   */
+  complete: ExitCompleteCallback | null
+}
+
+
+export interface Uni {
+
+  /**
+   * 退出当前应用
+   * @uniPlatform {
+   *    "app": {
+   *        "android": {
+   *            "osVer": "4.4.4",
+   *            "uniVer": "√",
+   *            "unixVer": "3.9.0"
+   *        },
+   *        "ios": {
+   *            "osVer": "x",
+   *            "uniVer": "x",
+   *            "unixVer": "x"
+   *   	  }
+   *    }
+   * }
+   * @uniVueVersion 2,3  //支持的vue版本
+   */
+  exit: Exit;
+}
+
+export type Exit = (options?: ExitOptions | null) => void;

package/types/uni/ext/lib/uni-file-manager/utssdk/index.d.ts

@@ -0,0 +1,33 @@
+import {
+  ReadFileSuccessResult as ReadFileSuccessResultOrigin,
+  ReadFileFailResult as ReadFileFailResultOrigin,
+  ReadFileSuccessCallback as ReadFileSuccessCallbackOrigin,
+  ReadFileFailCallback as ReadFileFailCallbackOrigin,
+  ReadFileCompleteCallback as ReadFileCompleteCallbackOrigin,
+  ReadFileOptions as ReadFileOptionsOrigin,
+  WriteFileSuccessResult as WriteFileSuccessResultOrigin,
+  WriteFileFailResult as WriteFileFailResultOrigin,
+  WriteFileSuccessCallback as WriteFileSuccessCallbackOrigin,
+  WriteFileFailCallback as WriteFileFailCallbackOrigin,
+  WriteFileCompleteCallback as WriteFileCompleteCallbackOrigin,
+  WriteFileOptions as WriteFileOptionsOrigin,
+  GetFileSystemManager as GetFileSystemManagerOrigin,
+  Uni as UniOrigin
+} from './interface'
+
+declare global {
+  type ReadFileSuccessResult = ReadFileSuccessResultOrigin
+  type ReadFileFailResult = ReadFileFailResultOrigin
+  type ReadFileSuccessCallback = ReadFileSuccessCallbackOrigin
+  type ReadFileFailCallback = ReadFileFailCallbackOrigin
+  type ReadFileCompleteCallback = ReadFileCompleteCallbackOrigin
+  type ReadFileOptions = ReadFileOptionsOrigin
+  type WriteFileSuccessResult = WriteFileSuccessResultOrigin
+  type WriteFileFailResult = WriteFileFailResultOrigin
+  type WriteFileSuccessCallback = WriteFileSuccessCallbackOrigin
+  type WriteFileFailCallback = WriteFileFailCallbackOrigin
+  type WriteFileCompleteCallback = WriteFileCompleteCallbackOrigin
+  type WriteFileOptions = WriteFileOptionsOrigin
+  type GetFileSystemManager = GetFileSystemManagerOrigin
+  interface Uni extends UniOrigin { }
+}

package/types/uni/ext/lib/uni-file-manager/utssdk/interface.d.ts

@@ -0,0 +1,132 @@
+
+export type ReadFileSuccessResult = {
+  data: string
+}
+
+export type ReadFileFailResult = {
+  /**
+   * 错误码
+   */
+  errCode: number,
+  /**
+   * 调用API的名称
+   */
+  errSubject: string,
+  /**
+   * 错误的详细信息
+   */
+  errMsg: string,
+}
+
+export type ReadFileSuccessCallback = (res: ReadFileSuccessResult) => void
+
+export type ReadFileFailCallback = (res: ReadFileFailResult) => void
+
+export type ReadFileCompleteCallback = (res: any) => void
+
+
+
+export type ReadFileOptions = {
+  /**
+   * base64 / utf-8
+   */
+  encoding: string,
+  /**
+   * 文件路径，支持相对地址和绝对地址
+   */
+  filePath: string,
+  /**
+   * 接口调用的回调函数
+   */
+  success: ReadFileSuccessCallback | null,
+  /**
+   * 接口调用失败的回调函数
+   */
+  fail: ReadFileFailCallback | null,
+  /**
+   * 接口调用结束的回调函数（调用成功、失败都会执行）
+   */
+  complete: ReadFileCompleteCallback | null
+}
+
+
+export type WriteFileSuccessResult = {
+  filePath: string,
+}
+
+export type WriteFileFailResult = {
+  /**
+   * 错误码
+   */
+  errCode: number,
+  /**
+   * 调用API的名称
+   */
+  errSubject: string,
+  /**
+   * 错误的详细信息
+   */
+  errMsg: string,
+}
+
+export type WriteFileSuccessCallback = (res: WriteFileSuccessResult) => void
+
+export type WriteFileFailCallback = (res: WriteFileFailResult) => void
+
+export type WriteFileCompleteCallback = (res: any) => void
+
+
+export type WriteFileOptions = {
+  /**
+   * 文件路径，只支持绝对地址
+   */
+  filePath: string,
+  /**
+   * 写入的文本内容
+   */
+  data: string,
+  /**
+   * 接口调用的回调函数
+   */
+  success: WriteFileSuccessCallback | null,
+  /**
+   * 接口调用失败的回调函数
+   */
+  fail: WriteFileFailCallback | null,
+  /**
+   * 接口调用结束的回调函数（调用成功、失败都会执行）
+   */
+  complete: WriteFileCompleteCallback | null
+}
+
+
+export interface FileSystemManager {
+  readFile(config: ReadFileOptions): void;
+  writeFile(config: WriteFileOptions): void;
+}
+
+
+export type GetFileSystemManager = () => FileSystemManager;
+
+
+export interface Uni {
+  /**
+   * 获取文件管理器
+   * @uniPlatform {
+   *    "app": {
+   *        "android": {
+   *            "osVer": "4.4.4",
+   *            "uniVer": "√",
+   *            "unixVer": "3.9.0"
+   *        },
+   *        "ios": {
+   *            "osVer": "x",
+   *            "uniVer": "x",
+   *            "unixVer": "x"
+   *   	  }
+   *    }
+   * }
+   * @uniVueVersion 2,3  //支持的vue版本
+   */
+  getFileSystemManager: GetFileSystemManager
+}

package/types/uni/ext/lib/uni-getAccessibilityInfo/utssdk/index.d.ts

@@ -0,0 +1,9 @@
+import {
+  GetAccessibilityInfo as GetAccessibilityInfoOrigin,
+  Uni as UniOrigin
+} from './interface'
+
+declare global {
+  type GetAccessibilityInfo = GetAccessibilityInfoOrigin
+  interface Uni extends UniOrigin { }
+}

package/types/uni/ext/lib/uni-getAccessibilityInfo/utssdk/interface.d.ts

@@ -0,0 +1,31 @@
+
+
+export type GetAccessibilityInfo = () => UTSJSONObject;
+
+export interface Uni {
+  /**
+   * GetAccessibilityInfo()
+   * @description 
+   * 获取app基本信息
+   * @return {object}
+   * @uniPlatform {
+   *    "app": {
+   *        "android": {
+   *            "osVer": "4.4",
+   * 			  "uniVer": "x",
+   * 			  "unixVer": "3.9.0"
+   *        },
+   *        "ios": {
+   *            "osVer": "9.0",
+   *  		  "uniVer": "x",
+   * 			  "unixVer": "3.9.0"
+   *        }
+   *    }
+   * }
+   * @example
+   ```typescript
+    uni.getAccessibilityInfo()
+   ```
+   */
+  getAccessibilityInfo: GetAccessibilityInfo
+}

package/types/uni/ext/lib/uni-getAppAuthorizeSetting/utssdk/index.d.ts

@@ -0,0 +1,11 @@
+import {
+  GetAppAuthorizeSetting as GetAppAuthorizeSettingOrigin,
+  GetAppAuthorizeSettingResult as GetAppAuthorizeSettingResultOrigin,
+  Uni as UniOrigin
+} from './interface'
+
+declare global {
+  type GetAppAuthorizeSetting = GetAppAuthorizeSettingOrigin
+  type GetAppAuthorizeSettingResult = GetAppAuthorizeSettingResultOrigin
+  interface Uni extends UniOrigin { }
+}

package/types/uni/ext/lib/uni-getAppAuthorizeSetting/utssdk/interface.d.ts

@@ -0,0 +1,135 @@
+export interface Uni {
+  /**
+    * getAppAuthorizeSetting()
+    * @description 
+    * 获取 APP 授权设置。
+    * @param {void}  
+    * @return {GetAppAuthorizeSettingResult}
+    * @tutorial http://uniapp.dcloud.io/api/system/getappauthorizesetting
+    * @uniPlatform {
+    *    "app": {
+    *        "android": {
+    *            "osVer": "4.4",
+    *  		  	 "uniVer": "√",
+    * 			 "unixVer": "3.9.0"
+    *        },
+    *        "ios": {
+    *            "osVer": "9.0",
+    *  		  	 "uniVer": "√",
+    * 			 "unixVer": "3.9.0"
+    *        }
+    *    }
+    * }
+    * @example
+     ```typescript
+      uni.getAppAuthorizeSetting()
+     ```
+    */
+  getAppAuthorizeSetting: GetAppAuthorizeSetting;
+}
+
+
+export type GetAppAuthorizeSetting = () => GetAppAuthorizeSettingResult;
+export type GetAppAuthorizeSettingResult = {
+  /**
+   * 允许 App 使用相册的开关（仅 iOS 支持）
+   * - authorized: 已经获得授权，无需再次请求授权
+   * - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
+   * - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
+   * @type 'authorized' | 'denied' | 'not determined'
+   */
+  albumAuthorized: string | null,
+  /**
+   * 允许 App 使用蓝牙的开关（仅 iOS 支持）
+   * - authorized: 已经获得授权，无需再次请求授权
+   * - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
+   * - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
+   * - config error: Android平台没有该值；iOS平台：表示没有在 `manifest.json -> App模块配置` 中配置 `BlueTooth(低功耗蓝牙)` 模块
+   * @type 'authorized' | 'denied' | 'not determined' | 'config error'
+   */
+  bluetoothAuthorized: string | null,
+  /**
+   * 允许 App 使用摄像头的开关
+   * - authorized: 已经获得授权，无需再次请求授权
+   * - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
+   * - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
+   * - config error: Android平台：表示没有授予 `android.permission.CAMERA` 权限；iOS平台没有该值
+   * @type 'authorized' | 'denied' | 'not determined' | 'config error'
+   */
+  cameraAuthorized: string,
+  /**
+   * 允许 App 使用定位的开关
+   * - authorized: 已经获得授权，无需再次请求授权
+   * - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
+   * - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
+   * - config error: Android平台：表示没有授予 `android.permission.ACCESS_COARSE_LOCATION` 权限；iOS平台：表示没有在 `manifest.json -> App模块配置` 中配置 `Geolocation(定位)` 模块
+   * @type 'authorized' | 'denied' | 'not determined' | 'config error'
+   */
+  locationAuthorized: string,
+  /**
+   * 定位准确度。true 表示模糊定位，false 表示精确定位（仅 iOS 支持）
+   * - reduced: 模糊定位
+   * - full: 精准定位
+   * - unsupported: 不支持（包括用户拒绝定位权限和没有在 `manifest.json -> App模块配置` 中配置 `Geolocation(定位)` 模块）
+   * @type 'reduced' | 'full' | 'unsupported'
+   */
+  locationAccuracy: string | null,
+  /**
+   * 定位准确度（推荐使用 locationAccuracy 属性）。true 表示模糊定位，false 表示精确定位（仅 iOS 支持）
+   * @type boolean
+   */
+  locationReducedAccuracy: boolean | null,
+  /**
+   * 允许 App 使用麦克风的开关
+   * - authorized: 已经获得授权，无需再次请求授权
+   * - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
+   * - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
+   * - config error: Android平台：表示没有授予 `android.permission.RECORD_AUDIO` 权限；iOS平台没有该值
+   * @type 'authorized' | 'denied' | 'not determined' | 'config error'
+   */
+  microphoneAuthorized: string,
+  /**
+   * 允许 App 通知的开关
+   * - authorized: 已经获得授权，无需再次请求授权
+   * - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
+   * - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
+   * - config error: Android平台没有该值；iOS平台：表示没有在 `manifest.json -> App模块配置` 中配置 `Push(推送)` 模块
+   * @type 'authorized' | 'denied' | 'not determined' | 'config error'
+   */
+  notificationAuthorized: string,
+  /**
+   * 允许 App 通知带有提醒的开关（仅 iOS 10.0+ 支持）
+   * - authorized: 已经获得授权，无需再次请求授权
+   * - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
+   * - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
+   * - config error: 没有在 `manifest.json -> App模块配置` 中配置 `Push(推送)` 模块
+   * @type 'authorized' | 'denied' | 'not determined' | 'config error'
+   */
+  notificationAlertAuthorized: string | null,
+  /**
+   * 允许 App 通知带有标记的开关（仅 iOS 10.0+ 支持）
+   * - authorized: 已经获得授权，无需再次请求授权
+   * - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
+   * - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
+   * - config error: 没有在 `manifest.json -> App模块配置` 中配置 `Push(推送)` 模块
+   * @type 'authorized' | 'denied' | 'not determined' | 'config error'
+   */
+  notificationBadgeAuthorized: string | null,
+  /**
+   * 允许 App 通知带有声音的开关（仅 iOS 10.0+ 支持）
+   * - authorized: 已经获得授权，无需再次请求授权
+   * - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
+   * - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
+   * - config error: 没有在 `manifest.json -> App模块配置` 中配置 `Push(推送)` 模块
+   * @type 'authorized' | 'denied' | 'not determined' | 'config error'
+   */
+  notificationSoundAuthorized: string | null,
+  /**
+   * 允许读写日历的开关（仅微信小程序支持）
+   * - authorized: 已经获得授权，无需再次请求授权
+   * - denied: 请求授权被拒绝，无法再次请求授权；（此情况需要引导用户打开系统设置，在设置页中打开权限）
+   * - not determined: 尚未请求授权，会在App下一次调用系统相应权限时请求；（仅 iOS 会出现。此种情况下引导用户打开系统设置，不展示开关）
+   * @type 'authorized' | 'denied' | 'not determined'
+   */
+  phoneCalendarAuthorized: string | null
+};

package/types/uni/ext/lib/uni-getAppBaseInfo/utssdk/index.d.ts

@@ -0,0 +1,13 @@
+import {
+  GetAppBaseInfoOptions as GetAppBaseInfoOptionsOrigin,
+  GetAppBaseInfoResult as GetAppBaseInfoResultOrigin,
+  GetAppBaseInfo as GetAppBaseInfoOrigin,
+  Uni as UniOrigin
+} from './interface'
+
+declare global {
+  type GetAppBaseInfoOptions = GetAppBaseInfoOptionsOrigin
+  type GetAppBaseInfoResult = GetAppBaseInfoResultOrigin
+  type GetAppBaseInfo = GetAppBaseInfoOrigin
+  interface Uni extends UniOrigin { }
+}

package/types/uni/ext/lib/uni-getAppBaseInfo/utssdk/interface.d.ts

@@ -0,0 +1,120 @@
+
+/**
+  * 过滤app基本信息，其中filter参数可设置为 
+      "appId",
+      "appName",
+      "appVersion",
+      "appVersionCode",
+      "appLanguage",
+      "language",
+      "version",
+      "appWgtVersion",
+      "hostLanguage",
+      "hostVersion",
+      "hostName",
+      "hostPackageName",
+      "hostSDKVersion",
+      "hostTheme",
+  */
+export type GetAppBaseInfoOptions = {
+  filter: Array<string>
+};
+
+export type GetAppBaseInfoResult = {
+  /**
+   * manifest.json 中应用appid，即DCloud appid。	
+   */
+  appId?: string,
+  /**
+   * manifest.json 中应用名称	
+   */
+  appName?: string,
+  /**
+   * manifest.json 中应用版本名称。	
+   */
+  appVersion?: string,
+  /**
+   * manifest.json 中应用版本名号。	
+   */
+  appVersionCode?: string,
+  /**
+   * 应用设置的语言en、zh-Hans、zh-Hant、fr、es	
+   */
+  appLanguage?: string,
+  /**
+   * 应用设置的语言	
+   */
+  language?: string,
+  /**
+   * 引擎版本号
+   */
+  version?: string,
+  /**
+   * 应用资源（wgt）的版本名称。	
+   */
+  appWgtVersion?: string,
+  /**
+   * 小程序宿主语言	
+   */
+  hostLanguage?: string,
+  /**
+   * App、小程序宿主版本。
+   */
+  hostVersion?: string,
+  /**
+   * 小程序宿主名称	
+   */
+  hostName?: string,
+  /**
+   * 小程序宿主包名	
+   */
+  hostPackageName?: string,
+  /**
+   * uni小程序SDK版本、小程序客户端基础库版本	
+   */
+  hostSDKVersion?: string,
+  /**
+   * 系统当前主题，取值为light或dark。微信小程序全局配置"darkmode":true时才能获取，否则为 undefined （不支持小游戏）
+   */
+  hostTheme?: string,
+  /**
+   * 是否uni-app x
+   */
+  isUniAppX: boolean
+}
+
+
+export type GetAppBaseInfo = (config: GetAppBaseInfoOptions | null) => GetAppBaseInfoResult;
+
+
+export interface Uni {
+  /**
+    * GetAppBaseInfo(Object object)
+    * @description 
+    * 获取app基本信息
+    * @param {AppBaseInfoOptions} option
+    * @return {object}
+    * @tutorial https://uniapp.dcloud.net.cn/api/system/getAppBaseInfo.html
+    * @uniPlatform {
+    *    "app": {
+    *        "android": {
+    *            "osVer": "4.4",
+    *  		  	 "uniVer": "√",
+    * 			 "unixVer": "3.9.0"
+    *        },
+    *        "ios": {
+    *            "osVer": "9.0",
+    *  		  	 "uniVer": "√",
+    * 			 "unixVer": "3.9.0"
+    *        }
+    *    }
+    * }
+    * @example
+     ```typescript
+      uni.getAppBaseInfo({
+        filter:[]
+      })
+     ```
+    */
+  getAppBaseInfo: GetAppBaseInfo
+}

package/types/uni/ext/lib/uni-getDeviceInfo/utssdk/index.d.ts

@@ -0,0 +1,13 @@
+import {
+  GetDeviceInfoOptions as GetDeviceInfoOptionsOrigin,
+  GetDeviceInfoResult as GetDeviceInfoResultOrigin,
+  GetDeviceInfo as GetDeviceInfoOrigin,
+  Uni as UniOrigin
+} from './interface'
+
+declare global {
+  type GetDeviceInfoOptions = GetDeviceInfoOptionsOrigin
+  type GetDeviceInfoResult = GetDeviceInfoResultOrigin
+  type GetDeviceInfo = GetDeviceInfoOrigin
+  interface Uni extends UniOrigin { }
+}