docs: update typed documentation and API report 🤖 (#6529)

Co-authored-by: Al Calzone <[email protected]>
zwave-js · Nov 30, 2023 · e922683 · e922683
1 parent b4fb2b5
commit e922683
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 0 deletions.
diff --git a/docs/api/config-manager.md b/docs/api/config-manager.md
@@ -415,6 +415,7 @@ interface GenericDeviceClass {
 	readonly requiresSecurity?: boolean;
 	readonly supportedCCs: readonly CommandClasses[];
 	readonly controlledCCs: readonly CommandClasses[];
+	readonly maySupportBasicCC: boolean;
 	readonly specific: ReadonlyMap<number, SpecificDeviceClass>;
 }
 ```
@@ -429,6 +430,7 @@ interface SpecificDeviceClass {
 	readonly requiresSecurity?: boolean;
 	readonly supportedCCs: readonly CommandClasses[];
 	readonly controlledCCs: readonly CommandClasses[];
+	readonly maySupportBasicCC: boolean;
 }
 ```
 

diff --git a/docs/api/node.md b/docs/api/node.md
@@ -907,6 +907,7 @@ interface GenericDeviceClass {
 	readonly requiresSecurity?: boolean;
 	readonly supportedCCs: readonly CommandClasses[];
 	readonly controlledCCs: readonly CommandClasses[];
+	readonly maySupportBasicCC: boolean;
 	readonly specific: ReadonlyMap<number, SpecificDeviceClass>;
 }
 ```
@@ -921,6 +922,7 @@ interface SpecificDeviceClass {
 	readonly requiresSecurity?: boolean;
 	readonly supportedCCs: readonly CommandClasses[];
 	readonly controlledCCs: readonly CommandClasses[];
+	readonly maySupportBasicCC: boolean;
 }
 ```
 

diff --git a/packages/config/api.md b/packages/config/api.md
@@ -669,6 +669,8 @@ export class GenericDeviceClass {
     // (undocumented)
     readonly label: string;
     // (undocumented)
+    readonly maySupportBasicCC: boolean;
+    // (undocumented)
     readonly requiresSecurity?: boolean;
     // (undocumented)
     readonly specific: ReadonlyMap<number, SpecificDeviceClass>;
@@ -975,6 +977,8 @@ export class SpecificDeviceClass {
     // (undocumented)
     readonly label: string;
     // (undocumented)
+    readonly maySupportBasicCC: boolean;
+    // (undocumented)
     readonly requiresSecurity?: boolean;
     // (undocumented)
     readonly supportedCCs: readonly CommandClasses[];

diff --git a/packages/zwave-js/api.md b/packages/zwave-js/api.md
@@ -536,7 +536,9 @@ export class Endpoint implements IZWaveEndpoint {
     invokeCCAPI<CC extends CCNameOrId, TMethod extends keyof TAPI, TAPI extends Record<string, (...args: any[]) => any> = CommandClasses_2 extends CC ? any : Omit<CCNameOrId, CommandClasses_2> extends CC ? any : APIMethodsOf<CC>>(cc: CC, method: TMethod, ...args: Parameters<TAPI[TMethod]>): ReturnType<TAPI[TMethod]>;
     isCCSecure(cc: CommandClasses_2): boolean;
     maybeAddBasicCCAsFallback(): void;
+    maySupportBasicCC(): boolean;
     readonly nodeId: number;
+    removeBasicCCSupportIfForbidden(): void;
     removeCC(cc: CommandClasses_2): void;
     protected reset(): void;
     supportsCC(cc: CommandClasses_2): boolean;