kuzzle-device-manager-types 2.0.0-rc29 → 2.0.0-rc38

package/README.md

@@ -0,0 +1,17 @@
+# Kuzzle Device Manager Types
+
+This package only contains types to work with in a frontend application.
+
+```
+
+import { DeviceContent } from 'kuzzle-device-manager-types';
+
+
+let device: DeviceContent;
+
+device.model = "Abeeway";
+```
+
+See main package for more informations:
+ - [Github](https://github.com/kuzzleio/kuzzle-device-manager)
+ - [NPM](https://www.npmjs.com/package/kuzzle-device-manager)

package/dist/features/fixtures/application/decoders/DummyTempDecoder.d.ts

@@ -7,5 +7,5 @@ export declare class DummyTempDecoder extends Decoder {
     }];
     constructor();
     validate(payload: JSONObject): Promise<boolean>;
-    decode(payload: JSONObject): Promise<DecodedPayload<Decoder>>;
+    decode(decodedPayload: DecodedPayload<DummyTempDecoder>, payload: JSONObject): Promise<DecodedPayload<DummyTempDecoder>>;
 }

package/dist/features/fixtures/application/decoders/DummyTempPositionDecoder.d.ts

@@ -12,5 +12,5 @@ export declare class DummyTempPositionDecoder extends Decoder {
         readonly type: "position";
     }];
     validate(payload: JSONObject): Promise<boolean>;
-    decode(payload: JSONObject): Promise<DecodedPayload<Decoder>>;
+    decode(decodedPayload: DecodedPayload<DummyTempPositionDecoder>, payload: JSONObject): Promise<DecodedPayload<DummyTempPositionDecoder>>;
 }

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-export * from './lib/core/DeviceManagerPlugin';
-export * from './lib/core/DeviceManagerConfiguration';
-export * from './lib/modules/asset';
-export * from './lib/modules/device';
-export * from './lib/modules/measure';
-export * from './lib/modules/decoder';
-export * from './lib/modules/shared';
+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';

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

@@ -1,5 +1,5 @@
 import { JSONObject } from "kuzzle";
-export declare type DeviceManagerConfiguration = {
+export type DeviceManagerConfiguration = {
     /**
      * Ignore errors at startup such as wrong mappings update.
      *

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

@@ -3,7 +3,7 @@ import { AbstractEngine, ConfigManager } from "kuzzle-plugin-commons";
 import { DeviceManagerConfiguration } from "./DeviceManagerConfiguration";
 import { DeviceManagerPlugin } from "./DeviceManagerPlugin";
 import { InternalCollection } from "./InternalCollection";
-export declare type AskEngineUpdateAll = {
+export type AskEngineUpdateAll = {
     name: "ask:device-manager:engine:updateAll";
     payload: void;
     result: void;
@@ -20,9 +20,10 @@ export declare class DeviceManagerEngine extends AbstractEngine<DeviceManagerPlu
         collections: any[];
     }>;
     onDelete(index: string): Promise<{
-        collections: string[];
+        collections: InternalCollection[];
     }>;
     createAssetsCollection(engineId: string, engineGroup: string): Promise<InternalCollection>;
+    createAssetsHistoryCollection(engineId: string, engineGroup: string): Promise<InternalCollection>;
     private getDigitalTwinMappings;
     createDevicesCollection(engineId: string): Promise<InternalCollection>;
     createMeasuresCollection(engineId: string, engineGroup: string): Promise<InternalCollection>;

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

@@ -1,10 +1,11 @@
 import { Plugin, PluginContext, JSONObject } from "kuzzle";
 import { MeasureDefinition } from "../modules/measure";
 import { AssetModelDefinition, DeviceModelDefinition } from "../modules/model";
+import { KuzzleRole } from "../modules/shared";
 import { DeviceManagerConfiguration } from "./DeviceManagerConfiguration";
 export declare class DeviceManagerPlugin extends Plugin {
     config: DeviceManagerConfiguration;
-    roles: {};
+    roles: KuzzleRole[];
     private deviceManagerEngine;
     private adminConfigManager;
     private engineConfigManager;
@@ -23,7 +24,7 @@ export declare class DeviceManagerPlugin extends Plugin {
          *
          * @param engineGroup Engine group name
          * @param model Name of the asset model
-         * @param definition.measuresNames Array describing measures names and types
+         * @param definition.measures Array describing measures names and types
          * @param definition.metadataMappings Metadata mappings definition
          * @param definition.defaultMetadata Default metadata values
          *
@@ -31,9 +32,9 @@ export declare class DeviceManagerPlugin extends Plugin {
          * ```
          * deviceManager.models.registerAsset(
          *   "logistic",
-         *   "container",
+         *   "Container",
          *   {
-         *     measuresNames: [
+         *     measures: [
          *       { name: "temperatureExt", type: "temperature" },
          *       { name: "temperatureInt", type: "temperature" },
          *       { name: "position", type: "position" },

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

@@ -1,5 +1,6 @@
 export declare enum InternalCollection {
     ASSETS = "assets",
+    ASSETS_HISTORY = "assets-history",
     DEVICES = "devices",
     MEASURES = "measures",
     MODELS = "models",

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

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

package/dist/lib/core/registers/ModelsRegister.d.ts

@@ -1,5 +1,6 @@
 import { JSONObject } from "kuzzle";
-import { MeasureDefinition } from "lib/modules/measure";
+import { NamedMeasures } from "../../modules/decoder";
+import { MeasureDefinition } from "../../modules/measure";
 import { DeviceManagerPlugin } from "../DeviceManagerPlugin";
 export declare class ModelsRegister {
     private config;
@@ -10,8 +11,8 @@ export declare class ModelsRegister {
     private get sdk();
     init(plugin: DeviceManagerPlugin): void;
     loadModels(): Promise<void>;
-    registerAsset(engineGroup: string, model: string, metadataMappings: JSONObject, measures: Record<string, string>, defaultMetadata?: JSONObject): void;
-    registerDevice(model: string, metadataMappings: JSONObject, measures: Record<string, string>, defaultMetadata?: JSONObject): void;
+    registerAsset(engineGroup: string, model: string, measures: NamedMeasures, metadataMappings?: JSONObject, defaultMetadata?: JSONObject): void;
+    registerDevice(model: string, measures: NamedMeasures, metadataMappings?: JSONObject, defaultMetadata?: JSONObject): void;
     registerMeasure(type: string, measureDefinition: MeasureDefinition): void;
     private load;
 }

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

@@ -0,0 +1,11 @@
+import { KDocument } from "kuzzle";
+import { DeviceManagerPlugin } from "../../core";
+import { AssetHistoryEvent } from "./types/AssetHistoryContent";
+import { AssetContent } from "./types/AssetContent";
+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>;
+}

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

@@ -1,6 +1,7 @@
 import { Module } from "../shared/Module";
 export declare class AssetModule extends Module {
     private assetService;
+    private assetHistoryService;
     private assetController;
     init(): Promise<void>;
 }

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

@@ -1,14 +1,17 @@
-import { JSONObject, KDocument, KHit, SearchResult } from "kuzzle";
+import { JSONObject, KDocument, KHit, SearchResult, User } from "kuzzle";
 import { MeasureContent } from "../measure/";
 import { Metadata } from "../shared";
 import { DeviceManagerPlugin } from "../../core";
 import { AssetContent } from "./types/AssetContent";
+import { AssetHistoryService } from "./AssetHistoryService";
 export declare class AssetService {
     private context;
     private config;
+    private assetHistoryService;
     private get sdk();
     private get app();
-    constructor(plugin: DeviceManagerPlugin);
+    private get impersonatedSdk();
+    constructor(plugin: DeviceManagerPlugin, assetHistoryService: AssetHistoryService);
     /**
      * Returns measures history for an asset
      *
@@ -24,13 +27,16 @@ export declare class AssetService {
         endAt?: string;
     }): Promise<KDocument<MeasureContent>[]>;
     get(engineId: string, assetId: string): Promise<KDocument<AssetContent>>;
-    update(engineId: string, assetId: string, metadata: Metadata, { refresh }: {
+    /**
+     * Updates an asset metadata
+     */
+    update(user: User, engineId: string, assetId: string, metadata: Metadata, { refresh }: {
         refresh: any;
     }): Promise<KDocument<AssetContent>>;
-    create(engineId: string, model: string, reference: string, metadata: JSONObject, { refresh }: {
+    create(user: User, engineId: string, model: string, reference: string, metadata: JSONObject, { refresh }: {
         refresh: any;
     }): Promise<KDocument<AssetContent>>;
-    delete(engineId: string, assetId: string, { refresh, strict }: {
+    delete(user: User, engineId: string, assetId: string, { refresh, strict }: {
         refresh: any;
         strict: boolean;
     }): Promise<void>;

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

@@ -0,0 +1,63 @@
+export declare const assetsHistoryMappings: {
+    dynamic: string;
+    properties: {
+        event: {
+            properties: {
+                name: {
+                    type: string;
+                };
+                measure: {
+                    properties: {
+                        names: {
+                            type: string;
+                        };
+                    };
+                };
+                metadata: {
+                    properties: {
+                        names: {
+                            type: string;
+                        };
+                    };
+                };
+                link: {
+                    properties: {
+                        deviceId: {
+                            type: string;
+                        };
+                    };
+                };
+                unlink: {
+                    properties: {
+                        deviceId: {
+                            type: string;
+                        };
+                    };
+                };
+            };
+        };
+        id: {
+            type: string;
+        };
+        asset: {
+            properties: {
+                _kuzzle_info: {
+                    properties: {
+                        author: {
+                            type: string;
+                        };
+                        createdAt: {
+                            type: string;
+                        };
+                        updatedAt: {
+                            type: string;
+                        };
+                        updater: {
+                            type: string;
+                        };
+                    };
+                };
+            };
+        };
+    };
+};

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

@@ -28,9 +28,15 @@ export declare const assetsMappings: {
                 _id: {
                     type: string;
                 };
-                measures: {
-                    dynamic: string;
-                    properties: {};
+                measureNames: {
+                    properties: {
+                        asset: {
+                            type: string;
+                        };
+                        device: {
+                            type: string;
+                        };
+                    };
                 };
             };
         };

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

@@ -0,0 +1,6 @@
+export * from "./types/AssetContent";
+export * from "./types/AssetHistoryContent";
+export * from "./types/AssetEvents";
+export * from "./types/AssetApi";
+export * from "./roles/RoleAssetsAdmin";
+export * from "./roles/RoleAssetsReader";

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

@@ -1,6 +1,10 @@
 export * from "./collections/assetsMappings";
+export * from "./collections/assetsHistoryMappings";
 export * from "./types/AssetContent";
+export * from "./types/AssetHistoryContent";
 export * from "./types/AssetEvents";
 export * from "./types/AssetApi";
 export * from "./model/AssetSerializer";
 export * from "./AssetModule";
+export * from "./roles/RoleAssetsAdmin";
+export * from "./roles/RoleAssetsReader";

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

@@ -0,0 +1,22 @@
+import { KuzzleRole } from "../../shared/types/KuzzleRole";
+/**
+ * This role allows to manage assets and their models.
+ *
+ * It's a tenant role.
+ *
+ * @example
+ *
+    "device-manager/assets": {
+      actions: {
+        "*": true,
+      },
+    },
+    "device-manager/models": {
+      actions: {
+        deleteAsset: true,
+        listAssets: true,
+        writeAsset: true,
+      },
+    },
+ */
+export declare const RoleAssetsAdmin: KuzzleRole;

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

@@ -0,0 +1,21 @@
+import { KuzzleRole } from "../../shared/types/KuzzleRole";
+/**
+ * This role only gives a read-only access to assets and their models.
+ *
+ * It's a tenant role.
+ *
+ * @example
+    "device-manager/assets": {
+      actions: {
+        get: true,
+        getMeasures: true,
+        search: true,
+      },
+    },
+    "device-manager/models": {
+      actions: {
+        listAssets: true,
+      },
+    },
+ */
+export declare const RoleAssetsReader: KuzzleRole;

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

@@ -10,7 +10,7 @@ export interface ApiAssetGetRequest extends AssetsControllerRequest {
     action: "get";
     _id: string;
 }
-export declare type ApiAssetGetResult = KDocument<AssetContent>;
+export type ApiAssetGetResult = KDocument<AssetContent>;
 export interface ApiAssetUpdateRequest extends AssetsControllerRequest {
     action: "update";
     _id: string;
@@ -19,7 +19,7 @@ export interface ApiAssetUpdateRequest extends AssetsControllerRequest {
         metadata: Metadata;
     };
 }
-export declare type ApiAssetUpdateResult = KDocument<AssetContent>;
+export type ApiAssetUpdateResult = KDocument<AssetContent>;
 export interface ApiAssetCreateRequest extends AssetsControllerRequest {
     action: "create";
     refresh?: string;
@@ -29,14 +29,14 @@ export interface ApiAssetCreateRequest extends AssetsControllerRequest {
         metadata?: Metadata;
     };
 }
-export declare type ApiAssetCreateResult = KDocument<AssetContent>;
+export type ApiAssetCreateResult = KDocument<AssetContent>;
 export interface ApiAssetDeleteRequest extends AssetsControllerRequest {
     action: "delete";
     _id: string;
     refresh?: string;
     strict?: boolean;
 }
-export declare type ApiAssetDeleteResult = void;
+export type ApiAssetDeleteResult = void;
 export interface ApiAssetSearchRequest extends AssetsControllerRequest {
     action: "search";
     from?: number;
@@ -44,7 +44,7 @@ export interface ApiAssetSearchRequest extends AssetsControllerRequest {
     scrollTTL?: string;
     body: JSONObject;
 }
-export declare type ApiAssetSearchResult = SearchResult<KHit<AssetContent>>;
+export type ApiAssetSearchResult = SearchResult<KHit<AssetContent>>;
 export interface ApiAssetGetMeasuresRequest extends AssetsControllerRequest {
     action: "getMeasures";
     _id: string;
@@ -52,7 +52,7 @@ export interface ApiAssetGetMeasuresRequest extends AssetsControllerRequest {
     startAt?: string;
     endAt?: string;
 }
-export declare type ApiAssetGetMeasuresResult = {
+export type ApiAssetGetMeasuresResult = {
     measures: Array<KDocument<MeasureContent<JSONObject>>>;
 };
 export {};

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

@@ -13,23 +13,26 @@ export interface AssetContent<TMeasures extends JSONObject = any, TMetadata exte
          */
         _id: string;
         /**
-         * Names lookup table for measures
+         * Names of the linked measures
          *
-         * Record<deviceName, assetName>
+         * Array<{ asset: string, device: string }>
          *
          * @example
          *
-         * {
-         *   "temperature": "externalTemperature",
-         * }
+         * [
+         *   { asset: "externalTemperature", device: "temperature" }
+         * ]
          */
-        measures: Record<string, string>;
+        measureNames: Array<{
+            asset: string;
+            device: string;
+        }>;
     }>;
 }
 /**
  * Asset description used to contextualize each measure data point
  */
-export declare type AssetMeasureContext<TMetadata extends Metadata = Metadata> = {
+export type AssetMeasureContext<TMetadata extends Metadata = Metadata> = {
     /**
      * ID of the asset
      */

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

@@ -1,17 +1,30 @@
 import { KDocument } from "kuzzle";
 import { Metadata } from "../../../modules/shared";
 import { AssetContent } from "./AssetContent";
-export declare type EventAssetUpdateBefore = {
+import { AssetHistoryEvent } from "./AssetHistoryContent";
+export type EventAssetUpdateBefore = {
     name: "device-manager:asset:update:before";
     args: [{
         asset: KDocument<AssetContent>;
         metadata: Metadata;
     }];
 };
-export declare type EventAssetUpdateAfter = {
+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/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/decoder/DecodedPayload.d.ts

@@ -43,4 +43,5 @@ export declare class DecodedPayload<TDecoder extends Decoder = Decoder> {
      * Get the metadata for a device
      */
     getMetadata(deviceReference: string): JSONObject;
+    private validateMeasurement;
 }

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

@@ -4,7 +4,7 @@ import { DecoderContent } from "./types/DecoderContent";
 /**
  * Array of measures declaration
  */
-export declare type NamedMeasures = ReadonlyArray<{
+export type NamedMeasures = ReadonlyArray<{
     name: string;
     type: string;
 }>;
@@ -82,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 DecodedPayload
      */
-    abstract decode(payload: JSONObject, request: KuzzleRequest): Promise<DecodedPayload<Decoder>>;
+    abstract decode(decodedPayload: DecodedPayload<any>, payload: JSONObject, request: KuzzleRequest): Promise<DecodedPayload<any>>;
     /**
      * Checks if the provided properties are present in the payload
      *

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

@@ -0,0 +1,6 @@
+export * from "./types/DecoderApi";
+export * from "./types/DecoderContent";
+export * from "./DecodedPayload";
+export * from "./Decoder";
+export * from "./roles/RolePayloadsAll";
+export * from "./roles/RoleDecodersAdmin";

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

@@ -4,3 +4,5 @@ export * from "./types/DecoderContent";
 export * from "./DecodedPayload";
 export * from "./Decoder";
 export * from "./DecoderModule";
+export * from "./roles/RolePayloadsAll";
+export * from "./roles/RoleDecodersAdmin";

package/dist/lib/modules/decoder/roles/RoleDecodersAdmin.d.ts

@@ -0,0 +1,14 @@
+import { KuzzleRole } from "../../shared/types/KuzzleRole";
+/**
+ * Role used to manage decoders and their payloads.
+ *
+ * It's a platform role.
+ *
+ * @example
+    "device-manager/decoders": {
+      actions: {
+        "*": true,
+      },
+    },
+ */
+export declare const RoleDecodersAdmin: KuzzleRole;

package/dist/lib/modules/decoder/roles/RolePayloadsAll.d.ts

@@ -0,0 +1,12 @@
+import { KuzzleRole } from "../../shared/types/KuzzleRole";
+/**
+ * This role allows to receive any kind of payloads.
+ *
+@example
+    "device-manager/payloads": {
+      actions: {
+        "*": true,
+      },
+    },
+ */
+export declare const RolePayloadsAll: KuzzleRole;

package/dist/lib/modules/decoder/types/DecoderApi.d.ts

@@ -6,14 +6,14 @@ export interface ApiDecoderListRequest extends DecodersControllerRequest {
     action: "list";
     _id: string;
 }
-export declare type ApiDecoderListResult = {
+export type ApiDecoderListResult = {
     decoders: DecoderContent[];
 };
 export interface ApiDecoderPrunePayloadsRequest extends DecodersControllerRequest {
     action: "prunePayloads";
     _id: string;
 }
-export declare type ApiDecoderPrunePayloadsResult = {
+export type ApiDecoderPrunePayloadsResult = {
     deleted: number;
 };
 export {};

package/dist/lib/modules/decoder/types/PayloadApi.d.ts

@@ -7,5 +7,5 @@ export interface ApiPayloadReceiveUnkownRequest extends PayloadsControllerReques
     deviceModel: string;
     body: JSONObject;
 }
-export declare type ApiPayloadReceiveUnkownResult = void;
+export type ApiPayloadReceiveUnkownResult = void;
 export {};