@xtctwins/tctwins-bimx-engine 0.2.55 → 0.3.1

package/types/store/const.d.ts

@@ -1,228 +1,11 @@
-import { AnnoType } from '../utils/eventBus';
-export declare const MENU = "menus";
-export declare const TOKEN = "token";
-export declare const IS_FOLD = "isFold";
-export declare const USER_INFO = "userInfo";
-export declare const USER_LIST = "userList";
-export declare const ENTIRE_ROLES = "entireRoles";
-export declare const KEYID = "LTAI4FvDVqNXSTHoAUqXGMfo";
-export declare const CACHE_LOGIN_USER_INFO = "loginUserInfo";
-export declare const KEYSECRET = "6wusVUYf8w9pW8YOJuGhRouYNHLnwY";
-export declare const USER_DEFAULT_AVATAR: string;
-export declare const USER_DEFAULT_POPOVER_AVATAR: string;
-export declare const INVALID_FILENAME: RegExp;
-export declare const TABLIST: ({
-    id: number;
-    name: string;
-    showIcon: boolean;
-    type: string;
-    active: boolean;
-    iconUpActive?: undefined;
-    iconDownActive?: undefined;
-} | {
-    id: number;
-    name: string;
-    showIcon: boolean;
-    type: string;
-    active: boolean;
-    iconUpActive: boolean;
-    iconDownActive: boolean;
-} | {
-    id: number;
-    name: string;
-    showIcon: boolean;
-    type: string;
-    active?: undefined;
-    iconUpActive?: undefined;
-    iconDownActive?: undefined;
-})[];
-export declare const CREATEITEM: {
-    projectId: number;
-    isCreat: boolean;
-    operate: number;
-}[];
-export declare const TABLE_TABS: {
-    id: number;
-    num: string;
-    fileType: string;
-    name: string;
-    img: string;
-}[];
-export declare const ACCOUNT_APP_ID = "wx74d8c813cb7fd518";
-export declare const CHOOSETYPELIST: {
-    id: number;
-    name: string;
-    data: number[];
-}[];
-export declare const FILETYPE: {
-    id: number;
-    name: string;
-    data: number[];
-}[];
-export declare const BULK_OPERATION: {
-    id: number;
-    name: string;
-}[];
-export declare const ALLOCATION_ROLE_LIST: {
-    id: number;
-    name: string;
-    label: string;
-}[];
-export declare const PROJECT_CHOOSE_TYPE: {
-    id: number;
-    name: string;
-    label: string;
-}[];
-export declare const DIRECTORY_LIST: {
-    id: number;
-    name: string;
-    label: string;
-    isShow: boolean;
-    color: string;
-}[];
-export declare const CONVERT_STATUS: {
-    unconverted: number;
-    converting: number;
-    convertSuccessful: number;
-    convertFailed: number;
-};
-export declare const STRUCTURE_TREE_LIST: {
-    id: number;
-    name: string;
-}[];
-export declare const MEMBER_BENEFITS: {
-    id: number;
-    name: string;
-    img: string;
-}[];
-export declare const MEMBER_TYPE_LIST: {
-    id: number;
-    name: string;
-}[];
-export declare const PROVOLEGE_LIST: {
-    id: number;
-    name: string;
-}[];
-export declare const LINE_WEIGHT_LIST: {
-    id: number;
-    size: string;
-}[];
-export declare const TIPS_COLOR: {
-    id: number;
-    color: string;
-}[];
-export declare const FONT_SIZE_LIST: {
-    id: number;
-    name: string;
-    label: string;
-    fontSize: string;
-}[];
-export declare const COMMENT_TOOL_LIST: {
-    id: number;
-    name: string;
-    label: string;
-    buttontype: string;
-    img: string;
-    imgActive: string;
-    svg: string;
-    svgActive: string;
-    isShow: boolean;
-}[];
-export declare const TOOL_BAR_LIST: {
-    id: number;
-    name: string;
-    isShowDelimiter: boolean;
-    img: string;
-    imgActive: string;
-}[];
-export declare const TOOL_BAR_APP_LIST: {
-    id: number;
-    code: string;
-    name: string;
-    isShowDelimiter: boolean;
-    img: string;
-    imgActive: string;
-}[];
-export declare const TOOL_BAR_APP_SHARED_LIST: {
-    id: number;
-    code: string;
-    name: string;
-    isShowDelimiter: boolean;
-    img: string;
-    imgActive: string;
-}[];
-export declare const BG_COLOR_APP_LIST: {
-    id: number;
-    name: string;
-    color: string;
-    rgb: number[];
-}[];
-export declare const BG_COLOR_LIST: {
-    id: number;
-    name: string;
-    label: string;
-    color: string;
-    rgb: number[];
-}[];
-export declare const ENJOY_MEMBER_LIST: {
-    id: number;
-    name: string;
-    label: string;
-}[];
-export declare const VALIDITY_PERIOD_LIST: {
-    id: string;
-    name: string;
-    label: string;
-}[];
-export declare const ROLE_LIST: {
-    id: number;
-    name: string;
-    label: string;
-}[];
-export declare const MEASUREMENT: {
-    id: number;
-    code: string;
-    name: string;
-    label: string;
-    img: string;
-    imgActive: string;
-    svg: string;
-    svgActive: string;
-}[];
-export declare const SCREEN_LIST: ({
-    id: number;
-    name: string;
-    width: string;
-    height: string;
-    label?: undefined;
-} | {
-    id: number;
-    label: string;
-    name?: undefined;
-    width?: undefined;
-    height?: undefined;
-})[];
-export declare const NAVIGATE_LIST: {
-    id: number;
-    code: string;
-    name: string;
-    label: string;
-    dir_num: number;
-    img: string;
-    imgActive: string;
-}[];
-export declare const ANNOTATION_LIST: {
-    id: number;
-    code: AnnoType;
-    name: string;
-    okType: string;
-    img: string;
-    img_active: string;
-    imgActive: string;
-}[];
-export declare const HIDDEN_LIST: {
-    id: number;
-    name: string;
-    img: string;
-    img_active: string;
-}[];
+/**
+ * const.ts — 常量桶文件
+ *
+ * 所有常量已按职责拆分到 const/ 子目录中的独立文件。
+ * 本文件统一重导出，保持 `import { ... } from "@/store/const"` 的向后兼容性。
+ */
+export { MENU, TOKEN, IS_FOLD, USER_INFO, USER_LIST, ENTIRE_ROLES, KEYID, CACHE_LOGIN_USER_INFO, KEYSECRET, USER_DEFAULT_AVATAR, USER_DEFAULT_POPOVER_AVATAR, INVALID_FILENAME, TABLIST, CREATEITEM, TABLE_TABS, ACCOUNT_APP_ID, CHOOSETYPELIST, FILETYPE, CONVERT_STATUS, } from './const/app';
+export { ALLOCATION_ROLE_LIST, PROJECT_CHOOSE_TYPE, DIRECTORY_LIST, MEMBER_BENEFITS, MEMBER_TYPE_LIST, PROVOLEGE_LIST, ENJOY_MEMBER_LIST, VALIDITY_PERIOD_LIST, ROLE_LIST, } from './const/project';
+export { BULK_OPERATION, MEASUREMENT, LINE_WEIGHT_LIST, TIPS_COLOR, FONT_SIZE_LIST, COMMENT_TOOL_LIST, ANNOTATION_LIST, HIDDEN_LIST, SCREEN_LIST, NAVIGATE_LIST, STRUCTURE_TREE_LIST, } from './const/bimTools';
+export { TOOL_BAR_LIST, TOOL_BAR_APP_LIST, TOOL_BAR_APP_SHARED_LIST, } from './const/toolbar';
+export { BG_COLOR_APP_LIST, BG_COLOR_LIST, } from './const/theme';

package/types/store/toolbars.d.ts

@@ -841,9 +841,31 @@ export declare function getToolbarStore(): import('pinia').Store<"toolbar", {
     ifToolAllReady(): boolean;
     setReadyTools(toolIds: number[]): void;
 }>;
+/**
+ * 初始化工具栏：关闭所有工具面板、清空就绪和激活状态
+ *
+ * @remarks 通常在模型加载前或切换模型时调用
+ */
 export declare function InitToolBar(): void;
 export declare let MobileToolOrder: string[];
 export declare let PcToolOrder: string[];
+/**
+ * 设置 PC 端工具栏排序
+ *
+ * @param order - 工具 key 数组，按期望的显示顺序排列
+ */
 export declare function setPcToolOrder(order: string[]): void;
+/**
+ * 设置移动端工具栏排序
+ *
+ * @param order - 工具 key 数组，按期望的显示顺序排列
+ */
 export declare function setMobileToolOrder(order: string[]): void;
+/**
+ * 按指定顺序对数组排序
+ *
+ * @param a - 待排序的 key 数组
+ * @param b - 排序依据（所有可能的 key 按期望顺序排列）
+ * @returns 排序后的 key 数组（仅包含 b 中存在的元素）
+ */
 export declare function sortArrayByOrder(a: any, b: any): any;

package/types/store/userInfoStore.d.ts

@@ -20,7 +20,7 @@ export declare const useUserInfoStore: import('pinia').StoreDefinition<"userInfo
         userId: number;
         staffList: any;
     }>) => any;
-    getStuffName: (state: {
+    getStaffName: (state: {
         userId: number;
         staffList: any;
     } & import('pinia').PiniaCustomStateProperties<{

package/types/stores/viewerStore.d.ts

@@ -0,0 +1,112 @@
+export declare const useViewerStore: import('pinia').StoreDefinition<"viewer", Pick<{
+    viewerInstance: import('vue').Ref<any, any>;
+    isReady: import('vue').ComputedRef<boolean>;
+    viewerState: import('vue').Ref<{
+        measureType: "distance" | "angle";
+    }, {
+        measureType: "distance" | "angle";
+    } | {
+        measureType: "distance" | "angle";
+    }>;
+    entityState: import('vue').Ref<{
+        xrayedObjectIds: string[];
+        highlightedObjectIds: string[];
+        selectedObjectIds: string[];
+        visibleObjectIds: string[];
+        edgesObjectIds: string[];
+    }, {
+        xrayedObjectIds: string[];
+        highlightedObjectIds: string[];
+        selectedObjectIds: string[];
+        visibleObjectIds: string[];
+        edgesObjectIds: string[];
+    } | {
+        xrayedObjectIds: string[];
+        highlightedObjectIds: string[];
+        selectedObjectIds: string[];
+        visibleObjectIds: string[];
+        edgesObjectIds: string[];
+    }>;
+    setViewerInstance: (instance: any) => void;
+    configViewer: (eventTarget?: string) => void;
+    saveViewerState: (content: Record<string, any>) => void;
+    setToolActiveById: (id: number, active?: boolean) => void;
+    setToolActiveByKey: (key: string, active?: boolean) => void;
+    setAllClose: () => void;
+    destroyViewer: () => void;
+    showRequestBusy: (show: boolean, callback?: Function) => void;
+}, "viewerInstance" | "viewerState" | "entityState">, Pick<{
+    viewerInstance: import('vue').Ref<any, any>;
+    isReady: import('vue').ComputedRef<boolean>;
+    viewerState: import('vue').Ref<{
+        measureType: "distance" | "angle";
+    }, {
+        measureType: "distance" | "angle";
+    } | {
+        measureType: "distance" | "angle";
+    }>;
+    entityState: import('vue').Ref<{
+        xrayedObjectIds: string[];
+        highlightedObjectIds: string[];
+        selectedObjectIds: string[];
+        visibleObjectIds: string[];
+        edgesObjectIds: string[];
+    }, {
+        xrayedObjectIds: string[];
+        highlightedObjectIds: string[];
+        selectedObjectIds: string[];
+        visibleObjectIds: string[];
+        edgesObjectIds: string[];
+    } | {
+        xrayedObjectIds: string[];
+        highlightedObjectIds: string[];
+        selectedObjectIds: string[];
+        visibleObjectIds: string[];
+        edgesObjectIds: string[];
+    }>;
+    setViewerInstance: (instance: any) => void;
+    configViewer: (eventTarget?: string) => void;
+    saveViewerState: (content: Record<string, any>) => void;
+    setToolActiveById: (id: number, active?: boolean) => void;
+    setToolActiveByKey: (key: string, active?: boolean) => void;
+    setAllClose: () => void;
+    destroyViewer: () => void;
+    showRequestBusy: (show: boolean, callback?: Function) => void;
+}, "isReady">, Pick<{
+    viewerInstance: import('vue').Ref<any, any>;
+    isReady: import('vue').ComputedRef<boolean>;
+    viewerState: import('vue').Ref<{
+        measureType: "distance" | "angle";
+    }, {
+        measureType: "distance" | "angle";
+    } | {
+        measureType: "distance" | "angle";
+    }>;
+    entityState: import('vue').Ref<{
+        xrayedObjectIds: string[];
+        highlightedObjectIds: string[];
+        selectedObjectIds: string[];
+        visibleObjectIds: string[];
+        edgesObjectIds: string[];
+    }, {
+        xrayedObjectIds: string[];
+        highlightedObjectIds: string[];
+        selectedObjectIds: string[];
+        visibleObjectIds: string[];
+        edgesObjectIds: string[];
+    } | {
+        xrayedObjectIds: string[];
+        highlightedObjectIds: string[];
+        selectedObjectIds: string[];
+        visibleObjectIds: string[];
+        edgesObjectIds: string[];
+    }>;
+    setViewerInstance: (instance: any) => void;
+    configViewer: (eventTarget?: string) => void;
+    saveViewerState: (content: Record<string, any>) => void;
+    setToolActiveById: (id: number, active?: boolean) => void;
+    setToolActiveByKey: (key: string, active?: boolean) => void;
+    setAllClose: () => void;
+    destroyViewer: () => void;
+    showRequestBusy: (show: boolean, callback?: Function) => void;
+}, "setViewerInstance" | "configViewer" | "saveViewerState" | "setToolActiveById" | "setToolActiveByKey" | "setAllClose" | "destroyViewer" | "showRequestBusy">>;

package/types/types/bcf.d.ts

@@ -0,0 +1,83 @@
+import { InputBCFView } from '@xtctwins/tctwins-bimx-viewer/types/src/toolbar/BCFTool';
+/** BCF 用户信息 */
+export type BcfUserInfo = {
+    avatar: string;
+    createTime: string;
+    updateTime: any;
+    email: string;
+    inviteId: number;
+    inviteUserName: string;
+    mobile: string;
+    role: number;
+    status: number;
+    userId: number;
+    userName: string;
+    self: boolean;
+};
+/** BCF 列表 + 人员信息的组合载荷 */
+export type BcfContent = {
+    userId: number;
+    bcfList: BcfTopicTotal[];
+    staffList: BcfUserInfo[];
+};
+/** BCF 评论输入 */
+export type BcfInputComment = {
+    guid?: string;
+    date: string;
+    userId?: number;
+    author: string | number;
+    comment: string;
+    snapshotList?: any[];
+    modified_author?: string;
+    modified_date?: string;
+    viewPoint?: string;
+};
+/** 服务端返回的完整 BCF 议题 */
+export type BcfTopicTotal = {
+    _id: number;
+    fileId: number;
+    userId: number;
+    guid?: string;
+    title: string;
+    author: number | string;
+    createDate: string;
+    index: number;
+    priority?: string;
+    type?: string;
+    stage?: string;
+    status?: string;
+    labels?: string[] | undefined;
+    dueDate?: string;
+    assignedTo?: string | number;
+    description?: string;
+    viewPoints?: InputBCFView[];
+    comments?: BcfInputComment[];
+    server_assigned_id?: string;
+    reference_links?: string[] | undefined;
+    modified_date?: string;
+    modified_author?: string;
+    related_topics?: string[] | undefined;
+};
+/** 新创建的 BCF 议题（guid 还没有服务端分配时） */
+export type BcfTopic = {
+    guid?: string;
+    title: string;
+    author: number | string;
+    createDate: string;
+    index?: number;
+    priority?: string;
+    type?: string;
+    stage?: string;
+    status?: string;
+    labels?: string[] | undefined;
+    dueDate?: string;
+    assignedTo?: string | number;
+    description?: string;
+    viewPoints?: InputBCFView[];
+    comments?: BcfInputComment[];
+    server_assigned_id?: string;
+    reference_links?: string[] | undefined;
+    modified_date?: string;
+    modified_author?: string;
+    related_topics?: string[] | undefined;
+};

package/types/types/events.d.ts

@@ -0,0 +1,88 @@
+import { ComponentName } from '../store/toolbars';
+import { BcfTopic, BcfTopicTotal, BcfInputComment } from './bcf';
+import { ToolDir } from '../store/initConfigs';
+/** 标注附件类型 */
+export type AnnoType = "file" | "image" | "record" | "text" | "video";
+/** 漫游事件类型 */
+export type RoamEvent = "goUp" | "goDown" | "goLeft" | "goRight" | "goForward" | "goBackward" | "stop";
+/** 测量工具类型 */
+export type MeasureTool = "distance" | "angle";
+/**
+ * 组件间事件通信的载荷结构
+ *
+ * @remarks 通过 mitt emitter 发送，event_target 标识事件来源组件，event_name 标识事件名。
+ */
+export type EventContent = {
+    /** 是否来自工具（true）还是 UI 组件（false） */
+    isTool: boolean;
+    /** 触发事件的目标组件 */
+    event_target: ComponentName | "BimXViewer" | "ToolBar";
+    /** 事件名称 */
+    event_name: string;
+    /** 事件载荷 */
+    content: {
+        content?: any;
+        id?: any;
+        msg?: string;
+        code?: 200 | -1;
+        item?: any;
+        type?: string;
+        toolId?: number;
+        toolKey?: string;
+        color?: string;
+        active?: boolean;
+        enable?: boolean;
+        tool_type?: AnnoType;
+        annoId?: string;
+        object?: any;
+        currentAnnotation?: any;
+        rawFile?: any;
+        targetAnno?: any;
+        status?: string | boolean;
+        nodeId?: string | number;
+        entityId?: string | number;
+        objectId?: string | number;
+        viewer_nodeId?: string | number;
+        active_tree?: number;
+        img_data?: string;
+        roam?: RoamEvent;
+        newSets?: any;
+        newComment?: any;
+        direction?: number;
+        measureTool?: MeasureTool;
+        newMeasure?: any;
+        measurePrefer?: any;
+        bcf?: BcfTopic | BcfTopicTotal;
+        bcfId?: number;
+        bcf_guid?: string;
+        bcf_cmt?: BcfInputComment;
+        bcf_cmt_guid?: string;
+    };
+};
+type InstructionName = "updateCmtList" | "checkCmtDetail" | "newComment" | "updateBcfList" | "checkBcfDetail" | "changeBackgroundColor" | "setNavCube" | "setAnnoStatus" | "lastSetsContent";
+/**
+ * 跨组件指令通信结构
+ *
+ * @remarks 用于父子组件间的指令传递，如更新列表、检查详情等。
+ */
+export type InstructionContent = {
+    instruct_name: InstructionName;
+    content: {
+        code?: any;
+        guid?: any;
+        msg?: any;
+        type?: any;
+        active?: boolean;
+        color?: string;
+        move?: boolean;
+        pos?: ToolDir;
+        posNum?: number[];
+        index?: number;
+        cmtList?: any;
+        cmtDetail?: any;
+        bcfList?: BcfTopicTotal[];
+        bcfDetail?: BcfTopicTotal;
+        lastSet?: any;
+    };
+};
+export {};

package/types/utils/OSSHelper.d.ts

@@ -1,5 +1,32 @@
+/**
+ * OSSHelper — 阿里云 OSS 文件操作辅助类
+ *
+ * 提供从 OSS 读取文件、下载 Buffer、获取 JSON 元数据等能力。
+ * 内部通过 STS 临时凭证自动创建 OSSClient 实例。
+ */
 export default class OSSHelper {
+    /**
+     * 从 OSS 获取文件的 ArrayBuffer
+     *
+     * @param filePath - OSS 文件路径
+     * @param done - 成功回调，接收 Buffer 数据
+     * @param error - 可选，失败回调
+     */
     static getBuffer(filePath: string, done: Function, error?: Function): Promise<void>;
+    /**
+     * 从 OSS 请求文件（支持单文件和多文件模式）
+     *
+     * @param filePath - OSS 目录路径
+     * @param isFile - true 读取 metadata.json，false 读取 index.json
+     * @param done - 成功回调，接收解析后的 JSON 对象
+     * @param error - 失败回调
+     */
     static requestFileFromOSS(filePath: string, isFile: boolean, done: Function, error: Function): Promise<void>;
+    /**
+     * 通过 HTTP 下载文件（非 OSS）
+     *
+     * @param filePath - 文件的完整 HTTP URL
+     * @returns 文件的 ArrayBuffer
+     */
     static downloadFile(filePath: string): Promise<ArrayBuffer>;
 }

package/types/utils/cacheInfo.d.ts

@@ -1,7 +1,12 @@
 /**
- * 本地缓存
- * LStorage
- * sStorage
+ * 本地缓存封装
+ *
+ * 基于 localStorage / sessionStorage，支持过期时间自动清除。
+ *
+ * @example
+ * import { LStorage, SStorage } from "@/utils/cacheInfo";
+ * LStorage.set("key", data, 3600); // 1 小时后过期
+ * const val = LStorage.get("key");  // 过期自动返回 null
  */
 declare enum StorageType {
     l = "localStorage",
@@ -9,10 +14,28 @@ declare enum StorageType {
 }
 declare class MyStorage {
     storage: Storage;
+    /**
+     * @param type - StorageType.l 为 localStorage，StorageType.s 为 sessionStorage
+     */
     constructor(type: StorageType);
+    /**
+     * 写入缓存
+     *
+     * @param key - 缓存键
+     * @param value - 缓存值（会被 JSON.stringify）
+     * @param expires - false 永不过期；true 默认 1 小时；number 为秒数
+     */
     set(key: string, value: any, expires?: boolean | number): void;
+    /**
+     * 读取缓存，过期自动清除并返回 null
+     *
+     * @param key - 缓存键
+     * @returns 缓存值（JSON 解析后），过期或不存在时返回 null
+     */
     get(key: string): any;
+    /** 删除指定缓存 */
     remove(key: string): void;
+    /** 清空所有缓存 */
     clear(): void;
 }
 declare const LStorage: MyStorage;

package/types/utils/dbscan.d.ts

@@ -0,0 +1 @@
+export default function startDBSCAN(modelId: string): void;