@ray-js/api 1.7.69 → 1.7.71

package/lib/cloud/interface.d.ts

@@ -327,6 +327,9 @@ export interface IGetLastTimerPeriodResponse {
     timers: Timers[];
 }
 export interface IGetAstronomicalList {
+    /**
+     * 设备 ID 或群组 ID
+     */
     bizId: string;
 }
 export interface IGetAstronomicalListResponse {
@@ -454,7 +457,13 @@ export interface IUpdateBillConfigure {
     billType: number;
 }
 export interface IGetDpsInfos {
+    /**
+     * 网关 ID，直连设备值同 devId，子设备则传网关的设备 ID
+     */
     gwId: string;
+    /**
+     * 设备 ID
+     */
     devId: string;
 }
 export interface IGetDpsInfosResponse {
@@ -484,9 +493,21 @@ export interface IGetDpsInfosResponse {
     type: string;
 }
 export interface IUpdateDpName {
+    /**
+     * 设备 ID
+     */
     devId: string;
+    /**
+     * DP ID
+     */
     dpId: string;
+    /**
+     * DP 自定义名称
+     */
     name: string;
+    /**
+     * 网关 ID，可不传
+     */
     gwId?: string;
 }
 export interface IGetGroupDpsInfosResponse {
@@ -516,8 +537,17 @@ export interface IGetGroupDpsInfosResponse {
     type: string;
 }
 export interface IUpdateGroupDpName {
+    /**
+     * 群组 ID
+     */
     group: string;
+    /**
+     * DP ID
+     */
     dpId: string;
+    /**
+     * DP 自定义名称
+     */
     name: string;
 }
 export interface IGetWeatherQuality {
@@ -725,12 +755,27 @@ export interface IGetWeathersResponse {
     }>;
 }
 export interface ISaveCustomizePosition {
+    /**
+     * 设备 ID
+     */
     devId: string;
+    /**
+     * 经度
+     */
     lon: string;
+    /**
+     * 纬度
+     */
     lat: string;
+    /**
+     * 位置名称（目前没用，不影响天气返回结果）
+     */
     locationName?: string;
 }
 export interface IGetCustomizePosition {
+    /**
+     * 设备 ID
+     */
     devId: string;
 }
 export interface IGetCustomizePositionResponse {
@@ -928,34 +973,57 @@ export interface IAlarmSdk {
     setAlarmSwitch: any;
 }
 export interface IGetLinkageDeviceList {
+    /** 家庭 ID */
     gid: number;
+    /** 请求类型 */
     sourceType: string;
 }
-export type IGetLinkageDeviceListResponse = Array<{
+export interface ILinkageDevice {
+    /** 设备品类 */
     category: string;
+    /** 设备 DP 点列表 */
     datapoints: any[];
+    /** 设备 ID */
     devId: string;
+    /** 设备图标地址 */
     iconUrl: string;
+    /** 设备名称 */
     name: string;
+    /** 产品 ID */
     productId: string;
-}>;
-export type IGetSceneListResponse = Array<{
+}
+export interface ISceneListItem {
+    /** 执行动作 */
     actions: any[];
+    /** 属性 */
     attribute: number;
+    /** 审核状态 */
     auditStatus: number;
+    /** 背景图地址 */
     background: string;
+    /** 面板绑定 */
     boundForPanel: boolean;
+    /** WiFi 面板绑定 */
     boundForWiFiPanel: boolean;
+    /** 规则 code */
     code: string;
+    /** 通用字段 */
     commonField: string;
+    /** 图标 */
     coverIcon: string;
+    /** 禁用时间 */
     disableTime: number;
+    /** 背景颜色 */
     displayColor: string;
+    /** 规则是否启用 */
     enabled: true;
+    /** 设备 ID */
     devId: string;
+    /** 联动名称 */
     name: string;
+    /** 执行规则 ID */
     id: string;
-}>;
+}
 export interface ISceneAction {
     /**
      * 执行动作的显示名称
@@ -1017,11 +1085,14 @@ export interface ISceneAction {
 /**
  * 一键执行类型的联动规则数据
  */
-export type IGetSceneListResponseV2 = Array<{
+export interface ISceneListItemV2 {
     /**
      * 执行动作
      */
     actions: ISceneAction[];
+    /**
+     * 是否为告警问题
+     */
     alarmIssue: boolean;
     /**
      * 属性
@@ -1043,6 +1114,9 @@ export type IGetSceneListResponseV2 = Array<{
      * 面板绑定
      */
     boundForPanel: boolean;
+    /**
+     * WiFi 面板绑定
+     */
     boundForWiFiPanel: boolean;
     /**
      * 规则 code
@@ -1052,12 +1126,21 @@ export type IGetSceneListResponseV2 = Array<{
      * 通用json字段，比如本地联动会存网关id，gwId
      */
     commonField: string;
+    /**
+     * 是否包含已删除的设备
+     */
     containDeviceDelete: boolean;
     /**
      * 图标
      */
     coverIcon: string;
+    /**
+     * 规则描述
+     */
     description?: string;
+    /**
+     * 禁用时间戳
+     */
     disableTime?: number;
     /**
      * 背景颜色
@@ -1067,13 +1150,25 @@ export type IGetSceneListResponseV2 = Array<{
      * 规则是否启用
      */
     enabled: boolean;
+    /**
+     * 是否强制云端触发
+     */
     forceCloudTrigger: boolean;
     /**
      * 执行规则 id
      */
     id: string;
+    /**
+     * 是否为 IoT 自动告警
+     */
     iotAutoAlarm: boolean;
+    /**
+     * 是否为告警问题
+     */
     isAlarmIssue: boolean;
+    /**
+     * 是否为逻辑规则
+     */
     isLogicRule: boolean;
     /**
      * 联动类型
@@ -1083,6 +1178,9 @@ export type IGetSceneListResponseV2 = Array<{
      * 是否本地联动
      */
     localLinkage: boolean;
+    /**
+     * 是否逻辑规则
+     */
     logicRule: boolean;
     /**
      * 匹配类型
@@ -1095,20 +1193,53 @@ export type IGetSceneListResponseV2 = Array<{
      * 联动名称或备注
      */
     name: string;
+    /**
+     * 是否需要清理 gidSid
+     */
     needCleanGidSid: boolean;
+    /**
+     * 是否需要校验不在工作时间段
+     */
     needValidOutOfWork: boolean;
+    /**
+     * 是否为新本地场景
+     */
     newLocalScene: boolean;
+    /**
+     * 是否离网关同步
+     */
     offGwSync: boolean;
+    /**
+     * 离网关同步是否成功
+     */
     offGwSyncSuccess: boolean;
+    /**
+     * 排序权重
+     */
     orderWeight: number;
+    /**
+     * 不在工作时间段标记
+     */
     outOfWork: number;
     /**
-     * 家庭id
+     * 家庭 id
      */
     ownerId: string;
+    /**
+     * 面板类型
+     */
     panelType: number;
+    /**
+     * 权限 code
+     */
     permissionCode: string;
+    /**
+     * 规则体裁
+     */
     ruleGenre: number;
+    /**
+     * 规则来源
+     */
     ruleSource: number;
     /**
      * 规则类型
@@ -1123,20 +1254,33 @@ export type IGetSceneListResponseV2 = Array<{
      * 运行环境
      */
     runtimeEnv: string;
+    /**
+     * 是否为场景规则
+     */
     scenarioRule: boolean;
+    /**
+     * 规则状态
+     */
     status: boolean;
+    /**
+     * 状态条件列表
+     */
     statusConditions: any[];
     /**
      * 是否显示在首页顶部
      */
     stickyOnTop: boolean;
+    /**
+     * 子匹配类型
+     */
     subMatchType: number;
     /**
      * 用户 id
      */
     uid: string;
-}>;
+}
 export interface IBindRule {
+    /** 设备 ID */
     devId: string;
     /**
      * 与面板/设备建立绑定关系,通常为设备ID、DP点、群组、规则，dpId#value等
@@ -1146,10 +1290,15 @@ export interface IBindRule {
      * 当associativeEntityId不足以区分情况下使用，通常可关联设备、DP值、群组、规则等
      */
     associativeEntityId: AssociativeEntityId;
+    /** 关联场景 ID */
     ruleId: string;
+    /** 关联 DP 点 */
     entitySubIds: string;
+    /** 关联 DP 点、动作组合 */
     expr: [string[]];
+    /** 业务域 */
     bizDomain: string;
+    /** 家庭 ID */
     gid: string;
     /**
      * 拓展字段，非必传
@@ -1190,18 +1339,41 @@ export interface IBindRuleResponse {
      */
     triggerRuleVO: any;
 }
+/**
+ * 实体类型枚举
+ */
 declare enum EntityType {
-    DEVICE = 1,// 关联实体为设备
+    /** 关联实体为设备 */
+    DEVICE = 1,
+    /** 关联实体为联动规则 */
     RULE = 2
 }
 export interface IGetBindRuleList {
+    /** 业务域 */
     bizDomain: string;
+    /** 设备 ID */
     devId: string;
+    /** 与面板/设备建立绑定关系标识 */
     sourceEntityId?: string;
+    /** 实体类型，1 为设备，2 为联动规则 */
     entityType: EntityType;
+    /** 家庭 ID */
     gid: string;
 }
-export type IGetBindRuleListResponse = Array<{
+/**
+ * 绑定规则关联的场景项
+ */
+export interface IBindRuleSceneItem extends ISceneListItemV2 {
+    /**
+     * 无线开关规则是否启用
+     */
+    triggerRuleEnable: boolean;
+    /**
+     * 无线开关执行规则 id
+     */
+    triggerRuleId: string;
+}
+export interface IBindRuleListItem {
     /**
      * 与面板/设备建立绑定关系,通常为设备ID、DP点、群组、规则，dpId#value等
      */
@@ -1209,16 +1381,7 @@ export type IGetBindRuleListResponse = Array<{
     /**
      * 关联实体的值列表
      */
-    associativeEntityValueList: Array<IGetSceneListResponseV2[number] & {
-        /**
-         * 无线开关规则是否启用
-         */
-        triggerRuleEnable: boolean;
-        /**
-         * 无线开关执行规则 id
-         */
-        triggerRuleId: string;
-    }>;
+    associativeEntityValueList: IBindRuleSceneItem[];
     /**
      * 绑定 id，一般用来解绑
      */
@@ -1235,23 +1398,29 @@ export type IGetBindRuleListResponse = Array<{
      * 设备 ID
      */
     sourceEntityId: string;
-}>;
+}
 export interface IUnbindRule {
     /**
-     * 解绑 id
+     * 绑定 ID
      */
     bindId: string;
     /**
-     * 家庭 id
+     * 家庭 ID
      */
     gid: string;
 }
 export interface IRemoveRule {
+    /** 业务域 */
     bizDomain: string;
+    /** 与面板/设备建立绑定关系标识 */
     sourceEntityId?: string;
+    /** 设备 ID */
     devId: string;
+    /** 绑定关系标识 */
     associativeEntityId: AssociativeEntityId;
+    /** 规则 ID */
     associativeEntityValue: AssociativeEntityValue;
+    /** 家庭 ID */
     gid: string;
 }
 export interface IGetDevProperty {
@@ -1268,7 +1437,7 @@ export interface IGetDevProperty {
      */
     code: string;
 }
-export type IGetDevPropertyResponse = Array<{
+export interface IDevPropertyItem {
     /**
      * 业务类型
      */
@@ -1301,7 +1470,8 @@ export type IGetDevPropertyResponse = Array<{
      * 属性值
      */
     value: string;
-}>;
+}
+export type IGetDevPropertyResponse = IDevPropertyItem[];
 export interface ISaveDevProperty {
     /**
      * 设备 ID
@@ -1339,25 +1509,29 @@ export interface IGetZigbeeLocalGroupRelation {
      */
     devId: string;
 }
+/**
+ * Zigbee 本地群组关系项
+ */
+export interface IZigbeeLocalGroupRelationItem {
+    /**
+     * 功能点 code
+     */
+    code: string;
+    /**
+     * 排序
+     */
+    order: number;
+    /**
+     * 设备端用到的群组 localId
+     */
+    localId: string;
+    /**
+     * 面板使用的 code，用来做映射，值以 300 为前缀，例如 3001
+     */
+    categoryCode: string;
+}
 export type IGetZigbeeLocalGroupRelationResponse = {
-    locals: Array<{
-        /**
-         * 功能点 code
-         */
-        code: string;
-        /**
-         * 排序
-         */
-        order: number;
-        /**
-         * 设备端用到的群组 localId
-         */
-        localId: string;
-        /**
-         * 面板使用的 code，用来做映射，值以 300 为前缀，例如 3001
-         */
-        categoryCode: string;
-    }>;
+    locals: IZigbeeLocalGroupRelationItem[];
 };
 export interface IGetZigbeeLocalGroupDeviceList {
     /**
@@ -1379,7 +1553,10 @@ export interface IGetZigbeeLocalGroupDeviceList {
      */
     homeId: string;
 }
-export type IGetZigbeeLocalGroupDeviceListResponse = Array<{
+/**
+ * Zigbee 本地群组设备信息
+ */
+export interface IZigbeeLocalGroupDevice {
     /**
      * 设备产品 id
      */
@@ -1420,7 +1597,8 @@ export type IGetZigbeeLocalGroupDeviceListResponse = Array<{
      * 网关是否在线
      */
     gwOnline: boolean;
-}>;
+}
+export type IGetZigbeeLocalGroupDeviceListResponse = IZigbeeLocalGroupDevice[];
 export type QueryGetMessageList = {
     sourceIds: string[];
     limit: number;

package/lib/cloud/interface.js

@@ -14,12 +14,25 @@
 /**
  * 一键执行类型的联动规则数据
  */
+/**
+ * 实体类型枚举
+ */
 var EntityType = /*#__PURE__*/function (EntityType) {
+  /** 关联实体为设备 */
   EntityType[EntityType["DEVICE"] = 1] = "DEVICE";
-  // 关联实体为设备
-  EntityType[EntityType["RULE"] = 2] = "RULE"; // 关联实体为联动规则
+  /** 关联实体为联动规则 */
+  EntityType[EntityType["RULE"] = 2] = "RULE";
   return EntityType;
 }(EntityType || {});
+/**
+ * 绑定规则关联的场景项
+ */
+/**
+ * Zigbee 本地群组关系项
+ */
+/**
+ * Zigbee 本地群组设备信息
+ */
 export let ReportType = /*#__PURE__*/function (ReportType) {
   ReportType[ReportType["DAILY"] = 1] = "DAILY";
   ReportType[ReportType["WEEKLY"] = 2] = "WEEKLY";

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

@@ -0,0 +1,27 @@
+import type { DeleteCleaningRecordParams } from './type';
+/**
+ * 删除清扫记录
+ * @public
+ * @since @ray-js/ray 1.5.36
+ * @since 基础库 2.21.0
+ * @param params - 包含设备 ID 和要删除的记录 ID 数组
+ * @returns Promise，resolve 值为 boolean，表示删除是否成功
+ * @example
+ * ```tsx
+ * import React from 'react';
+ * import { Button, deleteCleaningRecord } from '@ray-js/ray';
+ *
+ * export default function Demo() {
+ *   const handleDelete = async () => {
+ *     const success = await deleteCleaningRecord({
+ *       devId: 'your-device-id',
+ *       fileIds: [1001, 1002],
+ *     });
+ *     console.log('删除结果:', success);
+ *   };
+ *   return <Button onClick={handleDelete}>删除记录</Button>;
+ * }
+ * ```
+ */
+declare const deleteCleaningRecord: (params: DeleteCleaningRecordParams) => Promise<boolean>;
+export default deleteCleaningRecord;

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

@@ -0,0 +1,28 @@
+/**
+ * 删除清扫记录
+ * @public
+ * @since @ray-js/ray 1.5.36
+ * @since 基础库 2.21.0
+ * @param params - 包含设备 ID 和要删除的记录 ID 数组
+ * @returns Promise，resolve 值为 boolean，表示删除是否成功
+ * @example
+ * ```tsx
+ * import React from 'react';
+ * import { Button, deleteCleaningRecord } from '@ray-js/ray';
+ *
+ * export default function Demo() {
+ *   const handleDelete = async () => {
+ *     const success = await deleteCleaningRecord({
+ *       devId: 'your-device-id',
+ *       fileIds: [1001, 1002],
+ *     });
+ *     console.log('删除结果:', success);
+ *   };
+ *   return <Button onClick={handleDelete}>删除记录</Button>;
+ * }
+ * ```
+ */
+const deleteCleaningRecord = function (params) {
+  return ty.deleteCleaningRecord(params);
+};
+export default deleteCleaningRecord;

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

@@ -0,0 +1,7 @@
+/** 删除清扫记录的请求参数 */
+export interface DeleteCleaningRecordParams {
+    /** 设备 ID */
+    devId: string;
+    /** 要删除的记录 ID 数组 */
+    fileIds: number[];
+}

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

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

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

@@ -0,0 +1,27 @@
+import type { DeleteGyroCleanRecordParams } from './type';
+/**
+ * 删除惯导扫地机的清扫记录
+ * @public
+ * @since @ray-js/ray 1.7.14
+ * @since 基础库 2.29.0
+ * @param params - 包含设备 ID 和要删除的记录 ID
+ * @returns Promise，resolve 值为 boolean，表示删除是否成功
+ * @example
+ * ```tsx
+ * import React from 'react';
+ * import { Button, deleteGyroCleanRecord } from '@ray-js/ray';
+ *
+ * export default function Demo() {
+ *   const handleDelete = async () => {
+ *     const success = await deleteGyroCleanRecord({
+ *       devId: 'your-device-id',
+ *       uuid: 'record-id-1',
+ *     });
+ *     console.log('删除结果:', success);
+ *   };
+ *   return <Button onClick={handleDelete}>删除记录</Button>;
+ * }
+ * ```
+ */
+declare const deleteGyroCleanRecord: (params: DeleteGyroCleanRecordParams) => Promise<boolean>;
+export default deleteGyroCleanRecord;

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

@@ -0,0 +1,28 @@
+/**
+ * 删除惯导扫地机的清扫记录
+ * @public
+ * @since @ray-js/ray 1.7.14
+ * @since 基础库 2.29.0
+ * @param params - 包含设备 ID 和要删除的记录 ID
+ * @returns Promise，resolve 值为 boolean，表示删除是否成功
+ * @example
+ * ```tsx
+ * import React from 'react';
+ * import { Button, deleteGyroCleanRecord } from '@ray-js/ray';
+ *
+ * export default function Demo() {
+ *   const handleDelete = async () => {
+ *     const success = await deleteGyroCleanRecord({
+ *       devId: 'your-device-id',
+ *       uuid: 'record-id-1',
+ *     });
+ *     console.log('删除结果:', success);
+ *   };
+ *   return <Button onClick={handleDelete}>删除记录</Button>;
+ * }
+ * ```
+ */
+const deleteGyroCleanRecord = function (params) {
+  return ty.deleteGyroCleanRecord(params);
+};
+export default deleteGyroCleanRecord;

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

@@ -0,0 +1,7 @@
+/** 删除惯导扫地机清扫记录的请求参数 */
+export interface DeleteGyroCleanRecordParams {
+    /** 设备 ID */
+    devId: string;
+    /** 清扫记录的 recordId，多条记录用逗号隔开 */
+    uuid: string;
+}

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

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