model-action 2.0.12 → 2.2.1

package/src/modules/SceneAsset.ts

@@ -0,0 +1,242 @@
+/**
+ * 场景资产操作方法（上图、房间/资产与三维场景绑定等）
+ */
+import { Action, SendParam } from "./Action";
+
+/** 前端发往三维的 action */
+export type SceneAssetActionType =
+    | "mapLocation"
+    | "editSave"
+    | "editCancel"
+    | "disableSceneEdit";
+
+/** 资产大类：房间、POI 等 */
+export type SceneAssetType = "Room" | "POI" | string;
+
+/** 地图定位 — 房间在单层下的条目 */
+export interface RoomMapLocationParam {
+    /** 房间等业务唯一标识，必须 */
+    id: string;
+    /** 三维场景内唯一 id，初始可空，上图后由三维回写 */
+    sceneId?: string;
+    /** 展示名称，必须 */
+    name: string;
+    /** 如 `X=0.0,Y=0.0,Z=0.0`；空或省略则使用楼层分层默认定位 */
+    location?: string;
+    description?: string;
+    /** 是否已上图；也可由后台根据坐标是否为空推断 */
+    alreadyMap?: boolean;
+}
+
+/** POI 打点 — 单条参数（与 Room 的 params 结构不同） */
+export interface PoiMapLocationParam {
+    /** POI 子类型，用于区分展示样式，如 Camera */
+    type: string;
+    /** 非必须；前端有唯一值可传给三维，否则由三维生成并回传 */
+    sceneId?: string;
+    /** 业务关联 ID，必须 */
+    linkId: string;
+    /** 有则建议传入 */
+    name?: string;
+    /** 非必须；不传时三维可取当前鼠标在场景中的坐标 */
+    location?: string;
+}
+
+export type SceneAssetMapLocationPayload =
+    | {
+          action: "mapLocation";
+          type: "Room";
+          buildingId: string;
+          floor: string;
+          params: RoomMapLocationParam[];
+      }
+    | {
+          action: "mapLocation";
+          type: "POI";
+          /** 不传或空：室外打点；传入时三维会与当前分层校验 */
+          buildingId?: string;
+          floor?: string;
+          params: PoiMapLocationParam[];
+      };
+
+export type SceneAssetPayload =
+    | SceneAssetMapLocationPayload
+    | {
+          action: "editSave";
+          type: SceneAssetType;
+          /** 三维返回的 sceneId */
+          id: string;
+      }
+    | {
+          action: "editCancel";
+          type: SceneAssetType;
+          id: string;
+      }
+    | {
+          action: "disableSceneEdit";
+      };
+
+/** 三维推送：编辑模式下选中资产，前端可据此弹出编辑框 */
+export interface SceneAssetOnAssetSelectedData {
+    action: "OnAssetSelected";
+    type: SceneAssetType;
+    /** POI 场景下为前端下发的 linkId */
+    id: string;
+    /** 三维生成的唯一 id，需入库 */
+    sceneId: string;
+    /** POI 所在位置描述，需入库与三维一致 */
+    place?: string;
+    location: string;
+}
+
+/** 三维推送：单个资产修改后的结果 */
+export interface SceneAssetOnEditAssetData {
+    action: "OnEditAsset";
+    type: SceneAssetType;
+    id: string;
+    sceneId: string;
+    location: string;
+}
+
+export type SceneAssetPushData =
+    | SceneAssetOnAssetSelectedData
+    | SceneAssetOnEditAssetData;
+
+/** 三维经 sceneAsset 推送的通用消息壳（无 requestId） */
+export interface SceneAssetPushMessage<
+    T extends SceneAssetPushData = SceneAssetPushData
+> {
+    code: string;
+    message: string;
+    cmd: "sceneAsset";
+    data: T;
+}
+
+type SceneAssetParamType = SendParam & {
+    cmd: "sceneAsset";
+    data: SceneAssetPayload;
+};
+
+function appendPoiBuildingFloor(
+    data: Extract<SceneAssetMapLocationPayload, { type: "POI" }>,
+    buildingId?: string,
+    floor?: string
+) {
+    const b = buildingId?.trim();
+    const f = floor?.trim();
+    if (b) data.buildingId = b;
+    if (f) data.floor = f;
+}
+
+export class SceneAssetAction extends Action {
+    /**
+     * 房间等在指定建筑、楼层上地图定位（上图）
+     * @param buildingId 建筑唯一 ID
+     * @param floor 楼层，如 1F、B1
+     */
+    static mapRoomLocation(
+        buildingId: string,
+        floor: string,
+        params: RoomMapLocationParam[]
+    ) {
+        const data: Extract<SceneAssetMapLocationPayload, { type: "Room" }> = {
+            action: "mapLocation",
+            type: "Room",
+            buildingId,
+            floor,
+            params
+        };
+
+        const sendParam: SceneAssetParamType = {
+            cmd: "sceneAsset",
+            data
+        };
+        return this.sendParam(
+            sendParam,
+            `场景资产房间上图 - buildingId: ${buildingId} floor: ${floor}`
+        );
+    }
+
+    /**
+     * POI 打点上图。不传 `buildingId`、`floor`（或仅空白）视为室外；
+     * 传入时三维会与当前分层匹配，不匹配则打点失败，前端需提示先分层到目标楼层。
+     */
+    static mapPoiLocation(
+        params: PoiMapLocationParam[],
+        buildingId?: string,
+        floor?: string
+    ) {
+        const data: Extract<SceneAssetMapLocationPayload, { type: "POI" }> = {
+            action: "mapLocation",
+            type: "POI",
+            params
+        };
+        appendPoiBuildingFloor(data, buildingId, floor);
+
+        const sendParam: SceneAssetParamType = {
+            cmd: "sceneAsset",
+            data
+        };
+        const scope =
+            buildingId?.trim() && floor?.trim()
+                ? `buildingId: ${buildingId} floor: ${floor}`
+                : "室外";
+        return this.sendParam(sendParam, `场景资产 POI 上图 - ${scope}`);
+    }
+
+    /**
+     * 前端编辑框「保存」后通知三维
+     * @param id 三维返回的 sceneId
+     */
+    static editSave(id: string, type: SceneAssetType = "Room") {
+        const data: Extract<SceneAssetPayload, { action: "editSave" }> = {
+            action: "editSave",
+            type,
+            id
+        };
+
+        const sendParam: SceneAssetParamType = {
+            cmd: "sceneAsset",
+            data
+        };
+        return this.sendParam(
+            sendParam,
+            `场景资产编辑保存 - ${type} sceneId: ${id}`
+        );
+    }
+
+    /**
+     * 前端编辑框「取消」后通知三维
+     * @param id 三维返回的 sceneId
+     */
+    static editCancel(id: string, type: SceneAssetType = "Room") {
+        const data: Extract<SceneAssetPayload, { action: "editCancel" }> = {
+            action: "editCancel",
+            type,
+            id
+        };
+
+        const sendParam: SceneAssetParamType = {
+            cmd: "sceneAsset",
+            data
+        };
+        return this.sendParam(
+            sendParam,
+            `场景资产编辑取消 - ${type} sceneId: ${id}`
+        );
+    }
+
+    /** 退出整个资产管理编辑模块 */
+    static disableSceneEdit() {
+        const data: Extract<SceneAssetPayload, { action: "disableSceneEdit" }> =
+            {
+                action: "disableSceneEdit"
+            };
+
+        const sendParam: SceneAssetParamType = {
+            cmd: "sceneAsset",
+            data
+        };
+        return this.sendParam(sendParam, "退出场景资产编辑模块");
+    }
+}

package/src/modules/SingleMesh.ts

@@ -0,0 +1,89 @@
+/**
+ * 模型单体化：将指定模型转为可操作实例，支持 init / add / remove。
+ * POI 替代方案请走 POI 接口；本接口生成的是场景内模型实例。
+ */
+import { Action, SendParam } from "./Action";
+
+export type SingleMeshOp = "init" | "add" | "remove";
+
+/**
+ * 接口使用场景区分：Normal 通用；JF 等由项目约定。
+ * 无特殊场景可不传，三维按通用处理。
+ */
+export type SingleMeshSceneType = "Normal" | "JF" | string;
+
+/** 设备模型类型，如服务器、交换机，项目约定 */
+export type SingleMeshDeviceModelType = "Service" | "Switch" | string;
+
+/** 设备类别：机柜 | 机柜内设备 等 */
+export type SingleMeshDeviceCategory = "Cabinet" | "CDevice" | string;
+
+export interface SingleMeshDevice {
+    id: string;
+    name: string;
+    type: SingleMeshDeviceModelType;
+    /** 非必须，内置可补全 */
+    category?: SingleMeshDeviceCategory;
+    /** 如机柜内设备填所属机柜 id */
+    parentId?: string;
+    parentCategory?: SingleMeshDeviceCategory;
+    /** 在父设备上的槽口，机柜内设备按项目必传 */
+    socketOnParent?: string;
+}
+
+export interface SingleMeshScene {
+    /** 场景/机房编码，项目约定；不传则当前场景 */
+    sceneCode?: string;
+    sceneName?: string;
+    devices: SingleMeshDevice[];
+}
+
+export type SingleMeshPayload =
+    | {
+          action: "add";
+          scenes: SingleMeshScene[];
+          sceneType?: SingleMeshSceneType;
+      }
+    | {
+          action: "init" | "remove";
+          scenes: SingleMeshScene[];
+      };
+
+type SingleMeshParamType = SendParam & {
+    cmd: "singleMesh";
+    data: SingleMeshPayload;
+};
+
+export class SingleMeshAction extends Action {
+    private static emit(data: SingleMeshPayload, log: string) {
+        return this.sendParam(
+            { cmd: "singleMesh", data } as SingleMeshParamType,
+            log
+        );
+    }
+
+    /** 初始化场景内单体化数据 */
+    static init(scenes: SingleMeshScene[]) {
+        return this.emit({ action: "init", scenes }, "单体化 init");
+    }
+
+    /**
+     * 增加单体化设备/模型
+     * @param sceneType 非必须；机房等特殊场景传如 JF，默认不传为通用 Normal
+     */
+    static add(scenes: SingleMeshScene[], sceneType?: SingleMeshSceneType) {
+        const data: Extract<SingleMeshPayload, { action: "add" }> = {
+            action: "add",
+            scenes
+        };
+        if (sceneType != null && sceneType !== "") {
+            data.sceneType = sceneType;
+        }
+        return this.emit(data, `单体化 add${sceneType ? ` (${sceneType})` : ""}`);
+    }
+
+    /** 移除单体化实例 */
+    static remove(scenes: SingleMeshScene[]) {
+        return this.emit({ action: "remove", scenes }, "单体化 remove");
+    }
+}

package/src/modules/Status.ts

@@ -69,7 +69,7 @@ export class StatusAction extends Action {
         }
 
         // 使用类型断言调用sendParam，因为StatusType不严格符合SendParam（缺少action字段）
-        this.sendParam(param as any, msg);
+        return this.sendParam(param as any, msg);
     }
 
     /**

package/src/modules/VideoFusion.ts

@@ -97,7 +97,7 @@ export class VideoFusionAction extends Action {
             data
         };
 
-        this.sendParam(param, '初始化视频融合');
+        return this.sendParam(param, '初始化视频融合');
     }
 
     /**
@@ -118,7 +118,7 @@ export class VideoFusionAction extends Action {
             data
         };
 
-        this.sendParam(param, '刷新token');
+        return this.sendParam(param, '刷新token');
     }
 
     /**
@@ -166,7 +166,7 @@ export class VideoFusionAction extends Action {
             data
         };
 
-        this.sendParam(param, '播放视频');
+        return this.sendParam(param, '播放视频');
     }
 
     /**
@@ -190,7 +190,7 @@ export class VideoFusionAction extends Action {
             data
         };
 
-        this.sendParam(param, '停止视频');
+        return this.sendParam(param, '停止视频');
     }
 
     /**
@@ -214,7 +214,7 @@ export class VideoFusionAction extends Action {
             data
         };
 
-        this.sendParam(param, '暂停录像播放');
+        return this.sendParam(param, '暂停录像播放');
     }
 
     /**
@@ -238,7 +238,7 @@ export class VideoFusionAction extends Action {
             data
         };
 
-        this.sendParam(param, '恢复录像播放');
+        return this.sendParam(param, '恢复录像播放');
     }
 
     /**
@@ -261,7 +261,7 @@ export class VideoFusionAction extends Action {
             data
         };
 
-        this.sendParam(param, `飞到融合点位 - id: ${options.id}`);
+        return this.sendParam(param, `飞到融合点位 - id: ${options.id}`);
     }
 
     /**
@@ -279,7 +279,7 @@ export class VideoFusionAction extends Action {
             data
         };
 
-        this.sendParam(param, '获取当前所有的融合点位ID');
+        return this.sendParam(param, '获取当前所有的融合点位ID');
     }
 
     /**
@@ -311,6 +311,6 @@ export class VideoFusionAction extends Action {
             data
         };
 
-        this.sendParam(param, '设置隐藏融合视频的阈值');
+        return this.sendParam(param, '设置隐藏融合视频的阈值');
     }
 }

package/src/modules/Window.ts

@@ -0,0 +1,128 @@
+/**
+ * 弹框：三维内置弹框或外部弹框（返回屏幕坐标比例供前端自绘，可随锚点移动）。
+ * 内置样式需按项目单独开发，本包只负责协议与发送。
+ */
+import { Action, SendParam } from "./Action";
+
+/** create / remove / update / move */
+export type WindowCrudAction = "create" | "remove" | "update" | "move";
+
+export type WindowActionType = WindowCrudAction | "getWindowDetails";
+
+/** buildIn：三维内弹框；buildOut：前端弹框（接收屏幕坐标比例） */
+export type WindowPopType = "buildIn" | "buildOut";
+
+/** 弹框详情行：属性 / 事件 / 服务 */
+export type WindowDetailRowType = "attr" | "event" | "service";
+
+/** windowInfo.params 单项 */
+export interface WindowDetailParam {
+    /** 默认 attr；为空时三维会按 attr 处理 */
+    type?: WindowDetailRowType;
+    id?: string;
+    value?: string;
+    name?: string;
+    unit?: string;
+    textColor?: string;
+    textSize?: number;
+    /** 文本是否有背景（协议字段名如此） */
+    hasBlackground?: boolean;
+    alertIs?: boolean;
+    alertTime?: string;
+}
+
+/** 弹框主体配置 */
+export interface WindowInfo {
+    /** 设备所在场景编码，按项目约定，非必须 */
+    sceneCode?: string;
+    /** 弹框唯一 id，不传由三维生成 */
+    id?: string;
+    /** 绑定的三维资产模型 id */
+    linkAssetId?: string;
+    /** 标题 */
+    name?: string;
+    /** 设备/弹框类型 */
+    type?: string;
+    /** 世界坐标；不传则可用 linkAssetId 对应资产坐标 */
+    position?: string;
+    /** 相对锚点偏移，用于微调 */
+    localPosition?: string;
+    /** 详情内容；列表时每项一行 */
+    params?: WindowDetailParam[];
+}
+
+export type WindowPayload =
+    | {
+          action: WindowCrudAction;
+          popType: WindowPopType;
+          windowInfo: WindowInfo;
+      }
+    | {
+          action: "getWindowDetails";
+          /** 如机柜、机柜设备 */
+          type: string;
+          id: string;
+          /** 注意：与 windowInfo.sceneCode 不同，此处协议字段名为 senceCode */
+          senceCode: string;
+      };
+
+type WindowParamType = SendParam & {
+    cmd: "window";
+    data: WindowPayload;
+};
+
+export class WindowAction extends Action {
+    private static crud(
+        action: WindowCrudAction,
+        popType: WindowPopType,
+        windowInfo: WindowInfo,
+        log: string
+    ) {
+        const data: Extract<WindowPayload, { action: WindowCrudAction }> = {
+            action,
+            popType,
+            windowInfo
+        };
+        return this.sendParam(
+            { cmd: "window", data } as WindowParamType,
+            log
+        );
+    }
+
+    static createWindow(popType: WindowPopType, windowInfo: WindowInfo) {
+        return this.crud("create", popType, windowInfo, `弹框创建 - ${popType}`);
+    }
+
+    static removeWindow(popType: WindowPopType, windowInfo: WindowInfo) {
+        return this.crud("remove", popType, windowInfo, `弹框移除 - ${popType}`);
+    }
+
+    static updateWindow(popType: WindowPopType, windowInfo: WindowInfo) {
+        return this.crud("update", popType, windowInfo, `弹框更新 - ${popType}`);
+    }
+
+    static moveWindow(popType: WindowPopType, windowInfo: WindowInfo) {
+        return this.crud("move", popType, windowInfo, `弹框移动 - ${popType}`);
+    }
+
+    /**
+     * 查询弹框详情（按设备类型、设备 id、场景）
+     * @param senceCode 协议字段名与 sceneCode 拼写不一致，与三维约定保持一致
+     */
+    static getWindowDetails(
+        type: string,
+        id: string,
+        senceCode: string
+    ) {
+        const data: Extract<WindowPayload, { action: "getWindowDetails" }> = {
+            action: "getWindowDetails",
+            type,
+            id,
+            senceCode
+        };
+        return this.sendParam(
+            { cmd: "window", data } as WindowParamType,
+            `获取弹框详情 - type: ${type} id: ${id}`
+        );
+    }
+}