From fce2c260ef0309efdacb5b5574e839cd9c302638 Mon Sep 17 00:00:00 2001
From: Z-Wave JS Bot <76957017+zwave-js-bot@users.noreply.github.com>
Date: Fri, 6 Oct 2023 11:05:12 +0200
Subject: [PATCH] =?UTF-8?q?docs:=20update=20typed=20documentation=20and=20?=
 =?UTF-8?q?API=20report=20=F0=9F=A4=96=20(#6337)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Al Calzone <d.griesel@gmx.net>
---
 packages/config/api.md   |  2 ++
 packages/core/api.md     | 22 +++++++++++++++++++---
 packages/serial/api.md   |  2 +-
 packages/testing/api.md  |  5 +++++
 packages/zwave-js/api.md |  2 ++
 5 files changed, 29 insertions(+), 4 deletions(-)

diff --git a/packages/config/api.md b/packages/config/api.md
index ebd6418eb9bc..3fbf2a3d13e4 100644
--- a/packages/config/api.md
+++ b/packages/config/api.md
@@ -144,6 +144,8 @@ export class ConditionalCompatConfig implements ConditionalItem<CompatConfig> {
     // (undocumented)
     readonly disableBasicMapping?: boolean;
     // (undocumented)
+    readonly disableCallbackFunctionTypeCheck?: number[];
+    // (undocumented)
     readonly disableStrictEntryControlDataValidation?: boolean;
     // (undocumented)
     readonly disableStrictMeasurementValidation?: boolean;
diff --git a/packages/core/api.md b/packages/core/api.md
index 3f4fcb0c3038..ad8008f316be 100644
--- a/packages/core/api.md
+++ b/packages/core/api.md
@@ -1218,17 +1218,25 @@ export function isMessagePriority(val: unknown): val is MessagePriority;
 // Warning: (ae-missing-release-tag) "isMissingControllerACK" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-export function isMissingControllerACK(e: unknown): e is ZWaveError;
+export function isMissingControllerACK(e: unknown): e is ZWaveError & {
+    code: ZWaveErrorCodes.Controller_Timeout;
+    context: "ACK";
+};
 
 // Warning: (ae-missing-release-tag) "isMissingControllerCallback" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-export function isMissingControllerCallback(e: unknown): e is ZWaveError;
+export function isMissingControllerCallback(e: unknown): e is ZWaveError & {
+    code: ZWaveErrorCodes.Controller_Timeout;
+    context: "callback";
+};
 
 // Warning: (ae-missing-release-tag) "isRecoverableZWaveError" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public
-export function isRecoverableZWaveError(e: unknown): e is ZWaveError;
+export function isRecoverableZWaveError(e: unknown): e is ZWaveError & {
+    code: ZWaveErrorCodes.Controller_InterviewRestarted | ZWaveErrorCodes.Controller_NodeRemoved;
+};
 
 // Warning: (ae-missing-release-tag) "isRssiError" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
@@ -2627,6 +2635,14 @@ export enum TransmitStatus {
 // @public
 export function tryParseDSKFromQRCodeString(qr: string): string | undefined;
 
+// Warning: (ae-missing-release-tag) "tryParseParamNumber" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function tryParseParamNumber(str: string): {
+    parameter: number;
+    valueBitMask?: number;
+} | undefined;
+
 // Warning: (ae-missing-release-tag) "TXReport" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public
diff --git a/packages/serial/api.md b/packages/serial/api.md
index e969db92054c..4ac14b6a9282 100644
--- a/packages/serial/api.md
+++ b/packages/serial/api.md
@@ -467,7 +467,7 @@ export class Message {
     getResponseTimeout(): number | undefined;
     hasCallbackId(): boolean;
     // (undocumented)
-    protected host: ZWaveHost;
+    readonly host: ZWaveHost;
     static isComplete(data?: Buffer): boolean;
     isExpectedCallback(msg: Message): boolean;
     isExpectedNodeUpdate(msg: Message): boolean;
diff --git a/packages/testing/api.md b/packages/testing/api.md
index e53f35fde54d..eb2efdf05a43 100644
--- a/packages/testing/api.md
+++ b/packages/testing/api.md
@@ -101,6 +101,11 @@ export interface EnergyProductionCCCapabilities {
     };
 }
 
+// Warning: (ae-missing-release-tag) "getDefaultSupportedFunctionTypes" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function getDefaultSupportedFunctionTypes(): FunctionType[];
+
 // Warning: (ae-missing-release-tag) "LazyMockZWaveFrame" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
diff --git a/packages/zwave-js/api.md b/packages/zwave-js/api.md
index 97e01f528341..184cba7c2e15 100644
--- a/packages/zwave-js/api.md
+++ b/packages/zwave-js/api.md
@@ -1658,6 +1658,7 @@ export interface ZWaveOptions extends ZWaveHostOptions {
     attempts: {
         controller: number;
         sendData: number;
+        sendDataJammed: number;
         nodeInterview: number;
     };
     disableOptimisticValueUpdate?: boolean;
@@ -1710,6 +1711,7 @@ export interface ZWaveOptions extends ZWaveHostOptions {
         sendDataCallback: number;
         report: number;
         nonce: number;
+        retryJammed: number;
         sendToSleep: number;
         refreshValue: number;
         refreshValueAfterTransition: number;