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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -30,7 +30,7 @@ export interface DeviceContent<TMetadata extends Metadata = any> extends Digital
30
30
  }>;
31
31
  /**
32
32
  */
33
- engineId: string;
33
+ engineId: string | null;
34
34
  /**
35
35
  * Path's of device's groups
36
36
  */
@@ -14,7 +14,7 @@ export declare class ModelService extends BaseService {
14
14
  private checkGroupAffinity;
15
15
  writeAsset(engineGroup: string, model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: NamedMeasures, tooltipModels: TooltipModels, locales: {
16
16
  [valueName: string]: LocaleDetails;
17
- }): Promise<KDocument<AssetModelContent>>;
17
+ }, engines?: string[]): Promise<KDocument<AssetModelContent>>;
18
18
  writeDevice(model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: NamedMeasures): Promise<KDocument<DeviceModelContent>>;
19
19
  writeGroup(engineGroup: string, model: string, affinity: JSONObject, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups): Promise<KDocument<GroupModelContent>>;
20
20
  writeMeasure(type: string, valuesMappings: JSONObject, validationSchema?: SchemaObject, valuesDetails?: MeasureValuesDetails, locales?: {
@@ -24,17 +24,17 @@ export declare class ModelService extends BaseService {
24
24
  deleteDevice(_id: string): Promise<void>;
25
25
  deleteGroup(_id: string): Promise<void>;
26
26
  deleteMeasure(_id: string): Promise<void>;
27
- listAsset(engineGroup: string): Promise<KDocument<AssetModelContent>[]>;
27
+ listAsset(engineGroup: string, engineId?: string): Promise<KDocument<AssetModelContent>[]>;
28
28
  listDevices(): Promise<KDocument<DeviceModelContent>[]>;
29
29
  listGroups(engineGroup: string): Promise<KDocument<GroupModelContent>[]>;
30
30
  listMeasures(): Promise<KDocument<MeasureModelContent>[]>;
31
- searchAssets(engineGroup: string, searchParams: Partial<SearchParams>): Promise<SearchResult<KHit<AssetModelContent>>>;
31
+ searchAssets(engineGroup: string, engineId: string | undefined, searchParams: Partial<SearchParams>): Promise<SearchResult<KHit<AssetModelContent>>>;
32
32
  searchDevices(searchParams: Partial<SearchParams>): Promise<SearchResult<KHit<DeviceModelContent>>>;
33
33
  searchGroups(engineGroup: string, searchParams: Partial<SearchParams>): Promise<SearchResult<KHit<GroupModelContent>>>;
34
34
  searchMeasures(searchParams: Partial<SearchParams>): Promise<SearchResult<KHit<MeasureModelContent>>>;
35
35
  assetExists(model: string): Promise<boolean>;
36
36
  deviceExists(model: string): Promise<boolean>;
37
- getAsset(engineGroup: string, model: string): Promise<KDocument<AssetModelContent>>;
37
+ getAsset(engineGroup: string, engineId: string | undefined, model: string): Promise<KDocument<AssetModelContent>>;
38
38
  getDevice(model: string): Promise<KDocument<DeviceModelContent>>;
39
39
  getGroup(model: string): Promise<KDocument<GroupModelContent>>;
40
40
  getMeasure(type: string): Promise<KDocument<MeasureModelContent>>;
@@ -154,6 +154,12 @@ export interface TooltipModels {
154
154
  export interface AssetModelContent extends KDocumentContent {
155
155
  type: "asset";
156
156
  engineGroup: string;
157
+ /**
158
+ * Optional list of engine IDs (tenant IDs) this model is scoped to.
159
+ * When set, the model is only available to the specified tenants.
160
+ * When absent, the model is available to all tenants in the engineGroup.
161
+ */
162
+ engines?: string[];
157
163
  asset: {
158
164
  /**
159
165
  * Name of the model
@@ -3,6 +3,7 @@ export type AskModelAssetGet = {
3
3
  name: "ask:device-manager:model:asset:get";
4
4
  payload: {
5
5
  engineGroup: string;
6
+ engineId?: string;
6
7
  model: string;
7
8
  };
8
9
  result: AssetModelContent;
@@ -82,7 +82,7 @@ export declare class DigitalTwinService extends BaseService {
82
82
  * @param {any} model:string
83
83
  * @returns {any}
84
84
  */
85
- protected getAssetModel(engineGroup: string, model: string): Promise<AssetModelContent>;
85
+ protected getAssetModel(engineGroup: string, model: string, engineId?: string): Promise<AssetModelContent>;
86
86
  protected getDeviceModel(model: string): Promise<DeviceModelContent>;
87
87
  getEngine(engineId: string): Promise<JSONObject>;
88
88
  protected getDeviceProvisioning(deviceId: string): Promise<import("kuzzle").KDocument<DeviceProvisioningContent>>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "kuzzle-device-manager-types",
3
- "version": "3.0.0-next.22",
3
+ "version": "3.0.0-next.24",
4
4
  "description": "Shared types for Kuzzle Device Manager",
5
5
  "author": "The Kuzzle Team (support@kuzzle.io)",
6
6
  "main": "index.js",