kuzzle-device-manager-types 2.11.0-dev.1 → 3.0.0-3-dev.1

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

@@ -1,50 +1,27 @@
-import { JSONObject, KDocument } from "kuzzle";
-import { DeviceContent } from "../device";
+import { JSONObject } from "kuzzle";
 import { DeviceManagerPlugin } from "../plugin";
-import { BaseService, Metadata } from "../shared";
+import { BaseService } from "../shared";
 import { DecodedMeasurement } from "./types/MeasureContent";
-import { ApiMeasureSource } from "./types/MeasureSources";
-import { ApiMeasureTarget } from "./types/MeasureTarget";
+import { MeasureSource } from "./types/MeasureSources";
+import { MeasureTarget } from "./types/MeasureTarget";
 import { KuzzleLogger } from "kuzzle-logger";
 export declare class MeasureService extends BaseService {
     readonly logger: KuzzleLogger;
     constructor(plugin: DeviceManagerPlugin, logger: KuzzleLogger);
     /**
-     * Register new measures from an API, updates :
+     * Register new measures updates :
      * - asset
      * - engine measures
      *
      * This method represents the ingestion pipeline:
      *  - trigger events `before` (measure enrichment)
-     *  - save documents (measures and asset)
+     *  - save documents (measures & device metadata)
      *  - trigger events `after`
      */
-    ingestApi(source: ApiMeasureSource, target: ApiMeasureTarget, measurements: DecodedMeasurement<JSONObject>[], payloadUuids: string[]): Promise<void>;
-    /**
-     * Register new measures from a device, updates :
-     * - admin device
-     * - engine device
-     * - linked asset
-     * - engine measures
-     *
-     * A mutex ensure that a device can ingest one measure at a time.
-     *
-     * This method represents the ingestion pipeline:
-     *  - build measures documents and update digital twins (device and asset)
-     *  - trigger events `before` (measure enrichment)
-     *  - save documents (measures, device and asset)
-     *  - trigger events `after`
-     *
-     * @deprecated
-     */
-    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;
+    ingest(source: MeasureSource, target: MeasureTarget, measurements: DecodedMeasurement<JSONObject>[], payloadUuids: string[]): Promise<void>;
+    private buildDeviceMeasures;
+    private ingestDeviceMeasures;
+    private ingestApiMeasures;
     /**
      * Build the measures document received from the API
      *
@@ -52,14 +29,10 @@ export declare class MeasureService extends BaseService {
      * @param asset The target asset to build the measure for
      * @param measure The decoded raw measures
      * @param payloadUuids The uuid's of the payloads used to create the measure
-     *
+     * @param engineGroup engineGroup of model
      * @returns A MeasurementContent builded from parameters
      */
     private buildApiMeasures;
-    /**
-     * Build the measures documents to save
-     */
-    private buildMeasures;
     /**
      * Find an asset by its ID and its engine ID.
      *
@@ -89,9 +62,4 @@ export declare class MeasureService extends BaseService {
      * @throws If the device is not linked to the asset
      */
     private findAssetMeasureNameFromDevice;
-    private mutexUpdateAsset;
-    /**
-     * Create a new document in the collection asset-history, for each asset state
-     */
-    private historizeAssetStates;
 }

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

@@ -6,5 +6,4 @@ export declare const enum DATA_SOURCE_METADATA_TYPE {
     DEVICE = "device"
 }
 export declare function apiSourceToOriginApi(source: ApiMeasureSource, payloadUuids: string[]): MeasureOriginApi;
-export declare function toDeviceSource(dataSourceId: string, reference: string, model: string, metadata?: Metadata, lastMeasuredAt?: number): DeviceMeasureSource;
-export declare function deviceSourceToOriginDevice(source: DeviceMeasureSource, measureName: string, payloadUuids: string[]): MeasureOriginDevice;
+export declare function deviceSourceToOriginDevice(source: DeviceMeasureSource, measureName: string, payloadUuids: string[], deviceMetadata: Metadata): MeasureOriginDevice;

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

@@ -1,3 +1,3 @@
 import { ApiMeasureTarget, DeviceMeasureTarget } from "./types/MeasureTarget";
-export declare function toApiTarget(indexId: string, assetId: string, engineGroup?: string): ApiMeasureTarget;
+export declare function toApiTarget(indexId: string, assetId: string, engineGroups?: string[]): ApiMeasureTarget;
 export declare function toDeviceTarget(indexId: string, assetId?: string): DeviceMeasureTarget;

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

@@ -1,96 +1,7 @@
+import { CollectionMappings } from "kuzzle-sdk";
 /**
  * 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: {
-        type: {
-            type: string;
-        };
-        values: {
-            properties: {};
-        };
-        /**
-         * Micro Timestamp of the measurement time.
-         */
-        measuredAt: {
-            type: string;
-        };
-        asset: {
-            properties: {
-                _id: {
-                    type: string;
-                };
-                model: {
-                    type: string;
-                };
-                reference: {
-                    type: string;
-                };
-                measureName: {
-                    type: string;
-                };
-                metadata: {
-                    properties: {};
-                };
-                groups: {
-                    properties: {
-                        id: {
-                            type: string;
-                            fields: {
-                                text: {
-                                    type: string;
-                                };
-                            };
-                        };
-                        date: {
-                            type: string;
-                        };
-                    };
-                };
-                softTenant: {
-                    type: string;
-                    fields: {
-                        text: {
-                            type: string;
-                        };
-                    };
-                };
-            };
-        };
-        /**
-         * Define the origin of the measure.
-         */
-        origin: {
-            properties: {
-                type: {
-                    type: string;
-                };
-                measureName: {
-                    type: string;
-                };
-                deviceMetadata: {
-                    properties: {};
-                };
-                apiMetadata: {
-                    dynamic: string;
-                    properties: {};
-                };
-                payloadUuids: {
-                    type: string;
-                };
-                deviceModel: {
-                    type: string;
-                };
-                reference: {
-                    type: string;
-                };
-                _id: {
-                    type: string;
-                };
-            };
-        };
-    };
-};
+export declare const measuresMappings: CollectionMappings;

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

@@ -1,7 +1,6 @@
 export * from "./types/MeasureEvents";
 export * from "./types/MeasureContent";
 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

@@ -2,7 +2,6 @@ export * from "./collections/measuresMappings";
 export * from "./types/MeasureEvents";
 export * from "./types/MeasureContent";
 export * from "./types/MeasureDefinition";
-export * from "./measures";
 export * from "./MeasureModule";
 export * from "./roles/RoleMeasuresAdmin";
 export * from "./roles/RoleMeasuresReader";

package/dist/lib/modules/measure/types/MeasureContent.d.ts

@@ -1,6 +1,6 @@
 import { JSONObject, KDocumentContent } from "kuzzle-sdk";
-import { Metadata } from "../../../modules/shared";
-import { AssetMeasureContext } from "../../../modules/asset";
+import { Metadata } from "../../shared";
+import { AssetMeasureContext } from "../../asset";
 interface AbstractMeasureOrigin {
     /**
      * Origin of the measure
@@ -35,6 +35,13 @@ export interface MeasureOriginDevice extends AbstractMeasureOrigin {
      * Origin device metadata
      */
     deviceMetadata?: Metadata;
+    /**
+     * Origin device groups
+     */
+    groups: Array<{
+        path: string;
+        date: number;
+    }>;
     /**
      * Device ID
      */

package/dist/lib/modules/measure/types/MeasureEvents.d.ts

@@ -1,25 +1,8 @@
-import { JSONObject, KDocument } from "kuzzle-sdk";
-import { DeviceContent } from "../../../modules/device";
-import { AssetContent } from "../../../modules/asset";
-import { Metadata } from "../../../modules/shared";
+import { JSONObject } from "kuzzle-sdk";
+import { AssetContent } from "../../asset";
 import { DecodedMeasurement, MeasureContent } from "./MeasureContent";
 import { MeasureSource } from "./MeasureSources";
 import { MeasureTarget } from "./MeasureTarget";
-/**
- * @internal
- *
- * @deprecated Replaced by new Ask implementing data sources
- */
-export type AskMeasureIngest = {
-    name: "device-manager:measures:ingest";
-    payload: {
-        device: KDocument<DeviceContent>;
-        measurements: DecodedMeasurement<JSONObject>[];
-        metadata: Metadata;
-        payloadUuids: string[];
-    };
-    result: void;
-};
 /**
  * @internal
  */
@@ -34,29 +17,12 @@ export type AskMeasureSourceIngest = {
     result: void;
 };
 /**
- * Event before starting to process new measures.
+ * Event before starting to process new measures from data source.
  *
  * Useful to enrich measures before they are saved.
- *
- * @deprecated Replaced by new triggers implementing data sources
  */
 export type EventMeasureProcessBefore = {
     name: "device-manager:measures:process:before";
-    args: [
-        {
-            asset: KDocument<AssetContent>;
-            device: KDocument<DeviceContent>;
-            measures: MeasureContent[];
-        }
-    ];
-};
-/**
- * Event before starting to process new measures from data source.
- *
- * Useful to enrich measures before they are saved.
- */
-export type EventMeasureProcessSourceBefore = {
-    name: "device-manager:measures:process:sourceBefore";
     args: [
         {
             source: MeasureSource;
@@ -67,60 +33,12 @@ export type EventMeasureProcessSourceBefore = {
     ];
 };
 /**
- * Tenant event before starting to process new measures.
+ * Tenant event before starting to process new measures from data source.
  *
  * Useful to enrich measures before they are saved.
- *
- * @deprecated Replaced by new triggers implementing data sources
  */
 export type TenantEventMeasureProcessBefore = {
     name: `engine:${string}:device-manager:measures:process:before`;
-    args: [
-        {
-            asset: KDocument<AssetContent>;
-            device: KDocument<DeviceContent>;
-            measures: MeasureContent[];
-        }
-    ];
-};
-/**
- * Tenant event before starting to process new measures from data source.
- *
- * Useful to enrich measures before they are saved.
- */
-export type TenantEventMeasureProcessSourceBefore = {
-    name: `engine:${string}:device-manager:measures:process:sourceBefore`;
-    args: [
-        {
-            source: MeasureSource;
-            target: MeasureTarget;
-            asset?: AssetContent;
-            measures: MeasureContent[];
-        }
-    ];
-};
-/**
- * Event triggered after updating device and asset with new measures but
- * before persistence in database.
- *
- * @deprecated Replaced by new triggers implementing data sources
- */
-export type EventMeasurePersistBefore = {
-    name: "device-manager:measures:persist:before";
-    args: [
-        {
-            asset: KDocument<AssetContent>;
-            device: KDocument<DeviceContent>;
-            measures: MeasureContent[];
-        }
-    ];
-};
-/**
- * Event triggered after updating the data source and asset with new measures but
- * before persistence in database.
- */
-export type EventMeasurePersistSourceBefore = {
-    name: "device-manager:measures:persist:sourceBefore";
     args: [
         {
             source: MeasureSource;
@@ -131,56 +49,10 @@ export type EventMeasurePersistSourceBefore = {
     ];
 };
 /**
- * Tenant event triggered after updating device and asset with new measures but
- * before persistence in database.
- *
- * @deprecated Replaced by new triggers implementing data sources
- */
-export type TenantEventMeasurePersistBefore = {
-    name: `engine:${string}:device-manager:measures:persist:before`;
-    args: [
-        {
-            asset: KDocument<AssetContent>;
-            device: KDocument<DeviceContent>;
-            measures: MeasureContent[];
-        }
-    ];
-};
-/**
- * Tenant event triggered after updating the data source and asset with new measures but
- * before persistence in database.
- */
-export type TenantEventMeasurePersistSourceBefore = {
-    name: `engine:${string}:device-manager:measures:persist:sourceBefore`;
-    args: [
-        {
-            source: MeasureSource;
-            target: MeasureTarget;
-            asset?: AssetContent;
-            measures: MeasureContent[];
-        }
-    ];
-};
-/**
- * Event after processing new measures.
- *
- * @deprecated Replaced by new triggers implementing data sources
+ * Event after processing new measures from data source.
  */
 export type EventMeasureProcessAfter = {
     name: "device-manager:measures:process:after";
-    args: [
-        {
-            asset: KDocument<AssetContent>;
-            device: KDocument<DeviceContent>;
-            measures: MeasureContent[];
-        }
-    ];
-};
-/**
- * Event after processing new measures from data source.
- */
-export type EventMeasureProcessSourceAfter = {
-    name: "device-manager:measures:process:sourceAfter";
     args: [
         {
             source: MeasureSource;
@@ -191,26 +63,11 @@ export type EventMeasureProcessSourceAfter = {
     ];
 };
 /**
- * Tenant event after processing new measures.
+ * Tenant event after processing new measures from data source.
  *
- * @deprecated Replaced by new triggers implementing data sources
  */
 export type TenantEventMeasureProcessAfter = {
     name: `engine:${string}:device-manager:measures:process:after`;
-    args: [
-        {
-            asset: KDocument<AssetContent>;
-            device: KDocument<DeviceContent>;
-            measures: MeasureContent[];
-        }
-    ];
-};
-/**
- * Tenant event after processing new measures from data source.
- *
- */
-export type TenantEventMeasureProcessSourceAfter = {
-    name: `engine:${string}:device-manager:measures:process:sourceAfter`;
     args: [
         {
             source: MeasureSource;

package/dist/lib/modules/measure/types/MeasureSources.d.ts

@@ -7,8 +7,13 @@ interface AbstractMeasureSource {
 export interface DeviceMeasureSource extends AbstractMeasureSource {
     type: "device";
     reference: string;
+    deviceMetadata: Metadata;
     model: string;
     lastMeasuredAt?: number;
+    groups: Array<{
+        path: string;
+        date: number;
+    }>;
 }
 export interface ApiMeasureSource extends AbstractMeasureSource {
     type: "api";

package/dist/lib/modules/measure/types/MeasureTarget.d.ts

@@ -9,7 +9,7 @@ export interface DeviceMeasureTarget extends AbstractMeasureTarget {
 export interface ApiMeasureTarget extends AbstractMeasureTarget {
     type: "api";
     assetId: string;
-    engineGroup?: string;
+    engineGroups?: string[];
 }
 export declare function isTarget(target: any): target is AbstractMeasureTarget;
 export declare function isTargetDevice(target: any): target is DeviceMeasureTarget;

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

@@ -12,37 +12,43 @@ export declare class ModelService extends BaseService {
     constructor(plugin: DeviceManagerPlugin, logger: KuzzleLogger);
     registerAskEvents(): void;
     private checkModelsConflicts;
-    writeAsset(engineGroup: string, model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: NamedMeasures, tooltipModels: TooltipModels, locales: {
-        [valueName: string]: LocaleDetails;
-    }): Promise<KDocument<AssetModelContent>>;
     private checkDefaultValues;
+    private checkGroupAffinity;
+    writeAsset(engineGroups: string[], model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: NamedMeasures, tooltipModels: TooltipModels, locales: {
+        [valueName: string]: LocaleDetails;
+    }, engineIds?: string[]): Promise<KDocument<AssetModelContent>>;
     writeDevice(model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: NamedMeasures): Promise<KDocument<DeviceModelContent>>;
-    writeGroup(engineGroup: string, model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups): Promise<KDocument<GroupModelContent>>;
+    writeGroup(engineGroups: string[], model: string, affinity: JSONObject, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups): Promise<KDocument<GroupModelContent>>;
     writeMeasure(type: string, valuesMappings: JSONObject, validationSchema?: SchemaObject, valuesDetails?: MeasureValuesDetails, locales?: {
         [valueName: string]: LocaleDetails;
-    }): Promise<KDocument<MeasureModelContent>>;
+    }, engineIds?: string[]): Promise<KDocument<MeasureModelContent>>;
     deleteAsset(_id: string): Promise<void>;
     deleteDevice(_id: string): Promise<void>;
     deleteGroup(_id: string): Promise<void>;
     deleteMeasure(_id: string): Promise<void>;
-    listAsset(engineGroup: string): Promise<KDocument<AssetModelContent>[]>;
+    listAsset(engineGroups: string[], engineId?: string): Promise<KDocument<AssetModelContent>[]>;
     listDevices(): Promise<KDocument<DeviceModelContent>[]>;
-    listGroups(engineGroup: string): Promise<KDocument<GroupModelContent>[]>;
-    listMeasures(): Promise<KDocument<MeasureModelContent>[]>;
-    searchAssets(engineGroup: string, searchParams: Partial<SearchParams>): Promise<SearchResult<KHit<AssetModelContent>>>;
+    listGroups(engineGroups: string[]): Promise<KDocument<GroupModelContent>[]>;
+    listMeasures(engineId?: string): Promise<KDocument<MeasureModelContent>[]>;
+    searchAssets(engineGroups: string[], engineId: string | undefined, searchParams: Partial<SearchParams>): Promise<SearchResult<KHit<AssetModelContent>>>;
     searchDevices(searchParams: Partial<SearchParams>): Promise<SearchResult<KHit<DeviceModelContent>>>;
-    searchGroups(engineGroup: string, searchParams: Partial<SearchParams>): Promise<SearchResult<KHit<GroupModelContent>>>;
-    searchMeasures(searchParams: Partial<SearchParams>): Promise<SearchResult<KHit<MeasureModelContent>>>;
+    searchGroups(engineGroups: string[], searchParams: Partial<SearchParams>): Promise<SearchResult<KHit<GroupModelContent>>>;
+    searchMeasures(engineId: string | undefined, searchParams: Partial<SearchParams>): Promise<SearchResult<KHit<MeasureModelContent>>>;
     assetExists(model: string): Promise<boolean>;
     deviceExists(model: string): Promise<boolean>;
-    getAsset(engineGroup: string, model: string): Promise<KDocument<AssetModelContent>>;
+    getAsset(engineGroups: string[], engineId: string | undefined, model: string): Promise<KDocument<AssetModelContent>>;
     getDevice(model: string): Promise<KDocument<DeviceModelContent>>;
     getGroup(model: string): Promise<KDocument<GroupModelContent>>;
-    getMeasure(type: string): Promise<KDocument<MeasureModelContent>>;
+    getMeasure(type: string, engineId?: string): Promise<KDocument<MeasureModelContent>>;
+    /**
+     * Checks that creating/updating a measure model does not shadow an existing
+     * one at a different scope (global vs tenant-scoped).
+     */
+    private checkMeasureShadowing;
     /**
      * Update an asset model
      */
-    updateAsset(engineGroup: string, model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: AssetModelContent["asset"]["measures"], tooltipModels: TooltipModels, locales: {
+    updateAsset(engineGroups: string[], model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: AssetModelContent["asset"]["measures"], tooltipModels: TooltipModels, locales: {
         [valueName: string]: LocaleDetails;
     }, request: KuzzleRequest): Promise<KDocument<AssetModelContent>>;
 }

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

@@ -22,7 +22,7 @@ export declare class ModelsController {
     listAssets(request: KuzzleRequest): Promise<ApiModelListAssetsResult>;
     listDevices(): Promise<ApiModelListDevicesResult>;
     listGroups(request: KuzzleRequest): Promise<ApiModelListGroupsResult>;
-    listMeasures(): Promise<ApiModelListMeasuresResult>;
+    listMeasures(request: KuzzleRequest): Promise<ApiModelListMeasuresResult>;
     searchAssets(request: KuzzleRequest): Promise<ApiModelSearchAssetsResult>;
     searchDevices(request: KuzzleRequest): Promise<ApiModelSearchDevicesResult>;
     searchGroups(request: KuzzleRequest): Promise<ApiModelSearchGroupsResult>;

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

@@ -1,7 +1,7 @@
 import { DeviceManagerPlugin } from "../plugin";
 import { NamedMeasures } from "../decoder";
 import { MeasureDefinition } from "../measure";
-import { LocaleDetails, MetadataDetails, MetadataGroups, MetadataMappings, TooltipModels } from "./types/ModelContent";
+import { GroupAffinity, LocaleDetails, MetadataDetails, MetadataGroups, MetadataMappings, TooltipModels } from "./types/ModelContent";
 import { JSONObject } from "kuzzle-sdk";
 export declare class ModelsRegister {
     private config;
@@ -17,7 +17,7 @@ export declare class ModelsRegister {
     /**
      * Registers an asset model.
      *
-     * @param engineGroup - The engine group name.
+     * @param engineGroups - The engine group names.
      * @param model - The name of the asset model, which must be in PascalCase.
      * @param measures - The measures associated with this asset model.
      * @param metadataMappings - The metadata mappings for the model, defaults to an empty object.
@@ -27,7 +27,7 @@ export declare class ModelsRegister {
      * @param tooltipModels - Optional model list for tooltip, containing labels and tooltip content.
      * @throws PluginImplementationError if the model name is not in PascalCase.
      */
-    registerAsset(engineGroup: string, model: string, measures: NamedMeasures, metadataMappings?: MetadataMappings, defaultMetadata?: JSONObject, metadataDetails?: MetadataDetails, metadataGroups?: MetadataGroups, tooltipModels?: TooltipModels, locales?: {
+    registerAsset(engineGroups: string[], model: string, measures: NamedMeasures, metadataMappings?: MetadataMappings, defaultMetadata?: JSONObject, metadataDetails?: MetadataDetails, metadataGroups?: MetadataGroups, tooltipModels?: TooltipModels, locales?: {
         [valueName: string]: LocaleDetails;
     }): void;
     /**
@@ -46,15 +46,16 @@ export declare class ModelsRegister {
      * Registers a group model.
      *
      *
-     * @param engineGroup - The engine group name.
+     * @param engineGroups - The engine group names.
      * @param model - The name of the group model, which must be in PascalCase.
+     * @param affinity - The type of object accepted and their model affinity.
      * @param metadataMappings - The metadata mappings for the model, defaults to an empty object.
      * @param defaultMetadata - The default metadata values for the model, defaults to an empty object.
      * @param metadataDetails - Optional detailed metadata descriptions, localizations and definition.
      * @param metadataGroups - Optional groups for organizing metadata, with localizations.
      * @throws PluginImplementationError if the model name is not in PascalCase.
      */
-    registerGroup(engineGroup: string, model: string, metadataMappings?: MetadataMappings, defaultMetadata?: JSONObject, metadataDetails?: MetadataDetails, metadataGroups?: MetadataGroups): void;
+    registerGroup(engineGroups: string[], model: string, affinity: GroupAffinity, metadataMappings?: MetadataMappings, defaultMetadata?: JSONObject, metadataDetails?: MetadataDetails, metadataGroups?: MetadataGroups): void;
     registerMeasure(type: string, measureDefinition: MeasureDefinition): void;
     private load;
 }