chore: move to esm

.github/workflows/test-application.yml

@@ -18,7 +18,7 @@ jobs:
             - name: Set up Node.js
               uses: actions/setup-node@v5
               with:
-                  node-version: '20'
+                  node-version: '22'
                   cache: 'npm'
 
             - name: Install dependencies
@@ -81,7 +81,8 @@ jobs:
 
             - name: Start backend
               run: |
-                  nohup npm run server > server.log 2>&1 &
+                  npm run build:server
+                  nohup npm start > server.log 2>&1 &
                   sleep 25
 
             - name: Test MQTT write and read
@@ -91,17 +92,20 @@ jobs:
                   docker exec broker mosquitto_sub -h localhost -p 1883 -t "zwave/nodeID_2/106/0/currentValue/3" -C 1
 
             - name: Output backend logs
+              if: always()
               run: |
                 sleep 5
                 cat server.log
 
             - name: Output broker logs
+              if: always()
               run: |
                   docker logs broker
 
             - name: Ensure backend is running
+              if: always()
               run: |
-                  if ! pgrep -f "npm run server" > /dev/null; then
+                  if ! pgrep -f "npm start" > /dev/null; then
                     echo "Backend crashed!" && exit 1
                   fi
                   echo "Backend is running successfully."

.mocharc.yml

@@ -1,3 +1 @@
 recursive: true
-watch-files:
-  - 'test/**/*.ts'

.nvmrc

@@ -1 +1 @@
-v20.19.4
+v22.20.0

.prettierrc.js

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
 	semi: false,
 	singleQuote: true,
 	useTabs: true,

api/app.ts

@@ -1,29 +1,33 @@
-import express, { Request, RequestHandler, Response, Router } from 'express'
+import type { Request, RequestHandler, Response, Router } from 'express'
+import express from 'express'
 import history from 'connect-history-api-fallback'
 import cors from 'cors'
 import csrf from 'csurf'
 import morgan from 'morgan'
-import store, { Settings, User } from './config/store'
-import Gateway, { GatewayConfig, GatewayType } from './lib/Gateway'
-import jsonStore from './lib/jsonStore'
-import * as loggers from './lib/logger'
-import MqttClient from './lib/MqttClient'
-import SocketManager from './lib/SocketManager'
-import ZWaveClient, { CallAPIResult, SensorTypeScale } from './lib/ZwaveClient'
+import type { Settings, User } from './config/store.ts'
+import store from './config/store.ts'
+import type { GatewayConfig } from './lib/Gateway.ts'
+import Gateway, { GatewayType } from './lib/Gateway.ts'
+import jsonStore from './lib/jsonStore.ts'
+import * as loggers from './lib/logger.ts'
+import MqttClient from './lib/MqttClient.ts'
+import SocketManager from './lib/SocketManager.ts'
+import type { CallAPIResult, SensorTypeScale } from './lib/ZwaveClient.ts'
+import ZWaveClient from './lib/ZwaveClient.ts'
 import multer, { diskStorage } from 'multer'
 import extract from 'extract-zip'
 import { serverVersion } from '@zwave-js/server'
 import archiver from 'archiver'
 import rateLimit from 'express-rate-limit'
 import session from 'express-session'
-import fs, { mkdirp, move, readdir, rm, stat } from 'fs-extra'
-import { createServer as createHttpServer, Server as HttpServer } from 'http'
-import { createServer as createHttpsServer } from 'https'
+import type { Server as HttpServer } from 'node:http'
+import { createServer as createHttpServer } from 'node:http'
+import { createServer as createHttpsServer } from 'node:https'
 import jwt from 'jsonwebtoken'
-import path from 'path'
+import path from 'node:path'
 import sessionStore from 'session-file-store'
-import { Socket } from 'socket.io'
-import { promisify } from 'util'
+import type { Socket } from 'socket.io'
+import { promisify } from 'node:util'
 import { Driver, libVersion } from 'zwave-js'
 import {
 	defaultPsw,
@@ -32,18 +36,26 @@
 	snippetsDir,
 	storeDir,
 	tmpDir,
-} from './config/app'
+} from './config/app.ts'
+import type { CustomPlugin, PluginConstructor } from './lib/CustomPlugin.ts'
+import { createPlugin } from './lib/CustomPlugin.ts'
+import { inboundEvents, socketEvents } from './lib/SocketEvents.ts'
+import * as utils from './lib/utils.ts'
+import backupManager from './lib/BackupManager.ts'
 import {
-	createPlugin,
-	CustomPlugin,
-	PluginConstructor,
-} from './lib/CustomPlugin'
-import { inboundEvents, socketEvents } from './lib/SocketEvents'
-import * as utils from './lib/utils'
-import backupManager from './lib/BackupManager'
-import { readFile, realpath } from 'fs/promises'
+	readFile,
+	realpath,
+	readdir,
+	stat,
+	rm,
+	rename,
+	writeFile,
+	lstat,
+	mkdir,
+} from 'node:fs/promises'
 import { generate } from 'selfsigned'
-import ZnifferManager, { ZnifferConfig } from './lib/ZnifferManager'
+import type { ZnifferConfig } from './lib/ZnifferManager.ts'
+import ZnifferManager from './lib/ZnifferManager.ts'
 import { getAllNamedScaleGroups, getAllSensors } from '@zwave-js/core'
 
 const createCertificate = promisify(generate)
@@ -72,7 +84,7 @@
 
 const Storage = diskStorage({
 	async destination(reqD, file, callback) {
-		await mkdirp(tmpDir)
+		await utils.ensureDir(tmpDir)
 		callback(null, tmpDir)
 	},
 	filename(reqF, file, callback) {
@@ -262,7 +274,7 @@
 
 async function loadSnippets() {
 	const localSnippetsDir = utils.joinPath(false, 'snippets')
-	await mkdirp(snippetsDir)
+	await utils.ensureDir(snippetsDir)
 
 	const files = await readdir(localSnippetsDir)
 	for (const file of files) {
@@ -329,8 +341,8 @@
 	let cert: string
 
 	try {
-		cert = await fs.readFile(certFile, 'utf8')
-		key = await fs.readFile(keyFile, 'utf8')
+		cert = await readFile(certFile, 'utf8')
+		key = await readFile(keyFile, 'utf8')
 	} catch (error) {
 		// noop
 	}
@@ -349,8 +361,8 @@
 			key = result.private
 			cert = result.cert
 
-			await fs.writeFile(utils.joinPath(storeDir, 'key.pem'), key)
-			await fs.writeFile(utils.joinPath(storeDir, 'cert.pem'), cert)
+			await writeFile(utils.joinPath(storeDir, 'key.pem'), key)
+			await writeFile(utils.joinPath(storeDir, 'cert.pem'), cert)
 			logger.info('New cert and key created')
 		} catch (error) {
 			logger.error('Error creating cert and key for HTTPS', error)
@@ -447,14 +459,14 @@
 
 async function parseDir(dir: string): Promise<StoreFileEntry[]> {
 	const toReturn = []
-	const files = await fs.readdir(dir)
+	const files = await readdir(dir)
 	for (const file of files) {
 		try {
 			const entry: StoreFileEntry = {
 				name: path.basename(file),
 				path: utils.joinPath(dir, file),
 			}
-			const stats = await fs.lstat(entry.path)
+			const stats = await lstat(entry.path)
 			if (stats.isDirectory()) {
 				if (entry.path === process.env.ZWAVEJS_EXTERNAL_CONFIG) {
 					// hide config-db
@@ -1367,18 +1379,18 @@
 		if (req.query.path) {
 			const reqPath = getSafePath(req)
 			// lgtm [js/path-injection]
-			let stat = await fs.lstat(reqPath)
+			let stat = await lstat(reqPath)
 
 			// check symlink is secure
 			if (stat.isSymbolicLink()) {
 				const realPath = await realpath(reqPath)
 				getSafePath(realPath)
-				stat = await fs.lstat(realPath)
+				stat = await lstat(realPath)
 			}
 
 			if (stat.isFile()) {
 				// lgtm [js/path-injection]
-				data = await fs.readFile(reqPath, 'utf8')
+				data = await readFile(reqPath, 'utf8')
 			} else {
 				// read directory
 				// lgtm [js/path-injection]
@@ -1411,7 +1423,7 @@
 
 		if (!isNew) {
 			// lgtm [js/path-injection]
-			const stat = await fs.lstat(reqPath)
+			const stat = await lstat(reqPath)
 
 			if (!stat.isFile()) {
 				throw Error('Path is not a file')
@@ -1420,10 +1432,10 @@
 
 		if (!isDirectory) {
 			// lgtm [js/path-injection]
-			await fs.writeFile(reqPath, req.body.content, 'utf8')
+			await writeFile(reqPath, req.body.content, 'utf8')
 		} else {
 			// lgtm [js/path-injection]
-			await fs.mkdir(reqPath)
+			await mkdir(reqPath)
 		}
 
 		res.json({ success: true })
@@ -1442,7 +1454,7 @@
 			const reqPath = getSafePath(req)
 
 			// lgtm [js/path-injection]
-			await fs.remove(reqPath)
+			await rm(reqPath, { recursive: true, force: true })
 
 			res.json({ success: true })
 		} catch (error) {
@@ -1460,7 +1472,7 @@
 		try {
 			const files = req.body.files || []
 			for (const f of files) {
-				await fs.remove(f)
+				await rm(f, { recursive: true, force: true })
 			}
 			res.json({ success: true })
 		} catch (error) {
@@ -1498,7 +1510,7 @@
 		archive.pipe(res)
 
 		for (const f of files) {
-			const s = await fs.lstat(f)
+			const s = await lstat(f)
 			const name = f.replace(storeDir, '')
 			if (s.isFile()) {
 				archive.file(f, { name })
@@ -1559,7 +1571,7 @@
 				const destinationPath = getSafePath(
 					path.join(storeDir, folder, file.originalname),
 				)
-				await move(file.path, destinationPath)
+				await rename(file.path, destinationPath)
 			}
 
 			res.json({ success: true })

api/bin/www.ts

@@ -4,10 +4,10 @@
 /**
  * Module dependencies.
  */
-import jsonStore from '../lib/jsonStore'
-import store from '../config/store'
-import * as conf from '../config/app'
-import app, { startServer } from '../app'
+import jsonStore from '../lib/jsonStore.ts'
+import store from '../config/store.ts'
+import * as conf from '../config/app.ts'
+import app, { startServer } from '../app.ts'
 
 console.log(
 	`  ______  __          __                      _  _____     _    _ _____ \n |___  /  \\ \\        / /                     | |/ ____|   | |  | |_   _|\n    / /____\\ \\  /\\  / /_ ___   _____         | | (___     | |  | | | |  \n   / /______\\ \\/  \\/ / _\' \\ \\ / / _ \\    _   | |\\___ \\    | |  | | | |  \n  / /__      \\  /\\  / (_| |\\ V /  __/   | |__| |____) |   | |__| |_| |_ \n /_____|      \\/  \\/ \\__,_| \\_/ \\___|    \\____/|_____/     \\____/|_____|\n`,

api/config/app.ts

@@ -1,4 +1,4 @@
-import { joinPath } from '../lib/utils'
+import { joinPath } from '../lib/utils.ts'
 import { config } from 'dotenv'
 
 config({ path: './.env.app' })

api/config/store.ts

@@ -1,9 +1,10 @@
 // config/store.js
 
-import { GatewayConfig } from '../lib/Gateway'
-import { MqttConfig } from '../lib/MqttClient'
-import { ZnifferConfig } from '../lib/ZnifferManager'
-import { ZwaveConfig, deviceConfigPriorityDir } from '../lib/ZwaveClient'
+import type { GatewayConfig } from '../lib/Gateway.ts'
+import type { MqttConfig } from '../lib/MqttClient.ts'
+import type { ZnifferConfig } from '../lib/ZnifferManager.ts'
+import type { ZwaveConfig } from '../lib/ZwaveClient.ts'
+import { deviceConfigPriorityDir } from '../lib/Constants.ts'
 
 export type StoreKeys = 'settings' | 'scenes' | 'nodes' | 'users'
 

api/hass/configurations.ts

@@ -1,7 +1,7 @@
 // List of Home-Assistant configuration for MQTT Discovery
 // https://www.home-assistant.io/docs/mqtt/discovery/
 
-import { HassDevice } from '../lib/ZwaveClient'
+import type { HassDevice } from '../lib/ZwaveClient.ts'
 
 type HassDeviceKey =
 	| 'binary_sensor'

api/hass/devices.ts

@@ -1,6 +1,6 @@
 // Place here repeated patterns
 
-import { HassDevice } from '../lib/ZwaveClient'
+import type { HassDevice } from '../lib/ZwaveClient.ts'
 
 const FAN_DIMMER: HassDevice = {
 	type: 'fan',

api/lib/BackupManager.ts

@@ -1,11 +1,11 @@
-import store from '../config/store'
-import { module } from './logger'
-import jsonStore, { STORE_BACKUP_PREFIX } from './jsonStore'
+import store from '../config/store.ts'
+import { module } from './logger.ts'
+import jsonStore, { STORE_BACKUP_PREFIX } from './jsonStore.ts'
 import Cron from 'croner'
-import { readdir, unlink } from 'fs/promises'
-import { nvmBackupsDir, storeBackupsDir } from '../config/app'
-import { joinPath } from './utils'
-import type ZwaveClient from './ZwaveClient'
+import { readdir, unlink } from 'node:fs/promises'
+import { nvmBackupsDir, storeBackupsDir } from '../config/app.ts'
+import { joinPath } from './utils.ts'
+import type ZwaveClient from './ZwaveClient.ts'
 
 export const NVM_BACKUP_PREFIX = 'NVM_'
 

api/lib/Constants.ts

@@ -1,4 +1,6 @@
 import { getMeter, getMeterScale } from '@zwave-js/core'
+import { join } from 'node:path'
+import { storeDir } from '../config/app.ts'
 
 interface IGenericMap {
 	[key: number]: string
@@ -43,6 +45,8 @@ export interface IMeterCCSpecific {
 	meterType: number
 }
 
+export const deviceConfigPriorityDir = join(storeDir, 'config')
+
 // https://github.com/OpenZWave/open-zwave/blob/0d94c9427bbd19e47457578bccc60b16c6679b49/config/Localization.xml#L606
 const _productionMap: IGenericMap = {
 	0: 'instant',

api/lib/CustomPlugin.ts

@@ -1,7 +1,7 @@
-import { Router } from 'express'
-import MqttClient from './MqttClient'
-import { ModuleLogger } from './logger'
-import ZwaveClient from './ZwaveClient'
+import type { Router } from 'express'
+import type MqttClient from './MqttClient.ts'
+import type { ModuleLogger } from './logger.ts'
+import type ZwaveClient from './ZwaveClient.ts'
 
 export interface PluginContext {
 	zwave: ZwaveClient

api/lib/EventEmitter.ts

@@ -1,5 +1,5 @@
-import EventEmitter from 'events'
-import { applyMixin } from './utils'
+import EventEmitter from 'node:events'
+import { applyMixin } from './utils.ts'
 
 /**
  * A type-safe EventEmitter interface to use in place of Node.js's EventEmitter.