@spcsn/taro 0.1.0

package/types/api/data-analysis/index.d.ts

@@ -0,0 +1,122 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace getCommonConfig {
+    interface Option {
+      /** 需要获取的数据指标的对象数组，每个string的格式约定：配置类型_分表key */
+      keys?: string[]
+      /** 0：通用配置模式 1：实验模式, 参数与返回结果的使用等效于接口wx.getExptInfoSync */
+      mode: 0 | 1
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: SuccessCallbackResult) => void
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 错误码 */
+      errcode: number
+      /** 错误信息 */
+      errmsg: string
+      /** 配置类型, 1-表类型 2-kv类型 */
+      conf_type: number
+      /** 根据conf_type来确定conf内容, conf_type为1时conf是一个json数组, 类似"[{xxx},{xxx}]", 每一项对应表类型每一行配置内容, 其中conf_type为2时conf是一个json对象，类似"{xxxx}" */
+      conf: string
+      /** 过期时间,单位秒. 0表示当次有效 */
+      expire_sec: number
+    }
+  }
+
+  interface TaroStatic {
+    /** 自定义业务数据监控上报接口。
+     *
+     * **使用说明**
+     * 使用前，需要在「小程序管理后台-运维中心-性能监控-业务数据监控」中新建监控事件，配置监控描述与告警类型。每一个监控事件对应唯一的监控ID，开发者最多可以创建128个监控事件。
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.reportMonitor('1', 1)
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/data-analysis/wx.reportMonitor.html
+     */
+     reportMonitor(
+      /** 监控ID，在「小程序管理后台」新建数据指标后获得 */
+      name: string,
+      /** 上报数值，经处理后会在「小程序管理后台」上展示每分钟的上报总量 */
+      value: number,
+    ): void
+
+    /** 自定义分析数据上报接口。使用前，需要在小程序管理后台自定义分析中新建事件，配置好事件名与字段。
+     * @supported weapp, swan, tt
+     * @example
+     * ```tsx
+     * Taro.reportAnalytics('purchase', {
+     *   price: 120,
+     *   color: 'red'
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/data-analysis/wx.reportAnalytics.html
+     */
+    reportAnalytics(
+      /** 事件名 */
+      eventName: string,
+      /** 上报的自定义数据，key 为配置中的字段名，value 为上报的数据。 */
+      data: TaroGeneral.IAnyObject,
+    ): void
+
+    /** 事件上报
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.reportEvent('purchase', {
+     *   price: 120,
+     *   color: 'red'
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/data-analysis/wx.reportEvent.html
+     */
+    reportEvent(
+      /** 事件名 */
+      eventId: string,
+      /** 上报的自定义数据，key 为配置中的字段名，value 为上报的数据。 */
+      data: TaroGeneral.IAnyObject,
+    ): void
+
+    /** 给定实验参数数组，获取对应的实验参数值
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.getExptInfoSync(['color'])
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/data-analysis/wx.getExptInfoSync.html
+     */
+    getExptInfoSync(
+      /** 实验参数数组，不填则获取所有实验参数 */
+      keys?: Array<string>
+    ): TaroGeneral.IAnyObject
+
+    /** 给定实验参数数组，获取对应的实验参数值
+     * @supported weapp
+     * @example
+     * ```tsx
+     * Taro.getCommonConfig({
+     *   keys:["key1", "key2"],
+     *   mode: 0,
+     *   success: (res) => {
+     *     console.log("success")
+     *     console.log(res)
+     *   },
+     *   fail: (res) => {
+     *     console.log("fail")
+     *     console.log(res)
+     *   }
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/data-analysis/wx.getCommonConfig.html
+     */
+    getCommonConfig(
+      option: getCommonConfig.Option
+    ): Promise<getCommonConfig.SuccessCallbackResult>
+  }
+}

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

@@ -0,0 +1,102 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace startAccelerometer {
+    type Option = {
+      /**
+       * 监听加速度数据回调函数的执行频率
+       * @default "normal"
+       */
+      interval?: keyof Interval
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+
+    type Interval = {
+      /** 适用于更新游戏的回调频率，在 20ms/次 左右 */
+      game: 'game',
+      /** 适用于更新 UI 的回调频率，在 60ms/次 左右 */
+      ui: 'ui',
+      /** 普通的回调频率，在 200ms/次 左右 */
+      normal: 'normal'
+    }
+  }
+
+  namespace stopAccelerometer {
+    type Option = {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: TaroGeneral.CallbackResult) => void
+    }
+  }
+
+  namespace onAccelerometerChange {
+    type Callback = (res: Result) => void
+    type Result = {
+      /** X 轴 */
+      x: number
+      /** Y 轴 */
+      y: number
+      /** Z 轴 */
+      z: number
+    }
+  }
+
+  interface TaroStatic {
+    /**
+     * 开始监听加速度数据。
+     * @example
+     * ```tsx
+     * Taro.startAccelerometer({ interval: 'game' })
+     * ```
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, rn, harmony
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/accelerometer/wx.startAccelerometer.html
+     */
+    startAccelerometer (res?: startAccelerometer.Option): Promise<TaroGeneral.CallbackResult>
+
+    /**
+     * 停止监听加速度数据。
+     * @example
+     * ```tsx
+     * Taro.stopAccelerometer()
+     * ```
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, rn, harmony
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/accelerometer/wx.stopAccelerometer.html
+     */
+    stopAccelerometer (res?: stopAccelerometer.Option): Promise<TaroGeneral.CallbackResult>
+
+    /**
+     * 监听加速度数据，频率：5次/秒，接口调用后会自动开始监听，可使用 `Taro.stopAccelerometer` 停止监听。
+     * @supported weapp, alipay, swan, jd, qq, tt, h5, rn, harmony
+     * @example
+     * ```tsx
+     * Taro.onAccelerometerChange(res => {
+     *   console.log(res.x)
+     *   console.log(res.y)
+     *   console.log(res.z)
+     * })
+     * ```
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/accelerometer/wx.onAccelerometerChange.html
+     */
+    onAccelerometerChange(
+      callback: onAccelerometerChange.Callback
+    ): void
+
+    /**
+     * 取消监听加速度数据事件，参数为空，则取消所有的事件监听。
+     * @supported weapp, alipay, swan, jd, tt, h5, rn, harmony
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/accelerometer/wx.offAccelerometerChange.html
+     */
+    offAccelerometerChange(
+      /** 加速度数据事件的回调函数 */
+      callback?: onAccelerometerChange.Callback
+    ): void
+  }
+}

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

@@ -0,0 +1,26 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace checkIsOpenAccessibility {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (result: SuccessCallbackResult) => void
+    }
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** iOS 上开启辅助功能旁白，安卓开启 talkback 时返回 true */
+      open: boolean
+    }
+  }
+
+  interface TaroStatic {
+    /** 检测是否开启视觉无障碍功能。
+     * @supported weapp, jd
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/accessibility/wx.checkIsOpenAccessibility.html
+     */
+    checkIsOpenAccessibility(option: checkIsOpenAccessibility.Option): Promise<TaroGeneral.CallbackResult>
+  }
+}

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

@@ -0,0 +1,46 @@
+import Taro from '../../index'
+
+declare module '../../index' {
+  namespace getBatteryInfoSync {
+    interface Result {
+      /** 是否正在充电中 */
+      isCharging: boolean
+      /** 设备电量，范围 1 - 100 */
+      level: number
+    }
+  }
+
+  namespace getBatteryInfo {
+    interface Option {
+      /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+      complete?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用失败的回调函数 */
+      fail?: (res: TaroGeneral.CallbackResult) => void
+      /** 接口调用成功的回调函数 */
+      success?: (res: SuccessCallbackResult) => void
+    }
+
+    interface SuccessCallbackResult extends TaroGeneral.CallbackResult {
+      /** 是否正在充电中 */
+      isCharging: boolean
+      /** 设备电量，范围 1 - 100 */
+      level: number
+      /** 调用结果 */
+      errMsg: string
+    }
+  }
+
+  interface TaroStatic {
+    /** Taro.getBatteryInfo 的同步版本
+     * @supported weapp, alipay, swan, jd, qq, harmony
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/battery/wx.getBatteryInfoSync.html
+     */
+    getBatteryInfoSync(): getBatteryInfoSync.Result
+
+    /** 获取设备电量。同步 API Taro.getBatteryInfoSync 在 iOS 上不可用。
+     * @supported weapp, alipay, swan, jd, qq, h5, harmony, harmony_hybrid
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/device/battery/wx.getBatteryInfo.html
+     */
+    getBatteryInfo(option?: getBatteryInfo.Option): Promise<getBatteryInfo.SuccessCallbackResult>
+  }
+}