@ray-js/api 1.5.13 → 1.5.15

package/lib/cloud/interface.d.ts

@@ -330,36 +330,117 @@ export interface IGetAstronomicalList {
     bizId: string;
 }
 export interface IGetAstronomicalListResponse {
-    categoryStatus: number;
-    id: string;
-    category: string;
-    timers: Array<{
-        status: number;
-        loops: string;
-        time: string;
-        id: number;
-        isAppPush: boolean;
-        dps: string;
-        groupOrder: number;
-        groupId: string;
-        aliasName: string;
-    }>;
+    /**
+     * 日出日落类型
+     */
+    astronomicalType: number;
+    /**
+     * 设备或群组 ID
+     */
+    bizId: string;
+    /**
+     * 资源类型。0：单设备。1：群组设备。
+     */
+    bizType: number;
+    /**
+     * DP 值
+     */
+    dps: string;
+    /**
+     * 定时任务 ID
+     */
+    id: number;
+    /**
+     * 经度
+     */
+    lat: number;
+    /**
+     * 纬度
+     */
+    lon: number;
+    /**
+     * 周循环
+     */
+    loops: string;
+    /**
+     * 下一个日出时间
+     */
+    nextSunSet: string;
+    /**
+     * 定时偏移执行类型
+     */
+    offsetType: number;
+    /**
+     * 定时任务状态，0 关闭，1 开启，2 无效/已删除
+     */
+    status: number;
+    /**
+     * 定时时间
+     */
+    time: string;
+    /**
+     * 时区
+     */
+    timezone: string;
 }
 export interface IAstronomical {
+    /**
+     * 定时任务 ID
+     */
+    id: number;
+    /**
+     * 设备或群组 ID
+     */
     bizId: string;
+    /**
+     * 资源类型。0：单设备。1：群组设备。
+     */
     bizType: number;
+    /**
+     * 周循环
+     */
     loops: string;
-    dps: any;
+    /**
+     * DP 值
+     */
+    dps: string;
+    /**
+     * 日出日落类型
+     */
     astronomicalType: number;
+    /**
+     * 时区
+     */
     timezone: string;
+    /**
+     * 定时日期 yyyyMMdd
+     */
     date: string;
+    /**
+     * 定时时间
+     */
     time: string;
+    /**
+     * 定时偏移执行类型
+     */
     offsetType: number;
+    /**
+     * 经度
+     */
     lat: number;
+    /**
+     * 纬度
+     */
     lon: number;
 }
 export interface IUpdateAstronomicalStatus {
+    /**
+     * 定时任务 ID
+     */
     id: string;
+    /**
+     * 0：关闭。1：开启
+     */
     status: number;
 }
 export interface IUpdateBillConfigure {
@@ -875,15 +956,205 @@ export type IGetSceneListResponse = Array<{
     name: string;
     id: string;
 }>;
+export interface ISceneAction {
+    /**
+     * 执行动作的显示名称
+     */
+    actionDisplay: string;
+    /**
+     * 执行动作的执行者
+     */
+    actionExecutor: string;
+    /**
+     * 执行动作的策略
+     */
+    actionStrategy: string;
+    /**
+     * 属性值
+     */
+    attribute: number;
+    /**
+     * 设备删除标记，表示设备是否被删除
+     */
+    devDelMark: boolean;
+    /**
+     * 动作是否启用
+     */
+    enabled: boolean;
+    /**
+     * 实体ID，表示动作所属的实体的ID
+     */
+    entityId: string;
+    /**
+     * 修改时间戳
+     */
+    gmtModified: number;
+    /**
+     * 动作的唯一ID
+     */
+    id: string;
+    /**
+     * 网关同步标记，表示是否网关同步
+     */
+    offGwSync: boolean;
+    /**
+     * 动作的顺序号
+     */
+    orderNum: number;
+    /**
+     * 规则ID，表示动作所属的规则的ID
+     */
+    ruleId: string;
+    /**
+     * 动作状态
+     */
+    status: boolean;
+    /**
+     * 用户ID，表示动作所属的用户的ID
+     */
+    uid: string;
+}
+/**
+ * 一键执行类型的联动规则数据
+ */
+export type IGetSceneListResponseV2 = Array<{
+    /**
+     * 执行动作
+     */
+    actions: ISceneAction[];
+    alarmIssue: boolean;
+    /**
+     * 属性
+     * 根据枚举值的2次幂进行位运算
+     */
+    attribute: number;
+    /**
+     * 审核状态
+     * 0. 未审核
+     * 1. 审核通过
+     * 2. 审核不通过
+     */
+    auditStatus: number;
+    /**
+     * 背景图地址
+     */
+    background?: string;
+    /**
+     * 面板绑定
+     */
+    boundForPanel: boolean;
+    boundForWiFiPanel: boolean;
+    /**
+     * 规则 code
+     */
+    code: string;
+    /**
+     * 通用json字段，比如本地联动会存网关id，gwId
+     */
+    commonField: string;
+    containDeviceDelete: boolean;
+    /**
+     * 图标
+     */
+    coverIcon: string;
+    description?: string;
+    disableTime?: number;
+    /**
+     * 背景颜色
+     */
+    displayColor: string;
+    /**
+     * 规则是否启用
+     */
+    enabled: boolean;
+    forceCloudTrigger: boolean;
+    /**
+     * 执行规则 id
+     */
+    id: string;
+    iotAutoAlarm: boolean;
+    isAlarmIssue: boolean;
+    isLogicRule: boolean;
+    /**
+     * 联动类型
+     */
+    linkageType: number;
+    /**
+     * 是否本地联动
+     */
+    localLinkage: boolean;
+    logicRule: boolean;
+    /**
+     * 匹配类型
+     * 1. 任意条件，多个条件里只要有一个即触发（即 或关系）。
+     * 2. 全部满足，多个条件全部满足才触发。
+     * 3. 表态式匹配， 根据 rule 字段的 expr 确定是否满足，条件满足时触发。
+     */
+    matchType: number;
+    /**
+     * 联动名称或备注
+     */
+    name: string;
+    needCleanGidSid: boolean;
+    needValidOutOfWork: boolean;
+    newLocalScene: boolean;
+    offGwSync: boolean;
+    offGwSyncSuccess: boolean;
+    orderWeight: number;
+    outOfWork: number;
+    /**
+     * 家庭id
+     */
+    ownerId: string;
+    panelType: number;
+    permissionCode: string;
+    ruleGenre: number;
+    ruleSource: number;
+    /**
+     * 规则类型
+     * 1. 系统定义
+     * 2. 商家定义
+     * 3. 用户定义
+     * 4. 安防规则
+     * 5. 服务定义（如 dp 点转发）
+     */
+    ruleType: number;
+    /**
+     * 运行环境
+     */
+    runtimeEnv: string;
+    scenarioRule: boolean;
+    status: boolean;
+    statusConditions: any[];
+    /**
+     * 是否显示在首页顶部
+     */
+    stickyOnTop: boolean;
+    subMatchType: number;
+    /**
+     * 用户 id
+     */
+    uid: string;
+}>;
 export interface IBindRule {
     devId: string;
+    /**
+     * 与面板/设备建立绑定关系,通常为设备ID、DP点、群组、规则，dpId#value等
+     */
     sourceEntityId?: string;
+    /**
+     * 当associativeEntityId不足以区分情况下使用，通常可关联设备、DP值、群组、规则等
+     */
     associativeEntityId: AssociativeEntityId;
     ruleId: string;
     entitySubIds: string;
     expr: [string[]];
     bizDomain: string;
     gid: string;
+    /**
+     * 拓展字段，非必传
+     */
+    property?: Record<string, any>;
 }
 export interface IBindRuleResponse {
     /**
@@ -931,11 +1202,41 @@ export interface IGetBindRuleList {
     gid: string;
 }
 export type IGetBindRuleListResponse = Array<{
+    /**
+     * 与面板/设备建立绑定关系,通常为设备ID、DP点、群组、规则，dpId#value等
+     */
     associativeEntityId: AssociativeEntityId;
-    associativeEntityValueList: AssociativeEntityValue[];
+    /**
+     * 关联实体的值列表
+     */
+    associativeEntityValueList: IGetSceneListResponseV2;
+    /**
+     * 绑定 id，一般用来解绑
+     */
+    bindId: number;
+    /**
+     * 业务域
+     */
     bizDomain: string;
+    /**
+     * 是否启用
+     */
+    enable: boolean;
+    /**
+     * 设备 ID
+     */
     sourceEntityId: string;
 }>;
+export interface IUnbindRule {
+    /**
+     * 解绑 id
+     */
+    bindId: string;
+    /**
+     * 家庭 id
+     */
+    gid: string;
+}
 export interface IRemoveRule {
     bizDomain: string;
     sourceEntityId?: string;

package/lib/cloud/interface.js

@@ -11,6 +11,9 @@
 // 数据统计接口
 // 告警相关接口
 // 联动相关
+/**
+ * 一键执行类型的联动规则数据
+ */
 var EntityType = /*#__PURE__*/function (EntityType) {
   EntityType[EntityType["DEVICE"] = 1] = "DEVICE";
   EntityType[EntityType["RULE"] = 2] = "RULE";

package/lib/cloud/linkage.d.ts

@@ -1,4 +1,4 @@
-import { IGetLinkageDeviceList, IBindRule, IGetBindRuleList, IRemoveRule, IGetLinkageDeviceListResponse, IGetSceneListResponse, IGetBindRuleListResponse, IBindRuleResponse } from './interface';
+import { IGetLinkageDeviceList, IBindRule, IGetBindRuleList, IRemoveRule, IGetLinkageDeviceListResponse, IGetSceneListResponse, IGetBindRuleListResponse, IBindRuleResponse, IUnbindRule, IGetSceneListResponseV2 } from './interface';
 /**
  * 获取家庭下支持联动的设备列表
  * @param {number} gid 家庭id
@@ -6,7 +6,7 @@ import { IGetLinkageDeviceList, IBindRule, IGetBindRuleList, IRemoveRule, IGetLi
  */
 declare const getLinkageDeviceList: (params: IGetLinkageDeviceList) => Promise<IGetLinkageDeviceListResponse>;
 /**
- * 查询家庭下一键执行场景列表
+ * 查询家庭下联动规则列表，包含失效及自动化规则
  * @param {number} devId 设备id
  * @param {number} gid 家庭Id
  */
@@ -14,6 +14,17 @@ declare const getSceneList: ({ devId, gid, }: {
     devId: string;
     gid: string;
 }) => Promise<IGetSceneListResponse>;
+/**
+ * 查询家庭下一键执行列表，会去掉失效或自动化规则
+ * @param {number} devId 设备id
+ * @param {boolean} containStandardZigBee 是否包含标准场景，默认不包含
+ * @param {number} gid 家庭Id
+ */
+declare const getSceneListV2: ({ devId, gid, containStandardZigBee, }: {
+    devId: string;
+    gid: string;
+    containStandardZigBee?: boolean;
+}) => Promise<IGetSceneListResponseV2>;
 /**
  * 查询家庭下已绑定的列表
  * @param {string} bizDomain 业务范围
@@ -32,6 +43,12 @@ declare const getBindRuleList: (params: IGetBindRuleList) => Promise<IGetBindRul
  * @param {string} bizDomain 业务域
  */
 declare const bindRule: (params: IBindRule) => Promise<IBindRuleResponse>;
+/**
+ * 解绑联动
+ * @param {string} bindId 绑定 id
+ * @param {string} gid 家庭id
+ */
+declare const unbindRule: (params: IUnbindRule) => Promise<boolean>;
 /**
  * 解除联动
  * @param {string} bizDomain 业务范围
@@ -62,4 +79,4 @@ declare const enableRule: ({ ruleId }: {
 declare const disableRule: ({ ruleId }: {
     ruleId: string;
 }) => Promise<boolean>;
-export { getLinkageDeviceList, getSceneList, getBindRuleList, bindRule, removeRule, triggerRule, enableRule, disableRule, };
+export { getLinkageDeviceList, getSceneList, getSceneListV2, getBindRuleList, bindRule, unbindRule, removeRule, triggerRule, enableRule, disableRule, };

package/lib/cloud/linkage.js

@@ -21,7 +21,7 @@ const getLinkageDeviceList = params => {
 };
 
 /**
- * 查询家庭下一键执行场景列表
+ * 查询家庭下联动规则列表，包含失效及自动化规则
  * @param {number} devId 设备id
  * @param {number} gid 家庭Id
  */
@@ -42,6 +42,31 @@ const getSceneList = _ref => {
   });
 };
 
+/**
+ * 查询家庭下一键执行列表，会去掉失效或自动化规则
+ * @param {number} devId 设备id
+ * @param {boolean} containStandardZigBee 是否包含标准场景，默认不包含
+ * @param {number} gid 家庭Id
+ */
+const getSceneListV2 = _ref2 => {
+  let {
+    devId,
+    gid,
+    containStandardZigBee = false
+  } = _ref2;
+  return requestCloud({
+    api: "".concat(THING, ".m.linkage.rule.brief.query"),
+    version: '2.0',
+    data: {
+      devId,
+      containStandardZigBee
+    },
+    extData: {
+      gid: "".concat(gid)
+    }
+  });
+};
+
 /**
  * 查询家庭下已绑定的列表
  * @param {string} bizDomain 业务范围
@@ -86,7 +111,8 @@ const bindRule = params => {
     entitySubIds,
     expr,
     bizDomain,
-    gid
+    gid,
+    property
   } = params;
   return requestCloud({
     api: "".concat(THING, ".m.linkage.associative.entity.bind"),
@@ -110,6 +136,8 @@ const bindRule = params => {
             actionExecutor: 'ruleTrigger'
           }]
         },
+        ruleIds: [ruleId],
+        property,
         bizDomain,
         uniqueType: 3
       }
@@ -120,6 +148,24 @@ const bindRule = params => {
   });
 };
 
+/**
+ * 解绑联动
+ * @param {string} bindId 绑定 id
+ * @param {string} gid 家庭id
+ */
+const unbindRule = params => {
+  return requestCloud({
+    api: "".concat(THING, ".m.linkage.bind.delete"),
+    version: '1.0',
+    data: {
+      bindId: params.bindId
+    },
+    extData: {
+      gid: "".concat(params.gid)
+    }
+  });
+};
+
 /**
  * 解除联动
  * @param {string} bizDomain 业务范围
@@ -151,10 +197,10 @@ const removeRule = params => {
  * 触发联动
  * @param {string} ruleId 规则id
  */
-const triggerRule = _ref2 => {
+const triggerRule = _ref3 => {
   let {
     ruleId
-  } = _ref2;
+  } = _ref3;
   return requestCloud({
     api: "".concat(THING, ".m.linkage.rule.trigger"),
     version: '1.0',
@@ -168,10 +214,10 @@ const triggerRule = _ref2 => {
  *  启用联动
  * @param {string} ruleId 规则id
  */
-const enableRule = _ref3 => {
+const enableRule = _ref4 => {
   let {
     ruleId
-  } = _ref3;
+  } = _ref4;
   return requestCloud({
     api: "".concat(THING, ".m.linkage.rule.enable"),
     version: '1.0',
@@ -185,10 +231,10 @@ const enableRule = _ref3 => {
  * 停用联动
  * @param {string} ruleId 规则id
  */
-const disableRule = _ref4 => {
+const disableRule = _ref5 => {
   let {
     ruleId
-  } = _ref4;
+  } = _ref5;
   return requestCloud({
     api: "".concat(THING, ".m.linkage.rule.disable"),
     version: '1.0',
@@ -197,4 +243,4 @@ const disableRule = _ref4 => {
     }
   });
 };
-export { getLinkageDeviceList, getSceneList, getBindRuleList, bindRule, removeRule, triggerRule, enableRule, disableRule };
+export { getLinkageDeviceList, getSceneList, getSceneListV2, getBindRuleList, bindRule, unbindRule, removeRule, triggerRule, enableRule, disableRule };

package/lib/nativeRouters/common.d.ts

@@ -1,15 +1,17 @@
+export type ErrorMsg = {
+    errorMsg: string;
+    errorCode: string | number;
+    innerError: {
+        errorCode: string | number;
+        errorMsg: string;
+    };
+};
 export type ICommon = {
     success?: () => void;
-    fail?: (err?: {
-        errorMsg: string;
-        errorCode: string | number;
-        innerError: {
-            errorCode: string | number;
-            errorMsg: string;
-        };
-    }) => void;
+    fail?: (err?: ErrorMsg) => void;
     complete?: () => void;
-} & {
+};
+export type RecordRest = {
     [key: string]: string | boolean | number;
 };
 export declare function nativeRouter<T extends ICommon>(uri: string, params?: T): Promise<void>;

package/lib/nativeRouters//347/231/275/345/220/215/345/215/225.md

@@ -0,0 +1,64 @@
+```
+createScene
+tysh_family_add_member_rn
+presentGatewayCategroy
+device_detail
+helpAndFeedBack
+sceneUiUpdate
+createAuto
+member_info
+more_service
+createScene_allDevices
+editScene
+ty_home_security_page
+createAutoWithCondition
+config_device
+device_only_search_config_gw_sub
+grid_update_firmware
+dev_network_check
+helpCenter
+camera_base_setting
+device_gw_sub_device_help_list
+zigbee_pair
+devManualAndSmart
+device_offline_reconnect
+ihcImportDevice
+complete_user_information
+ty_user_setting
+addRelationDeviceWithoutMesh
+editLocalSceneWithoutMesh
+philipsImportDevice
+msg_media_play
+gotoGeekLock
+devMultiLink
+scene/createScene
+camera_video_view
+config_device_home
+messageCenter
+smartScene
+jumpHome
+tysh_family_setting
+camera_motion_monitor
+tutorial_tips
+sleep_stages_guide
+editZigbeeGroupScene
+ty_scene_device_related_scenes
+range-finder-canvas
+settingVoiceServiceConfigListRouter
+createAutoWithCondition
+scan
+upgrade_detail
+tsod_cycling_navigation
+tsod_additional_unlock_methods
+tsod_ambient_lighting
+tsod_shortcut_siri
+config_device_home
+thing_add_scene
+// 6.13新增
+createSmartScene
+addScene
+camera_playback_panel
+ipc_album_panel
+camera_cloud_panel
+modeSetting
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ray-js/api",
-  "version": "1.5.13",
+  "version": "1.5.15",
   "description": "Ray universal api",
   "keywords": [
     "ray"
@@ -29,14 +29,14 @@
     "watch": "ray start --type=component"
   },
   "dependencies": {
-    "@ray-js/framework": "1.5.13",
-    "@ray-js/router": "1.5.13",
+    "@ray-js/framework": "1.5.15",
+    "@ray-js/router": "1.5.15",
     "@ray-js/wechat": "^0.2.9",
     "base64-browser": "^1.0.1",
     "query-string": "^7.1.3"
   },
   "devDependencies": {
-    "@ray-js/cli": "1.5.13",
+    "@ray-js/cli": "1.5.15",
     "art-template": "^4.13.2",
     "fs-extra": "^10.1.0",
     "miniprogram-api-typings": "^3.12.2",
@@ -46,5 +46,5 @@
     "access": "public",
     "registry": "https://registry.npmjs.org"
   },
-  "gitHead": "632d2d9fa789c75828089087b4ba734e6daa3b34"
+  "gitHead": "c6ad2520befad858e6a353cdedfe1d99f4f1ffb1"
 }