docs: update typed documentation and API report

zwave-js · Nov 14, 2024 · 115ad99 · 115ad99
1 parent cecd3b7
commit 115ad99
Show file tree

Hide file tree

Showing 10 changed files with 1,682 additions and 670 deletions.
diff --git a/docs/api/controller.md b/docs/api/controller.md
@@ -1176,6 +1176,16 @@ interface GetFirmwareUpdatesOptions {
 	additionalUserAgentComponents?: Record<string, string>;
 	/** Whether the returned firmware upgrades should include prereleases from the `"beta"` channel. Default: `false`. */
 	includePrereleases?: boolean;
+	/**
+	 * Can be used to specify the RF region if the Z-Wave controller
+	 * does not support querying this information.
+	 *
+	 * **WARNING:** Specifying the wrong region may result in bricking the device!
+	 *
+	 * For this reason, the specified value is only used as a fallback
+	 * if the RF region of the controller is not already known.
+	 */
+	rfRegion?: RFRegion;
 }
 ```
 

diff --git a/docs/api/driver.md b/docs/api/driver.md
@@ -415,9 +415,7 @@ interface FileSystem {
 		file: string,
 		data: string | Uint8Array,
 		options?:
-			| {
-				encoding: BufferEncoding;
-			}
+			| { encoding: BufferEncoding }
 			| BufferEncoding,
 	): Promise<void>;
 	readFile(file: string, encoding: BufferEncoding): Promise<string>;

diff --git a/packages/cc/cc.api.md b/packages/cc/cc.api.md
diff --git a/packages/config/config.api.md b/packages/config/config.api.md
@@ -475,7 +475,7 @@ export class DeviceConfig {
         deviceId?: DeviceID;
     }): Promise<DeviceConfig>;
     getAssociationConfigForEndpoint(endpointIndex: number, group: number): AssociationConfig | undefined;
-    getHash(): Uint8Array;
+    getHash(algorithm?: "md5" | "sha-256"): Promise<Uint8Array>;
     readonly isEmbedded: boolean;
     // (undocumented)
     readonly label: string;
@@ -617,7 +617,7 @@ export type ManufacturersMap = Map<number, string>;
 // Warning: (ae-missing-release-tag) "PACKAGE_VERSION" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-export const PACKAGE_VERSION = "14.0.0";
+export const PACKAGE_VERSION = "14.3.3";
 
 // Warning: (ae-missing-release-tag) "ParamInfoMap" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //

diff --git a/packages/core/core.api.md b/packages/core/core.api.md
diff --git a/packages/host/host.api.md b/packages/host/host.api.md
@@ -76,22 +76,6 @@ export function createTestingHost(options?: Partial<CreateTestingHostOptions>):
 export interface CreateTestingHostOptions extends HostIDs, GetDeviceConfig {
 }
 
-// Warning: (ae-missing-release-tag) "FileSystem" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public
-export interface FileSystem {
-    // (undocumented)
-    ensureDir(path: string): Promise<void>;
-    // (undocumented)
-    pathExists(path: string): Promise<boolean>;
-    // (undocumented)
-    readFile(file: string, encoding: BufferEncoding): Promise<string>;
-    // (undocumented)
-    writeFile(file: string, data: string | Uint8Array, options?: {
-        encoding: BufferEncoding;
-    } | BufferEncoding): Promise<void>;
-}
-
 // Warning: (ae-missing-release-tag) "GetAllNodes" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public