vim-web 0.3.23

package/README.md

@@ -0,0 +1,60 @@
+# Vim Webgl Component
+
+# Documentation
+
+[API Documentation](https://vimaec.github.io/vim-web/api/)
+
+# Live Demo
+
+## Web
+- [Small Model Demo - Residence](https://vimaec.github.io/vim-webgl-app/release?vim=https://vim02.azureedge.net/samples/residence.v1.2.75.vim)
+- [Medium Model Demo - Medical Tower](https://vimaec.github.io/vim-webgl-app/release?vim=https://vim02.azureedge.net/samples/skanska.vim)
+- [Large Model Demo - Stadium](https://vimaec.github.io/vim-webgl-app/release?vim=https://vim02.azureedge.net/samples/stadium.vim) (_Warning_: slow download times)
+
+# Overview
+
+The VIM Webgl Component is a React ui implementation for the [Vim WebGL Viewer]([https://jsfiddle.net/simon_vimaec/2khmqy9v/](https://github.com/vimaec/vim-webgl-viewer)).
+
+## Intents
+
+- Provide a smooth online user experience while browsing complex bim data.
+- Test and demonstrate the capabilities of the underlying vim-webgl-viewer.
+- Be easy to use, extend and customize for other developpers.
+
+## VIM
+
+The VIM file format is a high-performance 3D scene format that supports rich BIM data, and can be easily extended to support other relational or non-relation data sets.
+Unlike IFC the VIM format is already tessellated, and ready to render. This results in very fast load times. Unlike glTF the VIM format is faster to load, scales better, and has a consistent structure for relational BIM data.
+More information on the vim format can be found here: https://github.com/vimaec/vim
+
+### Built With
+
+- [VIM Webgl Viewer](https://github.com/vimaec/vim-webgl-viewer)
+- [react.js](https://reactjs.org/)
+
+## Getting Started
+
+1. Clone the project.
+2. Open the project in VS Code.
+3. Install packages by running npm install.
+4. Run the dev command to start a live test server.
+
+Make sure you have a recent version of NodeJS installed as Vite requires it.
+
+## License
+
+Distributed under the MIT License. See `LICENSE.txt` for more information.
+
+## Contact
+
+- Simon Roberge - simon.roberge@vimaec.com
+- Martin Ashton - martin.ashton@vimaec.com
+
+## Acknowledgments
+
+Thanks to these great 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

@@ -0,0 +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.

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "vim-web",
+  "version": "0.3.23",
+  "description": "A demonstration app built on top of the vim-webgl-viewer",
+  "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/vimWebIndex.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 BuildUpdate && git push",
+    "copy:website": "copy .\\docs\\index.html .\\docs\\404.html",
+    "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",
+    "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"
+  ]
+}