@spcsn/taro 0.1.0

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

@@ -0,0 +1,105 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace stopCompass {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace startCompass {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace onCompassChange {
+    /** 罗盘数据变化事件的回调函数 */
+    type Callback = (
+      result: OnCompassChangeCallbackResult,
+    ) => void
+    interface OnCompassChangeCallbackResult {
+      /** 精度
+       *
+       * 由于平台差异，accuracy 在 iOS/Android 的值不同。
+       *
+       * - iOS：accuracy 是一个 number 类型的值，表示相对于磁北极的偏差。0 表示设备指向磁北，90 表示指向东，180 表示指向南，依此类推。
+       * - Android：accuracy 是一个 string 类型的枚举值。
+       */
+      accuracy: number | keyof accuracy | string
+      /** 面对的方向度数 */
+      direction: number
+    }
+
+    interface accuracy {
+      /** 高精度 */
+      high
+      /** 中等精度 */
+      medium
+      /** 低精度 */
+      low
+      /** 不可信，传感器失去连接 */
+      'no-contact'
+      /** 不可信，原因未知 */
+      unreliable
+      /** 未知的精度枚举值，即该 Android 系统此时返回的表示精度的 value 不是一个标准的精度枚举值 */
+      'unknow ${value}'
+    }
+  }
+
+  interface TaroStatic {
+    /** 停止监听罗盘数据
+     * @supported weapp, swan, qq, h5, tt
+     * @example
+     * ```tsx
+     * Taro.stopCompass()
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/compass/wx.stopCompass.html
+     */
+    stopCompass(option?: stopCompass.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 开始监听罗盘数据
+     * @supported weapp, swan, qq, h5, tt
+     * @example
+     * ```js
+     * Taro.startCompass()
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/compass/wx.startCompass.html
+     */
+    startCompass(option?: startCompass.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 监听罗盘数据变化事件。频率：5 次/秒，接口调用后会自动开始监听，可使用 Taro.stopCompass 停止监听。
+     * @supported weapp, swan, qq, h5, tt
+     * @example
+     * ```tsx
+     * Taro.onCompassChange(function (res) {
+     *   console.log(res.direction)
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/compass/wx.onCompassChange.html
+     */
+    onCompassChange(
+      /** 罗盘数据变化事件的回调函数 */
+      callback: onCompassChange.Callback,
+    ): void
+
+    /** 取消监听罗盘数据变化事件，参数为空，则取消所有的事件监听。
+     * @supported weapp, swan, qq, h5
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/compass/wx.offCompassChange.html
+     */
+    offCompassChange(
+      /** 罗盘数据变化事件的回调函数 */
+      callback?: onCompassChange.Callback,
+    ): void
+  }
+}

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

@@ -0,0 +1,110 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace chooseContact {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 手机号 */
+      phoneNumber: string
+      /** 联系人姓名 */
+      displayName: string
+      /** 选定联系人的所有手机号（部分 Android 系统只能选联系人而不能选特定手机号） */
+      phoneNumberList: string
+    }
+  }
+
+  namespace addPhoneContact {
+    interface Option {
+      /** 名字 */
+      firstName: string
+      /** 头像本地文件路径 */
+      photoFilePath?: string
+      /** 昵称 */
+      nickName?: string
+      /** 中间名 */
+      middleName?: string
+      /** 姓氏 */
+      lastName?: string
+      /** 备注 */
+      remark?: string
+      /** 手机号 */
+      mobilePhoneNumber?: string
+      /** 微信号 */
+      weChatNumber?: string
+      /** 联系地址国家 */
+      addressCountry?: string
+      /** 联系地址省份 */
+      addressState?: string
+      /** 联系地址城市 */
+      addressCity?: string
+      /** 联系地址街道 */
+      addressStreet?: string
+      /** 联系地址邮政编码 */
+      addressPostalCode?: string
+      /** 公司 */
+      organization?: string
+      /** 职位 */
+      title?: string
+      /** 工作传真 */
+      workFaxNumber?: string
+      /** 工作电话 */
+      workPhoneNumber?: string
+      /** 公司电话 */
+      hostNumber?: string
+      /** 电子邮件 */
+      email?: string
+      /** 网站 */
+      url?: string
+      /** 工作地址国家 */
+      workAddressCountry?: string
+      /** 工作地址省份 */
+      workAddressState?: string
+      /** 工作地址城市 */
+      workAddressCity?: string
+      /** 工作地址街道 */
+      workAddressStreet?: string
+      /** 工作地址邮政编码 */
+      workAddressPostalCode?: string
+      /** 住宅传真 */
+      homeFaxNumber?: string
+      /** 住宅电话 */
+      homePhoneNumber?: string
+      /** 住宅地址国家 */
+      homeAddressCountry?: string
+      /** 住宅地址省份 */
+      homeAddressState?: string
+      /** 住宅地址城市 */
+      homeAddressCity?: string
+      /** 住宅地址街道 */
+      homeAddressStreet?: string
+      /** 住宅地址邮政编码 */
+      homeAddressPostalCode?: string
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  interface TaroStatic {
+    /** 添加手机通讯录联系人。用户可以选择将该表单以「新增联系人」或「添加到已有联系人」的方式，写入手机系统通讯录。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/contact/wx.chooseContact.html
+     */
+    chooseContact(option: chooseContact.Option): Promise<chooseContact.SuccessCallbackResult>
+    /** 添加手机通讯录联系人。用户可以选择将该表单以「新增联系人」或「添加到已有联系人」的方式，写入手机系统通讯录。
+     * @supported weapp
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/contact/wx.addPhoneContact.html
+     */
+    addPhoneContact(option: addPhoneContact.Option): Promise<TaroGeneral.CallbackResult>
+  }
+}

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

@@ -0,0 +1,85 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace stopGyroscope {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+
+  namespace startGyroscope {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 监听陀螺仪数据回调函数的执行频率 */
+      interval?: keyof Interval
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+
+    /** 监听陀螺仪数据回调函数的执行频率 */
+    interface Interval {
+      /** 适用于更新游戏的回调频率，在 20ms/次 左右 */
+      game
+      /** 适用于更新 UI 的回调频率，在 60ms/次 左右 */
+      ui
+      /** 普通的回调频率，在 200ms/次 左右 */
+      normal
+    }
+  }
+
+  namespace onGyroscopeChange {
+    /** 陀螺仪数据变化事件的回调函数 */
+    type Callback = (
+      result: CallbackResult,
+    ) => void
+    interface CallbackResult {
+      /** x 轴的角速度 */
+      x: number
+      /** y 轴的角速度 */
+      y: number
+      /** z 轴的角速度 */
+      z: number
+    }
+  }
+
+  interface TaroStatic {
+    /** 停止监听陀螺仪数据。
+     * @supported weapp, alipay, swan, jd, qq, tt, rn
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/gyroscope/wx.stopGyroscope.html
+     */
+    stopGyroscope(option?: stopGyroscope.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 开始监听陀螺仪数据。
+     * @supported weapp, rn, tt
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/gyroscope/wx.startGyroscope.html
+     */
+    startGyroscope(option: startGyroscope.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 监听陀螺仪数据变化事件。频率根据 Taro.startGyroscope() 的 interval 参数。可以使用 Taro.stopGyroscope() 停止监听。
+     * @supported weapp, alipay, swan, jd, qq, tt, rn
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/gyroscope/wx.onGyroscopeChange.html
+     */
+    onGyroscopeChange(
+      /** 陀螺仪数据变化事件的回调函数 */
+      callback: onGyroscopeChange.Callback,
+    ): void
+
+    /** 取消监听陀螺仪数据变化事件。
+     * @supported weapp, alipay, swan, jd, tt, rn
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/gyroscope/wx.offGyroscopeChange.html
+     */
+    offGyroscopeChange(
+      /** 陀螺仪数据变化事件的回调函数 */
+      callback?: onGyroscopeChange.Callback,
+    ): void
+  }
+}

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

@@ -0,0 +1,168 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace stopBeaconDiscovery {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.IBeaconError) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.IBeaconError) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.IBeaconError) => void
+    }
+  }
+
+  namespace startBeaconDiscovery {
+    interface Option {
+      /** iBeacon 设备广播的 uuid 列表 */
+      uuids: string[]
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.IBeaconError) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.IBeaconError) => void
+      /** 是否校验蓝牙开关，仅在 iOS 下有效
+       * @default false
+       */
+      ignoreBluetoothAvailable?: boolean
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.IBeaconError) => void
+    }
+  }
+
+  namespace onBeaconUpdate {
+    /** iBeacon 设备更新事件的回调函数 */
+    type Callback = (result: CallbackResult) => void
+
+    interface CallbackResult {
+      /** 当前搜寻到的所有 iBeacon 设备列表 */
+      beacons: IBeaconInfo[]
+    }
+  }
+
+  namespace onBeaconServiceChange {
+    /** iBeacon 服务状态变化事件的回调函数 */
+    type Callback = (
+      result: CallbackResult,
+    ) => void
+
+    interface CallbackResult {
+      /** 服务目前是否可用 */
+      available: boolean
+      /** 目前是否处于搜索状态 */
+      discovering: boolean
+    }
+  }
+
+  namespace getBeacons {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.IBeaconError) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.IBeaconError) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: CallbackResult) => void
+    }
+
+    interface CallbackResult extends TaroGeneral.IBeaconError {
+      /** iBeacon 设备列表 */
+      beacons: IBeaconInfo[]
+      /** 调用结果 */
+      errMsg: string
+    }
+  }
+
+  interface IBeaconInfo {
+    /** Beacon 设备广播的 uuid */
+    uuid: string
+    /** Beacon 设备的主 ID */
+    major: string
+    /** Beacon 设备的次 ID */
+    minor: string
+    /** 表示设备距离的枚举值（仅iOS） */
+    proximity: keyof IBeaconInfo.Proximity
+    /** Beacon 设备的距离，单位 m。iOS 上，proximity 为 0 时，accuracy 为 -1。 */
+    accuracy: number
+    /** 表示设备的信号强度，单位 dBm */
+    rssi: number
+  }
+
+  namespace IBeaconInfo {
+    /** proximity 的合法值 */
+    interface Proximity {
+      /** 信号太弱不足以计算距离，或非 iOS 设备 */
+      0
+      /** 十分近 */
+      1
+      /** 比较近 */
+      2
+      /** 远 */
+      3
+    }
+  }
+
+  interface TaroStatic {
+    /** 停止搜索附近的 iBeacon 设备
+     * @supported weapp, alipay
+     * @example
+     * ```tsx
+     * Taro.stopBeaconDiscovery(params).then(...)
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.stopBeaconDiscovery.html
+     */
+    stopBeaconDiscovery(option?: stopBeaconDiscovery.Option): Promise<TaroGeneral.IBeaconError>
+
+    /** 开始搜索附近的 iBeacon 设备
+     * @supported weapp, alipay
+     * @example
+     * ```tsx
+     * Taro.startBeaconDiscovery({
+     *   success: function (res) { }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.startBeaconDiscovery.html
+     */
+    startBeaconDiscovery(option: startBeaconDiscovery.Option): Promise<TaroGeneral.IBeaconError>
+
+    /** 监听 iBeacon 设备更新事件，仅能注册一个监听
+     * @supported weapp, alipay
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.onBeaconUpdate.html
+     */
+    onBeaconUpdate(
+      /** iBeacon 设备更新事件的回调函数 */
+      callback: onBeaconUpdate.Callback,
+    ): void
+
+    /** 监听 iBeacon 服务状态变化事件，仅能注册一个监听
+     * @supported weapp, alipay
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.onBeaconServiceChange.html
+     */
+    onBeaconServiceChange(
+      /** iBeacon 服务状态变化事件的回调函数 */
+      callback: onBeaconServiceChange.Callback,
+    ): void
+
+    /** 取消监听 iBeacon 设备更新事件
+     * @supported weapp, alipay
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.offBeaconUpdate.html
+     */
+    offBeaconUpdate(
+      /** iBeacon 设备更新事件的回调函数 */
+      callback: (res: TaroGeneral.IBeaconError) => void,
+    ): void
+
+    /** 取消监听 iBeacon 服务状态变化事件
+     * @supported weapp, alipay
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.offBeaconServiceChange.html
+     */
+    offBeaconServiceChange(
+      /** iBeacon 服务状态变化事件的回调函数 */
+      callback: (res: TaroGeneral.IBeaconError) => void,
+    ): void
+
+    /** 获取所有已搜索到的 iBeacon 设备
+     * @supported weapp, alipay
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/ibeacon/wx.getBeacons.html
+     */
+    getBeacons(option?: getBeacons.Option): Promise<getBeacons.CallbackResult>
+  }
+}

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

@@ -0,0 +1,97 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace hideKeyboard {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace getSelectedTextRange {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 输入框光标结束位置 */
+      end: number
+      /** 输入框光标起始位置 */
+      start: number
+      /** 调用结果 */
+      errMsg: string
+    }
+  }
+
+  namespace onKeyboardHeightChange {
+    type Callback = (
+      result: CallbackResult,
+    ) => void
+    interface CallbackResult {
+      /** 键盘高度 */
+      height: number
+    }
+  }
+
+  interface TaroStatic {
+    /** 在input、textarea等focus拉起键盘之后，手动调用此接口收起键盘
+     * @supported weapp, alipay, swan, jd, tt, rn, harmony_hybrid, harmony
+     * @example
+     * ```tsx
+     * Taro.hideKeyboard({
+     *   complete: res => {
+     *     console.log('hideKeyboard res', res)
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/keyboard/wx.hideKeyboard.html
+     */
+    hideKeyboard(option?: hideKeyboard.Option): Promise<TaroGeneral.CallbackResult>
+
+    /** 在input、textarea等focus之后，获取输入框的光标位置。注意：只有在focus的时候调用此接口才有效。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.getSelectedTextRange({
+     *   complete: res => {
+     *     console.log('getSelectedTextRange res', res.start, res.end)
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/keyboard/wx.getSelectedTextRange.html
+     */
+    getSelectedTextRange(option?: getSelectedTextRange.Option): Promise<getSelectedTextRange.SuccessCallbackResult>
+
+    /** 监听键盘高度变化
+     * @supported weapp, swan, jd, qq, rn, harmony
+     * @example
+     * ```tsx
+     * Taro.onKeyboardHeightChange(res => {
+     *   console.log(res.height)
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/keyboard/wx.onKeyboardHeightChange.html
+     */
+    onKeyboardHeightChange(
+      callback: onKeyboardHeightChange.Callback
+    ): void
+
+    /**
+     * 取消监听键盘高度变化事件。
+     * @supported weapp, swan, jd, rn, harmony
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/keyboard/wx.offKeyboardHeightChange.html
+     */
+    offKeyboardHeightChange(
+      /** 键盘高度变化事件的回调函数 */
+      callback?: onKeyboardHeightChange.Callback
+    ): void
+  }
+}

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

@@ -0,0 +1,52 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace onMemoryWarning {
+    /** 内存不足告警事件的回调函数 */
+    type Callback = (
+      result: CallbackResult,
+    ) => void
+
+    interface CallbackResult {
+      /** 内存告警等级，只有 Android 才有，对应系统宏定义 */
+      level: keyof Level
+    }
+
+    interface Level {
+      /** TRIM_MEMORY_RUNNING_MODERATE */
+      5
+      /** TRIM_MEMORY_RUNNING_LOW */
+      10
+      /** TRIM_MEMORY_RUNNING_CRITICAL */
+      15
+    }
+  }
+
+  interface TaroStatic {
+    /** 监听内存不足告警事件。
+     *
+     * 当 iOS/Android 向小程序进程发出内存警告时，触发该事件。触发该事件不意味小程序被杀，大部分情况下仅仅是告警，开发者可在收到通知后回收一些不必要资源避免进一步加剧内存紧张。
+     * @supported weapp, alipay, swan, jd, tt, harmony
+     * @example
+     * ```tsx
+     * Taro.onMemoryWarning(function () {
+     *   console.log('onMemoryWarningReceive')
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/performance/wx.onMemoryWarning.html
+     */
+    onMemoryWarning(
+      /** 内存不足告警事件的回调函数 */
+      callback: onMemoryWarning.Callback,
+    ): void
+
+    /** 取消监听内存不足告警事件。
+     * @supported weapp, alipay, swan, harmony
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/memory/wx.offMemoryWarning.html
+     */
+    offMemoryWarning(
+      /** 取消监听内存不足告警事件 */
+      callback?: onMemoryWarning.Callback,
+    ): void
+  }
+}