kuzzle-device-manager-types 2.1.4 → 2.2.0

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-export * from './lib/core/exports';
-export * from './lib/modules/asset/exports';
-export * from './lib/modules/device/exports';
-export * from './lib/modules/measure/exports';
-export * from './lib/modules/decoder/exports';
-export * from './lib/modules/shared/exports';
-export * from './lib/modules/model/exports';
+export * from "./lib/modules/plugin/exports";
+export * from "./lib/modules/asset/exports";
+export * from "./lib/modules/device/exports";
+export * from "./lib/modules/measure/exports";
+export * from "./lib/modules/decoder/exports";
+export * from "./lib/modules/shared/exports";
+export * from "./lib/modules/model/exports";

package/dist/lib/modules/asset/AssetHistoryService.d.ts

@@ -1,11 +1,9 @@
-import { KDocument } from "kuzzle-sdk";
-import { DeviceManagerPlugin } from "../../core";
-import { AssetHistoryEvent } from "./types/AssetHistoryContent";
-import { AssetContent } from "./types/AssetContent";
+import { DeviceManagerPlugin } from "../plugin";
+import { AssetHistoryContent, AssetHistoryEvent } from "./types/AssetHistoryContent";
 export declare class AssetHistoryService {
     private context;
     private config;
     private get sdk();
     constructor(plugin: DeviceManagerPlugin);
-    add<TAssetHistoryEvent extends AssetHistoryEvent>(engineId: string, event: TAssetHistoryEvent, asset: KDocument<AssetContent>): Promise<void>;
+    add<TAssetHistoryEvent extends AssetHistoryEvent>(engineId: string, histories: AssetHistoryContent[]): Promise<void>;
 }

package/dist/lib/modules/asset/AssetService.d.ts

@@ -1,10 +1,9 @@
 import { User } from "kuzzle";
-import { JSONObject, KDocument, KHit, SearchResult } from "kuzzle-sdk";
+import { JSONObject, KDocument, KHit, SearchResult, mReplaceResponse } from "kuzzle-sdk";
+import { DeviceManagerPlugin } from "../plugin";
 import { Metadata } from "../shared";
-import { DeviceManagerPlugin } from "../../core";
-import { AssetContent } from "./types/AssetContent";
 import { AssetHistoryService } from "./AssetHistoryService";
-import { ApiAssetGetMeasuresResult } from "./types/AssetApi";
+import { AssetContent } from "./types/AssetContent";
 export declare class AssetService {
     private context;
     private config;
@@ -13,24 +12,7 @@ export declare class AssetService {
     private get app();
     private get impersonatedSdk();
     constructor(plugin: DeviceManagerPlugin, assetHistoryService: AssetHistoryService);
-    /**
-     * Returns measures history for an asset
-     *
-     * @param engineId Engine ID
-     * @param assetId Asset ID
-     * @param options.size Number of measures to return
-     * @param options.startAt Returns measures starting from this date (ISO8601)
-     * @param options.endAt Returns measures until this date (ISO8601)
-     */
-    getMeasureHistory(engineId: string, assetId: string, { size, from, endAt, startAt, query, sort, type, }: {
-        sort?: JSONObject;
-        query?: JSONObject;
-        from?: number;
-        size?: number;
-        startAt?: string;
-        endAt?: string;
-        type?: string;
-    }): Promise<ApiAssetGetMeasuresResult>;
+    registerAskEvents(): void;
     get(engineId: string, assetId: string): Promise<KDocument<AssetContent>>;
     /**
      * Updates an asset metadata
@@ -51,5 +33,12 @@ export declare class AssetService {
         scroll?: string;
         lang?: string;
     }): Promise<SearchResult<KHit<AssetContent>>>;
+    /**
+     * Replace an asset metadata
+     */
+    mReplaceAndHistorize(engineId: string, assets: KDocument<AssetContent>[], removedMetadata: string[], { refresh }: {
+        refresh: any;
+    }): Promise<mReplaceResponse>;
     private getEngine;
+    private refreshModel;
 }

package/dist/lib/modules/asset/AssetsController.d.ts

@@ -1,14 +1,19 @@
-import { ControllerDefinition, KuzzleRequest } from "kuzzle";
+import { ControllerDefinition, HttpStream, KuzzleRequest } from "kuzzle";
+import { DeviceManagerPlugin } from "../plugin";
 import { AssetService } from "./AssetService";
 import { ApiAssetCreateResult, ApiAssetDeleteResult, ApiAssetGetMeasuresResult, ApiAssetGetResult, ApiAssetSearchResult, ApiAssetUpdateResult } from "./types/AssetApi";
 export declare class AssetsController {
-    definition: ControllerDefinition;
+    private plugin;
     private assetService;
-    constructor(assetService: AssetService);
+    definition: ControllerDefinition;
+    constructor(plugin: DeviceManagerPlugin, assetService: AssetService);
     get(request: KuzzleRequest): Promise<ApiAssetGetResult>;
     update(request: KuzzleRequest): Promise<ApiAssetUpdateResult>;
     create(request: KuzzleRequest): Promise<ApiAssetCreateResult>;
     delete(request: KuzzleRequest): Promise<ApiAssetDeleteResult>;
     search(request: KuzzleRequest): Promise<ApiAssetSearchResult>;
     getMeasures(request: KuzzleRequest): Promise<ApiAssetGetMeasuresResult>;
+    exportMeasures(request: KuzzleRequest): Promise<HttpStream | {
+        link: string;
+    }>;
 }

package/dist/lib/modules/asset/collections/assetsHistoryMappings.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Base mappings for the "assetsHistory" collection.
+ *
+ * Those mappings does not contains the `asset` mappings.
+ */
 export declare const assetsHistoryMappings: {
     dynamic: string;
     properties: {
@@ -59,5 +64,8 @@ export declare const assetsHistoryMappings: {
                 };
             };
         };
+        timestamp: {
+            type: string;
+        };
     };
 };

package/dist/lib/modules/asset/collections/assetsMappings.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Base mappings for the "assets" collection.
+ *
+ * Those mappings does not contains the `measures` and `metadata` mappings.
+ */
 export declare const assetsMappings: {
     dynamic: string;
     properties: {
@@ -36,6 +41,9 @@ export declare const assetsMappings: {
                         device: {
                             type: string;
                         };
+                        type: {
+                            type: string;
+                        };
                     };
                 };
             };

package/dist/lib/modules/asset/exports.d.ts

@@ -4,3 +4,5 @@ export * from "./types/AssetEvents";
 export * from "./types/AssetApi";
 export * from "./roles/RoleAssetsAdmin";
 export * from "./roles/RoleAssetsReader";
+export * from "./collections/assetsMappings";
+export * from "./collections/assetsHistoryMappings";

package/dist/lib/modules/asset/roles/RoleAssetsAdmin.d.ts

@@ -17,6 +17,7 @@ import { KuzzleRole } from "../../shared/types/KuzzleRole";
         listAssets: true,
         getAsset: true,
         writeAsset: true,
+        listMeasures: true,
       },
     },
  */

package/dist/lib/modules/asset/roles/RoleAssetsReader.d.ts

@@ -9,12 +9,14 @@ import { KuzzleRole } from "../../shared/types/KuzzleRole";
       actions: {
         get: true,
         getMeasures: true,
+        exportMeasures: true,
         search: true,
       },
     },
     "device-manager/models": {
       actions: {
         listAssets: true,
+        listMeasures: true,
         getAsset: true,
       },
     },

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

@@ -63,4 +63,24 @@ export type ApiAssetGetMeasuresResult = {
     measures: Array<KDocument<MeasureContent<JSONObject>>>;
     total: number;
 };
+/**
+ * This action can be used only with WebSocket or POST
+ *
+ * Then the export can be download using HTTP Get and the following route:
+ *  `/_/device-manager/:engineId/devices/:_id/measures/_export/:exportId`
+ */
+export interface ApiAssetExportMeasuresRequest extends AssetsControllerRequest {
+    action: "exportMeasures";
+    _id: string;
+    startAt?: string;
+    endAt?: string;
+    type?: string;
+    body?: {
+        query?: JSONObject;
+        sort?: JSONObject;
+    };
+}
+export type ApiAssetExportMeasuresResult = {
+    link: string;
+};
 export {};

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

@@ -15,17 +15,18 @@ export interface AssetContent<TMeasures extends JSONObject = any, TMetadata exte
         /**
          * Names of the linked measures
          *
-         * Array<{ asset: string, device: string }>
+         * Array<{ asset: string, device: string, type: string }>
          *
          * @example
          *
          * [
-         *   { asset: "externalTemperature", device: "temperature" }
+         *   { asset: "externalTemperature", device: "temperature", type: "temperature" }
          * ]
          */
         measureNames: Array<{
             asset: string;
             device: string;
+            type: string;
         }>;
     }>;
 }

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

@@ -1,7 +1,8 @@
 import { KDocument } from "kuzzle-sdk";
+import { AssetModelContent } from "lib/modules/model";
 import { Metadata } from "../../../modules/shared";
 import { AssetContent } from "./AssetContent";
-import { AssetHistoryEvent } from "./AssetHistoryContent";
+import { AssetHistoryContent, AssetHistoryEvent } from "./AssetHistoryContent";
 export type EventAssetUpdateBefore = {
     name: "device-manager:asset:update:before";
     args: [{
@@ -16,6 +17,13 @@ export type EventAssetUpdateAfter = {
         metadata: Metadata;
     }];
 };
+export type AskAssetRefreshModel = {
+    name: "ask:device-manager:asset:refresh-model";
+    payload: {
+        assetModel: AssetModelContent;
+    };
+    result: void;
+};
 /**
  * @internal
  */
@@ -23,8 +31,7 @@ export type AskAssetHistoryAdd<TAssetHistoryEvent extends AssetHistoryEvent> = {
     name: "ask:device-manager:asset:history:add";
     payload: {
         engineId: string;
-        event: TAssetHistoryEvent;
-        asset: KDocument<AssetContent>;
+        histories: AssetHistoryContent<TAssetHistoryEvent>[];
     };
     result: void;
 };

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

@@ -1,17 +1,19 @@
 import { JSONObject, KDocumentContent } from "kuzzle-sdk";
 import { Metadata } from "../../shared";
 import { AssetContent } from "./AssetContent";
+export type AssetHistoryMetadata = {
+    names: string[];
+};
 export type AssetHistoryEventMeasure = {
     name: "measure";
     measure: {
         names: string[];
     };
+    metadata?: AssetHistoryMetadata;
 };
 export type AssetHistoryEventMetadata = {
     name: "metadata";
-    metadata: {
-        names: string[];
-    };
+    metadata: AssetHistoryMetadata;
 };
 export type AssetHistoryEventLink = {
     name: "link";
@@ -47,4 +49,13 @@ export interface AssetHistoryContent<TAssetHistoryEvent extends AssetHistoryEven
      * Asset content after the event
      */
     asset: AssetContent<TMeasures, TMetadata>;
+    /**
+     * Timestamp of the event according to its type
+     *
+     *  - `measure`: the date of measure (`measuredAt`)
+     *  - `metadata`: the current date of the event
+     *  - `link`: the current date of the event
+     *  - `unlink`: the current date of the event
+     */
+    timestamp: number;
 }

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

@@ -8,7 +8,7 @@ import { DecoderContent } from "./types/DecoderContent";
  * This need to be read only so we can provide strong typing when decoding measures
  * with the DecodedPayload
  */
-export type NamedMeasures = ReadonlyArray<{
+export type NamedMeasures = Array<{
     name: string;
     type: string;
 }>;
@@ -37,7 +37,7 @@ export declare abstract class Decoder {
      *   { type: 'temperature', name: 'temperatureExterior' },
      * ];
      */
-    measures: NamedMeasures;
+    measures: ReadonlyArray<NamedMeasures[0]>;
     /**
      * Custom name for the associated API action in the "payload" controller
      */

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

@@ -1,5 +1,5 @@
 import { ControllerDefinition, KuzzleRequest } from "kuzzle";
-import { DecodersRegister } from "../../core/registers/DecodersRegister";
+import { DecodersRegister } from "./DecodersRegister";
 import { PayloadService } from "./PayloadService";
 import { ApiDecoderListResult, ApiDecoderPrunePayloadsResult } from "./types/DecoderApi";
 export declare class DecodersController {

package/dist/lib/{core/registers → modules/decoder}/DecodersRegister.d.ts

@@ -1,6 +1,7 @@
 import { PluginContext } from "kuzzle";
-import { Decoder, DecoderContent } from "../../modules/decoder";
-import { DeviceManagerPlugin } from "..";
+import { DeviceManagerPlugin } from "../plugin";
+import { Decoder } from "./Decoder";
+import { DecoderContent } from "./exports";
 export declare class DecodersRegister {
     private context;
     private plugin;

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

@@ -0,0 +1,5 @@
+export declare enum DecodingState {
+    SKIP = 0,
+    ERROR = 1,
+    VALID = 2
+}

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

@@ -1,6 +1,6 @@
 import { KuzzleRequest } from "kuzzle";
 import { JSONObject, KDocument } from "kuzzle-sdk";
-import { DeviceManagerPlugin } from "../../core";
+import { DeviceManagerPlugin } from "../plugin";
 import { DeviceContent } from "../device";
 import { DecodedMeasurement } from "../measure";
 import { Decoder } from "./Decoder";

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

@@ -1,5 +1,5 @@
 import { ControllerDefinition, KuzzleRequest } from "kuzzle";
-import { DecodersRegister } from "../../core/registers/DecodersRegister";
+import { DecodersRegister } from "./DecodersRegister";
 import { PayloadService } from "./PayloadService";
 import { ApiPayloadReceiveUnkownResult } from "./types/PayloadApi";
 export declare class PayloadsController {

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

@@ -0,0 +1,3 @@
+export declare class SkipError extends Error {
+    constructor(message: string);
+}

package/dist/lib/modules/decoder/collections/payloadsMappings.d.ts

@@ -17,5 +17,11 @@ export declare const payloadsMappings: {
         apiAction: {
             type: string;
         };
+        state: {
+            type: string;
+        };
+        reason: {
+            type: string;
+        };
     };
 };

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

@@ -6,3 +6,4 @@ export * from "./Decoder";
 export * from "./DecoderModule";
 export * from "./roles/RolePayloadsAll";
 export * from "./roles/RoleDecodersAdmin";
+export * from "./DecodersRegister";

package/dist/lib/modules/device/DeviceService.d.ts

@@ -4,7 +4,7 @@ import { AssetContent } from "./../asset";
 import { Metadata } from "../shared";
 import { DecodedMeasurement } from "../measure";
 import { DeviceContent } from "./types/DeviceContent";
-import { ApiDeviceLinkAssetRequest, ApiDeviceGetMeasuresResult } from "./types/DeviceApi";
+import { ApiDeviceLinkAssetRequest } from "./types/DeviceApi";
 export declare class DeviceService {
     private config;
     private context;
@@ -91,15 +91,6 @@ export declare class DeviceService {
         asset: KDocument<AssetContent>;
         device: KDocument<DeviceContent>;
     }>;
-    getMeasureHistory(engineId: string, deviceId: string, { size, from, endAt, startAt, query, sort, type, }: {
-        sort?: JSONObject;
-        query?: JSONObject;
-        from?: number;
-        size?: number;
-        startAt?: string;
-        endAt?: string;
-        type?: string;
-    }): Promise<ApiDeviceGetMeasuresResult>;
     private checkEngineExists;
     private checkAttachedToEngine;
     private getEngine;

package/dist/lib/modules/device/DevicesController.d.ts

@@ -1,10 +1,12 @@
-import { ControllerDefinition, KuzzleRequest } from "kuzzle";
+import { ControllerDefinition, HttpStream, KuzzleRequest } from "kuzzle";
+import { DeviceManagerPlugin } from "../plugin";
 import { DeviceService } from "./DeviceService";
 import { ApiDeviceAttachEngineResult, ApiDeviceCreateResult, ApiDeviceDeleteResult, ApiDeviceDetachEngineResult, ApiDeviceGetResult, ApiDeviceLinkAssetResult, ApiDeviceSearchResult, ApiDeviceUnlinkAssetResult, ApiDeviceUpdateResult, ApiDeviceGetMeasuresResult } from "./types/DeviceApi";
 export declare class DevicesController {
-    definition: ControllerDefinition;
+    private plugin;
     private deviceService;
-    constructor(deviceService: DeviceService);
+    definition: ControllerDefinition;
+    constructor(plugin: DeviceManagerPlugin, deviceService: DeviceService);
     get(request: KuzzleRequest): Promise<ApiDeviceGetResult>;
     update(request: KuzzleRequest): Promise<ApiDeviceUpdateResult>;
     delete(request: KuzzleRequest): Promise<ApiDeviceDeleteResult>;
@@ -30,5 +32,8 @@ export declare class DevicesController {
      */
     unlinkAsset(request: KuzzleRequest): Promise<ApiDeviceUnlinkAssetResult>;
     getMeasures(request: KuzzleRequest): Promise<ApiDeviceGetMeasuresResult>;
+    exportMeasures(request: KuzzleRequest): Promise<HttpStream | {
+        link: string;
+    }>;
     receiveMeasures(request: KuzzleRequest): Promise<void>;
 }

package/dist/lib/modules/device/collections/deviceMappings.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Base mappings for the "devices" collection.
+ *
+ * Those mappings does not contains the `measures` and `metadata` mappings.
+ */
 export declare const devicesMappings: {
     dynamic: string;
     properties: {

package/dist/lib/modules/device/exports.d.ts

@@ -4,3 +4,4 @@ export * from "./types/DeviceEvents";
 export * from "./roles/RoleDevicesAdmin";
 export * from "./roles/RoleDevicesPlatformAdmin";
 export * from "./roles/RoleDevicesReader";
+export * from "./collections/deviceMappings";

package/dist/lib/modules/device/roles/RoleDevicesAdmin.d.ts

@@ -14,6 +14,8 @@ import { KuzzleRole } from "../../shared/types/KuzzleRole";
         search: true,
         unlinkAsset: true,
         update: true,
+        getMeasures: true,
+        exportMeasures: true,
       },
     },
     "device-manager/models": {
@@ -22,6 +24,7 @@ import { KuzzleRole } from "../../shared/types/KuzzleRole";
         listDevices: true,
         getDevice: true,
         writeDevice: true,
+        listMeasures: true,
       },
     },
  */

package/dist/lib/modules/device/roles/RoleDevicesReader.d.ts

@@ -9,12 +9,15 @@ import { KuzzleRole } from "../../shared/types/KuzzleRole";
       actions: {
         get: true,
         search: true,
+        getMeasures: true,
+        exportMeasures: true,
       },
     },
     "device-manager/models": {
       actions: {
         listDevices: true,
         getDevice: true,
+        listMeasures: true,
       },
     },
     }

package/dist/lib/modules/device/types/DeviceApi.d.ts

@@ -130,6 +130,26 @@ export type ApiDeviceGetMeasuresResult = {
     measures: Array<KDocument<MeasureContent<JSONObject>>>;
     total: number;
 };
+/**
+ * This action can be used only with WebSocket or POST
+ *
+ * Then the export can be download using HTTP Get and the following route:
+ *  `/_/device-manager/:engineId/devices/:_id/measures/_export/:exportId`
+ */
+export interface ApiDeviceExportMeasuresRequest extends DevicesControllerRequest {
+    action: "exportMeasures";
+    _id: string;
+    startAt?: string;
+    endAt?: string;
+    type?: string;
+    body?: {
+        query?: JSONObject;
+        sort?: JSONObject;
+    };
+}
+export type ApiDeviceExportMeasuresResult = {
+    link: string;
+};
 export interface ApiDeviceReceiveMeasuresRequest<TMeasureValues extends JSONObject = JSONObject> extends DevicesControllerRequest {
     action: "receiveMeasures";
     _id: string;

package/dist/lib/modules/measure/MeasureExporter.d.ts

@@ -0,0 +1,61 @@
+/// <reference types="node" />
+import { PassThrough } from "node:stream";
+import { JSONObject, User } from "kuzzle";
+import { DeviceManagerPlugin } from "../plugin";
+import { MeasureContent } from "./exports";
+type ExportOptions = {
+    sort?: JSONObject;
+    query?: JSONObject;
+    from?: number;
+    size?: number;
+    startAt?: string;
+    endAt?: string;
+    type?: string;
+};
+type ExportParams = {
+    query: JSONObject;
+    target: "asset" | "device";
+    model: string;
+    sort: JSONObject;
+    id: string;
+};
+export declare class MeasureExporter {
+    private plugin;
+    private engineId;
+    private target?;
+    private get sdk();
+    constructor(plugin: DeviceManagerPlugin, engineId: string, { target }?: {
+        target?: "asset" | "device";
+    });
+    /**
+     * Searches for measures and return them in a standard JSON
+     */
+    search(digitalTwinId: string, { size, from, endAt, startAt, query, sort, type, }: ExportOptions): Promise<{
+        measures: import("kuzzle").KHit<MeasureContent<any, any>>[];
+        total: number;
+    }>;
+    /**
+     * Prepare a measure export by saving the parameters in Redis.
+     *
+     * We need this method to process the export in 2 steps:
+     *   - preparing the export with a POST or WebSocket request
+     *   - download the export (only with a browser <a> link)
+     *
+     * Never return a rejected promise and write potential error on the stream
+     */
+    prepareExport(user: User, digitalTwinId: string, { endAt, startAt, query, sort, type, }: ExportOptions): Promise<{
+        link: string;
+    }>;
+    /**
+     * Retrieve a prepared export and write each document as a CSV in the stream
+     *
+     * This method never returns a rejected promise, but write potential error in
+     * the stream.
+     */
+    sendExport(stream: PassThrough, exportId: string): Promise<void>;
+    getExport(exportId: string): Promise<ExportParams>;
+    private exportRedisKey;
+    private prepareMeasureSearch;
+    private getEngine;
+}
+export {};

package/dist/lib/modules/measure/MeasureService.d.ts

@@ -1,6 +1,6 @@
 import { JSONObject, KDocument } from "kuzzle";
-import { DeviceManagerPlugin } from "../../core";
-import { DeviceContent } from "./../device";
+import { DeviceContent } from "../device";
+import { DeviceManagerPlugin } from "../plugin";
 import { Metadata } from "../shared";
 import { DecodedMeasurement } from "./types/MeasureContent";
 export declare class MeasureService {
@@ -20,12 +20,17 @@ export declare class MeasureService {
      *
      * This method represents the ingestion pipeline:
      *  - build measures documents and update digital twins (device and asset)
-     *  - trigger events to enrich measures documents
+     *  - trigger events `before` (measure enrichment)
      *  - save documents (measures, device and asset)
-     *  - trigger events to trigger business rules
+     *  - trigger events `after`
      */
     ingest(device: KDocument<DeviceContent>, measurements: DecodedMeasurement<JSONObject>[], metadata: Metadata, payloadUuids: string[]): Promise<void>;
     private updateDeviceMeasures;
+    /**
+     * Update asset with each non-null non-computed measures.
+     *
+     * @returns A map of each asset state by measuredAt timestamp.
+     */
     private updateAssetMeasures;
     /**
      * Build the measures documents to save

package/dist/lib/modules/measure/collections/measuresMappings.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Base mappings for the "measures" collection.
+ *
+ * Those mappings does not contains the `values` mappings and `asset.metadata` mappings.
+ */
 export declare const measuresMappings: {
     dynamic: string;
     properties: {

package/dist/lib/modules/measure/exports.d.ts

@@ -4,3 +4,4 @@ export * from "./types/MeasureDefinition";
 export * from "./measures";
 export * from "./roles/RoleMeasuresAdmin";
 export * from "./roles/RoleMeasuresReader";
+export * from "./collections/measuresMappings";

package/dist/lib/modules/measure/index.d.ts

@@ -7,3 +7,4 @@ export * from "./MeasureModule";
 export * from "./roles/RoleMeasuresAdmin";
 export * from "./roles/RoleMeasuresReader";
 export * from "./collections/getEmbeddedMeasureMappings";
+export * from "./MeasureExporter";

package/dist/lib/modules/model/ModelService.d.ts

@@ -1,5 +1,5 @@
 import { JSONObject, KDocument } from "kuzzle-sdk";
-import { DeviceManagerPlugin } from "../../core";
+import { DeviceManagerPlugin } from "../plugin";
 import { AssetModelContent, DeviceModelContent, MeasureModelContent } from "./types/ModelContent";
 export declare class ModelService {
     private config;

package/dist/lib/{core/registers → modules/model}/ModelsRegister.d.ts

@@ -1,7 +1,7 @@
 import { JSONObject } from "kuzzle-sdk";
-import { NamedMeasures } from "../../modules/decoder";
-import { MeasureDefinition } from "../../modules/measure";
-import { DeviceManagerPlugin } from "../DeviceManagerPlugin";
+import { DeviceManagerPlugin } from "../plugin";
+import { NamedMeasures } from "../decoder";
+import { MeasureDefinition } from "../measure";
 export declare class ModelsRegister {
     private config;
     private context;

package/dist/lib/modules/model/collections/modelsMappings.d.ts

@@ -1,2 +1,5 @@
 import { CollectionMappings } from "kuzzle";
+/**
+ * Mappings for models configuration documents
+ */
 export declare const modelsMappings: CollectionMappings;

package/dist/lib/modules/model/index.d.ts

@@ -5,3 +5,4 @@ export * from "./types/ModelDefinition";
 export * from "./types/ModelEvents";
 export * from "./ModelModule";
 export * from "./ModelSerializer";
+export * from "./ModelsRegister";

package/dist/lib/{core → modules/plugin}/DeviceManagerEngine.d.ts

@@ -1,8 +1,16 @@
 import { Backend, Plugin } from "kuzzle";
 import { AbstractEngine, ConfigManager } from "kuzzle-plugin-commons";
-import { DeviceManagerConfiguration } from "./DeviceManagerConfiguration";
+import { EngineContent } from "kuzzle-plugin-commons/lib/engine/EngineContent";
+import { DeviceManagerConfiguration } from "./types/DeviceManagerConfiguration";
 import { DeviceManagerPlugin } from "./DeviceManagerPlugin";
-import { InternalCollection } from "./InternalCollection";
+import { InternalCollection } from "./types/InternalCollection";
+export type AskEngineList = {
+    name: "ask:device-manager:engine:list";
+    payload: {
+        group: string | null;
+    };
+    result: EngineContent[];
+};
 export type AskEngineUpdateAll = {
     name: "ask:device-manager:engine:updateAll";
     payload: void;
@@ -14,7 +22,7 @@ export declare class DeviceManagerEngine extends AbstractEngine<DeviceManagerPlu
     constructor(plugin: Plugin, adminConfigManager: ConfigManager, engineConfigManager: ConfigManager);
     updateEngines(): Promise<void>;
     onCreate(index: string, group?: string): Promise<{
-        collections: string[];
+        collections: any[];
     }>;
     onUpdate(index: string, group?: string): Promise<{
         collections: any[];

package/dist/lib/{core → modules/plugin}/DeviceManagerPlugin.d.ts

@@ -1,8 +1,8 @@
 import { Plugin, PluginContext } from "kuzzle";
 import { JSONObject } from "kuzzle-sdk";
-import { MeasureDefinition } from "../modules/measure";
-import { AssetModelDefinition, DeviceModelDefinition } from "../modules/model";
-import { DeviceManagerConfiguration } from "./DeviceManagerConfiguration";
+import { MeasureDefinition } from "../measure";
+import { AssetModelDefinition, DeviceModelDefinition } from "../model";
+import { DeviceManagerConfiguration } from "./types/DeviceManagerConfiguration";
 export declare class DeviceManagerPlugin extends Plugin {
     config: DeviceManagerConfiguration;
     private deviceManagerEngine;

package/dist/lib/modules/plugin/exports.d.ts

@@ -0,0 +1,2 @@
+export * from "./types/DeviceManagerConfiguration";
+export * from "./DeviceManagerPlugin";

package/dist/lib/modules/plugin/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./types/DeviceManagerConfiguration";
+export * from "./DeviceManagerEngine";
+export * from "./DeviceManagerPlugin";
+export * from "./types/InternalCollection";

package/dist/lib/modules/shared/Module.d.ts

@@ -1,4 +1,4 @@
-import { DeviceManagerPlugin } from "../../core/DeviceManagerPlugin";
+import { DeviceManagerPlugin } from "../plugin/DeviceManagerPlugin";
 export declare abstract class Module {
     protected plugin: DeviceManagerPlugin;
     protected get sdk(): import("kuzzle").EmbeddedSDK;

package/dist/lib/modules/shared/types/Metadata.d.ts

@@ -1,5 +1,6 @@
+import { JSONObject } from "kuzzle-sdk";
 export type MetadataValue = boolean | number | string | {
     lat: number;
     lon: number;
-} | null;
+} | null | JSONObject;
 export type Metadata = Record<string, MetadataValue | Record<string, MetadataValue>>;

package/dist/tests/application/decoders/DummyTempDecoder.d.ts

@@ -9,6 +9,7 @@ export declare class DummyTempDecoder extends Decoder {
         readonly type: "battery";
     }];
     constructor();
-    validate(payload: JSONObject): Promise<boolean>;
-    decode(decodedPayload: DecodedPayload<DummyTempDecoder>, payload: JSONObject): Promise<DecodedPayload<DummyTempDecoder>>;
+    validate(rawPayload: JSONObject): Promise<boolean>;
+    decode(decodedPayload: DecodedPayload<DummyTempDecoder>, rawPayload: JSONObject): Promise<DecodedPayload<DummyTempDecoder>>;
+    decodeSimplePayload(decodedPayload: DecodedPayload<DummyTempDecoder>, payload: JSONObject): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kuzzle-device-manager-types",
-  "version": "2.1.4",
+  "version": "2.2.0",
   "description": "Shared types for Kuzzle Device Manager",
   "author": "The Kuzzle Team (support@kuzzle.io)",
   "types": "dist/index.d.ts",

package/dist/lib/core/exports.d.ts

@@ -1,2 +0,0 @@
-export * from "./DeviceManagerConfiguration";
-export * from "./DeviceManagerPlugin";

package/dist/lib/core/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./DeviceManagerConfiguration";
-export * from "./DeviceManagerEngine";
-export * from "./DeviceManagerPlugin";
-export * from "./InternalCollection";

package/dist/tests/fixtures/fixtures.d.ts

@@ -1,42 +0,0 @@
-declare const _default: {
-    "device-manager": {
-        devices: ({
-            model: string;
-            reference: string;
-            metadata: {};
-            measures: {};
-        } | {
-            index: {
-                _id: string;
-            };
-        })[];
-    };
-    "engine-ayse": {
-        devices: ({
-            model: string;
-            reference: string;
-            metadata: {};
-            measures: {};
-            engineId: string;
-            assetId: any;
-        } | {
-            index: {
-                _id: string;
-            };
-        })[];
-        assets: ({
-            model: string;
-            reference: string;
-            metadata: {
-                weight: number;
-                height: number;
-            };
-            linkedDevices: any[];
-        } | {
-            index: {
-                _id: string;
-            };
-        })[];
-    };
-};
-export default _default;

package/dist/tests/helpers/document.d.ts

@@ -1,5 +0,0 @@
-import { Kuzzle } from "kuzzle-sdk";
-/**
- * Returns directly the document content
- */
-export declare function documentGet(sdk: Kuzzle, index: string, collection: string, id: string): Promise<import("kuzzle-sdk").KDocumentContentGeneric>;

package/dist/tests/helpers/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./sdk";
-export * from "./payloads";
-export * from "./document";
-export * from "./setup";

package/dist/tests/helpers/payloads.d.ts

@@ -1,18 +0,0 @@
-import { JSONObject, Kuzzle } from "kuzzle-sdk";
-export type DummyTempPayload = {
-    deviceEUI: string;
-    temperature: number;
-    measuredAt?: number;
-    battery?: number;
-    metadata?: JSONObject;
-};
-export type DummyTempPositionPayload = DummyTempPayload & {
-    location: {
-        lat: number;
-        lon: number;
-        accuracy?: number;
-    };
-};
-export declare function sendDummyTempPayloads(sdk: Kuzzle, payloads: DummyTempPayload[]): Promise<void>;
-export declare function sendDummyTempPositionPayloads(sdk: Kuzzle, payloads: DummyTempPositionPayload[]): Promise<void>;
-export declare function sendPayloads(sdk: Kuzzle, action: string, payloads: JSONObject[]): Promise<any>;

package/dist/tests/helpers/sdk.d.ts

@@ -1,2 +0,0 @@
-import { Kuzzle } from "kuzzle-sdk";
-export declare function useSdk(): Kuzzle;

package/dist/tests/helpers/setup.d.ts

@@ -1 +0,0 @@
-export declare function setupHooks(): import("kuzzle-sdk").Kuzzle;

package/dist/tests/hooks/collections.d.ts

@@ -1,3 +0,0 @@
-import { Kuzzle } from "kuzzle-sdk";
-export declare function truncateCollection(sdk: Kuzzle, index: string, collection: string): Promise<void>;
-export declare function beforeEachTruncateCollections(sdk: Kuzzle): Promise<void>;

package/dist/tests/hooks/engines.d.ts

@@ -1,2 +0,0 @@
-import { Kuzzle } from "kuzzle-sdk";
-export declare function beforeAllCreateEngines(sdk: Kuzzle): Promise<void>;

package/dist/tests/hooks/fixtures.d.ts

@@ -1,2 +0,0 @@
-import { Kuzzle } from "kuzzle-sdk";
-export declare function beforeEachLoadFixtures(sdk: Kuzzle): Promise<void>;

package/dist/tests/scenario/migrated/asset-controller.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/migrated/asset-history.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/migrated/asset-roles.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/migrated/decoder-decoders-controller.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/migrated/decoder-default-rights.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/migrated/decoder-payload-controller.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/migrated/decoder-payloads-mappings.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/migrated/decoder-roles.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/migrated/device-controller-attach-engine.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/migrated/device-controller-detach-engine.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/migrated/device-controller-get-measures.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/migrated/device-controller-unlink-asset.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/migrated/device-metadata.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/migrated/device-roles.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/migrated/measure-ingestion-pipeline.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/migrated/measure-provisionning.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/migrated/measure-roles.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/migrated/model-controller.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/modules/assets/action-get-measures.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/modules/assets/asset-history.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/modules/devices/action-attach-engine.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/modules/devices/action-link-asset.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/modules/devices/action-receive-measure.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/modules/devices/action-scrud.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/modules/ingestion-pipeline/before-ingestion.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/modules/ingestion-pipeline/propagation.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/tests/scenario/usecase/dynamicaly-register-device-model.test.d.ts

@@ -1 +0,0 @@
-export {};