refactor: replace some instances of IZWaveEndpoint

zwave-js · Oct 9, 2024 · be65623 · be65623
1 parent 7510a38
commit be65623
Show file tree

Hide file tree

Showing 18 changed files with 82 additions and 69 deletions.
diff --git a/packages/cc/src/cc/AlarmSensorCC.ts b/packages/cc/src/cc/AlarmSensorCC.ts
@@ -1,6 +1,6 @@
 import {
 	CommandClasses,
-	type IZWaveEndpoint,
+	type EndpointId,
 	type MaybeNotKnown,
 	type MessageOrCCLogEntry,
 	MessagePriority,
@@ -289,7 +289,7 @@ duration: ${currentValue.duration}`;
 	 */
 	public static getSupportedSensorTypesCached(
 		applHost: ZWaveApplicationHost,
-		endpoint: IZWaveEndpoint,
+		endpoint: EndpointId,
 	): MaybeNotKnown<AlarmSensorType[]> {
 		return applHost
 			.getValueDB(endpoint.nodeId)

diff --git a/packages/cc/src/cc/AssociationCC.ts b/packages/cc/src/cc/AssociationCC.ts
@@ -1,5 +1,5 @@
 import type {
-	IZWaveEndpoint,
+	EndpointId,
 	MaybeNotKnown,
 	MessageRecord,
 	SupervisionResult,
@@ -307,7 +307,7 @@ export class AssociationCC extends CommandClass {
 	 */
 	public static getGroupCountCached(
 		applHost: ZWaveApplicationHost,
-		endpoint: IZWaveEndpoint,
+		endpoint: EndpointId,
 	): number {
 		return (
 			applHost
@@ -324,7 +324,7 @@ export class AssociationCC extends CommandClass {
 	 */
 	public static getMaxNodesCached(
 		applHost: ZWaveApplicationHost,
-		endpoint: IZWaveEndpoint,
+		endpoint: EndpointId,
 		groupId: number,
 	): number {
 		return (
@@ -351,7 +351,7 @@ export class AssociationCC extends CommandClass {
 	 */
 	public static getAllDestinationsCached(
 		applHost: ZWaveApplicationHost,
-		endpoint: IZWaveEndpoint,
+		endpoint: EndpointId,
 	): ReadonlyMap<number, readonly AssociationAddress[]> {
 		const ret = new Map<number, AssociationAddress[]>();
 		const groupCount = this.getGroupCountCached(applHost, endpoint);

diff --git a/packages/cc/src/cc/AssociationGroupInfoCC.ts b/packages/cc/src/cc/AssociationGroupInfoCC.ts
@@ -257,7 +257,7 @@ export class AssociationGroupInfoCC extends CommandClass {
 	/** Returns the name of an association group */
 	public static getGroupNameCached(
 		applHost: ZWaveApplicationHost,
-		endpoint: IZWaveEndpoint,
+		endpoint: EndpointId,
 		groupId: number,
 	): MaybeNotKnown<string> {
 		return applHost
@@ -288,7 +288,7 @@ export class AssociationGroupInfoCC extends CommandClass {
 	/** Returns the dictionary of all commands issued by the given association group */
 	public static getIssuedCommandsCached(
 		applHost: ZWaveApplicationHost,
-		endpoint: IZWaveEndpoint,
+		endpoint: EndpointId,
 		groupId: number,
 	): MaybeNotKnown<ReadonlyMap<CommandClasses, readonly number[]>> {
 		return applHost
@@ -302,6 +302,7 @@ export class AssociationGroupInfoCC extends CommandClass {
 
 	public static findGroupsForIssuedCommand(
 		applHost: ZWaveApplicationHost,
+		// FIXME: GH#7261 ID and endpoint capabilities would be enough
 		endpoint: IZWaveEndpoint,
 		ccId: CommandClasses,
 		command: number,
@@ -332,6 +333,7 @@ export class AssociationGroupInfoCC extends CommandClass {
 
 	private static getAssociationGroupCountCached(
 		applHost: ZWaveApplicationHost,
+		// FIXME: GH#7261 ID and endpoint capabilities would be enough
 		endpoint: IZWaveEndpoint,
 	): number {
 		// The association group count is either determined by the

diff --git a/packages/cc/src/cc/BinarySensorCC.ts b/packages/cc/src/cc/BinarySensorCC.ts
@@ -1,6 +1,6 @@
 import {
 	CommandClasses,
-	type IZWaveEndpoint,
+	type EndpointId,
 	type MaybeNotKnown,
 	type MessageOrCCLogEntry,
 	MessagePriority,
@@ -308,7 +308,7 @@ export class BinarySensorCC extends CommandClass {
 	 */
 	public static getSupportedSensorTypesCached(
 		applHost: ZWaveApplicationHost,
-		endpoint: IZWaveEndpoint,
+		endpoint: EndpointId,
 	): MaybeNotKnown<BinarySensorType[]> {
 		return applHost
 			.getValueDB(endpoint.nodeId)

diff --git a/packages/cc/src/cc/ConfigurationCC.ts b/packages/cc/src/cc/ConfigurationCC.ts
@@ -145,6 +145,7 @@ type NormalizedConfigurationCCAPISetOptions =
 
 function createConfigurationCCInstance(
 	applHost: ZWaveApplicationHost,
+	// FIXME: GH#7261 ID and index should be enough
 	endpoint: IZWaveEndpoint | IVirtualEndpoint,
 ): ConfigurationCC {
 	return CommandClass.createInstanceUnchecked(
@@ -156,6 +157,7 @@ function createConfigurationCCInstance(
 
 function normalizeConfigurationCCAPISetOptions(
 	applHost: ZWaveApplicationHost,
+	// FIXME: GH#7261 ID and index should be enough
 	endpoint: IZWaveEndpoint | IVirtualEndpoint,
 	options: ConfigurationCCAPISetOptions,
 ): NormalizedConfigurationCCAPISetOptions {
@@ -213,6 +215,7 @@ function normalizeConfigurationCCAPISetOptions(
 
 function bulkMergePartialParamValues(
 	applHost: ZWaveApplicationHost,
+	// FIXME: GH#7261 ID and index should be enough
 	endpoint: IZWaveEndpoint | IVirtualEndpoint,
 	options: NormalizedConfigurationCCAPISetOptions[],
 ): (NormalizedConfigurationCCAPISetOptions & { bitMask?: undefined })[] {

diff --git a/packages/cc/src/cc/DoorLockCC.ts b/packages/cc/src/cc/DoorLockCC.ts
@@ -1,7 +1,7 @@
 import {
 	CommandClasses,
 	Duration,
-	type IZWaveEndpoint,
+	type EndpointId,
 	type MaybeNotKnown,
 	type MessageOrCCLogEntry,
 	MessagePriority,
@@ -254,7 +254,7 @@ export const DoorLockCCValues = Object.freeze({
 
 function shouldAutoCreateLatchStatusValue(
 	applHost: ZWaveApplicationHost,
-	endpoint: IZWaveEndpoint,
+	endpoint: EndpointId,
 ): boolean {
 	const valueDB = applHost.tryGetValueDB(endpoint.nodeId);
 	if (!valueDB) return false;
@@ -265,7 +265,7 @@ function shouldAutoCreateLatchStatusValue(
 
 function shouldAutoCreateBoltStatusValue(
 	applHost: ZWaveApplicationHost,
-	endpoint: IZWaveEndpoint,
+	endpoint: EndpointId,
 ): boolean {
 	const valueDB = applHost.tryGetValueDB(endpoint.nodeId);
 	if (!valueDB) return false;
@@ -276,7 +276,7 @@ function shouldAutoCreateBoltStatusValue(
 
 function shouldAutoCreateDoorStatusValue(
 	applHost: ZWaveApplicationHost,
-	endpoint: IZWaveEndpoint,
+	endpoint: EndpointId,
 ): boolean {
 	const valueDB = applHost.tryGetValueDB(endpoint.nodeId);
 	if (!valueDB) return false;
@@ -287,7 +287,7 @@ function shouldAutoCreateDoorStatusValue(
 
 function shouldAutoCreateTwistAssistConfigValue(
 	applHost: ZWaveApplicationHost,
-	endpoint: IZWaveEndpoint,
+	endpoint: EndpointId,
 ): boolean {
 	const valueDB = applHost.tryGetValueDB(endpoint.nodeId);
 	if (!valueDB) return false;
@@ -298,7 +298,7 @@ function shouldAutoCreateTwistAssistConfigValue(
 
 function shouldAutoCreateBlockToBlockConfigValue(
 	applHost: ZWaveApplicationHost,
-	endpoint: IZWaveEndpoint,
+	endpoint: EndpointId,
 ): boolean {
 	const valueDB = applHost.tryGetValueDB(endpoint.nodeId);
 	if (!valueDB) return false;
@@ -309,7 +309,7 @@ function shouldAutoCreateBlockToBlockConfigValue(
 
 function shouldAutoCreateAutoRelockConfigValue(
 	applHost: ZWaveApplicationHost,
-	endpoint: IZWaveEndpoint,
+	endpoint: EndpointId,
 ): boolean {
 	const valueDB = applHost.tryGetValueDB(endpoint.nodeId);
 	if (!valueDB) return false;
@@ -320,7 +320,7 @@ function shouldAutoCreateAutoRelockConfigValue(
 
 function shouldAutoCreateHoldAndReleaseConfigValue(
 	applHost: ZWaveApplicationHost,
-	endpoint: IZWaveEndpoint,
+	endpoint: EndpointId,
 ): boolean {
 	const valueDB = applHost.tryGetValueDB(endpoint.nodeId);
 	if (!valueDB) return false;

diff --git a/packages/cc/src/cc/IndicatorCC.ts b/packages/cc/src/cc/IndicatorCC.ts
@@ -1,7 +1,7 @@
 import type { ConfigManager } from "@zwave-js/config";
 import {
 	CommandClasses,
-	type IZWaveEndpoint,
+	type EndpointId,
 	Indicator,
 	type MaybeNotKnown,
 	type MessageOrCCLogEntry,
@@ -850,7 +850,7 @@ export class IndicatorCC extends CommandClass {
 
 	public static getSupportedPropertyIDsCached(
 		applHost: ZWaveApplicationHost,
-		endpoint: IZWaveEndpoint,
+		endpoint: EndpointId,
 		indicatorId: number,
 	): MaybeNotKnown<number[]> {
 		return applHost

diff --git a/packages/cc/src/cc/IrrigationCC.ts b/packages/cc/src/cc/IrrigationCC.ts
@@ -1,6 +1,6 @@
 import {
 	CommandClasses,
-	type IZWaveEndpoint,
+	type EndpointId,
 	type MaybeNotKnown,
 	type MessageOrCCLogEntry,
 	MessagePriority,
@@ -1119,7 +1119,7 @@ export class IrrigationCC extends CommandClass {
 	 */
 	public static getMaxValveTableSizeCached(
 		applHost: ZWaveApplicationHost,
-		endpoint: IZWaveEndpoint,
+		endpoint: EndpointId,
 	): MaybeNotKnown<number> {
 		return applHost
 			.getValueDB(endpoint.nodeId)
@@ -1134,7 +1134,7 @@ export class IrrigationCC extends CommandClass {
 	 */
 	public static getNumValvesCached(
 		applHost: ZWaveApplicationHost,
-		endpoint: IZWaveEndpoint,
+		endpoint: EndpointId,
 	): MaybeNotKnown<number> {
 		return applHost
 			.getValueDB(endpoint.nodeId)
@@ -1147,7 +1147,7 @@ export class IrrigationCC extends CommandClass {
 	 */
 	public static supportsMasterValveCached(
 		applHost: ZWaveApplicationHost,
-		endpoint: IZWaveEndpoint,
+		endpoint: EndpointId,
 	): boolean {
 		return !!applHost
 			.getValueDB(endpoint.nodeId)

diff --git a/packages/cc/src/cc/MeterCC.ts b/packages/cc/src/cc/MeterCC.ts
@@ -1,6 +1,5 @@
 import {
 	type FloatParameters,
-	type IZWaveEndpoint,
 	type MaybeUnknown,
 	encodeBitMask,
 	encodeFloatWithScale,
@@ -13,6 +12,7 @@ import {
 } from "@zwave-js/core";
 import {
 	CommandClasses,
+	type EndpointId,
 	type MaybeNotKnown,
 	type MessageOrCCLogEntry,
 	MessagePriority,
@@ -782,7 +782,7 @@ supports reset:       ${suppResp.supportsReset}`;
 	 */
 	public static getMeterTypeCached(
 		applHost: ZWaveApplicationHost,
-		endpoint: IZWaveEndpoint,
+		endpoint: EndpointId,
 	): MaybeNotKnown<number> {
 		return applHost
 			.getValueDB(endpoint.nodeId)
@@ -795,7 +795,7 @@ supports reset:       ${suppResp.supportsReset}`;
 	 */
 	public static getSupportedScalesCached(
 		applHost: ZWaveApplicationHost,
-		endpoint: IZWaveEndpoint,
+		endpoint: EndpointId,
 	): MaybeNotKnown<number[]> {
 		return applHost
 			.getValueDB(endpoint.nodeId)
@@ -808,7 +808,7 @@ supports reset:       ${suppResp.supportsReset}`;
 	 */
 	public static supportsResetCached(
 		applHost: ZWaveApplicationHost,
-		endpoint: IZWaveEndpoint,
+		endpoint: EndpointId,
 	): MaybeNotKnown<boolean> {
 		return applHost
 			.getValueDB(endpoint.nodeId)
@@ -821,7 +821,7 @@ supports reset:       ${suppResp.supportsReset}`;
 	 */
 	public static getSupportedRateTypesCached(
 		applHost: ZWaveApplicationHost,
-		endpoint: IZWaveEndpoint,
+		endpoint: EndpointId,
 	): MaybeNotKnown<RateType[]> {
 		return applHost
 			.getValueDB(endpoint.nodeId)

diff --git a/packages/cc/src/cc/MultiChannelAssociationCC.ts b/packages/cc/src/cc/MultiChannelAssociationCC.ts
@@ -1,5 +1,5 @@
 import type {
-	IZWaveEndpoint,
+	EndpointId,
 	MessageRecord,
 	SupervisionResult,
 } from "@zwave-js/core/safe";
@@ -371,7 +371,7 @@ export class MultiChannelAssociationCC extends CommandClass {
 	 */
 	public static getGroupCountCached(
 		applHost: ZWaveApplicationHost,
-		endpoint: IZWaveEndpoint,
+		endpoint: EndpointId,
 	): number {
 		return (
 			applHost
@@ -390,7 +390,7 @@ export class MultiChannelAssociationCC extends CommandClass {
 	 */
 	public static getMaxNodesCached(
 		applHost: ZWaveApplicationHost,
-		endpoint: IZWaveEndpoint,
+		endpoint: EndpointId,
 		groupId: number,
 	): number {
 		return (
@@ -410,7 +410,7 @@ export class MultiChannelAssociationCC extends CommandClass {
 	 */
 	public static getAllDestinationsCached(
 		applHost: ZWaveApplicationHost,
-		endpoint: IZWaveEndpoint,
+		endpoint: EndpointId,
 	): ReadonlyMap<number, readonly AssociationAddress[]> {
 		const ret = new Map<number, AssociationAddress[]>();
 		const groupCount = this.getGroupCountCached(applHost, endpoint);

diff --git a/packages/cc/src/cc/MultilevelSensorCC.ts b/packages/cc/src/cc/MultilevelSensorCC.ts
@@ -7,7 +7,7 @@ import {
 	timespan,
 } from "@zwave-js/core";
 import type {
-	IZWaveEndpoint,
+	EndpointId,
 	MessageOrCCLogEntry,
 	MessageRecord,
 	Scale,
@@ -568,7 +568,7 @@ value:       ${mlsResponse.value}${
 	 */
 	public static getSupportedSensorTypesCached(
 		applHost: ZWaveApplicationHost,
-		endpoint: IZWaveEndpoint,
+		endpoint: EndpointId,
 	): MaybeNotKnown<number[]> {
 		return applHost
 			.getValueDB(endpoint.nodeId)
@@ -585,7 +585,7 @@ value:       ${mlsResponse.value}${
 	 */
 	public static getSupportedScalesCached(
 		applHost: ZWaveApplicationHost,
-		endpoint: IZWaveEndpoint,
+		endpoint: EndpointId,
 		sensorType: number,
 	): MaybeNotKnown<number[]> {
 		return applHost

diff --git a/packages/cc/src/cc/NotificationCC.ts b/packages/cc/src/cc/NotificationCC.ts
@@ -12,7 +12,7 @@ import {
 import {
 	CommandClasses,
 	Duration,
-	type IZWaveEndpoint,
+	type EndpointId,
 	type MaybeNotKnown,
 	type MessageOrCCLogEntry,
 	MessagePriority,
@@ -213,7 +213,7 @@ export const NotificationCCValues = Object.freeze({
 
 function shouldAutoCreateSimpleDoorSensorValue(
 	applHost: ZWaveApplicationHost,
-	endpoint: IZWaveEndpoint,
+	endpoint: EndpointId,
 ): boolean {
 	const valueDB = applHost.tryGetValueDB(endpoint.nodeId);
 	if (!valueDB) return false;

diff --git a/packages/cc/src/cc/SceneControllerConfigurationCC.ts b/packages/cc/src/cc/SceneControllerConfigurationCC.ts
@@ -1,7 +1,7 @@
 import {
 	CommandClasses,
 	Duration,
-	type IZWaveEndpoint,
+	type EndpointId,
 	type MaybeNotKnown,
 	type MessageOrCCLogEntry,
 	MessagePriority,
@@ -465,7 +465,7 @@ dimming duration: ${group.dimmingDuration.toString()}`;
 	 */
 	public static getGroupCountCached(
 		applHost: ZWaveApplicationHost,
-		endpoint: IZWaveEndpoint,
+		endpoint: EndpointId,
 	): number {
 		return (
 			applHost.getDeviceConfig?.(endpoint.nodeId)?.compat