@ray-js/api 1.7.69 → 1.7.71

package/lib/cloud/laser-clean/getVoiceList/index.js

@@ -0,0 +1,29 @@
+/**
+ * 获取扫地机的语音包列表
+ * @public
+ * @since @ray-js/ray 1.5.36
+ * @since 基础库 2.21.0
+ * @param params - 查询参数，包含设备 ID 和分页信息
+ * @returns Promise，resolve 值为语音包列表、当前页码和总数
+ * @example
+ * ```tsx
+ * import React from 'react';
+ * import { Button, getVoiceList } from '@ray-js/ray';
+ *
+ * export default function Demo() {
+ *   const handleFetch = async () => {
+ *     const result = await getVoiceList({
+ *       devId: 'your-device-id',
+ *       offset: 0,
+ *       limit: 100,
+ *     });
+ *     console.log(result.datas, result.totalCount);
+ *   };
+ *   return <Button onClick={handleFetch}>获取语音包列表</Button>;
+ * }
+ * ```
+ */
+const getVoiceList = function (params) {
+  return ty.getVoiceList(params);
+};
+export default getVoiceList;

package/lib/cloud/laser-clean/getVoiceList/type.d.ts

@@ -0,0 +1,48 @@
+/** 语音包扩展数据 */
+export interface VoiceExtendData {
+    /** 扩展 ID，与设备上报的语言包 ID 对比可判断是否正在使用 */
+    extendId: number;
+    /** 版本号 */
+    version: string;
+}
+/** 单个语音包信息 */
+export interface VoiceItem {
+    /** 试听链接 */
+    auditionUrl: string;
+    /** 描述（可选） */
+    desc?: string;
+    /** 扩展数据 */
+    extendData: VoiceExtendData;
+    /** 语音包 ID */
+    id: number;
+    /** 封面图片链接 */
+    imgUrl: string;
+    /** 语音包名称 */
+    name: string;
+    /** 官方下载链接 */
+    officialUrl: string;
+    /** 产品 ID */
+    productId: string;
+    /** 可用区域代码数组 */
+    region: string[];
+}
+/** 获取扫地机语音包列表的请求参数 */
+export interface GetVoiceListParams {
+    /** 设备 ID */
+    devId: string;
+    /** 设备 ID（兼容字段） */
+    deviceId?: string;
+    /** 分页偏移量，语言包较少时可传 0 */
+    offset: number;
+    /** 每页大小，建议传 100 */
+    limit: number;
+}
+/** 获取扫地机语音包列表的返回值 */
+export interface GetVoiceListResponse {
+    /** 语音包数据数组 */
+    datas: VoiceItem[];
+    /** 当前页码 */
+    pageNo: number;
+    /** 数据总数 */
+    totalCount: number;
+}

package/lib/cloud/laser-clean/getVoiceList/type.js

@@ -0,0 +1 @@
+export {};

package/lib/cloud/laser-clean/index.d.ts

@@ -1,3 +1,3 @@
-export { getCleaningRecords, deleteCleaningRecord, getGyroCleanRecords, getGyroCleanRecordDetail } from './record';
+export { getCleaningRecords, deleteCleaningRecord, getGyroCleanRecords, getGyroCleanRecordDetail, deleteGyroCleanRecord, } from './record';
 export { getVoiceList } from './voice';
 export { getMultipleMapFiles, getSweeperStorageConfig, deleteMultipleMapFiles, getGyroLatestCleanMap, renameHistoryMap, } from './map';

package/lib/cloud/laser-clean/index.js

@@ -1,3 +1,3 @@
-export { getCleaningRecords, deleteCleaningRecord, getGyroCleanRecords, getGyroCleanRecordDetail } from './record';
+export { getCleaningRecords, deleteCleaningRecord, getGyroCleanRecords, getGyroCleanRecordDetail, deleteGyroCleanRecord } from './record';
 export { getVoiceList } from './voice';
 export { getMultipleMapFiles, getSweeperStorageConfig, deleteMultipleMapFiles, getGyroLatestCleanMap, renameHistoryMap } from './map';

package/lib/cloud/laser-clean/map.d.ts

@@ -1,7 +1,5 @@
-/// <reference path="../../../@types/api-cloud.d.ts" />
-declare const getMultipleMapFiles: typeof ty.getMultipleMapFiles;
-declare const getSweeperStorageConfig: typeof ty.getSweeperStorageConfig;
-declare const deleteMultipleMapFiles: typeof ty.deleteMultipleMapFiles;
-declare const getGyroLatestCleanMap: typeof ty.getGyroLatestCleanMap;
-declare const renameHistoryMap: typeof ty.renameHistoryMap;
-export { getMultipleMapFiles, getSweeperStorageConfig, deleteMultipleMapFiles, getGyroLatestCleanMap, renameHistoryMap, };
+export { default as getMultipleMapFiles } from './getMultipleMapFiles';
+export { default as getSweeperStorageConfig } from './getSweeperStorageConfig';
+export { default as deleteMultipleMapFiles } from './deleteMultipleMapFiles';
+export { default as getGyroLatestCleanMap } from './getGyroLatestCleanMap';
+export { default as renameHistoryMap } from './renameHistoryMap';

package/lib/cloud/laser-clean/map.js

@@ -1,9 +1,5 @@
-/// <reference path="../../../@types/api-cloud.d.ts" />
-
-import { factory } from '../../utils';
-const getMultipleMapFiles = factory('getMultipleMapFiles');
-const getSweeperStorageConfig = factory('getSweeperStorageConfig');
-const deleteMultipleMapFiles = factory('deleteMultipleMapFiles');
-const getGyroLatestCleanMap = factory('getGyroLatestCleanMap');
-const renameHistoryMap = factory('renameHistoryMap');
-export { getMultipleMapFiles, getSweeperStorageConfig, deleteMultipleMapFiles, getGyroLatestCleanMap, renameHistoryMap };
+export { default as getMultipleMapFiles } from './getMultipleMapFiles';
+export { default as getSweeperStorageConfig } from './getSweeperStorageConfig';
+export { default as deleteMultipleMapFiles } from './deleteMultipleMapFiles';
+export { default as getGyroLatestCleanMap } from './getGyroLatestCleanMap';
+export { default as renameHistoryMap } from './renameHistoryMap';

package/lib/cloud/laser-clean/record.d.ts

@@ -1,6 +1,5 @@
-/// <reference path="../../../@types/api-cloud.d.ts" />
-declare const getCleaningRecords: typeof ty.getCleaningRecords;
-declare const deleteCleaningRecord: typeof ty.deleteCleaningRecord;
-declare const getGyroCleanRecords: typeof ty.getGyroCleanRecords;
-declare const getGyroCleanRecordDetail: typeof ty.getGyroCleanRecordDetail;
-export { getCleaningRecords, deleteCleaningRecord, getGyroCleanRecords, getGyroCleanRecordDetail };
+export { default as getCleaningRecords } from './getCleaningRecords';
+export { default as deleteCleaningRecord } from './deleteCleaningRecord';
+export { default as getGyroCleanRecords } from './getGyroCleanRecords';
+export { default as getGyroCleanRecordDetail } from './getGyroCleanRecordDetail';
+export { default as deleteGyroCleanRecord } from './deleteGyroCleanRecord';

package/lib/cloud/laser-clean/record.js

@@ -1,7 +1,5 @@
-/// <reference path="../../../@types/api-cloud.d.ts" />
-import { factory } from '../../utils';
-const getCleaningRecords = factory('getCleaningRecords');
-const deleteCleaningRecord = factory('deleteCleaningRecord');
-const getGyroCleanRecords = factory('getGyroCleanRecords');
-const getGyroCleanRecordDetail = factory('getGyroCleanRecordDetail');
-export { getCleaningRecords, deleteCleaningRecord, getGyroCleanRecords, getGyroCleanRecordDetail };
+export { default as getCleaningRecords } from './getCleaningRecords';
+export { default as deleteCleaningRecord } from './deleteCleaningRecord';
+export { default as getGyroCleanRecords } from './getGyroCleanRecords';
+export { default as getGyroCleanRecordDetail } from './getGyroCleanRecordDetail';
+export { default as deleteGyroCleanRecord } from './deleteGyroCleanRecord';

package/lib/cloud/laser-clean/renameHistoryMap/index.d.ts

@@ -0,0 +1,28 @@
+import type { RenameHistoryMapParams } from './type';
+/**
+ * 重命名扫地机的历史地图
+ * @public
+ * @since @ray-js/ray 1.7.10
+ * @since 基础库 2.27.2
+ * @param params - 请求参数，包含设备 ID、地图文件 ID 和新名称
+ * @returns Promise，resolve 值为 boolean，表示重命名是否成功
+ * @example
+ * ```tsx
+ * import React from 'react';
+ * import { Button, renameHistoryMap } from '@ray-js/ray';
+ *
+ * export default function Demo() {
+ *   const handleRename = async () => {
+ *     const success = await renameHistoryMap({
+ *       devId: 'your-device-id',
+ *       id: 2001,
+ *       fileName: '客厅地图',
+ *     });
+ *     console.log('重命名结果:', success);
+ *   };
+ *   return <Button onClick={handleRename}>重命名地图</Button>;
+ * }
+ * ```
+ */
+declare const renameHistoryMap: (params: RenameHistoryMapParams) => Promise<boolean>;
+export default renameHistoryMap;

package/lib/cloud/laser-clean/renameHistoryMap/index.js

@@ -0,0 +1,29 @@
+/**
+ * 重命名扫地机的历史地图
+ * @public
+ * @since @ray-js/ray 1.7.10
+ * @since 基础库 2.27.2
+ * @param params - 请求参数，包含设备 ID、地图文件 ID 和新名称
+ * @returns Promise，resolve 值为 boolean，表示重命名是否成功
+ * @example
+ * ```tsx
+ * import React from 'react';
+ * import { Button, renameHistoryMap } from '@ray-js/ray';
+ *
+ * export default function Demo() {
+ *   const handleRename = async () => {
+ *     const success = await renameHistoryMap({
+ *       devId: 'your-device-id',
+ *       id: 2001,
+ *       fileName: '客厅地图',
+ *     });
+ *     console.log('重命名结果:', success);
+ *   };
+ *   return <Button onClick={handleRename}>重命名地图</Button>;
+ * }
+ * ```
+ */
+const renameHistoryMap = function (params) {
+  return ty.renameHistoryMap(params);
+};
+export default renameHistoryMap;

package/lib/cloud/laser-clean/renameHistoryMap/type.d.ts

@@ -0,0 +1,9 @@
+/** 重命名历史地图的请求参数 */
+export interface RenameHistoryMapParams {
+    /** 设备 ID */
+    devId: string;
+    /** 地图文件 ID */
+    id: number;
+    /** 新的文件名称 */
+    fileName: string;
+}

package/lib/cloud/laser-clean/renameHistoryMap/type.js

@@ -0,0 +1 @@
+export {};

package/lib/cloud/laser-clean/voice.d.ts

@@ -1,3 +1 @@
-/// <reference path="../../../@types/api-cloud.d.ts" />
-declare const getVoiceList: typeof ty.getVoiceList;
-export { getVoiceList };
+export { default as getVoiceList } from './getVoiceList';

package/lib/cloud/laser-clean/voice.js

@@ -1,4 +1 @@
-/// <reference path="../../../@types/api-cloud.d.ts" />
-import { factory } from '../../utils';
-const getVoiceList = factory('getVoiceList');
-export { getVoiceList };
+export { default as getVoiceList } from './getVoiceList';

package/lib/cloud/linkage.d.ts

@@ -1,82 +1,300 @@
-import { IGetLinkageDeviceList, IBindRule, IGetBindRuleList, IRemoveRule, IGetLinkageDeviceListResponse, IGetSceneListResponse, IGetBindRuleListResponse, IBindRuleResponse, IUnbindRule, IGetSceneListResponseV2 } from './interface';
+import { IGetLinkageDeviceList, IBindRule, IGetBindRuleList, IRemoveRule, ILinkageDevice, ISceneListItem, IBindRuleListItem, IBindRuleResponse, IUnbindRule, ISceneListItemV2 } from './interface';
+interface IRuleIdParams {
+    /** 规则 ID */
+    ruleId: string;
+}
+interface ISceneListParams {
+    /** 设备 ID */
+    devId: string;
+    /** 家庭 ID */
+    gid: string;
+}
 /**
- * 获取家庭下支持联动的设备列表
- * @param {number} gid 家庭id
- * @param {string} sourceType 业务范围
+ * 查询家庭下支持联动的所有设备
+ * @param params - 查询设备列表参数
+ * @param params.gid 家庭 ID，可通过 getCurrentHomeInfo 获取
+ * @param params.sourceType 请求类型
+ * @returns 支持联动的设备列表
+ * @public
+ * @since @ray-js/ray 1.4.61
+ * @example
+ * ```typescript
+ * import { getLinkageDeviceList } from '@ray-js/ray';
+ *
+ * const fetchDevices = async () => {
+ *   try {
+ *     const devices = await getLinkageDeviceList({
+ *       gid: 12345678,
+ *       sourceType: 'condition',
+ *     });
+ *     devices.forEach(dev => {
+ *       console.log(`设备: ${dev.name}, ID: ${dev.devId}`);
+ *     });
+ *   } catch (err) {
+ *     console.error('查询失败:', err);
+ *   }
+ * };
+ * ```
  */
-declare const getLinkageDeviceList: (params: IGetLinkageDeviceList) => Promise<IGetLinkageDeviceListResponse>;
+declare const getLinkageDeviceList: (params: IGetLinkageDeviceList) => Promise<ILinkageDevice[]>;
 /**
- * 查询家庭下联动规则列表，包含失效及自动化规则
- * @param {number} devId 设备id
- * @param {number} gid 家庭Id
+ * 查询设备支持的一键执行场景，包含失效及自动化规则
+ * @param params - 查询参数
+ * @param params.devId 设备 ID
+ * @param params.gid 家庭 ID
+ * @returns 联动规则列表
+ * @public
+ * @since @ray-js/ray 1.4.61
+ * @example
+ * ```typescript
+ * import { getSceneList } from '@ray-js/ray';
+ *
+ * const fetchScenes = async () => {
+ *   try {
+ *     const scenes = await getSceneList({
+ *       devId: 'device_001',
+ *       gid: '12345678',
+ *     });
+ *     console.log('场景列表:', scenes);
+ *   } catch (err) {
+ *     console.error('查询失败:', err);
+ *   }
+ * };
+ * ```
  */
-declare const getSceneList: ({ devId, gid }: {
-    devId: string;
-    gid: string;
-}) => Promise<IGetSceneListResponse>;
+declare const getSceneList: ({ devId, gid }: ISceneListParams) => Promise<ISceneListItem[]>;
 /**
  * 查询家庭下一键执行列表，会去掉失效或自动化规则
- * @param {number} devId 设备id
- * @param {boolean} containStandardZigBee 是否包含标准场景，默认不包含
- * @param {number} gid 家庭Id
+ * @param params - 查询参数
+ * @param params.devId 设备 ID
+ * @param params.gid 家庭 ID
+ * @param params.containStandardZigBee 是否包含标准场景
+ * @defaultValue containStandardZigBee false
+ * @returns 一键执行类型的联动规则列表
+ * @public
+ * @since @ray-js/ray 1.5.15
+ * @example
+ * ```typescript
+ * import { getSceneListV2 } from '@ray-js/ray';
+ *
+ * const fetchScenes = async () => {
+ *   try {
+ *     const scenes = await getSceneListV2({
+ *       devId: 'device_001',
+ *       gid: '12345678',
+ *       containStandardZigBee: false,
+ *     });
+ *     console.log('一键执行列表:', scenes);
+ *   } catch (err) {
+ *     console.error('查询失败:', err);
+ *   }
+ * };
+ * ```
  */
 declare const getSceneListV2: ({ devId, gid, containStandardZigBee, }: {
+    /** 设备 ID */
     devId: string;
+    /** 家庭 ID */
     gid: string;
+    /** 是否包含标准场景 */
     containStandardZigBee?: boolean;
-}) => Promise<IGetSceneListResponseV2>;
+}) => Promise<ISceneListItemV2[]>;
 /**
- * 查询家庭下已绑定的列表
- * @param {string} bizDomain 业务范围
- * @param {string} devId 设备id
- * @param {number} entityType 实体类型
+ * 查询设备条件已绑定的场景
+ * @param params - 查询参数
+ * @param params.bizDomain 业务域
+ * @param params.devId 设备 ID
+ * @param params.entityType 实体类型，1 为设备，2 为联动规则
+ * @param params.gid 家庭 ID
+ * @returns 已绑定的规则列表
+ * @public
+ * @since @ray-js/ray 1.4.61
+ * @example
+ * ```typescript
+ * import { getBindRuleList } from '@ray-js/ray';
+ *
+ * const fetchBindRules = async () => {
+ *   try {
+ *     const rules = await getBindRuleList({
+ *       bizDomain: 'wirelessSwitch',
+ *       devId: 'device_001',
+ *       entityType: 1,
+ *       gid: '12345678',
+ *     });
+ *     rules.forEach(rule => {
+ *       console.log(`绑定ID: ${rule.bindId}, 启用: ${rule.enable}`);
+ *     });
+ *   } catch (err) {
+ *     console.error('查询失败:', err);
+ *   }
+ * };
+ * ```
  */
-declare const getBindRuleList: (params: IGetBindRuleList) => Promise<IGetBindRuleListResponse>;
+declare const getBindRuleList: (params: IGetBindRuleList) => Promise<IBindRuleListItem[]>;
 /**
- * 绑定联动
- * @param {string} devId 设备 ID
- * @param {string} associativeEntityId 关联DP点和DP点值的组合
- * @param {string} ruleId 关联场景 ID
- * @param {string} entitySubIds 关联 DP 点
- * @param {Array} expr 关联DP点、动作组合
- * @param {string} bizDomain 业务域
- * @param {string} bizDomain 业务域
+ * 将按键条件与场景规则关联，建立设备按键与联动规则的绑定关系
+ * @param params - 绑定规则参数
+ * @param params.devId 设备 ID
+ * @param params.associativeEntityId 与面板/设备建立绑定关系，通常为设备 ID、DP 点、群组、规则，dpId#value 等
+ * @param params.ruleId 关联场景 ID
+ * @param params.entitySubIds 关联 DP 点
+ * @param params.expr 关联 DP 点、动作组合
+ * @param params.bizDomain 业务域
+ * @param params.gid 家庭 ID，可通过 getCurrentHomeInfo 获取
+ * @returns 绑定结果信息
+ * @public
+ * @since @ray-js/ray 1.7.60
+ * @example
+ * ```typescript
+ * import { bindRule } from '@ray-js/ray';
+ *
+ * const bindSceneRule = async () => {
+ *   try {
+ *     const result = await bindRule({
+ *       devId: 'device_001',
+ *       associativeEntityId: '1',
+ *       ruleId: 'rule_001',
+ *       entitySubIds: '1',
+ *       expr: [['$dp1', '==', 'true']],
+ *       bizDomain: 'wirelessSwitch',
+ *       gid: '12345678',
+ *     });
+ *     console.log('绑定成功, ID:', result.id);
+ *   } catch (err) {
+ *     console.error('绑定失败:', err);
+ *   }
+ * };
+ * ```
  */
 declare const bindRule: (params: IBindRule) => Promise<IBindRuleResponse>;
 /**
- * 解绑联动
- * @param {string} bindId 绑定 id
- * @param {string} gid 家庭id
+ * 解绑联动，删除按键条件与场景规则的绑定关系
+ * @param params - 解绑规则参数
+ * @param params.bindId 绑定 ID
+ * @param params.gid 家庭 ID
+ * @returns 是否解绑成功
+ * @public
+ * @since @ray-js/ray 1.5.15
+ * @example
+ * ```typescript
+ * import { unbindRule } from '@ray-js/ray';
+ *
+ * const unbindSceneRule = async () => {
+ *   try {
+ *     const success = await unbindRule({
+ *       bindId: '123456',
+ *       gid: '12345678',
+ *     });
+ *     console.log('解绑结果:', success);
+ *   } catch (err) {
+ *     console.error('解绑失败:', err);
+ *   }
+ * };
+ * ```
  */
 declare const unbindRule: (params: IUnbindRule) => Promise<boolean>;
 /**
- * 解除联动
- * @param {string} bizDomain 业务范围
- * @param {string} devId 设备id
- * @param {string} associativeEntityId 关联dp组合
- * @param {string} associativeEntityValue 规则id
- * @param {string} gid 家庭id
+ * 移除相关按键条件下的场景规则
+ * @param params - 移除规则参数
+ * @param params.bizDomain 业务域
+ * @param params.devId 设备 ID
+ * @param params.associativeEntityId 绑定关系标识
+ * @param params.associativeEntityValue 规则 ID
+ * @param params.gid 家庭 ID
+ * @returns 是否删除成功
+ * @public
+ * @since @ray-js/ray 1.7.60
+ * @example
+ * ```typescript
+ * import { removeRule } from '@ray-js/ray';
+ *
+ * const removeSceneRule = async () => {
+ *   try {
+ *     const success = await removeRule({
+ *       bizDomain: 'wirelessSwitch',
+ *       devId: 'device_001',
+ *       associativeEntityId: '1',
+ *       associativeEntityValue: 'rule_001',
+ *       gid: '12345678',
+ *     });
+ *     console.log('移除结果:', success);
+ *   } catch (err) {
+ *     console.error('移除失败:', err);
+ *   }
+ * };
+ * ```
  */
 declare const removeRule: (params: IRemoveRule) => Promise<boolean>;
 /**
- * 触发联动
- * @param {string} ruleId 规则id
+ * 一键触发场景联动，由云端执行关联的自动化规则
+ * @param params - 触发规则参数
+ * @param params.ruleId 规则 ID
+ * @returns 是否执行成功
+ * @public
+ * @since @ray-js/ray 1.7.60
+ * @example
+ * ```typescript
+ * import { triggerRule } from '@ray-js/ray';
+ *
+ * const triggerSceneRule = async () => {
+ *   try {
+ *     const success = await triggerRule({
+ *       ruleId: 'rule_001',
+ *     });
+ *     console.log('触发结果:', success);
+ *   } catch (err) {
+ *     console.error('触发失败:', err);
+ *   }
+ * };
+ * ```
  */
-declare const triggerRule: ({ ruleId }: {
-    ruleId: string;
-}) => Promise<boolean>;
+declare const triggerRule: (params: IRuleIdParams) => Promise<boolean>;
 /**
- *  启用联动
- * @param {string} ruleId 规则id
+ * 开启已绑定规则，恢复规则的自动执行
+ * @param params - 启用规则参数
+ * @param params.ruleId 规则 ID
+ * @returns 是否操作成功
+ * @public
+ * @since @ray-js/ray 1.7.60
+ * @example
+ * ```typescript
+ * import { enableRule } from '@ray-js/ray';
+ *
+ * const enableSceneRule = async () => {
+ *   try {
+ *     const success = await enableRule({
+ *       ruleId: 'rule_001',
+ *     });
+ *     console.log('开启规则结果:', success);
+ *   } catch (err) {
+ *     console.error('开启失败:', err);
+ *   }
+ * };
+ * ```
  */
-declare const enableRule: ({ ruleId }: {
-    ruleId: string;
-}) => Promise<boolean>;
+declare const enableRule: (params: IRuleIdParams) => Promise<boolean>;
 /**
- * 停用联动
- * @param {string} ruleId 规则id
+ * 关闭已绑定规则，暂停规则的自动执行
+ * @param params - 禁用规则参数
+ * @param params.ruleId 规则 ID
+ * @returns 是否操作成功
+ * @public
+ * @since @ray-js/ray 1.7.60
+ * @example
+ * ```typescript
+ * import { disableRule } from '@ray-js/ray';
+ *
+ * const disableSceneRule = async () => {
+ *   try {
+ *     const success = await disableRule({
+ *       ruleId: 'rule_001',
+ *     });
+ *     console.log('关闭规则结果:', success);
+ *   } catch (err) {
+ *     console.error('关闭失败:', err);
+ *   }
+ * };
+ * ```
  */
-declare const disableRule: ({ ruleId }: {
-    ruleId: string;
-}) => Promise<boolean>;
+declare const disableRule: (params: IRuleIdParams) => Promise<boolean>;
 export { getLinkageDeviceList, getSceneList, getSceneListV2, getBindRuleList, bindRule, unbindRule, removeRule, triggerRule, enableRule, disableRule, };