3dviewer-sdk 1.0.11 → 1.0.13

package/dist/index.d.mts

@@ -20,13 +20,19 @@ declare enum ViewerMessageType {
     ZOOM_WINDOW = "viewer-zoom-window",
     ZOOM_FIT = "viewer-zoom-fit",
     TOOLBAR_CONFIG = "viewer-toolbar-config",
-    TOOLBAR_VISIBILITY = "viewer-toolbar-visibility",
+    TOOLBAR_USE = "viewer-toolbar-use",
     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",
+    OBJECT_PROPERTIES_GET_LIST = "viewer-object-properties-get-list",
+    OBJECT_PROPERTIES_LIST = "viewer-object-properties-list",
+    LINKED_OBJECTS_GET_LIST = "viewer-linked-objects-get-list",
+    LINKED_OBJECTS_LIST = "viewer-linked-objects-list",
+    STATES_OBJECTS_GET_LIST = "viewer-states-objects-get-list",
+    STATES_OBJECTS_LIST = "viewer-states-objects-list",
     TREE_SELECT_NODE = "viewer-tree-select-node",
     TREE_GET_NODE_IDS = "viewer-tree-get-node-ids",
     TREE_NODE_IDS = "viewer-tree-node-ids",
@@ -42,7 +48,7 @@ declare enum ViewerMessageType {
     PAN_CHANGE = "viewer-pan-change"
 }
 type LanguageCode = "en" | "vn";
-type ToolbarVisibilityTarget = "all" | "left" | "center" | "right";
+type ToolbarUseTarget = "all" | "left" | "center" | "right";
 type MarkupAction = "line" | "arrow" | "circle" | "ellipse" | "rectangle" | "polygon" | "polyline" | "textbox" | "note" | "callout" | "cloud" | "freehand";
 type MarkupOperationResultPayload = {
     requestId: string;
@@ -62,12 +68,29 @@ type MarkupListItem = {
     createdBy?: string;
     lastModifiedBy?: string;
 };
+type PanelTarget = "clipping-commands" | "setting" | "statesObjects" | "linkedObjects" | "model-tree" | "sheets" | "object-properties";
 type SheetListItem = {
     id: string | number;
     name: string;
     is3D?: boolean;
     viewId?: string;
 };
+type ObjectPropertyItem = Record<string, unknown>;
+type LinkedObjectItem = Record<string, unknown>;
+type StateObjectRefItem = {
+    name: string;
+    id: number;
+};
+type StateObjectItem = {
+    id: string;
+    name: string;
+    char: string;
+    object: StateObjectRefItem[];
+    states: {
+        color: string;
+        type: string;
+    };
+};
 type PdfModeEventPayload = {
     mode: "plan" | "document";
     timestamp: number;
@@ -115,6 +138,21 @@ type ViewerEventMap = {
         activeSheetId?: string | number | null;
         timestamp: number;
     };
+    "object-properties:list": {
+        requestId: string;
+        properties: ObjectPropertyItem[];
+        timestamp: number;
+    };
+    "linked-objects:list": {
+        requestId: string;
+        linkedObjects: LinkedObjectItem[];
+        timestamp: number;
+    };
+    "states-objects:list": {
+        requestId: string;
+        statesObjects: StateObjectItem[];
+        timestamp: number;
+    };
     "markup:list": {
         requestId: string;
         markups: MarkupListItem[];
@@ -320,6 +358,7 @@ declare class FilesModule {
     private normalizeBaseUrl;
     private resolveBaseUrl;
     private resolveViewerPath;
+    private normalizeSdkViewerPath;
     private resolveViewerOrigin;
     private resolveHostConversion;
     private getUploadPath;
@@ -340,6 +379,7 @@ declare class FilesModule {
     private toErrorMessage;
 }
 
+type ToolbarFormat = "3d" | "pdf";
 type GetSheetsOptions = {
     timeoutMs?: number;
 };
@@ -381,15 +421,11 @@ declare class ToolbarModule {
     disableAllPdf(): void;
     enableAll3D(): void;
     enableAllPdf(): void;
-    hideToolbar(): void;
-    showToolbar(): void;
-    setToolbarVisible(visible: boolean, target?: ToolbarVisibilityTarget): void;
-    hideLeftToolbar(): void;
-    showLeftToolbar(): void;
-    hideCenterToolbar(): void;
-    showCenterToolbar(): void;
-    hideRightToolbar(): void;
-    showRightToolbar(): void;
+    useToolbar(target?: ToolbarUseTarget): void;
+    useLeftToolbar(): void;
+    useCenterToolbar(): void;
+    useRightToolbar(): void;
+    usePanel(panel: PanelTarget, format?: ToolbarFormat): void;
     openClippingPlanes(): void;
     closeClippingPlanes(): void;
     openSetting(): void;
@@ -409,6 +445,9 @@ declare class ToolbarModule {
     openSheets(): void;
     closeSheets(): void;
     getSheets(options?: GetSheetsOptions): Promise<SheetListItem[]>;
+    getObjectProperties(options?: GetSheetsOptions): Promise<ObjectPropertyItem[]>;
+    getLinkedObjects(options?: GetSheetsOptions): Promise<LinkedObjectItem[]>;
+    getStatesObjects(options?: GetSheetsOptions): Promise<StateObjectItem[]>;
     applySheet(sheetId: string | number): void;
     cuttingCloseSections(): void;
     cuttingMultipleSides(): void;
@@ -423,12 +462,15 @@ declare class ToolbarModule {
     cuttingReversePlaneY(): void;
     cuttingReversePlaneZ(): void;
     private postConfig;
-    private postToolbarVisibility;
+    private postToolbarUse;
     private postPanelOpen;
     private postPanelClose;
     private postCuttingAction;
     private postSheetsGetList;
     private postSheetsApply;
+    private postObjectPropertiesGetList;
+    private postLinkedObjectsGetList;
+    private postStatesObjectsGetList;
 }
 
 type GetNodeIdsOptions = {
@@ -475,7 +517,7 @@ declare class LanguageModule {
     set(language: LanguageCode): void;
 }
 
-type InitialToolbarVisibility = Partial<Record<ToolbarVisibilityTarget, boolean>>;
+type InitialToolbarUse = ToolbarUseTarget | ToolbarUseTarget[] | Partial<Record<ToolbarUseTarget, boolean>>;
 type Viewer3DOptions = {
     container: HTMLElement | string;
     url?: string;
@@ -483,7 +525,7 @@ type Viewer3DOptions = {
     viewerPath?: string;
     uploadPath?: string;
     file?: File;
-    initialToolbarVisibility?: InitialToolbarVisibility;
+    initialToolbar?: InitialToolbarUse;
     width?: string;
     height?: string;
     sandbox?: string;
@@ -513,6 +555,7 @@ declare class Viewer3D {
     destroy(): void;
     private ensureInit;
     private withInitialOptions;
+    private normalizeInitialToolbar;
     _on<K extends SdkEventKey>(event: K, cb: (payload: SdkEventPayload<K>) => void): () => void;
     _off<K extends SdkEventKey>(event: K, cb: (payload: SdkEventPayload<K>) => void): void;
     _emit<K extends SdkEventKey>(event: K, payload: SdkEventPayload<K>): void;
@@ -520,4 +563,4 @@ declare class Viewer3D {
     private handleMessage;
 }
 
-export { type ConvertOptions, type ConvertV2Options, type FileInfoCheckInput, type FileInfoCheckPayloadItem, type FilesConfig, type InitialToolbarVisibility, type LanguageCode, type LoadStage, type LoadStatePayload, type MarkupAction, type MarkupListItem, type MarkupOperationResultPayload, type PreparedViewerData, Viewer3D };
+export { type ConvertOptions, type ConvertV2Options, type FileInfoCheckInput, type FileInfoCheckPayloadItem, type FilesConfig, type InitialToolbarUse, type LanguageCode, type LoadStage, type LoadStatePayload, type MarkupAction, type MarkupListItem, type MarkupOperationResultPayload, type PreparedViewerData, Viewer3D };

package/dist/index.d.ts

@@ -20,13 +20,19 @@ declare enum ViewerMessageType {
     ZOOM_WINDOW = "viewer-zoom-window",
     ZOOM_FIT = "viewer-zoom-fit",
     TOOLBAR_CONFIG = "viewer-toolbar-config",
-    TOOLBAR_VISIBILITY = "viewer-toolbar-visibility",
+    TOOLBAR_USE = "viewer-toolbar-use",
     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",
+    OBJECT_PROPERTIES_GET_LIST = "viewer-object-properties-get-list",
+    OBJECT_PROPERTIES_LIST = "viewer-object-properties-list",
+    LINKED_OBJECTS_GET_LIST = "viewer-linked-objects-get-list",
+    LINKED_OBJECTS_LIST = "viewer-linked-objects-list",
+    STATES_OBJECTS_GET_LIST = "viewer-states-objects-get-list",
+    STATES_OBJECTS_LIST = "viewer-states-objects-list",
     TREE_SELECT_NODE = "viewer-tree-select-node",
     TREE_GET_NODE_IDS = "viewer-tree-get-node-ids",
     TREE_NODE_IDS = "viewer-tree-node-ids",
@@ -42,7 +48,7 @@ declare enum ViewerMessageType {
     PAN_CHANGE = "viewer-pan-change"
 }
 type LanguageCode = "en" | "vn";
-type ToolbarVisibilityTarget = "all" | "left" | "center" | "right";
+type ToolbarUseTarget = "all" | "left" | "center" | "right";
 type MarkupAction = "line" | "arrow" | "circle" | "ellipse" | "rectangle" | "polygon" | "polyline" | "textbox" | "note" | "callout" | "cloud" | "freehand";
 type MarkupOperationResultPayload = {
     requestId: string;
@@ -62,12 +68,29 @@ type MarkupListItem = {
     createdBy?: string;
     lastModifiedBy?: string;
 };
+type PanelTarget = "clipping-commands" | "setting" | "statesObjects" | "linkedObjects" | "model-tree" | "sheets" | "object-properties";
 type SheetListItem = {
     id: string | number;
     name: string;
     is3D?: boolean;
     viewId?: string;
 };
+type ObjectPropertyItem = Record<string, unknown>;
+type LinkedObjectItem = Record<string, unknown>;
+type StateObjectRefItem = {
+    name: string;
+    id: number;
+};
+type StateObjectItem = {
+    id: string;
+    name: string;
+    char: string;
+    object: StateObjectRefItem[];
+    states: {
+        color: string;
+        type: string;
+    };
+};
 type PdfModeEventPayload = {
     mode: "plan" | "document";
     timestamp: number;
@@ -115,6 +138,21 @@ type ViewerEventMap = {
         activeSheetId?: string | number | null;
         timestamp: number;
     };
+    "object-properties:list": {
+        requestId: string;
+        properties: ObjectPropertyItem[];
+        timestamp: number;
+    };
+    "linked-objects:list": {
+        requestId: string;
+        linkedObjects: LinkedObjectItem[];
+        timestamp: number;
+    };
+    "states-objects:list": {
+        requestId: string;
+        statesObjects: StateObjectItem[];
+        timestamp: number;
+    };
     "markup:list": {
         requestId: string;
         markups: MarkupListItem[];
@@ -320,6 +358,7 @@ declare class FilesModule {
     private normalizeBaseUrl;
     private resolveBaseUrl;
     private resolveViewerPath;
+    private normalizeSdkViewerPath;
     private resolveViewerOrigin;
     private resolveHostConversion;
     private getUploadPath;
@@ -340,6 +379,7 @@ declare class FilesModule {
     private toErrorMessage;
 }
 
+type ToolbarFormat = "3d" | "pdf";
 type GetSheetsOptions = {
     timeoutMs?: number;
 };
@@ -381,15 +421,11 @@ declare class ToolbarModule {
     disableAllPdf(): void;
     enableAll3D(): void;
     enableAllPdf(): void;
-    hideToolbar(): void;
-    showToolbar(): void;
-    setToolbarVisible(visible: boolean, target?: ToolbarVisibilityTarget): void;
-    hideLeftToolbar(): void;
-    showLeftToolbar(): void;
-    hideCenterToolbar(): void;
-    showCenterToolbar(): void;
-    hideRightToolbar(): void;
-    showRightToolbar(): void;
+    useToolbar(target?: ToolbarUseTarget): void;
+    useLeftToolbar(): void;
+    useCenterToolbar(): void;
+    useRightToolbar(): void;
+    usePanel(panel: PanelTarget, format?: ToolbarFormat): void;
     openClippingPlanes(): void;
     closeClippingPlanes(): void;
     openSetting(): void;
@@ -409,6 +445,9 @@ declare class ToolbarModule {
     openSheets(): void;
     closeSheets(): void;
     getSheets(options?: GetSheetsOptions): Promise<SheetListItem[]>;
+    getObjectProperties(options?: GetSheetsOptions): Promise<ObjectPropertyItem[]>;
+    getLinkedObjects(options?: GetSheetsOptions): Promise<LinkedObjectItem[]>;
+    getStatesObjects(options?: GetSheetsOptions): Promise<StateObjectItem[]>;
     applySheet(sheetId: string | number): void;
     cuttingCloseSections(): void;
     cuttingMultipleSides(): void;
@@ -423,12 +462,15 @@ declare class ToolbarModule {
     cuttingReversePlaneY(): void;
     cuttingReversePlaneZ(): void;
     private postConfig;
-    private postToolbarVisibility;
+    private postToolbarUse;
     private postPanelOpen;
     private postPanelClose;
     private postCuttingAction;
     private postSheetsGetList;
     private postSheetsApply;
+    private postObjectPropertiesGetList;
+    private postLinkedObjectsGetList;
+    private postStatesObjectsGetList;
 }
 
 type GetNodeIdsOptions = {
@@ -475,7 +517,7 @@ declare class LanguageModule {
     set(language: LanguageCode): void;
 }
 
-type InitialToolbarVisibility = Partial<Record<ToolbarVisibilityTarget, boolean>>;
+type InitialToolbarUse = ToolbarUseTarget | ToolbarUseTarget[] | Partial<Record<ToolbarUseTarget, boolean>>;
 type Viewer3DOptions = {
     container: HTMLElement | string;
     url?: string;
@@ -483,7 +525,7 @@ type Viewer3DOptions = {
     viewerPath?: string;
     uploadPath?: string;
     file?: File;
-    initialToolbarVisibility?: InitialToolbarVisibility;
+    initialToolbar?: InitialToolbarUse;
     width?: string;
     height?: string;
     sandbox?: string;
@@ -513,6 +555,7 @@ declare class Viewer3D {
     destroy(): void;
     private ensureInit;
     private withInitialOptions;
+    private normalizeInitialToolbar;
     _on<K extends SdkEventKey>(event: K, cb: (payload: SdkEventPayload<K>) => void): () => void;
     _off<K extends SdkEventKey>(event: K, cb: (payload: SdkEventPayload<K>) => void): void;
     _emit<K extends SdkEventKey>(event: K, payload: SdkEventPayload<K>): void;
@@ -520,4 +563,4 @@ declare class Viewer3D {
     private handleMessage;
 }
 
-export { type ConvertOptions, type ConvertV2Options, type FileInfoCheckInput, type FileInfoCheckPayloadItem, type FilesConfig, type InitialToolbarVisibility, type LanguageCode, type LoadStage, type LoadStatePayload, type MarkupAction, type MarkupListItem, type MarkupOperationResultPayload, type PreparedViewerData, Viewer3D };
+export { type ConvertOptions, type ConvertV2Options, type FileInfoCheckInput, type FileInfoCheckPayloadItem, type FilesConfig, type InitialToolbarUse, type LanguageCode, type LoadStage, type LoadStatePayload, type MarkupAction, type MarkupListItem, type MarkupOperationResultPayload, type PreparedViewerData, Viewer3D };