kuzzle-device-manager 3.0.0-3-dev.19 → 3.0.0-3-dev.21

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

@@ -5,6 +5,7 @@ import { DeviceManagerPlugin } from "./DeviceManagerPlugin";
 import { DeviceManagerConfiguration } from "./types/DeviceManagerConfiguration";
 import { InternalCollection } from "./types/InternalCollection";
 import { ConflictChunk } from "../model/ModelsConflicts";
+import { MetadataMappings } from "../model/types/ModelContent";
 export type TwinType = "asset" | "device";
 export type TwinModelContent = AssetModelContent | DeviceModelContent;
 export interface EngineDocument extends KDocumentContent {
@@ -18,7 +19,7 @@ export interface EngineDocument extends KDocumentContent {
 export type AskEngineList = {
     name: "ask:device-manager:engine:list";
     payload: {
-        group?: string;
+        tenantClass?: string;
     };
     result: EngineContent[];
 };
@@ -39,10 +40,42 @@ export type AskEngineUpdateConflict = {
     };
     result: ConflictChunk[];
 };
+/**
+ * Checks a metadata of the metadata referential against the actual metadata mappings
+ * of the assets, devices and groups collections of every engine
+ */
+export type AskEngineMetadataConflict = {
+    name: "ask:device-manager:engine:doesMetadataConflict";
+    payload: {
+        metadataMappings: MetadataMappings;
+    };
+    result: ConflictChunk[];
+};
 export declare class DeviceManagerEngine extends AbstractEngine<DeviceManagerPlugin> {
     config: DeviceManagerConfiguration;
     get app(): Backend;
     constructor(plugin: Plugin, platformConfigManager: ConfigManager, engineConfigManager: ConfigManager);
+    /**
+     * Returns the actual metadata mappings of an engine collection
+     *
+     * @returns The mappings of the metadata properties, empty if the collection does not exist
+     */
+    private getCollectionMetadataMappings;
+    /**
+     * Return conflicts between the metadata mappings of models and the actual mappings
+     * of their collection in an engine
+     *
+     * @param engineIndex The target engine
+     * @param modelType The models type
+     * @param models The new or updated models, with their referential metadata resolved
+     * @returns An array of ConflictChunk
+     */
+    private getModelsMetadataConflicts;
+    /**
+     * Merges the mappings of the metadata referential and of models into metadata mappings.
+     * Every referential metadata is merged, used by a model or not.
+     */
+    private mergeMetadataMappings;
     /**
      * Return conflicts between the new and already present twin models
      *
@@ -79,10 +112,10 @@ export declare class DeviceManagerEngine extends AbstractEngine<DeviceManagerPlu
      */
     getEngines(): Promise<EngineDocument[]>;
     updateMeasuresSchema(): Promise<void>;
-    onCreate(index: string, group?: string): Promise<{
+    onCreate(index: string, tenantClass?: string): Promise<{
         collections: any[];
     }>;
-    onUpdate(index: string, group?: string): Promise<{
+    onUpdate(index: string, tenantClass?: string): Promise<{
         collections: any[];
     }>;
     onDelete(index: string): Promise<{
@@ -91,44 +124,44 @@ export declare class DeviceManagerEngine extends AbstractEngine<DeviceManagerPlu
     /**
      * Generate assets mappings and create the assets collection in the engine
      *
-     * @param engineId The target engine Id
-     * @param engineGroup The engine group
+     * @param index The target engine Id
+     * @param tenantClass The tenant class
      *
      * @throws If it failed during the assets collection creation
      */
-    createAssetsCollection(engineId: string, engineGroup: string): Promise<InternalCollection>;
+    createAssetsCollection(index: string, tenantClass: string): Promise<InternalCollection>;
     /**
      * Generate assets mappings and create the assets history collection in the engine
      *
-     * @param engineId The target engine Id
-     * @param engineGroup The engine group
+     * @param index The target engine Id
+     * @param tenantClass The tenant class
      *
      * @throws If it failed during the assets history collection creation
      */
-    createAssetsHistoryCollection(engineId: string, engineGroup: string): Promise<InternalCollection>;
+    createAssetsHistoryCollection(index: string, tenantClass: string): Promise<InternalCollection>;
     /**
      * Create the groups collection with the groups mappings in the engine
      *
-     * @param engineId The target engine Id
-     * @param engineGroup The engine group
+     * @param index The target engine Id
+     * @param tenantClass The tenant class
      *
      * @throws If it failed during the groups collection creation
      */
-    createGroupsCollection(engineId: string): Promise<InternalCollection>;
+    createGroupsCollection(index: string): Promise<InternalCollection>;
     /**
      * Generate devices mappings and create the devices collection in the engine
      *
-     * @param engineId The target engine Id
-     * @param engineGroup The engine group
+     * @param index The target engine Id
+     * @param tenantClass The tenant class
      *
      * @throws If it failed during the devices collection creation
      */
-    createDevicesCollection(engineId: string): Promise<InternalCollection>;
+    createDevicesCollection(index: string): Promise<InternalCollection>;
     /**
      * Generate devices mappings and create the devices collection in the engine
      *
-     * @param engineId The target engine Id
-     * @param engineGroup The engine group
+     * @param index The target engine Id
+     * @param tenantClass The tenant class
      *
      * @throws If it failed during the devices collection creation
      */
@@ -136,12 +169,12 @@ export declare class DeviceManagerEngine extends AbstractEngine<DeviceManagerPlu
     /**
      * Generate measures mappings and create the measures collection in the engine
      *
-     * @param engineId The target engine Id
-     * @param engineGroup The engine group
+     * @param index The target engine Id
+     * @param tenantClass The tenant class
      *
      * @throws If it failed during the measures collection creation
      */
-    createMeasuresCollection(engineId: string, engineGroup: string): Promise<InternalCollection>;
+    createMeasuresCollection(index: string, tenantClass: string): Promise<InternalCollection>;
     /**
      * Create a collection with custom mappings in an engine
      *
@@ -156,7 +189,7 @@ export declare class DeviceManagerEngine extends AbstractEngine<DeviceManagerPlu
      * Generate ES mappings from twin models and theirs associated measures, all fetched from the database
      *
      * @param digitalTwinType The target twin type
-     * @param engineGroup The twin engine group
+     * @param tenantClass The twin tenant class
      * @returns The complete ES mappings produces by merging all the target type twins
      */
     private getDigitalTwinMappingsFromDB;
@@ -172,7 +205,7 @@ export declare class DeviceManagerEngine extends AbstractEngine<DeviceManagerPlu
     /**
      * Generate ES mappings from measures and theirs associated assets, all fetched via the database
      *
-     * @param engineGroup The target engine group
+     * @param tenantClass The target tenant class
      * @returns The complete ES mappings produced by merging models mappings
      */
     private getMeasuresMappingsFromDB;
@@ -188,16 +221,16 @@ export declare class DeviceManagerEngine extends AbstractEngine<DeviceManagerPlu
     /**
      * Retrieve a certain type of models associated to an engine
      *
-     * @param engineId The target engine Id
+     * @param index The target engine Id
      * @param type The desired model type
-     * @param engineGroup The target engine group
+     * @param tenantClass The target tenant class
      * @returns An array of the generic type provided
      */
     private getModels;
     /**
      * Detach all devices of an index in the platform index
      *
-     * @param engineId The target engine Id
+     * @param index The target engine Id
      * @returns {any}
      */
     private detachDevicesFromPlatformIndex;