@willieee802/zigbee-herdsman 0.48.3 → 0.49.0

package/scripts/clusters-typegen.ts

@@ -0,0 +1,608 @@
+/**
+ * Usage:
+ *   tsx scripts/clusters-typegen.ts && pnpm run check:w
+ */
+import {writeFileSync} from "node:fs";
+import ts from "typescript";
+import {Clusters} from "../src/zspec/zcl/definition/cluster";
+import {BuffaloZclDataType, DataType} from "../src/zspec/zcl/definition/enums";
+import {Foundation, type FoundationCommandName, type FoundationDefinition} from "../src/zspec/zcl/definition/foundation";
+import {ManufacturerCode} from "../src/zspec/zcl/definition/manufacturerCode";
+import type {AttributeDefinition, ClusterName, CommandDefinition, ParameterDefinition} from "../src/zspec/zcl/definition/tstype";
+import {isFoundationDiscoverRsp} from "../src/zspec/zcl/utils";
+
+const FILENAME = "clusters-types.ts";
+
+const file = ts.createSourceFile(FILENAME, "", ts.ScriptTarget.ESNext, false, ts.ScriptKind.TS);
+const printer = ts.createPrinter({newLine: ts.NewLineKind.LineFeed});
+
+const emptyObject = ts.factory.createTypeReferenceNode("Record", [
+    ts.factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword),
+    ts.factory.createKeywordTypeNode(ts.SyntaxKind.NeverKeyword),
+]);
+
+const namedImports = ts.factory.createImportDeclaration(
+    undefined,
+    ts.factory.createImportClause(
+        ts.SyntaxKind.TypeKeyword,
+        undefined,
+        ts.factory.createNamedImports([
+            // sorted by name
+            ts.factory.createImportSpecifier(false, undefined, ts.factory.createIdentifier("ExtensionFieldSet")),
+            ts.factory.createImportSpecifier(false, undefined, ts.factory.createIdentifier("Gpd")),
+            ts.factory.createImportSpecifier(false, undefined, ts.factory.createIdentifier("GpdAttributeReport")),
+            ts.factory.createImportSpecifier(false, undefined, ts.factory.createIdentifier("GpdChannelConfiguration")),
+            ts.factory.createImportSpecifier(false, undefined, ts.factory.createIdentifier("GpdChannelRequest")),
+            ts.factory.createImportSpecifier(false, undefined, ts.factory.createIdentifier("GpdCommissioningReply")),
+            ts.factory.createImportSpecifier(false, undefined, ts.factory.createIdentifier("GpdCustomReply")),
+            ts.factory.createImportSpecifier(false, undefined, ts.factory.createIdentifier("MiboxerZone")),
+            ts.factory.createImportSpecifier(false, undefined, ts.factory.createIdentifier("Struct")),
+            ts.factory.createImportSpecifier(false, undefined, ts.factory.createIdentifier("StructuredSelector")),
+            ts.factory.createImportSpecifier(false, undefined, ts.factory.createIdentifier("ThermoTransition")),
+            ts.factory.createImportSpecifier(false, undefined, ts.factory.createIdentifier("TuyaDataPointValue")),
+            ts.factory.createImportSpecifier(false, undefined, ts.factory.createIdentifier("ZclArray")),
+            // ts.factory.createImportSpecifier(false, undefined, ts.factory.createIdentifier("ZclDate")), // XXX: currently unused
+            // ts.factory.createImportSpecifier(false, undefined, ts.factory.createIdentifier("ZclTimeOfDay")), // XXX: currently unused
+            ts.factory.createImportSpecifier(false, undefined, ts.factory.createIdentifier("ZoneInfo")),
+        ]),
+    ),
+    ts.factory.createStringLiteral("./tstype"),
+    undefined,
+);
+
+const getTypeFromDataType = (dataType: DataType | BuffaloZclDataType): ts.TypeNode => {
+    switch (dataType) {
+        case DataType.NO_DATA:
+        case DataType.UNKNOWN: {
+            return ts.factory.createKeywordTypeNode(ts.SyntaxKind.NeverKeyword);
+        }
+        case DataType.DATA56:
+        case DataType.BITMAP56:
+        case DataType.UINT56:
+        case DataType.DATA64:
+        case DataType.BITMAP64:
+        case DataType.UINT64:
+        case DataType.INT56:
+        case DataType.INT64: {
+            return ts.factory.createKeywordTypeNode(ts.SyntaxKind.BigIntKeyword);
+        }
+        case DataType.OCTET_STR:
+        case DataType.LONG_OCTET_STR:
+        case DataType.SEC_KEY: {
+            return ts.factory.createTypeReferenceNode("Buffer");
+        }
+        case DataType.CHAR_STR:
+        case DataType.LONG_CHAR_STR:
+        case DataType.IEEE_ADDR: {
+            return ts.factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword);
+        }
+        case DataType.ARRAY:
+        case DataType.SET:
+        case DataType.BAG: {
+            // mismatch on read vs write, have to union
+            return ts.factory.createUnionTypeNode([
+                ts.factory.createTypeReferenceNode("ZclArray"),
+                ts.factory.createArrayTypeNode(ts.factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword)),
+            ]);
+        }
+        case DataType.STRUCT: {
+            return ts.factory.createTypeReferenceNode("Struct");
+        }
+        case DataType.TOD: {
+            return ts.factory.createTypeReferenceNode("ZclTimeOfDay");
+        }
+        case DataType.DATE: {
+            return ts.factory.createTypeReferenceNode("ZclDate");
+        }
+        case BuffaloZclDataType.USE_DATA_TYPE: {
+            return ts.factory.createKeywordTypeNode(ts.SyntaxKind.UnknownKeyword);
+        }
+        case BuffaloZclDataType.LIST_UINT8:
+        case BuffaloZclDataType.LIST_UINT16:
+        case BuffaloZclDataType.LIST_UINT24:
+        case BuffaloZclDataType.LIST_UINT32: {
+            return ts.factory.createArrayTypeNode(ts.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword));
+        }
+        case BuffaloZclDataType.LIST_ZONEINFO: {
+            return ts.factory.createArrayTypeNode(ts.factory.createTypeReferenceNode("ZoneInfo"));
+        }
+        case BuffaloZclDataType.EXTENSION_FIELD_SETS: {
+            return ts.factory.createArrayTypeNode(ts.factory.createTypeReferenceNode("ExtensionFieldSet"));
+        }
+        case BuffaloZclDataType.LIST_THERMO_TRANSITIONS: {
+            return ts.factory.createArrayTypeNode(ts.factory.createTypeReferenceNode("ThermoTransition"));
+        }
+        case BuffaloZclDataType.BUFFER: {
+            return ts.factory.createTypeReferenceNode("Buffer");
+        }
+        case BuffaloZclDataType.GPD_FRAME: {
+            return ts.factory.createUnionTypeNode([
+                ts.factory.createTypeReferenceNode("Gpd"),
+                ts.factory.createTypeReferenceNode("GpdChannelRequest"),
+                ts.factory.createTypeReferenceNode("GpdAttributeReport"),
+                ts.factory.createTypeLiteralNode([
+                    ts.factory.createPropertySignature(undefined, "raw", undefined, ts.factory.createTypeReferenceNode("Buffer")),
+                ]),
+                ts.factory.createTypeReferenceNode("Record<string, never>"),
+                ts.factory.createTypeReferenceNode("GpdCommissioningReply"),
+                ts.factory.createTypeReferenceNode("GpdChannelConfiguration"),
+                ts.factory.createTypeReferenceNode("GpdCustomReply"),
+            ]);
+        }
+        case BuffaloZclDataType.STRUCTURED_SELECTOR: {
+            return ts.factory.createTypeReferenceNode("StructuredSelector");
+        }
+        case BuffaloZclDataType.LIST_TUYA_DATAPOINT_VALUES: {
+            return ts.factory.createArrayTypeNode(ts.factory.createTypeReferenceNode("TuyaDataPointValue"));
+        }
+        case BuffaloZclDataType.LIST_MIBOXER_ZONES: {
+            return ts.factory.createArrayTypeNode(ts.factory.createTypeReferenceNode("MiboxerZone"));
+        }
+        default: {
+            return ts.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword);
+        }
+    }
+};
+
+const getPropertyStr = (key: string, val: unknown, padId = 4) => {
+    let valStr = `${val}`;
+
+    if (key === "ID") {
+        valStr = `0x${Number(val).toString(16).padStart(padId, "0")}`;
+    } else if (key === "type") {
+        valStr = `${DataType[val as number] ?? BuffaloZclDataType[val as number]}`;
+    } else if (key === "manufacturerCode") {
+        valStr = `${ManufacturerCode[val as number]}(0x${Number(val).toString(16).padStart(4, "0")})`;
+    }
+
+    return valStr;
+};
+
+const getConditionStr = (conditions: ParameterDefinition["conditions"]): string | undefined => {
+    if (conditions) {
+        let str = "conditions=[";
+
+        for (const condition of conditions) {
+            str += `{${condition.type}`;
+
+            for (const key in condition) {
+                if (key === "type") {
+                    continue;
+                }
+
+                str += ` ${key}=${condition[key as keyof typeof condition]}`;
+            }
+
+            str += "}";
+        }
+
+        return `${str}]`;
+    }
+};
+
+const addAttributes = (attributes: Readonly<Record<string, Readonly<AttributeDefinition>>>): ts.TypeNode => {
+    const elements: ts.PropertySignature[] = [];
+
+    for (const attributeName in attributes) {
+        const attribute = attributes[attributeName];
+
+        const element = ts.factory.createPropertySignature(
+            undefined,
+            attributeName,
+            // always optional if manuf-specific
+            attribute.manufacturerCode ? ts.factory.createToken(ts.SyntaxKind.QuestionToken) : undefined,
+            getTypeFromDataType(attribute.type),
+        );
+
+        elements.push(element);
+
+        const commentChunks: string[] = [];
+
+        for (const key in attribute) {
+            commentChunks.push(`${key}=${getPropertyStr(key, attribute[key as keyof typeof attribute], 4)}`);
+        }
+
+        const comment = `* ${commentChunks.join(" | ")} `;
+
+        ts.addSyntheticLeadingComment(element, ts.SyntaxKind.MultiLineCommentTrivia, comment, true);
+    }
+
+    return elements.length > 0 ? ts.factory.createTypeLiteralNode(elements) : ts.factory.createKeywordTypeNode(ts.SyntaxKind.NeverKeyword);
+};
+
+const addCommands = (commands: Readonly<Record<string, Readonly<CommandDefinition>>>): ts.TypeNode => {
+    const elements: ts.PropertySignature[] = [];
+
+    for (const commandName in commands) {
+        const command = commands[commandName];
+        const cmdElements: ts.PropertySignature[] = [];
+
+        for (const parameter of command.parameters) {
+            // @ts-expect-error bad typing?
+            const existing = cmdElements.find((element) => element.name.escapedText === parameter.name);
+            const paramType = getTypeFromDataType(parameter.type);
+
+            if (!existing) {
+                const cmdElement = ts.factory.createPropertySignature(
+                    undefined,
+                    parameter.name,
+                    parameter.conditions ? ts.factory.createToken(ts.SyntaxKind.QuestionToken) : undefined,
+                    paramType,
+                );
+
+                const conditionComment = getConditionStr(parameter.conditions);
+                const commentChunks: string[] = [];
+
+                for (const key in parameter) {
+                    if (key === "name" || key === "conditions") {
+                        continue;
+                    }
+
+                    commentChunks.push(`${key}=${getPropertyStr(key, parameter[key as keyof typeof parameter])}`);
+                }
+
+                const comment = `* ${commentChunks.join(" | ")}${conditionComment ? ` | ${conditionComment}` : ""} `;
+
+                cmdElements.push(cmdElement);
+                ts.addSyntheticLeadingComment(cmdElement, ts.SyntaxKind.MultiLineCommentTrivia, comment, true);
+            } else if (
+                // @ts-expect-error bad typing?
+                existing.type?.typeName?.escapedText &&
+                // @ts-expect-error bad typing?
+                paramType.typeName?.escapedText &&
+                // @ts-expect-error bad typing?
+                existing.type.typeName.escapedText !== paramType.typeName.escapedText
+            ) {
+                // XXX: not currently used, untested
+                ts.factory.updatePropertySignature(
+                    existing,
+                    existing.modifiers,
+                    existing.name,
+                    existing.questionToken,
+                    ts.factory.createUnionTypeNode([existing.type, paramType]),
+                );
+            } else if (!parameter.conditions) {
+                throw new Error(`Two or more cluster command parameters have identical name without conditions. ${JSON.stringify(parameter)}`);
+            }
+        }
+
+        const element = ts.factory.createPropertySignature(
+            undefined,
+            commandName,
+            undefined,
+            cmdElements.length > 0 ? ts.factory.createTypeLiteralNode(cmdElements) : emptyObject,
+        );
+
+        elements.push(element);
+
+        const commentChunks: string[] = [];
+
+        for (const key in command) {
+            if (key === "parameters") {
+                continue;
+            }
+
+            commentChunks.push(`${key}=${getPropertyStr(key, command[key as keyof typeof command], 2)}`);
+        }
+
+        const comment = `* ${commentChunks.join(" | ")} `;
+
+        ts.addSyntheticLeadingComment(element, ts.SyntaxKind.MultiLineCommentTrivia, comment, true);
+    }
+
+    return elements.length > 0 ? ts.factory.createTypeLiteralNode(elements) : ts.factory.createKeywordTypeNode(ts.SyntaxKind.NeverKeyword);
+};
+
+const clusterElements: ts.TypeElement[] = [];
+
+for (const clusterName in Clusters) {
+    const cluster = Clusters[clusterName as ClusterName];
+
+    const attributesProp = ts.factory.createPropertySignature(undefined, "attributes", undefined, addAttributes(cluster.attributes));
+    const commandsProp = ts.factory.createPropertySignature(undefined, "commands", undefined, addCommands(cluster.commands));
+    const commandResponsesProp = ts.factory.createPropertySignature(undefined, "commandResponses", undefined, addCommands(cluster.commandsResponse));
+
+    clusterElements.push(
+        ts.factory.createPropertySignature(
+            undefined,
+            clusterName,
+            undefined,
+            ts.factory.createTypeLiteralNode([attributesProp, commandsProp, commandResponsesProp]),
+        ),
+    );
+}
+
+const clustersDecl = ts.factory.createInterfaceDeclaration(
+    [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+    "TClusters",
+    undefined,
+    undefined,
+    clusterElements,
+);
+
+const addParameters = (foundation: Readonly<FoundationDefinition>): ts.TypeNode => {
+    const elements: ts.PropertySignature[] = [];
+
+    for (const parameter of foundation.parameters) {
+        const element = ts.factory.createPropertySignature(
+            undefined,
+            parameter.name,
+            parameter.conditions ? ts.factory.createToken(ts.SyntaxKind.QuestionToken) : undefined,
+            getTypeFromDataType(parameter.type),
+        );
+        const conditionComment = getConditionStr(parameter.conditions);
+
+        elements.push(element);
+
+        ts.addSyntheticLeadingComment(
+            element,
+            ts.SyntaxKind.MultiLineCommentTrivia,
+            `* Type: ${DataType[parameter.type] ?? BuffaloZclDataType[parameter.type]}${conditionComment ? ` ${conditionComment}` : ""} `,
+            true,
+        );
+    }
+
+    if (elements.length === 0) {
+        return emptyObject;
+    }
+
+    switch (foundation.parseStrategy) {
+        case "repetitive": {
+            return ts.factory.createArrayTypeNode(ts.factory.createTypeLiteralNode(elements));
+        }
+        case "flat": {
+            return ts.factory.createTypeLiteralNode(elements);
+        }
+        case "oneof": {
+            if (isFoundationDiscoverRsp(foundation.ID)) {
+                const discComplete = ts.factory.createPropertySignature(
+                    undefined,
+                    "discComplete",
+                    undefined,
+                    ts.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword),
+                );
+
+                ts.addSyntheticLeadingComment(discComplete, ts.SyntaxKind.MultiLineCommentTrivia, `* Type: ${DataType[DataType.UINT8]} `, true);
+
+                return ts.factory.createTypeLiteralNode([
+                    discComplete,
+                    ts.factory.createPropertySignature(
+                        undefined,
+                        "attrInfos",
+                        undefined,
+                        ts.factory.createArrayTypeNode(ts.factory.createTypeLiteralNode(elements)),
+                    ),
+                ]);
+            }
+        }
+    }
+
+    throw new Error(`Unknown command strategy for ${JSON.stringify(foundation)}`);
+};
+
+const foundationElements: ts.TypeElement[] = [];
+const foundationRepetitiveElements: ts.TypeNode[] = [];
+const foundationFlatElements: ts.TypeNode[] = [];
+const foundationOneOfElements: ts.TypeNode[] = [];
+
+for (const foundationName in Foundation) {
+    const foundation = Foundation[foundationName as FoundationCommandName];
+    const element = ts.factory.createPropertySignature(undefined, foundationName, undefined, addParameters(foundation));
+
+    foundationElements.push(element);
+    ts.addSyntheticLeadingComment(element, ts.SyntaxKind.MultiLineCommentTrivia, `* ID: ${foundation.ID} `, true);
+
+    const stratNode = ts.factory.createTypeReferenceNode(`"${foundationName}"`);
+
+    switch (foundation.parseStrategy) {
+        case "repetitive": {
+            foundationRepetitiveElements.push(stratNode);
+            break;
+        }
+        case "flat": {
+            foundationFlatElements.push(stratNode);
+            break;
+        }
+        case "oneof": {
+            foundationOneOfElements.push(stratNode);
+            break;
+        }
+    }
+}
+
+const foundationDecl = ts.factory.createInterfaceDeclaration(
+    [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+    "TFoundation",
+    undefined,
+    undefined,
+    foundationElements,
+);
+
+const foundationRepetitiveDecl = ts.factory.createTypeAliasDeclaration(
+    [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+    "TFoundationRepetitive",
+    undefined,
+    ts.factory.createUnionTypeNode(foundationRepetitiveElements),
+);
+const foundationFlatDecl = ts.factory.createTypeAliasDeclaration(
+    [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+    "TFoundationFlat",
+    undefined,
+    ts.factory.createUnionTypeNode(foundationFlatElements),
+);
+const foundationOneOfDecl = ts.factory.createTypeAliasDeclaration(
+    [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+    "TFoundationOneOf",
+    undefined,
+    ts.factory.createUnionTypeNode(foundationOneOfElements),
+);
+const clDecl = ts.factory.createTypeParameterDeclaration(
+    undefined,
+    "Cl",
+    ts.factory.createUnionTypeNode([
+        ts.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword),
+        ts.factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword),
+    ]),
+);
+const coDecl = ts.factory.createTypeParameterDeclaration(
+    undefined,
+    "Co",
+    ts.factory.createUnionTypeNode([
+        ts.factory.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword),
+        ts.factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword),
+    ]),
+);
+const clusterAttributeKeysDecl = ts.factory.createTypeAliasDeclaration(
+    [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+    "TClusterAttributeKeys",
+    [clDecl],
+    ts.factory.createTypeReferenceNode(
+        `Cl extends keyof ${clustersDecl.name.escapedText} ? (keyof ${clustersDecl.name.escapedText}[Cl]["attributes"])[] : (string | number)[];`,
+    ),
+);
+const clusterAttributesDecl = ts.factory.createTypeAliasDeclaration(
+    [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+    "TClusterAttributes",
+    [clDecl],
+    ts.factory.createTypeReferenceNode(
+        `Cl extends keyof ${clustersDecl.name.escapedText} ? ${clustersDecl.name.escapedText}[Cl]["attributes"] : never`,
+    ),
+);
+const partialClusterAttributesDecl = ts.factory.createTypeAliasDeclaration(
+    [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+    "TPartialClusterAttributes",
+    [clDecl],
+    ts.factory.createTypeReferenceNode(
+        `Cl extends keyof ${clustersDecl.name.escapedText} ? Partial<${clustersDecl.name.escapedText}[Cl]["attributes"]> : never`,
+    ),
+);
+const clusterCommandKeysDecl = ts.factory.createTypeAliasDeclaration(
+    [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+    "TClusterCommandKeys",
+    [clDecl],
+    ts.factory.createTypeReferenceNode(
+        `Cl extends keyof ${clustersDecl.name.escapedText} ? (keyof ${clustersDecl.name.escapedText}[Cl]["commands"])[] : (string | number)[];`,
+    ),
+);
+const clusterCommandResponseKeysDecl = ts.factory.createTypeAliasDeclaration(
+    [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+    "TClusterCommandResponseKeys",
+    [clDecl],
+    ts.factory.createTypeReferenceNode(
+        `Cl extends keyof ${clustersDecl.name.escapedText} ? (keyof ${clustersDecl.name.escapedText}[Cl]["commandResponses"])[] : (string | number)[];`,
+    ),
+);
+const clusterCommandsDecl = ts.factory.createTypeAliasDeclaration(
+    [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+    "TClusterCommands",
+    [clDecl],
+    ts.factory.createTypeReferenceNode(
+        `Cl extends keyof ${clustersDecl.name.escapedText} ? ${clustersDecl.name.escapedText}[Cl]["commands"] : never`,
+    ),
+);
+const clusterCommandResponsesDecl = ts.factory.createTypeAliasDeclaration(
+    [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+    "TClusterCommandResponses",
+    [clDecl],
+    ts.factory.createTypeReferenceNode(
+        `Cl extends keyof ${clustersDecl.name.escapedText} ? ${clustersDecl.name.escapedText}[Cl]["commandResponses"] : never`,
+    ),
+);
+const clusterCommandPayloadDecl = ts.factory.createTypeAliasDeclaration(
+    [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+    "TClusterCommandPayload",
+    [clDecl, coDecl],
+    ts.factory.createTypeReferenceNode(
+        `Cl extends keyof ${clustersDecl.name.escapedText} ? Co extends keyof ${clustersDecl.name.escapedText}[Cl]["commands"] ? ${clustersDecl.name.escapedText}[Cl]["commands"][Co] : never : never;`,
+    ),
+);
+const clusterCommandResponsePayloadDecl = ts.factory.createTypeAliasDeclaration(
+    [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+    "TClusterCommandResponsePayload",
+    [clDecl, coDecl],
+    ts.factory.createTypeReferenceNode(
+        `Cl extends keyof ${clustersDecl.name.escapedText} ? Co extends keyof ${clustersDecl.name.escapedText}[Cl]["commandResponses"] ? ${clustersDecl.name.escapedText}[Cl]["commandResponses"][Co] : never : never;`,
+    ),
+);
+const clusterPayloadDecl = ts.factory.createTypeAliasDeclaration(
+    [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+    "TClusterPayload",
+    [clDecl, coDecl],
+    ts.factory.createTypeReferenceNode(
+        `Cl extends keyof ${clustersDecl.name.escapedText} ? ${clustersDecl.name.escapedText}[Cl]["commands"] extends never ? ${clustersDecl.name.escapedText}[Cl]["commandResponses"] extends never ? never : Co extends keyof ${clustersDecl.name.escapedText}[Cl]["commandResponses"] ? ${clustersDecl.name.escapedText}[Cl]["commandResponses"][Co] : never : Co extends keyof ${clustersDecl.name.escapedText}[Cl]["commands"] ? ${clustersDecl.name.escapedText}[Cl]["commands"][Co] : Co extends keyof ${clustersDecl.name.escapedText}[Cl]["commandResponses"] ? ${clustersDecl.name.escapedText}[Cl]["commandResponses"][Co] : never : never;`,
+    ),
+);
+const foundationGenericPayloadDecl = ts.factory.createTypeAliasDeclaration(
+    [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+    "TFoundationGenericPayload",
+    undefined,
+    ts.factory.createTypeReferenceNode(`${foundationDecl.name.escapedText}[keyof ${foundationDecl.name.escapedText}]`),
+);
+const foundationRepetitivePayloadDecl = ts.factory.createTypeAliasDeclaration(
+    [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+    "TFoundationRepetitivePayload",
+    undefined,
+    ts.factory.createTypeReferenceNode(`${foundationDecl.name.escapedText}[${foundationRepetitiveDecl.name.escapedText}]`),
+);
+const foundationFlatPayloadDecl = ts.factory.createTypeAliasDeclaration(
+    [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+    "TFoundationFlatPayload",
+    undefined,
+    ts.factory.createTypeReferenceNode(`${foundationDecl.name.escapedText}[${foundationFlatDecl.name.escapedText}]`),
+);
+const foundationOneOfPayloadDecl = ts.factory.createTypeAliasDeclaration(
+    [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+    "TFoundationOneOfPayload",
+    undefined,
+    ts.factory.createTypeReferenceNode(`${foundationDecl.name.escapedText}[${foundationOneOfDecl.name.escapedText}]`),
+);
+const foundationPayloadDecl = ts.factory.createTypeAliasDeclaration(
+    [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+    "TFoundationPayload",
+    [coDecl],
+    ts.factory.createTypeReferenceNode(
+        `Co extends keyof ${foundationDecl.name.escapedText} ? ${foundationDecl.name.escapedText}[Co] : ${foundationGenericPayloadDecl.name.escapedText}`,
+    ),
+);
+
+const result = `${printer.printNode(ts.EmitHint.Unspecified, namedImports, file)}
+
+${printer.printNode(ts.EmitHint.Unspecified, clustersDecl, file)}
+
+${printer.printNode(ts.EmitHint.Unspecified, foundationDecl, file)}
+
+${printer.printNode(ts.EmitHint.Unspecified, foundationRepetitiveDecl, file)}
+${printer.printNode(ts.EmitHint.Unspecified, foundationFlatDecl, file)}
+${printer.printNode(ts.EmitHint.Unspecified, foundationOneOfDecl, file)}
+
+// Clusters
+${printer.printNode(ts.EmitHint.Unspecified, clusterAttributeKeysDecl, file)}
+
+${printer.printNode(ts.EmitHint.Unspecified, clusterAttributesDecl, file)}
+
+${printer.printNode(ts.EmitHint.Unspecified, partialClusterAttributesDecl, file)}
+
+${printer.printNode(ts.EmitHint.Unspecified, clusterCommandKeysDecl, file)}
+
+${printer.printNode(ts.EmitHint.Unspecified, clusterCommandResponseKeysDecl, file)}
+
+${printer.printNode(ts.EmitHint.Unspecified, clusterCommandsDecl, file)}
+
+${printer.printNode(ts.EmitHint.Unspecified, clusterCommandResponsesDecl, file)}
+
+${printer.printNode(ts.EmitHint.Unspecified, clusterCommandPayloadDecl, file)}
+
+${printer.printNode(ts.EmitHint.Unspecified, clusterCommandResponsePayloadDecl, file)}
+
+${printer.printNode(ts.EmitHint.Unspecified, clusterPayloadDecl, file)}
+
+// Foundation
+${printer.printNode(ts.EmitHint.Unspecified, foundationGenericPayloadDecl, file)}
+${printer.printNode(ts.EmitHint.Unspecified, foundationRepetitivePayloadDecl, file)}
+${printer.printNode(ts.EmitHint.Unspecified, foundationFlatPayloadDecl, file)}
+${printer.printNode(ts.EmitHint.Unspecified, foundationOneOfPayloadDecl, file)}
+
+${printer.printNode(ts.EmitHint.Unspecified, foundationPayloadDecl, file)}
+`;
+
+writeFileSync(`./src/zspec/zcl/definition/${FILENAME}`, result, {encoding: "utf8"});

package/scripts/utils.ts

@@ -0,0 +1,88 @@
+/**
+ * Scores a string against a pattern for fuzzy matching.
+ *
+ * The score is higher for more accurate matches. A score of 0 indicates no match.
+ *
+ * Scoring logic:
+ * - A bonus is awarded for each matched character.
+ * - A bonus is awarded for consecutive matched characters (a "combo").
+ * - A large bonus is given if a character matches the beginning of a word (e.g., 'U' in "someUtils" or 's' in "some_utils").
+ * - A bonus is given for matching character case.
+ * - A penalty is applied for each character in the target string that is skipped.
+ *
+ * @param pattern The pattern to search for (e.g., "mtHandS").
+ * @param str The string to score against the pattern (e.g., "moveToHueAndSaturation").
+ * @returns The match score, or 0 if there is no match.
+ */
+export function fuzzyMatch(pattern: string, str: string): number {
+    if (pattern.length === 0) {
+        return 1; // Or some other value indicating a trivial match
+    }
+
+    if (str.length === 0) {
+        return 0;
+    }
+
+    let score = 0;
+    let patternIndex = 0;
+    let strIndex = 0;
+    let lastMatchIndex = -1;
+    let inCombo = false;
+
+    const SCORE_MATCH = 10;
+    const SCORE_COMBO = 15;
+    const SCORE_WORD_START = 20;
+    const SCORE_CASE_MATCH = 5;
+    const PENALTY_SKIP = -1;
+
+    while (strIndex < str.length && patternIndex < pattern.length) {
+        const patternChar = pattern[patternIndex];
+        const strChar = str[strIndex];
+
+        if (patternChar.toLowerCase() === strChar.toLowerCase()) {
+            score += SCORE_MATCH;
+
+            // Bonus for case-sensitive match
+            if (patternChar === strChar) {
+                score += SCORE_CASE_MATCH;
+            }
+
+            // Bonus for being a word start
+            const prevStrChar = strIndex > 0 ? str[strIndex - 1] : " ";
+            const isWordStart =
+                (prevStrChar === "_" || prevStrChar === " " || (prevStrChar.toLowerCase() === prevStrChar && strChar.toUpperCase() === strChar)) &&
+                strChar.toLowerCase() !== strChar;
+            if (isWordStart) {
+                score += SCORE_WORD_START;
+            }
+
+            // Bonus for consecutive matches
+            if (lastMatchIndex === strIndex - 1) {
+                if (inCombo) {
+                    score += SCORE_COMBO;
+                } else {
+                    inCombo = true;
+                }
+            } else {
+                inCombo = false;
+            }
+
+            lastMatchIndex = strIndex;
+            patternIndex += 1;
+        } else {
+            score += PENALTY_SKIP;
+        }
+
+        strIndex += 1;
+    }
+
+    // If the entire pattern was not found, it's not a match.
+    if (patternIndex !== pattern.length) {
+        return 0;
+    }
+
+    // Normalize score against the length of the string to penalize longer, less-specific matches.
+    const finalScore = score / str.length;
+
+    return finalScore > 0 ? finalScore : 0;
+}