model-action 1.0.6 → 1.0.7

package/dist/modules/Poi.js

@@ -1,12 +1,9 @@
-/**
- * POI点方法
- */
 import { Action } from "./Action";
 export class PoiAction extends Action {
     /**
       * 添加poi
       */
-    static poiAdd({ type = 'Camera', location, text = '', place = '', description = '', linkId = '' }) {
+    static poiAdd(type = 'Camera', location, text = '', place = '', description = '', linkId = '') {
         const param = {
             cmd: "POI",
             action: "add",
@@ -22,7 +19,7 @@ export class PoiAction extends Action {
     /**
     * 删除poi
     */
-    static poiDel({ id }) {
+    static poiDel(id) {
         const param = {
             cmd: "POI",
             action: "delete",
@@ -33,7 +30,7 @@ export class PoiAction extends Action {
     /**
      * 显示poi
      */
-    static poiShow({ id, type = "Camera", place }) {
+    static poiShow(id, type = "Camera", place) {
         const param = {
             cmd: "POI",
             action: "show",
@@ -48,7 +45,7 @@ export class PoiAction extends Action {
     /**
     * 隐藏poi
     */
-    static poiHide({ id, type = "Camera", place }) {
+    static poiHide(id, type = "Camera", place) {
         const param = {
             cmd: "POI",
             action: "hide",
@@ -63,7 +60,7 @@ export class PoiAction extends Action {
     /**
      * 获取指定POI
      */
-    static poiGetInfo({ type = 'Camera' }) {
+    static poiGetInfo(type = 'Camera') {
         const param = {
             cmd: "POI",
             action: "getInfo",

package/dist/modules/Track.js

@@ -1,12 +1,9 @@
-/**
- * 轨迹方法
- */
 import { Action } from "./Action";
 export class TrackAction extends Action {
     /**
      * 清除轨迹
      */
-    static trackRemove({ pathId = "CameraTrack" }) {
+    static trackRemove(pathId = "CameraTrack") {
         const param = {
             cmd: "path",
             action: "remove",
@@ -17,7 +14,7 @@ export class TrackAction extends Action {
     /**
      * 获取三维路网坐标
      */
-    static trackGetRoadNet({ data, rnId = 'RN-1' }) {
+    static trackGetRoadNet(data, rnId = 'RN-1') {
         const param = {
             cmd: "path",
             action: "getRoadNet",
@@ -29,7 +26,7 @@ export class TrackAction extends Action {
     /**
      * 请求三维绘制路网
      */
-    static trackPath({ data, pathId = "CameraTrack" }) {
+    static trackPath(data, pathId = "CameraTrack") {
         const param = {
             cmd: "path",
             action: "add",

package/dist/modules/VideoFusion.js

@@ -1,12 +1,9 @@
-/**
- * 视频融合方法
- */
 import { Action } from "./Action";
 export class VideoFusionAction extends Action {
     /**
      * 视频融合初始化
      */
-    static videoFusionInit({ token, ip, port = '1998', isHttps = false }) {
+    static videoFusionInit(token, ip, port = '1998', isHttps = false) {
         const param = {
             cmd: "videoFusion",
             action: "init",
@@ -20,7 +17,7 @@ export class VideoFusionAction extends Action {
     /**
      * 飞行到视频融合点位
      */
-    static videoFusionFlyTo({ id, fov }) {
+    static videoFusionFlyTo(id, fov) {
         const param = {
             cmd: "videoFusion",
             action: "flyTo",
@@ -32,7 +29,7 @@ export class VideoFusionAction extends Action {
     /**
      * 开启视频融合
      */
-    static videoFusionStart({ ids }) {
+    static videoFusionStart(ids) {
         const param = {
             cmd: "videoFusion",
             action: "start",
@@ -46,7 +43,7 @@ export class VideoFusionAction extends Action {
     /**
      * 关闭视频融合
      */
-    static videoFusionStop({ ids }) {
+    static videoFusionStop(ids) {
         const param = {
             cmd: "videoFusion",
             action: "stop",
@@ -60,7 +57,7 @@ export class VideoFusionAction extends Action {
     /**
      * 刷新视频融合
      */
-    static videoFusionRefresh({ token }) {
+    static videoFusionRefresh(token) {
         const param = {
             cmd: "videoFusion",
             action: "refresh",

package/dist/types/modules/Action.d.ts

@@ -0,0 +1,13 @@
+import { SendParam } from "../types";
+export declare class Action {
+    /**
+    * 视角初始化
+    */
+    static cameraInit(): void;
+    /**
+     * 发送到model
+     * @param {SendParam} param 发送的参数
+     * @param {string} msg 打印的信息
+     */
+    static sendParam<T extends SendParam>(param: T, msg?: string): void;
+}

package/dist/types/modules/Poi.d.ts

@@ -0,0 +1,27 @@
+/**
+ * POI点方法
+ */
+import { LocationItem } from "../types";
+import { Action } from "./Action";
+export declare class PoiAction extends Action {
+    /**
+      * 添加poi
+      */
+    static poiAdd(type: string | undefined, location: LocationItem, text?: string, place?: string, description?: string, linkId?: string): void;
+    /**
+    * 删除poi
+    */
+    static poiDel(id: string): void;
+    /**
+     * 显示poi
+     */
+    static poiShow(id: string, type: string | undefined, place: string): void;
+    /**
+    * 隐藏poi
+    */
+    static poiHide(id: string, type: string | undefined, place: string): void;
+    /**
+     * 获取指定POI
+     */
+    static poiGetInfo(type?: string): void;
+}

package/dist/types/modules/Track.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 轨迹方法
+ */
+import { TrackType } from "../types";
+import { Action } from "./Action";
+export declare class TrackAction extends Action {
+    /**
+     * 清除轨迹
+     */
+    static trackRemove(pathId?: string): void;
+    /**
+     * 获取三维路网坐标
+     */
+    static trackGetRoadNet(data: TrackType['data'], rnId?: string): void;
+    /**
+     * 请求三维绘制路网
+     */
+    static trackPath(data: TrackType['data'], pathId?: string): void;
+}

package/dist/types/modules/VideoFusion.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 视频融合方法
+ */
+import { VideoFusionType } from "../types";
+import { Action } from "./Action";
+export declare class VideoFusionAction extends Action {
+    /**
+     * 视频融合初始化
+     */
+    static videoFusionInit(token: string, ip: string, port?: string, isHttps?: boolean): void;
+    /**
+     * 飞行到视频融合点位
+     */
+    static videoFusionFlyTo(id: string, fov: number): void;
+    /**
+     * 开启视频融合
+     */
+    static videoFusionStart(ids: VideoFusionType['ids']): void;
+    /**
+     * 关闭视频融合
+     */
+    static videoFusionStop(ids: VideoFusionType['ids']): void;
+    /**
+     * 刷新视频融合
+     */
+    static videoFusionRefresh(token: string): void;
+}

package/dist/types/types.d.ts

@@ -0,0 +1,68 @@
+
+export type RequiredSome<T, K extends keyof T> = Required<Pick<T, K>> & Omit<T, K>;
+
+export interface SendParam {
+    cmd: string,
+    action: string,
+}
+
+export 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

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "model-action",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "与三维交互api",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "build":"tsc",
+    "build":"tsc && cp src/types.d.ts dist/types",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "files": ["dist","src"],

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

@@ -1,70 +1,4 @@
-export type RequiredSome<T, K extends keyof T> = Required<Pick<T, K>> & Omit<T, K>;
-
-export interface SendParam {
-    cmd: string,
-    action: string,
-}
-
-export 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
+import { SendParam } from "../types";
 
 export class Action {
     /**

package/src/modules/Poi.ts

@@ -1,13 +1,14 @@
 /**
  * POI点方法
  */
-import { Action, PoiType, RequiredSome } from "./Action";
+import { LocationItem, PoiType, RequiredSome } from "../types";
+import { Action } from "./Action";
 
 export class PoiAction extends Action {
     /**
       * 添加poi
       */
-    static poiAdd({ type = 'Camera', location, text = '', place = '', description = '', linkId = '' }: RequiredSome<PoiType, 'action' | 'type' | 'location'>) {
+    static poiAdd(type = 'Camera', location: LocationItem, text = '', place = '', description = '', linkId = '') {
         const param: RequiredSome<PoiType, 'action' | 'type' | 'location'> = {
             cmd: "POI",
             action: "add",
@@ -24,7 +25,7 @@ export class PoiAction extends Action {
     /**
     * 删除poi
     */
-    static poiDel({ id }: PoiType) {
+    static poiDel(id: string) {
         const param: PoiType = {
             cmd: "POI",
             action: "delete",
@@ -36,7 +37,7 @@ export class PoiAction extends Action {
     /**
      * 显示poi
      */
-    static poiShow({ id, type = "Camera", place }: PoiType) {
+    static poiShow(id: string, type = "Camera", place: string) {
         const param: PoiType = {
             cmd: "POI",
             action: "show",
@@ -53,7 +54,7 @@ export class PoiAction extends Action {
     /**
     * 隐藏poi
     */
-    static poiHide({ id, type = "Camera", place }: PoiType) {
+    static poiHide(id: string, type = "Camera", place: string) {
         const param: PoiType = {
             cmd: "POI",
             action: "hide",
@@ -70,7 +71,7 @@ export class PoiAction extends Action {
     /**
      * 获取指定POI
      */
-    static poiGetInfo({type='Camera'}:PoiType) {
+    static poiGetInfo(type = 'Camera') {
         const param: PoiType = {
             cmd: "POI",
             action: "getInfo",

package/src/modules/Track.ts

@@ -1,13 +1,14 @@
 /**
  * 轨迹方法
  */
-import { Action, TrackType } from "./Action";
+import { TrackType } from "../types";
+import { Action } from "./Action";
 
 export class TrackAction extends Action {
     /**
      * 清除轨迹
      */
-    static trackRemove({ pathId = "CameraTrack" }: TrackType) {
+    static trackRemove(pathId = "CameraTrack") {
         const param: TrackType = {
             cmd: "path",
             action: "remove",
@@ -19,7 +20,7 @@ export class TrackAction extends Action {
     /**
      * 获取三维路网坐标
      */
-    static trackGetRoadNet({ data, rnId = 'RN-1' }: TrackType) {
+    static trackGetRoadNet(data: TrackType['data'], rnId = 'RN-1') {
         const param: TrackType = {
             cmd: "path",
             action: "getRoadNet",
@@ -32,7 +33,7 @@ export class TrackAction extends Action {
     /**
      * 请求三维绘制路网
      */
-    static trackPath({ data, pathId = "CameraTrack" }: TrackType) {
+    static trackPath(data: TrackType['data'], pathId = "CameraTrack") {
         const param: TrackType = {
             cmd: "path",
             action: "add",

package/src/modules/VideoFusion.ts

@@ -1,13 +1,14 @@
 /**
  * 视频融合方法
  */
-import { Action, VideoFusionType } from "./Action";
+import { VideoFusionType } from "../types";
+import { Action } from "./Action";
 
 export class VideoFusionAction extends Action {
     /**
      * 视频融合初始化
      */
-    static videoFusionInit({ token, ip, port = '1998', isHttps = false }: VideoFusionType) {
+    static videoFusionInit(token: string, ip: string, port = '1998', isHttps = false) {
         const param: VideoFusionType = {
             cmd: "videoFusion",
             action: "init",
@@ -22,7 +23,7 @@ export class VideoFusionAction extends Action {
     /**
      * 飞行到视频融合点位
      */
-    static videoFusionFlyTo({id, fov}:VideoFusionType) {
+    static videoFusionFlyTo(id: string, fov: number) {
         const param: VideoFusionType = {
             cmd: "videoFusion",
             action: "flyTo",
@@ -35,7 +36,7 @@ export class VideoFusionAction extends Action {
     /**
      * 开启视频融合
      */
-    static videoFusionStart({ids}:VideoFusionType) {
+    static videoFusionStart(ids: VideoFusionType['ids']) {
         const param: VideoFusionType = {
             cmd: "videoFusion",
             action: "start",
@@ -50,7 +51,7 @@ export class VideoFusionAction extends Action {
     /**
      * 关闭视频融合
      */
-    static videoFusionStop({ids}:VideoFusionType) {
+    static videoFusionStop(ids: VideoFusionType['ids']) {
         const param: VideoFusionType = {
             cmd: "videoFusion",
             action: "stop",
@@ -65,7 +66,7 @@ export class VideoFusionAction extends Action {
     /**
      * 刷新视频融合
      */
-    static videoFusionRefresh({token}:VideoFusionType) {
+    static videoFusionRefresh(token: string) {
         const param: VideoFusionType = {
             cmd: "videoFusion",
             action: "refresh",

package/src/types.d.ts

@@ -0,0 +1,68 @@
+
+export type RequiredSome<T, K extends keyof T> = Required<Pick<T, K>> & Omit<T, K>;
+
+export interface SendParam {
+    cmd: string,
+    action: string,
+}
+
+export 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

package/dist/modules/Action.d.ts

@@ -1,66 +0,0 @@
-export type RequiredSome<T, K extends keyof T> = Required<Pick<T, K>> & Omit<T, K>;
-export interface SendParam {
-    cmd: string;
-    action: string;
-}
-export 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 {
-    /**
-    * 视角初始化
-    */
-    static cameraInit(): void;
-    /**
-     * 发送到model
-     * @param {SendParam} param 发送的参数
-     * @param {string} msg 打印的信息
-     */
-    static sendParam<T extends SendParam>(param: T, msg?: string): void;
-}

package/dist/modules/Poi.d.ts

@@ -1,26 +0,0 @@
-/**
- * POI点方法
- */
-import { Action, PoiType, RequiredSome } from "./Action";
-export declare class PoiAction extends Action {
-    /**
-      * 添加poi
-      */
-    static poiAdd({ type, location, text, place, description, linkId }: RequiredSome<PoiType, 'action' | 'type' | 'location'>): void;
-    /**
-    * 删除poi
-    */
-    static poiDel({ id }: PoiType): void;
-    /**
-     * 显示poi
-     */
-    static poiShow({ id, type, place }: PoiType): void;
-    /**
-    * 隐藏poi
-    */
-    static poiHide({ id, type, place }: PoiType): void;
-    /**
-     * 获取指定POI
-     */
-    static poiGetInfo({ type }: PoiType): void;
-}

package/dist/modules/Track.d.ts

@@ -1,18 +0,0 @@
-/**
- * 轨迹方法
- */
-import { Action, TrackType } from "./Action";
-export declare class TrackAction extends Action {
-    /**
-     * 清除轨迹
-     */
-    static trackRemove({ pathId }: TrackType): void;
-    /**
-     * 获取三维路网坐标
-     */
-    static trackGetRoadNet({ data, rnId }: TrackType): void;
-    /**
-     * 请求三维绘制路网
-     */
-    static trackPath({ data, pathId }: TrackType): void;
-}

package/dist/modules/VideoFusion.d.ts

@@ -1,26 +0,0 @@
-/**
- * 视频融合方法
- */
-import { Action, VideoFusionType } from "./Action";
-export declare class VideoFusionAction extends Action {
-    /**
-     * 视频融合初始化
-     */
-    static videoFusionInit({ token, ip, port, isHttps }: VideoFusionType): void;
-    /**
-     * 飞行到视频融合点位
-     */
-    static videoFusionFlyTo({ id, fov }: VideoFusionType): void;
-    /**
-     * 开启视频融合
-     */
-    static videoFusionStart({ ids }: VideoFusionType): void;
-    /**
-     * 关闭视频融合
-     */
-    static videoFusionStop({ ids }: VideoFusionType): void;
-    /**
-     * 刷新视频融合
-     */
-    static videoFusionRefresh({ token }: VideoFusionType): void;
-}