homey-lib 2.45.4 → 2.46.1

package/lib/Util/zigbee.js

@@ -0,0 +1,225 @@
+'use strict';
+
+const fs = require('fs');
+
+const OTA_FILE_IDENTIFIER = 0x0BEEF11E;
+const OTA_HEADER_VERSION = 0x0100;
+const OTA_MIN_HEADER_LENGTH = 56;
+
+const FIELD_CONTROL_BITS = {
+  securityCredentialVersion: 1 << 0,
+  deviceSpecificFile: 1 << 1,
+  hardwareVersionsPresent: 1 << 2,
+};
+
+/**
+ * @typedef {object} ZigbeeOTAHeader
+ * @property {number} fileSize - File size in bytes.
+ * @property {number} fileIdentifier - OTA file identifier.
+ * @property {number} headerVersion - OTA header version.
+ * @property {number} headerLength - OTA header length in bytes.
+ * @property {number} fieldControl - Field control bitmask.
+ * @property {number} manufacturerCode - Manufacturer code.
+ * @property {number} imageType - Image type.
+ * @property {number} fileVersion - File version.
+ * @property {number} zigbeeStackVersion - Zigbee stack version.
+ * @property {string} headerString - Header string (ASCII).
+ * @property {number} totalImageSize - Total image size in bytes.
+ * @property {number} [securityCredentialVersion] - Security credential version.
+ * @property {string} [upgradeFileDestination] - Destination EUI64 hex string.
+ * @property {number} [minimumHardwareVersion] - Minimum hardware version.
+ * @property {number} [maximumHardwareVersion] - Maximum hardware version.
+ * @property {number} remainingHeaderBytes - Unparsed header bytes.
+ */
+
+/**
+ * Read a fixed-length slice from the start of a file.
+ * @param {string} filePath - Absolute or relative path to the OTA file.
+ * @param {number} length - Number of bytes to read.
+ * @returns {Promise<Buffer>} Buffer with the requested bytes.
+ */
+async function readFileSlice(filePath, length) {
+  const fileHandle = await fs.promises.open(filePath, 'r');
+  try {
+    const buffer = Buffer.alloc(length);
+    const { bytesRead } = await fileHandle.read(buffer, 0, length, 0);
+    if (bytesRead < length) {
+      throw new Error('Unexpected end of file while reading Zigbee OTA header');
+    }
+    return buffer;
+  } finally {
+    await fileHandle.close();
+  }
+}
+
+/**
+ * Parse the Zigbee OTA header from a file.
+ * @param {string} filePath - Absolute or relative path to the OTA file.
+ * @returns {Promise<ZigbeeOTAHeader>} Parsed header values.
+ */
+async function parseZigbeeOTAHeader(filePath) {
+  if (typeof filePath !== 'string' || filePath.length === 0) {
+    throw new TypeError('filePath must be a non-empty string');
+  }
+
+  const stats = await fs.promises.stat(filePath);
+  if (stats.size < OTA_MIN_HEADER_LENGTH) {
+    throw new Error('File is too small to contain a Zigbee OTA header');
+  }
+
+  const baseHeader = await readFileSlice(filePath, OTA_MIN_HEADER_LENGTH);
+  const baseFileIdentifier = baseHeader.readUInt32LE(0);
+
+  if (baseFileIdentifier !== OTA_FILE_IDENTIFIER) {
+    throw new Error('Invalid Zigbee OTA header identifier');
+  }
+
+  const headerLength = baseHeader.readUInt16LE(6);
+
+  if (headerLength < OTA_MIN_HEADER_LENGTH) {
+    throw new Error('Zigbee OTA header length is shorter than the mandatory header size');
+  }
+  if (headerLength > stats.size) {
+    throw new Error('Zigbee OTA header length exceeds file size');
+  }
+
+  const headerBuffer = headerLength === OTA_MIN_HEADER_LENGTH
+    ? baseHeader
+    : await readFileSlice(filePath, headerLength);
+
+  let offset = 0;
+  const fileIdentifier = headerBuffer.readUInt32LE(offset);
+  offset += 4;
+  if (fileIdentifier !== OTA_FILE_IDENTIFIER) {
+    throw new Error('Invalid Zigbee OTA header identifier');
+  }
+  const headerVersion = headerBuffer.readUInt16LE(offset);
+  offset += 2;
+  const parsedHeaderLength = headerBuffer.readUInt16LE(offset);
+  offset += 2;
+  const fieldControl = headerBuffer.readUInt16LE(offset);
+  offset += 2;
+  const manufacturerCode = headerBuffer.readUInt16LE(offset);
+  offset += 2;
+  const imageType = headerBuffer.readUInt16LE(offset);
+  offset += 2;
+  const fileVersion = headerBuffer.readUInt32LE(offset);
+  offset += 4;
+  const zigbeeStackVersion = headerBuffer.readUInt16LE(offset);
+  offset += 2;
+  const headerString = headerBuffer
+    .toString('ascii', offset, offset + 32)
+    .replace(/\0+$/, '');
+  offset += 32;
+  const totalImageSize = headerBuffer.readUInt32LE(offset);
+  offset += 4;
+
+  const header = {
+    fileSize: stats.size,
+    fileIdentifier,
+    headerVersion,
+    headerLength: parsedHeaderLength,
+    fieldControl,
+    manufacturerCode,
+    imageType,
+    fileVersion,
+    zigbeeStackVersion,
+    headerString,
+    totalImageSize,
+  };
+
+  if (fieldControl & FIELD_CONTROL_BITS.securityCredentialVersion) {
+    header.securityCredentialVersion = headerBuffer.readUInt8(offset);
+    offset += 1;
+  }
+
+  if (fieldControl & FIELD_CONTROL_BITS.deviceSpecificFile) {
+    header.upgradeFileDestination = headerBuffer
+      .slice(offset, offset + 8)
+      .toString('hex');
+    offset += 8;
+  }
+
+  if (fieldControl & FIELD_CONTROL_BITS.hardwareVersionsPresent) {
+    header.minimumHardwareVersion = headerBuffer.readUInt16LE(offset);
+    offset += 2;
+    header.maximumHardwareVersion = headerBuffer.readUInt16LE(offset);
+    offset += 2;
+  }
+
+  if (parsedHeaderLength < offset) {
+    throw new Error('Zigbee OTA header length is shorter than parsed fields');
+  }
+
+  header.remainingHeaderBytes = parsedHeaderLength - offset;
+
+  return header;
+}
+
+/**
+ * Validate a Zigbee OTA header against expected values.
+ * @param {object} options - Validation options.
+ * @param {string} options.filePath - Absolute or relative path to the OTA file.
+ * @param {number} [options.manufacturerCode] - Expected manufacturer code.
+ * @param {number} [options.fileVersion] - Expected file version.
+ * @param {number} [options.imageType] - Expected image type.
+ * @returns {Promise<ZigbeeOTAHeader>} Parsed header values.
+ */
+async function validateZigbeeOTAHeader({
+  filePath,
+  manufacturerCode,
+  fileVersion,
+  imageType,
+} = {}) {
+  const header = await parseZigbeeOTAHeader(filePath);
+
+  if (header.fileIdentifier !== OTA_FILE_IDENTIFIER) {
+    throw new Error('Invalid Zigbee OTA header identifier');
+  }
+
+  if (header.headerVersion !== OTA_HEADER_VERSION) {
+    throw new Error('Unsupported Zigbee OTA header version');
+  }
+
+  if (header.headerLength > header.totalImageSize) {
+    throw new Error('Zigbee OTA header length exceeds total image size');
+  }
+
+  if (header.totalImageSize !== header.fileSize) {
+    throw new Error('Zigbee OTA total image size does not match file size');
+  }
+
+  if (manufacturerCode !== undefined) {
+    if (typeof manufacturerCode !== 'number') {
+      throw new TypeError('manufacturerCode must be a number');
+    }
+    if (header.manufacturerCode !== manufacturerCode) {
+      throw new Error('Zigbee OTA manufacturer code does not match');
+    }
+  }
+
+  if (imageType !== undefined) {
+    if (typeof imageType !== 'number') {
+      throw new TypeError('imageType must be a number');
+    }
+    if (header.imageType !== imageType) {
+      throw new Error('Zigbee OTA image type does not match');
+    }
+  }
+
+  if (fileVersion !== undefined) {
+    if (typeof fileVersion !== 'number') {
+      throw new TypeError('fileVersion must be a number');
+    }
+    if (header.fileVersion !== fileVersion) {
+      throw new Error('Zigbee OTA file version does not match');
+    }
+  }
+
+  return header;
+}
+
+module.exports = {
+  parseZigbeeOTAHeader,
+  validateZigbeeOTAHeader,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homey-lib",
-  "version": "2.45.4",
+  "version": "2.46.1",
   "description": "Shared Library for Homey",
   "types": "types/index.d.ts",
   "main": "index.js",

package/types/assets/app/schema.d.ts

@@ -80,6 +80,7 @@ export type DriverSettings = (
       [k: string]: unknown;
     }
 )[];
+export type Integrity = string;
 export type AppSettings = (
   | {
       type: "text" | "password" | "textarea" | "label";
@@ -247,6 +248,7 @@ export interface App {
       [k: string]: unknown;
     }[];
     settings?: DriverSettings;
+    firmwareUpdates?: ZigbeeFirmwareUpdates;
     gtin?: string | string[];
     matter?: MatterDevice;
     zwave?: ZwaveDevice;
@@ -373,6 +375,43 @@ export interface ZwaveSetting {
   signed?: boolean;
   [k: string]: unknown;
 }
+export interface ZigbeeFirmwareUpdates {
+  queryNextImageTimeout?: number;
+  minImageBlockPeriod?: number;
+  maxImageBlockSize?: number;
+  imageBlockRequestTimeout?: number;
+  upgradeEndRequestTimeout?: number;
+  upgradeEndDelay?: number;
+  postUpgradeAnnounceTimeout?: number;
+  /**
+   * @minItems 1
+   */
+  updates: [ZigbeeFirmwareUpdate, ...ZigbeeFirmwareUpdate[]];
+}
+export interface ZigbeeFirmwareUpdate {
+  changelog: I18NObject;
+  device: ZigbeeFirmwareUpdateDevice;
+  /**
+   * @minItems 1
+   */
+  files: [ZigbeeFirmwareUpdateFile, ...ZigbeeFirmwareUpdateFile[]];
+}
+export interface ZigbeeFirmwareUpdateDevice {
+  manufacturerName: string | string[];
+  productId: string | string[];
+}
+export interface ZigbeeFirmwareUpdateFile {
+  fileVersion: number;
+  imageType: number;
+  manufacturerCode: number;
+  minFileVersion?: number;
+  maxFileVersion?: number;
+  minHardwareVersion?: number;
+  maxHardwareVersion?: number;
+  size: number;
+  name: string;
+  integrity: Integrity;
+}
 export interface MatterDevice {
   vendorId: number | number[];
   productId: number | number[];

package/types/helpers/index.d.ts

@@ -7,5 +7,6 @@ export const readDirAsync: typeof fs.readdir.__promisify__;
 export const lstatAsync: typeof fs.lstat.__promisify__;
 export const imageSizeAsync: Function;
 import fs = require("fs");
+export function toArray(value: any): any[];
 export { join, extname, basename, dirname };
 //# sourceMappingURL=index.d.ts.map

package/types/helpers/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../helpers/index.js"],"names":[],"mappings":"wBAWe,4BAA4B;yBAE5B,6BAA6B;wBAE7B,4BAA4B;wBAE5B,4BAA4B;4BAE5B,gCAAgC;2BAEhC,+BAA+B;yBAE/B,6BAA6B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../helpers/index.js"],"names":[],"mappings":"wBAWe,4BAA4B;yBAE5B,6BAA6B;wBAE7B,4BAA4B;wBAE5B,4BAA4B;4BAE5B,gCAAgC;2BAEhC,+BAA+B;yBAE/B,6BAA6B;;;AAkB5C,2CAMC"}

package/types/index.d.ts

@@ -12,6 +12,7 @@ export const getCurrencies: typeof Energy.getCurrencies;
 export const getBatteries: typeof Energy.getBatteries;
 export type AppManifest = import("./assets/app/schema").App;
 export type CapabilityDefinition = import("./assets/capability/schema").Capability;
+export type ZigbeeFirmwareUpdates = import("./assets/app/schema").ZigbeeFirmwareUpdates;
 import App = require("./lib/App");
 import Capability = require("./lib/Capability");
 import Device = require("./lib/Device");

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.js"],"names":[],"mappings":"+BAkBW,OAAO,MAAM,CAAC,UAAU;6BAExB,OAAO,MAAM,CAAC,QAAQ;8BAGtB,OAAO,UAAU,CAAC,eAAe;4BAEjC,OAAO,UAAU,CAAC,aAAa;4BAE/B,OAAO,UAAU,CAAC,aAAa;4BAG/B,OAAO,GAAG,CAAC,UAAU;+BAErB,OAAO,GAAG,CAAC,aAAa;gCAExB,OAAO,GAAG,CAAC,cAAc;+BAEzB,OAAO,GAAG,CAAC,aAAa;6BAGxB,OAAO,KAAK,CAAC,SAAS;4BAGtB,OAAO,MAAM,CAAC,aAAa;2BAE3B,OAAO,MAAM,CAAC,YAAY;0BAGvB,OAAO,qBAAqB,EAAE,GAAG;mCACjC,OAAO,4BAA4B,EAAE,UAAU"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.js"],"names":[],"mappings":"+BAkBW,OAAO,MAAM,CAAC,UAAU;6BAExB,OAAO,MAAM,CAAC,QAAQ;8BAGtB,OAAO,UAAU,CAAC,eAAe;4BAEjC,OAAO,UAAU,CAAC,aAAa;4BAE/B,OAAO,UAAU,CAAC,aAAa;4BAG/B,OAAO,GAAG,CAAC,UAAU;+BAErB,OAAO,GAAG,CAAC,aAAa;gCAExB,OAAO,GAAG,CAAC,cAAc;+BAEzB,OAAO,GAAG,CAAC,aAAa;6BAGxB,OAAO,KAAK,CAAC,SAAS;4BAGtB,OAAO,MAAM,CAAC,aAAa;2BAE3B,OAAO,MAAM,CAAC,YAAY;0BAGvB,OAAO,qBAAqB,EAAE,GAAG;mCACjC,OAAO,4BAA4B,EAAE,UAAU;oCAC/C,OAAO,qBAAqB,EAAE,qBAAqB"}

package/types/lib/App/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/App/index.js"],"names":[],"mappings":";AA4EA;IACE,2CAAqD;IACrD,2CAAmD;IAotBnD;;;OAGG;IACH,sCAHW,WAAW,GACT,IAAI,CAOhB;IA4PD;;;;;OAKG;IACH,4CALW,MAAM,QACN;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,aAClB,MAAM,GACJ,IAAI,CAkChB;IAiBD;;;OAGG;IACH,wBAHW,MAAM,GACJ,OAAO,CAQnB;IAED;;;OAGG;IACH,gCAHW,MAAM,GACJ,OAAO,CAInB;IAED;;OAEG;IACH,wBAFa,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAMnC;IAED;;OAEG;IACH,yBAFa,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAcnD;IAED;;OAEG;IACH,wBAFa,MAAM,EAAE,CAIpB;IAED;;OAEG;IACH,qBAFa,MAAM,EAAE,CAKpB;IAED;;;OAGG;IACH,4BAHW,MAAM,GACJ,MAAM,CAuBlB;IAED;;;;OAIG;IACH,0BAJW,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,SAAS,WAC1C,WAAW,GACT,MAAM,GAAG,IAAI,CAyDzB;IAlqCD;;OAEG;IACH,kBAFW,MAAM,EAQhB;IALC,cAAiB;IAOnB;;;OAGG;IACH,eAHc,OAAO,EAAA,GACR,IAAI,CAKhB;IAED;;;OAGG;IACH,6BAHW;QAAE,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,UAAU,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAC3D,OAAO,CAAC,IAAI,CAAC,CA0rBzB;IAprBC,gBAAmB;IAisBrB;;;;OAIG;IACH,uCAJW,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,UACvB;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,GACZ,IAAI,CAwBhB;IAED;;;;OAIG;IACH,8BAJW,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS,WAC1C,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS,GACxC,IAAI,CAuBhB;IAED;;;OAGG;IACH,gCAHW,MAAM,GACJ,OAAO,CAAC,MAAM,EAAE,CAAC,CAY7B;IAED;;;OAGG;IACH,yCAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAOzB;IAED;;;OAGG;IACH,mCAHW,MAAM,GACJ,OAAO,CAAC,OAAO,CAAC,CAe5B;IAED;;;;;OAKG;IACH,2BALW;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,QAChC,KAAK,GAAG,QAAQ,cAChB,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CA6BzB;IAED;;OAEG;IACH,oBAFa,OAAO,CAAC,IAAI,CAAC,CAuBzB;IAED;;;;;;OAMG;IACH,wBANW,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,aACvB,MAAM,WACN,WAAW,mCACX;QAAE,YAAY,EAAE,OAAO,CAAC;QAAC,aAAa,EAAE,OAAO,CAAA;KAAE,GAC/C,IAAI,CA+EhB;IA0CD;;;;OAIG;IACH,qBAJW,MAAM,YACN,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAU3B;CAwJF;;;;mBAptCa,OAAO,yBAAyB,EAAE,GAAG"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/App/index.js"],"names":[],"mappings":";AA8EA;IACE,2CAAqD;IACrD,2CAAmD;IAmyBnD;;;OAGG;IACH,sCAHW,WAAW,GACT,IAAI,CAOhB;IA4PD;;;;;OAKG;IACH,4CALW,MAAM,QACN;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,aAClB,MAAM,GACJ,IAAI,CAkChB;IAiBD;;;OAGG;IACH,wBAHW,MAAM,GACJ,OAAO,CAQnB;IAED;;;OAGG;IACH,gCAHW,MAAM,GACJ,OAAO,CAInB;IAED;;OAEG;IACH,wBAFa,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAMnC;IAED;;OAEG;IACH,yBAFa,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAcnD;IAED;;OAEG;IACH,wBAFa,MAAM,EAAE,CAIpB;IAED;;OAEG;IACH,qBAFa,MAAM,EAAE,CAKpB;IAED;;;OAGG;IACH,4BAHW,MAAM,GACJ,MAAM,CAuBlB;IAED;;;;OAIG;IACH,0BAJW,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,SAAS,WAC1C,WAAW,GACT,MAAM,GAAG,IAAI,CAyDzB;IAjvCD;;OAEG;IACH,kBAFW,MAAM,EAQhB;IALC,cAAiB;IAOnB;;;OAGG;IACH,eAHc,OAAO,EAAA,GACR,IAAI,CAKhB;IAED;;;OAGG;IACH,6BAHW;QAAE,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,UAAU,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAC3D,OAAO,CAAC,IAAI,CAAC,CAywBzB;IAnwBC,gBAAmB;IAgxBrB;;;;OAIG;IACH,uCAJW,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,UACvB;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,GACZ,IAAI,CAwBhB;IAED;;;;OAIG;IACH,8BAJW,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS,WAC1C,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS,GACxC,IAAI,CAuBhB;IAED;;;OAGG;IACH,gCAHW,MAAM,GACJ,OAAO,CAAC,MAAM,EAAE,CAAC,CAY7B;IAED;;;OAGG;IACH,yCAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAOzB;IAED;;;OAGG;IACH,mCAHW,MAAM,GACJ,OAAO,CAAC,OAAO,CAAC,CAe5B;IAED;;;;;OAKG;IACH,2BALW;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,QAChC,KAAK,GAAG,QAAQ,cAChB,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CA6BzB;IAED;;OAEG;IACH,oBAFa,OAAO,CAAC,IAAI,CAAC,CAuBzB;IAED;;;;;;OAMG;IACH,wBANW,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,aACvB,MAAM,WACN,WAAW,mCACX;QAAE,YAAY,EAAE,OAAO,CAAC;QAAC,aAAa,EAAE,OAAO,CAAA;KAAE,GAC/C,IAAI,CA+EhB;IA0CD;;;;OAIG;IACH,qBAJW,MAAM,YACN,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAU3B;CAwJF;;;;mBAnyCa,OAAO,yBAAyB,EAAE,GAAG"}

package/types/lib/Util/file.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Calculate a hex hash for the contents of a file.
+ * @param {string} filePath - Absolute or relative path to the file.
+ * @param {string} [hashName='sha256'] - Hash algorithm name (e.g. sha256).
+ * @returns {Promise<string>} Resolves with a hex-encoded digest.
+ */
+export function hashFile(filePath: string, hashName?: string): Promise<string>;
+/**
+ * Create an integrity string for a file using an allowed hash algorithm.
+ * @param {string} filePath - Absolute or relative path to the file.
+ * @param {string} [hashName='sha256'] - Allowed hash algorithm name.
+ * @returns {Promise<string>} Resolves with `hashName:hexDigest`.
+ */
+export function getIntegrity(filePath: string, hashName?: string): Promise<string>;
+/**
+ * Validate file integrity using a `hashName:hexDigest` string.
+ * @param {string} filePath - Absolute or relative path to the file.
+ * @param {string} integrity - Hash name and hex digest separated by `:`.
+ * @returns {Promise<boolean>} Resolves with true when hashes match.
+ */
+export function validateIntegrity(filePath: string, integrity: string): Promise<boolean>;
+export function getOTAFilePath({ appPath, driverId, fileName }: {
+    appPath: any;
+    driverId: any;
+    fileName: any;
+}): string;
+//# sourceMappingURL=file.d.ts.map

package/types/lib/Util/file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file.d.ts","sourceRoot":"","sources":["../../../lib/Util/file.js"],"names":[],"mappings":"AAkBA;;;;;GAKG;AACH,mCAJW,MAAM,aACN,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAW3B;AAwBD;;;;;GAKG;AACH,uCAJW,MAAM,aACN,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAW3B;AArCD;;;;;GAKG;AACH,4CAJW,MAAM,aACN,MAAM,GACJ,OAAO,CAAC,OAAO,CAAC,CAgB5B;AAmBD;;;;WAEC"}

package/types/lib/Util/index.d.ts

@@ -11,6 +11,59 @@ declare class Util {
      * @returns {string[]}
      */
     static getMissingPlatformLocalFeatures(modelId: string, wantedFeatures: string[]): string[];
+    /**
+     * Create an integrity string for a file using an allowed hash algorithm.
+     * NOTE: This method is only available in Node.js environments.
+     * @param {string} filePath - Absolute or relative path to the file.
+     * @param {string} hashName - Allowed hash algorithm name.
+     * @returns {Promise<string>} Resolves with `hashName:hexDigest`.
+     */
+    static getIntegrity(filePath: string, hashName: string): Promise<string>;
+    /**
+     * Validate file integrity using a `hashName:hexDigest` string.
+     * NOTE: This method is only available in Node.js environments.
+     * @param {string} filePath - Absolute or relative path to the file.
+     * @param {string} integrity - Hash name and hex digest separated by `:`.
+     * @returns {Promise<boolean>} Resolves with true when hashes match.
+     */
+    static validateIntegrity(filePath: string, integrity: string): Promise<boolean>;
+    /**
+     * Parse the Zigbee OTA header from a file.
+     * NOTE: This method is only available in Node.js environments.
+     * @param {string} filePath - Absolute or relative path to the OTA file.
+     * @returns {Promise<import('./zigbee').ZigbeeOTAHeader>} Parsed header values.
+     */
+    static parseZigbeeOTAHeader(filePath: string): Promise<import("./zigbee").ZigbeeOTAHeader>;
+    /**
+     * Validate a Zigbee OTA header against expected values.
+     * NOTE: This method is only available in Node.js environments.
+     * @param {object} options - Validation options.
+     * @param {string} options.filePath - Absolute or relative path to the OTA file.
+     * @param {number} [options.manufacturerCode] - Expected manufacturer code.
+     * @param {number} [options.fileVersion] - Expected file version.
+     * @param {number} [options.imageType] - Expected image type.
+     * @returns {Promise<import('./zigbee').ZigbeeOTAHeader>} Parsed header values.
+     */
+    static validateZigbeeOTAHeader(options: {
+        filePath: string;
+        manufacturerCode?: number;
+        fileVersion?: number;
+        imageType?: number;
+    }): Promise<import("./zigbee").ZigbeeOTAHeader>;
+    /**
+     * Returns the expected file path for an OTA file based on app path, driver ID and file name.
+     * NOTE: This method is only available in Node.js environments.
+     * @param {object} options - File path options.
+     * @param {string} options.appPath - Absolute path to the app.
+     * @param {string} options.driverId - Driver ID.
+     * @param {string} options.fileName - OTA file name.
+     * @returns {string} Resolves with the expected file path.
+     */
+    static getOTAFilePath({ appPath, driverId, fileName }: {
+        appPath: string;
+        driverId: string;
+        fileName: string;
+    }): string;
 }
 declare namespace Util {
     let FEATURE_SPEAKER: string;

package/types/lib/Util/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/Util/index.js"],"names":[],"mappings":";AAEA;IAEE;;;OAGG;IACH,yCAHW,MAAM,GACJ,MAAM,EAAE,CAIpB;IAED;;;;OAIG;IACH,gDAJW,MAAM,kBACN,MAAM,EAAE,GACN,MAAM,EAAE,CAKpB;CAEF;;;;;;;gCAOU,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/Util/index.js"],"names":[],"mappings":";AAKA;IAEE;;;OAGG;IACH,yCAHW,MAAM,GACJ,MAAM,EAAE,CAIpB;IAED;;;;OAIG;IACH,gDAJW,MAAM,kBACN,MAAM,EAAE,GACN,MAAM,EAAE,CAKpB;IAED;;;;;;OAMG;IACH,8BAJW,MAAM,YACN,MAAM,GACJ,OAAO,CAAC,MAAM,CAAC,CAI3B;IAED;;;;;;OAMG;IACH,mCAJW,MAAM,aACN,MAAM,GACJ,OAAO,CAAC,OAAO,CAAC,CAI5B;IAED;;;;;OAKG;IACH,sCAHW,MAAM,GACJ,OAAO,CAAC,OAAO,UAAU,EAAE,eAAe,CAAC,CAIvD;IAED;;;;;;;;;OASG;IACH,wCANG;QAAwB,QAAQ,EAAxB,MAAM;QACW,gBAAgB,GAAjC,MAAM;QACW,WAAW,GAA5B,MAAM;QACW,SAAS,GAA1B,MAAM;KACd,GAAU,OAAO,CAAC,OAAO,UAAU,EAAE,eAAe,CAAC,CAIvD;IAED;;;;;;;;OAQG;IACH,uDALG;QAAwB,OAAO,EAAvB,MAAM;QACU,QAAQ,EAAxB,MAAM;QACU,QAAQ,EAAxB,MAAM;KACd,GAAU,MAAM,CAIlB;CAEF;;;;;;;gCAOU,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC"}

package/types/lib/Util/zigbee.d.ts

@@ -0,0 +1,88 @@
+export type ZigbeeOTAHeader = {
+    /**
+     * - File size in bytes.
+     */
+    fileSize: number;
+    /**
+     * - OTA file identifier.
+     */
+    fileIdentifier: number;
+    /**
+     * - OTA header version.
+     */
+    headerVersion: number;
+    /**
+     * - OTA header length in bytes.
+     */
+    headerLength: number;
+    /**
+     * - Field control bitmask.
+     */
+    fieldControl: number;
+    /**
+     * - Manufacturer code.
+     */
+    manufacturerCode: number;
+    /**
+     * - Image type.
+     */
+    imageType: number;
+    /**
+     * - File version.
+     */
+    fileVersion: number;
+    /**
+     * - Zigbee stack version.
+     */
+    zigbeeStackVersion: number;
+    /**
+     * - Header string (ASCII).
+     */
+    headerString: string;
+    /**
+     * - Total image size in bytes.
+     */
+    totalImageSize: number;
+    /**
+     * - Security credential version.
+     */
+    securityCredentialVersion?: number;
+    /**
+     * - Destination EUI64 hex string.
+     */
+    upgradeFileDestination?: string;
+    /**
+     * - Minimum hardware version.
+     */
+    minimumHardwareVersion?: number;
+    /**
+     * - Maximum hardware version.
+     */
+    maximumHardwareVersion?: number;
+    /**
+     * - Unparsed header bytes.
+     */
+    remainingHeaderBytes: number;
+};
+/**
+ * Parse the Zigbee OTA header from a file.
+ * @param {string} filePath - Absolute or relative path to the OTA file.
+ * @returns {Promise<ZigbeeOTAHeader>} Parsed header values.
+ */
+export function parseZigbeeOTAHeader(filePath: string): Promise<ZigbeeOTAHeader>;
+/**
+ * Validate a Zigbee OTA header against expected values.
+ * @param {object} options - Validation options.
+ * @param {string} options.filePath - Absolute or relative path to the OTA file.
+ * @param {number} [options.manufacturerCode] - Expected manufacturer code.
+ * @param {number} [options.fileVersion] - Expected file version.
+ * @param {number} [options.imageType] - Expected image type.
+ * @returns {Promise<ZigbeeOTAHeader>} Parsed header values.
+ */
+export function validateZigbeeOTAHeader({ filePath, manufacturerCode, fileVersion, imageType, }?: {
+    filePath: string;
+    manufacturerCode?: number;
+    fileVersion?: number;
+    imageType?: number;
+}): Promise<ZigbeeOTAHeader>;
+//# sourceMappingURL=zigbee.d.ts.map

package/types/lib/Util/zigbee.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zigbee.d.ts","sourceRoot":"","sources":["../../../lib/Util/zigbee.js"],"names":[],"mappings":";;;;cAgBc,MAAM;;;;oBACN,MAAM;;;;mBACN,MAAM;;;;kBACN,MAAM;;;;kBACN,MAAM;;;;sBACN,MAAM;;;;eACN,MAAM;;;;iBACN,MAAM;;;;wBACN,MAAM;;;;kBACN,MAAM;;;;oBACN,MAAM;;;;gCACN,MAAM;;;;6BACN,MAAM;;;;6BACN,MAAM;;;;6BACN,MAAM;;;;0BACN,MAAM;;AAuBpB;;;;GAIG;AACH,+CAHW,MAAM,GACJ,OAAO,CAAC,eAAe,CAAC,CAmGpC;AAED;;;;;;;;GAQG;AACH,kGANG;IAAwB,QAAQ,EAAxB,MAAM;IACW,gBAAgB,GAAjC,MAAM;IACW,WAAW,GAA5B,MAAM;IACW,SAAS,GAA1B,MAAM;CACd,GAAU,OAAO,CAAC,eAAe,CAAC,CAsDpC"}