matterbridge 3.3.8-dev-20251115-ca5ff21 → 3.3.8

package/dist/helpers.js

@@ -1,3 +1,27 @@
+/**
+ * This file contains the helpers functions of Matterbridge.
+ *
+ * @file helpers.ts
+ * @author Luca Liguori
+ * @created 2025-05-12
+ * @version 1.0.0
+ * @license Apache-2.0
+ *
+ * Copyright 2025, 2026, 2027 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+// @matter module
 import { OnOff } from '@matter/types/clusters/on-off';
 import { Endpoint } from '@matter/node';
 import { BridgedDeviceBasicInformationServer } from '@matter/node/behaviors/bridged-device-basic-information';
@@ -6,8 +30,24 @@ import { OnOffPlugInUnitDevice } from '@matter/node/devices/on-off-plug-in-unit'
 import { MountedOnOffControlDevice } from '@matter/node/devices/mounted-on-off-control';
 import { OnOffLightDevice } from '@matter/node/devices/on-off-light';
 import { OnOffLightSwitchDevice } from '@matter/node/devices/on-off-light-switch';
+// Matterbridge
 import { hasParameter } from './utils/commandLine.js';
+/**
+ * Adds a virtual device to the provided endpoint, sets up an event listener for device state changes,
+ * and ensures the device is initialized in the off state.
+ *
+ * @param {Endpoint<AggregatorEndpoint>} aggregatorEndpoint - The aggragator endpoint to which the virtual device will be added.
+ * @param {string} name - The name of the virtual device. Spaces in the name are removed to form the device ID.
+ * @param {'light' | 'outlet' | 'switch' | 'mounted_switch'} type - The type of the virtual device. Can be 'light', 'outlet', 'switch', or 'mounted_switch'.
+ * @param {() => Promise<void>} callback - A callback function that gets executed when the device's on/off state changes to true.
+ * @returns {Promise<Endpoint>} A promise that resolves with the created virtual device.
+ * @remarks The virtual device is created as an instance of `Endpoint` with the `OnOffPlugInUnitDevice` device type.
+ * The onOff state always reverts to false when the device is turned on.
+ */
 export async function addVirtualDevice(aggregatorEndpoint, name, type, callback) {
+    // Create a new virtual device by instantiating `Endpoint` with device information.
+    // The device ID is created by replacing all spaces in the name with an empty string.
+    // The node label of the bridged device basic information is set to the given name.
     let deviceType;
     switch (type) {
         case 'light':
@@ -28,7 +68,9 @@ export async function addVirtualDevice(aggregatorEndpoint, name, type, callback)
         bridgedDeviceBasicInformation: { nodeLabel: name.slice(0, 32) },
         onOff: { onOff: false, startUpOnOff: OnOff.StartUpOnOff.Off },
     });
+    // Set up an event listener for when the `onOff` state changes.
     device.events.onOff.onOff$Changed.on((value) => {
+        // If the `onOff` state becomes true, turn off the virtual device and execute the callback.
         if (value) {
             callback();
             process.nextTick(async () => {
@@ -36,14 +78,24 @@ export async function addVirtualDevice(aggregatorEndpoint, name, type, callback)
                     await device.setStateOf(OnOffBaseServer, { onOff: false });
                 }
                 catch (_error) {
+                    // Not necessary to handle the error
                 }
             });
         }
     });
+    // Add the created device to the given endpoint.
     await aggregatorEndpoint.add(device);
+    // Initially set the state of the virtual device's `OnOffBaseServer` to false (off).
     await device.setStateOf(OnOffBaseServer, { onOff: false });
     return device;
 }
+/**
+ * Creates and add the virtual devices to the aggregator.
+ *
+ * @param {Matterbridge} matterbridge - The Matterbridge instance.
+ * @param {Endpoint<AggregatorEndpoint>} aggregatorEndpoint - The aggregator node to add the virtual devices to.
+ * @returns {Promise<void>} A promise that resolves when the virtual devices are added.
+ */
 export async function addVirtualDevices(matterbridge, aggregatorEndpoint) {
     if (matterbridge.virtualMode !== 'disabled' && matterbridge.bridgeMode === 'bridge' && aggregatorEndpoint) {
         matterbridge.log.notice(`Creating virtual devices for Matterbridge server node...`);
@@ -92,3 +144,4 @@ export async function addVirtualDevices(matterbridge, aggregatorEndpoint) {
         }
     }
 }
+//# sourceMappingURL=helpers.js.map

package/dist/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,iBAAiB;AACjB,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,mCAAmC,EAAE,MAAM,yDAAyD,CAAC;AAC9G,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAC;AAEjF,OAAO,EAAE,yBAAyB,EAAE,MAAM,6CAA6C,CAAC;AACxF,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AACrE,OAAO,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAC;AAElF,eAAe;AACf,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAGtD;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,kBAAgD,EAAE,IAAY,EAAE,IAAsD,EAAE,QAA6B;IAC1L,mFAAmF;IACnF,qFAAqF;IACrF,mFAAmF;IACnF,IAAI,UAAU,CAAC;IACf,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,OAAO;YACV,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;YACxE,MAAM;QACR,KAAK,QAAQ;YACX,UAAU,GAAG,qBAAqB,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;YAC7E,MAAM;QACR,KAAK,QAAQ;YACX,UAAU,GAAG,sBAAsB,CAAC,IAAI,CAAC,mCAAmC,EAAE,eAAe,CAAC,CAAC;YAC/F,MAAM;QACR,KAAK,gBAAgB;YACnB,UAAU,GAAG,yBAAyB,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;YACjF,MAAM;IACV,CAAC;IACD,MAAM,MAAM,GAAG,IAAI,QAAQ,CAAC,UAAU,EAAE;QACtC,EAAE,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,GAAG,IAAI;QACzC,6BAA6B,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE;QAC/D,KAAK,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,EAAE;KAC9D,CAAC,CAAC;IAEH,+DAA+D;IAC/D,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,EAAE;QAC7C,2FAA2F;QAC3F,IAAI,KAAK,EAAE,CAAC;YACV,QAAQ,EAAE,CAAC;YACX,OAAO,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;gBAC1B,IAAI,CAAC;oBACH,MAAM,MAAM,CAAC,UAAU,CAAC,eAAe,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC7D,CAAC;gBAAC,OAAO,MAAM,EAAE,CAAC;oBAChB,oCAAoC;gBACtC,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,gDAAgD;IAChD,MAAM,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAErC,oFAAoF;IACpF,MAAM,MAAM,CAAC,UAAU,CAAC,eAAe,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAE3D,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,YAA0B,EAAE,kBAAgD;IAClH,IAAI,YAAY,CAAC,WAAW,KAAK,UAAU,IAAI,YAAY,CAAC,UAAU,KAAK,QAAQ,IAAI,kBAAkB,EAAE,CAAC;QAC1G,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,0DAA0D,CAAC,CAAC;QACpF,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,sBAAsB,EAAE,YAAY,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;YACtG,IAAI,YAAY,CAAC,WAAW,KAAK,EAAE;gBAAE,MAAM,YAAY,CAAC,cAAc,EAAE,CAAC;;gBACpE,MAAM,YAAY,CAAC,eAAe,EAAE,CAAC;QAC5C,CAAC,CAAC,CAAC;QACH,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,qBAAqB,EAAE,YAAY,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;YACrG,IAAI,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC3B,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,CAAC;gBAClD,SAAS,CAAC,0BAA0B,EAAE,EAAE,GAAG,IAAI,CAAC;qBAC7C,IAAI,CAAC,GAAG,EAAE;oBACT,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,oCAAoC,CAAC,CAAC;oBAC9D,OAAO;gBACT,CAAC,CAAC;qBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;oBACf,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,iCAAiC,KAAK,EAAE,CAAC,CAAC;gBACnE,CAAC,CAAC,CAAC;gBACL,SAAS,CAAC,2BAA2B,EAAE,EAAE,GAAG,IAAI,CAAC;qBAC9C,IAAI,CAAC,GAAG,EAAE;oBACT,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,sCAAsC,CAAC,CAAC;oBAChE,OAAO;gBACT,CAAC,CAAC;qBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;oBACf,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,mCAAmC,KAAK,EAAE,CAAC,CAAC;gBACrE,CAAC,CAAC,CAAC;YACP,CAAC;iBAAM,CAAC;gBACN,MAAM,YAAY,CAAC,aAAa,EAAE,CAAC;YACrC,CAAC;QACH,CAAC,CAAC,CAAC;QACH,IAAI,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3B,MAAM,gBAAgB,CAAC,kBAAkB,EAAE,qBAAqB,EAAE,YAAY,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;gBACrG,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,CAAC;gBACnD,UAAU,CAAC,oBAAoB,EAAE,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC;qBAC5C,IAAI,CAAC,GAAG,EAAE;oBACT,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,2BAA2B,CAAC,CAAC;oBACrD,OAAO;gBACT,CAAC,CAAC;qBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;oBACf,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,iCAAiC,KAAK,EAAE,CAAC,CAAC;gBACnE,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @description This file contains the entry point of Matterbridge.
+ * @file index.ts
+ * @author Luca Liguori
+ * @created 2023-12-29
+ * @version 1.0.9
+ * @license Apache-2.0
+ *
+ * Copyright 2023, 2024, 2025 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export * from './matterbridge.js';
+export * from './matterbridgeTypes.js';
+export * from './matterbridgeEndpoint.js';
+export * from './matterbridgeEndpointHelpers.js';
+export * from './matterbridgeEndpointTypes.js';
+export * from './matterbridgeBehaviors.js';
+export * from './matterbridgeDeviceTypes.js';
+export * from './matterbridgePlatform.js';
+export * from './matterbridgeAccessoryPlatform.js';
+export * from './matterbridgeDynamicPlatform.js';
+export { addVirtualDevice } from './helpers.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAMH,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kCAAkC,CAAC;AACjD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC"}

package/dist/index.js

@@ -1,5 +1,29 @@
+/**
+ * @description This file contains the entry point of Matterbridge.
+ * @file index.ts
+ * @author Luca Liguori
+ * @created 2023-12-29
+ * @version 1.0.9
+ * @license Apache-2.0
+ *
+ * Copyright 2023, 2024, 2025 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+// eslint-disable-next-line no-console
 if (process.argv.includes('--loader') || process.argv.includes('-loader'))
     console.log('\u001B[32mIndex loaded.\u001B[40;0m');
+// Matterbridge
 export * from './matterbridge.js';
 export * from './matterbridgeTypes.js';
 export * from './matterbridgeEndpoint.js';
@@ -11,3 +35,4 @@ export * from './matterbridgePlatform.js';
 export * from './matterbridgeAccessoryPlatform.js';
 export * from './matterbridgeDynamicPlatform.js';
 export { addVirtualDevice } from './helpers.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,sCAAsC;AACtC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;IAAE,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC;AAE9H,eAAe;AACf,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kCAAkC,CAAC;AACjD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC"}

package/dist/jestutils/export.d.ts

@@ -0,0 +1,2 @@
+export * from './jestHelpers.js';
+//# sourceMappingURL=export.d.ts.map

package/dist/jestutils/export.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"export.d.ts","sourceRoot":"","sources":["../../src/jestutils/export.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC"}

package/dist/jestutils/export.js

@@ -1 +1,2 @@
 export * from './jestHelpers.js';
+//# sourceMappingURL=export.js.map

package/dist/jestutils/export.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"export.js","sourceRoot":"","sources":["../../src/jestutils/export.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC"}

package/dist/jestutils/jestHelpers.d.ts

@@ -0,0 +1,250 @@
+/**
+ * @description This file contains the Jest helpers.
+ * @file src/helpers.test.ts
+ * @author Luca Liguori
+ * @created 2025-09-03
+ * @version 1.0.12
+ * @license Apache-2.0
+ *
+ * Copyright 2025, 2026, 2027 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { jest } from '@jest/globals';
+import { AnsiLogger } from 'node-ansi-logger';
+import { Environment } from '@matter/general';
+import { Endpoint, ServerNode } from '@matter/node';
+import { DeviceTypeId } from '@matter/types/datatype';
+import { AggregatorEndpoint } from '@matter/node/endpoints';
+import { Matterbridge } from '../matterbridge.js';
+import { MatterbridgePlatform } from '../matterbridgePlatform.js';
+export declare let loggerLogSpy: jest.SpiedFunction<typeof AnsiLogger.prototype.log>;
+export declare let loggerDebugSpy: jest.SpiedFunction<typeof AnsiLogger.prototype.debug>;
+export declare let loggerInfoSpy: jest.SpiedFunction<typeof AnsiLogger.prototype.info>;
+export declare let loggerNoticeSpy: jest.SpiedFunction<typeof AnsiLogger.prototype.notice>;
+export declare let loggerWarnSpy: jest.SpiedFunction<typeof AnsiLogger.prototype.warn>;
+export declare let loggerErrorSpy: jest.SpiedFunction<typeof AnsiLogger.prototype.error>;
+export declare let loggerFatalSpy: jest.SpiedFunction<typeof AnsiLogger.prototype.fatal>;
+export declare let consoleLogSpy: jest.SpiedFunction<typeof console.log>;
+export declare let consoleDebugSpy: jest.SpiedFunction<typeof console.log>;
+export declare let consoleInfoSpy: jest.SpiedFunction<typeof console.log>;
+export declare let consoleWarnSpy: jest.SpiedFunction<typeof console.log>;
+export declare let consoleErrorSpy: jest.SpiedFunction<typeof console.log>;
+export declare let addBridgedEndpointSpy: jest.SpiedFunction<typeof Matterbridge.prototype.addBridgedEndpoint>;
+export declare let removeBridgedEndpointSpy: jest.SpiedFunction<typeof Matterbridge.prototype.removeBridgedEndpoint>;
+export declare let removeAllBridgedEndpointsSpy: jest.SpiedFunction<typeof Matterbridge.prototype.removeAllBridgedEndpoints>;
+export declare let matterbridge: Matterbridge;
+export declare let environment: Environment;
+export declare let server: ServerNode<ServerNode.RootEndpoint>;
+export declare let aggregator: Endpoint<AggregatorEndpoint>;
+export declare let log: AnsiLogger;
+/**
+ * Setup the Jest environment:
+ * - it will remove any existing home directory
+ * - setup the spies for logging
+ *
+ * @param {string} name The name of the test suite.
+ * @param {boolean} debug If true, the logging is not mocked.
+ *
+ * @example
+ * ```typescript
+ * import { consoleDebugSpy, consoleErrorSpy, consoleInfoSpy, consoleLogSpy, consoleWarnSpy, loggerLogSpy, setDebug, setupTest } from './jestutils/jestHelpers.js';
+ *
+ * // Setup the test environment
+ * setupTest(NAME, false);
+ *
+ * ```
+ */
+export declare function setupTest(name: string, debug?: boolean): Promise<void>;
+/**
+ * Set or unset the debug mode.
+ *
+ * @param {boolean} debug If true, the logging is not mocked.
+ *
+ * @example
+ * ```typescript
+ * // Set the debug mode in test environment
+ * setDebug(true);
+ * ```
+ *
+ * ```typescript
+ * // Reset the debug mode in test environment
+ * setDebug(false);
+ * ```
+ */
+export declare function setDebug(debug: boolean): Promise<void>;
+/**
+ * Create a Matterbridge instance for testing without initializing it.
+ *
+ * @param {string} name - Name for the environment (jest/name).
+ * @returns {Promise<Matterbridge>} The Matterbridge instance.
+ *
+ * @example
+ * ```typescript
+ * // Create Matterbridge environment
+ * await createMatterbridgeEnvironment(NAME);
+ * await startMatterbridgeEnvironment(MATTER_PORT);
+ * ```
+ */
+export declare function createMatterbridgeEnvironment(name: string): Promise<Matterbridge>;
+/**
+ * Start the matterbridge environment
+ *
+ * @param {number} port The matter server port.
+ * @returns {Promise<[ServerNode<ServerNode.RootEndpoint>, Endpoint<AggregatorEndpoint>]>} The started server and aggregator.
+ *
+ * @example
+ * ```typescript
+ * // Create Matterbridge environment
+ * await createMatterbridgeEnvironment(NAME);
+ * await startMatterbridgeEnvironment(MATTER_PORT);
+ * ```
+ */
+export declare function startMatterbridgeEnvironment(port?: number): Promise<[ServerNode<ServerNode.RootEndpoint>, Endpoint<AggregatorEndpoint>]>;
+/**
+ * Add a matterbridge platform for testing.
+ *
+ * @param {MatterbridgePlatform} platform The platform to add.
+ * @param {string} [name] Optional name of the platform.
+ *
+ * @example
+ * ```typescript
+ * platform = new Platform(matterbridge, log, config);
+ * // Add the platform to the Matterbridge environment
+ * addMatterbridgePlatform(platform);
+ * ```
+ */
+export declare function addMatterbridgePlatform(platform: MatterbridgePlatform, name?: string): void;
+/**
+ * Stop the matterbridge environment
+ *
+ * @example
+ * ```typescript
+ * // Destroy Matterbridge environment
+ * await stopMatterbridgeEnvironment();
+ * await destroyMatterbridgeEnvironment();
+ * ```
+ */
+export declare function stopMatterbridgeEnvironment(): Promise<void>;
+/**
+ * Destroy the matterbridge environment
+ *
+ * @param {number} cleanupPause The timeout for the destroy operation (default 250ms).
+ * @param {number} destroyPause The pause duration after cleanup before destroying the instance (default 250ms).
+ *
+ * @example
+ * ```typescript
+ * // Destroy Matterbridge environment
+ * await stopMatterbridgeEnvironment();
+ * await destroyMatterbridgeEnvironment();
+ * ```
+ */
+export declare function destroyMatterbridgeEnvironment(cleanupPause?: number, destroyPause?: number): Promise<void>;
+/**
+ * Destroy a matterbridge instance
+ *
+ * @param {Matterbridge} matterbridge The matterbridge instance to destroy.
+ * @param {number} cleanupPause The pause duration to wait for the cleanup to complete in milliseconds (default 10ms).
+ * @param {number} destroyPause The pause duration to wait after cleanup before destroying the instance in milliseconds (default 250ms).
+ */
+export declare function destroyInstance(matterbridge: Matterbridge, cleanupPause?: number, destroyPause?: number): Promise<void>;
+/**
+ * Close the mDNS instance in the matterbridge environment.
+ *
+ * @param {Matterbridge} matterbridge The matterbridge instance.
+ * @returns {Promise<void>} A promise that resolves when the mDNS instance is closed.
+ */
+export declare function closeMdnsInstance(matterbridge: Matterbridge): Promise<void>;
+/**
+ * Create a matter Environment for testing:
+ * - it will remove any existing home directory
+ * - setup the matter environment with name, debug logging and ANSI format
+ *
+ * @param {string} name - Name for the environment (jest/name).
+ * @returns {Environment} - The default matter environment.
+ */
+export declare function createTestEnvironment(name: string): Environment;
+/**
+ * Advance the Node.js event loop deterministically to allow chained asynchronous work (Promises scheduled in
+ * microtasks and follow‑up macrotasks) to complete inside tests without adding arbitrary long timeouts.
+ *
+ * NOTE: This does not guarantee OS level network IO completion—only JavaScript task queue progression inside the
+ *       current process.
+ *
+ * @param {number} ticks       Number of macrotask (setImmediate) turns to yield (default 3).
+ * @param {number} microTurns  Number of microtask drains (Promise.resolve chains) after macrotask yielding (default 10).
+ * @param {number} pause       Final timer delay in ms; set 0 to disable (default 250ms).
+ * @returns {Promise<void>}        Resolves after the requested event loop advancement has completed.
+ */
+export declare function flushAsync(ticks?: number, microTurns?: number, pause?: number): Promise<void>;
+/**
+ * Flush (await) the lazy endpoint number persistence mechanism used by matter.js.
+ *
+ * Background:
+ *  assignNumber() batches persistence (store.saveNumber + updating __nextNumber__) via an internal promise (#numbersPersisted).
+ *  Calling endpointStores.close() waits for the current batch only. If new endpoints were added in the same macrotask
+ *  cycle additional micro/macro turns might be needed to ensure the batch started. We defensively yield macrotasks
+ *  (setImmediate) and then await close() multiple rounds.
+ *
+ * @param {ServerNode} targetServer  The server whose endpoint numbering persistence should be flushed.
+ * @param {number} rounds Number of macrotask + close cycles to run (2 is usually sufficient; 1 often works).
+ * @returns {Promise<void>}          Resolves when pending number persistence batches have completed.
+ */
+export declare function flushAllEndpointNumberPersistence(targetServer: ServerNode, rounds?: number): Promise<void>;
+/**
+ * Assert that every endpoint attached to the server has an assigned and (batch-)persisted endpoint number.
+ *
+ * This waits for any outstanding number persistence batch (endpointStores.close()), then traverses the endpoint
+ * graph and asserts:
+ *  - Root endpoint: number is 0 (allowing undefined to coerce to 0 via nullish coalescing check).
+ *  - All other endpoints: number > 0.
+ *
+ * @param {ServerNode} targetServer The server whose endpoint numbers are verified.
+ * @returns {Promise<void>}         Resolves when assertions complete.
+ */
+export declare function assertAllEndpointNumbersPersisted(targetServer: ServerNode): Promise<number>;
+/**
+ * Start a matter server node for testing.
+ *
+ * @param {string} name Name of the server (used for logging and product description).
+ * @param {number} port TCP port to listen on.
+ * @param {DeviceTypeId} deviceType Device type identifier for the server node.
+ * @returns {Promise<[ServerNode<ServerNode.RootEndpoint>, Endpoint<AggregatorEndpoint>]>} Resolves to an array containing the created ServerNode and its AggregatorNode.
+ */
+export declare function startServerNode(name: string, port: number, deviceType?: DeviceTypeId): Promise<[ServerNode<ServerNode.RootEndpoint>, Endpoint<AggregatorEndpoint>]>;
+/**
+ * Stop a matter server node.
+ *
+ * @param {ServerNode<ServerNode.RootEndpoint>} server The server to stop.
+ * @returns {Promise<void>} Resolves when the server has stopped.
+ */
+export declare function stopServerNode(server: ServerNode<ServerNode.RootEndpoint>): Promise<void>;
+/**
+ * Add a device (endpoint) to a matter server node or an aggregator.
+ *
+ * @param {ServerNode<ServerNode.RootEndpoint> | Endpoint<AggregatorEndpoint>} owner The server or aggregator to add the device to.
+ * @param {Endpoint} device The device to add.
+ * @param {number} pause The pause time in milliseconds after addition (default 10ms).
+ * @returns {Promise<void>} Resolves when the device has been added and is ready.
+ */
+export declare function addDevice(owner: ServerNode<ServerNode.RootEndpoint> | Endpoint<AggregatorEndpoint>, device: Endpoint, pause?: number): Promise<boolean>;
+/**
+ * Delete a device (endpoint) from a matter server node or an aggregator.
+ *
+ * @param {ServerNode<ServerNode.RootEndpoint> | Endpoint<AggregatorEndpoint>} owner The server or aggregator to remove the device from.
+ * @param {Endpoint} device The device to remove.
+ * @param {number} pause The pause time in milliseconds after deletion (default 10ms).
+ * @returns {Promise<void>} Resolves when the device has been removed and is no longer ready.
+ */
+export declare function deleteDevice(owner: ServerNode<ServerNode.RootEndpoint> | Endpoint<AggregatorEndpoint>, device: Endpoint, pause?: number): Promise<boolean>;
+//# sourceMappingURL=jestHelpers.d.ts.map

package/dist/jestutils/jestHelpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jestHelpers.d.ts","sourceRoot":"","sources":["../../src/jestutils/jestHelpers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAMH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAE1C,OAAO,EAAE,UAAU,EAAqC,MAAM,kBAAkB,CAAC;AACjF,OAAO,EAA4D,WAAW,EAAa,MAAM,iBAAiB,CAAC;AACnH,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAmB,MAAM,cAAc,CAAC;AACrE,OAAO,EAAE,YAAY,EAAY,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAG5D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAWlE,eAAO,IAAI,YAAY,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;AAC7E,eAAO,IAAI,cAAc,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AACjF,eAAO,IAAI,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AAC/E,eAAO,IAAI,eAAe,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AACnF,eAAO,IAAI,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AAC/E,eAAO,IAAI,cAAc,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AACjF,eAAO,IAAI,cAAc,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AAEjF,eAAO,IAAI,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;AACjE,eAAO,IAAI,eAAe,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;AACnE,eAAO,IAAI,cAAc,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;AAClE,eAAO,IAAI,cAAc,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;AAClE,eAAO,IAAI,eAAe,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;AAEnE,eAAO,IAAI,qBAAqB,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,YAAY,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;AACvG,eAAO,IAAI,wBAAwB,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,YAAY,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;AAC7G,eAAO,IAAI,4BAA4B,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,YAAY,CAAC,SAAS,CAAC,yBAAyB,CAAC,CAAC;AAErH,eAAO,IAAI,YAAY,EAAE,YAAY,CAAC;AACtC,eAAO,IAAI,WAAW,EAAE,WAAW,CAAC;AACpC,eAAO,IAAI,MAAM,EAAE,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;AACvD,eAAO,IAAI,UAAU,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;AACpD,eAAO,IAAI,GAAG,EAAE,UAAU,CAAC;AAE3B;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAiCnF;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAuB5D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,6BAA6B,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAuBvF;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,4BAA4B,CAAC,IAAI,GAAE,MAAa,GAAG,OAAO,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAkDpJ;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,oBAAoB,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAsB3F;AAED;;;;;;;;;GASG;AACH,wBAAsB,2BAA2B,IAAI,OAAO,CAAC,IAAI,CAAC,CA8BjE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,8BAA8B,CAAC,YAAY,GAAE,MAAW,EAAE,YAAY,GAAE,MAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAUzH;AAED;;;;;;GAMG;AACH,wBAAsB,eAAe,CAAC,YAAY,EAAE,YAAY,EAAE,YAAY,GAAE,MAAW,EAAE,YAAY,GAAE,MAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAOtI;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAMjF;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAoB/D;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,UAAU,CAAC,KAAK,GAAE,MAAU,EAAE,UAAU,GAAE,MAAW,EAAE,KAAK,GAAE,MAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAI/G;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,iCAAiC,CAAC,YAAY,EAAE,UAAU,EAAE,MAAM,GAAE,MAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAMnH;AAsBD;;;;;;;;;;GAUG;AACH,wBAAsB,iCAAiC,CAAC,YAAY,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAcjG;AAED;;;;;;;GAOG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,GAAE,YAA0B,GAAG,OAAO,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAuFtL;AAED;;;;;GAKG;AACH,wBAAsB,cAAc,CAAC,MAAM,EAAE,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAuB/F;AAED;;;;;;;GAOG;AACH,wBAAsB,SAAS,CAAC,KAAK,EAAE,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC,GAAG,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,GAAE,MAAW,GAAG,OAAO,CAAC,OAAO,CAAC,CAyBjK;AAED;;;;;;;GAOG;AACH,wBAAsB,YAAY,CAAC,KAAK,EAAE,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC,GAAG,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,GAAE,MAAW,GAAG,OAAO,CAAC,OAAO,CAAC,CAyBpK"}