zwave-js / zwave-js-ui / 22727422046

18%

push

github

feat(ui): validate number inputs against allowed values from config (#4566)

## Implementation Plan: Add Support for Configuration Value `allowed`
Field

### Understanding
- Z-Wave JS now supports `allowed` field in ValueMetadataNumeric for
defining specific allowed values (ranges with gaps)
- The `allowed` field is an array of `AllowedValue` objects: `{ value:
number } | { from: number, to: number, step?: number }`

### Changes Required

- [x] Explore codebase and understand current validation implementation
- [x] Add `allowed` field to `ZUIValueId` TypeScript type in backend
(`api/lib/ZwaveClient.ts`)
- [x] Update `_updateValueMetadata()` to pass `allowed` field from
Z-Wave JS metadata to frontend
- [x] Update `ValueId.vue` component to validate against `allowed`
values when present
- [x] Update validation logic to prioritize `allowed` over `min`/`max`
when both exist
- [x] Update error messages to reflect allowed values validation
- [x] Extract helper method to reduce code duplication (code review
feedback)
- [x] Add JSDoc documentation to new methods (code review feedback)
- [x] Fix validation for combobox inputs with `allowManualEntry` (issue
#4561 comment)
- [x] **Coerce value to number in `isValueAllowed()` and
`numberOutOfRange()` to handle string inputs from v-combobox** (PR
review feedback)
- [x] Run linting and tests (all pass)

### Files Modified
1. `api/lib/ZwaveClient.ts` - Added `allowed` field to `ZUIValueId` type
and pass it from metadata
2. `src/components/ValueId.vue` - Updated validation logic with number
coercion to handle string inputs from v-combobox

<!-- START COPILOT ORIGINAL PROMPT -->



<details>

<summary>Original prompt</summary>

> 
> ----
> 
> *This section details on the original issue you should resolve*
> 
> <issue_title>feat(ui): validate number inputs against allowed from
config</issue_title>
> <issue_description>**Is your feature request related to a problem?
Please describe.**
> After zwave-js/zwave-js-ui#4288 w... (continued)

334 of 444 branches covered (75.23%)

Branch coverage included in aggregate %.

0 of 3 new or added lines in 1 file covered. (0.0%)

4054 of 23519 relevant lines covered (17.24%)

1.07 hits per line