refactor: decouple Serial API Message parsing and creation (#7306)

packages/cc/src/cc/LanguageCC.ts

@@ -254,14 +254,11 @@ export class LanguageCCReport extends LanguageCC {
 		options: WithAddress<LanguageCCReportOptions>,
 	) {
 		super(options);
-
-		// TODO: Check implementation:
 		this.language = options.language;
 		this.country = options.country;
 	}
 
 	public static from(raw: CCRaw, ctx: CCParsingContext): LanguageCCReport {
-		// if (gotDeserializationOptions(options)) {
 		validatePayload(raw.payload.length >= 3);
 		const language = raw.payload.toString("ascii", 0, 3);
 		let country: MaybeNotKnown<string>;

packages/cc/src/cc/NoOperationCC.ts

@@ -1,13 +1,11 @@
 import { CommandClasses, MessagePriority } from "@zwave-js/core/safe";
-import type { Message } from "@zwave-js/serial";
 import { PhysicalCCAPI } from "../lib/API";
 import { CommandClass } from "../lib/CommandClass";
 import {
 	API,
 	commandClass,
 	implementedVersion,
 } from "../lib/CommandClassDecorators";
-import { isCommandClassContainer } from "../lib/ICommandClassContainer";
 
 // @noSetValueAPI This CC has no set-type commands
 // @noInterview There's nothing to interview here
@@ -37,13 +35,3 @@ export class NoOperationCCAPI extends PhysicalCCAPI {
 export class NoOperationCC extends CommandClass {
 	declare ccCommand: undefined;
 }
-
-/**
- * @publicAPI
- * Tests if a given message is a ping
- */
-export function messageIsPing<T extends Message>(
-	msg: T,
-): msg is T & { command: NoOperationCC } {
-	return isCommandClassContainer(msg) && msg.command instanceof NoOperationCC;
-}

packages/cc/src/cc/NotificationCC.ts

@@ -1318,6 +1318,7 @@ export class NotificationCCReport extends NotificationCC {
 					// Convert CommandClass instances to a standardized object representation
 					const cc = CommandClass.parse(this.eventParameters, {
 						...ctx,
+						frameType: "singlecast",
 						sourceNodeId: this.nodeId as number,
 						// Security encapsulation is handled outside of this CC,
 						// so it is not needed here:

packages/cc/src/cc/index.ts

@@ -544,7 +544,7 @@ export {
 	MultilevelSwitchCCSupportedReport,
 	MultilevelSwitchCCValues,
 } from "./MultilevelSwitchCC";
-export { NoOperationCC, messageIsPing } from "./NoOperationCC";
+export { NoOperationCC } from "./NoOperationCC";
 export type {
 	NodeNamingAndLocationCCLocationReportOptions,
 	NodeNamingAndLocationCCLocationSetOptions,

packages/cc/src/index.ts

@@ -6,7 +6,6 @@ export * from "./lib/API";
 export * from "./lib/CommandClass";
 export * from "./lib/CommandClassDecorators";
 export * from "./lib/EncapsulatingCommandClass";
-export * from "./lib/ICommandClassContainer";
 export {
 	MGRPExtension,
 	MOSExtension,

packages/cc/src/lib/CommandClass.ts

@@ -71,10 +71,6 @@ import {
 	isEncapsulatingCommandClass,
 	isMultiEncapsulatingCommandClass,
 } from "./EncapsulatingCommandClass";
-import {
-	type ICommandClassContainer,
-	isCommandClassContainer,
-} from "./ICommandClassContainer";
 import {
 	type CCValue,
 	type DynamicCCValue,
@@ -195,15 +191,6 @@ export class CCRaw {
 	public withPayload(payload: Buffer): CCRaw {
 		return new CCRaw(this.ccId, this.ccCommand, payload);
 	}
-
-	public serialize(): Buffer {
-		const ccIdLength = this.ccId >= 0xf100 ? 2 : 1;
-		const data = Buffer.allocUnsafe(ccIdLength + 1 + this.payload.length);
-		data.writeUIntBE(this.ccId, 0, ccIdLength);
-		data[ccIdLength] = this.ccCommand ?? 0;
-		this.payload.copy(data, ccIdLength + 1);
-		return data;
-	}
 }
 
 // @publicAPI
@@ -226,10 +213,10 @@ export class CommandClass implements CCId {
 	}
 
 	public static parse(
-		payload: Buffer,
+		data: Buffer,
 		ctx: CCParsingContext,
 	): CommandClass {
-		const raw = CCRaw.parse(payload);
+		const raw = CCRaw.parse(data);
 
 		// Find the correct subclass constructor to invoke
 		const CCConstructor = getCCConstructor(raw.ccId);
@@ -1189,26 +1176,6 @@ export class InvalidCC extends CommandClass {
 	}
 }
 
-/** @publicAPI */
-export function assertValidCCs(container: ICommandClassContainer): void {
-	if (container.command instanceof InvalidCC) {
-		if (typeof container.command.reason === "number") {
-			throw new ZWaveError(
-				"The message payload failed validation!",
-				container.command.reason,
-			);
-		} else {
-			throw new ZWaveError(
-				"The message payload is invalid!",
-				ZWaveErrorCodes.PacketFormat_InvalidPayload,
-				container.command.reason,
-			);
-		}
-	} else if (isCommandClassContainer(container.command)) {
-		assertValidCCs(container.command);
-	}
-}
-
 export type CCConstructor<T extends CommandClass> = typeof CommandClass & {
 	// I don't like the any, but we need it to support half-implemented CCs (e.g. report classes)
 	new (options: any): T;

packages/cc/src/lib/ICommandClassContainer.ts

@@ -1,14 +0,0 @@
-import { CommandClass } from "./CommandClass";
-
-export interface ICommandClassContainer {
-	command: CommandClass;
-}
-
-/**
- * Tests if the given message contains a CC
- */
-export function isCommandClassContainer<T>(
-	msg: T | undefined,
-): msg is T & ICommandClassContainer {
-	return (msg as any)?.command instanceof CommandClass;
-}

packages/core/src/consts/Transmission.ts

@@ -163,8 +163,6 @@ export function routingSchemeToString(scheme: RoutingScheme): string {
 export interface TXReport {
 	/** Transmission time in ticks (multiples of 10ms) */
 	txTicks: number;
-	/** Number of repeaters used in the route to the destination, 0 for direct range */
-	numRepeaters: number;
 	/** RSSI value of the acknowledgement frame */
 	ackRSSI?: RSSI;
 	/** RSSI values of the incoming acknowledgement frame, measured by repeater 0...3 */

packages/host/src/ZWaveHost.ts

@@ -23,16 +23,6 @@ export interface HostIDs {
 	homeId: number;
 }
 
-// FIXME: This should not be needed. Instead have the driver set callback IDs during sendMessage
-/** Allows generating a new callback ID */
-export interface GetNextCallbackId {
-	/**
-	 * Returns the next callback ID. Callback IDs are used to correlate requests
-	 * to the controller/nodes with its response
-	 */
-	getNextCallbackId(): number;
-}
-
 /** Allows querying device configuration for a node */
 export interface GetDeviceConfig {
 	getDeviceConfig(nodeId: number): DeviceConfig | undefined;
@@ -71,7 +61,7 @@ export interface CCParsingContext
 	__internalIsMockNode?: boolean;
 
 	/** If known, the frame type of the containing message */
-	frameType?: FrameType;
+	frameType: FrameType;
 
 	getHighestSecurityClass(nodeId: number): MaybeNotKnown<SecurityClass>;
 

packages/maintenance/src/generateTypedDocs.ts

@@ -359,9 +359,8 @@ async function processCCDocFile(
 	if (!APIClass) return;
 
 	const ccId = getCommandClassFromClassDeclaration(
-		// FIXME: there seems to be some discrepancy between ts-morph's bundled typescript and our typescript
-		file.compilerNode as any,
-		APIClass.compilerNode as any,
+		file.compilerNode,
+		APIClass.compilerNode,
 	);
 	if (ccId == undefined) return;
 	const ccName = getCCName(ccId);