3dviewer-sdk 1.0.0 → 1.0.1

package/dist/index.d.mts

@@ -1,239 +1,415 @@
-type ViewerEventMap = {
-    "camera:home": {
-        timestamp: number;
-    };
-    "node:select": {
-        nodeId: string;
-        timestamp: number;
-    };
-    "interaction:pan-change": {
-        enabled: boolean;
-    };
-};
-type LoadStage = "idle" | "uploading" | "converting" | "rendering" | "completed" | "error";
-type LoadStatePayload = {
-    isLoading: boolean;
-    stage: LoadStage;
-    message?: string;
-    elapsedMs?: number;
-};
-type PreparedViewerData = {
-    baseFileId: string;
-    baseMajorRev: number;
-    baseMinorRev: number;
-    fileName: string;
-    query: string;
-    url: string;
-};
-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;
-    };
-};
-type SdkEventMap = ViewerEventMap & FilesEventMap;
-type SdkEventKey = keyof SdkEventMap;
-type SdkEventPayload<K extends SdkEventKey> = SdkEventMap[K];
-
-declare class CameraModule {
-    private viewer;
-    on: {
-        home: (cb: (payload: {
-            timestamp: number;
-        }) => void) => () => void;
-    };
-    constructor(viewer: HcViewer);
-    zoomIn(percent: number): void;
-    zoomOut(percent: number): void;
-    home(): void;
-}
-
-declare class InteractionModule {
-    private viewer;
-    on: {
-        panChange: (cb: (payload: {
-            enabled: boolean;
-        }) => void) => () => void;
-    };
-    constructor(viewer: HcViewer);
-    enablePan(): void;
-    disablePan(): void;
-}
-
-declare class NodeModule {
-    private viewer;
-    on: {
-        select: (cb: (payload: {
-            nodeId: string;
-            timestamp: number;
-        }) => void) => () => void;
-    };
-    constructor(viewer: HcViewer);
-}
-
-type FilesConfig = {
-    baseUrl?: string;
-    viewerPath?: string;
-    uploadPath?: string;
-    notify?: boolean | {
-        success?: boolean;
-        error?: boolean;
-    };
-};
-declare class FilesModule {
-    private viewer;
-    on: {
-        state: (cb: (payload: LoadStatePayload) => void) => () => void;
-        uploadStart: (cb: (payload: {
-            fileName: string;
-        }) => void) => () => void;
-        uploadSuccess: (cb: (payload: {
-            fileName: string;
-            baseFileId: string;
-        }) => void) => () => void;
-        uploadError: (cb: (payload: {
-            fileName: string;
-            error: string;
-        }) => void) => () => void;
-        conversionStart: (cb: (payload: {
-            fileName: string;
-        }) => void) => () => void;
-        conversionSuccess: (cb: (payload: PreparedViewerData) => void) => () => void;
-        conversionError: (cb: (payload: {
-            fileName: string;
-            error: string;
-        }) => void) => () => void;
-        renderStart: (cb: (payload: {
-            url: string;
-        }) => void) => () => void;
-        renderSuccess: (cb: (payload: {
-            url: string;
-        }) => void) => () => void;
-        renderError: (cb: (payload: {
-            url?: string;
-            error: string;
-        }) => void) => () => void;
-        loadSuccess: (cb: (payload: PreparedViewerData) => void) => () => void;
-        loadError: (cb: (payload: {
-            error: string;
-        }) => void) => () => void;
-    };
-    private config;
-    private operationStartTime;
-    private state;
-    private lastUploadSession;
-    constructor(viewer: HcViewer);
-    setConfig(next: FilesConfig): void;
-    getState(): LoadStatePayload;
-    upload(file?: File): Promise<{
-        fileName: string;
-        baseFileId: string;
-    }>;
-    convert(file?: File): Promise<PreparedViewerData>;
-    prepare(file?: File): Promise<PreparedViewerData>;
-    open(input: PreparedViewerData | {
-        url: string;
-    }): void;
-    render(file?: File): Promise<PreparedViewerData>;
-    private resolveFile;
-    private normalizeBaseUrl;
-    private resolveBaseUrl;
-    private resolveViewerPath;
-    private resolveViewerOrigin;
-    private resolveHostConversion;
-    private getUploadPath;
-    private fileSignature;
-    private createBaseFileId;
-    private createUploadSession;
-    private getUploadSessionForFile;
-    private uploadInternal;
-    private buildCachePayload;
-    private cacheFile;
-    private convertInternal;
-    private updateState;
-    private withOperation;
-    private toErrorMessage;
-}
-
-declare enum ViewerMessageType {
-    ZOOM = "viewer-zoom",
-    HOME = "viewer-home",
-    PAN_TOGGLE = "viewer-pan-toggle",
-    HOME_CLICK = "viewer-home-click",
-    NODE_SELECT = "viewer-node-select",
-    PAN_CHANGE = "viewer-pan-change"
-}
-
-type HcViewerOptions = {
-    container: HTMLElement | string;
-    url?: string;
-    baseUrl?: string;
-    viewerPath?: string;
-    uploadPath?: string;
-    file?: File;
-    notify?: boolean | {
-        success?: boolean;
-        error?: boolean;
-    };
-    width?: string;
-    height?: string;
-    sandbox?: string;
-    allowedOrigin?: string;
-};
-declare class HcViewer {
-    private options;
-    private containerEl;
-    private iframeEl;
-    private initialized;
-    private emitter;
-    camera: CameraModule;
-    interaction: InteractionModule;
-    node: NodeModule;
-    files: FilesModule;
-    constructor(options: HcViewerOptions);
-    getOptions(): HcViewerOptions;
-    patchOptions(next: Partial<HcViewerOptions>): void;
-    getUrl(): string | null;
-    init(): void;
-    render(file?: File): Promise<PreparedViewerData | void>;
-    open(url: string): void;
-    destroy(): void;
-    private ensureInit;
-    _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;
-    postToViewer<TPayload = unknown>(type: ViewerMessageType, payload?: TPayload): void;
-    private handleMessage;
-}
-
-export { type FilesConfig, HcViewer, type LoadStage, type LoadStatePayload, type PreparedViewerData };
+declare enum ViewerMessageType {
+    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",
+    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",
+    HOME_CLICK = "viewer-home-click",
+    NODE_SELECT = "viewer-node-select",
+    PAN_CHANGE = "viewer-pan-change"
+}
+type MarkupAction = "line" | "arrow" | "circle" | "ellipse" | "rectangle" | "polygon" | "polyline" | "textbox" | "note" | "callout" | "cloud" | "freehand";
+type MarkupOperationResultPayload = {
+    requestId: string;
+    success: boolean;
+    timestamp: number;
+    error?: string;
+};
+type MarkupListItem = {
+    id: string;
+    viewId: string;
+    viewName?: string;
+    title: string;
+    type: string;
+    shapeName?: string;
+    createdDate?: string;
+    modifiedDate?: string;
+    createdBy?: string;
+    lastModifiedBy?: string;
+};
+type SheetListItem = {
+    id: string | number;
+    name: string;
+    is3D?: boolean;
+    viewId?: string;
+};
+
+type ViewerEventMap = {
+    "camera:home": {
+        timestamp: number;
+    };
+    "node:select": {
+        nodeId: string;
+        timestamp: number;
+    };
+    "interaction:pan-change": {
+        enabled: boolean;
+    };
+    "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;
+};
+type LoadStage = "idle" | "uploading" | "converting" | "rendering" | "completed" | "error";
+type LoadStatePayload = {
+    isLoading: boolean;
+    stage: LoadStage;
+    message?: string;
+    elapsedMs?: number;
+};
+type PreparedViewerData = {
+    baseFileId: string;
+    baseMajorRev: number;
+    baseMinorRev: number;
+    fileName: string;
+    query: string;
+    url: string;
+};
+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;
+    };
+};
+type SdkEventMap = ViewerEventMap & FilesEventMap;
+type SdkEventKey = keyof SdkEventMap;
+type SdkEventPayload<K extends SdkEventKey> = SdkEventMap[K];
+
+declare class CameraModule {
+    private viewer;
+    on: {
+        home: (cb: (payload: {
+            timestamp: number;
+        }) => void) => () => void;
+    };
+    constructor(viewer: Viewer3D);
+    zoomIn(percent: number): void;
+    zoomOut(percent: number): void;
+    home(): void;
+}
+
+declare class InteractionModule {
+    private viewer;
+    on: {
+        panChange: (cb: (payload: {
+            enabled: boolean;
+        }) => void) => () => void;
+    };
+    constructor(viewer: Viewer3D);
+    enablePan(): void;
+    disablePan(): void;
+    select(): void;
+    areaSelect(): void;
+    orbit(): void;
+    rotateZ(): void;
+    walkThrough(): void;
+    zoomWindow(): void;
+    zoomFit(): void;
+    drawModeShaded(): void;
+    drawModeWireframe(): void;
+    drawModeHiddenLine(): void;
+    drawModeShadedWire(): void;
+    drawModeXRay(): void;
+    drawModeGhosting(): void;
+    explode(magnitude: number): void;
+    explodeOff(): void;
+    private setDrawMode;
+}
+
+declare class NodeModule {
+    private viewer;
+    on: {
+        select: (cb: (payload: {
+            nodeId: string;
+            timestamp: number;
+        }) => void) => () => void;
+    };
+    constructor(viewer: Viewer3D);
+}
+
+type FilesConfig = {
+    baseUrl?: string;
+    viewerPath?: string;
+    uploadPath?: string;
+};
+declare class FilesModule {
+    private viewer;
+    on: {
+        state: (cb: (payload: LoadStatePayload) => void) => () => void;
+        uploadStart: (cb: (payload: {
+            fileName: string;
+        }) => void) => () => void;
+        uploadSuccess: (cb: (payload: {
+            fileName: string;
+            baseFileId: string;
+        }) => void) => () => void;
+        uploadError: (cb: (payload: {
+            fileName: string;
+            error: string;
+        }) => void) => () => void;
+        conversionStart: (cb: (payload: {
+            fileName: string;
+        }) => void) => () => void;
+        conversionSuccess: (cb: (payload: PreparedViewerData) => void) => () => void;
+        conversionError: (cb: (payload: {
+            fileName: string;
+            error: string;
+        }) => void) => () => void;
+        renderStart: (cb: (payload: {
+            url: string;
+        }) => void) => () => void;
+        renderSuccess: (cb: (payload: {
+            url: string;
+        }) => void) => () => void;
+        renderError: (cb: (payload: {
+            url?: string;
+            error: string;
+        }) => void) => () => void;
+        loadSuccess: (cb: (payload: PreparedViewerData) => void) => () => void;
+        loadError: (cb: (payload: {
+            error: string;
+        }) => void) => () => void;
+    };
+    private config;
+    private operationStartTime;
+    private state;
+    private lastUploadSession;
+    constructor(viewer: Viewer3D);
+    setConfig(next: FilesConfig): void;
+    getState(): LoadStatePayload;
+    upload(file?: File): Promise<{
+        fileName: string;
+        baseFileId: string;
+    }>;
+    convert(file?: File): Promise<PreparedViewerData>;
+    prepare(file?: File): Promise<PreparedViewerData>;
+    open(input: PreparedViewerData | {
+        url: string;
+    }): void;
+    render(file?: File): Promise<PreparedViewerData>;
+    private resolveFile;
+    private normalizeBaseUrl;
+    private resolveBaseUrl;
+    private resolveViewerPath;
+    private resolveViewerOrigin;
+    private resolveHostConversion;
+    private getUploadPath;
+    private fileSignature;
+    private createBaseFileId;
+    private createUploadSession;
+    private getUploadSessionForFile;
+    private uploadInternal;
+    private buildCachePayload;
+    private cacheFile;
+    private convertInternal;
+    private updateState;
+    private withOperation;
+    private toErrorMessage;
+}
+
+type GetSheetsOptions = {
+    timeoutMs?: number;
+};
+declare class ToolbarModule {
+    private viewer;
+    constructor(viewer: Viewer3D);
+    setDisabled3D(operators: string[]): void;
+    setDisabledPdf(operators: string[]): void;
+    clearDisabled3D(): void;
+    clearDisabledPdf(): void;
+    disableAll3D(): void;
+    disableAllPdf(): void;
+    enableAll3D(): void;
+    enableAllPdf(): void;
+    openClippingPlanes(): void;
+    closeClippingPlanes(): void;
+    openSetting(): void;
+    closeSetting(): void;
+    openSetting3D(): void;
+    closeSetting3D(): void;
+    openSettingPdf(): void;
+    closeSettingPdf(): void;
+    openStatesObjects(): void;
+    closeStatesObjects(): void;
+    openLinkedObjects(): void;
+    closeLinkedObjects(): void;
+    openModelTree(): void;
+    closeModelTree(): void;
+    openObjectProperties(): void;
+    closeObjectProperties(): void;
+    openSheets(): void;
+    closeSheets(): void;
+    getSheets(options?: GetSheetsOptions): Promise<SheetListItem[]>;
+    applySheet(sheetId: string | number): void;
+    cuttingCloseSections(): void;
+    cuttingMultipleSides(): void;
+    cuttingToggleSelection(): void;
+    cuttingTogglePlanes(): void;
+    cuttingPlaneX(): void;
+    cuttingPlaneY(): void;
+    cuttingPlaneZ(): void;
+    cuttingPlaneBox(): void;
+    cuttingRotateBox(): void;
+    cuttingReversePlaneX(): void;
+    cuttingReversePlaneY(): void;
+    cuttingReversePlaneZ(): void;
+    private postConfig;
+    private postPanelOpen;
+    private postPanelClose;
+    private postCuttingAction;
+    private postSheetsGetList;
+    private postSheetsApply;
+}
+
+type GetNodeIdsOptions = {
+    onlyRealNodes?: boolean;
+    timeoutMs?: number;
+};
+declare class ModelTreeModule {
+    private viewer;
+    constructor(viewer: Viewer3D);
+    open(): void;
+    selectNode(nodeId: string | number): void;
+    getNodeIds(options?: GetNodeIdsOptions): Promise<string[]>;
+}
+
+type MarkupRequestOptions = {
+    timeoutMs?: number;
+};
+declare class MarkupModule {
+    private viewer;
+    constructor(viewer: Viewer3D);
+    action(action: MarkupAction): void;
+    drawLine(): void;
+    drawArrow(): void;
+    drawCircle(): void;
+    drawEllipse(): void;
+    drawRectangle(): void;
+    drawPolygon(): void;
+    drawPolyline(): void;
+    drawTextBox(): void;
+    drawNote(): void;
+    drawCallout(): void;
+    drawCloud(): void;
+    drawFreehand(): void;
+    save(options?: MarkupRequestOptions): Promise<void>;
+    cancel(options?: MarkupRequestOptions): Promise<void>;
+    getList(options?: MarkupRequestOptions): Promise<MarkupListItem[]>;
+    private runRequest;
+}
+
+type Viewer3DOptions = {
+    container: HTMLElement | string;
+    url?: string;
+    baseUrl?: string;
+    viewerPath?: string;
+    uploadPath?: string;
+    file?: File;
+    width?: string;
+    height?: string;
+    sandbox?: string;
+    allowedOrigin?: string;
+};
+declare class Viewer3D {
+    private options;
+    private containerEl;
+    private iframeEl;
+    private initialized;
+    private emitter;
+    camera: CameraModule;
+    interaction: InteractionModule;
+    node: NodeModule;
+    files: FilesModule;
+    toolbar: ToolbarModule;
+    modelTree: ModelTreeModule;
+    markup: MarkupModule;
+    constructor(options: Viewer3DOptions);
+    getOptions(): Viewer3DOptions;
+    patchOptions(next: Partial<Viewer3DOptions>): void;
+    getUrl(): string | null;
+    init(): void;
+    render(file?: File): Promise<PreparedViewerData | void>;
+    open(url: string): void;
+    destroy(): void;
+    private ensureInit;
+    _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;
+    postToViewer<TPayload = unknown>(type: ViewerMessageType, payload?: TPayload): void;
+    private handleMessage;
+}
+
+export { type FilesConfig, type LoadStage, type LoadStatePayload, type MarkupAction, type MarkupListItem, type MarkupOperationResultPayload, type PreparedViewerData, Viewer3D };