@soonspacejs/plugin-cps-soonmanager 2.9.7 → 2.9.9

package/dist/batch-update-poi/index.d.ts

@@ -0,0 +1,17 @@
+import SoonSpace from 'soonspacejs';
+import PoiRendererPlugin from '@soonspacejs/plugin-poi-renderer';
+import CpsManagerPlugin from '../';
+import { ITreeData } from '../types';
+import { SourceApiListInterface } from '../data-source/request-types';
+import { PoiList } from './types';
+declare class BatchUpdatePoi {
+    #private;
+    treeList: ITreeData[] | null;
+    poiList: PoiList[] | null;
+    ssp: SoonSpace;
+    plugin: PoiRendererPlugin;
+    cpsPlugin: CpsManagerPlugin;
+    constructor(treeList: ITreeData[] | null, poiList: PoiList[] | null, ssp: SoonSpace, plugin: PoiRendererPlugin, cpsPlugin: CpsManagerPlugin);
+    batchPoi(api: SourceApiListInterface, data: any): void;
+}
+export default BatchUpdatePoi;

package/dist/batch-update-poi/types.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="node" />
+import { IPublishPacket } from 'mqtt';
+import { IPoiData, ITreeData, PoiContent } from '../types';
+export type TFlatTreeNode = Record<ITreeData['id'], ITreeData>;
+export type PoiList = IPoiData & {
+    contentData?: PoiContent;
+};
+export type ResponseMqttType = {
+    topic: string;
+    payload: Buffer;
+    packet: IPublishPacket;
+};
+export type ResponseSocketType = {
+    event: string;
+    message: any;
+};

package/dist/batch-update-poi/utils.d.ts

@@ -0,0 +1,18 @@
+import { ITreeData } from '../types';
+import { PoiList, TFlatTreeNode } from './types';
+/**
+ * 重新生成树节点
+ * @param modelTree
+ */
+export declare const regenerateNodes: (modelTree: ITreeData[]) => {
+    treeNodes: ITreeData[];
+    flatNodes: TFlatTreeNode;
+};
+export declare const getPoiByNodeId: (id: string, poiList: PoiList[]) => PoiList[];
+/**
+ * 捕获 JSON.parse 错误
+ * @param str
+ * @returns
+ */
+export declare const safeParseJSON: <T = any>(str: string) => T | null;
+export declare const subjectTopicMqtt: (subject: string, topic: string) => boolean;

package/dist/constants.d.ts

@@ -14,6 +14,10 @@ export declare const TREE_DATA_FILE_PATH = "/db/tree_models.json";
  * poi
  */
 export declare const POI_DATA_FILE_PATH = "/db/pois.json";
+/**
+ * poi
+ */
+export declare const DATA_SOURCE_FILE_PATH = "/db/data_source.json";
 /**
  * 拓扑路径
  */

package/dist/data-source/index.d.ts

@@ -0,0 +1,15 @@
+import { ClientType, SourceOnEventType } from './types';
+import { SourceApiListInterface, SourceEnvListInterface } from './request-types';
+declare class DataSource {
+    #private;
+    sourceEnv: SourceEnvListInterface[];
+    sourceApi: SourceApiListInterface[];
+    constructor(sourceEnv: SourceEnvListInterface[], sourceApi: SourceApiListInterface[]);
+    on<T extends keyof SourceOnEventType>(eventName: T, callback: SourceOnEventType[T]): void;
+    getClientById(id: string): ClientType;
+    requestAll(): void;
+    requestById(ids: string[]): void;
+    closeAll(): void;
+    closeById(ids: string[]): void;
+}
+export default DataSource;

package/dist/data-source/request-types.d.ts

@@ -0,0 +1,193 @@
+/**
+ * @description: 请求参数类型
+ */
+export declare enum RequestParamsTypeEnum {
+    PARAMS = "params",
+    BODY = "body",
+    HEADERS = "headers"
+}
+/**
+ * @description: 协议
+ */
+export declare enum ProtocolEnum {
+    HTTP = "HTTP",
+    MQTT = "MQTT",
+    WEBSOCKET = "WebSocket"
+}
+/**
+ * @description: 协议值
+ */
+export declare enum ProtocolValueEnum {
+    HTTPS = "https://",
+    HTTP = "http://",
+    MQTTS = "wss://",
+    MQTT = "ws://",
+    WSS = "wss://",
+    WS = "ws://"
+}
+/**
+ * @description: 请求参数主体
+ */
+export type RequestParamsObjType = {
+    [T: string]: string;
+};
+/**
+ * @description: 请求头部类型
+ */
+export declare enum RequestBodyEnum {
+    NONE = "none",
+    FORM_DATA = "form-data",
+    X_WWW_FORM_URLENCODED = "x-www-form-urlencoded",
+    JSON = "json",
+    XML = "xml"
+}
+/**
+ * @description: 请求方法
+ */
+export declare enum RequestHttpEnum {
+    GET = "GET",
+    POST = "POST",
+    PATCH = "PATCH",
+    PUT = "PUT",
+    OPTIONS = "OPTIONS",
+    DELETE = "DELETE"
+}
+/**
+ * @description: 请求间隔
+ */
+export declare enum RequestHttpIntervalEnum {
+    SECOND = "second",
+    MINUTE = "minute",
+    HOUR = "hour",
+    DAY = "day"
+}
+/**
+ * @description: 导出包json文件类型
+ */
+export type DataSourceType = {
+    dataSources: SourceEnvListInterface[];
+    dataSourceApis: SourceApiListInterface[];
+};
+/**
+ * @description: 数据源基础字段
+ */
+export interface SourceBaseConfigInterface {
+    id: string;
+    url: string;
+    name: string;
+    [RequestParamsTypeEnum.HEADERS]: RequestParamsObjType;
+    protocol: ProtocolEnum;
+    protocolValue: ProtocolValueEnum;
+    modules: 'SOON_MANAGER';
+}
+/**
+ * @description: 环境
+ */
+export interface SourceEnvListInterface extends SourceBaseConfigInterface {
+    apiNumber: number;
+    port?: number;
+}
+/**
+ * @description: 接口
+ */
+export interface SourceApiListInterface extends SourceBaseConfigInterface {
+    sid: string;
+    componentsId?: string[];
+    configureJson: RequestConfigType;
+    method?: RequestHttpEnum;
+    nodeArray?: SourceApiRelation[];
+    fullUrl?: string;
+}
+export type RequestConfigType = HttpConfigInterface | WssConfigInterface | MqttConfigInterface;
+/**
+ * @description: Http连接配置
+ */
+export interface HttpConfigInterface {
+    [RequestParamsTypeEnum.PARAMS]: RequestParamsObjType;
+    [RequestParamsTypeEnum.BODY]: {
+        [RequestBodyEnum.FORM_DATA]: RequestParamsObjType;
+        [RequestBodyEnum.X_WWW_FORM_URLENCODED]: RequestParamsObjType;
+        [RequestBodyEnum.JSON]: string;
+        [RequestBodyEnum.XML]: string;
+    };
+    filter: string;
+    interval: number;
+    unit: RequestHttpIntervalEnum;
+    bodyType: RequestBodyEnum;
+    method: RequestHttpEnum;
+}
+/**
+ * @description: 长连接事件处理
+ */
+export interface ConnectionEventInterface {
+    successCallback?: string;
+    errorCallback?: string;
+}
+/**
+ * @description: websocket连接配置
+ */
+export interface WssConfigInterface extends ConnectionEventInterface {
+    nameSpace?: string;
+    subProtocols?: string;
+    eventList: WssEventList[];
+    query: RequestParamsObjType;
+}
+/**
+ * @description: websocket-事件
+ */
+export interface WssEventList {
+    event: string;
+    remark?: string;
+    filter?: string;
+}
+/**
+ * @description: mqtt连接配置
+ */
+export interface MqttConfigInterface extends ConnectionEventInterface {
+    baseConfig: MqttBaseConfig;
+    willMessage: MqttLastWillMessage;
+    subscription: MqttSubscription[];
+}
+export interface MqttBaseConfig {
+    version: 3 | 4 | 5;
+    clientId?: string;
+    username?: string;
+    password?: string;
+    keepAlive?: number;
+}
+export type QoS = 0 | 1 | 2;
+export interface MqttLastWillMessage {
+    topic: string;
+    qos: QoS;
+    retain: boolean;
+    message: string;
+}
+export interface MqttSubscription {
+    topic: string;
+    qos: QoS;
+    remark?: string;
+    filter?: string;
+}
+export type OptionType = {
+    label: string;
+    value: string;
+};
+/**
+ * @description: 节点和接口的关联关系
+ */
+export type SourceApiRelation = {
+    id: string;
+    apiId: string;
+    eventList?: string[];
+    nodeId: string;
+    projectId: string;
+    matchParams?: string;
+};
+export declare const ProtocolOption: OptionType[];
+export declare enum ContentTypeEnum {
+    JSON = "application/json;charset=UTF-8",
+    TEXT = "text/plain;charset=UTF-8",
+    XML = "application/xml;charset=UTF-8",
+    FORM_URLENCODED = "application/x-www-form-urlencoded;charset=UTF-8",
+    FORM_DATA = "multipart/form-data"
+}

package/dist/data-source/types.d.ts

@@ -0,0 +1,37 @@
+import { MqttClient } from 'mqtt';
+import { Socket } from 'socket.io-client';
+import { HttpRequest } from './utils/http-request';
+import { SourceApiListInterface } from './request-types';
+export type ClientType = HttpRequest | MqttClient | Socket | undefined;
+export type SourceClientListType = {
+    [T: string]: ClientType;
+};
+/**
+ * @description: 连接状态
+ */
+export declare enum RequestStatusEnum {
+    SUCCESS = "success",
+    ERROR = "error",
+    CONNECT = "connect",
+    CLOSE = "close"
+}
+export type SourceOnEventType = {
+    onStatus: SourceStatusCallbackType;
+    onMessage: SourceMessageCallbackType;
+};
+export type SourceOnEventNameType = 'onMessage' | 'onStatus';
+export type SourceStatusCallbackType = (info: SourceStatusType) => void;
+export type SourceMessageCallbackType = (info: SourceMessageType) => void;
+export type SourceCallBackBaseType = {
+    api: SourceApiListInterface;
+    client: ClientType;
+};
+export type SourceStatusType = SourceCallBackBaseType & InfoStatusType;
+export type SourceMessageType = SourceCallBackBaseType & InfoMessageType;
+export type InfoStatusType = {
+    status: RequestStatusEnum;
+    message?: Error;
+};
+export type InfoMessageType = {
+    data: any;
+};

package/dist/data-source/utils/http-request.d.ts

@@ -0,0 +1,72 @@
+export interface HttpRequesttOptionInterface {
+    method?: string;
+    protocol?: string;
+    headers?: RequestParamsObjType;
+    params?: RequestParamsObjType;
+    body?: string | FormData | RequestParamsObjType | null;
+    interval?: number;
+    timeout?: number;
+    responseType?: XMLHttpRequestResponseType;
+    filter?: ((response: any) => any) | string;
+}
+/**
+ * @description: 请求参数主体
+ */
+type RequestParamsObjType = {
+    [T: string]: string;
+};
+export type RequestEventNameType = 'onSuccess' | 'onError' | 'onStatus';
+export declare class HttpRequest {
+    url: string;
+    method: string;
+    protocol: string;
+    params?: RequestParamsObjType;
+    headers?: RequestParamsObjType;
+    body: any | string | FormData | RequestParamsObjType | null;
+    filter?: any;
+    interval: number;
+    timeout: number;
+    responseType: XMLHttpRequestResponseType;
+    responseData: any;
+    filteredData: any | null;
+    option?: HttpRequesttOptionInterface;
+    XHR: XMLHttpRequest | undefined;
+    private isInterval;
+    private successCallback;
+    private errorCallback;
+    private statusCallback;
+    constructor(url: string, option?: HttpRequesttOptionInterface);
+    get getUrl(): string;
+    get getOption(): {
+        url: string;
+        method?: string | undefined;
+        protocol?: string | undefined;
+        headers?: RequestParamsObjType | undefined;
+        params?: RequestParamsObjType | undefined;
+        body?: string | RequestParamsObjType | FormData | null | undefined;
+        interval?: number | undefined;
+        timeout?: number | undefined;
+        responseType?: XMLHttpRequestResponseType | undefined;
+        filter?: string | ((response: any) => any) | undefined;
+    };
+    get getStatus(): number | undefined;
+    get getRequesting(): boolean;
+    get getResponseData(): any;
+    get getFilterData(): any;
+    send(): void;
+    abort(): void;
+    onceSend(): void;
+    listen(successCallback: (response: any, filteredData: any) => void, errorCallback?: (error: Error) => void): void;
+    on(eventName: RequestEventNameType, callback: any): void;
+    private onStatusCallback;
+    private onErrorCallback;
+    private onSuccessCallback;
+    private request;
+    private circulateRequest;
+    private onTimeout;
+    private onLoad;
+    private onError;
+    private paramsUrl;
+    private toObject;
+}
+export {};

package/dist/data-source/utils/http.d.ts

@@ -0,0 +1,4 @@
+import { HttpRequest } from './http-request';
+import { SourceApiListInterface, SourceEnvListInterface } from '../request-types';
+import { SourceMessageCallbackType, SourceStatusCallbackType } from '../types';
+export declare function requestHttp(api: SourceApiListInterface, env: SourceEnvListInterface, onStatus: SourceStatusCallbackType, onMessage: SourceMessageCallbackType): HttpRequest;

package/dist/data-source/utils/index.d.ts

@@ -0,0 +1,4 @@
+export * from './http';
+export * from './mqtt';
+export * from './socket';
+export * from './utils';

package/dist/data-source/utils/mqtt.d.ts

@@ -0,0 +1,4 @@
+import mqtt from 'mqtt';
+import { SourceApiListInterface, SourceEnvListInterface } from '../request-types';
+import { SourceMessageCallbackType, SourceStatusCallbackType } from '../types';
+export declare function requestMqtt(api: SourceApiListInterface, env: SourceEnvListInterface, onStatus: SourceStatusCallbackType, onMessage: SourceMessageCallbackType): mqtt.MqttClient;

package/dist/data-source/utils/socket.d.ts

@@ -0,0 +1,4 @@
+import { Socket } from 'socket.io-client';
+import { SourceApiListInterface, SourceEnvListInterface } from '../request-types';
+import { SourceMessageCallbackType, SourceStatusCallbackType } from '../types';
+export declare function requestSocket(api: SourceApiListInterface, env: SourceEnvListInterface, onStatus: SourceStatusCallbackType, onMessage: SourceMessageCallbackType): Socket<import("@socket.io/component-emitter").DefaultEventsMap, import("@socket.io/component-emitter").DefaultEventsMap>;

package/dist/data-source/utils/utils.d.ts

@@ -0,0 +1,18 @@
+import { RequestHttpIntervalEnum, RequestParamsObjType, SourceEnvListInterface } from '../request-types';
+export declare function has<T>(object: T, key: string): boolean;
+export declare function isNumber(value: any): boolean;
+export declare function isObject(value: any): boolean;
+export declare function getEnvUrl(env: SourceEnvListInterface): string;
+export declare function intervalUnitHandle(num: number, unit: RequestHttpIntervalEnum): number;
+export declare function encodeFormData(data: RequestParamsObjType): string;
+export declare function toString(str: any): any;
+/**
+ * * 函数过滤器
+ * @param data 数据值
+ * @param funcStr 函数字符串
+ * @param toString 转为字符串
+ * @param errorCallBack 错误回调函数
+ * @param successCallBack 成功回调函数
+ * @returns
+ */
+export declare function newFunctionHandle(data: any, funcStr: string, extractData?: boolean, isToString?: boolean, errorCallBack?: (s: any) => void, successCallBack?: (s: any) => void): any;

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import SoonSpace, { AnimationOptions, TopologyNodeInfo } from 'soonspacejs';
 import type { BaseObject3D, TopologyInfo } from 'soonspacejs/types/Library';
+import { PoiNodeData } from '@soonspacejs/plugin-poi-renderer';
 import SoonFlow from '@soonflow/core';
 import { Tween } from '@tweenjs/tween.js';
 import { IMetadata, ITreeData, IPoiData, ITopologyPath, ILoadSceneOptions, TPropertiesMap, TAnimationsMap, IPlayAnimationByIdOptions, TModelVisionsMap, IPresetEffectsOptions, ConstructorOptions } from './types';
@@ -20,6 +21,10 @@ declare class CpsSoonmanagerPlugin {
      * poi 数据
      */
     poiData: IPoiData[] | null;
+    /**
+     * 数据源
+     */
+    dataSourceData: any | null;
     /**
      * 拓扑路径
      */
@@ -65,6 +70,11 @@ declare class CpsSoonmanagerPlugin {
      * @returns
      */
     fetchPoiData(): Promise<IPoiData[]>;
+    /**
+     * 获取数据源数据
+     * @returns
+     */
+    fetchDataSourceData(): Promise<any>;
     /**
      * 获取拓扑路径
      * @returns
@@ -85,6 +95,18 @@ declare class CpsSoonmanagerPlugin {
      * @returns
      */
     fetchModelVisionsData(): Promise<TModelVisionsMap>;
+    /**
+     * 格式化 Poi 数据完成 Poi Renderer 插件使用
+     */
+    formatPoiData: (poiData: IPoiData) => PoiNodeData;
+    /**
+     * 初始化 Poi
+     */
+    loadPoi(refreshByDataSource: boolean): Promise<void>;
+    /**
+     *  通过数据源刷新 poi
+     */
+    refreshPoiByDataSource(): Promise<void>;
     /**
      * 根据 id 获取树节点
      */