Merge back to NREL

.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+  - package-ecosystem: npm
+    directory: '/'
+    schedule:
+      interval: daily
+      time: '01:00'
+    open-pull-requests-limit: 10

.github/workflows/auto-merge.yml

@@ -0,0 +1,17 @@
+name: auto-merge
+
+on:
+  pull_request_target:
+    branches:
+      - develop
+
+jobs:
+  auto-merge:
+    runs-on: self-hosted
+    if: github.actor == 'dependabot[bot]' || github.actor == 'renovate[bot]'
+    steps:
+      - uses: ahmadnassri/[email protected]
+        with:
+          github-token: ${{ secrets.AUTOMERGE_TOKEN }}
+          command: 'squash and merge'
+          target: minor

.github/workflows/deploy.yml

@@ -3,7 +3,7 @@ on:
   workflow_run:
     workflows: [ 'Test on branch push' ]
     branches: [ develop ]
-    types: 
+    types:
       - completed
 
 jobs:
@@ -15,19 +15,21 @@ jobs:
       NODE_ENV: 'PROD'
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
-          node-version: 15
+          node-version: 20
       - run: sudo apt-get install -y libappindicator1 fonts-liberation ruby-full python3-pip
       - run: sudo pip install mkdocs
-      - run: npm ci
-      - run: npm run openstudio-build && sed -i 's/\/static/static/g' dist/index.html && sed -i 's/\/static/..\/static/g' dist/3DViewer/index.html
+      - run: |
+          yarn config set unsafe-disable-integrity-migration true -g
+          yarn install --ignore-engines --frozen-lockfile --non-interactive
+      - run: yarn run wp:build && yarn run openstudio-build && sed -i 's/\/static/static/g' dist/index.html
       - run: mkdocs build -d dist/docs
       - run: cp -r icons/ dist/ && cp site.webmanifest dist/ && cp browserconfig.xml dist/
       - name: Deploy 🚀
         uses: JamesIves/[email protected]
         with:
           branch: gh-pages # The branch the action should deploy to.
-          folder: dist # The folder the action should deploy.
+          folder: dist # The folder the action should deploy.

.github/workflows/test.yml

@@ -9,13 +9,28 @@ jobs:
       NODE_ENV: 'PROD'
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Setup Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
-          node-version: 15
-      - run: npm ci
-      - run: xvfb-run npm run test
-        env: 
+          node-version: 20
+      - run: |
+          yarn config set unsafe-disable-integrity-migration true -g
+          yarn install --ignore-engines --frozen-lockfile --non-interactive
+      - run: xvfb-run yarn unit
+        if: always()
+        env:
           DISPLAY: 99.0
-          DBUS_SESSION_BUS_ADDRESS: '/dev/null'
+          DBUS_SESSION_BUS_ADDRESS: '/dev/null'
+      - name: Install Playwright Browsers
+        if: always()
+        run: npx playwright install --with-deps
+      - name: Run Playwright tests
+        if: always()
+        run: npx playwright test
+      - uses: actions/upload-artifact@v4
+        if: ${{ !cancelled() }}
+        with:
+          name: playwright-report
+          path: playwright-report/
+          retention-days: 1

.gitignore

@@ -7,3 +7,10 @@ test/e2e/reports
 selenium-debug.log
 output
 .vscode
+logs
+karma_html
+distTs/
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

3DViewer/Dockerfile

@@ -1,4 +1,4 @@
-FROM emscripten/emsdk:2.0.26
+FROM emscripten/emsdk:3.1.61
 
 RUN echo "## Start building" \
     \
@@ -21,9 +21,9 @@ RUN echo "## Start building" \
             openjdk-8-jre-headless \
     \
 &&	echo "## Installing CMake" \
-    &&	wget https://cmake.org/files/v3.18/cmake-3.18.3-Linux-x86_64.sh -q \
+    &&	wget https://cmake.org/files/v3.29/cmake-3.29.5-linux-x86_64.sh -q \
     &&	mkdir /opt/cmake \
-    &&	printf "y\nn\n" | sh cmake-3.18.3-Linux-x86_64.sh --prefix=/opt/cmake > /dev/null \
+    &&	printf "y\nn\n" | sh cmake-3.29.5-linux-x86_64.sh --prefix=/opt/cmake > /dev/null \
     &&		rm -fr cmake*.sh /opt/cmake/doc \
     &&		rm -fr /opt/cmake/bin/cmake-gui \
     &&		rm -fr /opt/cmake/bin/ccmake \

3DViewer/viewer/index.js

@@ -1,2 +1,4 @@
+import 'core-js/stable';
+import 'regenerator-runtime/runtime';
 import './styles.css';
 import './main';

README.md

@@ -5,38 +5,42 @@
 
 ## Getting Started
 
-Read [the docs](https://nrel.github.io/floorspace.js/docs) then try out the [latest development version](https://nrel.github.io/floorspace.js/) in your browser.
+Read [the docs](https://openstudiocoalition.org/floorspace.js/docs) then try out the [latest development version](https://openstudiocoalition.org/floorspace.js/) in your browser.
 
 ## Build Setup
 
 ``` bash
-# install dependencies
-npm install
+# install node using nvm
+$ nvm install 20
+$ nvm use 20
+$ npm install --global yarn
+
+# install locked dependencies
+yarn install --frozen-lockfile
+
+# install and update dependencies (optional)
+yarn install
 
 # serve with hot reload at localhost:8080
-npm run dev
+yarn wp:dev
 
 # build for production with minification
-npm run build
+yarn wp:build
 
 # build single page output for openstudio
-npm run openstudio-build
-
-# alternative if `npm run openstudio-build` does not work, build single page output for openstudio
-npm run build
-ruby build/build.rb
+yarn openstudio-build
 
 # run unit tests
-npm run unit
+yarn run unit
 
 # run e2e tests
-npm run e2e
+yarn run e2e
 
-# run all tests
-npm test
+# run performance tests (optional)
+yarn perf
+
+# run test playwright watch mode interactive
+yarn playwright test --ui test/playwright
 ```
 
 For detailed explanation on how things work, checkout the [guide](http://vuejs-templates.github.io/webpack/) and [docs for vue-loader](http://vuejs.github.io/vue-loader).
-
-[Tests](https://travis-ci.org/NREL/floorspace.js) are run on each pull request. Current status: [![Build Status](https://travis-ci.org/NREL/floorspace.js.svg?branch=develop)](https://travis-ci.org/NREL/floorspace.js)
-

babel.config.js

@@ -0,0 +1,13 @@
+module.exports = {
+  presets: [
+    '@babel/preset-typescript',
+    [
+      '@babel/preset-env',
+      {
+        corejs: 3,
+        modules: false,
+        useBuiltIns: 'usage',
+      },
+    ],
+  ],
+};

build/build-embeddable.js

@@ -5,7 +5,7 @@ const srcPath = './src';
 const webpack_output = readFileSync(distPath + '/index.html', { encoding: 'utf-8' });
 
 const scripts = webpack_output.split('src=').slice(1).map(scriptChunk => {
-  const jsPath = scriptChunk.split('></script>')[0];
+  const jsPath = scriptChunk.split('></script>')[0].replace(/['"]+/g, '');
   console.log(`Loading scripts from: ${jsPath}\n\n`);
   return readFileSync(distPath + jsPath, { encoding: 'utf-8' });
 }).join('\n\t');
@@ -36,8 +36,8 @@ const standaloneHtml = baseHtml + `
 </html>`
 
 writeFileSync(distPath + '/standalone_geometry_editor.html', standaloneHtml);
-console.log(`Loading floorspace.js API script from: ${srcPath + '/api.js'}\n\n`);
-const apiScripts = readFileSync(srcPath + '/api.js', { encoding: 'utf-8' });
+console.log(`Loading floorspace.js API script from: ${srcPath + '/api.ts'}\n\n`);
+const apiScripts = readFileSync(srcPath + '/api.ts', { encoding: 'utf-8' });
 const lodash = readFileSync('./node_modules/lodash/lodash.min.js', { encoding: 'utf-8' });
 
 const embeddableHtml = baseHtml + `

build/dev-client.js

@@ -1,9 +1,9 @@
 /* eslint-disable */
-require('eventsource-polyfill')
-var hotClient = require('webpack-hot-middleware/client?noInfo=true&reload=true')
+require("eventsource-polyfill");
+const hotClient = require("webpack-hot-middleware/client?noInfo=true&reload=true");
 
 hotClient.subscribe(function (event) {
-  if (event.action === 'reload') {
-    window.location.reload()
+  if (event.action === "reload") {
+    window.location.reload();
   }
-})
+});

build/dev-server.js

@@ -1,79 +1,74 @@
-require('./check-versions')()
-var config = require('../config')
-if (!process.env.NODE_ENV) process.env.NODE_ENV = JSON.parse(config.dev.env.NODE_ENV)
-var path = require('path')
-var express = require('express')
-var webpack = require('webpack')
-var opn = require('opn')
-var proxyMiddleware = require('http-proxy-middleware')
-var webpackConfig = process.env.NODE_ENV === 'testing'
-  ? require('./webpack.prod.conf')
-  : require('./webpack.dev.conf')
+require("./check-versions")();
+const config = require("../config");
+if (!process.env.NODE_ENV)
+  process.env.NODE_ENV = JSON.parse(config.dev.env.NODE_ENV);
+const path = require("path");
+const express = require("express");
+const webpack = require("webpack");
+const opn = require("opn");
+const proxyMiddleware = require("http-proxy-middleware");
+const webpackConfig =
+  process.env.NODE_ENV === "testing"
+    ? require("./webpack.prod.conf")
+    : require("./webpack.dev.conf");
 
 // default port where dev server listens for incoming traffic
-var port = process.env.PORT || config.dev.port
+const port = process.env.PORT || config.dev.port;
 // Define HTTP proxies to your custom API backend
 // https://github.com/chimurai/http-proxy-middleware
-var proxyTable = config.dev.proxyTable
+const proxyTable = config.dev.proxyTable;
 
-var app = express()
-var compiler = webpack(webpackConfig)
+const app = express();
+const compiler = webpack(webpackConfig);
 
 // serve pure static assets
-var staticPath = path.posix.join(config.dev.assetsPublicPath, config.dev.assetsSubDirectory)
-app.use(staticPath, express.static('./static'))
-app.use(path.posix.join(config.dev.assetsPublicPath, '3DViewer/'), express.static('./3DViewer/build/'))
+const staticPath = path.posix.join(
+  config.dev.assetsPublicPath,
+  config.dev.assetsSubDirectory
+);
+app.use(staticPath, express.static("./static"));
+app.use(
+  path.posix.join(config.dev.assetsPublicPath, "3DViewer/"),
+  express.static("./3DViewer/build/")
+);
 
-var devMiddleware = require('webpack-dev-middleware')(compiler, {
+var devMiddleware = require("webpack-dev-middleware")(compiler, {
   publicPath: webpackConfig.output.publicPath,
   stats: {
     colors: true,
-    chunks: false
+    chunks: false,
   },
-})
-
-var hotMiddleware = require('webpack-hot-middleware')(compiler)
-// force page reload when html-webpack-plugin template changes
-compiler.plugin('compilation', function (compilation) {
-  compilation.plugin('html-webpack-plugin-after-emit', function (data, cb) {
-    hotMiddleware.publish({ action: 'reload' })
-    cb()
-  })
-})
+});
 
 // proxy api requests
 Object.keys(proxyTable).forEach(function (context) {
-  var options = proxyTable[context]
-  if (typeof options === 'string') {
-    options = { target: options }
+  var options = proxyTable[context];
+  if (typeof options === "string") {
+    options = { target: options };
   }
-  app.use(proxyMiddleware(context, options))
-})
+  app.use(proxyMiddleware(context, options));
+});
 
 // handle fallback for HTML5 history API
-app.use(require('connect-history-api-fallback')({
-  rewrites: [
-    { from: /\/3DViewer/, to: '/3DViewer/index.html'}
-  ]
-}))
+app.use(
+  require("connect-history-api-fallback")({
+    rewrites: [{ from: /\/3DViewer/, to: "/3DViewer/index.html" }],
+  })
+);
 
 // serve webpack bundle output
-app.use(devMiddleware)
-
-// enable hot-reload and state-preserving
-// compilation error display
-app.use(hotMiddleware)
+app.use(devMiddleware);
 
 module.exports = app.listen(port, function (err) {
   if (err) {
-    console.log(err)
-    return
+    console.log(err);
+    return;
   }
-  var uri = 'http://localhost:' + port
-  console.log('Listening at ' + uri + '\n')
+  var uri = "http://localhost:" + port;
+  console.log("Listening at " + uri + "\n");
 
   // when env is testing, don't need open it
-  if (process.env.NODE_ENV !== 'testing') {
-    opn(uri)
+  if (process.env.NODE_ENV !== "testing") {
+    opn(uri);
   }
-})
+});

build/getBundleAnalyzer.js

@@ -0,0 +1,20 @@
+const BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPlugin;
+
+const getBundleAnalyzer = () => {
+  if (process.env.BUNDLE_ANALYZER === 'true') {
+    // eslint-disable-next-line
+    console.log('bundle analyzer enabled');
+
+    return [
+      new BundleAnalyzerPlugin(),
+    ];
+  }
+
+  // eslint-disable-next-line
+  console.log('bundle analyzer disabled');
+
+  return [
+  ];
+};
+
+module.exports = getBundleAnalyzer;