kuzzle-device-manager 2.0.0-rc8 → 2.0.0

package/dist/lib/modules/asset/types/AssetContent.d.ts

@@ -0,0 +1,44 @@
+import { JSONObject } from "kuzzle";
+import { DigitalTwinContent, Metadata } from "../../shared";
+/**
+ * Asset document content
+ */
+export interface AssetContent<TMeasures extends JSONObject = any, TMetadata extends Metadata = any> extends DigitalTwinContent<TMeasures, TMetadata> {
+    /**
+     * Link with attached device
+     */
+    linkedDevices: Array<{
+        /**
+         * Device ID
+         */
+        _id: string;
+        /**
+         * Names of the linked measures
+         *
+         * Array<{ asset: string, device: string }>
+         *
+         * @example
+         *
+         * [
+         *   { asset: "externalTemperature", device: "temperature" }
+         * ]
+         */
+        measureNames: Array<{
+            asset: string;
+            device: string;
+        }>;
+    }>;
+}
+/**
+ * Asset description used to contextualize each measure data point
+ */
+export type AssetMeasureContext<TMetadata extends Metadata = Metadata> = {
+    /**
+     * ID of the asset
+     */
+    _id: string;
+    /**
+     * Name of the measure for the Asset
+     */
+    measureName: string;
+} & Pick<AssetContent<JSONObject, TMetadata>, "model" | "reference" | "metadata">;

package/{lib/types/DecodedPayload.js → dist/lib/modules/asset/types/AssetContent.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=DecodedPayload.js.map
+//# sourceMappingURL=AssetContent.js.map

package/dist/lib/modules/asset/types/AssetContent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AssetContent.js","sourceRoot":"","sources":["../../../../../lib/modules/asset/types/AssetContent.ts"],"names":[],"mappings":""}

package/dist/lib/modules/asset/types/AssetEvents.d.ts

@@ -0,0 +1,30 @@
+import { KDocument } from "kuzzle";
+import { Metadata } from "../../../modules/shared";
+import { AssetContent } from "./AssetContent";
+import { AssetHistoryEvent } from "./AssetHistoryContent";
+export type EventAssetUpdateBefore = {
+    name: "device-manager:asset:update:before";
+    args: [{
+        asset: KDocument<AssetContent>;
+        metadata: Metadata;
+    }];
+};
+export type EventAssetUpdateAfter = {
+    name: "device-manager:asset:update:after";
+    args: [{
+        asset: KDocument<AssetContent>;
+        metadata: Metadata;
+    }];
+};
+/**
+ * @internal
+ */
+export type AskAssetHistoryAdd<TAssetHistoryEvent extends AssetHistoryEvent> = {
+    name: "ask:device-manager:asset:history:add";
+    payload: {
+        engineId: string;
+        event: TAssetHistoryEvent;
+        asset: KDocument<AssetContent>;
+    };
+    result: void;
+};

package/dist/lib/modules/asset/types/AssetEvents.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=AssetEvents.js.map

package/dist/lib/modules/asset/types/AssetEvents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AssetEvents.js","sourceRoot":"","sources":["../../../../../lib/modules/asset/types/AssetEvents.ts"],"names":[],"mappings":""}

package/dist/lib/modules/asset/types/AssetHistoryContent.d.ts

@@ -0,0 +1,50 @@
+import { JSONObject, KDocumentContent } from "kuzzle";
+import { Metadata } from "../../shared";
+import { AssetContent } from "./AssetContent";
+export type AssetHistoryEventMeasure = {
+    name: "measure";
+    measure: {
+        names: string[];
+    };
+};
+export type AssetHistoryEventMetadata = {
+    name: "metadata";
+    metadata: {
+        names: string[];
+    };
+};
+export type AssetHistoryEventLink = {
+    name: "link";
+    link: {
+        deviceId: string;
+    };
+};
+export type AssetHistoryEventUnlink = {
+    name: "unlink";
+    unlink: {
+        deviceId: string;
+    };
+};
+export type AssetHistoryEvent = AssetHistoryEventMeasure | AssetHistoryEventMetadata | AssetHistoryEventLink | AssetHistoryEventUnlink;
+/**
+ * Asset History document content
+ */
+export interface AssetHistoryContent<TAssetHistoryEvent extends AssetHistoryEvent = any, TMeasures extends JSONObject = any, TMetadata extends Metadata = any> extends KDocumentContent {
+    /**
+     * Name of the event who caused the historization
+     *
+     *  - `measure` a new measure has been received
+     *  - `metadata` the asset metadata has been updated
+     *  - `link` a device has been linked or unlinked to the asset
+     *  - `unlink` a device has been unlinked from the asset
+     */
+    event: TAssetHistoryEvent;
+    /**
+     * ID of the historized asset
+     */
+    id: string;
+    /**
+     * Asset content after the event
+     */
+    asset: AssetContent<TMeasures, TMetadata>;
+}

package/dist/lib/modules/asset/types/AssetHistoryContent.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=AssetHistoryContent.js.map

package/dist/lib/modules/asset/types/AssetHistoryContent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AssetHistoryContent.js","sourceRoot":"","sources":["../../../../../lib/modules/asset/types/AssetHistoryContent.ts"],"names":[],"mappings":""}

package/dist/lib/modules/decoder/DecodedPayload.d.ts

@@ -0,0 +1,47 @@
+import { JSONObject } from "kuzzle";
+import { DecodedMeasurement } from "../measure";
+import { Decoder } from "./Decoder";
+/**
+ * Class containing the decoded measures.
+ */
+export declare class DecodedPayload<TDecoder extends Decoder = Decoder> {
+    decoder: TDecoder;
+    /**
+     * Measurements per device.
+     *
+     * Record<deviceReference, Measurement[]>
+     */
+    private measurementsByDevice;
+    /**
+     * Metadata per device.
+     */
+    private metadataByDevice;
+    constructor(decoder: TDecoder);
+    get references(): string[];
+    /**
+     * Add a new measure into the decoded payload
+     *
+     * @param deviceReference Device reference
+     * @param measureName Name of the decoded measure
+     * @param measurement Measurement object
+     */
+    addMeasurement<TMeasureValues extends JSONObject = JSONObject>(deviceReference: string, measureName: TDecoder["measures"][number]["name"], measurement: Omit<DecodedMeasurement<TMeasureValues>, "measureName">): void;
+    /**
+     * Add metadata values for a Device.
+     *
+     * Metadata should have been declared on the plugin to be used.
+     *
+     * @param deviceReference Device reference
+     * @param metadata Object containing metadata values
+     */
+    addMetadata(deviceReference: string, metadata: JSONObject): void;
+    /**
+     * Gets the measurements decoded for a device
+     */
+    getMeasurements(deviceReference: string): DecodedMeasurement[];
+    /**
+     * Get the metadata for a device
+     */
+    getMetadata(deviceReference: string): JSONObject;
+    private validateMeasurement;
+}

package/dist/lib/modules/decoder/DecodedPayload.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DecodedPayload = void 0;
+const kuzzle_1 = require("kuzzle");
+/**
+ * Class containing the decoded measures.
+ */
+class DecodedPayload {
+    constructor(decoder) {
+        /**
+         * Measurements per device.
+         *
+         * Record<deviceReference, Measurement[]>
+         */
+        this.measurementsByDevice = {};
+        /**
+         * Metadata per device.
+         */
+        this.metadataByDevice = {};
+        this.decoder = decoder;
+    }
+    get references() {
+        return Object.keys(this.measurementsByDevice);
+    }
+    /**
+     * Add a new measure into the decoded payload
+     *
+     * @param deviceReference Device reference
+     * @param measureName Name of the decoded measure
+     * @param measurement Measurement object
+     */
+    addMeasurement(deviceReference, measureName, measurement) {
+        if (!this.decoder.measureNames.includes(measureName)) {
+            throw new kuzzle_1.BadRequestError(`Decoder "${this.decoder.deviceModel}" has no measure named "${measureName}"`);
+        }
+        this.validateMeasurement(measurement);
+        if (!this.measurementsByDevice[deviceReference]) {
+            this.measurementsByDevice[deviceReference] = [];
+        }
+        const decodedMeasurement = {
+            measureName,
+            ...measurement,
+        };
+        this.measurementsByDevice[deviceReference].push(decodedMeasurement);
+    }
+    /**
+     * Add metadata values for a Device.
+     *
+     * Metadata should have been declared on the plugin to be used.
+     *
+     * @param deviceReference Device reference
+     * @param metadata Object containing metadata values
+     */
+    addMetadata(deviceReference, metadata) {
+        if (!this.metadataByDevice[deviceReference]) {
+            this.metadataByDevice[deviceReference] = {};
+        }
+        this.metadataByDevice[deviceReference] = {
+            ...this.metadataByDevice[deviceReference],
+            ...metadata,
+        };
+    }
+    /**
+     * Gets the measurements decoded for a device
+     */
+    getMeasurements(deviceReference) {
+        return this.measurementsByDevice[deviceReference];
+    }
+    /**
+     * Get the metadata for a device
+     */
+    getMetadata(deviceReference) {
+        return this.metadataByDevice[deviceReference];
+    }
+    validateMeasurement(measurement) {
+        if (measurement.measuredAt.toString().length !== 13) {
+            throw new kuzzle_1.BadRequestError(`Invalid payload: "measuredAt" should be a timestamp in milliseconds`);
+        }
+    }
+}
+exports.DecodedPayload = DecodedPayload;
+//# sourceMappingURL=DecodedPayload.js.map

package/dist/lib/modules/decoder/DecodedPayload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DecodedPayload.js","sourceRoot":"","sources":["../../../../lib/modules/decoder/DecodedPayload.ts"],"names":[],"mappings":";;;AAAA,mCAAqD;AAMrD;;GAEG;AACH,MAAa,cAAc;IAezB,YAAY,OAAiB;QAZ7B;;;;WAIG;QACK,yBAAoB,GAAyC,EAAE,CAAC;QAExE;;WAEG;QACK,qBAAgB,GAAe,EAAE,CAAC;QAGxC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;OAMG;IACH,cAAc,CACZ,eAAuB,EACvB,WAAiD,EACjD,WAAoE;QAEpE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE;YACpD,MAAM,IAAI,wBAAe,CACvB,YAAY,IAAI,CAAC,OAAO,CAAC,WAAW,2BAA2B,WAAW,GAAG,CAC9E,CAAC;SACH;QAED,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;QAEtC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,EAAE;YAC/C,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,GAAG,EAAE,CAAC;SACjD;QAED,MAAM,kBAAkB,GAAuC;YAC7D,WAAW;YACX,GAAG,WAAW;SACf,CAAC;QAEF,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;OAOG;IACH,WAAW,CAAC,eAAuB,EAAE,QAAoB;QACvD,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,EAAE;YAC3C,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,GAAG,EAAE,CAAC;SAC7C;QAED,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,GAAG;YACvC,GAAG,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC;YACzC,GAAG,QAAQ;SACZ,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,eAAuB;QACrC,OAAO,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,eAAuB;QACjC,OAAO,IAAI,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;IAChD,CAAC;IAEO,mBAAmB,CACzB,WAAoE;QAEpE,IAAI,WAAW,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,MAAM,KAAK,EAAE,EAAE;YACnD,MAAM,IAAI,wBAAe,CACvB,qEAAqE,CACtE,CAAC;SACH;IACH,CAAC;CACF;AAjGD,wCAiGC"}

package/{lib/core-classes → dist/lib/modules/decoder}/Decoder.d.ts

@@ -1,9 +1,13 @@
-import { HttpRoute, JSONObject, KuzzleRequest } from 'kuzzle';
-import { DecodedPayload } from '../types/DecodedPayload';
-import { DecoderContent } from '../types';
-import { MeasuresRegister } from './registers/MeasuresRegister';
-export declare type DecoderMeasures = Record<string, // deviceMeasureName
-string>;
+import { HttpRoute, JSONObject, KuzzleRequest } from "kuzzle";
+import { DecodedPayload } from "./DecodedPayload";
+import { DecoderContent } from "./types/DecoderContent";
+/**
+ * Array of measures declaration
+ */
+export type NamedMeasures = ReadonlyArray<{
+    name: string;
+    type: string;
+}>;
 /**
  * Base class to implement a decoder for a device model.
  * The device model must be passed to the parent constructor.
@@ -12,13 +16,24 @@ string>;
 export declare abstract class Decoder {
     private _http?;
     /**
-     * Device model name
+     * Device model name.
+     *
+     * Will be infered from the class name if not defined:
+     * `AbeewayGPSDecoder` => `AbeewayGPS`
      */
     deviceModel: string;
     /**
-     * Array of device measure and their type
+     * Declaration of the measures decoded by this decoder.
+     * The name correspond of the measure name for the device.
+     * Measures types should be registered on the plugin beforehand.
+     *
+     * @example
+     *
+     * this.measures = [
+     *   { type: 'temperature', name: 'temperatureExterior' },
+     * ];
      */
-    decoderMeasures: DecoderMeasures;
+    measures: NamedMeasures;
     /**
      * Custom name for the associated API action in the "payload" controller
      */
@@ -29,6 +44,7 @@ export declare abstract class Decoder {
      * the device model unique identifier field.
      *
      * @example
+     *
      * this.payloadsMappings = {
      *   device_properties: {
      *     properties: {
@@ -45,14 +61,8 @@ export declare abstract class Decoder {
      */
     set http(http: HttpRoute[]);
     get http(): HttpRoute[];
-    /**
-     * @param deviceModel Device model for this decoder
-     * @param decoderMeasures Measures created by this decoder
-     *
-     * @example
-     * super('AbeewayGPS', ['position']);
-     */
-    constructor(deviceModel: string, decoderMeasures: DecoderMeasures, measuresRegister: MeasuresRegister);
+    get measureNames(): string[];
+    get measureTypes(): string[];
     /**
      * Validate the payload format before processing.
      *
@@ -72,12 +82,13 @@ export declare 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
      *
-     * @returns Map of `Measurements` by device reference.
+     * @returns DecodedPayload
      */
-    abstract decode(payload: JSONObject, request: KuzzleRequest): Promise<DecodedPayload>;
+    abstract decode(decodedPayload: DecodedPayload<any>, payload: JSONObject, request: KuzzleRequest): Promise<DecodedPayload<any>>;
     /**
      * Checks if the provided properties are present in the payload
      *

package/{lib/core-classes → dist/lib/modules/decoder}/Decoder.js

@@ -12,20 +12,26 @@ const lodash_1 = __importDefault(require("lodash"));
  * The abstract "decode" method must be implemented.
  */
 class Decoder {
-    /**
-     * @param deviceModel Device model for this decoder
-     * @param decoderMeasures Measures created by this decoder
-     *
-     * @example
-     * super('AbeewayGPS', ['position']);
-     */
-    constructor(deviceModel, decoderMeasures, measuresRegister) {
+    constructor() {
+        /**
+         * Declaration of the measures decoded by this decoder.
+         * The name correspond of the measure name for the device.
+         * Measures types should be registered on the plugin beforehand.
+         *
+         * @example
+         *
+         * this.measures = [
+         *   { type: 'temperature', name: 'temperatureExterior' },
+         * ];
+         */
+        this.measures = [];
         /**
          * Custom mappings for the payload collection.
          * It will be injected in the "payload" property and it should allows to index
          * the device model unique identifier field.
          *
          * @example
+         *
          * this.payloadsMappings = {
          *   device_properties: {
          *     properties: {
@@ -35,13 +41,6 @@ class Decoder {
          * }
          */
         this.payloadsMappings = {};
-        this.deviceModel = deviceModel;
-        for (const [measureName, measureType] of Object.entries(decoderMeasures)) {
-            if (!measuresRegister.has(measureType)) {
-                throw new kuzzle_1.PluginImplementationError(`Decoder "${this.constructor.name}" cannot register unknown measure type "${measureType}"`);
-            }
-        }
-        this.decoderMeasures = decoderMeasures;
     }
     /**
      * Define custom HTTP routes
@@ -53,10 +52,34 @@ class Decoder {
     }
     get http() {
         if (!this._http) {
-            this._http = [{ path: `device-manager/payload/${this.action}`, verb: 'post' }];
+            this._http = [
+                {
+                    openapi: {
+                        description: `Receive a payload from a ${this.deviceModel} device`,
+                        parameters: [
+                            {
+                                in: "body",
+                                name: "payload",
+                                required: true,
+                                schema: {
+                                    type: "object",
+                                },
+                            },
+                        ],
+                    },
+                    path: `device-manager/payload/${this.action}`,
+                    verb: "post",
+                },
+            ];
         }
         return this._http;
     }
+    get measureNames() {
+        return this.measures.map(({ name }) => name);
+    }
+    get measureTypes() {
+        return this.measures.map(({ type }) => type);
+    }
     /**
      * Validate the payload format before processing.
      *
@@ -91,8 +114,8 @@ class Decoder {
     }
     serialize() {
         return {
-            decoderMeasures: this.decoderMeasures,
             deviceModel: this.deviceModel,
+            measures: this.measures,
         };
     }
 }

package/dist/lib/modules/decoder/Decoder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Decoder.js","sourceRoot":"","sources":["../../../../lib/modules/decoder/Decoder.ts"],"names":[],"mappings":";;;;;;AAAA,mCAKgB;AAChB,oDAAuB;AAgBvB;;;;GAIG;AACH,MAAsB,OAAO;IAA7B;QAWE;;;;;;;;;;WAUG;QACI,aAAQ,GAAkB,EAAE,CAAC;QAOpC;;;;;;;;;;;;;;WAcG;QACI,qBAAgB,GAAgB,EAAE,CAAC;IA0G5C,CAAC;IAxGC;;;;OAIG;IACH,IAAI,IAAI,CAAC,IAAiB;QACxB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED,IAAI,IAAI;QACN,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACf,IAAI,CAAC,KAAK,GAAG;gBACX;oBACE,OAAO,EAAE;wBACP,WAAW,EAAE,4BAA4B,IAAI,CAAC,WAAW,SAAS;wBAClE,UAAU,EAAE;4BACV;gCACE,EAAE,EAAE,MAAM;gCACV,IAAI,EAAE,SAAS;gCACf,QAAQ,EAAE,IAAI;gCACd,MAAM,EAAE;oCACN,IAAI,EAAE,QAAQ;iCACf;6BACF;yBACF;qBACF;oBACD,IAAI,EAAE,0BAA0B,IAAI,CAAC,MAAM,EAAE;oBAC7C,IAAI,EAAE,MAAM;iBACb;aACF,CAAC;SACH;QAED,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,0CAA0C;IAC1C,KAAK,CAAC,QAAQ,CACZ,OAAmB,EACnB,OAAsB;QAEtB,OAAO,IAAI,CAAC;IACd,CAAC;IAoBD;;;;;;;OAOG;IACH,gBAAgB,CAAC,OAAmB,EAAE,KAAe;QACnD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,IAAI,CAAC,gBAAC,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE;gBACzB,MAAM,IAAI,0BAAiB,CAAC,qBAAqB,IAAI,cAAc,CAAC,CAAC;aACtE;SACF;IACH,CAAC;IAED,SAAS;QACP,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;IACJ,CAAC;CACF;AAtJD,0BAsJC;AAED,qDAAqD"}

package/dist/lib/modules/decoder/DecoderModule.d.ts

@@ -0,0 +1,8 @@
+import { Module } from "../shared/Module";
+export declare class DecoderModule extends Module {
+    private payloadService;
+    private decoderController;
+    private payloadsController;
+    private get decodersRegister();
+    init(): Promise<void>;
+}

package/dist/lib/modules/decoder/DecoderModule.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DecoderModule = void 0;
+const Module_1 = require("../shared/Module");
+const DecodersController_1 = require("./DecodersController");
+const PayloadsController_1 = require("./PayloadsController");
+const PayloadService_1 = require("./PayloadService");
+const RoleDecodersAdmin_1 = require("./roles/RoleDecodersAdmin");
+const RolePayloadsAll_1 = require("./roles/RolePayloadsAll");
+class DecoderModule extends Module_1.Module {
+    // @todo temporary until registers refactor
+    get decodersRegister() {
+        // eslint-disable-next-line dot-notation
+        return this.plugin["decodersRegister"];
+    }
+    async init() {
+        this.payloadService = new PayloadService_1.PayloadService(this.plugin);
+        this.decoderController = new DecodersController_1.DecodersController(this.payloadService, this.decodersRegister);
+        this.payloadsController = new PayloadsController_1.PayloadsController(this.payloadService, this.decodersRegister);
+        this.plugin.api["device-manager/decoders"] =
+            this.decoderController.definition;
+        this.plugin.api["device-manager/payloads"] =
+            this.payloadsController.definition;
+        this.plugin.roles.push(RoleDecodersAdmin_1.RoleDecodersAdmin);
+        this.plugin.roles.push(RolePayloadsAll_1.RolePayloadsAll);
+    }
+}
+exports.DecoderModule = DecoderModule;
+//# sourceMappingURL=DecoderModule.js.map

package/dist/lib/modules/decoder/DecoderModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DecoderModule.js","sourceRoot":"","sources":["../../../../lib/modules/decoder/DecoderModule.ts"],"names":[],"mappings":";;;AAAA,6CAA0C;AAE1C,6DAA0D;AAC1D,6DAA0D;AAC1D,qDAAkD;AAClD,iEAA8D;AAC9D,6DAA0D;AAE1D,MAAa,aAAc,SAAQ,eAAM;IAKvC,2CAA2C;IAC3C,IAAY,gBAAgB;QAC1B,wCAAwC;QACxC,OAAO,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;IACzC,CAAC;IAEM,KAAK,CAAC,IAAI;QACf,IAAI,CAAC,cAAc,GAAG,IAAI,+BAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACtD,IAAI,CAAC,iBAAiB,GAAG,IAAI,uCAAkB,CAC7C,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,gBAAgB,CACtB,CAAC;QACF,IAAI,CAAC,kBAAkB,GAAG,IAAI,uCAAkB,CAC9C,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,gBAAgB,CACtB,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,yBAAyB,CAAC;YACxC,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC;QAEpC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,yBAAyB,CAAC;YACxC,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC;QAErC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,qCAAiB,CAAC,CAAC;QAC1C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,iCAAe,CAAC,CAAC;IAC1C,CAAC;CACF;AA/BD,sCA+BC"}

package/dist/lib/modules/decoder/DecodersController.d.ts

@@ -0,0 +1,18 @@
+import { ControllerDefinition, KuzzleRequest } from "kuzzle";
+import { DecodersRegister } from "../../core/registers/DecodersRegister";
+import { PayloadService } from "./PayloadService";
+import { ApiDecoderListResult, ApiDecoderPrunePayloadsResult } from "./types/DecoderApi";
+export declare class DecodersController {
+    private payloadService;
+    private decodersRegister;
+    definition: ControllerDefinition;
+    constructor(payloadService: PayloadService, decodersRegister: DecodersRegister);
+    /**
+     * List all available decoders
+     */
+    list(): Promise<ApiDecoderListResult>;
+    /**
+     * Clean payload collection for a time period
+     */
+    prunePayloads(request: KuzzleRequest): Promise<ApiDecoderPrunePayloadsResult>;
+}

package/dist/lib/modules/decoder/DecodersController.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DecodersController = void 0;
+class DecodersController {
+    constructor(payloadService, decodersRegister) {
+        this.payloadService = payloadService;
+        this.decodersRegister = decodersRegister;
+        this.definition = {
+            actions: {
+                list: {
+                    handler: this.list.bind(this),
+                    http: [{ path: "device-manager/decoders", verb: "get" }],
+                },
+                prunePayloads: {
+                    handler: this.prunePayloads.bind(this),
+                    http: [
+                        { path: "device-manager/decoders/_prunePayloads", verb: "delete" },
+                    ],
+                },
+            },
+        };
+    }
+    /**
+     * List all available decoders
+     */
+    async list() {
+        const decoders = this.decodersRegister.list();
+        return { decoders };
+    }
+    /**
+     * Clean payload collection for a time period
+     */
+    async prunePayloads(request) {
+        const days = request.getBodyNumber("days");
+        const deviceModel = request.input.body.deviceModel;
+        const onlyValid = request.input.body.onlyValid ?? true;
+        const deleted = await this.payloadService.prune(days, onlyValid, {
+            deviceModel,
+        });
+        return { deleted };
+    }
+}
+exports.DecodersController = DecodersController;
+//# sourceMappingURL=DecodersController.js.map

package/dist/lib/modules/decoder/DecodersController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DecodersController.js","sourceRoot":"","sources":["../../../../lib/modules/decoder/DecodersController.ts"],"names":[],"mappings":";;;AAUA,MAAa,kBAAkB;IAM7B,YACE,cAA8B,EAC9B,gBAAkC;QAElC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QAEzC,IAAI,CAAC,UAAU,GAAG;YAChB,OAAO,EAAE;gBACP,IAAI,EAAE;oBACJ,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;oBAC7B,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,yBAAyB,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;iBACzD;gBACD,aAAa,EAAE;oBACb,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC;oBACtC,IAAI,EAAE;wBACJ,EAAE,IAAI,EAAE,wCAAwC,EAAE,IAAI,EAAE,QAAQ,EAAE;qBACnE;iBACF;aACF;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC;QAE9C,OAAO,EAAE,QAAQ,EAAE,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa,CACjB,OAAsB;QAEtB,MAAM,IAAI,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC3C,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC;QACnD,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC;QAEvD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE;YAC/D,WAAW;SACZ,CAAC,CAAC;QAEH,OAAO,EAAE,OAAO,EAAE,CAAC;IACrB,CAAC;CACF;AAtDD,gDAsDC"}

package/dist/lib/modules/decoder/PayloadService.d.ts

@@ -0,0 +1,34 @@
+import { JSONObject, KuzzleRequest } from "kuzzle";
+import { DeviceManagerPlugin } from "../../core";
+import { Decoder } from "./Decoder";
+export declare class PayloadService {
+    private config;
+    private context;
+    private get sdk();
+    private get app();
+    constructor(plugin: DeviceManagerPlugin);
+    /**
+     * Process a payload by validating and decode it with the `decoder` associated
+     * with the device model. It :
+     * - register the brut `Payload`
+     * - redirect measurements to MeasureService
+     */
+    receive(request: KuzzleRequest, decoder: Decoder, { refresh }?: any): Promise<{
+        valid: boolean;
+    }>;
+    /**
+     * Method used to save the payload and catch + log the error if any.
+     *
+     * This method never returns a rejected promise.
+     */
+    private savePayload;
+    /**
+     * Get devices or create missing ones (when auto-provisionning is enabled)
+     */
+    private retrieveDevices;
+    private provisionDevices;
+    prune(days: number, onlyValid: boolean, { deviceModel }?: {
+        deviceModel?: string;
+    }): Promise<number>;
+    receiveUnknown(deviceModel: string, payload: JSONObject): Promise<void>;
+}