@switchbot/homebridge-switchbot 5.0.0-beta.99 → 5.0.0

package/dist/utils.d.ts

@@ -1,5 +1,44 @@
-import type { PlatformConfig } from 'homebridge';
 import type { SwitchBotPluginConfig } from './settings.js';
+import type { Logger, PlatformConfig } from 'homebridge';
+/**
+ * Indicates which device types should prefer Matter if available.
+ * Based on HAP service mappings: device implementations use specific HomeKit services
+ * that map to corresponding Matter clusters when Matter is enabled.
+ *
+ * @property {boolean} [deviceType] - True if the device type supports Matter, false otherwise.
+ * @example
+ * DEVICE_MATTER_SUPPORTED['bot'] // true
+ */
+/**
+ * Factory function to create Matter handlers with Homebridge logger integration.
+ * Returns handler objects for supported device types, mapping Matter cluster actions to SwitchBot API calls.
+ *
+ * @param log - Homebridge logger instance
+ * @param deviceId - SwitchBot device ID
+ * @param type - Device type string
+ * @param client - SwitchBot client instance
+ * @returns Handler object for Matter clusters
+ */
+export declare const DEVICE_MATTER_SUPPORTED: Record<string, boolean>;
+/**
+ * Default Matter cluster configurations by device type.
+ * Maps device types to their Matter cluster states (used when device doesn't provide clusters).
+ * Note: wosweeper/curtain/plug variants are normalized before cluster lookup (see loadDevices).
+ *
+ * @property {object} [deviceType] - The default cluster state for the device type.
+ * @example
+ * DEVICE_MATTER_CLUSTERS['bot'] // { onOff: { onOff: false } }
+ */
+export declare const DEVICE_MATTER_CLUSTERS: Record<string, any>;
+export declare function createMatterHandlers(log: Logger, deviceId: string, type: string, client: any): any;
+export declare function resolveMatterDeviceType(matterApi: any, type: string, createdDeviceType?: any, clusters?: any): any;
+/**
+ * Canonical Matter cluster ID mapping (from matter.js clusters).
+ * Maps cluster names to their numeric cluster IDs.
+ *
+ * @example
+ * MATTER_CLUSTER_IDS.OnOff // 0x0006
+ */
 export declare const MATTER_CLUSTER_IDS: {
     readonly OnOff: 6;
     readonly LevelControl: 8;
@@ -9,6 +48,13 @@ export declare const MATTER_CLUSTER_IDS: {
     readonly FanControl: 514;
     readonly RelativeHumidityMeasurement: 1029;
 };
+/**
+ * Common Matter attribute IDs grouped by cluster.
+ * Maps cluster names to objects mapping attribute names to their numeric attribute IDs.
+ *
+ * @example
+ * MATTER_ATTRIBUTE_IDS.OnOff.OnOff // 0x0000
+ */
 export declare const MATTER_ATTRIBUTE_IDS: {
     readonly OnOff: {
         readonly OnOff: 0;
@@ -35,6 +81,35 @@ export declare const MATTER_ATTRIBUTE_IDS: {
         readonly MeasuredValue: 0;
     };
 };
+/**
+ * Normalizes a device type string for Matter integration.
+ * Maps various device type aliases and variants to canonical Matter device types.
+ *
+ * @param {string | undefined | null} typeValue - The device type string to normalize.
+ * @returns {string} The normalized device type string for Matter.
+ *
+ * @example
+ * normalizeTypeForMatter('wosweeper') // 'vacuum'
+ * normalizeTypeForMatter('curtain3') // 'curtain'
+ * normalizeTypeForMatter('plug mini (us)') // 'plug'
+ */
+export declare function normalizeTypeForMatter(typeValue: string | undefined | null): string;
+/**
+ * Normalizes a Homebridge PlatformConfig object to a SwitchBotPluginConfig.
+ *
+ * @param raw The raw Homebridge platform config object.
+ * @returns The normalized plugin config object.
+ */
 export declare function normalizeConfig(raw?: PlatformConfig): SwitchBotPluginConfig;
+/**
+ * Creates a proxy class that instantiates the correct platform implementation (HAP or Matter) at runtime.
+ *
+ * @param HAPPlatform The HAP platform class constructor.
+ * @param MatterPlatform The Matter platform class constructor.
+ * @returns A proxy class that delegates to the correct platform implementation.
+ *
+ * @class SwitchBotPlatformProxy
+ * @property impl The instantiated platform implementation (HAP or Matter).
+ */
 export declare function createPlatformProxy(HAPPlatform: any, MatterPlatform: any): any;
 //# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAChD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAA;AAG1D,eAAO,MAAM,kBAAkB;;;;;;;;CAQrB,CAAA;AAGV,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;CAQvB,CAAA;AAEV,wBAAgB,eAAe,CAAC,GAAG,CAAC,EAAE,cAAc,GAAG,qBAAqB,CAG3E;AAGD,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,GAAG,EAAE,cAAc,EAAE,GAAG,GAAG,GAAG,CAkB9E"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAA;AAC1D,OAAO,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AACxD;;;;;;;;GAQG;AACH;;;;;;;;;GASG;AAEH,eAAO,MAAM,uBAAuB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAoD3D,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,sBAAsB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CA2KtD,CAAA;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,GAAG,CA2rBlG;AA+BD,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,iBAAiB,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,GAAG,GAAG,GAAG,CAelH;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;CAQrB,CAAA;AAEV;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;CAQvB,CAAA;AAEV;;;;;;;;;;;GAWG;AACH,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,GAAG,MAAM,CAyEnF;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,GAAG,CAAC,EAAE,cAAc,GAAG,qBAAqB,CAK3E;AAGD;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,GAAG,EAAE,cAAc,EAAE,GAAG,GAAG,GAAG,CA2B9E"}