3dviewer-sdk 1.0.18 → 1.0.20

package/dist/index.d.mts

@@ -31,6 +31,10 @@ declare enum ViewerMessageType {
     SHEETS_APPLY = "viewer-sheets-apply",
     OBJECT_PROPERTIES_GET_LIST = "viewer-object-properties-get-list",
     OBJECT_PROPERTIES_LIST = "viewer-object-properties-list",
+    OBJECT_PROPERTIES_WATCH = "viewer-object-properties-watch",
+    OBJECT_PROPERTIES_UNWATCH = "viewer-object-properties-unwatch",
+    OBJECT_PROPERTIES_GET_CURRENT = "viewer-object-properties-get-current",
+    OBJECT_PROPERTIES_CHANGED = "viewer-object-properties-changed",
     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",
@@ -86,6 +90,14 @@ type SheetListItem = {
     viewId?: string;
 };
 type ObjectPropertyItem = Record<string, unknown>;
+type ObjectPropertiesChangedPayload = {
+    requestId?: string;
+    selectionKey: string;
+    nodeIds: string[];
+    persistentIds: string[];
+    properties: ObjectPropertyItem[];
+    timestamp: number;
+};
 type LinkedObjectItem = Record<string, unknown>;
 type StateObjectRefItem = {
     name: string;
@@ -173,6 +185,7 @@ type ViewerEventMap = {
         properties: ObjectPropertyItem[];
         timestamp: number;
     };
+    "object-properties:changed": ObjectPropertiesChangedPayload;
     "linked-objects:list": {
         requestId: string;
         linkedObjects: LinkedObjectItem[];
@@ -569,6 +582,25 @@ declare class LanguageModule {
     set(language: LanguageCode): void;
 }
 
+type ObjectPropertiesWatchOptions = {
+    debounceMs?: number;
+    includeSelectionMeta?: boolean;
+};
+type ObjectPropertiesGetCurrentOptions = ObjectPropertiesWatchOptions & {
+    timeoutMs?: number;
+};
+type ObjectPropertiesChangedEvent = ObjectPropertiesChangedPayload;
+declare class ObjectPropertiesModule {
+    private viewer;
+    on: {
+        change: (cb: (payload: ObjectPropertiesChangedEvent) => void) => () => void;
+    };
+    constructor(viewer: Viewer3D);
+    watch(options?: ObjectPropertiesWatchOptions): void;
+    unwatch(): void;
+    getCurrent(options?: ObjectPropertiesGetCurrentOptions): Promise<ObjectPropertiesChangedEvent>;
+}
+
 type InitialToolbarUse = ToolbarUseTarget | ToolbarUseTarget[] | Partial<Record<ToolbarUseTarget, boolean>>;
 type Viewer3DOptions = {
     container: HTMLElement | string;
@@ -598,6 +630,7 @@ declare class Viewer3D {
     modelTree: ModelTreeModule;
     markup: MarkupModule;
     language: LanguageModule;
+    objectProperties: ObjectPropertiesModule;
     constructor(options: Viewer3DOptions);
     getOptions(): Viewer3DOptions;
     patchOptions(next: Partial<Viewer3DOptions>): void;
@@ -616,4 +649,4 @@ declare class Viewer3D {
     private handleMessage;
 }
 
-export { type CameraZoomPayload, 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 };
+export { type CameraZoomPayload, 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 ObjectPropertiesChangedEvent, type ObjectPropertiesGetCurrentOptions, type ObjectPropertiesWatchOptions, type PreparedViewerData, Viewer3D };

package/dist/index.d.ts

@@ -31,6 +31,10 @@ declare enum ViewerMessageType {
     SHEETS_APPLY = "viewer-sheets-apply",
     OBJECT_PROPERTIES_GET_LIST = "viewer-object-properties-get-list",
     OBJECT_PROPERTIES_LIST = "viewer-object-properties-list",
+    OBJECT_PROPERTIES_WATCH = "viewer-object-properties-watch",
+    OBJECT_PROPERTIES_UNWATCH = "viewer-object-properties-unwatch",
+    OBJECT_PROPERTIES_GET_CURRENT = "viewer-object-properties-get-current",
+    OBJECT_PROPERTIES_CHANGED = "viewer-object-properties-changed",
     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",
@@ -86,6 +90,14 @@ type SheetListItem = {
     viewId?: string;
 };
 type ObjectPropertyItem = Record<string, unknown>;
+type ObjectPropertiesChangedPayload = {
+    requestId?: string;
+    selectionKey: string;
+    nodeIds: string[];
+    persistentIds: string[];
+    properties: ObjectPropertyItem[];
+    timestamp: number;
+};
 type LinkedObjectItem = Record<string, unknown>;
 type StateObjectRefItem = {
     name: string;
@@ -173,6 +185,7 @@ type ViewerEventMap = {
         properties: ObjectPropertyItem[];
         timestamp: number;
     };
+    "object-properties:changed": ObjectPropertiesChangedPayload;
     "linked-objects:list": {
         requestId: string;
         linkedObjects: LinkedObjectItem[];
@@ -569,6 +582,25 @@ declare class LanguageModule {
     set(language: LanguageCode): void;
 }
 
+type ObjectPropertiesWatchOptions = {
+    debounceMs?: number;
+    includeSelectionMeta?: boolean;
+};
+type ObjectPropertiesGetCurrentOptions = ObjectPropertiesWatchOptions & {
+    timeoutMs?: number;
+};
+type ObjectPropertiesChangedEvent = ObjectPropertiesChangedPayload;
+declare class ObjectPropertiesModule {
+    private viewer;
+    on: {
+        change: (cb: (payload: ObjectPropertiesChangedEvent) => void) => () => void;
+    };
+    constructor(viewer: Viewer3D);
+    watch(options?: ObjectPropertiesWatchOptions): void;
+    unwatch(): void;
+    getCurrent(options?: ObjectPropertiesGetCurrentOptions): Promise<ObjectPropertiesChangedEvent>;
+}
+
 type InitialToolbarUse = ToolbarUseTarget | ToolbarUseTarget[] | Partial<Record<ToolbarUseTarget, boolean>>;
 type Viewer3DOptions = {
     container: HTMLElement | string;
@@ -598,6 +630,7 @@ declare class Viewer3D {
     modelTree: ModelTreeModule;
     markup: MarkupModule;
     language: LanguageModule;
+    objectProperties: ObjectPropertiesModule;
     constructor(options: Viewer3DOptions);
     getOptions(): Viewer3DOptions;
     patchOptions(next: Partial<Viewer3DOptions>): void;
@@ -616,4 +649,4 @@ declare class Viewer3D {
     private handleMessage;
 }
 
-export { type CameraZoomPayload, 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 };
+export { type CameraZoomPayload, 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 ObjectPropertiesChangedEvent, type ObjectPropertiesGetCurrentOptions, type ObjectPropertiesWatchOptions, type PreparedViewerData, Viewer3D };

package/dist/index.js

@@ -1141,6 +1141,54 @@ var LanguageModule = class {
   }
 };
 
+// src/modules/object-properties.module.ts
+function createRequestId5(prefix) {
+  return `${prefix}_${Date.now()}_${Math.random().toString(36).slice(2, 10)}`;
+}
+var ObjectPropertiesModule = class {
+  constructor(viewer) {
+    this.viewer = viewer;
+    this.on = {
+      change: (cb) => this.viewer._on("object-properties:changed", cb)
+    };
+  }
+  watch(options) {
+    const payload = {};
+    if (typeof (options == null ? void 0 : options.debounceMs) === "number" && Number.isFinite(options.debounceMs)) {
+      payload.debounceMs = options.debounceMs;
+    }
+    if (typeof (options == null ? void 0 : options.includeSelectionMeta) === "boolean") {
+      payload.includeSelectionMeta = options.includeSelectionMeta;
+    }
+    this.viewer.postToViewer("viewer-object-properties-watch" /* OBJECT_PROPERTIES_WATCH */, payload);
+  }
+  unwatch() {
+    this.viewer.postToViewer("viewer-object-properties-unwatch" /* OBJECT_PROPERTIES_UNWATCH */, {});
+  }
+  getCurrent(options) {
+    var _a;
+    const requestId = createRequestId5("object_properties_current");
+    const timeoutMs = Math.max(1e3, (_a = options == null ? void 0 : options.timeoutMs) != null ? _a : 1e4);
+    return new Promise((resolve, reject) => {
+      const timer = setTimeout(() => {
+        off();
+        reject(new Error("Timeout while getting current object properties from viewer"));
+      }, timeoutMs);
+      const off = this.viewer._on("object-properties:changed", (payload2) => {
+        if (payload2.requestId !== requestId) return;
+        clearTimeout(timer);
+        off();
+        resolve(payload2);
+      });
+      const payload = { requestId };
+      if (typeof (options == null ? void 0 : options.includeSelectionMeta) === "boolean") {
+        payload.includeSelectionMeta = options.includeSelectionMeta;
+      }
+      this.viewer.postToViewer("viewer-object-properties-get-current" /* OBJECT_PROPERTIES_GET_CURRENT */, payload);
+    });
+  }
+};
+
 // src/viewer.ts
 var SDK_VIEWER_PATH2 = "/mainviewer-sdk";
 var LEGACY_VIEWER_PATH2 = "/mainviewer";
@@ -1152,7 +1200,7 @@ var Viewer3D = class {
     this.initialized = false;
     this.emitter = new Emitter();
     this.handleMessage = (event) => {
-      var _a, _b, _c, _d;
+      var _a, _b, _c, _d, _e;
       const data = event.data;
       if (!data || typeof data !== "object") return;
       switch (data.type) {
@@ -1295,6 +1343,19 @@ var Viewer3D = class {
           });
           break;
         }
+        case "viewer-object-properties-changed" /* OBJECT_PROPERTIES_CHANGED */: {
+          const payload = data.payload;
+          if (!payload || !Array.isArray(payload.properties)) break;
+          this._emit("object-properties:changed", {
+            requestId: payload.requestId ? String(payload.requestId) : void 0,
+            selectionKey: String((_e = payload.selectionKey) != null ? _e : ""),
+            nodeIds: Array.isArray(payload.nodeIds) ? payload.nodeIds.map(String) : [],
+            persistentIds: Array.isArray(payload.persistentIds) ? payload.persistentIds.map(String) : [],
+            properties: payload.properties.filter((item) => item && typeof item === "object").map((item) => ({ ...item })),
+            timestamp: Number(payload.timestamp) || Date.now()
+          });
+          break;
+        }
         case "viewer-linked-objects-list" /* LINKED_OBJECTS_LIST */: {
           const payload = data.payload;
           if (!payload || !payload.requestId || !Array.isArray(payload.linkedObjects)) break;
@@ -1311,7 +1372,7 @@ var Viewer3D = class {
           this._emit("states-objects:list", {
             requestId: String(payload.requestId),
             statesObjects: payload.statesObjects.map((item) => {
-              var _a2, _b2, _c2, _d2, _e, _f, _g;
+              var _a2, _b2, _c2, _d2, _e2, _f, _g;
               return {
                 id: String((_a2 = item.id) != null ? _a2 : ""),
                 name: String((_b2 = item.name) != null ? _b2 : ""),
@@ -1324,7 +1385,7 @@ var Viewer3D = class {
                   };
                 }) : [],
                 states: {
-                  color: String((_e = (_d2 = item.states) == null ? void 0 : _d2.color) != null ? _e : ""),
+                  color: String((_e2 = (_d2 = item.states) == null ? void 0 : _d2.color) != null ? _e2 : ""),
                   type: String((_g = (_f = item.states) == null ? void 0 : _f.type) != null ? _g : "")
                 }
               };
@@ -1391,6 +1452,7 @@ var Viewer3D = class {
     this.modelTree = new ModelTreeModule(this);
     this.markup = new MarkupModule(this);
     this.language = new LanguageModule(this);
+    this.objectProperties = new ObjectPropertiesModule(this);
   }
   // ===== options helpers =====
   getOptions() {

package/dist/index.mjs

@@ -1115,6 +1115,54 @@ var LanguageModule = class {
   }
 };
 
+// src/modules/object-properties.module.ts
+function createRequestId5(prefix) {
+  return `${prefix}_${Date.now()}_${Math.random().toString(36).slice(2, 10)}`;
+}
+var ObjectPropertiesModule = class {
+  constructor(viewer) {
+    this.viewer = viewer;
+    this.on = {
+      change: (cb) => this.viewer._on("object-properties:changed", cb)
+    };
+  }
+  watch(options) {
+    const payload = {};
+    if (typeof (options == null ? void 0 : options.debounceMs) === "number" && Number.isFinite(options.debounceMs)) {
+      payload.debounceMs = options.debounceMs;
+    }
+    if (typeof (options == null ? void 0 : options.includeSelectionMeta) === "boolean") {
+      payload.includeSelectionMeta = options.includeSelectionMeta;
+    }
+    this.viewer.postToViewer("viewer-object-properties-watch" /* OBJECT_PROPERTIES_WATCH */, payload);
+  }
+  unwatch() {
+    this.viewer.postToViewer("viewer-object-properties-unwatch" /* OBJECT_PROPERTIES_UNWATCH */, {});
+  }
+  getCurrent(options) {
+    var _a;
+    const requestId = createRequestId5("object_properties_current");
+    const timeoutMs = Math.max(1e3, (_a = options == null ? void 0 : options.timeoutMs) != null ? _a : 1e4);
+    return new Promise((resolve, reject) => {
+      const timer = setTimeout(() => {
+        off();
+        reject(new Error("Timeout while getting current object properties from viewer"));
+      }, timeoutMs);
+      const off = this.viewer._on("object-properties:changed", (payload2) => {
+        if (payload2.requestId !== requestId) return;
+        clearTimeout(timer);
+        off();
+        resolve(payload2);
+      });
+      const payload = { requestId };
+      if (typeof (options == null ? void 0 : options.includeSelectionMeta) === "boolean") {
+        payload.includeSelectionMeta = options.includeSelectionMeta;
+      }
+      this.viewer.postToViewer("viewer-object-properties-get-current" /* OBJECT_PROPERTIES_GET_CURRENT */, payload);
+    });
+  }
+};
+
 // src/viewer.ts
 var SDK_VIEWER_PATH2 = "/mainviewer-sdk";
 var LEGACY_VIEWER_PATH2 = "/mainviewer";
@@ -1126,7 +1174,7 @@ var Viewer3D = class {
     this.initialized = false;
     this.emitter = new Emitter();
     this.handleMessage = (event) => {
-      var _a, _b, _c, _d;
+      var _a, _b, _c, _d, _e;
       const data = event.data;
       if (!data || typeof data !== "object") return;
       switch (data.type) {
@@ -1269,6 +1317,19 @@ var Viewer3D = class {
           });
           break;
         }
+        case "viewer-object-properties-changed" /* OBJECT_PROPERTIES_CHANGED */: {
+          const payload = data.payload;
+          if (!payload || !Array.isArray(payload.properties)) break;
+          this._emit("object-properties:changed", {
+            requestId: payload.requestId ? String(payload.requestId) : void 0,
+            selectionKey: String((_e = payload.selectionKey) != null ? _e : ""),
+            nodeIds: Array.isArray(payload.nodeIds) ? payload.nodeIds.map(String) : [],
+            persistentIds: Array.isArray(payload.persistentIds) ? payload.persistentIds.map(String) : [],
+            properties: payload.properties.filter((item) => item && typeof item === "object").map((item) => ({ ...item })),
+            timestamp: Number(payload.timestamp) || Date.now()
+          });
+          break;
+        }
         case "viewer-linked-objects-list" /* LINKED_OBJECTS_LIST */: {
           const payload = data.payload;
           if (!payload || !payload.requestId || !Array.isArray(payload.linkedObjects)) break;
@@ -1285,7 +1346,7 @@ var Viewer3D = class {
           this._emit("states-objects:list", {
             requestId: String(payload.requestId),
             statesObjects: payload.statesObjects.map((item) => {
-              var _a2, _b2, _c2, _d2, _e, _f, _g;
+              var _a2, _b2, _c2, _d2, _e2, _f, _g;
               return {
                 id: String((_a2 = item.id) != null ? _a2 : ""),
                 name: String((_b2 = item.name) != null ? _b2 : ""),
@@ -1298,7 +1359,7 @@ var Viewer3D = class {
                   };
                 }) : [],
                 states: {
-                  color: String((_e = (_d2 = item.states) == null ? void 0 : _d2.color) != null ? _e : ""),
+                  color: String((_e2 = (_d2 = item.states) == null ? void 0 : _d2.color) != null ? _e2 : ""),
                   type: String((_g = (_f = item.states) == null ? void 0 : _f.type) != null ? _g : "")
                 }
               };
@@ -1365,6 +1426,7 @@ var Viewer3D = class {
     this.modelTree = new ModelTreeModule(this);
     this.markup = new MarkupModule(this);
     this.language = new LanguageModule(this);
+    this.objectProperties = new ObjectPropertiesModule(this);
   }
   // ===== options helpers =====
   getOptions() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "3dviewer-sdk",
-  "version": "1.0.18",
+  "version": "1.0.20",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [