matterbridge-example-dynamic-platform 1.4.0 → 2.0.0

package/CHANGELOG.md

@@ -1,3 +1,5 @@
+<!-- markdownlint-disable MD024 MD033 -->
+
 # <img src="matterbridge.svg" alt="Matterbridge Logo" width="64px" height="64px">&nbsp;&nbsp;&nbsp;Matterbridge dynamic platform example plugin changelog
 
 [![npm version](https://img.shields.io/npm/v/matterbridge-example-dynamic-platform.svg)](https://www.npmjs.com/package/matterbridge-example-dynamic-platform)
@@ -17,31 +19,46 @@
 
 All notable changes to this project will be documented in this file.
 
-If you like this project and find it useful, please consider giving it a star on GitHub at https://github.com/Luligu/matterbridge-example-dynamic-platform and sponsoring it.
+If you like this project and find it useful, please consider giving it a star on GitHub at <https://github.com/Luligu/matterbridge-example-dynamic-platform> and sponsoring it.
 
 <a href="https://www.buymeacoffee.com/luligugithub">
   <img src="bmc-button.svg" alt="Buy me a coffee" width="120">
 </a>
 
+## [2.0.0] - 2025-10-24
+
+### Changed
+
+- [package]: Bumped platform to v. 2.0.0.
+- [package]: Updated dependencies.
+- [package]: Bumped package to automator version 2.0.9
+- [jest]: Updated jestHelpers to v. 1.0.9.
+
+<a href="https://www.buymeacoffee.com/luligugithub">
+  <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
+</a>
+
 ## [1.4.0] - 2025-10-15
 
 ### Added
 
 - [jest]: Added jest helper module v. 1.0.6.
 - [platform]: Added a thermostat with auto mode and occupancy and outdoorTemperature.
-- [platform]: Added animation to Heat pump. Thanks Ludovic BOUÉ (https://github.com/Luligu/matterbridge-example-dynamic-platform/pull/35).
-- [platform]: Added Toggle thermostatRunningState heat and cool. Thanks Ludovic BOUÉ (https://github.com/Luligu/matterbridge-example-dynamic-platform/pull/36).
+- [platform]: Added animation to Heat pump. Thanks Ludovic BOUÉ (<https://github.com/Luligu/matterbridge-example-dynamic-platform/pull/35>).
+- [platform]: Added Toggle thermostatRunningState heat and cool. Thanks Ludovic BOUÉ (<https://github.com/Luligu/matterbridge-example-dynamic-platform/pull/36>).
 
 ### Changed
 
 - [package]: Require matterbridge 3.3.0.
 - [index]: Updated to new signature PlatformMatterbridge.
 - [platform]: Updated to new signature PlatformMatterbridge.
-- [platform]: Added whiteList and blackList.
-- [platform]: Typed TestPlatformConfig.
 - [package]: Updated dependencies.
 - [package]: Bumped package to automator version 2.0.7
-- [workflows]: Ignore any .md anywhere in all workflows.
+- [workflows]: Ignore any .md in build.yaml.
+- [workflows]: Ignore any .md in codeql.yaml.
+- [workflows]: Ignore any .md in codecov.yaml.
+- [template]: Updated bug_report.md.
+- [jest]: Updated jestHelpers to v. 1.0.6.
 
 <a href="https://www.buymeacoffee.com/luligugithub">
   <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
@@ -52,7 +69,7 @@ If you like this project and find it useful, please consider giving it a star on
 ### Added
 
 - [jest]: Added jest helper module v. 1.0.5.
-- [rvc]: Added DustBinFull to the Rvc animation (https://github.com/Luligu/matterbridge-example-dynamic-platform/pull/31).
+- [rvc]: Added DustBinFull to the Rvc animation (<https://github.com/Luligu/matterbridge-example-dynamic-platform/pull/31>).
 
 ### Changed
 
@@ -69,7 +86,7 @@ If you like this project and find it useful, please consider giving it a star on
 ### Changed
 
 - [package]: Updated dependencies.
-- [platform]: Removed attributes setting when is managed by the Matterbridge servers. This add support for **Apple Home Adaptive Lighting**. See https://github.com/Luligu/matterbridge/discussions/390.
+- [platform]: Removed attributes setting when is managed by the Matterbridge servers. This add support for **Apple Home Adaptive Lighting**. See <https://github.com/Luligu/matterbridge/discussions/390>.
 
 <a href="https://www.buymeacoffee.com/luligugithub">
   <img src="bmc-button.svg" alt="Buy me a coffee" width="80">
@@ -333,7 +350,7 @@ If you like this project and find it useful, please consider giving it a star on
 
 ### Added
 
-- [platform]: Added Robot Vacuum Cleaner device (supported by SmartThings, Alexa, Home Assistant and partially by Apple Home). Read carefully the readme please and also https://github.com/Luligu/matterbridge/discussions/264.
+- [platform]: Added Robot Vacuum Cleaner device (supported by SmartThings, Alexa, Home Assistant and partially by Apple Home). Read carefully the readme please and also <https://github.com/Luligu/matterbridge/discussions/264>.
 - [platform]: Added OnOff Mounted Switch device (supported by SmartThings, Alexa, Home Assistant).
 - [platform]: Added Dimmer Mounted Switch device (supported by SmartThings, Alexa, Home Assistant).
 - [platform]: Added Laundry Washer device (supported by SmartThings, Alexa and Home Assistant).

package/README.md

@@ -1,3 +1,5 @@
+<!-- markdownlint-disable MD033 -->
+
 # <img src="matterbridge.svg" alt="Matterbridge Logo" width="64px" height="64px">&nbsp;&nbsp;&nbsp;Matterbridge dynamic platform example plugin
 
 [![npm version](https://img.shields.io/npm/v/matterbridge-example-dynamic-platform.svg)](https://www.npmjs.com/package/matterbridge-example-dynamic-platform)
@@ -61,7 +63,7 @@ It exposes 58 virtual devices:
 - an airQuality device with all concentration measurements clusters (supported by Apple Home with the concentration measurements from version 18.5)
 - a momentary switch composed by three switches with Single Double Long (tagged with One Two Three and Top Middle Bottom) and three switches with Single only.
 - a latching switch
-- a Robot Vacuum Cleaner device (supported by SmartThings, Alexa, Home Assistant and partially by Apple Home). Read also https://github.com/Luligu/matterbridge/discussions/264.
+- a Robot Vacuum Cleaner device (supported by SmartThings, Alexa, Home Assistant and partially by Apple Home). Read also <https://github.com/Luligu/matterbridge/discussions/264>.
 - a onOff Mounted Switch device (supported by SmartThings, Alexa, Home Assistant)
 - a dimmer Mounted Switch device (supported by SmartThings, Alexa, Home Assistant)
 - a laundry Washer device (supported by SmartThings, Alexa and Home Assistant)
@@ -83,7 +85,7 @@ All these devices continuously change state and position. The plugin also shows
 
 If you want to write your plugin, the easiest way to start create a new plugin is to clone the [Matterbridge Plugin Template](https://github.com/Luligu/matterbridge-plugin-template) which has **Dev Container support for instant development environment** and all tools and extensions (like Node.js, npm, TypeScript, ESLint, Prettier, Jest and Vitest) already loaded and configured.
 
-If you like this project and find it useful, please consider giving it a star on GitHub at https://github.com/Luligu/matterbridge-example-dynamic-platform and sponsoring it.
+If you like this project and find it useful, please consider giving it a star on GitHub at <https://github.com/Luligu/matterbridge-example-dynamic-platform> and sponsoring it.
 
 <a href="https://www.buymeacoffee.com/luligugithub">
   <img src="bmc-button.svg" alt="Buy me a coffee" width="120">

package/dist/{platform.js → module.js}

@@ -19,6 +19,9 @@ function matterToLux(value) {
     const lux = Math.pow(10, v / 10000);
     return Math.round(lux < 0 ? 0 : lux);
 }
+export default function initializePlugin(matterbridge, log, config) {
+    return new ExampleMatterbridgeDynamicPlatform(matterbridge, log, config);
+}
 export class ExampleMatterbridgeDynamicPlatform extends MatterbridgeDynamicPlatform {
     config;
     door;

package/npm-shrinkwrap.json

@@ -1,19 +1,19 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "1.4.0",
+  "version": "2.0.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-example-dynamic-platform",
-      "version": "1.4.0",
+      "version": "2.0.0",
       "license": "Apache-2.0",
       "dependencies": {
         "node-ansi-logger": "3.1.1",
         "node-persist-manager": "2.0.0"
       },
       "engines": {
-        "node": ">=18.0.0 <19.0.0 || >=20.0.0 <21.0.0 || >=22.0.0 <23.0.0 || >=24.0.0 <25.0.0"
+        "node": ">=20.0.0 <21.0.0 || >=22.0.0 <23.0.0 || >=24.0.0 <25.0.0"
       },
       "funding": {
         "type": "buymeacoffee",

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge-example-dynamic-platform",
-  "version": "1.4.0",
+  "version": "2.0.0",
   "description": "Matterbridge dynamic plugin",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",
   "homepage": "https://www.npmjs.com/package/matterbridge-example-dynamic-platform",
   "type": "module",
-  "main": "dist/index.js",
+  "main": "dist/module.js",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Luligu/matterbridge-example-dynamic-platform.git"
@@ -31,7 +31,7 @@
     "virtual devices"
   ],
   "engines": {
-    "node": ">=18.0.0 <19.0.0 || >=20.0.0 <21.0.0 || >=22.0.0 <23.0.0 || >=24.0.0 <25.0.0"
+    "node": ">=20.0.0 <21.0.0 || >=22.0.0 <23.0.0 || >=24.0.0 <25.0.0"
   },
   "dependencies": {
     "node-ansi-logger": "3.1.1",

package/dist/index.js

@@ -1,4 +0,0 @@
-import { ExampleMatterbridgeDynamicPlatform } from './platform.js';
-export default function initializePlugin(matterbridge, log, config) {
-    return new ExampleMatterbridgeDynamicPlatform(matterbridge, log, config);
-}

package/dist/jestHelpers.js

@@ -1,231 +0,0 @@
-import { rmSync } from 'node:fs';
-import { inspect } from 'node:util';
-import path from 'node:path';
-import { jest } from '@jest/globals';
-import { DeviceTypeId, Endpoint, Environment, MdnsService, ServerNode, ServerNodeStore, VendorId, LogFormat as MatterLogFormat, LogLevel as MatterLogLevel, Lifecycle, } from 'matterbridge/matter';
-import { RootEndpoint, AggregatorEndpoint } from 'matterbridge/matter/endpoints';
-import { AnsiLogger } from 'matterbridge/logger';
-export let loggerLogSpy;
-export let consoleLogSpy;
-export let consoleDebugSpy;
-export let consoleInfoSpy;
-export let consoleWarnSpy;
-export let consoleErrorSpy;
-export function setupTest(name, debug = false) {
-    expect(name).toBeDefined();
-    expect(typeof name).toBe('string');
-    expect(name.length).toBeGreaterThanOrEqual(4);
-    rmSync(path.join('jest', name), { recursive: true, force: true });
-    if (debug) {
-        loggerLogSpy = jest.spyOn(AnsiLogger.prototype, 'log');
-        consoleLogSpy = jest.spyOn(console, 'log');
-        consoleDebugSpy = jest.spyOn(console, 'debug');
-        consoleInfoSpy = jest.spyOn(console, 'info');
-        consoleWarnSpy = jest.spyOn(console, 'warn');
-        consoleErrorSpy = jest.spyOn(console, 'error');
-    }
-    else {
-        loggerLogSpy = jest.spyOn(AnsiLogger.prototype, 'log').mockImplementation(() => { });
-        consoleLogSpy = jest.spyOn(console, 'log').mockImplementation(() => { });
-        consoleDebugSpy = jest.spyOn(console, 'debug').mockImplementation(() => { });
-        consoleInfoSpy = jest.spyOn(console, 'info').mockImplementation(() => { });
-        consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => { });
-        consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => { });
-    }
-}
-export function setDebug(debug) {
-    if (debug) {
-        loggerLogSpy.mockRestore();
-        consoleLogSpy.mockRestore();
-        consoleDebugSpy.mockRestore();
-        consoleInfoSpy.mockRestore();
-        consoleWarnSpy.mockRestore();
-        consoleErrorSpy.mockRestore();
-        loggerLogSpy = jest.spyOn(AnsiLogger.prototype, 'log');
-        consoleLogSpy = jest.spyOn(console, 'log');
-        consoleDebugSpy = jest.spyOn(console, 'debug');
-        consoleInfoSpy = jest.spyOn(console, 'info');
-        consoleWarnSpy = jest.spyOn(console, 'warn');
-        consoleErrorSpy = jest.spyOn(console, 'error');
-    }
-    else {
-        loggerLogSpy = jest.spyOn(AnsiLogger.prototype, 'log').mockImplementation(() => { });
-        consoleLogSpy = jest.spyOn(console, 'log').mockImplementation(() => { });
-        consoleDebugSpy = jest.spyOn(console, 'debug').mockImplementation(() => { });
-        consoleInfoSpy = jest.spyOn(console, 'info').mockImplementation(() => { });
-        consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation(() => { });
-        consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => { });
-    }
-}
-export function createTestEnvironment(homeDir) {
-    expect(homeDir).toBeDefined();
-    expect(typeof homeDir).toBe('string');
-    expect(homeDir.length).toBeGreaterThanOrEqual(4);
-    rmSync(homeDir, { recursive: true, force: true });
-    const environment = Environment.default;
-    environment.vars.set('log.level', MatterLogLevel.DEBUG);
-    environment.vars.set('log.format', MatterLogFormat.ANSI);
-    environment.vars.set('path.root', homeDir);
-    environment.vars.set('runtime.signals', false);
-    environment.vars.set('runtime.exitcode', false);
-    return environment;
-}
-export async function flushAsync(ticks = 3, microTurns = 10, pause = 100) {
-    for (let i = 0; i < ticks; i++)
-        await new Promise((resolve) => setImmediate(resolve));
-    for (let i = 0; i < microTurns; i++)
-        await Promise.resolve();
-    if (pause)
-        await new Promise((resolve) => setTimeout(resolve, pause));
-}
-export async function flushAllEndpointNumberPersistence(targetServer, rounds = 2) {
-    const nodeStore = targetServer.env.get(ServerNodeStore);
-    for (let i = 0; i < rounds; i++) {
-        await new Promise((resolve) => setImmediate(resolve));
-        await nodeStore.endpointStores.close();
-    }
-}
-function collectAllEndpoints(root) {
-    const list = [];
-    const walk = (ep) => {
-        list.push(ep);
-        if (ep.parts) {
-            for (const child of ep.parts) {
-                walk(child);
-            }
-        }
-    };
-    walk(root);
-    return list;
-}
-export async function assertAllEndpointNumbersPersisted(targetServer) {
-    const nodeStore = targetServer.env.get(ServerNodeStore);
-    await nodeStore.endpointStores.close();
-    const all = collectAllEndpoints(targetServer);
-    for (const ep of all) {
-        const store = nodeStore.storeForEndpoint(ep);
-        if (ep.maybeNumber === 0) {
-            expect(store.number ?? 0).toBe(0);
-        }
-        else {
-            expect(store.number).toBeGreaterThan(0);
-        }
-    }
-    return all.length;
-}
-export async function startServerNode(name, port) {
-    const server = await ServerNode.create({
-        id: name + 'ServerNode',
-        productDescription: {
-            name: name + 'ServerNode',
-            deviceType: DeviceTypeId(RootEndpoint.deviceType),
-            vendorId: VendorId(0xfff1),
-            productId: 0x8000,
-        },
-        basicInformation: {
-            vendorId: VendorId(0xfff1),
-            vendorName: 'Matterbridge',
-            productId: 0x8000,
-            productName: 'Matterbridge ' + name,
-            nodeLabel: name + 'ServerNode',
-            hardwareVersion: 1,
-            softwareVersion: 1,
-            reachable: true,
-        },
-        network: {
-            port,
-        },
-    });
-    expect(server).toBeDefined();
-    expect(server.lifecycle.isReady).toBeTruthy();
-    const aggregator = new Endpoint(AggregatorEndpoint, {
-        id: name + 'AggregatorNode',
-    });
-    expect(aggregator).toBeDefined();
-    await server.add(aggregator);
-    expect(server.parts.has(aggregator.id)).toBeTruthy();
-    expect(server.parts.has(aggregator)).toBeTruthy();
-    expect(aggregator.lifecycle.isReady).toBeTruthy();
-    expect(server.lifecycle.isOnline).toBeFalsy();
-    await new Promise((resolve) => {
-        server.lifecycle.online.on(async () => {
-            resolve();
-        });
-        server.start();
-    });
-    expect(server.lifecycle.isReady).toBeTruthy();
-    expect(server.lifecycle.isOnline).toBeTruthy();
-    expect(server.lifecycle.isCommissioned).toBeFalsy();
-    expect(server.lifecycle.isPartsReady).toBeTruthy();
-    expect(server.lifecycle.hasId).toBeTruthy();
-    expect(server.lifecycle.hasNumber).toBeTruthy();
-    expect(aggregator.lifecycle.isReady).toBeTruthy();
-    expect(aggregator.lifecycle.isInstalled).toBeTruthy();
-    expect(aggregator.lifecycle.isPartsReady).toBeTruthy();
-    expect(aggregator.lifecycle.hasId).toBeTruthy();
-    expect(aggregator.lifecycle.hasNumber).toBeTruthy();
-    await flushAsync(undefined, undefined, 200);
-    return [server, aggregator];
-}
-export async function stopServerNode(server) {
-    await flushAllEndpointNumberPersistence(server);
-    await assertAllEndpointNumbersPersisted(server);
-    expect(server).toBeDefined();
-    expect(server.lifecycle.isReady).toBeTruthy();
-    expect(server.lifecycle.isOnline).toBeTruthy();
-    await server.close();
-    expect(server.lifecycle.isReady).toBeTruthy();
-    expect(server.lifecycle.isOnline).toBeFalsy();
-    await server.env.get(MdnsService)[Symbol.asyncDispose]();
-    await flushAsync(undefined, undefined, 200);
-}
-export async function addDevice(owner, device, pause = 10) {
-    expect(owner).toBeDefined();
-    expect(device).toBeDefined();
-    expect(owner.lifecycle.isReady).toBeTruthy();
-    expect(owner.construction.status).toBe(Lifecycle.Status.Active);
-    expect(owner.lifecycle.isPartsReady).toBeTruthy();
-    try {
-        await owner.add(device);
-    }
-    catch (error) {
-        const errorMessage = error instanceof Error ? error.message : error;
-        const errorInspect = inspect(error, { depth: 10 });
-        console.error(`Error adding device ${device.maybeId}.${device.maybeNumber}: ${errorMessage}\nstack: ${errorInspect}`);
-        return false;
-    }
-    expect(owner.parts.has(device)).toBeTruthy();
-    expect(owner.lifecycle.isPartsReady).toBeTruthy();
-    expect(device.lifecycle.isReady).toBeTruthy();
-    expect(device.lifecycle.isInstalled).toBeTruthy();
-    expect(device.lifecycle.hasId).toBeTruthy();
-    expect(device.lifecycle.hasNumber).toBeTruthy();
-    expect(device.construction.status).toBe(Lifecycle.Status.Active);
-    await flushAsync(1, 1, pause);
-    return true;
-}
-export async function deleteDevice(owner, device, pause = 10) {
-    expect(owner).toBeDefined();
-    expect(device).toBeDefined();
-    expect(owner.lifecycle.isReady).toBeTruthy();
-    expect(owner.construction.status).toBe(Lifecycle.Status.Active);
-    expect(owner.lifecycle.isPartsReady).toBeTruthy();
-    try {
-        await device.delete();
-    }
-    catch (error) {
-        const errorMessage = error instanceof Error ? error.message : error;
-        const errorInspect = inspect(error, { depth: 10 });
-        console.error(`Error deleting device ${device.maybeId}.${device.maybeNumber}: ${errorMessage}\nstack: ${errorInspect}`);
-        return false;
-    }
-    expect(owner.parts.has(device)).toBeFalsy();
-    expect(owner.lifecycle.isPartsReady).toBeTruthy();
-    expect(device.lifecycle.isReady).toBeFalsy();
-    expect(device.lifecycle.isInstalled).toBeFalsy();
-    expect(device.lifecycle.hasId).toBeTruthy();
-    expect(device.lifecycle.hasNumber).toBeTruthy();
-    expect(device.construction.status).toBe(Lifecycle.Status.Destroyed);
-    await flushAsync(1, 1, pause);
-    return true;
-}