@spcsn/taro 0.1.0

package/types/api/device/phone.d.ts

@@ -0,0 +1,30 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace makePhoneCall {
+    interface Option {
+      /** 需要拨打的电话号码 */
+      phoneNumber: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  interface TaroStatic {
+    /** 拨打电话
+     * @supported weapp, swan, jd, qq, tt, h5, rn, harmony, harmony_hybrid
+     * @example
+     * ```tsx
+     * Taro.makePhoneCall({
+     *   phoneNumber: '1340000' //仅为示例，并非真实的电话号码
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/phone/wx.makePhoneCall.html
+     */
+    makePhoneCall(option: makePhoneCall.Option): Promise<TaroGeneral.CallbackResult>
+  }
+}

package/types/api/device/scan.d.ts

@@ -0,0 +1,111 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace scanCode {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 是否只能从相机扫码，不允许从相册选择图片
+       * @default false
+       */
+      onlyFromCamera?: boolean
+      /** 扫码类型 */
+      scanType?: (keyof ScanType)[]
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+        /** 所扫码的字符集 */
+        charSet: string
+        /** 当所扫的码为当前小程序二维码时，会返回此字段，内容为二维码携带的 path */
+        path: string
+        /** 原始数据，base64编码 */
+        rawData: string
+        /** 所扫码的内容 */
+        result: string
+        /** 所扫码的类型 */
+        scanType: keyof QRType
+        /** 调用结果 */
+        errMsg: string
+    }
+    /** 扫码类型 */
+    interface ScanType {
+      /** 一维码 */
+      barCode
+      /** 二维码 */
+      qrCode
+      /** Data Matrix 码 */
+      datamatrix
+      /** PDF417 条码 */
+      pdf417
+    }
+    /** 所扫码的类型 */
+    interface QRType {
+      /** 二维码 */
+      QR_CODE
+      /** 一维码 */
+      AZTEC
+      /** 一维码 */
+      CODABAR
+      /** 一维码 */
+      CODE_39
+      /** 一维码 */
+      CODE_93
+      /** 一维码 */
+      CODE_128
+      /** 二维码 */
+      DATA_MATRIX
+      /** 一维码 */
+      EAN_8
+      /** 一维码 */
+      EAN_13
+      /** 一维码 */
+      ITF
+      /** 一维码 */
+      MAXICODE
+      /** 二维码 */
+      PDF_417
+      /** 一维码 */
+      RSS_14
+      /** 一维码 */
+      RSS_EXPANDED
+      /** 一维码 */
+      UPC_A
+      /** 一维码 */
+      UPC_E
+      /** 一维码 */
+      UPC_EAN_EXTENSION
+      /** 二维码 */
+      WX_CODE
+      /** 一维码 */
+      CODE_25
+    }
+  }
+
+  interface TaroStatic {
+    /**
+     * 调起客户端扫码界面，扫码成功后返回对应的结果
+     * @supported weapp, swan, jd, qq, tt, h5, rn
+     * @example
+     * ```tsx
+     * // 允许从相机和相册扫码
+     * Taro.scanCode({
+     *   success: (res) => {
+     *     console.log(res)
+     *   }
+     * })
+     * // 只允许从相机扫码
+     * Taro.scanCode({
+     *   onlyFromCamera: true,
+     *   success: (res) => {
+     *     console.log(res)
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/scan/wx.scanCode.html
+     */
+    scanCode(option: scanCode.Option): Promise<scanCode.SuccessCallbackResult>
+  }
+}

package/types/api/device/screen.d.ts

@@ -0,0 +1,217 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace setVisualEffectOnCapture {
+    interface Option {
+      /** 截屏/录屏时的表现，仅支持 none / hidden，传入 hidden 则表示在截屏/录屏时隐藏屏幕
+       * @default "none"
+       */
+      visualEffect?: 'none' | 'hidden'
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace setScreenBrightness {
+    interface Option {
+      /** 屏幕亮度值，范围 0 ~ 1。0 最暗，1 最亮 */
+      value: number
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace setKeepScreenOn {
+    interface Promised extends TaroGeneral.CallbackResult {
+      /** 调用结果 */
+      errMsg: string
+    }
+    interface Option {
+      /** 是否保持屏幕常亮 */
+      keepScreenOn: boolean
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace onUserCaptureScreen {
+    /** 用户主动截屏事件的回调函数 */
+    type Callback = (
+        result: TaroGeneral.CallbackResult,
+    ) => void
+  }
+
+  namespace onScreenRecordingStateChanged {
+    interface ScreenRecordingState {
+      /** 开始录屏 */
+      start
+      /** 结束录屏 */
+      stop
+    }
+    /** 用户录屏事件的监听函数 */
+    type Callback = (
+      /** 录屏状态 */
+      state: keyof ScreenRecordingState,
+    ) => void
+  }
+
+  namespace getScreenRecordingState {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (option: SuccessCallbackResult) => void
+    }
+    interface ScreenRecordingState {
+      /** 开启 */
+      on
+      /** 关闭 */
+      off
+    }
+    interface SuccessCallbackResult {
+      /** 录屏状态 */
+      state: keyof ScreenRecordingState
+    }
+  }
+
+  namespace getScreenBrightness {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (option: SuccessCallbackOption) => void
+    }
+
+    interface SuccessCallbackOption {
+      /** 屏幕亮度值，范围 0 ~ 1，0 最暗，1 最亮 */
+      value: number
+    }
+  }
+
+  interface TaroStatic {
+    /** 设置截屏/录屏时屏幕表现，仅支持在 Android 端调用
+     * @supported weapp, alipay
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.setVisualEffectOnCapture.html
+     */
+    setVisualEffectOnCapture(option: setVisualEffectOnCapture.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 设置屏幕亮度。
+     * @supported weapp, swan, jd, qq, tt, rn
+     * @example
+     * ```tsx
+     * Taro.setScreenBrightness(params).then(...)
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.setScreenBrightness.html
+     */
+    setScreenBrightness(option: setScreenBrightness.Option): Promise<TaroGeneral.CallbackResult>
+
+    /**
+     * 设置是否保持常亮状态。仅在当前小程序生效，离开小程序后设置失效。
+     * @supported weapp, alipay, swan, jd, qq, tt, rn, harmony_hybrid
+     * @example
+     * ```tsx
+     * // 保持屏幕常亮
+     * Taro.setKeepScreenOn({
+     *     keepScreenOn: true
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.setKeepScreenOn.html
+     */
+    setKeepScreenOn(option: setKeepScreenOn.Option): Promise<setKeepScreenOn.Promised>
+
+    /**
+     * 监听用户主动截屏事件，用户使用系统截屏按键截屏时触发此事件
+     * @supported weapp, alipay, swan, jd, tt, harmony_hybrid
+     * @example
+     * ```tsx
+     * Taro.onUserCaptureScreen(function (res) {
+     *     console.log('用户截屏了')
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.onUserCaptureScreen.html
+     */
+    onUserCaptureScreen(
+      /** 用户主动截屏事件的回调函数 */
+      callback: onUserCaptureScreen.Callback,
+    ): void
+
+    /** 监听用户录屏事件
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.onScreenRecordingStateChanged.html
+     * @example
+     * ```tsx
+     * // 监听用户录屏事件
+     * const handler = function (res) {
+     *     console.log(res.state)
+     * }
+     * Taro.onScreenRecordingStateChanged(handler)
+     * ```
+     */
+    onScreenRecordingStateChanged(
+      /** 用户录屏事件的监听函数 */
+      callback: onScreenRecordingStateChanged.Callback
+    ): void
+
+    /** 用户主动截屏事件。取消事件监听。
+     * @supported weapp, alipay, swan, jd, tt
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.offUserCaptureScreen.html
+     */
+    offUserCaptureScreen(
+      /** 用户主动截屏事件的回调函数 */
+      callback: onUserCaptureScreen.Callback,
+    ): void
+
+    /** 取消用户录屏事件的监听函数
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.offScreenRecordingStateChanged.html
+     */
+    offScreenRecordingStateChanged(
+      /** 用户录屏事件的监听函数 */
+      callback?: onScreenRecordingStateChanged.Callback
+    ): void
+
+    /** 查询用户是否在录屏
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.getScreenRecordingState.html
+     * @example
+     * ```tsx
+     * Taro.getScreenRecordingState({
+     *     success: function (res) {
+     *         console.log(res.state)
+     *     },
+     * })
+     * ```
+     */
+    getScreenRecordingState(
+      option?: getScreenRecordingState.Option
+    ): Promise<getScreenRecordingState.SuccessCallbackResult>
+
+    /**
+     * 获取屏幕亮度。
+     *
+     * **说明**
+     * - 若安卓系统设置中开启了自动调节亮度功能，则屏幕亮度会根据光线自动调整，该接口仅能获取自动调节亮度之前的值，而非实时的亮度值。
+     * @supported weapp, alipay, swan, jd, qq, rn, harmony
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/screen/wx.getScreenBrightness.html
+     */
+    getScreenBrightness(
+      option?: getScreenBrightness.Option
+    ): Promise<getScreenBrightness.SuccessCallbackOption>
+  }
+}

package/types/api/device/sms.d.ts

@@ -0,0 +1,26 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace sendSms {
+    interface Option {
+      /** 预填到发送短信面板的手机号 */
+      phoneNumber?: string
+      /** 预填到发送短信面板的内容 */
+      content?: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  interface TaroStatic {
+    /** 拉起手机发送短信界面
+     * @supported weapp, tt
+     * @see declare module '../../index' 
+     */
+    sendSms(option: sendSms.Option): Promise<TaroGeneral.CallbackResul>
+  }
+}

package/types/api/device/vibrate.d.ts

@@ -0,0 +1,51 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace vibrateShort {
+    interface Option {
+      /** 震动强度类型，有效值为：heavy、medium、light */
+      type?: 'heavy' | 'medium' | 'light'
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace vibrateLong {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  interface TaroStatic {
+    /** 使手机发生较短时间的振动（15 ms）。仅在 iPhone `7 / 7 Plus` 以上及 Android 机型生效
+     *
+     * 仅微信小程序平台支持 type 参数
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, rn, harmony
+     * @example
+     * ```tsx
+     * Taro.vibrateShort(params).then(...)
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/vibrate/wx.vibrateShort.html
+     */
+    vibrateShort(option?: vibrateShort.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 使手机发生较长时间的振动（400ms）
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, rn, harmony
+     * @example
+     * ```tsx
+     * Taro.vibrateLong(params).then(...)
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/vibrate/wx.vibrateLong.html
+     */
+    vibrateLong(option?: vibrateLong.Option): Promise<TaroGeneral.CallbackResult>
+  }
+}