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

Co-authored-by: Al Calzone <[email protected]>

packages/config/api.md

@@ -492,18 +492,13 @@ export interface DeviceComment {
 //
 // @public (undocumented)
 export class DeviceConfig {
-    constructor(filename: string,
-    isEmbedded: boolean, manufacturer: string, manufacturerId: number, label: string, description: string, devices: readonly {
+    constructor(filename: string, isEmbedded: boolean, manufacturer: string, manufacturerId: number, label: string, description: string, devices: readonly {
         productType: number;
         productId: number;
-    }[], firmwareVersion: FirmwareVersionRange,
-    preferred: boolean, endpoints?: ReadonlyMap<number, EndpointConfig> | undefined, associations?: ReadonlyMap<number, AssociationConfig> | undefined, paramInformation?: ParamInfoMap | undefined,
-    proprietary?: Record<string, unknown> | undefined,
-    compat?: CompatConfig | undefined,
-    metadata?: DeviceMetadata | undefined);
+    }[], firmwareVersion: FirmwareVersionRange, preferred: boolean, endpoints?: ReadonlyMap<number, EndpointConfig>, associations?: ReadonlyMap<number, AssociationConfig>, paramInformation?: ParamInfoMap, proprietary?: Record<string, unknown>, compat?: CompatConfig, metadata?: DeviceMetadata);
     // (undocumented)
-    readonly associations?: ReadonlyMap<number, AssociationConfig> | undefined;
-    readonly compat?: CompatConfig | undefined;
+    readonly associations?: ReadonlyMap<number, AssociationConfig>;
+    readonly compat?: CompatConfig;
     // (undocumented)
     readonly description: string;
     // (undocumented)
@@ -512,7 +507,7 @@ export class DeviceConfig {
         productId: number;
     }[];
     // (undocumented)
-    readonly endpoints?: ReadonlyMap<number, EndpointConfig> | undefined;
+    readonly endpoints?: ReadonlyMap<number, EndpointConfig>;
     // (undocumented)
     readonly filename: string;
     // (undocumented)
@@ -533,11 +528,11 @@ export class DeviceConfig {
     readonly manufacturer: string;
     // (undocumented)
     readonly manufacturerId: number;
-    readonly metadata?: DeviceMetadata | undefined;
+    readonly metadata?: DeviceMetadata;
     // (undocumented)
-    readonly paramInformation?: ParamInfoMap | undefined;
+    readonly paramInformation?: ParamInfoMap;
     readonly preferred: boolean;
-    readonly proprietary?: Record<string, unknown> | undefined;
+    readonly proprietary?: Record<string, unknown>;
 }
 
 // Warning: (ae-missing-release-tag) "DeviceConfigIndex" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)

packages/core/api.md

@@ -6,7 +6,6 @@
 
 /// <reference types="node" />
 
-import { DeepPartial } from '@zwave-js/shared';
 import type { ExecutionContext } from 'ava';
 import type { Format } from 'logform';
 import type { JsonlDB } from '@alcalzone/jsonl-db';
@@ -1221,6 +1220,11 @@ export function isMessagePriority(val: unknown): val is MessagePriority;
 // @public (undocumented)
 export function isMissingControllerACK(e: unknown): e is ZWaveError;
 
+// 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;
+
 // 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
@@ -3368,7 +3372,7 @@ export enum ZWaveLibraryTypes {
 //
 // @public (undocumented)
 export class ZWaveLogContainer extends winston.Container {
-    constructor(config?: DeepPartial<LogConfig>);
+    constructor(config?: Partial<LogConfig>);
     // (undocumented)
     destroy(): void;
     // (undocumented)
@@ -3378,7 +3382,7 @@ export class ZWaveLogContainer extends winston.Container {
     isLoglevelVisible(loglevel: string): boolean;
     shouldLogNode(nodeId: number): boolean;
     // (undocumented)
-    updateConfiguration(config: DeepPartial<LogConfig>): void;
+    updateConfiguration(config: Partial<LogConfig>): void;
 }
 
 // Warning: (ae-missing-release-tag) "ZWaveLogger" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)

packages/host/api.md

@@ -53,11 +53,11 @@ export interface FileSystem {
     // (undocumented)
     pathExists(path: string): Promise<boolean>;
     // (undocumented)
-    readFile(file: string, encoding: string): Promise<string>;
+    readFile(file: string, encoding: BufferEncoding): Promise<string>;
     // (undocumented)
     writeFile(file: string, data: string | Buffer, options?: {
-        encoding: string;
-    } | string): Promise<void>;
+        encoding: BufferEncoding;
+    } | BufferEncoding): Promise<void>;
 }
 
 // Warning: (ae-missing-release-tag) "NodeSchedulePollOptions" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)

packages/zwave-js/api.md

@@ -42,7 +42,8 @@ import { Duration as Duration_2 } from '@zwave-js/core';
 import { DurationUnit } from '@zwave-js/core/safe';
 import { EntryControlDataTypes } from '@zwave-js/cc/safe';
 import { EntryControlEventTypes } from '@zwave-js/cc/safe';
-import { Expand } from '@zwave-js/shared/safe';
+import { Expand } from '@zwave-js/shared';
+import { Expand as Expand_2 } from '@zwave-js/shared/safe';
 import { extractFirmware } from '@zwave-js/core';
 import { FileSystem } from '@zwave-js/host/safe';
 import type { FileSystem as FileSystem_2 } from '@zwave-js/host';
@@ -318,7 +319,8 @@ export class DeviceClass {
 export class Driver extends TypedEventEmitter<DriverEventCallbacks> implements ZWaveApplicationHost {
     // (undocumented)
     [util.inspect.custom](): string;
-    constructor(port: string | ZWaveSerialPortImplementation, options?: DeepPartial<ZWaveOptions>);
+    // Warning: (ae-forgotten-export) The symbol "PartialZWaveOptions" needs to be exported by the entry point index.d.ts
+    constructor(port: string | ZWaveSerialPortImplementation, options?: PartialZWaveOptions);
     get allNodesReady(): boolean;
     // (undocumented)
     readonly cacheDir: string;
@@ -427,8 +429,8 @@ export class Driver extends TypedEventEmitter<DriverEventCallbacks> implements Z
     unregisterRequestHandler(fnType: FunctionType, handler: RequestHandler): void;
     // (undocumented)
     unwrapCommands(msg: Message & ICommandClassContainer): void;
-    updateLogConfig(config: DeepPartial<LogConfig>): void;
-    updateOptions(options: DeepPartial<EditableZWaveOptions>): void;
+    updateLogConfig(config: Partial<LogConfig>): void;
+    updateOptions(options: EditableZWaveOptions): void;
     // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
     updateUserAgent(components: Record<string, string | null | undefined>): void;
     get userAgent(): string;
@@ -463,9 +465,9 @@ export { DurationUnit }
 // Warning: (ae-missing-release-tag) "EditableZWaveOptions" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-export type EditableZWaveOptions = Pick<ZWaveOptions, "disableOptimisticValueUpdate" | "emitValueUpdateAfterSetValue" | "inclusionUserCallbacks" | "interview" | "logConfig" | "preferences"> & {
+export type EditableZWaveOptions = Expand<Pick<PartialZWaveOptions, "disableOptimisticValueUpdate" | "emitValueUpdateAfterSetValue" | "inclusionUserCallbacks" | "interview" | "logConfig" | "preferences"> & {
     userAgent?: Record<string, string | null | undefined>;
-};
+}>;
 
 // Warning: (ae-missing-release-tag) "Endpoint" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
@@ -541,7 +543,7 @@ export { FirmwareFileFormat }
 // Warning: (ae-missing-release-tag) "FirmwareUpdateDeviceID" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public
-export type FirmwareUpdateDeviceID = Expand<DeviceID & {
+export type FirmwareUpdateDeviceID = Expand_2<DeviceID & {
     firmwareVersion: string;
     rfRegion?: RFRegion_2;
 }>;
@@ -562,7 +564,7 @@ export interface FirmwareUpdateFileInfo {
 // Warning: (ae-missing-release-tag) "FirmwareUpdateInfo" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-export type FirmwareUpdateInfo = Expand<FirmwareUpdateServiceResponse & {
+export type FirmwareUpdateInfo = Expand_2<FirmwareUpdateServiceResponse & {
     device: FirmwareUpdateDeviceID;
 }>;
 
@@ -1255,7 +1257,6 @@ export class ZWaveController extends TypedEventEmitter<ControllerEventCallbacks>
     // (undocumented)
     get supportedSerialAPISetupCommands(): readonly SerialAPISetupCommand[] | undefined;
     supportsFeature(feature: ZWaveFeature): MaybeNotKnown<boolean>;
-    get supportsSoftReset(): MaybeNotKnown<boolean>;
     // (undocumented)
     get supportsTimers(): MaybeNotKnown<boolean>;
     toggleRF(enabled: boolean): Promise<boolean>;