iobroker.staticsfilefolder 0.0.23 → 0.0.26

package/README.md

@@ -64,6 +64,15 @@ Once configured and the instance is running (green status):
 	Placeholder for the next version (at the beginning of the line):
 	### **WORK IN PROGRESS**
 -->
+### 0.0.26
+* Regenerated lockfile cleanly to resolve npm ci errors on GitHub Actions workflow.
+
+### 0.0.25
+* Resolved ESLint peer dependency warnings, linked CHANGELOG_OLD in README, updated check-and-lint workflow to Node 24, and added major auto-merge rules for GitHub actions.
+
+### 0.0.24
+* Resolved all remaining repochecker warnings and suggestions, migrated to standard automerge-dependabot workflow, and updated to ESLint v9 with flat config.
+
 ### 0.0.23
 * Added live rendering / auto-refresh in file explorer on file additions/deletions.
 
@@ -94,6 +103,8 @@ Once configured and the instance is running (green status):
 ### 0.0.1
 * (gokturk413) initial release: SPA, Offline document viewers, Chokidar file observer.
 
+[Older changelog entries](CHANGELOG_OLD.md)
+
 ## License
 MIT License
 

package/io-package.json

@@ -1,20 +1,20 @@
 {
 	"common": {
 		"name": "staticsfilefolder",
-		"version": "0.0.23",
+		"version": "0.0.26",
 		"news": {
-			"0.0.23": {
-				"en": "Added live rendering / auto-refresh in file explorer on file additions/deletions.",
-				"de": "Live-Rendering / automatische Aktualisierung im Datei-Explorer bei Hinzufügung/Löschung von Dateien hinzugefügt.",
-				"ru": "Добавлено живое отображение / автообновление в проводнике файлов при добавлении/удалении файлов.",
-				"pt": "Adicionada renderização ao vivo / atualização automática no explorador de arquivos ao adicionar/excluir arquivos.",
-				"nl": "Live rendering / auto-refresh toegevoegd in de bestandsbrowser bij toevoeging/verwijdering van bestanden.",
-				"fr": "Ajout du rendu en direct / de l'actualisation automatique dans l'explorateur de fichiers lors de l'ajout/suppression de fichiers.",
-				"it": "Aggiunto rendering live / aggiornamento automatico in Esplora file all'aggiunta/eliminazione di file.",
-				"es": "Se agregó renderizado en vivo / actualización automática en el explorador de archivos al agregar o eliminar archivos.",
-				"pl": "Dodano renderowanie na żywo / automatyczne odświeżanie w eksploratorze plików przy dodawaniu/usuwaniu plików.",
-				"uk": "Додано живе відображення / автооновлення в провіднику файлів при додаванні/вилученні файлів.",
-				"zh-cn": "在文件资源管理器中添加了在添加/删除文件时的实时渲染/自动刷新。"
+			"0.0.26": {
+				"en": "Regenerated lockfile cleanly to resolve npm ci errors on GitHub Actions workflow.",
+				"de": "Lockfile sauber regeneriert, um npm-ci-Fehler im GitHub Actions-Workflow zu beheben.",
+				"ru": "Чистая регенерация lockfile для устранения ошибок npm ci в рабочем процессе GitHub Actions.",
+				"pt": "Regenerado o lockfile de forma limpa para resolver erros do npm ci no fluxo de trabalho do GitHub Actions.",
+				"nl": "Lockfile schoon geregenereerd om npm ci-fouten in de GitHub Actions-workflow op te lossen.",
+				"fr": "Régénération propre du fichier lockfile pour résoudre les erreurs npm ci dans le flux de travail GitHub Actions.",
+				"it": "Rigenerato in modo pulito il lockfile per risolvere gli errori di npm ci nel flusso di lavoro di GitHub Actions.",
+				"es": "Se regeneró el archivo lockfile de forma limpia para resolver los errores de npm ci en el flujo de trabajo de GitHub Actions.",
+				"pl": "Czysto zregenerowano plik blokady lockfile, aby rozwiązać błędy npm ci w przepływie pracy GitHub Actions.",
+				"uk": "Чиста регенерація lockfile для усунення помилок npm ci у робочому процесі GitHub Actions.",
+				"zh-cn": "干净地重新生成 lockfile，以解决 GitHub Actions 工作流中的 npm ci 错误。"
 			},
 			"0.0.15": {
 				"en": "Reverted minimum Node.js engine requirement to 20 to support GitHub Actions runners.",
@@ -99,8 +99,9 @@
 			"gokturk413 <gokturk413@gmail.com>"
 		],
 		"keywords": [
-			"ioBroker",
-			"Static Files Directory Browsing"
+			"static-files",
+			"directory-browsing",
+			"file-viewer"
 		],
 		"licenseInformation": {
 			"type": "free",

package/lib/adapter-config.d.ts

@@ -1,19 +1,20 @@
+/* eslint-disable @typescript-eslint/no-empty-object-type */
 // This file extends the AdapterConfig type from "@types/iobroker"
 // using the actual properties present in io-package.json
 // in order to provide typings for adapter.config properties
 
-import { native } from "../io-package.json";
+import type { native } from '../io-package.json';
 
 type _AdapterConfig = typeof native;
 
 // Augment the globally declared type ioBroker.AdapterConfig
 declare global {
-	namespace ioBroker {
-		interface AdapterConfig extends _AdapterConfig {
-			// Do not enter anything here!
-		}
-	}
+    namespace ioBroker {
+        interface AdapterConfig extends _AdapterConfig {
+            // Do not enter anything here!
+        }
+    }
 }
 
 // this is required so the above AdapterConfig is found by TypeScript / type checking
-export {};
+export {};

package/lib/web.js

@@ -1,88 +1,91 @@
-const express = require("express");
-const path = require("node:path");
-const fs = require("node:fs");
+const express = require('express');
+const path = require('node:path');
+const fs = require('node:fs');
 
+/**
+ * Extension class to serve static files and configuration API endpoints.
+ */
 class ExtensionExample {
-	/**
+    /**
      * @param {object} server http or https node.js object
      * @param {object} webSettings settings of the web server
      * @param {object} adapter web adapter object
      * @param {object} instanceSettings instance object with common and native
      * @param {object} app express application
      */
-	constructor(server, webSettings, adapter, instanceSettings, app) {
-		this.app = app;
-		this.adapter = adapter;
-		this.config = instanceSettings ? instanceSettings.native : {};
-		this.config.route = this.config.route || "demo";
+    constructor(server, webSettings, adapter, instanceSettings, app) {
+        this.app = app;
+        this.adapter = adapter;
+        this.config = instanceSettings ? instanceSettings.native : {};
+        this.config.route = this.config.route || 'demo';
 
-		try {
-			adapter.log.info("Install extension on /" + this.config.route);
+        try {
+            adapter.log.info(`Install extension on /${this.config.route}`);
 
-			// Serve our SPA static files from www folder
-			const wwwPath = path.join(__dirname, "../www");
-			this.app.use("/" + this.config.route, express.static(wwwPath));
+            // Serve our SPA static files from www folder
+            const wwwPath = path.join(__dirname, '../www');
+            this.app.use(`/${this.config.route}`, express.static(wwwPath));
 
-			// Serve the reports directory so files can be accessed via URL
-			if (this.config.dirname) {
-				this.app.use("/" + this.config.route + "/files", express.static(this.config.dirname));
-			}
+            // Serve the reports directory so files can be accessed via URL
+            if (this.config.dirname) {
+                this.app.use(`/${this.config.route}/files`, express.static(this.config.dirname));
+            }
 
-			// API Endpoint for configuration and system language
-			this.app.get("/" + this.config.route + "/api/config", async (req, res) => {
-				try {
-					const systemConfig = await this.adapter.getForeignObjectAsync("system.config");
-					const systemLanguage = (systemConfig && systemConfig.common && systemConfig.common.language) || "en";
-					res.json({ success: true, language: systemLanguage });
-				} catch (e) {
-					res.json({ success: false, language: "en" });
-				}
-			});
+            // API Endpoint for configuration and system language
+            this.app.get(`/${this.config.route}/api/config`, async (req, res) => {
+                try {
+                    const systemConfig = await this.adapter.getForeignObjectAsync('system.config');
+                    const systemLanguage =
+                        (systemConfig && systemConfig.common && systemConfig.common.language) || 'en';
+                    res.json({ success: true, language: systemLanguage });
+                } catch {
+                    res.json({ success: false, language: 'en' });
+                }
+            });
 
-			// API Endpoint for listing files
-			this.app.get("/" + this.config.route + "/api/list", (req, res) => {
-				try {
-					const relPath = req.query.path || "";
-					if (relPath.includes("..")) {
-						return res.status(400).json({error: "Invalid path"});
-					}
+            // API Endpoint for listing files
+            this.app.get(`/${this.config.route}/api/list`, (req, res) => {
+                try {
+                    const relPath = req.query.path || '';
+                    if (relPath.includes('..')) {
+                        return res.status(400).json({ error: 'Invalid path' });
+                    }
 
-					const targetDir = path.join(this.config.dirname, relPath);
+                    const targetDir = path.join(this.config.dirname, relPath);
 
-					if (!fs.existsSync(targetDir) || !fs.statSync(targetDir).isDirectory()) {
-						return res.status(404).json({error: "Directory not found"});
-					}
+                    if (!fs.existsSync(targetDir) || !fs.statSync(targetDir).isDirectory()) {
+                        return res.status(404).json({ error: 'Directory not found' });
+                    }
 
-					const items = fs.readdirSync(targetDir);
-					const result = [];
-					for (const item of items) {
-						try {
-							const itemPath = path.join(targetDir, item);
-							const stat = fs.statSync(itemPath);
-							result.push({
-								name: item,
-								isDirectory: stat.isDirectory(),
-								size: stat.size,
-								mtime: stat.mtimeMs,
-								birthtime: stat.birthtimeMs,
-								ext: path.extname(item).toLowerCase()
-							});
-						} catch (err) {
-							// ignore errors
-						}
-					}
+                    const items = fs.readdirSync(targetDir);
+                    const result = [];
+                    for (const item of items) {
+                        try {
+                            const itemPath = path.join(targetDir, item);
+                            const stat = fs.statSync(itemPath);
+                            result.push({
+                                name: item,
+                                isDirectory: stat.isDirectory(),
+                                size: stat.size,
+                                mtime: stat.mtimeMs,
+                                birthtime: stat.birthtimeMs,
+                                ext: path.extname(item).toLowerCase(),
+                            });
+                        } catch {
+                            // ignore errors
+                        }
+                    }
 
-					res.json({ success: true, items: result, path: relPath });
-				} catch(e) {
-					adapter.log.error("Error in /api/list: " + e);
-					res.status(500).json({error: e.toString()});
-				}
-			});
-
-		} catch (err) {
-			adapter.log.error("Error during Extension init: " + err.stack);
-		}
-	}
+                    res.json({ success: true, items: result, path: relPath });
+                } catch (e) {
+                    adapter.log.error(`Error in /api/list: ${e}`);
+                    res.status(500).json({ error: e.toString() });
+                }
+            });
+        } catch (err) {
+            adapter.log.error(`Error during Extension init: ${err.stack}`);
+        }
+    }
 }
 
-module.exports = ExtensionExample;
+module.exports = ExtensionExample;

package/main.js

@@ -1,4 +1,4 @@
-"use strict";
+'use strict';
 
 /*
  * Created with @iobroker/create-adapter v2.6.2
@@ -6,133 +6,140 @@
 
 // The adapter-core module gives you access to the core ioBroker functions
 // you need to create an adapter
-const utils = require("@iobroker/adapter-core");
+const utils = require('@iobroker/adapter-core');
 
 // Load your modules here, e.g.:
 // const fs = require("fs");
 
 class Staticsfilefolder extends utils.Adapter {
-
-	/**
-	 * @param {Partial<utils.AdapterOptions>} [options={}]
-	 */
-	constructor(options) {
-		super({
-			...options,
-			name: "staticsfilefolder",
-		});
-		this.on("ready", this.onReady.bind(this));
-		this.on("stateChange", this.onStateChange.bind(this));
-		this.on("unload", this.onUnload.bind(this));
-
-		this.watcher = null;
-	}
-
-	/**
-	 * Is called when databases are connected and adapter received configuration.
-	 */
-	async onReady() {
-		// Create state for latest file url
-		await this.setObjectNotExistsAsync("latest_file_url", {
-			type: "state",
-			common: {
-				name: "Latest File URL",
-				type: "string",
-				role: "url",
-				read: true,
-				write: false,
-			},
-			native: {},
-		});
-
-		// Create state for the latest file path
-		await this.setObjectNotExistsAsync("latest_file_path", {
-			type: "state",
-			common: {
-				name: "Latest File Path",
-				type: "string",
-				role: "value",
-				read: true,
-				write: false,
-			},
-			native: {},
-		});
-
-		if (this.config.dirname) {
-			this.log.info("Starting file observer on: " + this.config.dirname);
-			try {
-				const chokidar = require("chokidar");
-				const path = require("node:path");
-
-				this.watcher = chokidar.watch(this.config.dirname, {
-					ignored: /(^|[/\\])\../, // ignore dotfiles
-					persistent: true,
-					ignoreInitial: true // do not fire for existing files on startup
-				});
-
-				this.watcher.on("add", async (filePath) => {
-					this.log.info(`New file detected: ${filePath}`);
-
-					// Calculate relative path for URL
-					const relativePath = path.relative(this.config.dirname, filePath).replace(/\\/g, "/");
-					const route = this.config.route || "demo";
-
-					// Assuming the web adapter serves this extension under the web server's port
-					// and relative path is encoded.
-					const fileUrl = `/${route}/files/${encodeURI(relativePath)}`;
-
-					await this.setStateAsync("latest_file_url", { val: fileUrl, ack: true });
-					await this.setStateAsync("latest_file_path", { val: filePath, ack: true });
-				});
-
-				this.watcher.on("error", error => this.log.error(`Watcher error: ${error}`));
-			} catch (e) {
-				this.log.error("Failed to start file observer: " + e);
-			}
-		} else {
-			this.log.warn("Directory name not configured. File observer will not start.");
-		}
-	}
-
-	/**
-	 * Is called when adapter shuts down - callback has to be called under any circumstances!
-	 * @param {() => void} callback
-	 */
-	onUnload(callback) {
-		try {
-			if (this.watcher) {
-				this.watcher.close();
-				this.watcher = null;
-			}
-			callback();
-		} catch (e) {
-			callback();
-		}
-	}
-
-	/**
-	 * Is called if a subscribed state changes
-	 * @param {string} id
-	 * @param {ioBroker.State | null | undefined} state
-	 */
-	onStateChange(id, state) {
-		if (state) {
-			// The state was changed
-			this.log.info(`state ${id} changed: ${state.val} (ack = ${state.ack})`);
-		} else {
-			// The state was deleted
-			this.log.info(`state ${id} deleted`);
-		}
-	}
+    /**
+     * @param {Partial<utils.AdapterOptions>} [options] The adapter options.
+     */
+    constructor(options) {
+        super({
+            ...options,
+            name: 'staticsfilefolder',
+        });
+        this.on('ready', this.onReady.bind(this));
+        this.on('stateChange', this.onStateChange.bind(this));
+        this.on('unload', this.onUnload.bind(this));
+
+        this.watcher = null;
+    }
+
+    /**
+     * Is called when databases are connected and adapter received configuration.
+     */
+    async onReady() {
+        // Create state for latest file url
+        await this.setObjectNotExistsAsync('latest_file_url', {
+            type: 'state',
+            common: {
+                name: 'Latest File URL',
+                type: 'string',
+                role: 'url',
+                read: true,
+                write: false,
+            },
+            native: {},
+        });
+
+        // Create state for the latest file path
+        await this.setObjectNotExistsAsync('latest_file_path', {
+            type: 'state',
+            common: {
+                name: 'Latest File Path',
+                type: 'string',
+                role: 'value',
+                read: true,
+                write: false,
+            },
+            native: {},
+        });
+
+        if (this.config.dirname) {
+            this.log.info(`Starting file observer on: ${this.config.dirname}`);
+            try {
+                const chokidar = require('chokidar');
+                const path = require('node:path');
+
+                this.watcher = chokidar.watch(this.config.dirname, {
+                    ignored: /(^|[/\\])\../, // ignore dotfiles
+                    persistent: true,
+                    ignoreInitial: true, // do not fire for existing files on startup
+                });
+
+                this.watcher.on('add', async filePath => {
+                    this.log.info(`New file detected: ${filePath}`);
+
+                    // Calculate relative path for URL
+                    const relativePath = path.relative(this.config.dirname, filePath).replace(/\\/g, '/');
+                    const route = this.config.route || 'demo';
+
+                    // Assuming the web adapter serves this extension under the web server's port
+                    // and relative path is encoded.
+                    const fileUrl = `/${route}/files/${encodeURI(relativePath)}`;
+
+                    await this.setStateAsync('latest_file_url', {
+                        val: fileUrl,
+                        ack: true,
+                    });
+                    await this.setStateAsync('latest_file_path', {
+                        val: filePath,
+                        ack: true,
+                    });
+                });
+
+                this.watcher.on('error', error => this.log.error(`Watcher error: ${error}`));
+            } catch (e) {
+                this.log.error(`Failed to start file observer: ${e}`);
+            }
+        } else {
+            this.log.warn('Directory name not configured. File observer will not start.');
+        }
+    }
+
+    /**
+     * Is called when adapter shuts down - callback has to be called under any circumstances!
+     *
+     * @param {() => void} callback The callback function to call after unloading.
+     */
+    onUnload(callback) {
+        try {
+            if (this.watcher) {
+                this.watcher.close();
+                this.watcher = null;
+            }
+            callback();
+        } catch {
+            callback();
+        }
+    }
+
+    /**
+     * Is called if a subscribed state changes
+     *
+     * @param {string} id The state ID.
+     * @param {ioBroker.State | null | undefined} state The state object.
+     */
+    onStateChange(id, state) {
+        if (state) {
+            // The state was changed
+            this.log.info(`state ${id} changed: ${state.val} (ack = ${state.ack})`);
+        } else {
+            // The state was deleted
+            this.log.info(`state ${id} deleted`);
+        }
+    }
 }
 
 if (require.main !== module) {
-	// Export the constructor in compact mode
-	/**
-	 * @param {Partial<utils.AdapterOptions>} [options={}]
-	 */
-	module.exports = (options) => new Staticsfilefolder(options);
+    // Export the constructor in compact mode
+    /**
+     * @param {Partial<utils.AdapterOptions>} [options] The adapter options.
+     */
+    module.exports = options => new Staticsfilefolder(options);
 } else {
-	// otherwise start the instance directly
-	new Staticsfilefolder();
-}
+    // otherwise start the instance directly
+    new Staticsfilefolder();
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.staticsfilefolder",
-  "version": "0.0.23",
+  "version": "0.0.26",
   "description": "Static Files Folder",
   "author": {
     "name": "gokturk413",
@@ -29,14 +29,14 @@
     "@alcalzone/release-script-plugin-iobroker": "^5.2.0",
     "@alcalzone/release-script-plugin-license": "^5.2.0",
     "@alcalzone/release-script-plugin-manual-review": "^5.2.0",
-    "@iobroker/adapter-dev": "^1.3.0",
-    "@iobroker/testing": "^5.2.2",
-    "@tsconfig/node22": "^22.0.0",
+    "@iobroker/adapter-dev": "^1.5.0",
+    "@iobroker/eslint-config": "^2.3.4",
+    "@iobroker/testing": "^5.3.0",
+    "@tsconfig/node22": "^22.0.5",
     "@types/node": "^18.19.24",
     "@types/proxyquire": "^1.3.31",
-    "eslint": "^8.57.0",
     "proxyquire": "^2.1.3",
-    "typescript": "~5.0.4"
+    "typescript": "^5.5.4"
   },
   "main": "main.js",
   "files": [