kuzzle-device-manager-types 3.0.0-next.24 → 3.0.0-next.26

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/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,36 +12,41 @@ export declare class ModelService extends BaseService {
     private checkModelsConflicts;
     private checkDefaultValues;
     private checkGroupAffinity;
-    writeAsset(engineGroup: string, model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: NamedMeasures, tooltipModels: TooltipModels, locales: {
+    writeAsset(engineGroups: string[], model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: NamedMeasures, tooltipModels: TooltipModels, locales: {
         [valueName: string]: LocaleDetails;
-    }, engines?: string[]): Promise<KDocument<AssetModelContent>>;
+    }, 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, affinity: JSONObject, 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, engineId?: 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, engineId: string | undefined, 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, engineId: string | undefined, 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

@@ -20,7 +20,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

@@ -16,7 +16,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.
@@ -26,7 +26,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;
     /**
@@ -45,7 +45,7 @@ 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.
@@ -54,7 +54,7 @@ export declare class ModelsRegister {
      * @param metadataGroups - Optional groups for organizing metadata, with localizations.
      * @throws PluginImplementationError if the model name is not in PascalCase.
      */
-    registerGroup(engineGroup: string, model: string, affinity: GroupAffinity, 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;
 }

package/dist/lib/modules/model/types/ModelApi.d.ts

@@ -8,7 +8,7 @@ interface ModelsControllerRequest {
 export interface ApiModelGetAssetRequest extends ModelsControllerRequest {
     action: "getAsset";
     model: string;
-    engineGroup: string;
+    engineGroups: string[];
 }
 export type ApiModelGetAssetResult = KDocument<AssetModelContent>;
 export interface ApiModelGetDeviceRequest extends ModelsControllerRequest {
@@ -24,12 +24,13 @@ export type ApiModelGetGroupResult = KDocument<GroupModelContent>;
 export interface ApiModelGetMeasureRequest extends ModelsControllerRequest {
     action: "getMeasure";
     type: string;
+    engineId?: string;
 }
 export type ApiModelGetMeasureResult = KDocument<MeasureModelContent>;
 export interface ApiModelWriteAssetRequest extends ModelsControllerRequest {
     action: "writeAsset";
     body: {
-        engineGroup: string;
+        engineGroups: string[];
         model: string;
         metadataDetails?: MetadataDetails;
         metadataGroups?: MetadataGroups;
@@ -59,7 +60,7 @@ export interface ApiModelWriteGroupRequest extends ModelsControllerRequest {
     action: "writeGroup";
     body: {
         affinity: GroupAffinity;
-        engineGroup: string;
+        engineGroups: string[];
         model: string;
         metadataDetails?: MetadataDetails;
         metadataGroups?: MetadataGroups;
@@ -72,6 +73,7 @@ export interface ApiModelWriteMeasureRequest extends ModelsControllerRequest {
     action: "writeMeasure";
     body: {
         type: string;
+        engineIds?: string[];
         locales?: {
             [valueName: string]: LocaleDetails;
         };
@@ -83,7 +85,7 @@ export interface ApiModelWriteMeasureRequest extends ModelsControllerRequest {
 export type ApiModelWriteMeasureResult = KDocument<MeasureModelContent>;
 export interface ApiModelUpdateAssetRequest extends ModelsControllerRequest {
     action: "updateAsset";
-    engineGroup: string;
+    engineGroups: string[];
     model: string;
     body: {
         metadataDetails?: MetadataDetails;
@@ -120,7 +122,7 @@ export interface ApiModelDeleteMeasureRequest extends ModelsControllerRequest {
 export type ApiModelDeleteMeasureResult = void;
 export interface ApiModelListAssetsRequest extends ModelsControllerRequest {
     action: "listAssets";
-    engineGroup: string;
+    engineGroups: string[];
 }
 export type ApiModelListAssetsResult = {
     models: KDocument<AssetModelContent>[];
@@ -135,7 +137,7 @@ export type ApiModelListDevicesResult = {
 };
 export interface ApiModelListGroupsRequest extends ModelsControllerRequest {
     action: "listGroups";
-    engineGroup: string;
+    engineGroups: string[];
 }
 export type ApiModelListGroupsResult = {
     models: KDocument<GroupModelContent>[];
@@ -143,6 +145,7 @@ export type ApiModelListGroupsResult = {
 };
 export interface ApiModelListMeasuresRequest extends ModelsControllerRequest {
     action: "listMeasures";
+    engineId?: string;
 }
 export type ApiModelListMeasuresResult = {
     models: KDocument<MeasureModelContent>[];
@@ -150,7 +153,7 @@ export type ApiModelListMeasuresResult = {
 };
 export interface ApiModelSearchAssetsRequest extends ModelsControllerRequest {
     action: "searchAssets";
-    engineGroup: string;
+    engineGroups: string[];
     from?: number;
     size?: number;
     scrollTTL?: string;
@@ -167,7 +170,7 @@ export interface ApiModelSearchDevicesRequest extends ModelsControllerRequest {
 export type ApiModelSearchDevicesResult = SearchResult<KHit<DeviceModelContent>>;
 export interface ApiModelSearchGroupsRequest extends ModelsControllerRequest {
     action: "searchGroups";
-    engineGroup: string;
+    engineGroups: string[];
     from?: number;
     size?: number;
     scrollTTL?: string;
@@ -176,6 +179,7 @@ export interface ApiModelSearchGroupsRequest extends ModelsControllerRequest {
 export type ApiModelSearchGroupsResult = SearchResult<KHit<GroupModelContent>>;
 export interface ApiModelSearchMeasuresRequest extends ModelsControllerRequest {
     action: "searchMeasures";
+    engineId?: string;
     from?: number;
     size?: number;
     scrollTTL?: string;

package/dist/lib/modules/model/types/ModelContent.d.ts

@@ -3,6 +3,7 @@ import { NamedMeasures } from "../../decoder";
 import { MeasureDefinition } from "../../measure";
 export interface MeasureModelContent extends KDocumentContent {
     type: "measure";
+    engineIds?: string[];
     measure: MeasureDefinition & {
         type: string;
         locales?: {
@@ -153,13 +154,13 @@ export interface TooltipModels {
 }
 export interface AssetModelContent extends KDocumentContent {
     type: "asset";
-    engineGroup: string;
+    engineGroups: string[];
     /**
      * Optional list of engine IDs (tenant IDs) this model is scoped to.
      * When set, the model is only available to the specified tenants.
-     * When absent, the model is available to all tenants in the engineGroup.
+     * When absent, the model is available to all tenants in the engineGroups.
      */
-    engines?: string[];
+    engineIds?: string[];
     asset: {
         /**
          * Name of the model
@@ -390,7 +391,7 @@ export interface DeviceModelContent extends KDocumentContent {
 }
 export interface GroupModelContent extends KDocumentContent {
     type: "group";
-    engineGroup: string;
+    engineGroups: string[];
     group: {
         /**
          * Name of the model

package/dist/lib/modules/model/types/ModelEvents.d.ts

@@ -2,7 +2,7 @@ import { AssetModelContent, DeviceModelContent, GroupModelContent, MeasureModelC
 export type AskModelAssetGet = {
     name: "ask:device-manager:model:asset:get";
     payload: {
-        engineGroup: string;
+        engineGroups: string[];
         engineId?: string;
         model: string;
     };
@@ -19,6 +19,7 @@ export type AskModelMeasureGet = {
     name: "ask:device-manager:model:measure:get";
     payload: {
         type: string;
+        engineId?: string;
     };
     result: MeasureModelContent;
 };

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

@@ -23,7 +23,7 @@ export declare class DeviceManagerPlugin extends Plugin {
         /**
          * Register an asset model
          *
-         * @param engineGroup Engine group name
+         * @param engineGroups Engine group names
          * @param model Name of the asset model. Must follow a naming convention in PascalCase.
          * @param definition Object containing the asset model definition, including:
          *        - measures: Array describing measure names and their types.
@@ -123,7 +123,7 @@ export declare class DeviceManagerPlugin extends Plugin {
          * );
          * ```
          */
-        registerAsset: (engineGroup: string, model: string, definition: AssetModelDefinition) => void;
+        registerAsset: (engineGroups: string[], model: string, definition: AssetModelDefinition) => void;
         /**
          * Register a device.
          *
@@ -231,7 +231,7 @@ export declare class DeviceManagerPlugin extends Plugin {
          * );
          * ```
          */
-        registerGroup: (engineGroup: string, model: string, definition: GroupModelDefinition) => void;
+        registerGroup: (engineGroups: string[], model: string, definition: GroupModelDefinition) => void;
         /**
          * Register a new measure
          *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kuzzle-device-manager-types",
-  "version": "3.0.0-next.24",
+  "version": "3.0.0-next.26",
   "description": "Shared types for Kuzzle Device Manager",
   "author": "The Kuzzle Team (support@kuzzle.io)",
   "main": "index.js",