@procore/bim-webviewer-sdk 1.10.0-rc.0 → 2.0.0-BIM-1586

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.
package/CHANGELOG.md CHANGED
@@ -4,51 +4,84 @@ All notable changes to this project will be documented in this file.
4
4
 
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
+ ## [Unreleased]
8
+
9
+ ### Changed
10
+
11
+ - NOT GENERALLY AVAILABLE - Gated by the 'webviewer-meshnode-caching' LanchDarkly switch. Changed the Meshnode caching implementation from a LRUCache to a simple Javascript Map. This allows engineering to experiment in staging and production to better understands how performance changes with this change.
12
+
13
+ ### Added
14
+
15
+ - Added missing CSS for Webviewer when included outside of Procore domain.
16
+ - Introduces new "Developer documentation" in the form of always up-to-date, versionned C4 and UML diagrams, using PlantUML syntax.
17
+ - Provides examples on how to leverage our PlantUML-based diagrams in Github and in Confluence, using Markdown syntax.
18
+ - Updates the release process in README.md to ensure that we publish always up-to-date Level 4 C4 diagrams for our Javascript/Typescript code. base.
19
+ - Addition of a README.md file in every folder under `src/`, that renders the dependency diagram when browsing code in Github.
20
+
21
+ ## [2.0.0] - 2022-03-25
22
+
23
+ ### Added
24
+
25
+ - Caching is now handled internally by the Webviewer SDK. Prior to this release, the only way we allowed for cached models was through a Service Worker provided separately from this npm package (or implementing one yourself). If you were using a service worker in this way, it will no longer be registered by the SDK and from the SDK's perspective is useless and can be deleted.
26
+
27
+ ### Changed
28
+
29
+ - [BREAKING CHANGE] Change `enableWebWorker` option default to true. If you were not declaring this option before and want to maintain the old behavior then you must set `enableWebWorker: false`. We will still check if Web Workers are supported by the environment even if this is unset or set to true and gracefully fallback if they are not supported.
30
+
31
+ ### Removed
32
+
33
+ - [BREAKING CHANGE] Removed `improved_raytest` option and always use the Improved Raytest codepath. If you were using `improved_raytest: false` or not defining it then you will see different behavior on this version.
34
+ - [BREAKING CHANGE] Removed `rest_version` option. If you were previously using the `/vapid/` endpoints specifically with this option, you will now be using the `rest/v1.0` endpoints. This option defaulted to use the `rest/v1.0` endpoints so no change necessary if you were not using it.
35
+ - Removed `improved_modeltree` option. This was unused as we were already always using the Improved Modeltree
36
+ - Removed `enableClipping` option. This was not doing anything.
37
+ - Removed Service Worker options: `swEnable`, `swScope`, and `swUrl`. This is not a breaking change and caching will continue to work. See note on caching changes in 'Added' section of this release
7
38
 
8
39
  ## [1.10.0] - 2022-03-11
9
40
 
10
- ## Changed
41
+ ### Changed
11
42
 
12
43
  - Refactored Mesh and Meshnode into true primitives implementing lazy evaluation of their attributes, along with caching of Meshnodes.
44
+ - Allow Webviewer to be initialized with File Extraction ID
45
+ - Refactored Performance Benchmark to promises so that each sample takes exactly as long as it needs. This is faster than before where we just waited long enough (500ms) for things to finish.
13
46
 
14
- ## Fixed
47
+ ### Fixed
15
48
 
16
49
  - Model Tree will now render for objects with non-sequential property ID's
17
50
 
18
51
  ## [1.9.0] - 2022-02-28
19
52
 
20
- ## Fixed
53
+ ### Fixed
21
54
 
22
55
  - Fixed issue where moving into low-density zones would cause performance in high-density zones to suffer.
23
56
 
24
- ## Changed
57
+ ### Changed
25
58
 
26
59
  - Updated Style of keyboard shortcuts and tooltips
27
60
 
28
- ## Added
61
+ ### Added
29
62
 
30
63
  - Added translations for search empty state in Properties window
31
64
 
32
65
  ## [1.8.1] - 2022-02-11
33
66
 
34
- ## Added
67
+ ### Added
35
68
 
36
69
  - Add ability to filter properties in the Properties window
37
70
  - Webgl2 support
38
71
 
39
72
  ## [1.7.0] - 2022-01-28
40
73
 
41
- ## Added
74
+ ### Added
42
75
 
43
76
  - Add GUI for rendering parameters behind debug initialization
44
77
 
45
- ## Changed
78
+ ### Changed
46
79
 
47
80
  - Improved transparency accuracy at rest
48
81
 
49
82
  ## [1.6.0] - 2022-01-07
50
83
 
51
- ## Changed
84
+ ### Changed
52
85
 
53
86
  - Improved rendering performance for a more cinematic experience:
54
87
  - Reduced flashing of objects while moving
@@ -56,7 +89,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
56
89
  - Prioritize rendering objects closer to camera while moving
57
90
  - Upgraded threejs to r111
58
91
 
59
- ## Fixed
92
+ ### Fixed
60
93
 
61
94
  - Event for `View Properties` using the context menu now uses `context_menu` for the origin key
62
95
  - New frozen object `ToolOrigin` is used when publishing `selectTool` events on origin key
@@ -70,34 +103,34 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
70
103
 
71
104
  ## [v1.5.1] - 2021-12-16
72
105
 
73
- ## Fixed
106
+ ### Fixed
74
107
 
75
108
  - Small and far objects are now correctly culled
76
109
 
77
110
  ## [v1.5.0] - 2021-12-10
78
111
 
79
- ## Added
112
+ ### Added
80
113
 
81
114
  - Added culling of small and far objects to improve rendering performance
82
115
  - Added translations for View Properties
83
116
 
84
117
  ## [v1.4.0] - 2021-11-19
85
118
 
86
- ## Added
119
+ ### Added
87
120
 
88
121
  - Added new events `hideSimilarCompleted` and `isolateCompleted`, which are invoked from the right click context menu.
89
122
  - Added `Properties` tool
90
123
 
91
124
  ## [v1.3.4] - 2021-11-12
92
125
 
93
- ## Fixed
126
+ ### Fixed
94
127
 
95
128
  - Section Data from published Viewpoints will now display correctly.
96
129
  - Fixed mouse scroll to zoom on the 2D Plan map modal.
97
130
 
98
131
  ## [v1.3.3] - 2021-11-09
99
132
 
100
- ## Fixed
133
+ ### Fixed
101
134
 
102
135
  - Fixed window components from getting stuck outside the browser window when switching from different window sizes.
103
136
  - Fixed keyboard shortcut for `Shift + Left Click` to select objects while in Fly/Orbit Navigation.