kuzzle-device-manager-types 3.0.0-next.23 → 3.0.0-next.25

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

@@ -14,30 +14,35 @@ export declare class ModelService extends BaseService {
     private checkGroupAffinity;
     writeAsset(engineGroup: string, model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: NamedMeasures, tooltipModels: TooltipModels, locales: {
         [valueName: string]: LocaleDetails;
-    }): 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>>;
     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(engineGroup: 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>>>;
+    listMeasures(engineId?: string): Promise<KDocument<MeasureModelContent>[]>;
+    searchAssets(engineGroup: 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>>>;
+    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(engineGroup: 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
      */

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/types/ModelApi.d.ts

@@ -24,6 +24,7 @@ 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 {
@@ -72,6 +73,7 @@ export interface ApiModelWriteMeasureRequest extends ModelsControllerRequest {
     action: "writeMeasure";
     body: {
         type: string;
+        engineIds?: string[];
         locales?: {
             [valueName: string]: LocaleDetails;
         };
@@ -143,6 +145,7 @@ export type ApiModelListGroupsResult = {
 };
 export interface ApiModelListMeasuresRequest extends ModelsControllerRequest {
     action: "listMeasures";
+    engineId?: string;
 }
 export type ApiModelListMeasuresResult = {
     models: KDocument<MeasureModelContent>[];
@@ -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?: {
@@ -154,6 +155,12 @@ export interface TooltipModels {
 export interface AssetModelContent extends KDocumentContent {
     type: "asset";
     engineGroup: 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.
+     */
+    engineIds?: string[];
     asset: {
         /**
          * Name of the model

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

@@ -3,6 +3,7 @@ export type AskModelAssetGet = {
     name: "ask:device-manager:model:asset:get";
     payload: {
         engineGroup: string;
+        engineId?: string;
         model: string;
     };
     result: AssetModelContent;
@@ -18,6 +19,7 @@ export type AskModelMeasureGet = {
     name: "ask:device-manager:model:measure:get";
     payload: {
         type: string;
+        engineId?: string;
     };
     result: MeasureModelContent;
 };

package/dist/lib/modules/shared/services/DigitalTwinService.d.ts

@@ -82,7 +82,7 @@ export declare class DigitalTwinService extends BaseService {
      * @param {any} model:string
      * @returns {any}
      */
-    protected getAssetModel(engineGroup: string, model: string): Promise<AssetModelContent>;
+    protected getAssetModel(engineGroup: string, model: string, engineId?: string): Promise<AssetModelContent>;
     protected getDeviceModel(model: string): Promise<DeviceModelContent>;
     getEngine(engineId: string): Promise<JSONObject>;
     protected getDeviceProvisioning(deviceId: string): Promise<import("kuzzle").KDocument<DeviceProvisioningContent>>;

package/package.json

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