Unifies value constructors and implements NamedEntity for all values

Author: unematiii

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@highmobility/auto-api-javascript",
-  "version": "1.0.0",
+  "version": "1.1.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

@@ -43,7 +43,7 @@ const ValueConstructors: Partial<Record<TypeDefinitionType | string, ValueConstr
 
 export class ValueFactory {
   public static createFromDefinition(definition: TypeDefinition): InstanceType<ValueConstructor> {
-    const { customType, event, size, type, unitType } = definition;
+    const { customType, event, type, unitType } = definition;
 
     if (customType || event) {
       return ValueFactory.createFromDefinition(Configuration.getTypeDefinitionFromRef(definition));
@@ -58,16 +58,14 @@ export class ValueFactory {
     switch (ValueConstructor) {
       case CustomValue:
       case EnumValue:
-        return new ValueConstructor(definition);
       case DoubleValue:
       case FloatValue:
       case IntegerValue:
       case UintValue:
-        return new (ValueConstructor as NumericValueConstructor)(size);
       case BytesValue:
       case StringValue:
       case TimestampValue:
-        return new ValueConstructor();
+        return new ValueConstructor(definition);
       default:
         throw new Error(`Unknown value type: ${type}`);
     }

src/factories/ValueFactory.ts

@@ -24,7 +24,7 @@ export const base64ToByteArray = (base64String: string) =>
   (atob(base64String) || '').split('').map((c) => c.charCodeAt(0));
 
 export const byteArrayToBase64 = (byteArray: number[]) =>
-  btoa(String.fromCharCode.apply(null, byteArray));
+  btoa(String.fromCharCode.apply(null, byteArray)) || '';
 
 export function bytesToChunk(
   bytes: number[],

src/utils/encoding.ts

@@ -1,9 +1,20 @@
+import { TypeDefinition } from '../types';
+
 import { FormatError } from '../core/Error';
+import { NamedEntity } from '../core/NamedEntity';
 import { Value } from '../core/Value';
 
 import { isArrayOfNumbers } from '../utils';
 
-export class BytesValue extends Value<number[]> {
+export class BytesValue extends Value<number[]> implements NamedEntity {
+  public constructor(public readonly definition: Readonly<Pick<TypeDefinition, 'name' | 'size'>>) {
+    super();
+  }
+
+  public get name() {
+    return this.definition.name;
+  }
+
   public encode() {
     return [...this.getValueForEncoding()];
   }

src/values/BytesValue.ts

@@ -3,8 +3,8 @@ import { base10ToIeee754Double, ieee754DoubleToBase10 } from '../utils';
 import { FloatValue } from './FloatValue';
 
 export class DoubleValue extends FloatValue {
-  public constructor(public readonly size = 8) {
-    super(size);
+  public get size() {
+    return this.definition.size || 8;
   }
 
   public encode() {

src/values/DoubleValue.ts

@@ -1,13 +1,24 @@
+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';
 
-export class FloatValue extends Value<number> {
-  public constructor(public readonly size = 4) {
+export class FloatValue extends Value<number> implements NamedEntity {
+  public constructor(public readonly definition: Readonly<Pick<TypeDefinition, 'name' | 'size'>>) {
     super();
   }
 
+  public get name() {
+    return this.definition.name;
+  }
+
+  public get size() {
+    return this.definition.size || 4;
+  }
+
   public encode() {
     return base10ToIeee754(this.getValueForEncoding(), this.size);
   }

src/values/FloatValue.ts

@@ -1,13 +1,24 @@
+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';
 
-export class IntegerValue extends Value<number> {
-  public constructor(public readonly size = 1) {
+export class IntegerValue extends Value<number> implements NamedEntity {
+  public constructor(public readonly definition: Readonly<Pick<TypeDefinition, 'name' | 'size'>>) {
     super();
   }
 
+  public get name() {
+    return this.definition.name;
+  }
+
+  public get size() {
+    return this.definition.size || 1;
+  }
+
   public encode() {
     return decimalToHexArray(this.getValueForEncoding(), this.size);
   }

src/values/IntegerValue.ts

@@ -1,9 +1,20 @@
+import { TypeDefinition } from '../types';
+
 import { FormatError } from '../core/Error';
+import { NamedEntity } from '../core/NamedEntity';
 import { Value } from '../core/Value';
 
 import { isString, utfStringToByteArray } from '../utils';
 
-export class StringValue extends Value<string> {
+export class StringValue extends Value<string> implements NamedEntity {
+  public constructor(public readonly definition: Readonly<Pick<TypeDefinition, 'name' | 'size'>>) {
+    super();
+  }
+
+  public get name() {
+    return this.definition.name;
+  }
+
   public encode() {
     return utfStringToByteArray(this.getValueForEncoding());
   }

src/values/StringValue.ts

@@ -1,14 +1,24 @@
+import { TypeDefinition } from '../types';
+
 import { FormatError } from '../core/Error';
+import { NamedEntity } from '../core/NamedEntity';
 import { Value } from '../core/Value';
 
 import { bytesToInt, decimalToHexArray, isString } from '../utils';
 
-export class TimestampValue extends Value<Date, Date | string> {
-  public constructor(value = new Date()) {
+export class TimestampValue extends Value<Date, Date | string> implements NamedEntity {
+  public constructor(
+    public readonly definition: Readonly<Pick<TypeDefinition, 'name' | 'size'>>,
+    value = new Date(),
+  ) {
     super();
     this.setValue(value);
   }
 
+  public get name() {
+    return this.definition.name;
+  }
+
   public encode() {
     return [...decimalToHexArray(this.getValueForEncoding().getTime(), 8)];
   }

src/values/TimestampValue.ts

@@ -1,7 +1,3 @@
 import { IntegerValue } from './IntegerValue';
 
-export class UintValue extends IntegerValue {
-  public constructor(public readonly size = 1) {
-    super(size);
-  }
-}
+export class UintValue extends IntegerValue {}

src/values/UintValue.ts

@@ -51,7 +51,7 @@ export class UnitValue extends Value<UnitValueData, UnitValueDataSetter> impleme
     const [, unitId, ...valueBytes] = bytes;
 
     const unit = this.getUnitDefinition('id', unitId);
-    const value = new DoubleValue(UnitValue.ValueSize).decode(valueBytes);
+    const value = this.createDoubleValue().decode(valueBytes);
 
     this._value = {
       unit,
@@ -112,7 +112,7 @@ export class UnitValue extends Value<UnitValueData, UnitValueDataSetter> impleme
           ? this.getUnitDefinition('name', unitIdentifier)
           : this.getUnitDefinition('id', unitIdentifier)
         : currentUnit || this.getFirstUnitDefinition();
-    const value = (currentValue || new DoubleValue(UnitValue.ValueSize)).setValue(valueInUnits);
+    const value = (currentValue || this.createDoubleValue()).setValue(valueInUnits);
 
     this._value = {
       unit,
@@ -133,4 +133,11 @@ export class UnitValue extends Value<UnitValueData, UnitValueDataSetter> impleme
 
     return null;
   }
+
+  protected createDoubleValue() {
+    return new DoubleValue({
+      name: this.name,
+      size: UnitValue.ValueSize,
+    });
+  }
 }