vim-web 0.3.27 → 0.3.29

package/README.md

@@ -1,83 +1,83 @@
-# VIM WebGL Component
-
-### Documentation
-
-Explore the full [API Documentation](https://vimaec.github.io/vim-web/api/).
-
-### Package
-https://www.npmjs.com/package/vim-web
-
-## Live Demo
-
-### WebGL Viewer
-- **[Small - Residence](https://vimaec.github.io/vim-web/webgl)**
-- **[Medium - Medical Tower](https://vimaec.github.io/vim-web/webgl?vim=https://vim.azureedge.net/samples/skanska.vim)**
-- **[Small - Stadium](https://vimaec.github.io/vim-web/webgl?vim=https://vim.azureedge.net/samples/stadium.vim)**
-
-### Ultra Viewer
-- **[Small - Residence](https://vimaec.github.io/vim-web/ultra)**
-- **[Medium - Medical Tower](https://vimaec.github.io/vim-web/ultra?vim=https://vim.azureedge.net/samples/skanska.vim)**
-- **[Small - Stadium](https://vimaec.github.io/vim-web/ultra?vim=https://vim.azureedge.net/samples/stadium.vim)**
-
-Find detailed camera controls here: [Camera Controls](https://docs.vimaec.com/docs/vim-cloud/webgl-navigation-and-controls-guide).
-
-## Overview
-
-The **VIM-Web** repository consists of four primary components, divided into two layers:
-
-### Core Viewers
-- **WebGL Viewer:** A WebGL-based viewer for the VIM format. Includes features like outlines, ghosting, and sectioning, but without UI components.
-- **Ultra Viewer:** A high-performance viewer for the VIM Ultra Render Server, optimized for scale and speed.
-
-### React Viewers
-- **WebGL Component:** A React-based wrapper for the WebGL viewer, providing interactive UI elements and a BIM explorer.
-- **Ultra Component:** A React-based wrapper for the Ultra viewer, featuring a UI for real-time interactions.
-
-## VIM Format
-
-The **VIM** file format is a high-performance 3D scene format that supports rich BIM data. It can also be extended to accommodate other relational and non-relational datasets. Unlike **IFC**, the VIM format is pre-tessellated, allowing for rapid loading and rendering.
-
-Learn more about the VIM format here: [VIM GitHub Repository](https://github.com/vimaec/vim).
-
-### Built With
-- [VIM WebGL Viewer](https://github.com/vimaec/vim-webgl-viewer)
-- [React.js](https://reactjs.org/)
-
-## Getting Started
-
-Follow these steps to get started with the project:
-
-1. Clone the repository.
-2. Open the project in **VS Code**.
-3. Install the dependencies: `npm install`.
-4. Start the development server: `npm run dev`.
-
-> **Note:** Ensure you have a recent version of **Node.js** installed, as required by Vite.
-
-## Repository Organization
-
-- **`./docs`:** Root folder for GitHub Pages, built using the `build:website` script.
-- **`./dist`:** Contains the built package for npm, created with the `build:libs` script.
-- **`./src/pages`:** Source code for the demo pages published on GitHub Pages.
-- **`./src/vim-web`:** Source code for building and publishing the vim-web npm package.
-- **`./src/core-viewers/webgl`:** Source code for the WebGL core viewer. Based on [vim-webgl-viewer](https://github.com/vimaec/vim-webgl-viewer).
-- **`./src/core-viewers/ultra`:** Source code for the Ultra core viewer.
-- **`./src/react-viewers/webgl`:** Source code for the WebGL React component. Based on [vim-webgl-component](https://github.com/vimaec/vim-webgl-component).
-- **`./src/react-viewers/ultra`:** Source code for the Ultra React component.
-
-## License
-
-Distributed under the **MIT License**. See `LICENSE.txt` for more details.
-
-## Contact
-
-- **Simon Roberge** - [simon.roberge@vimaec.com](mailto:simon.roberge@vimaec.com)
-- **Martin Ashton** - [martin.ashton@vimaec.com](mailto:martin.ashton@vimaec.com)
-
-## Acknowledgments
-
-Special thanks to these packages and more:
-- [react-complex-tree](https://github.com/lukasbach/react-complex-tree)
-- [re-resizable](https://github.com/bokuweb/re-resizable)
-- [react-tooltip](https://github.com/ReactTooltip/react-tooltip)
-- [Strongly Typed Events](https://github.com/KeesCBakker/Strongly-Typed-Events-for-TypeScript#readme)
+# VIM WebGL Component
+
+### Documentation
+
+Explore the full [API Documentation](https://vimaec.github.io/vim-web/api/).
+
+### Package
+https://www.npmjs.com/package/vim-web
+
+## Live Demo
+
+### WebGL Viewer
+- **[Small - Residence](https://vimaec.github.io/vim-web/webgl)**
+- **[Medium - Medical Tower](https://vimaec.github.io/vim-web/webgl?vim=https://vim.azureedge.net/samples/skanska.vim)**
+- **[Small - Stadium](https://vimaec.github.io/vim-web/webgl?vim=https://vim.azureedge.net/samples/stadium.vim)**
+
+### Ultra Viewer
+- **[Small - Residence](https://vimaec.github.io/vim-web/ultra)**
+- **[Medium - Medical Tower](https://vimaec.github.io/vim-web/ultra?vim=https://vim.azureedge.net/samples/skanska.vim)**
+- **[Small - Stadium](https://vimaec.github.io/vim-web/ultra?vim=https://vim.azureedge.net/samples/stadium.vim)**
+
+Find detailed camera controls here: [Camera Controls](https://docs.vimaec.com/docs/vim-cloud/webgl-navigation-and-controls-guide).
+
+## Overview
+
+The **VIM-Web** repository consists of four primary components, divided into two layers:
+
+### Core Viewers
+- **WebGL Viewer:** A WebGL-based viewer for the VIM format. Includes features like outlines, ghosting, and sectioning, but without UI components.
+- **Ultra Viewer:** A high-performance viewer for the VIM Ultra Render Server, optimized for scale and speed.
+
+### React Viewers
+- **WebGL Component:** A React-based wrapper for the WebGL viewer, providing interactive UI elements and a BIM explorer.
+- **Ultra Component:** A React-based wrapper for the Ultra viewer, featuring a UI for real-time interactions.
+
+## VIM Format
+
+The **VIM** file format is a high-performance 3D scene format that supports rich BIM data. It can also be extended to accommodate other relational and non-relational datasets. Unlike **IFC**, the VIM format is pre-tessellated, allowing for rapid loading and rendering.
+
+Learn more about the VIM format here: [VIM GitHub Repository](https://github.com/vimaec/vim).
+
+### Built With
+- [VIM WebGL Viewer](https://github.com/vimaec/vim-webgl-viewer)
+- [React.js](https://reactjs.org/)
+
+## Getting Started
+
+Follow these steps to get started with the project:
+
+1. Clone the repository.
+2. Open the project in **VS Code**.
+3. Install the dependencies: `npm install`.
+4. Start the development server: `npm run dev`.
+
+> **Note:** Ensure you have a recent version of **Node.js** installed, as required by Vite.
+
+## Repository Organization
+
+- **`./docs`:** Root folder for GitHub Pages, built using the `build:website` script.
+- **`./dist`:** Contains the built package for npm, created with the `build:libs` script.
+- **`./src/pages`:** Source code for the demo pages published on GitHub Pages.
+- **`./src/vim-web`:** Source code for building and publishing the vim-web npm package.
+- **`./src/core-viewers/webgl`:** Source code for the WebGL core viewer. Based on [vim-webgl-viewer](https://github.com/vimaec/vim-webgl-viewer).
+- **`./src/core-viewers/ultra`:** Source code for the Ultra core viewer.
+- **`./src/react-viewers/webgl`:** Source code for the WebGL React component. Based on [vim-webgl-component](https://github.com/vimaec/vim-webgl-component).
+- **`./src/react-viewers/ultra`:** Source code for the Ultra React component.
+
+## License
+
+Distributed under the **MIT License**. See `LICENSE.txt` for more details.
+
+## Contact
+
+- **Simon Roberge** - [simon.roberge@vimaec.com](mailto:simon.roberge@vimaec.com)
+- **Martin Ashton** - [martin.ashton@vimaec.com](mailto:martin.ashton@vimaec.com)
+
+## Acknowledgments
+
+Special thanks to these packages and more:
+- [react-complex-tree](https://github.com/lukasbach/react-complex-tree)
+- [re-resizable](https://github.com/bokuweb/re-resizable)
+- [react-tooltip](https://github.com/ReactTooltip/react-tooltip)
+- [Strongly Typed Events](https://github.com/KeesCBakker/Strongly-Typed-Events-for-TypeScript#readme)

package/license.txt

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 VIMaec LLC.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 VIMaec LLC.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -1,88 +1,89 @@
-{
-  "name": "vim-web",
-  "version": "0.3.27",
-  "description": "A demonstration app built on top of the vim-webgl-viewer",
-  "type": "module",
-  "files": [
-    "dist"
-  ],
-  "main": "./dist/vim-web.iife.js",
-  "types": "./dist/types/index.d.ts",
-  "module": "./dist/vim-web.mjs",
-  "homepage": "https://github.com/vimaec/vim-web.git",
-  "bugs": {
-    "url": "https://github.com/vimaec/vim-web/issues"
-  },
-  "license": "MIT",
-  "author": "VIM <hello@vimaec.com>",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/vimaec/vim-web.git"
-  },
-  "scripts": {
-    "dev": "vite --host --config vite.config.website.js",
-    "build:libs": "vite build --config vite.config.libs.js && npm run declarations:libs",
-    "package:libs": "npm run build:libs && npm publish",
-    "declarations:libs": "tsc --project tsconfig.libs.json --declaration --emitDeclarationOnly --outdir ./dist/types",
-    "documentation:libs": "typedoc --entryPoints src/vim-web/index.ts --entryPointStrategy expand --out docs/api --excludeProtected --excludeExternals --excludePrivate",
-    "build:website": "vite build --config vite.config.website.js && npm run copy:website && npm run documentation:libs && npm run commit:website",
-    "serve:website": "vite preview --outDir docs",  
-    "commit:website": "git add docs && git commit -m 'Build website[ci skip]' && git push",
-    "copy:website": "node scripts/copyIndex.js",
-    "eslint": "eslint --ext .js,.ts,.tsx src --fix"
-  },
-  "devDependencies": {
-    "@types/dom-webcodecs": "^0.1.13",
-    "@types/react": "^18.3.13",
-    "@types/react-dom": "^18.3.1",
-    "@typescript-eslint/eslint-plugin": "^8.17.0",
-    "@typescript-eslint/parser": "^8.17.0",
-    "autoprefixer": "^10.4.20",
-    "eslint": "^8.23.1",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-prettier": "^5.2.1",
-    "eslint-plugin-promise": "^6.0.1",
-    "eslint-plugin-react": "^7.37.2",
-    "eslint-plugin-react-hooks": "^5.0.0",
-    "fs-extra": "^11.2.0",
-    "postcss": "^8.4.49",
-    "prettier": "^3.4.2",
-    "prettier-plugin-tailwindcss": "^0.6.9",
-    "react-router-dom": "^7.0.2",
-    "tailwindcss": "^3.4.16",
-    "tailwindcss-scoped-preflight": "^3.4.9",
-    "typedoc": "^0.27.3",
-    "typescript": "^5.7.2",
-    "vite": "^6.0.2"
-  },
-  "dependencies": {
-    "@firefox-devtools/react-contextmenu": "^5.1.1",
-    "@types/three": "0.143.0",
-    "@vitejs/plugin-react": "^4.3.4",
-    "deepmerge": "^4.3.1",
-    "is-plain-object": "^5.0.0",
-    "re-resizable": "^6.9.9",
-    "react-complex-tree": "^2.4.6",
-    "react-tooltip": "^4.2.21",
-    "stats-js": "^1.0.1",
-    "ste-events": "^3.0.11",
-    "ste-signals": "^3.0.11",
-    "ste-simple-events": "^3.0.11",
-    "three": "0.143.0",
-    "vim-format": "1.0.14"
-  },
-  "peerDependencies": {
-    "react": "^18.3.1",
-    "react-dom": "^18.3.1"
-  },
-  "keywords": [
-    "3d",
-    "viewer",
-    "three.js",
-    "model",
-    "aec",
-    "vim",
-    "loader",
-    "webgl"
-  ]
-}
+{
+  "name": "vim-web",
+  "version": "0.3.29",
+  "description": "A demonstration app built on top of the vim-webgl-viewer",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "readme": "README.md",
+  "main": "./dist/vim-web.iife.js",
+  "types": "./dist/types/index.d.ts",
+  "module": "./dist/vim-web.mjs",
+  "homepage": "https://github.com/vimaec/vim-web.git",
+  "bugs": {
+    "url": "https://github.com/vimaec/vim-web/issues"
+  },
+  "license": "MIT",
+  "author": "VIM <hello@vimaec.com>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vimaec/vim-web.git"
+  },
+  "scripts": {
+    "dev": "vite --host --config vite.config.website.js",
+    "build:libs": "vite build --config vite.config.libs.js && npm run declarations:libs",
+    "package:libs": "npm run build:libs && npm publish",
+    "declarations:libs": "tsc --project tsconfig.libs.json --declaration --emitDeclarationOnly --outdir ./dist/types",
+    "documentation:libs": "typedoc --entryPoints src/vim-web/index.ts --entryPointStrategy expand --out docs/api --excludeProtected --excludeExternals --excludePrivate",
+    "build:website": "vite build --config vite.config.website.js && npm run copy:website && npm run documentation:libs && npm run commit:website",
+    "serve:website": "vite preview --outDir docs",
+    "commit:website": "git add docs && git commit -m 'Build website[ci skip]' && git push",
+    "copy:website": "node scripts/copyIndex.js",
+    "eslint": "eslint --ext .js,.ts,.tsx src --fix"
+  },
+  "devDependencies": {
+    "@types/dom-webcodecs": "^0.1.13",
+    "@types/react": "^18.3.13",
+    "@types/react-dom": "^18.3.1",
+    "@typescript-eslint/eslint-plugin": "^8.17.0",
+    "@typescript-eslint/parser": "^8.17.0",
+    "autoprefixer": "^10.4.20",
+    "eslint": "^8.23.1",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-promise": "^6.0.1",
+    "eslint-plugin-react": "^7.37.2",
+    "eslint-plugin-react-hooks": "^5.0.0",
+    "fs-extra": "^11.2.0",
+    "postcss": "^8.4.49",
+    "prettier": "^3.4.2",
+    "prettier-plugin-tailwindcss": "^0.6.9",
+    "react-router-dom": "^7.0.2",
+    "tailwindcss": "^3.4.16",
+    "tailwindcss-scoped-preflight": "^3.4.9",
+    "typedoc": "^0.27.3",
+    "typescript": "^5.7.2",
+    "vite": "^6.0.2"
+  },
+  "dependencies": {
+    "@firefox-devtools/react-contextmenu": "^5.1.1",
+    "@types/three": "0.143.0",
+    "@vitejs/plugin-react": "^4.3.4",
+    "deepmerge": "^4.3.1",
+    "is-plain-object": "^5.0.0",
+    "re-resizable": "^6.9.9",
+    "react-complex-tree": "^2.4.6",
+    "react-tooltip": "^4.2.21",
+    "stats-js": "^1.0.1",
+    "ste-events": "^3.0.11",
+    "ste-signals": "^3.0.11",
+    "ste-simple-events": "^3.0.11",
+    "three": "0.143.0",
+    "vim-format": "1.0.14"
+  },
+  "peerDependencies": {
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1"
+  },
+  "keywords": [
+    "3d",
+    "viewer",
+    "three.js",
+    "model",
+    "aec",
+    "vim",
+    "loader",
+    "webgl"
+  ]
+}