@procore/bim-webviewer-sdk 17.6.0-rc.9 → 17.6.0-release-17-6-0-test-inline-worker-changes.1

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 (32) hide show
  1. package/CHANGELOG.md +2 -1
  2. package/dist/Procore.Bim.Webviewer.d.ts +17 -14
  3. package/dist/Procore.Bim.Webviewer.js +106711 -2
  4. package/dist/Procore.Bim.Webviewer.js.map +1 -0
  5. package/dist/types/src/controllers/Bootstrapper.d.ts +4 -1
  6. package/dist/types/src/controllers/RenderController.d.ts +1 -1
  7. package/dist/types/src/controllers/RenderControllerProxy.d.ts +1 -0
  8. package/dist/types/src/controllers/RendererFactory.d.ts +2 -1
  9. package/dist/types/src/procoregl/Models/Models.d.ts +2 -0
  10. package/dist/types/src/procoregl/PartitionsRendererImpl.d.ts +2 -0
  11. package/dist/types/src/pwfreader/PWF.d.ts +3 -2
  12. package/dist/types/src/pwfreader/PWFProxy.d.ts +3 -2
  13. package/dist/types/src/pwfreader/Utils.d.ts +6 -2
  14. package/dist/types/src/pwfreader/v1/PWFV1.d.ts +3 -1
  15. package/dist/types/src/pwfreader/v1/impl/bufferReader/HPartitionProxyBufferReader.d.ts +8 -0
  16. package/dist/types/src/pwfreader/v1/impl/bufferReader/__tests__/HPartitionProxyBufferReader.test.d.ts +1 -0
  17. package/dist/types/src/pwfreader/v1/impl/pwfNoCache/PWFHPartitionProxyNoCache.d.ts +14 -0
  18. package/dist/types/src/pwfreader/v1/impl/recordReader/PWFHPartitionProxyReader.d.ts +19 -0
  19. package/dist/types/src/pwfreader/v1/interface/PWFHPartitionProxy.d.ts +7 -0
  20. package/dist/types/src/pwfreader/v1/standard/MeshnodeServices.d.ts +3 -1
  21. package/dist/types/src/pwfreader/v1/streaming/HPartitionProxy.d.ts +20 -0
  22. package/dist/types/src/pwfreader/v1/streaming/PartitionProxy.d.ts +3 -3
  23. package/dist/types/src/pwfreader/v1/streaming/__tests__/HPartitionProxy.test.d.ts +1 -0
  24. package/dist/types/src/pwfreader/v2/PWFV2.d.ts +2 -1
  25. package/dist/types/src/pwfreader/v2/streaming/PartitionProxy.d.ts +1 -2
  26. package/dist/types/src/pwfreader/v2/streaming/StreamedMeshServices.d.ts +1 -2
  27. package/dist/types/src/pwfreader/v2/streaming/StreamedMeshnode.d.ts +1 -3
  28. package/dist/types/src/types/WebviewerOptions.d.ts +1 -0
  29. package/dist/types/src/utils/constants.d.ts +0 -2
  30. package/package.json +1 -1
  31. package/dist/Procore.Bim.Webviewer.js.LICENSE.txt +0 -5
  32. package/dist/Procore.Bim.Webviewer.worker.js.LICENSE.txt +0 -3
package/CHANGELOG.md CHANGED
@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
7
7
 
8
- ## [Unreleased]
8
+ ## [17.6.0] 2025-03-17
9
9
 
10
10
  ### Added
11
11
 
@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
13
13
  - In Firefox, this will prompt the user to allow persistent storage, which, when granted, will increase the amount of disk space made available to the current origin. While this prompt is displayed, the loading screen (enabled with `tools: [Webviewer.tools.LOADING]`) will display a message directing the user to "Allow Persistent Storage".
14
14
  - ([#1404](https://github.com/procore/bim-webviewer/pull/1404)) Logs bootstrapper execution summary at the console with the option `logInitializationTimes=true`
15
15
  - ([#1401](https://github.com/procore/bim-webviewer/pull/1401)) [Internal][QA Ignore] Adds the new `model:hpartition` script for development, along with several plantUML diagrams of the "to be" end state under `docs/diagrams/hierarchicalPartitions/`.
16
+ - ([#1506](https://github.com/procore/bim-webviewer/pull/1506)) Adds a WebViewer option to control the prefetching-vs-progressive loading of partitions for large models.
16
17
 
17
18
  ### Changed
18
19
 
@@ -184,6 +184,7 @@ export declare type FeatureFlags = {
184
184
  * @beta Enables writing mesh data to OPFS for partitioned models, which allows users to use features that use mesh data, notably Point to Point.
185
185
  */
186
186
  enableMeshDataOnOPFS: boolean;
187
+ enableProgressiveLoading: boolean;
187
188
  };
188
189
 
189
190
  declare type File_2 = {
@@ -529,7 +530,8 @@ declare class MeshnodeServices_2 {
529
530
  private meshnodes;
530
531
  protected pwf: PWFV1;
531
532
  protected cachedMeshnodes: Map<number, Meshnode_2>;
532
- constructor(pwfMeshnodes: PWFMeshnode[], pwf: PWFV1);
533
+ protected readonly featureFlags: ValidatedFeatureFlags;
534
+ constructor(pwfMeshnodes: PWFMeshnode[], pwf: PWFV1, featureFlags: ValidatedFeatureFlags);
533
535
  getMeshnodeFromIndex(index: number): Meshnode_2;
534
536
  getMeshnode(offset: number): Meshnode_2;
535
537
  numMeshnodes(): number;
@@ -883,7 +885,6 @@ declare class Partition_2 {
883
885
 
884
886
  declare class PartitionProxy {
885
887
  private pwfPartitionProxy;
886
- private meshServices;
887
888
  static numberOfPartitions: number;
888
889
  static numberOfPartitionsLoaded: number;
889
890
  static currentNumberOfDownloading: number;
@@ -909,7 +910,7 @@ declare class PartitionProxy {
909
910
  meshnodes(): StreamedMeshnode[];
910
911
  setMeshnodes(meshnodes: StreamedMeshnode[]): void;
911
912
  loadPartitionData(callbackFn: (partition: Partition) => void): Promise<void>;
912
- loadPartition(factory: StreamedGeometryFactory): Promise<void>;
913
+ loadPartition(_factory: StreamedGeometryFactory): Promise<void>;
913
914
  size(): {
914
915
  compressed: number;
915
916
  size: number;
@@ -928,9 +929,9 @@ declare class PartitionProxy_2 {
928
929
  isLoading: boolean;
929
930
  isLoaded: boolean;
930
931
  meshRef2Meshnodes: Map<number, StreamedMeshnode_2[]>;
931
- private _meshnodes;
932
- private _byteLength?;
933
- private _compressedByteLength;
932
+ protected _meshnodes: StreamedMeshnode_2[];
933
+ protected _byteLength?: number;
934
+ protected _compressedByteLength: number;
934
935
  private stats;
935
936
  private static partitionDownloadManager;
936
937
  constructor(params: {
@@ -1016,7 +1017,8 @@ export declare type PublicNode = {
1016
1017
 
1017
1018
  declare interface PWF {
1018
1019
  setStandardModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, meshAB: ArrayBuffer): void;
1019
- setPartitionedModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, partitionAB: ArrayBuffer): void;
1020
+ setPartitionedModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, partitionProxiesAB: ArrayBuffer): void;
1021
+ setHPartitionedModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, partitionProxiesAB: ArrayBuffer): void;
1020
1022
  initPwfParser(): void;
1021
1023
  parsePwfNodes(): BootstrapperResult;
1022
1024
  parsePwfMeshnodes(): BootstrapperResult;
@@ -1034,7 +1036,7 @@ declare interface PWF {
1034
1036
  getVirtualMeshnodeIndexesByNodeId(nodeId: number): number[];
1035
1037
  getNamedNode(nodeId: number): Node_2;
1036
1038
  globalOffset(): Vector3;
1037
- getPwfPartitionContentUrls(): string[];
1039
+ getPwfPartitionContentUrls(): Promise<string[]>;
1038
1040
  numNodes(): number;
1039
1041
  numMeshnodes(): number;
1040
1042
  numMeshes(): number;
@@ -1209,6 +1211,7 @@ declare class PWFV1 implements PWF {
1209
1211
  meshAB?: ArrayBuffer;
1210
1212
  partitionProxiesAB?: ArrayBuffer;
1211
1213
  pwfModelParser?: PWFModelParser_2;
1214
+ modelType: 'standard' | 'partitioned-flat' | 'partitioned-tree';
1212
1215
  private _numMeshnodes;
1213
1216
  private _numMeshes;
1214
1217
  private _numNodes;
@@ -1237,7 +1240,8 @@ declare class PWFV1 implements PWF {
1237
1240
  });
1238
1241
  setStandardModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, meshAB: ArrayBuffer): void;
1239
1242
  setPartitionedModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, partitionProxiesAB: ArrayBuffer): void;
1240
- getPwfPartitionContentUrls(): string[];
1243
+ setHPartitionedModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, partitionProxiesAB: ArrayBuffer): void;
1244
+ getPwfPartitionContentUrls(): Promise<string[]>;
1241
1245
  initPwfParser(): void;
1242
1246
  parsePwfNodes(): BootstrapperResult;
1243
1247
  parsePwfMeshnodes(): BootstrapperResult;
@@ -1332,7 +1336,8 @@ declare class PWFV2 implements PWF {
1332
1336
  });
1333
1337
  setStandardModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, meshAB: ArrayBuffer): void;
1334
1338
  setPartitionedModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, partitionProxiesAB: ArrayBuffer): void;
1335
- getPwfPartitionContentUrls(): string[];
1339
+ setHPartitionedModelBuffers(_nodeAB: ArrayBuffer, _meshnodeAB: ArrayBuffer, _partitionProxiesAB: ArrayBuffer): void;
1340
+ getPwfPartitionContentUrls(): Promise<string[]>;
1336
1341
  initPwfParser(): void;
1337
1342
  parsePwfNodes(): BootstrapperResult;
1338
1343
  parsePwfMeshnodes(): BootstrapperResult;
@@ -1445,12 +1450,10 @@ declare class StreamedMeshGeometry extends MeshGeometry {
1445
1450
 
1446
1451
  declare class StreamedMeshnode extends Meshnode_3 {
1447
1452
  private _partitionProxy?;
1448
- private _meshGeometries;
1449
1453
  setPartitionProxy(partitionProxy: PartitionProxy): void;
1450
1454
  partitionProxy(): PartitionProxy;
1451
1455
  meshGeometries(): MeshGeometry[];
1452
- setMeshGeometry(meshIndex: number, meshGeometry: StreamedMeshGeometry): void;
1453
- getMeshGeometry(meshIndex: number): StreamedMeshGeometry | undefined;
1456
+ getMeshGeometry(_meshIndex: number): StreamedMeshGeometry | undefined;
1454
1457
  asObject(): MeshnodeObject_2;
1455
1458
  private getMeshObject;
1456
1459
  }
@@ -1498,7 +1501,7 @@ declare class StreamedMeshServices extends MeshServices {
1498
1501
  closeOPFS(): Promise<void>;
1499
1502
  writeMeshDataToOPFS(meshData: MeshData): Promise<void>;
1500
1503
  getMeshObject(meshIndex: number): MeshObject_2;
1501
- loadPartitionContainingMeshnode(_streamedMeshnode: StreamedMeshnode): Promise<boolean>;
1504
+ loadPartitionContainingMeshnode(): void;
1502
1505
  getMeshGeometryForOffsets(meshOffset: number, meshnodeOffset: number): StreamedMeshGeometry | undefined;
1503
1506
  meshFromOffset(meshIndex: number): Mesh;
1504
1507
  private getCompressedMeshDataFromOPFS;