Export DeviceModelDefinition and AssetModelDefinition

features/fixtures/application/decoders/DummyTempDecoder.ts

@@ -31,7 +31,7 @@ export class DummyTempDecoder extends Decoder {
 
   async decode(
     decodedPayload: DecodedPayload<DummyTempDecoder>,
-    payload: JSONObject,
+    payload: JSONObject
   ): Promise<DecodedPayload<DummyTempDecoder>> {
     if (payload?.metadata?.color) {
       decodedPayload.addMetadata(payload.deviceEUI, {

features/fixtures/application/decoders/DummyTempPositionDecoder.ts

@@ -25,7 +25,7 @@ export class DummyTempPositionDecoder extends Decoder {
 
   async decode(
     decodedPayload: DecodedPayload<DummyTempPositionDecoder>,
-    payload: JSONObject,
+    payload: JSONObject
   ): Promise<DecodedPayload<DummyTempPositionDecoder>> {
     decodedPayload.addMeasurement<TemperatureMeasurement>(
       payload.deviceEUI,

index.ts

@@ -11,3 +11,5 @@ export * from './lib/modules/measure';
 export * from './lib/modules/decoder';
 
 export * from './lib/modules/shared';
+
+export * from './lib/modules/model';

lib/core/DeviceManagerPlugin.ts

@@ -10,12 +10,12 @@ import {
 import { ConfigManager, EngineController } from "kuzzle-plugin-commons";
 
 import {
-  batteryMeasure,
-  humidityMeasure,
+  batteryMeasureDefinition,
+  humidityMeasureDefinition,
   MeasureDefinition,
-  movementMeasure,
-  positionMeasure,
-  temperatureMeasure,
+  movementMeasureDefinition,
+  positionMeasureDefinition,
+  temperatureMeasureDefinition,
 } from "../modules/measure";
 
 import { DeviceModule, devicesMappings } from "../modules/device";
@@ -144,8 +144,8 @@ export class DeviceManagerPlugin extends Plugin {
 
         this.modelsRegister.registerDevice(
           model,
-          definition.metadataMappings,
           measures,
+          definition.metadataMappings,
           definition.defaultMetadata
         );
       },
@@ -229,11 +229,11 @@ export class DeviceManagerPlugin extends Plugin {
     this.decodersRegister = new DecodersRegister();
     this.modelsRegister = new ModelsRegister();
 
-    this.models.registerMeasure("temperature", temperatureMeasure);
-    this.models.registerMeasure("position", positionMeasure);
-    this.models.registerMeasure("movement", movementMeasure);
-    this.models.registerMeasure("humidity", humidityMeasure);
-    this.models.registerMeasure("battery", batteryMeasure);
+    this.models.registerMeasure("temperature", temperatureMeasureDefinition);
+    this.models.registerMeasure("position", positionMeasureDefinition);
+    this.models.registerMeasure("movement", movementMeasureDefinition);
+    this.models.registerMeasure("humidity", humidityMeasureDefinition);
+    this.models.registerMeasure("battery", batteryMeasureDefinition);
   }
 
   /**

lib/core/registers/ModelsRegister.ts

@@ -57,8 +57,8 @@ export class ModelsRegister {
 
   registerDevice(
     model: string,
-    metadataMappings: JSONObject,
     measures: Record<string, string>,
+    metadataMappings: JSONObject = {},
     defaultMetadata: JSONObject = {}
   ) {
     this.deviceModels.push({

lib/modules/decoder/Decoder.ts

@@ -140,6 +140,7 @@ export abstract class Decoder {
    *  - set "reference"
    *  - fetch measures
    *
+   * @param decodedPayload Decoded payload to store decoded measures
    * @param payload Raw payload received in the API action body
    * @param request Original request
    *

lib/modules/measure/measures/BatteryMeasure.ts

@@ -6,6 +6,6 @@ export type BatteryMeasurement = {
   battery: number;
 };
 
-export const batteryMeasure: MeasureDefinition = {
+export const batteryMeasureDefinition: MeasureDefinition = {
   valuesMappings: { battery: { type: "integer" } },
 };

lib/modules/measure/measures/HumidityMeasure.ts

@@ -6,6 +6,6 @@ export type HumidityMeasurement = {
   humidity: number;
 };
 
-export const humidityMeasure: MeasureDefinition = {
+export const humidityMeasureDefinition: MeasureDefinition = {
   valuesMappings: { humidity: { type: "float" } },
 };

lib/modules/measure/measures/MovementMeasure.ts

@@ -6,6 +6,6 @@ export type MovementMeasurement = {
   movement: boolean;
 };
 
-export const movementMeasure: MeasureDefinition = {
+export const movementMeasureDefinition: MeasureDefinition = {
   valuesMappings: { movement: { type: "boolean" } },
 };

lib/modules/measure/measures/PositionMeasure.ts

@@ -11,7 +11,7 @@ export type PositionMeasurement = {
   accuracy?: number;
 };
 
-export const positionMeasure: MeasureDefinition = {
+export const positionMeasureDefinition: MeasureDefinition = {
   valuesMappings: {
     accuracy: { type: "float" },
     altitude: { type: "float" },

lib/modules/measure/measures/TemperatureMeasure.ts

@@ -6,6 +6,6 @@ export type TemperatureMeasurement = {
   temperature: number;
 };
 
-export const temperatureMeasure: MeasureDefinition = {
+export const temperatureMeasureDefinition: MeasureDefinition = {
   valuesMappings: { temperature: { type: "float" } },
 };

lib/modules/model/types/ModelDefinition.ts

@@ -2,14 +2,66 @@ import { JSONObject } from "kuzzle";
 
 import { Decoder, NamedMeasures } from "../../../modules/decoder";
 
+/**
+ * Define an asset model
+ *
+ * @example
+ *   {
+ *     measuresNames: [
+ *       { name: "temperatureExt", type: "temperature" },
+ *       { name: "temperatureInt", type: "temperature" },
+ *       { name: "position", type: "position" },
+ *     ],
+ *     metadataMappings: {
+ *       weight: { type: "integer" },
+ *       height: { type: "integer" },
+ *     },
+ *     defaultMetadata: {
+ *       height: 20
+ *     }
+ *   }
+ *
+ */
 export type AssetModelDefinition = {
+  /**
+   * Array describing measures names and types
+   */
   measuresNames: NamedMeasures;
+
+  /**
+   * Metadata mappings definition
+   */
   metadataMappings: JSONObject;
+
+  /**
+   * Default metadata values
+   */
   defaultMetadata?: JSONObject;
 };
 
+/**
+ * Define a device model
+ *
+ * @example
+ *   {
+ *     decoder: new DummyTempPositionDecoder(),
+ *     metadataMappings: {
+ *       serial: { type: "keyword" },
+ *     }
+ *   }
+ *
+ */
 export type DeviceModelDefinition = {
+  /**
+   * Decoder used to decode payloads
+   */
   decoder: Decoder;
-  metadataMappings: JSONObject;
+  /**
+   * Metadata mappings definition
+   */
+  metadataMappings?: JSONObject;
+  /**
+   * Default metadata values
+   */
   defaultMetadata?: JSONObject;
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "kuzzle-device-manager",
-  "version": "2.0.0-rc34",
+  "version": "2.0.0-rc35",
   "description": "Manage your IoT devices and assets. Choose a provisioning strategy, receive and decode payload, handle your IoT business logic.",
   "author": "The Kuzzle Team (support@kuzzle.io)",
   "repository": {