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

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 (31) 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 +8462 -2
  4. package/dist/types/src/controllers/Bootstrapper.d.ts +4 -1
  5. package/dist/types/src/controllers/RenderController.d.ts +1 -1
  6. package/dist/types/src/controllers/RenderControllerProxy.d.ts +1 -0
  7. package/dist/types/src/controllers/RendererFactory.d.ts +2 -1
  8. package/dist/types/src/procoregl/Models/Models.d.ts +2 -0
  9. package/dist/types/src/procoregl/PartitionsRendererImpl.d.ts +2 -0
  10. package/dist/types/src/pwfreader/PWF.d.ts +3 -2
  11. package/dist/types/src/pwfreader/PWFProxy.d.ts +3 -2
  12. package/dist/types/src/pwfreader/Utils.d.ts +6 -2
  13. package/dist/types/src/pwfreader/v1/PWFV1.d.ts +3 -1
  14. package/dist/types/src/pwfreader/v1/impl/bufferReader/HPartitionProxyBufferReader.d.ts +8 -0
  15. package/dist/types/src/pwfreader/v1/impl/bufferReader/__tests__/HPartitionProxyBufferReader.test.d.ts +1 -0
  16. package/dist/types/src/pwfreader/v1/impl/pwfNoCache/PWFHPartitionProxyNoCache.d.ts +14 -0
  17. package/dist/types/src/pwfreader/v1/impl/recordReader/PWFHPartitionProxyReader.d.ts +19 -0
  18. package/dist/types/src/pwfreader/v1/interface/PWFHPartitionProxy.d.ts +7 -0
  19. package/dist/types/src/pwfreader/v1/standard/MeshnodeServices.d.ts +3 -1
  20. package/dist/types/src/pwfreader/v1/streaming/HPartitionProxy.d.ts +20 -0
  21. package/dist/types/src/pwfreader/v1/streaming/PartitionProxy.d.ts +3 -3
  22. package/dist/types/src/pwfreader/v1/streaming/__tests__/HPartitionProxy.test.d.ts +1 -0
  23. package/dist/types/src/pwfreader/v2/PWFV2.d.ts +2 -1
  24. package/dist/types/src/pwfreader/v2/streaming/PartitionProxy.d.ts +1 -2
  25. package/dist/types/src/pwfreader/v2/streaming/StreamedMeshServices.d.ts +1 -2
  26. package/dist/types/src/pwfreader/v2/streaming/StreamedMeshnode.d.ts +1 -3
  27. package/dist/types/src/types/WebviewerOptions.d.ts +1 -0
  28. package/dist/types/src/utils/constants.d.ts +0 -2
  29. package/package.json +1 -1
  30. package/dist/Procore.Bim.Webviewer.js.LICENSE.txt +0 -5
  31. package/dist/Procore.Bim.Webviewer.worker.js.LICENSE.txt +0 -3
@@ -1,4 +1,5 @@
1
1
  import type { RenderController } from './RenderController';
2
+ import { ValidatedFeatureFlags } from '../types/WebviewerOptions';
2
3
  export type BootstrapperResult = {
3
4
  isComplete: boolean;
4
5
  };
@@ -18,13 +19,15 @@ export declare class Bootstrapper {
18
19
  static estimatedInitializationSteps: number;
19
20
  static numPartitions: number;
20
21
  static launchAnimationLoopExecuted: boolean;
22
+ static modelType: string;
23
+ static enableProgressiveLoading: boolean;
21
24
  static summary: Map<string, {
22
25
  numCalls: number;
23
26
  totalTime: number;
24
27
  }>;
25
28
  static STEPS_PLANNER: Record<string, number>;
26
29
  static initBootstrappingSummary(): void;
27
- static bootstrap(renderController: RenderController): Promise<void>;
30
+ static bootstrap(renderController: RenderController, featureFlags: ValidatedFeatureFlags): Promise<void>;
28
31
  static recordStep(step: string, duration: number): void;
29
32
  static summarizeStepsAsText(): void;
30
33
  static summarizeStepsAsCSV(): void;
@@ -377,7 +377,7 @@ export class RenderController {
377
377
  nodeABCached: boolean;
378
378
  meshABCached: boolean;
379
379
  };
380
- getPwfPartitionContentUrls(params?: {}): string[];
380
+ getPwfPartitionContentUrls(params?: {}): Promise<string[]>;
381
381
  getNumMeshes(params?: {}): number;
382
382
  getNumMeshnodes(params?: {}): number;
383
383
  getNumNodes(params?: {}): number;
@@ -44,6 +44,7 @@ export class RenderControllerProxy {
44
44
  'Error: File size exception.': "fileTooBigError";
45
45
  };
46
46
  handleDownloadError: (message: any) => void;
47
+ modelType: "standard" | "partitioned-flat" | "partitioned-tree";
47
48
  downloadMetaData: {
48
49
  timeToDownload: number;
49
50
  modelCached: boolean;
@@ -1,4 +1,5 @@
1
1
  import { ViewerRenderer } from '../procoregl/ViewerRenderer';
2
+ import { ValidatedFeatureFlags } from '../types/WebviewerOptions';
2
3
  export declare class RendererFactory {
3
- static createViewerRenderer(canvas: HTMLCanvasElement, offsetWidth: number, offsetHeight: number): ViewerRenderer;
4
+ static createViewerRenderer(canvas: HTMLCanvasElement, offsetWidth: number, offsetHeight: number, featureFlags: ValidatedFeatureFlags): ViewerRenderer;
4
5
  }
@@ -39,6 +39,8 @@ export declare class Models {
39
39
  private tempVirtualizedMeshnodes;
40
40
  private detailsParams?;
41
41
  private readonly isLogging;
42
+ private readonly featureFlags;
43
+ private modelType;
42
44
  constructor(params: {
43
45
  sceneGraphName: SceneGraphName;
44
46
  isLogging: boolean;
@@ -3,11 +3,13 @@ import type { RenderMode } from '../utils/constants';
3
3
  import type { Models } from './Models';
4
4
  import { ColorServices } from './ColorServices';
5
5
  import { GeometryFactory } from './GeometryFactory';
6
+ import { ValidatedFeatureFlags } from '../types/WebviewerOptions';
6
7
  type PartitionedModelRendererArgs = {
7
8
  antialias: boolean;
8
9
  preserveDrawingBuffer: boolean;
9
10
  alpha: boolean;
10
11
  canvas: HTMLCanvasElement;
12
+ featureFlags: ValidatedFeatureFlags;
11
13
  };
12
14
  export declare class PartitionsRendererImpl implements ViewerRenderer {
13
15
  private readonly renderer;
@@ -5,7 +5,8 @@ import type { BootstrapperResult } from '../controllers/Bootstrapper';
5
5
  import { Vector3 } from '../types/Math';
6
6
  export interface PWF {
7
7
  setStandardModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, meshAB: ArrayBuffer): void;
8
- setPartitionedModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, partitionAB: ArrayBuffer): void;
8
+ setPartitionedModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, partitionProxiesAB: ArrayBuffer): void;
9
+ setHPartitionedModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, partitionProxiesAB: ArrayBuffer): void;
9
10
  initPwfParser(): void;
10
11
  parsePwfNodes(): BootstrapperResult;
11
12
  parsePwfMeshnodes(): BootstrapperResult;
@@ -23,7 +24,7 @@ export interface PWF {
23
24
  getVirtualMeshnodeIndexesByNodeId(nodeId: number): number[];
24
25
  getNamedNode(nodeId: number): Node;
25
26
  globalOffset(): Vector3;
26
- getPwfPartitionContentUrls(): string[];
27
+ getPwfPartitionContentUrls(): Promise<string[]>;
27
28
  numNodes(): number;
28
29
  numMeshnodes(): number;
29
30
  numMeshes(): number;
@@ -16,8 +16,9 @@ export declare class PWFProxy implements PWF {
16
16
  featureFlags: ValidatedFeatureFlags;
17
17
  });
18
18
  setStandardModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, meshAB: ArrayBuffer): void;
19
- setPartitionedModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, partitionAB: ArrayBuffer): void;
20
- getPwfPartitionContentUrls(): string[];
19
+ setPartitionedModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, partitionProxiesAB: ArrayBuffer): void;
20
+ setHPartitionedModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, partitionProxiesAB: ArrayBuffer): void;
21
+ getPwfPartitionContentUrls(): Promise<string[]>;
21
22
  initPwfParser(): void;
22
23
  parsePwfNodes(): BootstrapperResult;
23
24
  parsePwfMeshnodes(): BootstrapperResult;
@@ -2,8 +2,12 @@ import type { DownloadMetaData } from '../procoregl/Models/Models';
2
2
  import type { PWF, PWFVersion } from './PWFTypes';
3
3
  export declare const MESHNODE_BUFFER_MAX_CHUNK_SIZE = 100000;
4
4
  export declare const NODE_BUFFER_MAX_CHUNK_SIZE = 100000;
5
- export declare const MESH_BUFFER_MAX_CHUNK_SIZE = 3000;
6
- export declare function isPartitionProxiesAB(buffer: ArrayBuffer): boolean;
5
+ export declare const MESH_BUFFER_MAX_CHUNK_SIZE = 2500;
6
+ export type STANDARD_MODEL = 'standard';
7
+ export type PARTITIONED_FLAT_MODEL = 'partitioned-flat';
8
+ export type PARTITIONED_TREE_MODEL = 'partitioned-tree';
9
+ export declare function inferModelTypeFromMeshAB(meshAB: ArrayBuffer): STANDARD_MODEL | PARTITIONED_FLAT_MODEL | PARTITIONED_TREE_MODEL;
10
+ export declare function extractDataFromPartitionProxiesAB(buffer: ArrayBuffer): ArrayBuffer;
7
11
  export declare function constructPartitionFASUrl(partitionUrl: string, baseUrl: string, projectId: number): string;
8
12
  export declare function trackDownloadComplete(params: {
9
13
  totalPartitionsSize?: number;
@@ -33,6 +33,7 @@ export declare class PWFV1 implements PWF {
33
33
  meshAB?: ArrayBuffer;
34
34
  partitionProxiesAB?: ArrayBuffer;
35
35
  pwfModelParser?: PWFModelParser;
36
+ modelType: 'standard' | 'partitioned-flat' | 'partitioned-tree';
36
37
  private _numMeshnodes;
37
38
  private _numMeshes;
38
39
  private _numNodes;
@@ -61,7 +62,8 @@ export declare class PWFV1 implements PWF {
61
62
  });
62
63
  setStandardModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, meshAB: ArrayBuffer): void;
63
64
  setPartitionedModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, partitionProxiesAB: ArrayBuffer): void;
64
- getPwfPartitionContentUrls(): string[];
65
+ setHPartitionedModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, partitionProxiesAB: ArrayBuffer): void;
66
+ getPwfPartitionContentUrls(): Promise<string[]>;
65
67
  initPwfParser(): void;
66
68
  parsePwfNodes(): BootstrapperResult;
67
69
  parsePwfMeshnodes(): BootstrapperResult;
@@ -0,0 +1,8 @@
1
+ import { PWFHPartitionProxy } from '../../interface/PWFHPartitionProxy';
2
+ export declare class HPartitionProxyBufferReader {
3
+ private readonly buffer;
4
+ constructor(buffer: ArrayBuffer);
5
+ parse(): PWFHPartitionProxy[];
6
+ private index;
7
+ private forEach;
8
+ }
@@ -0,0 +1,14 @@
1
+ import { PWFHPartitionProxy } from '../../interface/PWFHPartitionProxy';
2
+ export declare class PWFHPartitionProxyNoCache implements PWFHPartitionProxy {
3
+ private readonly _buffer;
4
+ private readonly _offset;
5
+ constructor(buffer: ArrayBuffer, offset: number);
6
+ offset(): number;
7
+ partitionId(): number;
8
+ partitionUrl(): string;
9
+ meshnodeOffsets(): Uint32Array;
10
+ bbox(): Float32Array;
11
+ childrenIds(): Uint32Array;
12
+ size(): number;
13
+ token(): string;
14
+ }
@@ -0,0 +1,19 @@
1
+ export declare class PWFHPartitionProxyReader {
2
+ static recordByteSize(buffer: ArrayBuffer, offset: number): number;
3
+ static partitionId(buffer: ArrayBuffer, offset: number): number;
4
+ private static partitionIdAttribute;
5
+ static numChildren(buffer: ArrayBuffer, offset: number): number;
6
+ private static numChildrenAttribute;
7
+ static childrenIds(buffer: ArrayBuffer, offset: number): Uint32Array;
8
+ private static childrenIdsAttribute;
9
+ static bbox(buffer: ArrayBuffer, offset: number): Float32Array;
10
+ private static bboxAttribute;
11
+ static numMeshnodes(buffer: ArrayBuffer, offset: number): number;
12
+ private static numMeshnodesAttribute;
13
+ static meshnodeOffsets(buffer: ArrayBuffer, offset: number): Uint32Array;
14
+ private static meshnodeOffsetsAttribute;
15
+ static tokenSize(buffer: ArrayBuffer, offset: number): number;
16
+ private static tokenSizeAttribute;
17
+ static token(buffer: ArrayBuffer, offset: number): string;
18
+ private static tokenAttribute;
19
+ }
@@ -0,0 +1,7 @@
1
+ import { PWFPartitionProxy } from './PWFPartitionProxy';
2
+ export interface PWFHPartitionProxy extends PWFPartitionProxy {
3
+ bbox(): Float32Array;
4
+ childrenIds(): Uint32Array;
5
+ size(): number;
6
+ token(): string;
7
+ }
@@ -1,12 +1,14 @@
1
1
  import type { PWFV1 } from '../PWFV1';
2
2
  import { Meshnode } from './Meshnode';
3
3
  import { PWFMeshnode } from '../interface/PWFMeshnode';
4
+ import type { ValidatedFeatureFlags } from '../../../types/WebviewerOptions';
4
5
  export declare class MeshnodeServices {
5
6
  private meshnodeCount;
6
7
  private meshnodes;
7
8
  protected pwf: PWFV1;
8
9
  protected cachedMeshnodes: Map<number, Meshnode>;
9
- constructor(pwfMeshnodes: PWFMeshnode[], pwf: PWFV1);
10
+ protected readonly featureFlags: ValidatedFeatureFlags;
11
+ constructor(pwfMeshnodes: PWFMeshnode[], pwf: PWFV1, featureFlags: ValidatedFeatureFlags);
10
12
  getMeshnodeFromIndex(index: number): Meshnode;
11
13
  getMeshnode(offset: number): Meshnode;
12
14
  numMeshnodes(): number;
@@ -0,0 +1,20 @@
1
+ import { StreamedMeshServices } from './StreamedMeshServices';
2
+ import { PWFHPartitionProxy } from '../interface/PWFHPartitionProxy';
3
+ import { PartitionProxy } from './PartitionProxy';
4
+ export declare class HPartitionProxy extends PartitionProxy {
5
+ static devModelName: string;
6
+ private pwfHPartitionProxy;
7
+ constructor(params: {
8
+ pwfHPartitionProxy: PWFHPartitionProxy;
9
+ meshServices: StreamedMeshServices;
10
+ });
11
+ partitionId(): number;
12
+ partitionUrl(): Promise<string>;
13
+ meshnodeOffsets(): Uint32Array;
14
+ size(): {
15
+ compressed: number;
16
+ size: number;
17
+ };
18
+ static processPartitionProxiesAB(partitionProxiesAB: ArrayBuffer, meshServices: StreamedMeshServices, callback: (partitionProxy: HPartitionProxy) => void): void;
19
+ static getPartitionProxies(partitionProxiesAB: ArrayBuffer): PWFHPartitionProxy[];
20
+ }
@@ -12,9 +12,9 @@ export declare class PartitionProxy {
12
12
  isLoading: boolean;
13
13
  isLoaded: boolean;
14
14
  meshRef2Meshnodes: Map<number, StreamedMeshnode[]>;
15
- private _meshnodes;
16
- private _byteLength?;
17
- private _compressedByteLength;
15
+ protected _meshnodes: StreamedMeshnode[];
16
+ protected _byteLength?: number;
17
+ protected _compressedByteLength: number;
18
18
  private stats;
19
19
  private static partitionDownloadManager;
20
20
  constructor(params: {
@@ -65,7 +65,8 @@ export declare class PWFV2 implements PWF {
65
65
  });
66
66
  setStandardModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, meshAB: ArrayBuffer): void;
67
67
  setPartitionedModelBuffers(nodeAB: ArrayBuffer, meshnodeAB: ArrayBuffer, partitionProxiesAB: ArrayBuffer): void;
68
- getPwfPartitionContentUrls(): string[];
68
+ setHPartitionedModelBuffers(_nodeAB: ArrayBuffer, _meshnodeAB: ArrayBuffer, _partitionProxiesAB: ArrayBuffer): void;
69
+ getPwfPartitionContentUrls(): Promise<string[]>;
69
70
  initPwfParser(): void;
70
71
  parsePwfNodes(): BootstrapperResult;
71
72
  parsePwfMeshnodes(): BootstrapperResult;
@@ -5,7 +5,6 @@ import { StreamedGeometryFactory } from '../../../procoregl/StreamedGeometryFact
5
5
  import { StreamedMeshServices } from './StreamedMeshServices';
6
6
  export declare class PartitionProxy {
7
7
  private pwfPartitionProxy;
8
- private meshServices;
9
8
  static numberOfPartitions: number;
10
9
  static numberOfPartitionsLoaded: number;
11
10
  static currentNumberOfDownloading: number;
@@ -31,7 +30,7 @@ export declare class PartitionProxy {
31
30
  meshnodes(): StreamedMeshnode[];
32
31
  setMeshnodes(meshnodes: StreamedMeshnode[]): void;
33
32
  loadPartitionData(callbackFn: (partition: Partition) => void): Promise<void>;
34
- loadPartition(factory: StreamedGeometryFactory): Promise<void>;
33
+ loadPartition(_factory: StreamedGeometryFactory): Promise<void>;
35
34
  size(): {
36
35
  compressed: number;
37
36
  size: number;
@@ -1,7 +1,6 @@
1
1
  import { StreamedMeshGeometry } from '../../../procoregl/StreamedMeshGeometry';
2
2
  import type { PWFV2 } from '../PWFV2';
3
3
  import { MeshServices } from '../standard';
4
- import type { StreamedMeshnode } from './StreamedMeshnode';
5
4
  import { MeshObject } from '../objects/MeshObject';
6
5
  import { MeshData } from './MeshData';
7
6
  import { Mesh } from '../standard/Mesh';
@@ -25,7 +24,7 @@ export declare class StreamedMeshServices extends MeshServices {
25
24
  closeOPFS(): Promise<void>;
26
25
  writeMeshDataToOPFS(meshData: MeshData): Promise<void>;
27
26
  getMeshObject(meshIndex: number): MeshObject;
28
- loadPartitionContainingMeshnode(_streamedMeshnode: StreamedMeshnode): Promise<boolean>;
27
+ loadPartitionContainingMeshnode(): void;
29
28
  getMeshGeometryForOffsets(meshOffset: number, meshnodeOffset: number): StreamedMeshGeometry | undefined;
30
29
  meshFromOffset(meshIndex: number): Mesh;
31
30
  private getCompressedMeshDataFromOPFS;
@@ -5,12 +5,10 @@ import { PartitionProxy } from './PartitionProxy';
5
5
  import { StreamedMeshGeometry } from '../../../procoregl/StreamedMeshGeometry';
6
6
  export declare class StreamedMeshnode extends Meshnode {
7
7
  private _partitionProxy?;
8
- private _meshGeometries;
9
8
  setPartitionProxy(partitionProxy: PartitionProxy): void;
10
9
  partitionProxy(): PartitionProxy;
11
10
  meshGeometries(): MeshGeometry[];
12
- setMeshGeometry(meshIndex: number, meshGeometry: StreamedMeshGeometry): void;
13
- getMeshGeometry(meshIndex: number): StreamedMeshGeometry | undefined;
11
+ getMeshGeometry(_meshIndex: number): StreamedMeshGeometry | undefined;
14
12
  asObject(): MeshnodeObject;
15
13
  private getMeshObject;
16
14
  }
@@ -8,6 +8,7 @@ export type FeatureFlags = {
8
8
  * @beta Enables writing mesh data to OPFS for partitioned models, which allows users to use features that use mesh data, notably Point to Point.
9
9
  */
10
10
  enableMeshDataOnOPFS: boolean;
11
+ enableProgressiveLoading: boolean;
11
12
  };
12
13
  export type ValidatedFeatureFlags = Readonly<FeatureFlags>;
13
14
  export type CommonOptions = {
@@ -7,6 +7,4 @@ export declare const RENDER_MODE: {
7
7
  readonly XRAY: "xray";
8
8
  };
9
9
  export type RenderMode = (typeof RENDER_MODE)[keyof typeof RENDER_MODE];
10
- export declare const PREFETCHED_PARTITIONS = true;
11
- export declare const PROGRESSIVE_PARTITIONS = false;
12
10
  export declare const LOG_RENDERER_MESHNODES_STATS = false;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@procore/bim-webviewer-sdk",
3
- "version": "17.6.0-rc.9",
3
+ "version": "17.6.0-release-17.6.0-test-inline-worker-changes.0",
4
4
  "description": "Procore BIM Webviewer SDK",
5
5
  "main": "dist/Procore.Bim.Webviewer.js",
6
6
  "types": "dist/Procore.Bim.Webviewer.d.ts",
@@ -1,5 +0,0 @@
1
- /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */
2
-
3
- /** @license URI.js v4.4.1 (c) 2011 Gary Court. License: http://github.com/garycourt/uri-js */
4
-
5
- //!\ DECLARE ALIAS AFTER assign prototype !
@@ -1,3 +0,0 @@
1
- /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */
2
-
3
- //!\ DECLARE ALIAS AFTER assign prototype !