Clamp numeric values to reguired validation constraints or allowed range

Author: unematiii

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@highmobility/auto-api-javascript",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "Auto API for JavaScript - the parsing library for the Auto API vehicle data model",
   "main": "lib/index.js",
   "module": "es/index.js",

package.json

@@ -54,6 +54,11 @@ export interface MeasurementType {
 
 export type MeasurementTypes = MeasurementType[];
 
+export interface NumericRange {
+  min: number;
+  max: number;
+}
+
 export interface Property extends Omit<TypeDefinition, 'items'> {
   id: number;
   added?: number;

src/types.ts

@@ -81,6 +81,10 @@ export function bytesWithSize(bytes: number[]) {
   return [...intToTwoBytes(bytes.length), ...bytes];
 }
 
+export function clamp(value: number, min: number, max: number) {
+  return Math.max(Math.min(value, max), min);
+}
+
 export function decimalToHexArray(value: number | string, bytes = 1) {
   let hex = intToHex(typeof value === 'string' ? parseInt(value, 10) : value);
 
@@ -91,6 +95,13 @@ export function decimalToHexArray(value: number | string, bytes = 1) {
   return hex.match(/.{1,2}/g)!.map((hexItem) => Number(`0x${hexItem}`));
 }
 
+export function getNumericInputRange(size = 1, unsigned?: boolean) {
+  return {
+    min: unsigned ? 0 : -1 * Math.pow(2, size * 8 - 1),
+    max: Math.pow(2, size * 8 - (unsigned ? 0 : 1)) - 1,
+  };
+}
+
 export function hexArrayToHex(hexArray: number[]) {
   return hexArray.reduce((memo, i) => memo + intToHex(i).padStart(2, '0'), '');
 }

src/utils/encoding.ts

@@ -12,8 +12,7 @@ export class DoubleValue extends FloatValue {
   }
 
   public decode(bytes: number[]) {
-    this._value = ieee754DoubleToBase10(bytes, this.size);
-    return this;
+    return this.setValue(ieee754DoubleToBase10(bytes, this.size));
   }
 
   public toString() {

src/values/DoubleValue.ts

@@ -2,19 +2,26 @@ import { TypeDefinition } from '../types';
 
 import { FormatError } from '../core/Error';
 import { NamedEntity } from '../core/NamedEntity';
-import { Value } from '../core/Value';
 
-import { base10ToIeee754, ieee754ToBase10, isNumber } from '../utils';
+import { base10ToIeee754, getNumericInputRange, ieee754ToBase10, isNumber } from '../utils';
 
-export class FloatValue extends Value<number> implements NamedEntity {
-  public constructor(public readonly definition: Readonly<Pick<TypeDefinition, 'name' | 'size'>>) {
-    super();
+import { NumericValue } from './NumericValue';
+
+export class FloatValue extends NumericValue implements NamedEntity {
+  public constructor(
+    public readonly definition: Readonly<Pick<TypeDefinition, 'name' | 'size' | 'validation'>>,
+  ) {
+    super(definition);
   }
 
   public get name() {
     return this.definition.name;
   }
 
+  public get range() {
+    return getNumericInputRange(this.size);
+  }
+
   public get size() {
     return this.definition.size || 4;
   }
@@ -24,8 +31,7 @@ export class FloatValue extends Value<number> implements NamedEntity {
   }
 
   public decode(bytes: number[]) {
-    this._value = ieee754ToBase10(bytes, this.size);
-    return this;
+    return this.setValue(ieee754ToBase10(bytes, this.size));
   }
 
   public fromJSON(payload: unknown) {
@@ -38,11 +44,6 @@ export class FloatValue extends Value<number> implements NamedEntity {
     return this;
   }
 
-  public setValue(value: number) {
-    this._value = value;
-    return this;
-  }
-
   public toString() {
     return (this._value ?? NaN).toPrecision(7);
   }

src/values/FloatValue.ts

@@ -2,19 +2,26 @@ import { TypeDefinition } from '../types';
 
 import { FormatError } from '../core/Error';
 import { NamedEntity } from '../core/NamedEntity';
-import { Value } from '../core/Value';
 
-import { bytesToInt, decimalToHexArray, isInteger } from '../utils';
+import { bytesToInt, decimalToHexArray, getNumericInputRange, isInteger } from '../utils';
 
-export class IntegerValue extends Value<number> implements NamedEntity {
-  public constructor(public readonly definition: Readonly<Pick<TypeDefinition, 'name' | 'size'>>) {
-    super();
+import { NumericValue } from './NumericValue';
+
+export class IntegerValue extends NumericValue implements NamedEntity {
+  public constructor(
+    public readonly definition: Readonly<Pick<TypeDefinition, 'name' | 'size' | 'validation'>>,
+  ) {
+    super(definition);
   }
 
   public get name() {
     return this.definition.name;
   }
 
+  public get range() {
+    return getNumericInputRange(this.size);
+  }
+
   public get size() {
     return this.definition.size || 1;
   }
@@ -24,8 +31,7 @@ export class IntegerValue extends Value<number> implements NamedEntity {
   }
 
   public decode(bytes: number[]) {
-    this._value = bytesToInt(bytes);
-    return this;
+    return this.setValue(bytesToInt(bytes));
   }
 
   public fromJSON(payload: unknown) {
@@ -38,11 +44,6 @@ export class IntegerValue extends Value<number> implements NamedEntity {
     return this;
   }
 
-  public setValue(value: number) {
-    this._value = value;
-    return this;
-  }
-
   public valueOf() {
     return this._value ?? null;
   }

src/values/IntegerValue.ts

@@ -0,0 +1,38 @@
+import { NumericRange, TypeDefinition } from '../types';
+
+import { Value } from '../core/Value';
+
+import { clamp } from '../utils';
+
+export abstract class NumericValue extends Value<number> {
+  public constructor(public readonly definition: Readonly<Pick<TypeDefinition, 'validation'>>) {
+    super();
+  }
+
+  public abstract get range(): NumericRange;
+
+  public get validation(): NumericRange | undefined {
+    const { validation } = this.definition;
+
+    if (validation) {
+      const match = validation.match(/min:(.*)\|max:(.*)/);
+      if (match) {
+        return {
+          min: Number(match[1]),
+          max: Number(match[2]),
+        };
+      }
+    }
+  }
+
+  public clamp(value: number) {
+    const { min, max } = this.validation || this.range;
+
+    return clamp(value, min, max);
+  }
+
+  public setValue(value: number) {
+    this._value = this.clamp(value);
+    return this;
+  }
+}

src/values/NumericValue.ts

@@ -1,3 +1,9 @@
+import { getNumericInputRange } from '../utils';
+
 import { IntegerValue } from './IntegerValue';
 
-export class UintValue extends IntegerValue {}
+export class UintValue extends IntegerValue {
+  public get range() {
+    return getNumericInputRange(this.size, true);
+  }
+}