1.3.0 (#318)

unematiii · web-flow · commit 69605701e1f7 · 2023-02-10T18:26:58.000+02:00
* Add AutoAPI L13.2 changes
* Upgrade dependencies
* Implement Property tags
diff --git a/auto-api b/auto-api
@@ -1 +1 @@
-Subproject commit e13baf081036cc91b7b54f80078f4c63046beb9b
+Subproject commit ec1071306b03869a891061d8378c82dd3b3adf38
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@highmobility/auto-api-javascript",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "Auto API for JavaScript - the parsing library for the Auto API vehicle data model",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -38,33 +38,33 @@
     "@tsconfig/node14": "^1.0.3",
     "@types/lodash.clonedeep": "^4.5.7",
     "@types/lodash.get": "^4.4.7",
-    "@types/node": "^18.7.1",
+    "@types/node": "^18.13.0",
     "@types/yamljs": "^0.2.31",
-    "@typescript-eslint/eslint-plugin": "^5.33.0",
-    "@typescript-eslint/parser": "^5.33.0",
-    "eslint": "^8.21.0",
-    "eslint-config-prettier": "^8.5.0",
+    "@typescript-eslint/eslint-plugin": "^5.51.0",
+    "@typescript-eslint/parser": "^5.51.0",
+    "eslint": "^8.33.0",
+    "eslint-config-prettier": "^8.6.0",
     "eslint-import-resolver-alias": "^1.1.2",
-    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-prettier": "^4.2.1",
-    "husky": "^8.0.1",
-    "jest": "^28.1.3",
-    "lint-staged": "^13.0.3",
+    "husky": "^8.0.3",
+    "jest": "^29.4.2",
+    "lint-staged": "^13.1.1",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.7.1",
-    "rimraf": "^3.0.2",
-    "ts-jest": "^28.0.7",
+    "prettier": "^2.8.4",
+    "rimraf": "^4.1.2",
+    "ts-jest": "^29.0.5",
     "ts-node": "^10.9.1",
-    "tsconfig-paths": "^4.1.0",
-    "typescript": "^4.7.4",
+    "tsconfig-paths": "^4.1.2",
+    "typescript": "^4.9.5",
     "yamljs": "^0.3.0"
   },
   "dependencies": {
     "abab": "^2.0.6",
     "ieee754": "^1.2.1",
     "lodash.clonedeep": "^4.5.0",
     "lodash.get": "^4.4.2",
-    "tslib": "^2.4.0"
+    "tslib": "^2.5.0"
   },
   "husky": {
     "hooks": {
diff --git a/scripts/generate-capabilities.ts b/scripts/generate-capabilities.ts
@@ -60,7 +60,6 @@ function createConstructorDeclaration(className: string) {
 
 function createIdentifierDeclaration({ identifier }: Capability) {
   return ts.factory.createPropertyDeclaration(
-    undefined,
     [
       ts.factory.createModifier(ts.SyntaxKind.StaticKeyword),
       ts.factory.createModifier(ts.SyntaxKind.ReadonlyKeyword),
@@ -86,7 +85,6 @@ function createIdentifierDeclaration({ identifier }: Capability) {
 
 function createNameDeclaration(name: string) {
   return ts.factory.createPropertyDeclaration(
-    undefined,
     [
       ts.factory.createModifier(ts.SyntaxKind.StaticKeyword),
       ts.factory.createModifier(ts.SyntaxKind.ReadonlyKeyword),
@@ -100,7 +98,6 @@ function createNameDeclaration(name: string) {
 
 function createPropertiesDeclaration() {
   return ts.factory.createPropertyDeclaration(
-    undefined,
     [
       ts.factory.createModifier(ts.SyntaxKind.StaticKeyword),
       ts.factory.createModifier(ts.SyntaxKind.ReadonlyKeyword),
@@ -118,7 +115,6 @@ function createPropertiesEnumDeclaration(
   exportDeclaration = false,
 ) {
   return ts.factory.createEnumDeclaration(
-    undefined,
     exportDeclaration ? [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)] : undefined,
     ts.factory.createIdentifier(token),
     properties
@@ -135,7 +131,6 @@ function createPropertiesEnumDeclaration(
 
 function createCapabilityClassDefinition(className: string, capability: Capability) {
   return ts.factory.createClassDeclaration(
-    undefined,
     [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
     className,
     undefined,
@@ -163,7 +158,6 @@ function createCapabilityClassDefinition(className: string, capability: Capabili
 
 function createCapabilityClassTypeDefinition(classNames: string[]) {
   return ts.factory.createTypeAliasDeclaration(
-    undefined,
     [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
     ts.factory.createIdentifier(ClassTypeIdentifier),
     undefined,
diff --git a/scripts/generate-configuration.ts b/scripts/generate-configuration.ts
@@ -51,6 +51,7 @@ export const getPropertyIdentityKey = (capabilityName: string) => (propertyName:
         case 'park_assists':
           return 'location';
       }
+      break;
 
     case 'charging':
       switch (propertyName) {
@@ -59,6 +60,7 @@ export const getPropertyIdentityKey = (capabilityName: string) => (propertyName:
         case 'reduction_times':
           return 'start_stop';
       }
+      break;
 
     case 'chassis_settings':
       switch (propertyName) {
@@ -67,18 +69,21 @@ export const getPropertyIdentityKey = (capabilityName: string) => (propertyName:
         case 'minimum_spring_rates':
           return 'axle';
       }
+      break;
 
     case 'climate':
       switch (propertyName) {
         case 'hvac_weekday_starting_times':
           return 'weekday';
       }
+      break;
 
     case 'crash':
       switch (propertyName) {
         case 'incidents':
           return 'location';
       }
+      break;
 
     case 'dashboard_lights':
       switch (propertyName) {
@@ -87,6 +92,7 @@ export const getPropertyIdentityKey = (capabilityName: string) => (propertyName:
         case 'dashboard_lights':
           return 'name';
       }
+      break;
 
     case 'diagnostics':
       switch (propertyName) {
@@ -101,6 +107,7 @@ export const getPropertyIdentityKey = (capabilityName: string) => (propertyName:
         case 'wheel_rpms':
           return 'location';
       }
+      break;
 
     case 'doors':
       switch (propertyName) {
@@ -109,6 +116,7 @@ export const getPropertyIdentityKey = (capabilityName: string) => (propertyName:
         case 'positions':
           return 'location';
       }
+      break;
 
     case 'lights':
       switch (propertyName) {
@@ -117,6 +125,7 @@ export const getPropertyIdentityKey = (capabilityName: string) => (propertyName:
         case 'reading_lamps':
           return 'location';
       }
+      break;
 
     case 'maintenance':
       switch (propertyName) {
@@ -125,6 +134,7 @@ export const getPropertyIdentityKey = (capabilityName: string) => (propertyName:
         case 'brakes_service_statuses':
           return 'axle';
       }
+      break;
 
     case 'race':
       switch (propertyName) {
@@ -133,13 +143,15 @@ export const getPropertyIdentityKey = (capabilityName: string) => (propertyName:
         case 'brake_torque_vectorings':
           return 'axle';
       }
+      break;
 
     case 'seats':
       switch (propertyName) {
         case 'persons_detected':
         case 'seatbelts_state':
           return 'location';
       }
+      break;
 
     case 'tachograph':
       switch (propertyName) {
@@ -148,6 +160,7 @@ export const getPropertyIdentityKey = (capabilityName: string) => (propertyName:
         case 'drivers_time_states':
           return 'driver_number';
       }
+      break;
 
     case 'trips':
       switch (propertyName) {
@@ -156,20 +169,26 @@ export const getPropertyIdentityKey = (capabilityName: string) => (propertyName:
         case 'thresholds':
           return 'type';
       }
+      break;
 
     case 'usage':
       switch (propertyName) {
+        case 'acceleration_durations':
+          return 'direction';
+
         case 'driving_modes_activation_periods':
         case 'driving_modes_energy_consumptions':
           return 'driving_mode';
       }
+      break;
 
     case 'windows':
       switch (propertyName) {
         case 'open_percentages':
         case 'positions':
           return 'location';
       }
+      break;
   }
 };
 
diff --git a/scripts/generate-property-components.ts b/scripts/generate-property-components.ts
@@ -45,7 +45,6 @@ function createConstructorDeclaration({ name }: PropertyComponent) {
     ],
     [
       ts.factory.createParameterDeclaration(
-        undefined,
         [
           ts.factory.createModifier(ts.SyntaxKind.PublicKeyword),
           ts.factory.createModifier(ts.SyntaxKind.ReadonlyKeyword),
@@ -67,7 +66,6 @@ function createConstructorDeclaration({ name }: PropertyComponent) {
 
 function createDataComponentValueTypeDefinitionOverride() {
   return ts.factory.createMethodDeclaration(
-    undefined,
     [ts.factory.createModifier(ts.SyntaxKind.ProtectedKeyword)],
     undefined,
     ts.factory.createIdentifier('getValueTypeDefinition'),
@@ -91,7 +89,6 @@ function createDataComponentValueTypeDefinitionOverride() {
 
 function createPropertyComponentClassDefinition(className: string, component: PropertyComponent) {
   return ts.factory.createClassDeclaration(
-    undefined,
     [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
     className,
     undefined,
@@ -112,7 +109,6 @@ function createPropertyComponentClassDefinition(className: string, component: Pr
 
 function createPropertyComponentNameDeclaration(components: PropertyComponents) {
   return ts.factory.createTypeAliasDeclaration(
-    undefined,
     [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
     ts.factory.createIdentifier(ComponentNameTypeName),
     undefined,
diff --git a/scripts/shared/typescript.ts b/scripts/shared/typescript.ts
@@ -5,7 +5,6 @@ export function createConstructorDeclaration(
   parameters: ts.ParameterDeclaration[] = [],
 ) {
   return ts.factory.createConstructorDeclaration(
-    undefined,
     undefined,
     parameters,
     ts.factory.createBlock(statements, true),
@@ -14,7 +13,6 @@ export function createConstructorDeclaration(
 
 export function createExportDeclaration(source: string, identifier: string) {
   return ts.factory.createExportDeclaration(
-    undefined,
     undefined,
     false,
     ts.factory.createNamedExports([
@@ -26,7 +24,6 @@ export function createExportDeclaration(source: string, identifier: string) {
 
 export function createImportDeclaration(source: string, identifier: string) {
   return ts.factory.createImportDeclaration(
-    undefined,
     undefined,
     ts.factory.createImportClause(
       false,
diff --git a/src/capabilities/Charging.ts b/src/capabilities/Charging.ts
@@ -7,6 +7,7 @@ enum Properties {
   AcousticLimit = 'acoustic_limit',
   AuxiliaryPower = 'auxiliary_power',
   BatteryCapacity = 'battery_capacity',
+  BatteryChargeType = 'battery_charge_type',
   BatteryCoolingTemperature = 'battery_cooling_temperature',
   BatteryCurrent = 'battery_current',
   BatteryCurrentAc = 'battery_current_ac',
@@ -42,6 +43,7 @@ enum Properties {
   CurrentType = 'current_type',
   DepartureTimeDisplay = 'departure_time_display',
   DepartureTimes = 'departure_times',
+  DrivingModePhev = 'driving_mode_phev',
   EstimatedRange = 'estimated_range',
   EstimatedRangeTarget = 'estimated_range_target',
   FlapLockStatus = 'flap_lock_status',
diff --git a/src/capabilities/Diagnostics.ts b/src/capabilities/Diagnostics.ts
@@ -45,6 +45,7 @@ enum Properties {
   MileageMeters = 'mileage_meters',
   Odometer = 'odometer',
   OemTroubleCodeValues = 'oem_trouble_code_values',
+  PassengerAirbagStatus = 'passenger_airbag_status',
   Speed = 'speed',
   TirePressureStatuses = 'tire_pressure_statuses',
   TirePressures = 'tire_pressures',
diff --git a/src/capabilities/Race.ts b/src/capabilities/Race.ts
@@ -5,6 +5,7 @@ import { UniversalProperties } from './properties';
 
 enum Properties {
   Accelerations = 'accelerations',
+  AcceleratorDurations = 'accelerator_durations',
   AcceleratorPedalIdleSwitch = 'accelerator_pedal_idle_switch',
   AcceleratorPedalKickdownSwitch = 'accelerator_pedal_kickdown_switch',
   BrakePedalPosition = 'brake_pedal_position',
diff --git a/src/capabilities/Trips.ts b/src/capabilities/Trips.ts
@@ -5,6 +5,7 @@ import { UniversalProperties } from './properties';
 
 enum Properties {
   AverageFuelConsumption = 'average_fuel_consumption',
+  BrakingCount = 'braking_count',
   Description = 'description',
   Distance = 'distance',
   DriverName = 'driver_name',
diff --git a/src/capabilities/Usage.ts b/src/capabilities/Usage.ts
@@ -4,6 +4,7 @@ import { Configuration } from '../core/Configuration';
 import { UniversalProperties } from './properties';
 
 enum Properties {
+  AccelerationDurations = 'acceleration_durations',
   AccelerationEvaluation = 'acceleration_evaluation',
   AverageFuelConsumption = 'average_fuel_consumption',
   AverageSpeed = 'average_speed',
diff --git a/src/configuration/configuration.json b/src/configuration/configuration.json
diff --git a/src/core/Property.ts b/src/core/Property.ts
@@ -14,6 +14,7 @@ export class Property extends Serializable implements NamedEntity {
   public constructor(
     public readonly definition: Readonly<IProperty>,
     public components: Partial<Record<ComponentName, PropertyComponent>> = {},
+    public tags: Record<string, unknown> = {},
   ) {
     super();
   }
@@ -128,6 +129,20 @@ export class Property extends Serializable implements NamedEntity {
     return component;
   }
 
+  public addTag<T = unknown>(label: string, value: T) {
+    this.tags[label] = value;
+    return this;
+  }
+
+  public getTag<T = unknown>(label: string) {
+    return this.tags[label] as T | undefined;
+  }
+
+  public removeTag(label: string) {
+    delete this.tags[label];
+    return this;
+  }
+
   public isInstanceOf(property: Property) {
     const { identityKey, multiple } = property;
     if (property instanceof Object.getPrototypeOf(this).constructor) {
diff --git a/src/factories/PropertyComponentFactory.ts b/src/factories/PropertyComponentFactory.ts
@@ -33,7 +33,7 @@ export class PropertyComponentFactory {
 
     if (PropertyComponentConstructor) {
       const component = new PropertyComponentConstructor(property) as InstanceType<
-        typeof ClassMap[T]
+        (typeof ClassMap)[T]
       >;
 
       if (initialValue !== undefined) {
