3dviewer-sdk 1.0.15 → 1.0.17

package/dist/contracts/events.d.ts

@@ -0,0 +1,97 @@
+import type { MarkupListItem, MarkupOperationResultPayload, PdfCurrentPagePayload, PdfModeEventPayload, PdfToolbarActionEventPayload } from "./messages";
+export declare type ViewerEventMap = {
+    "camera:home": {
+        timestamp: number;
+    };
+    "node:select": {
+        nodeId: string;
+        timestamp: number;
+    };
+    "interaction:pan-change": {
+        enabled: boolean;
+    };
+    "toolbar:pdf-plan-mode": PdfModeEventPayload;
+    "toolbar:pdf-document-mode": PdfModeEventPayload;
+    "toolbar:pdf-first-page": PdfToolbarActionEventPayload;
+    "toolbar:pdf-previous-page": PdfToolbarActionEventPayload;
+    "toolbar:pdf-next-page": PdfToolbarActionEventPayload;
+    "toolbar:pdf-last-page": PdfToolbarActionEventPayload;
+    "toolbar:pdf-current-page": PdfCurrentPagePayload;
+    "modelTree:node-ids": {
+        requestId: string;
+        nodeIds: string[];
+        timestamp: number;
+    };
+    "sheets:list": {
+        requestId: string;
+        sheets: {
+            id: string | number;
+            name: string;
+            is3D?: boolean;
+            viewId?: string;
+        }[];
+        activeSheetId?: string | number | null;
+        timestamp: number;
+    };
+    "markup:list": {
+        requestId: string;
+        markups: MarkupListItem[];
+        timestamp: number;
+    };
+    "markup:save": MarkupOperationResultPayload;
+    "markup:cancel": MarkupOperationResultPayload;
+};
+export declare type LoadStage = "idle" | "uploading" | "converting" | "rendering" | "completed" | "error";
+export declare type LoadStatePayload = {
+    isLoading: boolean;
+    stage: LoadStage;
+    message?: string;
+    elapsedMs?: number;
+};
+export declare type PreparedViewerData = {
+    baseFileId: string;
+    baseMajorRev: number;
+    baseMinorRev: number;
+    fileName: string;
+    query: string;
+    url: string;
+};
+export declare type FilesEventMap = {
+    "files:state": LoadStatePayload;
+    "files:upload:start": {
+        fileName: string;
+    };
+    "files:upload:success": {
+        fileName: string;
+        baseFileId: string;
+    };
+    "files:upload:error": {
+        fileName: string;
+        error: string;
+    };
+    "files:conversion:start": {
+        fileName: string;
+    };
+    "files:conversion:success": PreparedViewerData;
+    "files:conversion:error": {
+        fileName: string;
+        error: string;
+    };
+    "files:render:start": {
+        url: string;
+    };
+    "files:render:success": {
+        url: string;
+    };
+    "files:render:error": {
+        url?: string;
+        error: string;
+    };
+    "files:load:success": PreparedViewerData;
+    "files:load:error": {
+        error: string;
+    };
+};
+export declare type SdkEventMap = ViewerEventMap & FilesEventMap;
+export declare type SdkEventKey = keyof SdkEventMap;
+export declare type SdkEventPayload<K extends SdkEventKey> = SdkEventMap[K];

package/dist/contracts/events.js

@@ -0,0 +1 @@
+export {};

package/dist/contracts/messages.d.ts

@@ -0,0 +1,159 @@
+export declare enum ViewerMessageType {
+    LANGUAGE_CHANGE = "viewer-language-change",
+    ZOOM = "viewer-zoom",
+    DRAW_MODE = "viewer-draw-mode",
+    EXPLODE = "viewer-explode",
+    MARKUP_ACTION = "viewer-markup-action",
+    MARKUP_SAVE = "viewer-markup-save",
+    MARKUP_CANCEL = "viewer-markup-cancel",
+    MARKUP_GET_LIST = "viewer-markup-get-list",
+    MARKUP_SAVE_RESULT = "viewer-markup-save-result",
+    MARKUP_CANCEL_RESULT = "viewer-markup-cancel-result",
+    MARKUP_LIST = "viewer-markup-list",
+    HOME = "viewer-home",
+    PAN_TOGGLE = "viewer-pan-toggle",
+    SELECT = "viewer-select",
+    AREA_SELECT = "viewer-area-select",
+    ORBIT = "viewer-orbit",
+    ROTATE_Z = "viewer-rotate-z",
+    WALK_THROUGH = "viewer-walk-through",
+    ZOOM_WINDOW = "viewer-zoom-window",
+    ZOOM_FIT = "viewer-zoom-fit",
+    TOOLBAR_CONFIG = "viewer-toolbar-config",
+    TOOLBAR_VISIBILITY = "viewer-toolbar-visibility",
+    PANEL_OPEN = "viewer-panel-open",
+    PANEL_CLOSE = "viewer-panel-close",
+    CUTTING_PLANE_ACTION = "viewer-cutting-plane-action",
+    SHEETS_GET_LIST = "viewer-sheets-get-list",
+    SHEETS_LIST = "viewer-sheets-list",
+    SHEETS_APPLY = "viewer-sheets-apply",
+    TREE_SELECT_NODE = "viewer-tree-select-node",
+    TREE_GET_NODE_IDS = "viewer-tree-get-node-ids",
+    TREE_NODE_IDS = "viewer-tree-node-ids",
+    PDF_PLAN_MODE = "viewer-pdf-plan-mode",
+    PDF_DOCUMENT_MODE = "viewer-pdf-document-mode",
+    PDF_FIRST_PAGE = "viewer-pdf-first-page",
+    PDF_PREVIOUS_PAGE = "viewer-pdf-previous-page",
+    PDF_NEXT_PAGE = "viewer-pdf-next-page",
+    PDF_LAST_PAGE = "viewer-pdf-last-page",
+    PDF_CURRENT_PAGE = "viewer-pdf-current-page",
+    HOME_CLICK = "viewer-home-click",
+    NODE_SELECT = "viewer-node-select",
+    PAN_CHANGE = "viewer-pan-change"
+}
+export declare enum ViewerMessageSource {
+    SDK = "HC_SDK",
+    VIEWER = "HC_VIEWER"
+}
+export declare type OutgoingMessage<T = unknown> = {
+    source: ViewerMessageSource.SDK;
+    type: ViewerMessageType;
+    payload?: T;
+};
+export declare type IncomingMessage<T = any> = {
+    source?: ViewerMessageSource | string;
+    type: ViewerMessageType;
+    payload?: T;
+};
+export declare type LanguageCode = "en" | "vn";
+export declare type LanguageChangePayload = {
+    language: LanguageCode;
+    timestamp?: number;
+};
+export declare type DrawModeValue = "shaded" | "wireframe" | "hidden-line" | "shaded-wire" | "xray" | "ghosting";
+export declare type DrawModePayload = {
+    mode: DrawModeValue;
+};
+export declare type ToolbarVisibilityTarget = "all" | "left" | "center" | "right";
+export declare type ToolbarVisibilityPayload = {
+    visible: boolean;
+    target?: ToolbarVisibilityTarget;
+};
+export declare type ExplodePayload = {
+    magnitude: number;
+};
+export declare type MarkupAction = "line" | "arrow" | "circle" | "ellipse" | "rectangle" | "polygon" | "polyline" | "textbox" | "note" | "callout" | "cloud" | "freehand";
+export declare type MarkupActionPayload = {
+    action: MarkupAction;
+};
+export declare type MarkupRequestPayload = {
+    requestId: string;
+};
+export declare type MarkupOperationResultPayload = {
+    requestId: string;
+    success: boolean;
+    timestamp: number;
+    error?: string;
+};
+export declare type MarkupListItem = {
+    id: string;
+    viewId: string;
+    viewName?: string;
+    title: string;
+    type: string;
+    shapeName?: string;
+    createdDate?: string;
+    modifiedDate?: string;
+    createdBy?: string;
+    lastModifiedBy?: string;
+};
+export declare type MarkupListPayload = {
+    requestId: string;
+    markups: MarkupListItem[];
+    timestamp: number;
+};
+export declare type PanelTarget = "clipping-commands" | "setting" | "statesObjects" | "linkedObjects" | "model-tree" | "sheets" | "object-properties";
+export declare type PanelOpenPayload = {
+    panel: PanelTarget;
+    format?: "3d" | "pdf";
+};
+export declare type PanelClosePayload = {
+    panel: PanelTarget;
+    format?: "3d" | "pdf";
+};
+export declare type CuttingPlaneAction = "close" | "multi" | "toggle-section" | "toggle-plane" | "plane-x" | "plane-y" | "plane-z" | "plane-box" | "rotate-box" | "reverse-plane-x" | "reverse-plane-y" | "reverse-plane-z";
+export declare type CuttingPlaneActionPayload = {
+    action: CuttingPlaneAction;
+};
+export declare type SheetsGetListPayload = {
+    requestId: string;
+};
+export declare type SheetListItem = {
+    id: string | number;
+    name: string;
+    is3D?: boolean;
+    viewId?: string;
+};
+export declare type SheetsListPayload = {
+    requestId: string;
+    sheets: SheetListItem[];
+    activeSheetId?: string | number | null;
+    timestamp: number;
+};
+export declare type SheetsApplyPayload = {
+    sheetId: string | number;
+};
+export declare type TreeSelectNodePayload = {
+    nodeId: string;
+};
+export declare type TreeGetNodeIdsPayload = {
+    requestId: string;
+    onlyRealNodes?: boolean;
+};
+export declare type TreeNodeIdsPayload = {
+    requestId: string;
+    nodeIds: string[];
+    timestamp: number;
+};
+export declare type PdfModeEventPayload = {
+    mode: "plan" | "document";
+    timestamp: number;
+};
+export declare type PdfToolbarActionEventPayload = {
+    timestamp: number;
+};
+export declare type PdfCurrentPagePayload = {
+    pageIndex: number;
+    pageNumber: number;
+    timestamp: number;
+};

package/dist/contracts/messages.js

@@ -0,0 +1,50 @@
+// sdk/src/contracts/messages.ts
+export var ViewerMessageType;
+(function (ViewerMessageType) {
+    ViewerMessageType["LANGUAGE_CHANGE"] = "viewer-language-change";
+    ViewerMessageType["ZOOM"] = "viewer-zoom";
+    ViewerMessageType["DRAW_MODE"] = "viewer-draw-mode";
+    ViewerMessageType["EXPLODE"] = "viewer-explode";
+    ViewerMessageType["MARKUP_ACTION"] = "viewer-markup-action";
+    ViewerMessageType["MARKUP_SAVE"] = "viewer-markup-save";
+    ViewerMessageType["MARKUP_CANCEL"] = "viewer-markup-cancel";
+    ViewerMessageType["MARKUP_GET_LIST"] = "viewer-markup-get-list";
+    ViewerMessageType["MARKUP_SAVE_RESULT"] = "viewer-markup-save-result";
+    ViewerMessageType["MARKUP_CANCEL_RESULT"] = "viewer-markup-cancel-result";
+    ViewerMessageType["MARKUP_LIST"] = "viewer-markup-list";
+    ViewerMessageType["HOME"] = "viewer-home";
+    ViewerMessageType["PAN_TOGGLE"] = "viewer-pan-toggle";
+    ViewerMessageType["SELECT"] = "viewer-select";
+    ViewerMessageType["AREA_SELECT"] = "viewer-area-select";
+    ViewerMessageType["ORBIT"] = "viewer-orbit";
+    ViewerMessageType["ROTATE_Z"] = "viewer-rotate-z";
+    ViewerMessageType["WALK_THROUGH"] = "viewer-walk-through";
+    ViewerMessageType["ZOOM_WINDOW"] = "viewer-zoom-window";
+    ViewerMessageType["ZOOM_FIT"] = "viewer-zoom-fit";
+    ViewerMessageType["TOOLBAR_CONFIG"] = "viewer-toolbar-config";
+    ViewerMessageType["TOOLBAR_VISIBILITY"] = "viewer-toolbar-visibility";
+    ViewerMessageType["PANEL_OPEN"] = "viewer-panel-open";
+    ViewerMessageType["PANEL_CLOSE"] = "viewer-panel-close";
+    ViewerMessageType["CUTTING_PLANE_ACTION"] = "viewer-cutting-plane-action";
+    ViewerMessageType["SHEETS_GET_LIST"] = "viewer-sheets-get-list";
+    ViewerMessageType["SHEETS_LIST"] = "viewer-sheets-list";
+    ViewerMessageType["SHEETS_APPLY"] = "viewer-sheets-apply";
+    ViewerMessageType["TREE_SELECT_NODE"] = "viewer-tree-select-node";
+    ViewerMessageType["TREE_GET_NODE_IDS"] = "viewer-tree-get-node-ids";
+    ViewerMessageType["TREE_NODE_IDS"] = "viewer-tree-node-ids";
+    ViewerMessageType["PDF_PLAN_MODE"] = "viewer-pdf-plan-mode";
+    ViewerMessageType["PDF_DOCUMENT_MODE"] = "viewer-pdf-document-mode";
+    ViewerMessageType["PDF_FIRST_PAGE"] = "viewer-pdf-first-page";
+    ViewerMessageType["PDF_PREVIOUS_PAGE"] = "viewer-pdf-previous-page";
+    ViewerMessageType["PDF_NEXT_PAGE"] = "viewer-pdf-next-page";
+    ViewerMessageType["PDF_LAST_PAGE"] = "viewer-pdf-last-page";
+    ViewerMessageType["PDF_CURRENT_PAGE"] = "viewer-pdf-current-page";
+    ViewerMessageType["HOME_CLICK"] = "viewer-home-click";
+    ViewerMessageType["NODE_SELECT"] = "viewer-node-select";
+    ViewerMessageType["PAN_CHANGE"] = "viewer-pan-change";
+})(ViewerMessageType || (ViewerMessageType = {}));
+export var ViewerMessageSource;
+(function (ViewerMessageSource) {
+    ViewerMessageSource["SDK"] = "HC_SDK";
+    ViewerMessageSource["VIEWER"] = "HC_VIEWER";
+})(ViewerMessageSource || (ViewerMessageSource = {}));

package/dist/core/emitter.d.ts

@@ -0,0 +1,7 @@
+export declare class Emitter<EventMap extends Record<string, any>> {
+    private listeners;
+    on<K extends keyof EventMap>(event: K, cb: (payload: EventMap[K]) => void): () => void;
+    off<K extends keyof EventMap>(event: K, cb: (payload: EventMap[K]) => void): void;
+    emit<K extends keyof EventMap>(event: K, payload: EventMap[K]): void;
+    clear(): void;
+}

package/dist/core/emitter.js

@@ -0,0 +1,31 @@
+// sdk/src/core/emitter.ts
+export class Emitter {
+    constructor() {
+        this.listeners = {};
+    }
+    on(event, cb) {
+        if (!this.listeners[event]) {
+            this.listeners[event] = [];
+        }
+        const arr = this.listeners[event];
+        arr.push(cb);
+        return () => this.off(event, cb);
+    }
+    off(event, cb) {
+        const arr = this.listeners[event];
+        if (!arr)
+            return;
+        const idx = arr.indexOf(cb);
+        if (idx >= 0)
+            arr.splice(idx, 1);
+        if (arr.length === 0)
+            delete this.listeners[event];
+    }
+    emit(event, payload) {
+        var _a;
+        (_a = this.listeners[event]) === null || _a === void 0 ? void 0 : _a.forEach((cb) => cb(payload));
+    }
+    clear() {
+        this.listeners = {};
+    }
+}

package/dist/index.d.mts

@@ -36,6 +36,8 @@ declare enum ViewerMessageType {
     TREE_SELECT_NODE = "viewer-tree-select-node",
     TREE_GET_NODE_IDS = "viewer-tree-get-node-ids",
     TREE_NODE_IDS = "viewer-tree-node-ids",
+    TREE_GET_NODES = "viewer-tree-get-nodes",
+    TREE_NODES = "viewer-tree-nodes",
     PDF_PLAN_MODE = "viewer-pdf-plan-mode",
     PDF_DOCUMENT_MODE = "viewer-pdf-document-mode",
     PDF_FIRST_PAGE = "viewer-pdf-first-page",
@@ -91,6 +93,19 @@ type StateObjectItem = {
         type: string;
     };
 };
+type TreeNodeItem = {
+    id: string;
+    name: string;
+    type: number;
+    parent?: string;
+    childs?: string[];
+    modelFileId?: string;
+    persistentId?: string;
+    categoryName?: string;
+    familyName?: string;
+    typeName?: string;
+    isRealNode: boolean;
+};
 type PdfModeEventPayload = {
     mode: "plan" | "document";
     timestamp: number;
@@ -127,6 +142,12 @@ type ViewerEventMap = {
         nodeIds: string[];
         timestamp: number;
     };
+    "modelTree:nodes": {
+        requestId: string;
+        nodes: TreeNodeItem[];
+        rootNodeIds?: string[];
+        timestamp: number;
+    };
     "sheets:list": {
         requestId: string;
         sheets: {
@@ -237,8 +258,7 @@ declare class InteractionModule {
         }) => void) => () => void;
     };
     constructor(viewer: Viewer3D);
-    enablePan(): void;
-    disablePan(): void;
+    pan(): void;
     select(): void;
     areaSelect(): void;
     orbit(): void;
@@ -281,8 +301,8 @@ type ConvertV2Options = {
     filename: string;
     originalFilePath: string;
     downloadUrl: string;
-    workflowId: string;
-    taskId: string;
+    workflowId?: string;
+    taskId?: string;
     baseFileId: string;
     baseMajorRev?: number;
     baseMinorRev?: number;
@@ -476,16 +496,30 @@ declare class ToolbarModule {
     private postStatesObjectsGetList;
 }
 
-type GetNodeIdsOptions = {
+type ModelTreeRequestOptions = {
     onlyRealNodes?: boolean;
     timeoutMs?: number;
 };
+type GetNodeIdsOptions = ModelTreeRequestOptions;
+type GetNodesOptions = ModelTreeRequestOptions;
+type ModelTreeNode = TreeNodeItem;
+type ModelTreeHierarchyNode = ModelTreeNode & {
+    children: ModelTreeHierarchyNode[];
+};
 declare class ModelTreeModule {
     private viewer;
     constructor(viewer: Viewer3D);
     open(): void;
     selectNode(nodeId: string | number): void;
     getNodeIds(options?: GetNodeIdsOptions): Promise<string[]>;
+    getNodes(options?: GetNodesOptions): Promise<ModelTreeNode[]>;
+    getTree(options?: GetNodesOptions): Promise<ModelTreeHierarchyNode[]>;
+    private requestNodes;
+    private resolveTimeoutMs;
+    private postPanelOpen;
+    private postTreeSelectNode;
+    private postTreeGetNodeIds;
+    private postTreeGetNodes;
 }
 
 type MarkupRequestOptions = {

package/dist/index.d.ts

@@ -36,6 +36,8 @@ declare enum ViewerMessageType {
     TREE_SELECT_NODE = "viewer-tree-select-node",
     TREE_GET_NODE_IDS = "viewer-tree-get-node-ids",
     TREE_NODE_IDS = "viewer-tree-node-ids",
+    TREE_GET_NODES = "viewer-tree-get-nodes",
+    TREE_NODES = "viewer-tree-nodes",
     PDF_PLAN_MODE = "viewer-pdf-plan-mode",
     PDF_DOCUMENT_MODE = "viewer-pdf-document-mode",
     PDF_FIRST_PAGE = "viewer-pdf-first-page",
@@ -91,6 +93,19 @@ type StateObjectItem = {
         type: string;
     };
 };
+type TreeNodeItem = {
+    id: string;
+    name: string;
+    type: number;
+    parent?: string;
+    childs?: string[];
+    modelFileId?: string;
+    persistentId?: string;
+    categoryName?: string;
+    familyName?: string;
+    typeName?: string;
+    isRealNode: boolean;
+};
 type PdfModeEventPayload = {
     mode: "plan" | "document";
     timestamp: number;
@@ -127,6 +142,12 @@ type ViewerEventMap = {
         nodeIds: string[];
         timestamp: number;
     };
+    "modelTree:nodes": {
+        requestId: string;
+        nodes: TreeNodeItem[];
+        rootNodeIds?: string[];
+        timestamp: number;
+    };
     "sheets:list": {
         requestId: string;
         sheets: {
@@ -237,8 +258,7 @@ declare class InteractionModule {
         }) => void) => () => void;
     };
     constructor(viewer: Viewer3D);
-    enablePan(): void;
-    disablePan(): void;
+    pan(): void;
     select(): void;
     areaSelect(): void;
     orbit(): void;
@@ -281,8 +301,8 @@ type ConvertV2Options = {
     filename: string;
     originalFilePath: string;
     downloadUrl: string;
-    workflowId: string;
-    taskId: string;
+    workflowId?: string;
+    taskId?: string;
     baseFileId: string;
     baseMajorRev?: number;
     baseMinorRev?: number;
@@ -476,16 +496,30 @@ declare class ToolbarModule {
     private postStatesObjectsGetList;
 }
 
-type GetNodeIdsOptions = {
+type ModelTreeRequestOptions = {
     onlyRealNodes?: boolean;
     timeoutMs?: number;
 };
+type GetNodeIdsOptions = ModelTreeRequestOptions;
+type GetNodesOptions = ModelTreeRequestOptions;
+type ModelTreeNode = TreeNodeItem;
+type ModelTreeHierarchyNode = ModelTreeNode & {
+    children: ModelTreeHierarchyNode[];
+};
 declare class ModelTreeModule {
     private viewer;
     constructor(viewer: Viewer3D);
     open(): void;
     selectNode(nodeId: string | number): void;
     getNodeIds(options?: GetNodeIdsOptions): Promise<string[]>;
+    getNodes(options?: GetNodesOptions): Promise<ModelTreeNode[]>;
+    getTree(options?: GetNodesOptions): Promise<ModelTreeHierarchyNode[]>;
+    private requestNodes;
+    private resolveTimeoutMs;
+    private postPanelOpen;
+    private postTreeSelectNode;
+    private postTreeGetNodeIds;
+    private postTreeGetNodes;
 }
 
 type MarkupRequestOptions = {