Export types#181
Merged
Merged
Conversation
RobinBol
requested changes
Apr 16, 2026
RobinBol
reviewed
Apr 16, 2026
Several metering cluster attributes were declared with empty enum8 placeholders marked TODO. Comment them out until proper enum values are defined, and regenerate type definitions.
Align casing with the rest of the codebase: "Zigbee" is the project's spelling for the protocol name. Updates both the generated `index.d.ts` and the `scripts/template.d.ts.txt` source it is rendered from.
Introduce `ZCLNodeInput` describing what the `ZCLNode` constructor actually reads from its argument: a required `sendFrame` and an optional `endpointDescriptors` array. The previous typing forced callers to also provide `handleFrame`, even though the constructor overwrites that slot, which made directly-constructed `ZCLNode` inputs unnecessarily painful to type. The full bidirectional `ZigbeeNode` interface is kept for callers that model the real Homey-provided node.
Local TypeScript scratch file used to validate the exported types against a small consumer. Not part of the library output.
This reverts commit 5d50bb3.
`ZCLNode` exposes `handleFrame` at runtime (see `lib/Node.js`), but the published types omitted it, forcing callers that route frames manually (e.g. inter-PAN handlers) to cast. Add the declaration so the public API matches the runtime.
The base `Cluster<Attributes, Commands>` required both generics, so callers wanting a "cluster of any shape" had to spell out `Cluster<types.AttributeDefinitions, types.CommandDefinitions>` or introduce a local alias. Concrete cluster classes (e.g. `BasicCluster`) already default their generics to their own attribute/command definitions, so the base class was the odd one out. Default the generics on the base class to their constraint types, matching the pattern used by the concrete subclasses and letting callers write a plain `Cluster` again.
…tatic These properties are stored on the class (via Cluster.addCluster) at runtime, not on the instance. The previous declarations as instance properties caused runtime undefined errors when consumers accessed cluster.attributes etc.
Collaborator
|
@JELoohuis I made some changes that follow from trying to update node-zigbee-clusters in node-zigbee. |
The bound command methods present at runtime, such as `move` for a bound LevelControl cluster, could not be added due to TypeScript not allowing for dynamic types on classes. They were only added in a separate interface as to not hinder developers.
Contributor
Author
|
Looks good to me. 👍 |
Collaborator
Could you merge this PR so we can check lint/test in CI? JELoohuis#1 |
Contributor
Author
|
I installed the @athombv/data-types from the npm registry to fix the remaining pipeline errors. I don't know why the GitHub registry has these access issues, but you may want to change that back once it is fixed, if the GitHub registry is preferred. |
This was referenced May 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Depends on athombv/node-data-types#42
Some of the generated types were incomplete, so I rewrote the generation to document more of the properties available at runtime, as well as adding some additional types based on the JS sources and runtime introspection.
I enabled type checking for the definition file and added the SDK types, since these are used by the ZCLNode.
Some broken enum8 attributes in the Metering cluster definition, where the function was not properly called, were also fixed.