model-action 1.0.6 → 1.0.8

package/dist/modules/Action.d.ts

@@ -3,55 +3,14 @@ export interface SendParam {
     cmd: string;
     action: string;
 }
-export interface IdItem {
+interface IdItem {
     id: string;
 }
 export type IdList = IdItem[];
-export type PathList = Array<{
-    location: string;
-}>;
-export type PoiAction = 'show' | 'hide' | 'add' | 'delete' | 'update' | 'getInfo';
 export type LocationItem = `X=${number},Y=${number},Z=${number}`;
-export type PoiType = {
-    action: PoiAction;
-    id?: string;
-    type?: string;
-    typeChild?: string;
-    text?: string;
-    location?: LocationItem;
-    place?: string;
-    description?: string;
-    linkId?: string;
-    floorNum?: string;
-    lowestFloor?: string;
-} & SendParam;
 export type LocationList = Array<{
     location: LocationItem;
 }>;
-export type TrackAction = 'getRoadNet' | 'remove' | 'add';
-export type TrackType = {
-    action: TrackAction;
-    pathId?: string;
-    rnId?: string;
-    roadNet?: string;
-    type?: string;
-    data?: LocationList | IdList;
-} & SendParam;
-export type VideoFusionAction = 'init' | 'flyTo' | 'start' | 'stop' | 'pause' | 'resume' | 'refresh';
-export type VideoFusionType = {
-    action: VideoFusionAction;
-    token?: string;
-    ip?: string;
-    port?: string;
-    isHttps?: boolean;
-    id?: string;
-    fov?: number;
-    backPlay?: boolean;
-    ids?: IdList;
-    isLocation?: boolean;
-    videoType?: 'Video' | 'Record';
-    recordType?: 'Cloud' | 'Device';
-} & SendParam;
 export declare class Action {
     /**
     * 视角初始化
@@ -64,3 +23,4 @@ export declare class Action {
      */
     static sendParam<T extends SendParam>(param: T, msg?: string): void;
 }
+export {};

package/dist/modules/Poi.d.ts

@@ -1,26 +1,55 @@
 /**
  * POI点方法
  */
-import { Action, PoiType, RequiredSome } from "./Action";
+import { Action, LocationItem, SendParam } from "./Action";
+type PoiActionType = 'show' | 'hide' | 'add' | 'delete' | 'update' | 'getInfo';
+type PoiType = {
+    action: PoiActionType;
+    id?: string;
+    type?: string;
+    typeChild?: string;
+    text?: string;
+    location?: LocationItem;
+    place?: string;
+    description?: string;
+    linkId?: string;
+    floorNum?: string;
+    lowestFloor?: string;
+} & SendParam;
 export declare class PoiAction extends Action {
     /**
       * 添加poi
+      * @param {*} type 相机type
+      * @param {*} location poi点位置
+      * @param {*} text POI标题
+      * @param {*} place POI所在位置
+      * @param {*} description POI描述
+      * @param {*} linkId POI关联的设备ID
       */
-    static poiAdd({ type, location, text, place, description, linkId }: RequiredSome<PoiType, 'action' | 'type' | 'location'>): void;
+    static poiAdd(type: PoiType['type'], location: LocationItem, text?: PoiType['text'], place?: PoiType['place'], description?: PoiType['description'], linkId?: PoiType['linkId']): void;
     /**
     * 删除poi
+    * @param {*} id 点ID
     */
-    static poiDel({ id }: PoiType): void;
+    static poiDel(id: string): void;
     /**
      * 显示poi
+     * @param {*} id POI的ID
+     * @param {*} type 相机type
+     * @param {*} place POI所在位置
      */
-    static poiShow({ id, type, place }: PoiType): void;
+    static poiShow(id: PoiType['id'], type: PoiType['type'], place: PoiType['place']): void;
     /**
     * 隐藏poi
+    * @param {*} id POI的ID
+    * @param {*} type 相机type
+    * @param {*} place POI所在位置
     */
-    static poiHide({ id, type, place }: PoiType): void;
+    static poiHide(id: PoiType['id'], type: PoiType['type'], place: PoiType['place']): void;
     /**
      * 获取指定POI
+     * @param {*} type 相机type
      */
-    static poiGetInfo({ type }: PoiType): void;
+    static poiGetInfo(type?: PoiType['type']): void;
 }
+export {};

package/dist/modules/Poi.js

@@ -5,8 +5,14 @@ import { Action } from "./Action";
 export class PoiAction extends Action {
     /**
       * 添加poi
+      * @param {*} type 相机type
+      * @param {*} location poi点位置
+      * @param {*} text POI标题
+      * @param {*} place POI所在位置
+      * @param {*} description POI描述
+      * @param {*} linkId POI关联的设备ID
       */
-    static poiAdd({ type = 'Camera', location, text = '', place = '', description = '', linkId = '' }) {
+    static poiAdd(type = 'Camera', location, text = '', place = '', description = '', linkId = '') {
         const param = {
             cmd: "POI",
             action: "add",
@@ -21,8 +27,9 @@ export class PoiAction extends Action {
     }
     /**
     * 删除poi
+    * @param {*} id 点ID
     */
-    static poiDel({ id }) {
+    static poiDel(id) {
         const param = {
             cmd: "POI",
             action: "delete",
@@ -32,8 +39,11 @@ export class PoiAction extends Action {
     }
     /**
      * 显示poi
+     * @param {*} id POI的ID
+     * @param {*} type 相机type
+     * @param {*} place POI所在位置
      */
-    static poiShow({ id, type = "Camera", place }) {
+    static poiShow(id, type = "Camera", place) {
         const param = {
             cmd: "POI",
             action: "show",
@@ -47,8 +57,11 @@ export class PoiAction extends Action {
     }
     /**
     * 隐藏poi
+    * @param {*} id POI的ID
+    * @param {*} type 相机type
+    * @param {*} place POI所在位置
     */
-    static poiHide({ id, type = "Camera", place }) {
+    static poiHide(id, type = "Camera", place) {
         const param = {
             cmd: "POI",
             action: "hide",
@@ -62,8 +75,9 @@ export class PoiAction extends Action {
     }
     /**
      * 获取指定POI
+     * @param {*} type 相机type
      */
-    static poiGetInfo({ type = 'Camera' }) {
+    static poiGetInfo(type = 'Camera') {
         const param = {
             cmd: "POI",
             action: "getInfo",

package/dist/modules/Track.d.ts

@@ -1,18 +1,33 @@
 /**
  * 轨迹方法
  */
-import { Action, TrackType } from "./Action";
+import { Action, IdList, LocationList, SendParam } from "./Action";
+type TrackActionType = 'getRoadNet' | 'remove' | 'add';
+type TrackType = {
+    action: TrackActionType;
+    pathId?: string;
+    rnId?: string;
+    roadNet?: string;
+    type?: string;
+    data?: LocationList | IdList;
+} & SendParam;
 export declare class TrackAction extends Action {
     /**
      * 清除轨迹
+     * @param {*} pathId 自定义轨迹ID
      */
-    static trackRemove({ pathId }: TrackType): void;
+    static trackRemove(pathId?: TrackType['pathId']): void;
     /**
      * 获取三维路网坐标
+     * @param {*} data
+     * @param {*} rnId 路网ID
      */
-    static trackGetRoadNet({ data, rnId }: TrackType): void;
+    static trackGetRoadNet(data: TrackType['data'], rnId?: TrackType['rnId']): void;
     /**
      * 请求三维绘制路网
+     * @param {*} data
+     * @param {*} pathId 自定义轨迹ID
      */
-    static trackPath({ data, pathId }: TrackType): void;
+    static trackPath(data: TrackType['data'], pathId?: TrackType['pathId']): void;
 }
+export {};

package/dist/modules/Track.js

@@ -5,8 +5,9 @@ import { Action } from "./Action";
 export class TrackAction extends Action {
     /**
      * 清除轨迹
+     * @param {*} pathId 自定义轨迹ID
      */
-    static trackRemove({ pathId = "CameraTrack" }) {
+    static trackRemove(pathId = "CameraTrack") {
         const param = {
             cmd: "path",
             action: "remove",
@@ -16,8 +17,10 @@ export class TrackAction extends Action {
     }
     /**
      * 获取三维路网坐标
+     * @param {*} data
+     * @param {*} rnId 路网ID
      */
-    static trackGetRoadNet({ data, rnId = 'RN-1' }) {
+    static trackGetRoadNet(data, rnId = 'RN-1') {
         const param = {
             cmd: "path",
             action: "getRoadNet",
@@ -28,8 +31,10 @@ export class TrackAction extends Action {
     }
     /**
      * 请求三维绘制路网
+     * @param {*} data
+     * @param {*} pathId 自定义轨迹ID
      */
-    static trackPath({ data, pathId = "CameraTrack" }) {
+    static trackPath(data, pathId = "CameraTrack") {
         const param = {
             cmd: "path",
             action: "add",

package/dist/modules/VideoFusion.d.ts

@@ -1,26 +1,52 @@
 /**
  * 视频融合方法
  */
-import { Action, VideoFusionType } from "./Action";
+import { Action, IdList, SendParam } from "./Action";
+type VideoFusionActionType = 'init' | 'flyTo' | 'start' | 'stop' | 'pause' | 'resume' | 'refresh';
+type VideoFusionType = {
+    action: VideoFusionActionType;
+    token?: string;
+    ip?: string;
+    port?: string;
+    isHttps?: boolean;
+    id?: string;
+    fov?: number;
+    backPlay?: boolean;
+    ids?: IdList;
+    isLocation?: boolean;
+    videoType?: 'Video' | 'Record';
+    recordType?: 'Cloud' | 'Device';
+} & SendParam;
 export declare class VideoFusionAction extends Action {
     /**
      * 视频融合初始化
+     * @param {*} token TOKEN
+     * @param {*} ip IP
+     * @param {*} port 端口
+     * @param {*} token TOKEN
+     * @param {*} isHttps 是否https
      */
-    static videoFusionInit({ token, ip, port, isHttps }: VideoFusionType): void;
+    static videoFusionInit(token: VideoFusionType['token'], ip: VideoFusionType['ip'], port?: VideoFusionType['port'], isHttps?: VideoFusionType['isHttps']): void;
     /**
      * 飞行到视频融合点位
+     * @param {*} id 点ID
+     * @param {*} fov 视场角
      */
-    static videoFusionFlyTo({ id, fov }: VideoFusionType): void;
+    static videoFusionFlyTo(id: VideoFusionType['id'], fov: VideoFusionType['fov']): void;
     /**
      * 开启视频融合
+     * @param {*} ids id列表
      */
-    static videoFusionStart({ ids }: VideoFusionType): void;
+    static videoFusionStart(ids: VideoFusionType['ids']): void;
     /**
      * 关闭视频融合
+     * @param {*} ids id列表
      */
-    static videoFusionStop({ ids }: VideoFusionType): void;
+    static videoFusionStop(ids: VideoFusionType['ids']): void;
     /**
      * 刷新视频融合
+     * @param {*} token TOKEN
      */
-    static videoFusionRefresh({ token }: VideoFusionType): void;
+    static videoFusionRefresh(token: VideoFusionType['token']): void;
 }
+export {};

package/dist/modules/VideoFusion.js

@@ -5,8 +5,13 @@ import { Action } from "./Action";
 export class VideoFusionAction extends Action {
     /**
      * 视频融合初始化
+     * @param {*} token TOKEN
+     * @param {*} ip IP
+     * @param {*} port 端口
+     * @param {*} token TOKEN
+     * @param {*} isHttps 是否https
      */
-    static videoFusionInit({ token, ip, port = '1998', isHttps = false }) {
+    static videoFusionInit(token, ip, port = '1998', isHttps = false) {
         const param = {
             cmd: "videoFusion",
             action: "init",
@@ -19,8 +24,10 @@ export class VideoFusionAction extends Action {
     }
     /**
      * 飞行到视频融合点位
+     * @param {*} id 点ID
+     * @param {*} fov 视场角
      */
-    static videoFusionFlyTo({ id, fov }) {
+    static videoFusionFlyTo(id, fov) {
         const param = {
             cmd: "videoFusion",
             action: "flyTo",
@@ -31,8 +38,9 @@ export class VideoFusionAction extends Action {
     }
     /**
      * 开启视频融合
+     * @param {*} ids id列表
      */
-    static videoFusionStart({ ids }) {
+    static videoFusionStart(ids) {
         const param = {
             cmd: "videoFusion",
             action: "start",
@@ -45,8 +53,9 @@ export class VideoFusionAction extends Action {
     }
     /**
      * 关闭视频融合
+     * @param {*} ids id列表
      */
-    static videoFusionStop({ ids }) {
+    static videoFusionStop(ids) {
         const param = {
             cmd: "videoFusion",
             action: "stop",
@@ -59,8 +68,9 @@ export class VideoFusionAction extends Action {
     }
     /**
      * 刷新视频融合
+     * @param {*} token TOKEN
      */
-    static videoFusionRefresh({ token }) {
+    static videoFusionRefresh(token) {
         const param = {
             cmd: "videoFusion",
             action: "refresh",

package/package.json

@@ -1,18 +1,23 @@
 {
   "name": "model-action",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "与三维交互api",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "build":"tsc",
+    "dev": "tsc --watch",
+    "build": "tsc",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "files": ["dist","src"],
+  "files": [
+    "dist",
+    "src",
+    "index.d.js"
+  ],
   "author": "andm31",
   "license": "ISC",
   "devDependencies": {
     "typescript": "^5.8.3"
   },
   "type": "module"
-}
+}

package/src/index.ts

@@ -1,4 +1,4 @@
 export { Action } from './modules/Action'
 export { VideoFusionAction } from "./modules/VideoFusion";
 export { PoiAction } from './modules/Poi'
-export { TrackAction } from './modules/Track'
+export { TrackAction } from './modules/Track'

package/src/modules/Action.ts

@@ -5,66 +5,18 @@ export interface SendParam {
     action: string,
 }
 
-export interface IdItem {
+
+interface IdItem {
     id: string;
 }
 
 export type IdList = IdItem[];
 
-
-export type PathList = Array<{
-    location: string
-}>
-
-
-export type PoiAction = 'show' | 'hide' | 'add' | 'delete' | 'update' | 'getInfo'
 export type LocationItem = `X=${number},Y=${number},Z=${number}`
-export type PoiType = {
-    action: PoiAction,          //方法
-    id?: string,                //POI点UE中的ID
-    type?: string,              //POI类型
-    typeChild?: string,         //POI子类型
-    text?: string,              //POI标题
-    location?: LocationItem,        //POI在场景中的坐标格式
-    place?: string,              //POI所在位置
-    description?: string,        //POI描述
-    linkId?: string,             //POI关联设备ID
-    floorNum?: string,           //总楼层
-    lowestFloor?: string         //最低楼层
-} & SendParam
-
-
 
 export type LocationList = Array<{
     location: LocationItem
 }>
-export type TrackAction = 'getRoadNet' | 'remove' | 'add'
-export type TrackType = {
-    action: TrackAction,
-    pathId?: string,         //自定义轨迹ID
-    rnId?: string,           //路网ID
-    roadNet?: string,        //路网信息
-    type?: string,
-    data?: LocationList | IdList
-} & SendParam
-
-
-export type VideoFusionAction = 'init' | 'flyTo' | 'start' | 'stop' | 'pause' | 'resume' | 'refresh'
-export type VideoFusionType = {
-    action: VideoFusionAction,
-    token?: string,
-    ip?: string,
-    port?: string,
-    isHttps?: boolean,
-    id?: string,
-    fov?: number,        //视场角
-    backPlay?:boolean,
-    ids?: IdList,
-    isLocation?: boolean,    //是否定位到第一个点，true=定位到第一个，false=不定位
-    videoType?: 'Video' | 'Record',  //Video:实时流，Record：录像，默认实时流 Video
-    recordType?: 'Cloud' | 'Device',//     Cloud:中心录像，Device：设备录像，默认中心录像 Cloud，videoType为 Record 时有效
-
-} & SendParam
 
 export class Action {
     /**

package/src/modules/Poi.ts

@@ -1,13 +1,35 @@
+
 /**
  * POI点方法
  */
-import { Action, PoiType, RequiredSome } from "./Action";
+import { Action, LocationItem, RequiredSome, SendParam } from "./Action";
+
+type PoiActionType = 'show' | 'hide' | 'add' | 'delete' | 'update' | 'getInfo'
+type PoiType = {
+    action: PoiActionType,          //方法
+    id?: string,                //POI点UE中的ID
+    type?: string,              //POI类型
+    typeChild?: string,         //POI子类型
+    text?: string,              //POI标题
+    location?: LocationItem,        //POI在场景中的坐标格式
+    place?: string,              //POI所在位置
+    description?: string,        //POI描述
+    linkId?: string,             //POI关联设备ID
+    floorNum?: string,           //总楼层
+    lowestFloor?: string         //最低楼层
+} & SendParam
 
 export class PoiAction extends Action {
     /**
       * 添加poi
+      * @param {*} type 相机type
+      * @param {*} location poi点位置
+      * @param {*} text POI标题
+      * @param {*} place POI所在位置
+      * @param {*} description POI描述
+      * @param {*} linkId POI关联的设备ID
       */
-    static poiAdd({ type = 'Camera', location, text = '', place = '', description = '', linkId = '' }: RequiredSome<PoiType, 'action' | 'type' | 'location'>) {
+    static poiAdd(type: PoiType['type'] = 'Camera', location: LocationItem, text: PoiType['text'] = '', place: PoiType['place'] = '', description: PoiType['description'] = '', linkId: PoiType['linkId'] = '') {
         const param: RequiredSome<PoiType, 'action' | 'type' | 'location'> = {
             cmd: "POI",
             action: "add",
@@ -23,8 +45,9 @@ export class PoiAction extends Action {
 
     /**
     * 删除poi
+    * @param {*} id 点ID
     */
-    static poiDel({ id }: PoiType) {
+    static poiDel(id: string) {
         const param: PoiType = {
             cmd: "POI",
             action: "delete",
@@ -35,8 +58,11 @@ export class PoiAction extends Action {
 
     /**
      * 显示poi
+     * @param {*} id POI的ID
+     * @param {*} type 相机type
+     * @param {*} place POI所在位置
      */
-    static poiShow({ id, type = "Camera", place }: PoiType) {
+    static poiShow(id: PoiType['id'], type: PoiType['type'] = "Camera", place: PoiType['place']) {
         const param: PoiType = {
             cmd: "POI",
             action: "show",
@@ -52,8 +78,11 @@ export class PoiAction extends Action {
 
     /**
     * 隐藏poi
+    * @param {*} id POI的ID
+    * @param {*} type 相机type
+    * @param {*} place POI所在位置
     */
-    static poiHide({ id, type = "Camera", place }: PoiType) {
+    static poiHide(id: PoiType['id'], type: PoiType['type'] = "Camera", place: PoiType['place']) {
         const param: PoiType = {
             cmd: "POI",
             action: "hide",
@@ -69,8 +98,9 @@ export class PoiAction extends Action {
 
     /**
      * 获取指定POI
+     * @param {*} type 相机type
      */
-    static poiGetInfo({type='Camera'}:PoiType) {
+    static poiGetInfo(type: PoiType['type'] = 'Camera') {
         const param: PoiType = {
             cmd: "POI",
             action: "getInfo",

package/src/modules/Track.ts

@@ -1,13 +1,28 @@
+
+
+
 /**
  * 轨迹方法
  */
-import { Action, TrackType } from "./Action";
+import { Action, IdList, LocationList, SendParam } from "./Action";
+
+
+type TrackActionType = 'getRoadNet' | 'remove' | 'add'
+type TrackType = {
+    action: TrackActionType,
+    pathId?: string,         //自定义轨迹ID
+    rnId?: string,           //路网ID
+    roadNet?: string,        //路网信息
+    type?: string,
+    data?: LocationList | IdList
+} & SendParam
 
 export class TrackAction extends Action {
     /**
      * 清除轨迹
+     * @param {*} pathId 自定义轨迹ID
      */
-    static trackRemove({ pathId = "CameraTrack" }: TrackType) {
+    static trackRemove(pathId: TrackType['pathId'] = "CameraTrack") {
         const param: TrackType = {
             cmd: "path",
             action: "remove",
@@ -18,8 +33,10 @@ export class TrackAction extends Action {
 
     /**
      * 获取三维路网坐标
+     * @param {*} data
+     * @param {*} rnId 路网ID
      */
-    static trackGetRoadNet({ data, rnId = 'RN-1' }: TrackType) {
+    static trackGetRoadNet(data: TrackType['data'], rnId: TrackType['rnId'] = 'RN-1') {
         const param: TrackType = {
             cmd: "path",
             action: "getRoadNet",
@@ -31,8 +48,10 @@ export class TrackAction extends Action {
 
     /**
      * 请求三维绘制路网
+     * @param {*} data
+     * @param {*} pathId 自定义轨迹ID
      */
-    static trackPath({ data, pathId = "CameraTrack" }: TrackType) {
+    static trackPath(data: TrackType['data'], pathId: TrackType['pathId'] = "CameraTrack") {
         const param: TrackType = {
             cmd: "path",
             action: "add",

package/src/modules/VideoFusion.ts

@@ -1,13 +1,37 @@
+
+
 /**
  * 视频融合方法
  */
-import { Action, VideoFusionType } from "./Action";
+import { Action, IdList, LocationList, SendParam } from "./Action";
+
+type VideoFusionActionType = 'init' | 'flyTo' | 'start' | 'stop' | 'pause' | 'resume' | 'refresh'
+type VideoFusionType = {
+    action: VideoFusionActionType,
+    token?: string,
+    ip?: string,
+    port?: string,
+    isHttps?: boolean,
+    id?: string,
+    fov?: number,        //视场角
+    backPlay?: boolean,
+    ids?: IdList,
+    isLocation?: boolean,    //是否定位到第一个点，true=定位到第一个，false=不定位
+    videoType?: 'Video' | 'Record',  //Video:实时流，Record：录像，默认实时流 Video
+    recordType?: 'Cloud' | 'Device',//     Cloud:中心录像，Device：设备录像，默认中心录像 Cloud，videoType为 Record 时有效
+} & SendParam
+
 
 export class VideoFusionAction extends Action {
     /**
      * 视频融合初始化
+     * @param {*} token TOKEN
+     * @param {*} ip IP
+     * @param {*} port 端口
+     * @param {*} token TOKEN
+     * @param {*} isHttps 是否https
      */
-    static videoFusionInit({ token, ip, port = '1998', isHttps = false }: VideoFusionType) {
+    static videoFusionInit(token: VideoFusionType['token'], ip: VideoFusionType['ip'], port: VideoFusionType['port'] = '1998', isHttps: VideoFusionType['isHttps'] = false) {
         const param: VideoFusionType = {
             cmd: "videoFusion",
             action: "init",
@@ -21,8 +45,10 @@ export class VideoFusionAction extends Action {
 
     /**
      * 飞行到视频融合点位
+     * @param {*} id 点ID
+     * @param {*} fov 视场角
      */
-    static videoFusionFlyTo({id, fov}:VideoFusionType) {
+    static videoFusionFlyTo(id: VideoFusionType['id'], fov: VideoFusionType['fov']) {
         const param: VideoFusionType = {
             cmd: "videoFusion",
             action: "flyTo",
@@ -34,8 +60,9 @@ export class VideoFusionAction extends Action {
 
     /**
      * 开启视频融合
+     * @param {*} ids id列表
      */
-    static videoFusionStart({ids}:VideoFusionType) {
+    static videoFusionStart(ids: VideoFusionType['ids']) {
         const param: VideoFusionType = {
             cmd: "videoFusion",
             action: "start",
@@ -49,8 +76,9 @@ export class VideoFusionAction extends Action {
 
     /**
      * 关闭视频融合
+     * @param {*} ids id列表
      */
-    static videoFusionStop({ids}:VideoFusionType) {
+    static videoFusionStop(ids: VideoFusionType['ids']) {
         const param: VideoFusionType = {
             cmd: "videoFusion",
             action: "stop",
@@ -64,8 +92,9 @@ export class VideoFusionAction extends Action {
 
     /**
      * 刷新视频融合
+     * @param {*} token TOKEN
      */
-    static videoFusionRefresh({token}:VideoFusionType) {
+    static videoFusionRefresh(token: VideoFusionType['token']) {
         const param: VideoFusionType = {
             cmd: "videoFusion",
             action: "refresh",