@procore/bim-webviewer-sdk 15.2.0-rc.0 → 15.3.0-rc.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 (28) hide show
  1. package/CHANGELOG.md +19 -4
  2. package/dist/Procore.Bim.Webviewer.d.ts +749 -6
  3. package/dist/Procore.Bim.Webviewer.js +1 -1
  4. package/dist/types/src/Webviewer.d.ts +21 -5
  5. package/dist/types/src/api/analytic_events/analyticKeys.d.ts +2 -0
  6. package/dist/types/src/api/analytic_events/payloadFactories.d.ts +1 -0
  7. package/dist/types/src/components/ViewpointManager/ViewpointManager.d.ts +6 -2
  8. package/dist/types/src/controllers/RenderController.d.ts +4 -4
  9. package/dist/types/src/controllers/RenderControllerProxy.d.ts +99 -98
  10. package/dist/types/src/controllers/RenderControllerWorker.d.ts +94 -94
  11. package/dist/types/src/procoregl/HiddenNodeServices/HiddenNodeServices.d.ts +3 -1
  12. package/dist/types/src/sdk.d.ts +4 -1
  13. package/dist/types/src/types/Palette.d.ts +1 -1
  14. package/dist/types/src/types/WebviewerOptions.d.ts +28 -1
  15. package/dist/types/src/utils/ApiMetaData/ApiMetaData.d.ts +18 -12
  16. package/dist/types/src/utils/ApiMetaData/__tests__/mocks.d.ts +25 -1
  17. package/dist/types/src/utils/Error/CustomError.d.ts +3 -0
  18. package/dist/types/src/utils/Error/ErrorLogger.d.ts +12 -0
  19. package/dist/types/src/utils/Error/ExternalError.d.ts +5 -0
  20. package/dist/types/src/utils/Error/__tests__/CustomError.test.d.ts +1 -0
  21. package/dist/types/src/utils/Error/__tests__/ErrorLogger.test.d.ts +1 -0
  22. package/dist/types/src/utils/Error/__tests__/ExternalError.test.d.ts +1 -0
  23. package/dist/types/src/utils/Error/index.d.ts +3 -0
  24. package/dist/types/src/utils/Logger/BugsnagLogger.d.ts +8 -0
  25. package/dist/types/src/utils/Logger/Logger.d.ts +3 -0
  26. package/dist/types/src/utils/Logger/__tests__/BugsnagLogger.test.d.ts +1 -0
  27. package/dist/types/src/utils/Logger/index.d.ts +2 -0
  28. package/package.json +1 -1
@@ -4,9 +4,10 @@ declare const Cache: {
4
4
  };
5
5
  export { Cache };
6
6
  export { Webviewer } from './Webviewer';
7
+ export type { ResourceDiscriminator } from './Webviewer';
7
8
  export { BenchmarkReporter as Benchmark } from './utils/Benchmark';
8
9
  export { TestRoutineRecorder } from './utils/Benchmark';
9
- export type { Options, GeometryBundle, FileExtractionModePwfV1OverrideOptions, FileExtractionModePwfV2OverrideOptions, FileExtractionModeOptions, ModelRevisionModePwfV2Options, ModelRevisionModePwfV1Options, PwfV1Bundle, PwfV2Bundle, CommonOptions, FeatureFlags, } from './types/WebviewerOptions';
10
+ export type { Options, GeometryBundle, FileExtractionModePwfV1OverrideOptions, FileExtractionModePwfV2OverrideOptions, FileExtractionModeOptions, ModelRevisionModePwfV2Options, ModelRevisionModePwfV1Options, Resource, ResourceOptions, FileExtractionModePwfV1OverrideResource, FileExtractionModePwfV2OverrideResource, FileExtractionModeResource, ModelRevisionModePwfV1Resource, ModelRevisionModePwfV2Resource, PwfV1Bundle, PwfV2Bundle, CommonOptions, FeatureFlags, } from './types/WebviewerOptions';
10
11
  export type { GeometryFile, FileExtraction, BimFileUpload, FileExtractionItem, WebFormatExtractionItem, PropertiesExtractionItem, FileVersion, Attachment, PropertiesFile, } from './api/types/FileExtraction';
11
12
  export type { Model } from './api/types/Model';
12
13
  export type { ModelRevision, ModelRevisionViewpoint, } from './api/types/ModelRevision';
@@ -30,5 +31,7 @@ export { TOOL_BAR_TOOLS } from './components/ToolBarTools';
30
31
  export type { ToolBarTools } from './components/ToolBarTools';
31
32
  export { ACTION } from './utils/Enums';
32
33
  export type { Action } from './utils/Enums';
34
+ export type { PaletteParams } from './types/Palette';
33
35
  declare const version: string;
34
36
  export { version };
37
+ export { ErrorLogger } from './utils/Error';
@@ -10,7 +10,7 @@ export type Palette = {
10
10
  xray?: Color;
11
11
  selected?: Color;
12
12
  };
13
- type PaletteParams = {
13
+ export type PaletteParams = {
14
14
  palette: Palette;
15
15
  objectIds: NodeId[];
16
16
  };
@@ -91,12 +91,39 @@ export type ModelRevisionModePwfV2Options = CommonOptions & PwfV2Bundle & {
91
91
  modelId: Model['id'];
92
92
  modelRevisionId: ModelRevision['id'];
93
93
  };
94
- export type Options = FileExtractionModePwfV2OverrideOptions | FileExtractionModePwfV1OverrideOptions | FileExtractionModeOptions | ModelRevisionModePwfV2Options | ModelRevisionModePwfV1Options;
94
+ export type FileExtractionModePwfV1OverrideResource = PwfV1Bundle & {
95
+ fileExtractionId: FileExtraction['id'];
96
+ };
97
+ export type FileExtractionModePwfV2OverrideResource = PwfV2Bundle & {
98
+ fileExtractionId: FileExtraction['id'];
99
+ };
100
+ export type FileExtractionModeResource = {
101
+ fileExtractionId: FileExtraction['id'];
102
+ };
103
+ export type ModelRevisionModePwfV1Resource = PwfV1Bundle & {
104
+ modelId: Model['id'];
105
+ modelRevisionId: ModelRevision['id'];
106
+ };
107
+ export type ModelRevisionModePwfV2Resource = PwfV2Bundle & {
108
+ modelId: Model['id'];
109
+ modelRevisionId: ModelRevision['id'];
110
+ };
111
+ export type Resource = FileExtractionModePwfV1OverrideResource | FileExtractionModePwfV2OverrideResource | FileExtractionModeResource | ModelRevisionModePwfV1Resource | ModelRevisionModePwfV2Resource;
112
+ export type ResourceOptions = CommonOptions & {
113
+ resources: Resource[];
114
+ };
115
+ export type Options = FileExtractionModePwfV2OverrideOptions | FileExtractionModePwfV1OverrideOptions | FileExtractionModeOptions | ModelRevisionModePwfV2Options | ModelRevisionModePwfV1Options | ResourceOptions;
95
116
  export declare const isModelRevisionModePwfV1Options: (options: Options) => options is ModelRevisionModePwfV1Options;
96
117
  export declare const isModelRevisionModePwfV2Options: (options: Options) => options is ModelRevisionModePwfV2Options;
97
118
  export declare const isFileExtractionModePwfV1OverrideOptions: (options: Options) => options is FileExtractionModePwfV1OverrideOptions;
98
119
  export declare const isFileExtractionModePwfV2OverrideOptions: (options: Options) => options is FileExtractionModePwfV2OverrideOptions;
99
120
  export declare const isFileExtractionModeOptions: (options: Options) => options is FileExtractionModeOptions;
121
+ export declare const isFileExtractionModePwfV2OverrideResource: (resource: Resource) => resource is FileExtractionModePwfV2OverrideResource;
122
+ export declare const isFileExtractionModePwfV1OverrideResource: (resource: Resource) => resource is FileExtractionModePwfV1OverrideResource;
123
+ export declare const isFileExtractionModeResource: (resource: Resource) => resource is FileExtractionModeResource;
124
+ export declare const isModelRevisionModePwfV2Resource: (resource: Resource) => resource is ModelRevisionModePwfV2Resource;
125
+ export declare const isModelRevisionModePwfV1Resource: (resource: Resource) => resource is ModelRevisionModePwfV1Resource;
126
+ export declare const isResourceOptions: (options: Options) => options is ResourceOptions;
100
127
  /**
101
128
  * Type Testing
102
129
  *
@@ -1,9 +1,16 @@
1
- import { PropertiesFile, FileVersion, Attachment } from '../../api/types/FileExtraction';
1
+ import { FileExtraction, PropertiesFile, FileVersion, Attachment } from '../../api/types/FileExtraction';
2
2
  import { ModelRevision } from '../../api/types/ModelRevision';
3
3
  import * as FileExtractions from '../../api/bim_file_extractions';
4
4
  import * as BimModelRevisions from '../../api/bim_model_revisions';
5
5
  import { Options, GeometryBundle } from '../../types/WebviewerOptions';
6
6
  import { InternalViewpoint } from '../../viewpoint/types';
7
+ import { Model } from '../../api/types/Model';
8
+ export type ResourceBundle = ({
9
+ fileExtractionId: FileExtraction['id'];
10
+ } | {
11
+ modelId: Model['id'];
12
+ modelRevisionId: ModelRevision['id'];
13
+ }) & GeometryBundle;
7
14
  type Api = {
8
15
  getBimFileExtraction: typeof FileExtractions.GetBimFileExtraction;
9
16
  getBimModelRevision: typeof BimModelRevisions.GetBimModelRevision;
@@ -19,19 +26,18 @@ export declare class ApiMetaData {
19
26
  private api;
20
27
  apiMode: ApiMode;
21
28
  constructor(options: Options & ApiOptions);
22
- private get fileExtractionBundle();
23
- get fileVersion(): Promise<FileVersion>;
24
- get attachment(): Promise<Attachment>;
25
- private geometryUrlsProvided;
26
- private get geometryBundleInFileExtractionMode();
27
- private get geometryBundleInModelRevisionMode();
28
- get geometryBundle(): Promise<GeometryBundle>;
29
- get propertyFileId(): Promise<PropertiesFile['id']>;
30
- get modelRevisionId(): Promise<number>;
31
- get modelId(): Promise<number>;
29
+ private getFileExtractionBundle;
30
+ get fileVersions(): Promise<FileVersion[]>;
31
+ get attachments(): Promise<Attachment[]>;
32
+ private getGeometryBundleInFileExtractionMode;
33
+ private getGeometryBundleInModelRevisionMode;
34
+ get geometryBundles(): Promise<ResourceBundle[]>;
35
+ get propertyFileIds(): Promise<PropertiesFile['id'][]>;
36
+ get modelRevisionIds(): Promise<number[]>;
37
+ get modelIds(): Promise<number[]>;
32
38
  get projectId(): Promise<number>;
33
39
  get companyId(): Promise<number>;
34
- get fileExtractionId(): Promise<number>;
40
+ get fileExtractionIds(): Promise<number[]>;
35
41
  get modelRevision(): Promise<ModelRevision>;
36
42
  get homeViewpoint(): Promise<InternalViewpoint | undefined>;
37
43
  private get homeViewpointInModelRevisionMode();
@@ -1,17 +1,25 @@
1
- import type { FileExtractionModePwfV2OverrideOptions, FileExtractionModePwfV1OverrideOptions, FileExtractionModeOptions, ModelRevisionModePwfV2Options, ModelRevisionModePwfV1Options } from '../../../types/WebviewerOptions';
1
+ import type { FileExtractionModePwfV2OverrideOptions, FileExtractionModePwfV1OverrideOptions, FileExtractionModeOptions, ModelRevisionModePwfV2Options, ModelRevisionModePwfV1Options, FileExtractionModePwfV1OverrideResource, FileExtractionModePwfV2OverrideResource, ModelRevisionModePwfV1Resource, ModelRevisionModePwfV2Resource, ResourceOptions } from '../../../types/WebviewerOptions';
2
2
  import { FileExtraction } from '../../../api/types/FileExtraction';
3
3
  import { ModelRevision, ModelRevisionViewpoint } from '../../../api/types/ModelRevision';
4
4
  import { InternalViewpoint } from '../../../viewpoint/types';
5
5
  export declare const projectId = 4;
6
6
  export declare const companyId = 1;
7
7
  export declare const fileExtractionId = 1;
8
+ export declare const fileExtractionIds: number[];
8
9
  export declare const modelId = 2;
10
+ export declare const modelIds: number[];
9
11
  export declare const modelRevisionId = 3;
12
+ export declare const modelRevisionIds: number[];
10
13
  export declare const propertyFileId = 5;
14
+ export declare const propertyFileIds: number[];
11
15
  export declare const fileVersion: {
12
16
  id: number;
13
17
  file_id: number;
14
18
  };
19
+ export declare const fileVersions: {
20
+ id: number;
21
+ file_id: number;
22
+ }[];
15
23
  export declare const attachment: {
16
24
  id: number;
17
25
  content_type: string;
@@ -19,6 +27,13 @@ export declare const attachment: {
19
27
  size: number;
20
28
  url: string;
21
29
  };
30
+ export declare const attachments: {
31
+ id: number;
32
+ content_type: string;
33
+ name: string;
34
+ size: number;
35
+ url: string;
36
+ }[];
22
37
  export declare const nodeUrl = "a node url";
23
38
  export declare const meshnodeUrl = "a meshnode url";
24
39
  export declare const meshUrl = "a mesh url";
@@ -39,6 +54,15 @@ export declare const fileExtractionModePwfV2OverrideOptions: FileExtractionModeP
39
54
  export declare const fileExtractionModeOptions: FileExtractionModeOptions;
40
55
  export declare const modelRevisionModePwfV1Options: ModelRevisionModePwfV1Options;
41
56
  export declare const modelRevisionModePwfV2Options: ModelRevisionModePwfV2Options;
57
+ export declare const fileExtractionModeResourceOptions: ResourceOptions;
58
+ export declare const fileExtractionModePwfV1OverrideResource: FileExtractionModePwfV1OverrideResource;
59
+ export declare const fileExtractionModePwfV1OverrideResourceOptions: ResourceOptions;
60
+ export declare const fileExtractionModePwfV2OverrideResource: FileExtractionModePwfV2OverrideResource;
61
+ export declare const fileExtractionModePwfV2OverrideResourceOptions: ResourceOptions;
62
+ export declare const modelRevisionModePwfV1Resource: ModelRevisionModePwfV1Resource;
63
+ export declare const modelRevisionModePwfV1ResourceOptions: ResourceOptions;
64
+ export declare const modelRevisionModePwfV2Resource: ModelRevisionModePwfV2Resource;
65
+ export declare const modelRevisionModePwfV2ResourceOptions: ResourceOptions;
42
66
  export declare const fileExtraction: FileExtraction;
43
67
  export declare const homeViewpoint: ModelRevisionViewpoint;
44
68
  export declare const modelRevision: ModelRevision;
@@ -0,0 +1,3 @@
1
+ export declare class CustomError extends Error {
2
+ constructor(...params: ConstructorParameters<typeof Error>);
3
+ }
@@ -0,0 +1,12 @@
1
+ import { Logger } from '../Logger';
2
+ export declare namespace ErrorLogger {
3
+ let logger: Logger;
4
+ const init: (params: {
5
+ bugsnagConfig: {
6
+ apiKey: string;
7
+ releaseStage?: string;
8
+ };
9
+ }) => void;
10
+ const logError: <T extends Error>(error: T) => void;
11
+ const dispose: () => void;
12
+ }
@@ -0,0 +1,5 @@
1
+ import { CustomError } from './CustomError';
2
+ export declare class ExternalError extends CustomError {
3
+ external: true;
4
+ constructor(...params: ConstructorParameters<typeof CustomError>);
5
+ }
@@ -0,0 +1,3 @@
1
+ export { CustomError } from './CustomError';
2
+ export { ExternalError } from './ExternalError';
3
+ export { ErrorLogger } from './ErrorLogger';
@@ -0,0 +1,8 @@
1
+ import { Logger } from './Logger';
2
+ export declare class BugsnagLogger implements Logger {
3
+ constructor(config: {
4
+ apiKey: string;
5
+ releaseStage?: string;
6
+ });
7
+ logError(error: any): void;
8
+ }
@@ -0,0 +1,3 @@
1
+ export interface Logger {
2
+ logError(error: any): void;
3
+ }
@@ -0,0 +1,2 @@
1
+ export { Logger } from './Logger';
2
+ export { BugsnagLogger } from './BugsnagLogger';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@procore/bim-webviewer-sdk",
3
- "version": "15.2.0-rc.0",
3
+ "version": "15.3.0-rc.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",