@procore/bim-webviewer-sdk 17.3.0-rc.1 → 17.3.0-rc.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/dist/Procore.Bim.Webviewer.d.ts +35 -36
  3. package/dist/Procore.Bim.Webviewer.js +1 -1
  4. package/dist/types/src/EscapeOperationsManager/EscapeOperationsManager.d.ts +21 -0
  5. package/dist/types/src/EscapeOperationsManager/__tests__/EscapeOperationsManager.test.d.ts +1 -0
  6. package/dist/types/src/EscapeOperationsManager/index.d.ts +1 -0
  7. package/dist/types/src/Webviewer.d.ts +1 -0
  8. package/dist/types/src/api/types/FileExtraction.d.ts +2 -9
  9. package/dist/types/src/api/types/GeometryFileBundle.d.ts +10 -0
  10. package/dist/types/src/api/types/ModelRevision.d.ts +2 -0
  11. package/dist/types/src/components/ContextMenuComponent/ContextMenuComponent.d.ts +9 -5
  12. package/dist/types/src/components/ContextMenuComponent/__tests__/ContextMenuComponent.test.d.ts +1 -0
  13. package/dist/types/src/controllers/RenderController.d.ts +1 -10
  14. package/dist/types/src/controllers/RenderControllerProxy.d.ts +5 -5
  15. package/dist/types/src/controllers/RenderControllerWorker.d.ts +1 -3
  16. package/dist/types/src/controllers/ShortestDistanceController.d.ts +0 -1
  17. package/dist/types/src/measuring/DistanceLabel.d.ts +6 -0
  18. package/dist/types/src/measuring/MeasurementRenderer.d.ts +0 -1
  19. package/dist/types/src/measuring/PointToPointController.d.ts +4 -1
  20. package/dist/types/src/navigation/DefaultControl.d.ts +1 -0
  21. package/dist/types/src/navigation/__tests__/DefaultControl.test.d.ts +1 -0
  22. package/dist/types/src/procoregl/MeshTopology/MeshTopology.d.ts +1 -0
  23. package/dist/types/src/procoregl/MeshTopology/__tests__/TopologyFixtures.d.ts +1 -0
  24. package/dist/types/src/procoregl/Models/__tests__/Models.test.d.ts +2 -2
  25. package/dist/types/src/pwfreader/PWF.d.ts +1 -2
  26. package/dist/types/src/pwfreader/PWFProxy.d.ts +1 -2
  27. package/dist/types/src/pwfreader/v1/PWFV1.d.ts +0 -2
  28. package/dist/types/src/pwfreader/v2/PWFV2.d.ts +0 -2
  29. package/dist/types/src/sdk.d.ts +3 -2
  30. package/dist/types/src/types/WebviewerOptions.d.ts +31 -31
  31. package/dist/types/src/utils/ApiMetaData/ApiMetaData.d.ts +1 -0
  32. package/dist/types/src/utils/ApiMetaData/__tests__/mocks.d.ts +10 -7
  33. package/dist/types/src/utils/CameraHelper/CameraHelper.d.ts +8 -0
  34. package/dist/types/src/utils/CameraHelper/index.d.ts +1 -0
  35. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -7,9 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
 
8
8
  ## [Unreleased]
9
9
 
10
+ ### Added
11
+
12
+ - ([#1389](https://github.com/procore/bim-webviewer/pull/1389)) [QA Ignore] Fetching the model by only using model revision id in SDK side.
13
+
14
+ ### Changed
15
+
16
+ - ([#1415](https://github.com/procore/bim-webviewer/pull/1415)) Changed the priority of the escape key operations to place resetting the measurement below closing the floor plan modal, but above closing any open windows.
17
+ - ([#1416](https://github.com/procore/bim-webviewer/pull/1416)) When the Measurement Tool is enabled, the context menu for mouse right click button will no longer display.
18
+ - ([#1442](https://github.com/procore/bim-webviewer/pull/1442)) [Internal] Refactor Shortest Distance Measurement to get mesh data in the same code path for both standard and partitioned models. For partitioned models this means it no longer fetches the partition from cache for the mesh data and instead reads it from OPFS
19
+
10
20
  ### Fixed
11
21
 
12
22
  - ([#1422](https://github.com/procore/bim-webviewer/pull/1422)) Fixed an issue where the crosshair cursor wouldn't appear when enabling the point-to-point measurement tool, requiring users to hover over a mesh and then move into empty space.
23
+ - ([#1423](https://github.com/procore/bim-webviewer/pull/1423)) Fixed bug that caused the temporary distance label to reappear in the scene when zooming in even when it was hidden behind the camera.
24
+ - ([#1414](https://github.com/procore/bim-webviewer/pull/1414)) [Internal][QA Ignore] Removes noisy console logs from the PointToPointController when a user of p2p hovers over non-manifold meshes.
25
+ - ([#1445](https://github.com/procore/bim-webviewer/pull/1445)) Fixed UI bug in which the footer line of the Settings dialog was on top of the Measurement Units dropdown menu.
26
+ - ([#1448](https://github.com/procore/bim-webviewer/pull/1448)) Fixed an issue where the cursor was not updated to the default one if the section box was disabled while the resize cursor was applied.
13
27
 
14
28
  ## [17.2.0] 2024-12-13
15
29
 
@@ -188,6 +188,10 @@ export declare type FeatureFlags = {
188
188
  enableMeshDataOnOPFS: boolean;
189
189
  };
190
190
 
191
+ declare type File_2 = {
192
+ url: string;
193
+ };
194
+
191
195
  export declare type FileExtraction = {
192
196
  id: number;
193
197
  extraction_items: FileExtractionItem[];
@@ -200,17 +204,13 @@ export declare type FileExtractionModeOptions = CommonOptions & {
200
204
  fileExtractionId: FileExtraction['id'];
201
205
  };
202
206
 
203
- export declare type FileExtractionModePwfV1OverrideOptions = CommonOptions & PwfV1Bundle & {
204
- fileExtractionId: FileExtraction['id'];
205
- };
207
+ export declare type FileExtractionModePwfV1OverrideOptions = FileExtractionModeOptions & PwfV1Bundle;
206
208
 
207
209
  export declare type FileExtractionModePwfV1OverrideResource = PwfV1Bundle & {
208
210
  fileExtractionId: FileExtraction['id'];
209
211
  };
210
212
 
211
- export declare type FileExtractionModePwfV2OverrideOptions = CommonOptions & PwfV2Bundle & {
212
- fileExtractionId: FileExtraction['id'];
213
- };
213
+ export declare type FileExtractionModePwfV2OverrideOptions = FileExtractionModeOptions & PwfV2Bundle;
214
214
 
215
215
  export declare type FileExtractionModePwfV2OverrideResource = PwfV2Bundle & {
216
216
  fileExtractionId: FileExtraction['id'];
@@ -239,10 +239,10 @@ export declare type FilterField = (typeof FILTER_FIELD)[keyof typeof FILTER_FIEL
239
239
  * the valid configurations that we support.
240
240
  */
241
241
  export declare type GeometryBundle = {
242
- nodeUrl: GeometryFile['url'];
243
- meshnodeUrl: GeometryFile['url'];
244
- meshUrl?: GeometryFile['url'];
245
- manifestUrl?: GeometryFile['url'];
242
+ nodeUrl: string;
243
+ meshnodeUrl: string;
244
+ meshUrl?: string;
245
+ manifestUrl?: string;
246
246
  };
247
247
 
248
248
  declare class GeometryFactory {
@@ -264,8 +264,11 @@ declare class GeometryFactory {
264
264
  createMeshGeometry(_vertices: Float32Array, _faces: Uint16Array, _color: number, _opacity: number, _drawType: number): StreamedMeshGeometry;
265
265
  }
266
266
 
267
- export declare type GeometryFile = {
268
- url: string;
267
+ export declare type GeometryFileBundle = {
268
+ manifest_file?: File_2 | null;
269
+ mesh_file: File_2;
270
+ mesh_node_file: File_2;
271
+ node_file: File_2;
269
272
  };
270
273
 
271
274
  declare type GPUMeshData = {
@@ -504,8 +507,6 @@ declare type MeshnodeObject_2 = {
504
507
  selected: boolean;
505
508
  };
506
509
 
507
- declare type MeshnodeObject_3 = MeshnodeObject | MeshnodeObject_2;
508
-
509
510
  declare class MeshnodeServices {
510
511
  private meshnodeCount;
511
512
  private meshnodes;
@@ -618,24 +619,29 @@ export declare type ModelRevision = {
618
619
  id: number;
619
620
  revision: number;
620
621
  viewpoints: ModelRevisionViewpoint[];
622
+ geometry_file_bundle: GeometryFileBundle;
621
623
  };
622
624
 
623
- export declare type ModelRevisionModePwfV1Options = CommonOptions & PwfV1Bundle & {
625
+ export declare type ModelRevisionModeOptions = CommonOptions & {
624
626
  modelId: Model['id'];
625
627
  modelRevisionId: ModelRevision['id'];
626
628
  };
627
629
 
628
- export declare type ModelRevisionModePwfV1Resource = PwfV1Bundle & {
630
+ export declare type ModelRevisionModePwfV1OverrideOptions = ModelRevisionModeOptions & PwfV1Bundle;
631
+
632
+ export declare type ModelRevisionModePwfV1OverrideResource = PwfV1Bundle & {
629
633
  modelId: Model['id'];
630
634
  modelRevisionId: ModelRevision['id'];
631
635
  };
632
636
 
633
- export declare type ModelRevisionModePwfV2Options = CommonOptions & PwfV2Bundle & {
637
+ export declare type ModelRevisionModePwfV2OverrideOptions = ModelRevisionModeOptions & PwfV2Bundle;
638
+
639
+ export declare type ModelRevisionModePwfV2OverrideResource = PwfV2Bundle & {
634
640
  modelId: Model['id'];
635
641
  modelRevisionId: ModelRevision['id'];
636
642
  };
637
643
 
638
- export declare type ModelRevisionModePwfV2Resource = PwfV2Bundle & {
644
+ export declare type ModelRevisionModeResource = {
639
645
  modelId: Model['id'];
640
646
  modelRevisionId: ModelRevision['id'];
641
647
  };
@@ -827,7 +833,7 @@ export declare type ObjectFilter = {
827
833
  filterValue: string;
828
834
  };
829
835
 
830
- export declare type Options = FileExtractionModePwfV2OverrideOptions | FileExtractionModePwfV1OverrideOptions | FileExtractionModeOptions | ModelRevisionModePwfV2Options | ModelRevisionModePwfV1Options | ResourceOptions;
836
+ export declare type Options = FileExtractionModePwfV2OverrideOptions | FileExtractionModePwfV1OverrideOptions | FileExtractionModeOptions | ModelRevisionModePwfV2OverrideOptions | ModelRevisionModePwfV1OverrideOptions | ModelRevisionModeOptions | ResourceOptions;
831
837
 
832
838
  declare type Palette = {
833
839
  default?: Color;
@@ -1017,7 +1023,6 @@ declare interface PWF {
1017
1023
  hasNode(id: number): boolean;
1018
1024
  loadAllMeshGeometryToGPU(): BootstrapperResult;
1019
1025
  loadAllPartitionProxies(): void;
1020
- getMeshDataForPartitionedModel(meshnodeIndex: number): Promise<MeshnodeObject_3>;
1021
1026
  captureModelStats(): void;
1022
1027
  getModelAnalyticsData(): ModelAnalyticsData;
1023
1028
  get virtualMeshnodeIndexOffset(): number;
@@ -1241,7 +1246,6 @@ declare class PWFV1 implements PWF {
1241
1246
  numFirstObjects(): number;
1242
1247
  breadthFirstTraversalNodes(callback: (n: Node_3 | Meshnode_2) => void): BootstrapperResult;
1243
1248
  getNamedNode(nodeId: number): Node_3;
1244
- getMeshDataForPartitionedModel(meshnodeIndex: number): Promise<MeshnodeObject>;
1245
1249
  captureModelStats(): number;
1246
1250
  private captureStandardModelStats;
1247
1251
  private capturePartitionedModelStats;
@@ -1252,9 +1256,9 @@ declare class PWFV1 implements PWF {
1252
1256
  }
1253
1257
 
1254
1258
  export declare type PwfV1Bundle = {
1255
- nodeUrl: GeometryFile['url'];
1256
- meshnodeUrl: GeometryFile['url'];
1257
- meshUrl: GeometryFile['url'];
1259
+ nodeUrl: string;
1260
+ meshnodeUrl: string;
1261
+ meshUrl: string;
1258
1262
  };
1259
1263
 
1260
1264
  declare class PWFV2 implements PWF {
@@ -1332,7 +1336,6 @@ declare class PWFV2 implements PWF {
1332
1336
  numFirstObjects(): number;
1333
1337
  breadthFirstTraversalNodes(callback: (n: Node_4 | Meshnode_3) => void): BootstrapperResult;
1334
1338
  getNamedNode(nodeId: number): Node_4;
1335
- getMeshDataForPartitionedModel(meshnodeIndex: number): Promise<MeshnodeObject_2>;
1336
1339
  captureModelStats(): number;
1337
1340
  private captureStandardModelStats;
1338
1341
  private capturePartitionedModelStats;
@@ -1343,10 +1346,10 @@ declare class PWFV2 implements PWF {
1343
1346
  }
1344
1347
 
1345
1348
  export declare type PwfV2Bundle = {
1346
- nodeUrl: GeometryFile['url'];
1347
- meshnodeUrl: GeometryFile['url'];
1348
- meshUrl: GeometryFile['url'];
1349
- manifestUrl: GeometryFile['url'];
1349
+ nodeUrl: string;
1350
+ meshnodeUrl: string;
1351
+ meshUrl: string;
1352
+ manifestUrl: string;
1350
1353
  };
1351
1354
 
1352
1355
  declare type PWFVersion = `${number}.${number}`;
@@ -1358,7 +1361,7 @@ export declare const RENDER_MODE: {
1358
1361
 
1359
1362
  export declare type RenderMode = (typeof RENDER_MODE)[keyof typeof RENDER_MODE];
1360
1363
 
1361
- export declare type Resource = FileExtractionModePwfV1OverrideResource | FileExtractionModePwfV2OverrideResource | FileExtractionModeResource | ModelRevisionModePwfV1Resource | ModelRevisionModePwfV2Resource;
1364
+ export declare type Resource = FileExtractionModePwfV1OverrideResource | FileExtractionModePwfV2OverrideResource | FileExtractionModeResource | ModelRevisionModePwfV1OverrideResource | ModelRevisionModePwfV2OverrideResource | ModelRevisionModeResource;
1362
1365
 
1363
1366
  declare type ResourceDiscriminator = {
1364
1367
  fileExtractionId: number;
@@ -1595,12 +1598,7 @@ export declare type Visibility = {
1595
1598
  export declare type WebFormatExtractionItem = {
1596
1599
  item_type: 'WebFormat';
1597
1600
  artifact: {
1598
- web_format: {
1599
- node_file: GeometryFile;
1600
- mesh_node_file: GeometryFile;
1601
- mesh_file: GeometryFile;
1602
- manifest_file?: GeometryFile;
1603
- };
1601
+ web_format: GeometryFileBundle;
1604
1602
  };
1605
1603
  };
1606
1604
 
@@ -1608,6 +1606,7 @@ export declare class Webviewer {
1608
1606
  options: Options;
1609
1607
  private readonly measurementRenderer;
1610
1608
  private readonly measurementManager;
1609
+ private readonly escapeOperationsManager;
1611
1610
  static readonly tools: {
1612
1611
  readonly ALL: 0;
1613
1612
  readonly BOTTOMTOOL: 1;