@bimdata/viewer 1.10.2 → 2.0.0-alpha-zone-editor.1

package/CHANGELOG.md

@@ -1,20 +1,73 @@
-## [1.10.2](https://github.com/bimdata/viewer/compare/v1.10.1...v1.10.2) (2023-06-21)
-
-
-### PATCH
-
-* replace big gif with webp ([3b386db](https://github.com/bimdata/viewer/commit/3b386db01a78a4c7dbc1579742150f7aee0231c0))
-
-## [1.10.1](https://github.com/bimdata/viewer/compare/v1.10.0...v1.10.1) (2023-06-14)
-
-
-### PATCH
-
-* add (types) after type pset names (#891) ([2c9479a](https://github.com/bimdata/viewer/commit/2c9479ac32383555668dc6faf6b1ab19bbcfc7d5)), closes [#891](https://github.com/bimdata/viewer/issues/891)
+# [2.0.0-alpha.1](https://github.com/bimdata/viewer/compare/v2.0.0-alpha.1...v1.9.0) (2023-04-14)
+
+Update to [Vue.js](https://vuejs.org/) framework version 3.
+This brings some breaking changes in the writting of plugins due to the major version increase.
+Please follow [this guide](https://v3-migration.vuejs.org/) to update your plugins.
+
+## FEATURES
+
+[Vue.js](https://vuejs.org/) v3 brings the new [composition API](https://vuejs.org/guide/introduction.html#composition-api) & the [script setup support](https://vuejs.org/api/sfc-script-setup.html).
+
+`$viewer` is available as injection.
+
+Example of a plugin using the composition API:
+
+```js
+import { inject } from "vue";
+
+export default {
+  setup() {
+    const $viewer = inject("$viewer");
+    // your code here
+  }
+};
+```
+
+## DEPRECATED
+
+* To limit incompatibility issues, `destroyed` & `beforeDestroy` vue.js component lifecyles are still available but logged as deprecated. Please migrate to `beforeUnmount` & `unmounted`.
+* `localContext` & `globalContext` `incrementSpinnerProcesses` & `decrementSpinnerProcesses` are deprecated, please use `loadingProcessStart` & `loadingProcessEnd` instead.
+* `localContext.getPlugin(pluginName: string): Plugin` is deprecated, please use `localContext.plugins: Map<string, Plugin>` instead.
+* `globalContext.getPlugins(pluginName: string): Plugin[]` is deprecated, please use `globalContext.plugins: Map<string, Plugin[]>` instead.
+* `BIMDataViewerVue` is the `vue.js` instance the viewer is based on. Use it to write render functions or if you use the composition API in your plugins.
+
+## PLUGIN BUILD
+
+Due to the major Vue.js update, plugin build configuration must be updated. As the `h` function is now exposed on the vue.js instance, please use the globally available `BIMDataViewerVue` singleton.
+
+Example of vite configuration:
+
+```js
+import { defineConfig } from "vite";
+
+import vue from "@vitejs/plugin-vue";
+import cssInjectedByJsPlugin from "vite-plugin-css-injected-by-js";
+import externalGlobals from "rollup-plugin-external-globals";
+
+export default defineConfig(() => {
+  return {
+    build: {
+      lib: {
+        entry: "./src/myPlugin.js",
+        formats: ["es"],
+        name: "myPlugin",
+        fileName: "myPlugin.plugin",
+      },
+      minify: 'terser',
+    },
+    plugins: [
+      vue(),
+      cssInjectedByJsPlugin(),
+      externalGlobals({
+        vue: 'BIMDataViewerVue', // MANDATORY
+      }),
+    ],
+  };
+});
+```
 
 # [1.10.0](https://github.com/bimdata/viewer/compare/v1.9.0...v1.10.0) (2023-06-13)
 
-
 ### chore
 
 * rename platform repo ([81a4183](https://github.com/bimdata/viewer/commit/81a418399eda6a471aa89b0ed161c9087d2db651))
@@ -111,7 +164,6 @@
 
 # [1.9.0](https://github.com/bimdata/viewer/compare/v1.8.2...v1.9.0) (2022-11-24)
 
-
 ### ci
 
 * add sdk-viewer on triggering ([5aecddc](https://github.com/bimdata/viewer/commit/5aecddcf1765db80ad0126beed344897e11eaa85))
@@ -320,21 +372,18 @@
 
 ## [1.8.2](https://github.com/bimdata/viewer/compare/v1.8.1...v1.8.2) (2021-11-12)
 
-
 ### PATCH
 
 * IFC entities are not translated by default ([dd88067](https://github.com/bimdata/viewer/commit/dd88067efd01436e91f6526e49df69ac440b0983))
 
 ## [1.8.1](https://github.com/bimdata/viewer/compare/v1.8.0...v1.8.1) (2021-11-10)
 
-
 ### PATCH
 
 * add getLastEvent type ([3fee282](https://github.com/bimdata/viewer/commit/3fee282a92d92263702c7d644e2d62f7acada525))
 
 # [1.8.0](https://github.com/bimdata/viewer/compare/v1.7.5...v1.8.0) (2021-11-10)
 
-
 ### chore
 
 * update dev readme (#581) ([1883c4b](https://github.com/bimdata/viewer/commit/1883c4b170bdb76f3f13cac713b511e5d79a561e)), closes [#581](https://github.com/bimdata/viewer/issues/581)
@@ -361,21 +410,18 @@
 
 ## [1.7.5](https://github.com/bimdata/viewer/compare/v1.7.4...v1.7.5) (2021-10-19)
 
-
 ### PATCH
 
 * improve BCF search (#585) ([e11f738](https://github.com/bimdata/viewer/commit/e11f738214cce60700161acf1c8aa32381ed2862)), closes [#585](https://github.com/bimdata/viewer/issues/585)
 
 ## [1.7.4](https://github.com/bimdata/viewer/compare/v1.7.3...v1.7.4) (2021-10-18)
 
-
 ### PATCH
 
 * ignore archived ifc visibility if an archived model is loaded (#582) ([9dbf4cf](https://github.com/bimdata/viewer/commit/9dbf4cf9942df277b6a682724f4dfb76aa86d71b)), closes [#582](https://github.com/bimdata/viewer/issues/582)
 
 ## [1.7.3](https://github.com/bimdata/viewer/compare/v1.7.2...v1.7.3) (2021-10-13)
 
-
 ### Chore
 
 * Update README (#578) ([a59fa7f](https://github.com/bimdata/viewer/commit/a59fa7f2e127181ce60fd1a9d70c81d2682d8301)), closes [#578](https://github.com/bimdata/viewer/issues/578)
@@ -399,7 +445,6 @@
 
 ## [1.6.2](https://github.com/bimdata/viewer/compare/v1.6.1...v1.6.2) (2021-05-12)
 
-
 ### PATCH
 
 * fix logarithmicDepthBuffer (#527) ([d34b1aa](https://github.com/bimdata/viewer/commit/d34b1aa02f836cc8bcb891ff84bc05bfc87df460)), closes [#527](https://github.com/bimdata/viewer/issues/527)
@@ -407,14 +452,12 @@
 
 ## [1.6.1](https://github.com/bimdata/viewer/compare/v1.6.0...v1.6.1) (2021-05-10)
 
-
 ### PATCH
 
 * improve default 2D and 3D parameters (#526) ([02e3cd1](https://github.com/bimdata/viewer/commit/02e3cd1369654076eb4ecc4b996101e18c2b9473)), closes [#526](https://github.com/bimdata/viewer/issues/526)
 
 # [1.6.0](https://github.com/bimdata/viewer/compare/v1.5.6...v1.6.0) (2021-05-10)
 
-
 ### chore
 
 * update package.lock with npm 7 ([8ed2250](https://github.com/bimdata/viewer/commit/8ed225084e5a3cb15ff817bdb1d9bf7d24423934))
@@ -481,7 +524,6 @@
 
 # [1.5.0](https://github.com/bimdata/viewer/compare/v1.4.2...v1.5.0) (2021-02-19)
 
-
 ### MINOR
 
 * add showAllAnnotations ([ab45dd2](https://github.com/bimdata/viewer/commit/ab45dd2278801e409bf716ac4972703597368d8f))
@@ -496,14 +538,12 @@
 
 ## [1.4.2](https://github.com/bimdata/viewer/compare/v1.4.1...v1.4.2) (2021-02-15)
 
-
 ### PATCH
 
 * fix BCF users ([06b8022](https://github.com/bimdata/viewer/commit/06b80227a627ef2718f85f76da3921387c127f2d))
 
 ## [1.4.1](https://github.com/bimdata/viewer/compare/v1.4.0...v1.4.1) (2021-02-08)
 
-
 ### PATCH
 
 * fix sections in section tool plugin ([2db10b4](https://github.com/bimdata/viewer/commit/2db10b4020bb2500e0d799df24174e09df409851))
@@ -513,10 +553,9 @@
 
 # [1.4.0](https://github.com/bimdata/viewer/compare/v1.3.0...v1.4.0) (2021-02-02)
 
-
 ### MINOR
 
-* $viewer.currentContext is now a localContext ([9adabf2](https://github.com/bimdata/viewer/commit/9adabf25f31a9ceac9b8d1bc5ccfb6a117e82d62))
+* $viewer.currentLocalContext is now a localContext ([9adabf2](https://github.com/bimdata/viewer/commit/9adabf25f31a9ceac9b8d1bc5ccfb6a117e82d62))
 * add getRawElements method ([1cd193a](https://github.com/bimdata/viewer/commit/1cd193af29ed1cfcd629ea2e5df443ac9f78d126))
 * add structure-properties plugin reloadTrees ([b5c513e](https://github.com/bimdata/viewer/commit/b5c513e672afedd353ce0b4e2b13dd9a388bdd03))
 
@@ -531,21 +570,18 @@
 
 # [1.4.0-rc.4](https://github.com/bimdata/viewer/compare/v1.4.0-rc.3...v1.4.0-rc.4) (2021-02-02)
 
-
 ### PATCH
 
 * advanced object getters were not enumerable ([72b1997](https://github.com/bimdata/viewer/commit/72b1997280610e5a6cbfb5d7fea974db91c05ce4))
 
 # [1.4.0-rc.3](https://github.com/bimdata/viewer/compare/v1.4.0-rc.2...v1.4.0-rc.3) (2021-02-02)
 
-
 ### PATCH
 
 * fix component $close triggered when clicked away ([cf1a9c8](https://github.com/bimdata/viewer/commit/cf1a9c860f8cea7ad60d5a49e48be255d7ded32b))
 
 # [1.4.0-rc.2](https://github.com/bimdata/viewer/compare/v1.4.0-rc.1...v1.4.0-rc.2) (2021-02-02)
 
-
 ### MINOR
 
 * add getRawElements method ([1cd193a](https://github.com/bimdata/viewer/commit/1cd193af29ed1cfcd629ea2e5df443ac9f78d126))
@@ -553,28 +589,24 @@
 
 # [1.4.0-rc.1](https://github.com/bimdata/viewer/compare/v1.3.1-rc.3...v1.4.0-rc.1) (2021-02-01)
 
-
 ### MINOR
 
-* $viewer.currentContext is now a localContext ([9adabf2](https://github.com/bimdata/viewer/commit/9adabf25f31a9ceac9b8d1bc5ccfb6a117e82d62))
+* $viewer.currentLocalContext is now a localContext ([9adabf2](https://github.com/bimdata/viewer/commit/9adabf25f31a9ceac9b8d1bc5ccfb6a117e82d62))
 
 ## [1.3.1-rc.3](https://github.com/bimdata/viewer/compare/v1.3.1-rc.2...v1.3.1-rc.3) (2021-01-28)
 
-
 ### PATCH
 
 * fix xeokit version ([6521cb7](https://github.com/bimdata/viewer/commit/6521cb7b1d82b2100c093b8f533d5232d89ec429))
 
 ## [1.3.1-rc.2](https://github.com/bimdata/viewer/compare/v1.3.1-rc.1...v1.3.1-rc.2) (2021-01-28)
 
-
 ### PATCH
 
 * fix logarithmicDepthBuffer, upgrade xeokit ([530b5d9](https://github.com/bimdata/viewer/commit/530b5d969d6961dfb68ebd01879dd0b461c7a075))
 
 ## [1.3.1-rc.1](https://github.com/bimdata/viewer/compare/v1.3.0...v1.3.1-rc.1) (2021-01-26)
 
-
 ### PATCH
 
 * populate BCF calls with current user ([da701a7](https://github.com/bimdata/viewer/commit/da701a74a7fbfc232baeb3f228c76be280bd0a8f))