Skip to content

Commit

Permalink
docs: update typed documentation and API report 🤖 (#6720)
Browse files Browse the repository at this point in the history 
Co-authored-by: Al Calzone <[email protected]>
  • Loading branch information
@zwave-js-bot @AlCalzone
zwave-js-bot and AlCalzone authored May 13, 2024
1 parent 74a66c4 commit 0728740
Show file tree
Hide file tree
Showing 6 changed files with 1,023 additions and 181 deletions.
41 changes: 21 additions & 20 deletions packages/cc/api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7926,9 +7926,9 @@ export enum HumidityControlSetpointType {
// (undocumented)
"De-humidifier" = 2,
// (undocumented)
"N/A" = 0,
"N/A" = 0,// CC v1
// (undocumented)
"Auto" = 3,
"Auto" = 3,// CC v1
// (undocumented)
"Humidifier" = 1
}
Expand Down Expand Up @@ -10195,21 +10195,21 @@ export function isTransportServiceEncapsulation(command: CommandClass): command
// @public (undocumented)
export enum KEXFailType {
// (undocumented)
BootstrappingCanceled = 6,
BootstrappingCanceled = 6,// KEX_KEY
// (undocumented)
Decrypt = 5,
Decrypt = 5,// KEX_SCHEME
// (undocumented)
DifferentKey = 10,
DifferentKey = 10,// KEX_CURVES
// (undocumented)
KeyNotGranted = 8,
// (undocumented)
NoKeyMatch = 1,
NoKeyMatch = 1,// CANCEL
// (undocumented)
NoSupportedCurve = 3,
NoSupportedCurve = 3,// AUTH
// (undocumented)
NoSupportedScheme = 2,
NoSupportedScheme = 2,// GET
// (undocumented)
NoVerify = 9,
NoVerify = 9,// VERIFY
// (undocumented)
WrongSecurityLevel = 7
}
Expand Down Expand Up @@ -15453,6 +15453,7 @@ export class Security2CCMessageEncapsulation extends Security2CC {
extensions: Security2Extension[];
// (undocumented)
getMulticastGroupId(): number | undefined;
getSenderEI(): Buffer | undefined;
// (undocumented)
hasMOSExtension(): boolean;
// (undocumented)
Expand Down Expand Up @@ -17676,25 +17677,25 @@ export enum ThermostatSetpointType {
// (undocumented)
"Auto Changeover" = 10,
// (undocumented)
"Away Cooling" = 14,
"Away Cooling" = 14,// CC v1
// (undocumented)
"Away Heating" = 13,
"Away Heating" = 13,// CC v1
// (undocumented)
"Dry Air" = 8,
"Dry Air" = 8,// CC v1
// (undocumented)
"Energy Save Cooling" = 12,
"Energy Save Cooling" = 12,// CC v1
// (undocumented)
"Energy Save Heating" = 11,
"Energy Save Heating" = 11,// CC v1
// (undocumented)
"Full Power" = 15,
"Full Power" = 15,// CC v1
// (undocumented)
"Moist Air" = 9,
"Moist Air" = 9,// CC v2
// (undocumented)
"N/A" = 0,
"N/A" = 0,// CC v2
// (undocumented)
"Cooling" = 2,
"Cooling" = 2,// CC v2
// (undocumented)
"Furnace" = 7,
"Furnace" = 7,// CC v3
// (undocumented)
"Heating" = 1
}
Expand Down Expand Up @@ -20525,7 +20526,7 @@ export enum ZWavePlusCommand {
// @public (undocumented)
export enum ZWavePlusNodeType {
// (undocumented)
IPGateway = 2,
IPGateway = 2,// ZWave+ Node
// (undocumented)
Node = 0
}
Expand Down
32 changes: 18 additions & 14 deletions packages/config/api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,18 @@ export interface BasicDeviceClass {
// @public (undocumented)
export type BasicDeviceClassMap = ReadonlyMap<number, string>;

// Warning: (ae-forgotten-export) The symbol "basicReportMappings" needs to be exported by the entry point index.d.ts
// Warning: (ae-missing-release-tag) "BasicReportMapping" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export type BasicReportMapping = typeof basicReportMappings[number];

// Warning: (ae-forgotten-export) The symbol "basicSetMappings" needs to be exported by the entry point index.d.ts
// Warning: (ae-missing-release-tag) "BasicSetMapping" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export type BasicSetMapping = typeof basicSetMappings[number];

// Warning: (ae-missing-release-tag) "CompatAddCC" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
Expand Down Expand Up @@ -142,16 +154,12 @@ export class ConditionalCompatConfig implements ConditionalItem<CompatConfig> {
// (undocumented)
readonly disableAutoRefresh?: boolean;
// (undocumented)
readonly disableBasicMapping?: boolean;
// (undocumented)
readonly disableCallbackFunctionTypeCheck?: number[];
// (undocumented)
readonly disableStrictEntryControlDataValidation?: boolean;
// (undocumented)
readonly disableStrictMeasurementValidation?: boolean;
// (undocumented)
readonly enableBasicSetMapping?: boolean;
// (undocumented)
evaluateCondition(deviceId?: DeviceID): CompatConfig | undefined;
// (undocumented)
readonly forceNotificationIdleReset?: boolean;
Expand All @@ -160,6 +168,10 @@ export class ConditionalCompatConfig implements ConditionalItem<CompatConfig> {
// (undocumented)
readonly manualValueRefreshDelayMs?: number;
// (undocumented)
readonly mapBasicReport?: BasicReportMapping;
// (undocumented)
readonly mapBasicSet?: BasicSetMapping;
// (undocumented)
readonly mapRootReportsToEndpoint?: number;
// (undocumented)
readonly overrideFloatEncoding?: {
Expand Down Expand Up @@ -189,8 +201,6 @@ export class ConditionalCompatConfig implements ConditionalItem<CompatConfig> {
// (undocumented)
readonly skipConfigurationNameQuery?: boolean;
// (undocumented)
readonly treatBasicSetAsEvent?: boolean;
// (undocumented)
readonly treatDestinationEndpointAsSource?: boolean;
// (undocumented)
readonly treatMultilevelSwitchSetAsEvent?: boolean;
Expand Down Expand Up @@ -663,8 +673,6 @@ export interface FulltextDeviceConfigIndexEntry {
export class GenericDeviceClass {
constructor(key: number, definition: JSONObject);
// (undocumented)
readonly controlledCCs: readonly CommandClasses[];
// (undocumented)
readonly key: number;
// (undocumented)
readonly label: string;
Expand All @@ -674,8 +682,6 @@ export class GenericDeviceClass {
readonly requiresSecurity?: boolean;
// (undocumented)
readonly specific: ReadonlyMap<number, SpecificDeviceClass>;
// (undocumented)
readonly supportedCCs: readonly CommandClasses[];
}

// Warning: (ae-missing-release-tag) "GenericDeviceClassMap" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
Expand Down Expand Up @@ -847,6 +853,8 @@ export class NotificationParameterWithDuration {
export class NotificationParameterWithEnum {
constructor(definition: JSONObject);
// (undocumented)
readonly default?: number;
// (undocumented)
readonly values: ReadonlyMap<number, string>;
}

Expand Down Expand Up @@ -971,8 +979,6 @@ export type SensorTypeMap = ReadonlyMap<number, SensorType>;
export class SpecificDeviceClass {
constructor(key: number, definition: JSONObject, generic: GenericDeviceClass);
// (undocumented)
readonly controlledCCs: readonly CommandClasses[];
// (undocumented)
readonly key: number;
// (undocumented)
readonly label: string;
Expand All @@ -981,8 +987,6 @@ export class SpecificDeviceClass {
// (undocumented)
readonly requiresSecurity?: boolean;
// (undocumented)
readonly supportedCCs: readonly CommandClasses[];
// (undocumented)
readonly zwavePlusDeviceType?: string;
}

Expand Down
126 changes: 118 additions & 8 deletions packages/core/api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,20 @@ export function authHomeIdFromDSK(dsk: Buffer): Buffer;
// @public
export function averageRSSI(acc: number | undefined, rssi: RSSI, weight: number): number;

// Warning: (ae-missing-release-tag) "BeamingInfo" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum BeamingInfo {
// (undocumented)
Fragmented = 4,
// (undocumented)
LongContinuous = 2,
// (undocumented)
None = 0,
// (undocumented)
ShortContinuous = 1
}

// Warning: (ae-missing-release-tag) "BroadcastCC" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
Expand Down Expand Up @@ -484,7 +498,7 @@ export enum ConfigValueFormat {
// (undocumented)
Enumerated = 2,
// (undocumented)
SignedInteger = 0,
SignedInteger = 0,// UnsignedInt, Radio Buttons
// (undocumented)
UnsignedInteger = 1
}
Expand All @@ -504,15 +518,15 @@ export const CONTROLLER_LABEL = "CNTRLR";
// @public (undocumented)
export enum ControllerCapabilityFlags {
// (undocumented)
NoNodesIncluded = 32,
NoNodesIncluded = 32,// Controller is a secondary
// (undocumented)
OnOtherNetwork = 2,
OnOtherNetwork = 2,// Controller is using a home ID from another network
// (undocumented)
Secondary = 1,
Secondary = 1,// There's a SUC id server (SIS) on the network
// (undocumented)
SISPresent = 4,
SISPresent = 4,// Before the SIS was added, the controller was the primary
// (undocumented)
SUC = 16,
SUC = 16,// Controller is a static update controller (SUC)
// (undocumented)
WasRealPrimary = 8
}
Expand Down Expand Up @@ -1006,6 +1020,14 @@ export function getBitMaskWidth(mask: number): number;
// @public (undocumented)
export function getCCName(cc: number): string;

// Warning: (ae-missing-release-tag) "getChipTypeAndVersion" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function getChipTypeAndVersion(zWaveChipType: string): MaybeNotKnown<{
type: number;
version: number;
}>;

// Warning: (ae-missing-release-tag) "getDefaultDSTInfo" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
Expand Down Expand Up @@ -1073,6 +1095,11 @@ export function getNodeTag(nodeId: number): string;
// @public
export function getNumericEnumValues<T extends Record<string, any>>(enumeration: T): readonly number[];

// Warning: (ae-missing-release-tag) "getZWaveChipType" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function getZWaveChipType(type: number, version: number): string | UnknownZWaveChipType;

// Warning: (ae-missing-release-tag) "GraphNode" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
Expand Down Expand Up @@ -1465,10 +1492,10 @@ export type LogValueArgs<T> = T & {
export enum LongRangeChannel {
// (undocumented)
A = 1,
Auto = 255,
// (undocumented)
B = 2,
// (undocumented)
Unknown = 0
Unsupported = 0
}

// Warning: (ae-missing-release-tag) "managementCCs" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
Expand Down Expand Up @@ -1600,6 +1627,22 @@ export type MPANTableEntry = {
currentMPAN: Buffer;
};

// Warning: (ae-missing-release-tag) "MPDUHeaderType" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum MPDUHeaderType {
// (undocumented)
Acknowledgement = 3,
// (undocumented)
Explorer = 5,
// (undocumented)
Multicast = 2,
// (undocumented)
Routed = 8,
// (undocumented)
Singlecast = 1
}

// Warning: (ae-missing-release-tag) "MulticastCC" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
Expand Down Expand Up @@ -2724,6 +2767,16 @@ export const UNKNOWN_STATE: null;
// @public (undocumented)
export type UNKNOWN_STATE = typeof UNKNOWN_STATE;

// Warning: (ae-missing-release-tag) "UnknownZWaveChipType" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export interface UnknownZWaveChipType {
// (undocumented)
type: number;
// (undocumented)
version: number;
}

// Warning: (ae-missing-release-tag) "unsilence" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
Expand Down Expand Up @@ -3231,6 +3284,61 @@ export interface ValueUpdatedArgs extends ValueID {
source?: "driver" | "node";
}

// Warning: (ae-missing-release-tag) "ZnifferProtocolDataRate" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum ZnifferProtocolDataRate {
// (undocumented)
LongRange_100k = 3,
// (undocumented)
ZWave_100k = 2,
// (undocumented)
ZWave_40k = 1,
// (undocumented)
ZWave_9k6 = 0
}

// Warning: (ae-missing-release-tag) "znifferProtocolDataRateToString" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function znifferProtocolDataRateToString(rate: ZnifferProtocolDataRate): string;

// Warning: (ae-missing-release-tag) "ZnifferRegion" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum ZnifferRegion {
// (undocumented)
"Australia/New Zealand" = 2,
// (undocumented)
"Default (EU)" = 255,
// (undocumented)
"Hong Kong" = 3,
// (undocumented)
"USA (Long Range)" = 9,
// (undocumented)
"USA (Long Range, backup)" = 10,
// (undocumented)
"USA (Long Range, end device)" = 48,
// (undocumented)
"China" = 8,
// (undocumented)
"Europe" = 0,
// (undocumented)
"India" = 5,
// (undocumented)
"Israel" = 6,
// (undocumented)
"Japan" = 32,
// (undocumented)
"Korea" = 33,
// (undocumented)
"Russia" = 7,
// (undocumented)
"Unknown" = 254,
// (undocumented)
"USA" = 1
}

// Warning: (ae-missing-release-tag) "ZWaveApiVersion" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
Expand Down Expand Up @@ -3488,6 +3596,8 @@ export interface ZWaveLogInfo<TContext extends LogContext = LogContext> extends

// Warnings were encountered during analysis:
//
// src/security/Manager2.ts:116:79 - (tsdoc-escape-greater-than) The ">" character should be escaped using a backslash to avoid confusion with an HTML tag
// src/security/Manager2.ts:116:98 - (tsdoc-escape-greater-than) The ">" character should be escaped using a backslash to avoid confusion with an HTML tag
// src/security/QR.ts:99:3 - (ae-unresolved-link) The @link reference could not be resolved: The package "@zwave-js/core" does not have an export "requestedSecurityClasses"

// (No @packageDocumentation comment for this package)
Expand Down
Loading

0 comments on commit 0728740

Please sign in to comment.