@ray-js/api 1.7.80 → 1.7.82

package/@types/ThirdAuthKit.d.ts

@@ -1,100 +1,324 @@
 /**
  * ThirdAuthKit
  *
- * @version 1.0.1
+ * @version 1.0.15
  */
 declare namespace ty.thirdauth {
   /**
-   *@description QQ音乐授权
-   *注意:WearKit(2.1.0)起下该方法已过时,请使用ThirdAuthKit下同名方法*/
+   * QQ音乐授权
+   * @description.en QQ Music authorization.
+   * @public
+   * @since WearKit 1.0.0
+   * @remarks 注意:WearKit(2.1.0)起下该方法已过时,请使用ThirdAuthKit下同名方法
+   * @remarksEn Note: Deprecated since WearKit 2.1.0, use the same method in ThirdAuthKit.
+   * @example 基础用法
+   * ```tsx
+   * ty.wear.qqMusicAuth({
+   *   type: 0,
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
+   * @see https://developer.tuya.com/
+   * @platform iOS Android
+   * @error {10001} 参数错误
+   * @error {10002} 授权失败
+   * @error {10003} 解密失败
+   * @error {10004} JSON解析错误
+   * @error {10005} 签名校验失败
+   * @error {10006} 不支持的授权类型
+   */
   export function qqMusicAuth(params: {
-    /** 三方服务列表 ThirdPartyType */
+    /**
+     * 第三方服务类型，参见 ThirdPartyType 枚举
+     * @since ThirdAuthKit 1.0.0
+     */
     type: number
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void
+    /** 接口调用成功的回调函数 */
     success?: (params: {
-      /** 过期时间 */
+      /**
+       * 过期时间（Unix 时间戳，单位：秒）
+       * @since ThirdAuthKit 1.0.0
+       */
       expireTime: number
-      /** openId */
+      /**
+       * QQ音乐账户 openId
+       * @since ThirdAuthKit 1.0.0
+       */
       openId: string
-      /** openToken */
+      /**
+       * QQ音乐访问令牌
+       * @since ThirdAuthKit 1.0.0
+       */
       openToken: string
     }) => void
+    /** 接口调用失败的回调函数 */
     fail?: (params: {
+      /** 错误信息 */
       errorMsg: string
+      /** 错误码 */
       errorCode: string | number
+      /** 错误扩展 */
       innerError: {
+        /** 错误扩展码 */
         errorCode: string | number
+        /** 错误扩展信息 */
         errorMsg: string
       }
     }) => void
-    complete?: () => void
   }): void
 
   /**
-   *@description 获取QQ音乐QQ小程序授权参数
-   *注意:WearKit(2.1.0)起下该方法已过时,请使用ThirdAuthKit下同名方法*/
+   * 获取QQ音乐QQ小程序授权参数
+   * @description.en Get QQ Music QQ Mini Program authorization parameters.
+   * @public
+   * @since WearKit 1.0.0
+   * @remarks 注意:WearKit(2.1.0)起下该方法已过时,请使用ThirdAuthKit下同名方法
+   * @remarksEn Note: Deprecated since WearKit 2.1.0, use the same method in ThirdAuthKit.
+   * @example 基础用法
+   * ```tsx
+   * ty.wear.getQQMusicQQMiniProgramAuthParams({
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
+   * @see https://developer.tuya.com/
+   * @platform iOS Android
+   */
   export function getQQMusicQQMiniProgramAuthParams(params?: {
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void
+    /** 接口调用成功的回调函数 */
     success?: (params: {
-      /** qq音乐appkey */
+      /**
+       * QQ音乐 AppKey
+       * @since ThirdAuthKit 1.0.0
+       */
       qqMusicAppKey: string
-      /** 签名字符串 */
+      /**
+       * 加密的签名字符串
+       * @since ThirdAuthKit 1.0.0
+       */
       encryptString: string
     }) => void
+    /** 接口调用失败的回调函数 */
     fail?: (params: {
+      /** 错误信息 */
       errorMsg: string
+      /** 错误码 */
       errorCode: string | number
+      /** 错误扩展 */
       innerError: {
+        /** 错误扩展码 */
         errorCode: string | number
+        /** 错误扩展信息 */
         errorMsg: string
       }
     }) => void
-    complete?: () => void
   }): void
 
   /**
-   *@description 解析QQ音乐QQ小程序授权结果
-   *注意:WearKit(2.1.0)起下该方法已过时,请使用ThirdAuthKit下同名方法*/
+   * 解析QQ音乐QQ小程序授权结果
+   * @description.en Parse QQ Music QQ Mini Program authorization result.
+   * @public
+   * @since WearKit 1.0.0
+   * @remarks 注意:WearKit(2.1.0)起下该方法已过时,请使用ThirdAuthKit下同名方法
+   * @remarksEn Note: Deprecated since WearKit 2.1.0, use the same method in ThirdAuthKit.
+   * @example 基础用法
+   * ```tsx
+   * ty.wear.parseQQMusicAuthResult({
+   *   encryptString: "xx",
+   *   success: data => {
+   *     console.log(data);
+   *   },
+   *   fail: error => {
+   *     console.error(error);
+   *   },
+   * });
+   * ```
+   * @see https://developer.tuya.com/
+   * @platform iOS Android
+   * @error {10001} 参数错误
+   * @error {10004} JSON解析错误
+   * @error {10005} 签名校验失败
+   * @error {10007} 解密失败
+   */
   export function parseQQMusicAuthResult(params: {
-    /** 授权结果 */
+    /**
+     * 加密的授权结果字符串
+     * @since ThirdAuthKit 1.0.0
+     */
     encryptString: string
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void
+    /** 接口调用成功的回调函数 */
     success?: (params: {
-      /** 过期时间 */
+      /**
+       * 过期时间（Unix 时间戳，单位：秒）
+       * @since ThirdAuthKit 1.0.0
+       */
       expireTime: number
-      /** openId */
+      /**
+       * QQ音乐账户 openId
+       * @since ThirdAuthKit 1.0.0
+       */
       openId: string
-      /** openToken */
+      /**
+       * QQ音乐访问令牌
+       * @since ThirdAuthKit 1.0.0
+       */
       openToken: string
     }) => void
+    /** 接口调用失败的回调函数 */
     fail?: (params: {
+      /** 错误信息 */
       errorMsg: string
+      /** 错误码 */
       errorCode: string | number
+      /** 错误扩展 */
       innerError: {
+        /** 错误扩展码 */
         errorCode: string | number
+        /** 错误扩展信息 */
         errorMsg: string
       }
     }) => void
-    complete?: () => void
   }): void
 
   /**
-   *@description 获取微信授权信息
-   *注意:WearKit(2.1.0)起下该方法已过时,请使用ThirdAuthKit下同名方法*/
+   * 监听微信授权代理事件
+   * @description.en Get WeChat authorization information.
+   * @public
+   * @since WearKit 1.0.0
+   * @remarks 注意:WearKit(2.1.0)起下该方法已过时,请使用ThirdAuthKit下同名方法
+   * @remarksEn Note: Deprecated since WearKit 2.1.0, use the same method in ThirdAuthKit.
+   * @example 基础用法
+   * ```tsx
+   * ty.wear.onWechatAuthAgentEvent(e => {
+   *   console.log(e);
+   * });
+   * ```
+   * @see https://developer.tuya.com/
+   * @platform iOS Android
+   */
   export function onWechatAuthAgentEvent(
     listener: (params: QQMusicAuthResult) => void
   ): void
 
   /**
-   *@description 移除监听：获取微信授权信息
-   *注意:WearKit(2.1.0)起下该方法已过时,请使用ThirdAuthKit下同名方法*/
+   * 监听微信授权代理事件
+   * @description.en Get WeChat authorization information.
+   * @public
+   * @since WearKit 1.0.0
+   * @remarks 注意:WearKit(2.1.0)起下该方法已过时,请使用ThirdAuthKit下同名方法
+   * @remarksEn Note: Deprecated since WearKit 2.1.0, use the same method in ThirdAuthKit.
+   * @example 基础用法
+   * ```tsx
+   * ty.wear.onWechatAuthAgentEvent(e => {
+   *   console.log(e);
+   * });
+   * ```
+   * @see https://developer.tuya.com/
+   * @platform iOS Android
+   */
   export function offWechatAuthAgentEvent(
     listener: (params: QQMusicAuthResult) => void
   ): void
 
-  export type QQMusicAuthResult = {
-    /** 过期时间 */
+  /**
+   * QQ音乐授权请求参数
+   * @since ThirdAuthKit 1.0.0
+   */
+  export interface QQMusicAuthParams {
+    /**
+     * 第三方服务类型，参见 ThirdPartyType 枚举
+     * @since ThirdAuthKit 1.0.0
+     */
+    type: number
+  }
+
+  /**
+   * QQ音乐授权结果
+   * @since ThirdAuthKit 1.0.0
+   */
+  export interface QQMusicAuthResult {
+    /**
+     * 过期时间（Unix 时间戳，单位：秒）
+     * @since ThirdAuthKit 1.0.0
+     */
     expireTime: number
-    /** openId */
+    /**
+     * QQ音乐账户 openId
+     * @since ThirdAuthKit 1.0.0
+     */
     openId: string
-    /** openToken */
+    /**
+     * QQ音乐访问令牌
+     * @since ThirdAuthKit 1.0.0
+     */
     openToken: string
   }
+
+  /**
+   * QQ音乐小程序授权参数
+   * @since ThirdAuthKit 1.0.0
+   */
+  export interface QQMusicQQMiniProgramAuthParams {
+    /**
+     * QQ音乐 AppKey
+     * @since ThirdAuthKit 1.0.0
+     */
+    qqMusicAppKey: string
+    /**
+     * 加密的签名字符串
+     * @since ThirdAuthKit 1.0.0
+     */
+    encryptString: string
+  }
+
+  /**
+   * QQ音乐授权结果解析参数
+   * @since ThirdAuthKit 1.0.0
+   */
+  export interface QQMusicAuthResultParseParam {
+    /**
+     * 加密的授权结果字符串
+     * @since ThirdAuthKit 1.0.0
+     */
+    encryptString: string
+  }
+
+  /**
+   * 第三方服务类型枚举
+   * @since ThirdAuthKit 1.0.0
+   */
+  export enum ThirdPartyType {
+    /**
+     * qq音乐
+     * @since ThirdAuthKit 1.0.0
+     */
+    QQMusic = 0,
+
+    /**
+     * qq(暂不支持)
+     * @since ThirdAuthKit 1.0.0
+     */
+    QQ = 1,
+
+    /**
+     * 微信
+     * @since ThirdAuthKit 1.0.0
+     */
+    Wechat = 2,
+  }
 }

package/@types/ThirdPartyDeviceKit.d.ts

@@ -160,7 +160,7 @@ declare namespace ty.thirdpartydevice {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */
@@ -192,7 +192,7 @@ declare namespace ty.thirdpartydevice {
     /** 接口调用结束的回调函数（调用成功、失败都会执行） */
     complete?: () => void
     /** 接口调用成功的回调函数 */
-    success?: (params: null) => void
+    success?: () => void
     /** 接口调用失败的回调函数 */
     fail?: (params: {
       /** 错误信息 */