@procore/bim-webviewer-sdk 15.2.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
package/CHANGELOG.md CHANGED
@@ -5,24 +5,39 @@ 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
+ ## [15.3.0] - 2024-06-21
9
+
10
+ ### Changed
11
+
12
+ - Loading progress bar will not show percentage number.
13
+
14
+ ### Added
15
+
16
+ - Added ability to instantiate Webviewer with new `resources` option. Multiple models is not yet implemented so passing two models in as resources will not work in this ticket. However, you should be able to pass in a single model as an array of one `Resource` either as just a `fileExtractionId`, `fileExtractionId` with url overrides, or `modelId` + `modelRevisionId` with urls for local development
17
+ - Added `options.resource` argument to address multiple models with `model.setObjectColor`, `model.clearObjectColor`, and `model.clearAllObjectColor`.
18
+ - Added `ErrorLogger` namespace to the SDK. The `ErrorLogger` currently only supports Bugsnag configurations and will log errors to Bugsnag if the `bugsnagConfig` key is found in the params object of `ErrorLogger.init`. The `bugsnagConfig` object requires an `apiKey` key to be set, and optionally a `releaseStage` key.
19
+ - Added `defaultVisibilityAlwaysTrue` argument to `model.getVisibility` and `model.getViewpoint`
20
+ - When either method is called with `{ defaultVisibilityAlwaysTrue: true }` they will return a `visibility` object with `default_visibility: true` regardless of the number of hidden objects.
21
+ - When either method is called with `{ defaultVisibilityAlwaysTrue: false }` or not provided they will return a `visibility` object whose `default_visibility` field varies based on the amount of hidden objects.
22
+
8
23
  ## [15.2.0] - 2024-05-24
9
24
 
10
- ## Changed
25
+ ### Changed
11
26
 
12
27
  - Changed `model.getViewpoint` and `model.setViewpoint` to include `visibility` and `render_mode`.
13
28
  - Viewpoints selected in the Views tool now respect visibility and render mode if the views contain them.
14
29
  - Some enums and types for them are now exposed
15
- - `TOOL` and its type `Tool`. Used to enable tools when instantiating the `Webviewer.
30
+ - `TOOL` and its type `Tool`. Used to enable tools when instantiating the `Webviewer`.
16
31
  - `TOOL_BAR_TOOLS` and its type `ToolBarTools`. Used for enabling tools within the toolbar and for some events.
17
32
  - `ACTION` and its type `Action`. Used in some events to describe type of camera movement.
18
33
 
19
- ## Fixed
34
+ ### Fixed
20
35
 
21
36
  - Fixed `initialization` event will always set `success` to true even loading partition model is failed.
22
37
 
23
38
  ## [15.1.0] - 2024-05-13
24
39
 
25
- ## Added
40
+ ### Added
26
41
 
27
42
  - Add `model.getVisibility` and `model.setVisibility` methods.
28
43
  - These methods interact with the visibility portion of the viewpoints schema defined by the `bim_viewpoints` endpoint (https://developers.procore.com/reference/rest/v1/bim-viewpoints?version=1.0)