@ray-js/api 1.7.70 → 1.7.71

package/@types/GroupCITestKit.d.ts

@@ -0,0 +1,651 @@
+/**
+ * GroupCITestKit
+ *
+ * @version 1.2.109
+ */
+declare namespace ty.groupcitest {
+  /**
+   * 富文档方法，覆盖公开注释、多语言、示例、错误码和外链文本。
+   * @description.en Public method case with multilingual docs and file-backed assets.
+   * @public
+   * @since @ray-js/smart-ui 1.0.0
+   * @since GroupCITestKit 1.2.101
+   * @remarks 这个方法用于验证 method 级别的 decorator 文档字段。
+   * @remarksEn This is the English remarks content.
+   * It verifies `@remarksEn` file loading and final rendering.
+   * @example 基础一点的
+   * ```tsx
+   * ty.richDocMethod({ mode: "basic" });
+   * ```
+   * @example 完整一点的
+   * ```tsx
+   * ty.richDocMethod({
+   *   mode: "basic",
+   *   enabled: true,
+   *   success(data) {
+   *     console.log(data.resultCode);
+   *   },
+   *   fail(err) {
+   *     console.error(err);
+   *   },
+   * });
+   * ```
+   * @see https://developer.tuya.com/
+   * @platform iOS Android
+   * @error {DEMO_ERROR} 演示错误码描述，验证 `@error` 的 `file:` 外链文本会进入最终产物。
+   * @error {DEMO_TIMEOUT} 调用超时，请稍后重试。
+   */
+  export function richDocMethod(params: {
+    /**
+     * 模式字段。
+     * @description.en Mode field.
+     * @since GroupCITestKit 1.2.101
+     */
+    mode: string;
+    /**
+     * 是否启用默认行为。
+     * @description.en Whether to enable the default behavior.
+     * @since GroupCITestKit 1.2.101
+     * @defaultValue true
+     */
+    enabled?: boolean;
+    /**
+     * 旧文本字段。
+     * @description.en Legacy text field.
+     * @since GroupCITestKit 1.2.101
+     * @defaultValue "legacy"
+     * @deprecated 请改用 richDocMethod 或新的默认字段，旧字段将在后续版本移除。
+     */
+    legacyText?: string;
+    /** complete 完成回调（成功、失败都会触发） */
+    complete?: () => void;
+    /** success 成功回调 */
+    success?: (params: {
+      /**
+       * 结果码。
+       * @description.en Result code.
+       * @since GroupCITestKit 1.2.101
+       */
+      resultCode: string;
+    }) => void;
+    /** fail 失败回调 */
+    fail?: (params: {
+      /** 错误信息 */
+      errorMsg: string;
+      /** 错误码 */
+      errorCode: string | number;
+      /** 错误扩展 */
+      innerError: {
+        /** 错误扩展码 */
+        errorCode: string | number;
+        /** 错误扩展信息 */
+        errorMsg: string;
+      };
+    }) => void;
+  }): void;
+
+  /**
+   * 历史方法案例，用于验证英文描述外链、示例文件外链和动态 since 推断。
+   * @description.en This type verifies file-backed English descriptions.
+   * The same text should appear in metadata and declaration output.
+   * @public
+   * @since GroupCITestKit 1.0.0
+   * @remarks 这个历史方法不写版本标签，用于验证方法级动态 since。
+   * @remarksEn This existing method intentionally omits an explicit version tag so the generator can infer it from history.
+   * @example Demo
+   * ```tsx
+   * ty.hasParamsMethod({
+   *   paramsBean: {
+   *     testDeviceID: 123,
+   *   },
+   *   success(data) {
+   *     console.log("advanced", data.testDeviceID);
+   *   },
+   *   fail(err) {
+   *     console.error("advanced", err);
+   *   },
+   * });
+   * ```
+   * @see https://developer.tuya.com/cn/docs/iot
+   * @platform iOS Android Harmony
+   */
+  export function hasParamsMethod(params: {
+    /**
+     * deviceID，ConstantsBean中的类型均可定义。
+     * @description.en Device ID used for history since verification.
+     * @since GroupCITestKit 1.0.0
+     */
+    testDeviceID: number;
+    /** complete 完成回调（成功、失败都会触发） */
+    complete?: () => void;
+    /** success 成功回调 */
+    success?: (params: {
+      /**
+       * deviceID，ConstantsBean中的类型均可定义。
+       * @description.en Device ID returned from callback.
+       * @since GroupCITestKit 1.0.0
+       */
+      testDeviceID: number;
+    }) => void;
+    /** fail 失败回调 */
+    fail?: (params: {
+      /** 错误信息 */
+      errorMsg: string;
+      /** 错误码 */
+      errorCode: string | number;
+      /** 错误扩展 */
+      innerError: {
+        /** 错误扩展码 */
+        errorCode: string | number;
+        /** 错误扩展信息 */
+        errorMsg: string;
+      };
+    }) => void;
+  }): void;
+
+  /**
+   * 有入参有回调（无数据模型返回）的方法声明。
+   * @public
+   * @since GroupCITestKit 1.0.0
+   * @platform iOS Android Harmony
+   */
+  export function hasParamsNoCallbackModelMethod(params: {
+    /**
+     * deviceID，ConstantsBean中的类型均可定义。
+     * @description.en Device ID used for history since verification.
+     * @since GroupCITestKit 1.0.0
+     */
+    testDeviceID: number;
+    /** complete 完成回调（成功、失败都会触发） */
+    complete?: () => void;
+    /** success 成功回调 */
+    success?: (params: null) => void;
+    /** fail 失败回调 */
+    fail?: (params: {
+      /** 错误信息 */
+      errorMsg: string;
+      /** 错误码 */
+      errorCode: string | number;
+      /** 错误扩展 */
+      innerError: {
+        /** 错误扩展码 */
+        errorCode: string | number;
+        /** 错误扩展信息 */
+        errorMsg: string;
+      };
+    }) => void;
+  }): void;
+
+  /**
+   * 有入参有回调（boolean返回）的方法声明。
+   * @public
+   * @since GroupCITestKit 1.0.0
+   * @platform iOS Android
+   */
+  export function hasParamsBooleanModelMethod(params: {
+    /**
+     * deviceID，ConstantsBean中的类型均可定义。
+     * @description.en Device ID used for history since verification.
+     * @since GroupCITestKit 1.0.0
+     */
+    testDeviceID: number;
+    /** complete 完成回调（成功、失败都会触发） */
+    complete?: () => void;
+    /** success 成功回调 */
+    success?: (params: boolean) => void;
+    /** fail 失败回调 */
+    fail?: (params: {
+      /** 错误信息 */
+      errorMsg: string;
+      /** 错误码 */
+      errorCode: string | number;
+      /** 错误扩展 */
+      innerError: {
+        /** 错误扩展码 */
+        errorCode: string | number;
+        /** 错误扩展信息 */
+        errorMsg: string;
+      };
+    }) => void;
+  }): void;
+
+  /**
+   * 有入参有回调（string返回）的方法声明。
+   * @public
+   * @since GroupCITestKit 1.0.0
+   * @platform iOS Android Harmony
+   */
+  export function hasParamsStringModelMethod(params: {
+    /**
+     * deviceID，ConstantsBean中的类型均可定义。
+     * @description.en Device ID used for history since verification.
+     * @since GroupCITestKit 1.0.0
+     */
+    testDeviceID: number;
+    /** complete 完成回调（成功、失败都会触发） */
+    complete?: () => void;
+    /** success 成功回调 */
+    success?: (params: string) => void;
+    /** fail 失败回调 */
+    fail?: (params: {
+      /** 错误信息 */
+      errorMsg: string;
+      /** 错误码 */
+      errorCode: string | number;
+      /** 错误扩展 */
+      innerError: {
+        /** 错误扩展码 */
+        errorCode: string | number;
+        /** 错误扩展信息 */
+        errorMsg: string;
+      };
+    }) => void;
+  }): void;
+
+  /**
+   * 有入参有回调（Integer返回）的方法声明。
+   * @public
+   * @since GroupCITestKit 1.0.0
+   * @platform iOS Android
+   */
+  export function hasParamsIntegerModelMethod(params: {
+    /**
+     * deviceID，ConstantsBean中的类型均可定义。
+     * @description.en Device ID used for history since verification.
+     * @since GroupCITestKit 1.0.0
+     */
+    testDeviceID: number;
+    /** complete 完成回调（成功、失败都会触发） */
+    complete?: () => void;
+    /** success 成功回调 */
+    success?: (params: number) => void;
+    /** fail 失败回调 */
+    fail?: (params: {
+      /** 错误信息 */
+      errorMsg: string;
+      /** 错误码 */
+      errorCode: string | number;
+      /** 错误扩展 */
+      innerError: {
+        /** 错误扩展码 */
+        errorCode: string | number;
+        /** 错误扩展信息 */
+        errorMsg: string;
+      };
+    }) => void;
+  }): void;
+
+  /**
+   * 有入参有回调（Float返回）的方法声明。
+   * @public
+   * @since GroupCITestKit 1.0.0
+   * @platform iOS Android Harmony
+   */
+  export function hasParamsFloatModelMethod(params: {
+    /**
+     * deviceID，ConstantsBean中的类型均可定义。
+     * @description.en Device ID used for history since verification.
+     * @since GroupCITestKit 1.0.0
+     */
+    testDeviceID: number;
+    /** complete 完成回调（成功、失败都会触发） */
+    complete?: () => void;
+    /** success 成功回调 */
+    success?: (params: number) => void;
+    /** fail 失败回调 */
+    fail?: (params: {
+      /** 错误信息 */
+      errorMsg: string;
+      /** 错误码 */
+      errorCode: string | number;
+      /** 错误扩展 */
+      innerError: {
+        /** 错误扩展码 */
+        errorCode: string | number;
+        /** 错误扩展信息 */
+        errorMsg: string;
+      };
+    }) => void;
+  }): void;
+
+  /**
+   * 无入参有回调（有数据模型返回）的方法声明。
+   * @public
+   * @since GroupCITestKit 1.0.0
+   * @platform iOS Android
+   * @deprecated 请改用 richDocMethod 或新的默认字段，旧字段将在后续版本移除。
+   */
+  export function noParamsMethod(params?: {
+    /** complete 完成回调（成功、失败都会触发） */
+    complete?: () => void;
+    /** success 成功回调 */
+    success?: (params: {
+      /**
+       * deviceID，ConstantsBean中的类型均可定义。
+       * @description.en Device ID returned from callback.
+       * @since GroupCITestKit 1.0.0
+       */
+      testDeviceID: number;
+    }) => void;
+    /** fail 失败回调 */
+    fail?: (params: {
+      /** 错误信息 */
+      errorMsg: string;
+      /** 错误码 */
+      errorCode: string | number;
+      /** 错误扩展 */
+      innerError: {
+        /** 错误扩展码 */
+        errorCode: string | number;
+        /** 错误扩展信息 */
+        errorMsg: string;
+      };
+    }) => void;
+  }): void;
+
+  /**
+   * 无入参有回调（无数据模型返回）的方法声明。
+   * @public
+   * @since GroupCITestKit 1.0.0
+   * @platform iOS Android Harmony
+   */
+  export function noParamsNoCallbackModelMethod(params?: {
+    /** complete 完成回调（成功、失败都会触发） */
+    complete?: () => void;
+    /** success 成功回调 */
+    success?: (params: {
+      /**
+       * deviceID，ConstantsBean中的类型均可定义。
+       * @description.en Device ID returned from callback.
+       * @since GroupCITestKit 1.0.0
+       */
+      testDeviceID: number;
+    }) => void;
+    /** fail 失败回调 */
+    fail?: (params: {
+      /** 错误信息 */
+      errorMsg: string;
+      /** 错误码 */
+      errorCode: string | number;
+      /** 错误扩展 */
+      innerError: {
+        /** 错误扩展码 */
+        errorCode: string | number;
+        /** 错误扩展信息 */
+        errorMsg: string;
+      };
+    }) => void;
+  }): void;
+
+  /**
+   * Event事件声明，Event事件命名均已on开头。
+   * @public
+   * @since GroupCITestKit 1.2.100
+   * @platform iOS Android Harmony
+   */
+  export function onTestEvent(listener: (params: EventBodyBean_jEOOSU) => void): void;
+
+  /**
+   * Event事件声明，Event事件命名均已on开头。
+   * @public
+   * @since GroupCITestKit 1.2.100
+   * @platform iOS Android Harmony
+   */
+  export function offTestEvent(listener: (params: EventBodyBean_jEOOSU) => void): void;
+
+  /**
+   * RegisterEvent事件声明，RegisterEvent事件声明由两个方法组成。
+   * @public
+   * @since GroupCITestKit 1.2.100
+   * @platform iOS Android Harmony
+   */
+  export function onTestRegisterEventMethod(
+    listener: (params: {
+      /** url */
+      url: string;
+    }) => void,
+  ): void;
+
+  /**
+   * 历史入参模型，用于验证属性级动态 since。
+   * @description.en Historical params bean used to verify inferred property since.
+   */
+  export interface ParamsBean_k1LFBO {
+    /**
+     * deviceID，ConstantsBean中的类型均可定义。
+     * @description.en Device ID used for history since verification.
+     * @since GroupCITestKit 1.0.0
+     */
+    testDeviceID: number;
+  }
+
+  /** 常量定义集合。 */
+  export interface ConstantsBean_z1PxNj {
+    /** Integer 类型，属性版本号 d.Variable('2.0.0')。 */
+    testInt: number;
+    /**
+     * Integer 类型。
+     * @defaultValue 9
+     */
+    testInt2?: number;
+    /** Long 类型。 */
+    testLong: number;
+    /**
+     * Long 类型。
+     * @defaultValue 123
+     */
+    testLong2?: number;
+    /** Float 类型。 */
+    testFloat: number;
+    /**
+     * Float 类型。
+     * @defaultValue 1.02
+     */
+    testFloat2?: number;
+    /** Double 类型。 */
+    testDouble: number;
+    /**
+     * Double 类型。
+     * @defaultValue 1.02123213
+     */
+    testDouble2?: number;
+    /** Array 类型。 */
+    testArray: string[];
+    /**
+     * Array 类型。
+     * @defaultValue ["abc", "def", "123"]
+     */
+    testArray2?: string[];
+    /** Array 类型。 */
+    testArray3: ParamsBean_k1LFBO[];
+    /** Map 类型。 */
+    testMap: Record<string, string>;
+    /** Map 类型。 */
+    testMap2: Record<string, any>;
+    /** 自定义对象类型。 */
+    testBean: ParamsBean_k1LFBO;
+    /**
+     * 默认开关，验证 defaultValue 自动提取。
+     * @defaultValue false
+     */
+    testEnabled?: boolean;
+    /**
+     * 已废弃字段。
+     * @defaultValue "legacy"
+     * @deprecated 请改用 richDocMethod 或新的默认字段，旧字段将在后续版本移除。
+     */
+    legacyField?: string;
+  }
+
+  /**
+   * 富文档入参模型，用于验证类型级别的别名、版本和外链备注。
+   * @description.en This type verifies file-backed English descriptions.
+   * The same text should appear in metadata and declaration output.
+   * @alias HarmonyRichDocParams
+   * @since @ray-js/ray 3.0.0
+   * @example Demo
+   * ```tsx
+   * ty.richDocMethod({
+   *   mode: "basic",
+   *   enabled: true,
+   *   success(data) {
+   *     console.log(data.resultCode);
+   *   },
+   *   fail(err) {
+   *     console.error(err);
+   *   },
+   * });
+   * ```
+   * @see https://developer.tuya.com/cn/docs/iot
+   */
+  export interface RichDocParamsBean_Vlyd29 {
+    /**
+     * 模式字段。
+     * @description.en Mode field.
+     * @since GroupCITestKit 1.2.101
+     */
+    mode: string;
+    /**
+     * 是否启用默认行为。
+     * @description.en Whether to enable the default behavior.
+     * @since GroupCITestKit 1.2.101
+     * @defaultValue true
+     */
+    enabled?: boolean;
+    /**
+     * 旧文本字段。
+     * @description.en Legacy text field.
+     * @since GroupCITestKit 1.2.101
+     * @defaultValue "legacy"
+     * @deprecated 请改用 richDocMethod 或新的默认字段，旧字段将在后续版本移除。
+     */
+    legacyText?: string;
+  }
+
+  /**
+   * 富文档方法返回值。
+   * @description.en Rich documented callback bean.
+   */
+  export interface RichDocCallbackBean_b47MEv {
+    /**
+     * 结果码。
+     * @description.en Result code.
+     * @since GroupCITestKit 1.2.101
+     */
+    resultCode: string;
+  }
+
+  /**
+   * 历史返回模型，用于验证出参属性级动态 since。
+   * @description.en Historical callback bean used to verify inferred return property since.
+   */
+  export interface CallbackBean_EdSC0o {
+    /**
+     * deviceID，ConstantsBean中的类型均可定义。
+     * @description.en Device ID returned from callback.
+     * @since GroupCITestKit 1.0.0
+     */
+    testDeviceID: number;
+  }
+
+  export interface EventBodyBean_jEOOSU {
+    /** url */
+    url: string;
+  }
+
+  export interface TaskBean_UukM2C {
+    /** taskId */
+    taskId: string;
+    /**
+     * taskParam
+     * @since GroupCITestKit 1.2.107
+     */
+    taskParam: string;
+  }
+
+  export interface RegisterEventBean_kgUrAO {
+    /** url */
+    url: string;
+  }
+
+  export interface RegisterTaskEventBean_VX1QZa {
+    /** taskid */
+    taskId: string;
+    /** url */
+    url: string;
+  }
+
+  interface CreateDemoTask {
+    /**
+     * Task 普通方法声明。
+     * @public
+     * @since GroupCITestKit 1.2.107
+     * @platform iOS Android
+     */
+    taskPingMethod(params?: {
+      /** complete 完成回调（成功、失败都会触发） */
+      complete?: () => void;
+      /** success 成功回调 */
+      success?: (params: null) => void;
+      /** fail 失败回调 */
+      fail?: (params: {
+        /** 错误信息 */
+        errorMsg: string;
+        /** 错误码 */
+        errorCode: string | number;
+        /** 错误扩展 */
+        innerError: {
+          /** 错误扩展码 */
+          errorCode: string | number;
+          /** 错误扩展信息 */
+          errorMsg: string;
+        };
+      }) => void;
+    }): void;
+
+    /**
+     * Task RegisterEvent 事件声明。
+     * @public
+     * @platform iOS Android Harmony
+     */
+    onTaskRegisterEventMethod(
+      listener: (params: {
+        /** taskid */
+        taskId: string;
+        /** url */
+        url: string;
+      }) => void,
+    ): void;
+  }
+  /**
+   * 创建task对象。
+   * @public
+   * @since GroupCITestKit 1.0.0
+   * @platform iOS Android
+   */
+  export function createDemo(params: {
+    /**
+     * taskParam
+     * @since GroupCITestKit 1.2.107
+     */
+    taskParam: string;
+    /** complete 完成回调（成功、失败都会触发） */
+    complete?: () => void;
+    /** success 成功回调 */
+    success?: (params: null) => void;
+    /** fail 失败回调 */
+    fail?: (params: {
+      /** 错误信息 */
+      errorMsg: string;
+      /** 错误码 */
+      errorCode: string | number;
+      /** 错误扩展 */
+      innerError: {
+        /** 错误扩展码 */
+        errorCode: string | number;
+        /** 错误扩展信息 */
+        errorMsg: string;
+      };
+    }) => void;
+  }): CreateDemoTask;
+}