feat!: change project name to zwave-js-ui (#2650)

.env.app.example

@@ -2,7 +2,7 @@
 # HOST="0.0.0.0"
 # The port to listen to for incoming requests. Default is `8091`
 # PORT=8091
-# The absolute path to the directory where all files will be stored. Default is `<path to your z2m dir>/store`
+# The absolute path to the directory where all files will be stored. Default is `<path to your zui dir>/store`
 # STORE_DIR
 # Used as secret for session. If not provided the default one is used
 # SESSION_SECRET

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -17,14 +17,14 @@ body:
           If yes, please open an issue at: https://github.com/zwave-js/node-zwave-js/issues/new?assignees=&labels=&template=bug_report.yml
 
           3. Check the troubleshooting section if your problem is described there:
-          https://zwave-js.github.io/zwavejs2mqtt/#/troubleshooting/bug_report
+          https://zwave-js.github.io/zwave-js-ui/#/troubleshooting/bug_report
 
           4. Check the changelog if your problem was already fixed recently.
-          https://github.com/zwave-js/zwavejs2mqtt/blob/master/CHANGELOG.md
+          https://github.com/zwave-js/zwave-js-ui/blob/master/CHANGELOG.md
           We cannot provide support if you are not using the latest version.
 
           5. Make sure to provide the necessary information, as described here:
-          https://zwave-js.github.io/zwavejs2mqtt/#/troubleshooting/bug_report
+          https://zwave-js.github.io/zwave-js-ui/#/troubleshooting/bug_report
 
           If you are using HomeAssistant, this is how you do it:
 
@@ -46,7 +46,7 @@ body:
     id: build
     attributes:
       label: Deploy method
-      description: How did you installed Zwavejs2mqtt
+      description: How did you install Z-Wave JS UI
       options:
         - Docker
         - PKG executable
@@ -55,9 +55,9 @@ body:
     validations:
       required: true
   - type: input
-    id: zjs2m-version
+    id: zui-version
     attributes:
-      label: Zwavejs2Mqtt version
+      label: Z-Wave JS UI version
     validations:
       required: true
   - type: input

.github/ISSUE_TEMPLATE/hass_discovery.md

@@ -7,7 +7,7 @@ assignees: billiaz
 
 ---
 
-Before submitting a bug please read: <https://zwave-js.github.io/zwavejs2mqtt/#/troubleshooting/bug_report>
+Before submitting a bug please read: <https://zwave-js.github.io/zwave-js-ui/#/troubleshooting/bug_report>
 
 If you are using the Home Assistant Z-Wave JS integration, please add a full dump:
 
@@ -21,7 +21,7 @@ Build/Run method:
 [ ] Git Clone + yarn install + yarn run build + yarn start
 [ ] Pkg
 
-Zwavejs2Mqtt version: **[Enter Version Number]**
+Z-Wave JS UI version: **[Enter Version Number]**
 Z-Wave JS version: **[Enter Version Number]**
 
 ### Describe the bug

.github/workflows/ci.yml

@@ -19,7 +19,7 @@ jobs:
         node-version: [14.x, 16.x, 18.x]
 
     steps:
-      - name: Checkout Zwavejs2Mqtt
+      - name: Checkout Z-Wave JS UI
         uses: actions/checkout@v2
 
       - name: Use Node.js ${{ matrix.node-version }}

.github/workflows/docker-release-test.yml

@@ -42,16 +42,16 @@ jobs:
         id: docker_meta
         uses: docker/metadata-action@v3
         with:
-          images: zwavejs/zwavejs2mqtt,ghcr.io/zwave-js/zwavejs2mqtt
+          images: zwavejs/zwavejs2mqtt,zwavejs/zwave-js-ui,ghcr.io/zwave-js/zwave-js-ui
           tags: |
             ${{ github.event.inputs.tag }}
           flavor: |
             latest=false
           labels: |
             org.opencontainers.image.vendor=zwave-js
-            org.opencontainers.image.documentation=https://zwave-js.github.io/zwavejs2mqtt/#/
+            org.opencontainers.image.documentation=https://zwave-js.github.io/zwave-js-ui/#/
             org.opencontainers.image.authors=Daniel Lando <[email protected]>
-            org.opencontainers.image.url=https://zwave-js.github.io/zwavejs2mqtt/#/
+            org.opencontainers.image.url=https://zwave-js.github.io/zwave-js-ui/#/
             maintainer=robertsLando
 
       - name: build+push

.github/workflows/docker-release.yml

@@ -38,14 +38,29 @@ jobs:
         id: docker_meta
         uses: docker/metadata-action@v3
         with:
-          images: zwavejs/zwavejs2mqtt,ghcr.io/zwave-js/zwavejs2mqtt
+          images: zwavejs/zwave-js-ui,ghcr.io/zwave-js/zwave-js-ui
           tags: |
             type=semver,pattern={{version}}
             type=sha
             type=ref,event=branch
           labels: |
             org.opencontainers.image.vendor=zwave-js
-            org.opencontainers.image.documentation=https://zwave-js.github.io/zwavejs2mqtt
+            org.opencontainers.image.documentation=https://zwave-js.github.io/zwave-js-ui
+            org.opencontainers.image.authors=Daniel Lando <[email protected]>
+            maintainer=robertsLando
+      
+      - name: Create Docker Meta for zwavejs2mqtt
+        id: docker_meta2
+        uses: docker/metadata-action@v3
+        with:
+          images: zwavejs/zwavejs2mqtt
+          tags: |
+            type=semver,pattern={{version}}
+            type=sha
+            type=ref,event=branch
+          labels: |
+            org.opencontainers.image.vendor=zwave-js
+            org.opencontainers.image.documentation=https://zwave-js.github.io/zwave-js-ui
             org.opencontainers.image.authors=Daniel Lando <[email protected]>
             maintainer=robertsLando
 
@@ -59,3 +74,16 @@ jobs:
           push: true
           tags: ${{ steps.docker_meta.outputs.tags }}
           labels: ${{ steps.docker_meta.outputs.labels }}
+
+      - name: build+push zwavejs2mqtt
+        uses: docker/build-push-action@v2
+        with:
+          platforms: linux/arm64,linux/amd64,linux/arm/v6,linux/arm/v7
+          file: docker/Dockerfile
+          cache-from: type=gha
+          build-args: |
+            image=zwavejs2mqtt
+          cache-to: type=gha,mode=max
+          push: true
+          tags: ${{ steps.docker_meta2.outputs.tags }}
+          labels: ${{ steps.docker_meta2.outputs.labels }}

.github/workflows/docker-test.yml

@@ -31,16 +31,16 @@ jobs:
         id: docker_meta
         uses: docker/metadata-action@v3
         with:
-          images: zwavejs/zwavejs2mqtt,ghcr.io/zwave-js/zwavejs2mqtt
+          images: zwavejs/zwavejs2mqtt,zwavejs/zwave-js-ui,ghcr.io/zwave-js/zwave-js-ui
           tags: |
             test
           flavor: |
             latest=false
           labels: |
             org.opencontainers.image.vendor=zwave-js
-            org.opencontainers.image.documentation=https://zwave-js.github.io/zwavejs2mqtt/#/
+            org.opencontainers.image.documentation=https://zwave-js.github.io/zwave-js-ui/#/
             org.opencontainers.image.authors=Daniel Lando <[email protected]>
-            org.opencontainers.image.url=https://zwave-js.github.io/zwavejs2mqtt/#/
+            org.opencontainers.image.url=https://zwave-js.github.io/zwave-js-ui/#/
             maintainer=robertsLando
 
       - name: Buildx build

README.md

@@ -1,32 +1,30 @@
-# Zwavejs2Mqtt
+# Z-Wave JS UI
 
-![GitHub package.json version](https://img.shields.io/github/package-json/v/zwave-js/zwavejs2mqtt)
+![GitHub package.json version](https://img.shields.io/github/package-json/v/zwave-js/zwave-js-ui)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
 [![MadeWithVueJs.com shield](https://madewithvuejs.com/storage/repo-shields/1897-shield.svg)](https://madewithvuejs.com/p/zwave2mqtt/shield-link)
 [![MIT Licence](https://badges.frapsoft.com/os/mit/mit.png)](https://opensource.org/licenses/mit-license.php)
-[![ci](https://github.com/zwave-js/zwavejs2mqtt/workflows/ci/badge.svg?branch=master)](https://github.com/zwave-js/zwavejs2mqtt/actions?query=workflow%3Aci+branch%3Amaster)
-[![Docker Release](https://github.com/zwave-js/zwavejs2mqtt/actions/workflows/docker-release.yml/badge.svg)](https://github.com/zwave-js/zwavejs2mqtt/actions/workflows/docker-release.yml)
-[![GitHub All Releases](https://img.shields.io/github/downloads/zwave-js/zwavejs2mqtt/total)](https://github.com/zwave-js/zwavejs2mqtt/releases)
-[![Coverage Status](https://coveralls.io/repos/github/zwave-js/zwavejs2mqtt/badge.svg?branch=master)](https://coveralls.io/github/zwave-js/zwavejs2mqtt?branch=master)
-[![Known Vulnerabilities](https://snyk.io/test/github/zwave-js/zwavejs2mqtt/badge.svg?targetFile=package.json)](https://snyk.io/test/github/zwave-js/zwavejs2mqtt?targetFile=package.json)
-[![Total alerts](https://img.shields.io/lgtm/alerts/g/zwave-js/zwavejs2mqtt.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/zwave-js/zwavejs2mqtt/alerts/)
-[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/zwave-js/zwavejs2mqtt.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/zwave-js/zwavejs2mqtt/context:javascript)
+[![ci](https://github.com/zwave-js/zwave-js-ui/workflows/ci/badge.svg?branch=master)](https://github.com/zwave-js/zwave-js-ui/actions?query=workflow%3Aci+branch%3Amaster)
+[![Docker Release](https://github.com/zwave-js/zwave-js-ui/actions/workflows/docker-release.yml/badge.svg)](https://github.com/zwave-js/zwave-js-ui/actions/workflows/docker-release.yml)
+[![GitHub All Releases](https://img.shields.io/github/downloads/zwave-js/zwave-js-ui/total)](https://github.com/zwave-js/zwave-js-ui/releases)
+[![Coverage Status](https://coveralls.io/repos/github/zwave-js/zwave-js-ui/badge.svg?branch=master)](https://coveralls.io/github/zwave-js/zwave-js-ui?branch=master)
+[![Known Vulnerabilities](https://snyk.io/test/github/zwave-js/zwave-js-ui/badge.svg?targetFile=package.json)](https://snyk.io/test/github/zwave-js/zwave-js-ui?targetFile=package.json)
+[![Total alerts](https://img.shields.io/lgtm/alerts/g/zwave-js/zwave-js-ui.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/zwave-js/zwave-js-ui/alerts/)
+[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/zwave-js/zwave-js-ui.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/zwave-js/zwave-js-ui/context:javascript)
 
 [![Join channel](https://img.shields.io/badge/SLACK-zwave--js.slack.com-red.svg?style=popout&logo=slack&logoColor=red)](https://join.slack.com/t/zwave-js/shared_invite/zt-8ns655f6-d407vtI~KjU~1z11jyaQ9Q "Join channel")
 
 [![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/MVg9wc2HE "Buy Me A Coffee") [<img style="background:#ccc;border-radius:10px" alt="PayPal" src="https://www.paypalobjects.com/paypal-ui/logos/svg/paypal-color.svg" alt="PayPal" width="200" height="40px" />](https://paypal.me/daniellando) [![Patreon](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/bePatron?u=16906849)
 
-[![dockeri.co](https://dockeri.co/image/zwavejs/zwavejs2mqtt)](https://hub.docker.com/r/zwavejs/zwavejs2mqtt)
+[![dockeri.co](https://dockeri.co/image/zwavejs/zwave-js-ui)](https://hub.docker.com/r/zwavejs/zwave-js-ui)
 
 <div>
-  <img src="docs/_images/zwavejs_logo.svg" width="300" alt="zwavejs">
-  <span style="font-size: 25px">TO</span>
-  <img src="docs/_images/MQTT-Logo.png" alt="mqtt">
+  <img style="background-color: #fff; border-radius: 15px" src="docs/_images/app_logo.svg" alt="Z-Wave JS UI">
 </div>
 
-Fully configurable Z-Wave to MQTT **Gateway** and **Control Panel**.
+Full featured Z-Wave **Control Panel** and MQTT **Gateway**.
 
-- **Backend**: [NodeJS](https://nodejs.org/en/), [Express](https://expressjs.com/), [socket.io](https://github.com/socketio/socket.io), [Mqttjs](https://github.com/mqttjs/MQTT.js), [zwavejs](https://github.com/zwave-js/node-zwave-js), [Webpack](https://webpack.js.org/)
+- **Backend**: [NodeJS](https://nodejs.org/en/), [Express](https://expressjs.com/), [socket.io](https://github.com/socketio/socket.io), [MQTTjs](https://github.com/mqttjs/MQTT.js), [zwavejs](https://github.com/zwave-js/node-zwave-js), [Webpack](https://webpack.js.org/)
 - **Frontend**: [Vue](https://vuejs.org/), [socket.io](https://github.com/socketio/socket.io), [Vuetify](https://github.com/vuetifyjs/vuetify)
 
 ## Main features
@@ -49,4 +47,4 @@ Fully configurable Z-Wave to MQTT **Gateway** and **Control Panel**.
 
 ## Documentation
 
-[Project documentation](https://zwave-js.github.io/zwavejs2mqtt/#/)
+[Project documentation](https://zwave-js.github.io/zwave-js-ui/#/)

SECURITY.md

@@ -2,4 +2,4 @@
 
 ## Reporting a Vulnerability
 
-Please email daniel.sorridi+zwavejs2mqtt@gmail.com; chris+zwavejs2mqtt@cns.me.uk
+Please email daniel.sorridi+zwave-js-ui@gmail.com; chris+zwave-js-ui@cns.me.uk

app.ts

@@ -557,7 +557,7 @@ app.use(cors({ credentials: true, origin: true }))
 // enable sessions management
 app.use(
 	session({
-		name: 'zwavejs2mqtt-session',
+		name: 'zwave-js-ui-session',
 		secret: sessionSecret,
 		resave: false,
 		saveUninitialized: false,
@@ -945,7 +945,7 @@ app.get('/health/:client', apisLimiter, function (req, res) {
 
 app.get('/version', apisLimiter, function (req, res) {
 	res.json({
-		z2m: utils.getVersion(),
+		appVersion: utils.getVersion(),
 		zwavejs: libVersion,
 		zwavejsServer: serverVersion,
 	})
@@ -995,6 +995,7 @@ app.get(
 			serial_ports: [],
 			scales: scales,
 			sslDisabled: sslDisabled(),
+			deprecationWarning: process.env.TAG_NAME === 'zwavejs2mqtt',
 		}
 
 		if (process.platform !== 'sunos') {
@@ -1108,7 +1109,7 @@ app.post(
 	async function (req, res) {
 		let config = req.body.data
 		try {
-			if (!gw.zwave) throw Error('Zwave client not inited')
+			if (!gw.zwave) throw Error('Z-Wave client not inited')
 
 			// try convert to node object
 			if (Array.isArray(config)) {
@@ -1303,7 +1304,7 @@ app.post(
 		})
 
 		// set the archive name
-		res.attachment('zwavejs2mqtt-store.zip')
+		res.attachment('zwave-js-ui-store.zip')
 		res.setHeader('Content-Type', 'application/zip')
 
 		// use res as stream so I don't need to create a temp file

bin/www.ts

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+/* eslint-disable no-useless-escape */
 
 /**
  * Module dependencies.
@@ -8,15 +9,14 @@ import store from '../config/store'
 import * as conf from '../config/app'
 import app, { startServer } from '../app'
 
-console.log(`
- ______                       _     ___                  _   _   
-|___  /                      (_)   |__ \\                | | | |  
-   / /_      ____ ___   _____ _ ___   ) |_ __ ___   __ _| |_| |_ 
-  / /\\ \\ /\\ / / _\` \\ \\ / / _ \\ / __| / /| '_ \` _ \\ / _\` | __| __|
- / /__\\ V  V / (_| |\\ V /  __/ \\__ \\/ /_| | | | | | (_| | |_| |_ 
-/_____|\\_/\\_/ \\__,_| \\_/ \\___| |___/____|_| |_| |_|\\__, |\\__|\\__|
-                            _/ |                      | |        
-                           |__/                       |_|        
+console.log(` 
+  ______  __          __                      _  _____     _    _ _____ 
+ |___  /  \ \        / /                     | |/ ____|   | |  | |_   _|
+    / /____\ \  /\  / /_ ___   _____         | | (___     | |  | | | |  
+   / /______\ \/  \/ / _' \ \ / / _ \    _   | |\___ \    | |  | | | |  
+  / /__      \  /\  / (_| |\ V /  __/   | |__| |____) |   | |__| |_| |_ 
+ /_____|      \/  \/ \__,_| \_/ \___|    \____/|_____/     \____/|_____|
+                                                                  
 `)
 
 // jsonstore is a singleton instance that handles the json configuration files

build/webpack.dev.conf.js

@@ -57,7 +57,7 @@ const devWebpackConfig = merge(baseWebpackConfig, {
     new webpack.HotModuleReplacementPlugin(),
     // https://github.com/ampedandwired/html-webpack-plugin
     new HtmlWebpackPlugin({
-      title: 'ZWave To MQTT',
+      title: 'Z-Wave JS UI',
       filename: 'index.html',
       template: 'views/index.ejs',
       templateParameters: {

config/app.ts

@@ -4,7 +4,7 @@ import { config } from 'dotenv'
 config({ path: './.env.app' })
 
 // config/app.js
-export const title: string = 'ZWave To MQTT'
+export const title: string = 'Z-Wave JS UI'
 export const storeDir: string = process.env.STORE_DIR || joinPath(true, 'store')
 export const logsDir: string = joinPath(storeDir, 'logs')
 export const snippetsDir: string = joinPath(storeDir, 'snippets')

config/webConfig.ts

@@ -4,7 +4,7 @@ const base = appConfig.base && appConfig.base.replace(/\/?$/, '/')
 
 const defaultConfig = {
   base: '/',
-  title: 'ZWave To MQTT'
+  title: 'Z-Wave JS UI'
 }
 
 // don't use export default as it has an unexpected behaviour when used in js files require

docker/Dockerfile

@@ -1,5 +1,7 @@
+ARG image=zwave-js-ui
+
 # STEP: 1 doesn't work with alpine 3.13+
-FROM node:16.3.0-alpine3.12 AS build-z2m
+FROM node:16.3.0-alpine3.12 AS build-zui
 
 WORKDIR /usr/src/app
 
@@ -60,10 +62,12 @@ RUN apk add --no-cache \
 
 
 # Copy files from previous build stage	
-COPY --from=build-z2m /usr/src/app /usr/src/app
+COPY --from=build-zui /usr/src/app /usr/src/app
 
 ENV ZWAVEJS_EXTERNAL_CONFIG=/usr/src/app/store/.config-db
 
+ENV TAG_NAME=${image_name}
+
 WORKDIR /usr/src/app
 
 EXPOSE 8091

docker/Dockerfile.contrib

@@ -1,6 +1,6 @@
 # NOTE: This Dockerfile only works with BuildKit enabled.
 # Please find instructions on how to run it at
-# https://zwave-js.github.io/zwavejs2mqtt/#/development/custom-docker?id=building-a-container-using-dockerfilecontrib
+# https://zwave-js.github.io/zwave-js-ui/#/development/custom-docker?id=building-a-container-using-dockerfilecontrib
 ARG SRC=git-clone-src
 
 #####################
@@ -11,18 +11,18 @@ ARG SRC=git-clone-src
 FROM node:16.3.0-buster AS git-clone-src
 ARG ZWJ_BRANCH=master
 ARG ZWJ_REPOSITORY=https://github.com/zwave-js/node-zwave-js
-ARG Z2M_BRANCH=master
-ARG Z2M_REPOSITORY=https://github.com/zwave-js/zwavejs2mqtt
+ARG ZUI_BRANCH=master
+ARG ZUI_REPOSITORY=https://github.com/zwave-js/zwave-js-ui
 USER node
 WORKDIR /home/node
 
 RUN git clone -b ${ZWJ_BRANCH} ${ZWJ_REPOSITORY}
-RUN git clone -b ${Z2M_BRANCH} --depth 1 ${Z2M_REPOSITORY}
+RUN git clone -b ${ZUI_BRANCH} --depth 1 ${ZUI_REPOSITORY}
 
 # Option 2: Copy from local sources
 FROM node:16.3.0-buster AS local-copy-src
 COPY --chown=node node-zwave-js /home/node/node-zwave-js
-COPY --chown=node zwavejs2mqtt /home/node/zwavejs2mqtt
+COPY --chown=node zwave-js-ui /home/node/zwave-js-ui
 
 #####################
 # Build Environment #
@@ -48,8 +48,8 @@ RUN yarn workspaces foreach version $(echo $(yarn node -p 'require("semver").inc
 
 RUN yarn workspaces foreach pack
 
-### Build zwavejs2mqtt ###
-WORKDIR /home/node/zwavejs2mqtt
+### Build zwave-js-ui ###
+WORKDIR /home/node/zwave-js-ui
 
 # Change resolutions to point to local packs
 RUN cat package.json \
@@ -88,7 +88,7 @@ LABEL maintainer="robertsLando"
 ENV ZWAVEJS_EXTERNAL_CONFIG=/usr/src/app/store/.config-db
 
 RUN apt-get update && apt-get install -y git && rm -rf /var/lib/apt/lists/*
-COPY --from=build /home/node/zwavejs2mqtt/my_dist /usr/src/app
+COPY --from=build /home/node/zwave-js-ui/my_dist /usr/src/app
 WORKDIR /usr/src/app
 EXPOSE 8091
 USER root