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

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.
Files changed (108) hide show
  1. package/dist/index.d.ts +1 -0
  2. package/dist/lib/modules/asset/AssetModule.d.ts +0 -1
  3. package/dist/lib/modules/asset/AssetService.d.ts +14 -4
  4. package/dist/lib/modules/asset/AssetsController.d.ts +31 -7
  5. package/dist/lib/modules/asset/exports.d.ts +0 -4
  6. package/dist/lib/modules/asset/index.d.ts +1 -3
  7. package/dist/lib/modules/asset/types/AssetApi.d.ts +128 -7
  8. package/dist/lib/modules/asset/types/AssetContent.d.ts +9 -11
  9. package/dist/lib/modules/asset/types/AssetHistoryContent.d.ts +4 -11
  10. package/dist/lib/modules/decoder/DecodedPayload.d.ts +2 -0
  11. package/dist/lib/modules/decoder/DecodersController.d.ts +6 -0
  12. package/dist/lib/modules/decoder/PayloadService.d.ts +1 -0
  13. package/dist/lib/modules/decoder/types/DecoderApi.d.ts +0 -1
  14. package/dist/lib/modules/device/DeviceService.d.ts +14 -40
  15. package/dist/lib/modules/device/DevicesController.d.ts +5 -5
  16. package/dist/lib/modules/device/collections/deviceMappings.d.ts +6 -0
  17. package/dist/lib/modules/device/roles/RoleDevicesAdmin.d.ts +2 -2
  18. package/dist/lib/modules/device/types/DeviceApi.d.ts +69 -42
  19. package/dist/lib/modules/device/types/DeviceContent.d.ts +55 -4
  20. package/dist/lib/modules/device/types/DeviceEvents.d.ts +2 -25
  21. package/dist/lib/modules/group/GroupsController.d.ts +35 -0
  22. package/dist/lib/modules/group/GroupsModule.d.ts +6 -0
  23. package/dist/lib/modules/group/GroupsService.d.ts +116 -0
  24. package/dist/lib/modules/group/collections/groupsMappings.d.ts +2 -0
  25. package/dist/lib/modules/group/exports.d.ts +5 -0
  26. package/dist/lib/modules/group/index.d.ts +4 -0
  27. package/dist/lib/modules/{asset/roles/RoleAssetsGroupsAdmin.d.ts → group/roles/RoleGroupsAdmin.d.ts} +3 -3
  28. package/dist/lib/modules/{asset/roles/RoleAssetsGroupsReader.d.ts → group/roles/RoleGroupsReader.d.ts} +3 -3
  29. package/dist/lib/modules/group/types/GroupContent.d.ts +10 -0
  30. package/dist/lib/modules/group/types/GroupsApi.d.ts +141 -0
  31. package/dist/lib/modules/measure/MeasureExporter.d.ts +2 -0
  32. package/dist/lib/modules/measure/MeasureService.d.ts +11 -38
  33. package/dist/lib/modules/measure/MeasureSourcesBuilder.d.ts +1 -2
  34. package/dist/lib/modules/measure/collections/measuresMappings.d.ts +2 -83
  35. package/dist/lib/modules/measure/exports.d.ts +0 -1
  36. package/dist/lib/modules/measure/index.d.ts +0 -1
  37. package/dist/lib/modules/measure/types/MeasureContent.d.ts +9 -2
  38. package/dist/lib/modules/measure/types/MeasureDefinition.d.ts +4 -0
  39. package/dist/lib/modules/measure/types/MeasureEvents.d.ts +6 -149
  40. package/dist/lib/modules/measure/types/MeasureSources.d.ts +5 -0
  41. package/dist/lib/modules/model/ModelService.d.ts +16 -4
  42. package/dist/lib/modules/model/ModelsConflicts.d.ts +9 -1
  43. package/dist/lib/modules/model/ModelsController.d.ts +6 -1
  44. package/dist/lib/modules/model/ModelsRegister.d.ts +19 -2
  45. package/dist/lib/modules/model/types/ModelApi.d.ts +50 -1
  46. package/dist/lib/modules/model/types/ModelContent.d.ts +158 -3
  47. package/dist/lib/modules/model/types/ModelDefinition.d.ts +111 -3
  48. package/dist/lib/modules/model/types/ModelEvents.d.ts +8 -1
  49. package/dist/lib/modules/plugin/DeviceManagerEngine.d.ts +32 -6
  50. package/dist/lib/modules/plugin/DeviceManagerPlugin.d.ts +60 -5
  51. package/dist/lib/modules/plugin/types/DeviceManagerConfiguration.d.ts +9 -7
  52. package/dist/lib/modules/plugin/types/InternalCollection.d.ts +1 -1
  53. package/dist/lib/modules/plugin/types/exports.d.ts +2 -0
  54. package/dist/lib/modules/shared/errors/index.d.ts +1 -0
  55. package/dist/lib/modules/shared/exports.d.ts +1 -5
  56. package/dist/lib/modules/shared/index.d.ts +3 -11
  57. package/dist/lib/modules/shared/services/AbstractExporter.d.ts +2 -0
  58. package/dist/lib/modules/shared/services/DigitalTwinExporter.d.ts +2 -0
  59. package/dist/lib/modules/shared/services/DigitalTwinService.d.ts +71 -1
  60. package/dist/lib/modules/shared/types/DigitalTwinContent.d.ts +6 -5
  61. package/dist/lib/modules/shared/types/DigitalTwinEvents.d.ts +30 -0
  62. package/dist/lib/modules/shared/types/Models.d.ts +18 -0
  63. package/dist/lib/modules/shared/types/exports.d.ts +6 -0
  64. package/dist/lib/modules/shared/types/index.d.ts +9 -0
  65. package/dist/lib/modules/shared/utils/index.d.ts +5 -0
  66. package/dist/tests/application/assets/Container.d.ts +7 -4
  67. package/dist/tests/application/assets/MagicHouse.d.ts +2 -2
  68. package/dist/tests/application/assets/Room.d.ts +2 -2
  69. package/dist/tests/application/assets/StreetLamp.d.ts +2 -2
  70. package/dist/tests/application/assets/Warehouse.d.ts +2 -2
  71. package/dist/tests/application/assets/index.d.ts +1 -0
  72. package/dist/tests/application/decoders/EmptyTempDecoder.d.ts +8 -0
  73. package/dist/tests/application/devices/DummyTemp.d.ts +2 -0
  74. package/dist/tests/application/devices/DummyTempPosition.d.ts +2 -0
  75. package/dist/tests/application/devices/EmptyTemp.d.ts +2 -0
  76. package/dist/tests/application/devices/index.d.ts +3 -0
  77. package/dist/tests/application/groups/AssetRestricted.d.ts +8 -0
  78. package/dist/tests/application/groups/DeviceRestricted.d.ts +8 -0
  79. package/dist/tests/application/groups/Parking.d.ts +14 -0
  80. package/dist/tests/application/groups/index.d.ts +3 -0
  81. package/dist/tests/application/measures/{AccelerationMeasure.d.ts → Acceleration.d.ts} +2 -2
  82. package/dist/tests/application/measures/BatteryMeasure.d.ts +5 -0
  83. package/dist/tests/application/measures/Brightness.d.ts +2 -0
  84. package/dist/tests/application/measures/CO2.d.ts +2 -0
  85. package/dist/tests/application/measures/HumidityMeasure.d.ts +5 -0
  86. package/dist/tests/application/measures/Illuminance.d.ts +2 -0
  87. package/dist/tests/application/measures/Magicule.d.ts +2 -2
  88. package/dist/tests/application/measures/MovementMeasure.d.ts +5 -0
  89. package/dist/{lib/modules/measure → tests/application}/measures/PositionMeasure.d.ts +2 -2
  90. package/dist/tests/application/measures/PowerConsumption.d.ts +2 -0
  91. package/dist/tests/application/measures/TemperatureMeasure.d.ts +5 -0
  92. package/dist/tests/application/measures/index.d.ts +11 -0
  93. package/dist/tests/application/models.d.ts +2 -0
  94. package/package.json +2 -2
  95. package/dist/lib/modules/asset/AssetsGroupsController.d.ts +0 -20
  96. package/dist/lib/modules/asset/collections/assetsGroupsMapping.d.ts +0 -2
  97. package/dist/lib/modules/asset/types/AssetGroupContent.d.ts +0 -8
  98. package/dist/lib/modules/asset/types/AssetGroupsApi.d.ts +0 -59
  99. package/dist/lib/modules/measure/measures/BatteryMeasure.d.ts +0 -5
  100. package/dist/lib/modules/measure/measures/HumidityMeasure.d.ts +0 -5
  101. package/dist/lib/modules/measure/measures/MovementMeasure.d.ts +0 -5
  102. package/dist/lib/modules/measure/measures/TemperatureMeasure.d.ts +0 -5
  103. package/dist/lib/modules/measure/measures/index.d.ts +0 -5
  104. package/dist/tests/application/decoders/index.d.ts +0 -2
  105. package/dist/tests/application/measures/BrightnessMeasure.d.ts +0 -2
  106. package/dist/tests/application/measures/CO2Measure.d.ts +0 -2
  107. package/dist/tests/application/measures/IlluminanceMeasure.d.ts +0 -2
  108. package/dist/tests/application/measures/PowerConsumptionMeasure.d.ts +0 -2
package/dist/index.d.ts CHANGED
@@ -5,3 +5,4 @@ export * from "./lib/modules/measure/exports";
5
5
  export * from "./lib/modules/decoder/exports";
6
6
  export * from "./lib/modules/shared/exports";
7
7
  export * from "./lib/modules/model/exports";
8
+ export * from "./lib/modules/group/exports";
@@ -3,6 +3,5 @@ export declare class AssetModule extends Module {
3
3
  private assetService;
4
4
  private assetHistoryService;
5
5
  private assetController;
6
- private assetGroupsController;
7
6
  init(): Promise<void>;
8
7
  }
@@ -3,10 +3,10 @@ import { JSONObject, KDocument, KHit, SearchResult, mReplaceResponse } from "kuz
3
3
  import { DeviceManagerPlugin } from "../plugin";
4
4
  import { DigitalTwinService, Metadata, SearchParams } from "../shared";
5
5
  import { AssetHistoryService } from "./AssetHistoryService";
6
- import { ApiAssetMigrateTenantResult } from "./types/AssetApi";
6
+ import { ApiAssetMigrateTenantResult, ApiAssetUnlinkDevicesResult, ApiAssetUpdateModelLocales } from "./types/AssetApi";
7
7
  import { AssetContent } from "./types/AssetContent";
8
8
  export declare class AssetService extends DigitalTwinService {
9
- private assetHistoryService;
9
+ readonly assetHistoryService: AssetHistoryService;
10
10
  constructor(plugin: DeviceManagerPlugin, assetHistoryService: AssetHistoryService);
11
11
  registerAskEvents(): void;
12
12
  get(engineId: string, assetId: string, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
@@ -22,6 +22,7 @@ export declare class AssetService extends DigitalTwinService {
22
22
  * Update or Create an asset metadata
23
23
  */
24
24
  upsert(engineId: string, model: string, reference: string, metadata: Metadata, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
25
+ private _create;
25
26
  /**
26
27
  * Create an asset metadata
27
28
  */
@@ -31,13 +32,22 @@ export declare class AssetService extends DigitalTwinService {
31
32
  */
32
33
  delete(engineId: string, assetId: string, request: KuzzleRequest): Promise<void>;
33
34
  search(engineId: string, searchParams: SearchParams, request: KuzzleRequest): Promise<SearchResult<KHit<AssetContent>>>;
34
- migrateTenant(user: User, assetsList: string[], engineId: string, newEngineId: string): Promise<ApiAssetMigrateTenantResult>;
35
+ unlinkDevices(assetId: string, allMeasures: boolean, deviceIds: string[], measureSlots: string[], request: KuzzleRequest): Promise<ApiAssetUnlinkDevicesResult>;
36
+ migrateTenant(user: User, assetsList: string[], engineId: string, newEngineId: string, includeDevices: boolean, request: KuzzleRequest): Promise<ApiAssetMigrateTenantResult>;
35
37
  /**
36
38
  * Replace an asset metadata
37
39
  */
38
40
  mReplaceAndHistorize(engineId: string, assets: KDocument<AssetContent>[], removedMetadata: string[], { refresh }: {
39
41
  refresh: any;
40
42
  }): Promise<mReplaceResponse>;
41
- private getEngine;
43
+ /**
44
+ * Retrieve locales with the specified model and search all assets related to the model to update the locales.
45
+ * The operation is historized.
46
+ * @param request
47
+ * @param model
48
+ */
49
+ updateModelLocales(request: KuzzleRequest, model: string): Promise<ApiAssetUpdateModelLocales[]>;
50
+ addMeasureSlot(assetId: string, measureSlot: AssetContent["measureSlots"][0], engineId: string, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
51
+ removeMeasureSlot(assetId: string, measureSlotName: string, engineId: string, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
42
52
  private refreshModel;
43
53
  }
@@ -1,13 +1,15 @@
1
1
  import { ControllerDefinition, KuzzleRequest } from "kuzzle";
2
+ import { MeasureExporter } from "../measure";
2
3
  import { DeviceManagerPlugin } from "../plugin";
4
+ import { DigitalTwinExporter } from "../shared";
3
5
  import { AssetService } from "./AssetService";
4
- import { ApiAssetCreateResult, ApiAssetUpsertResult, ApiAssetDeleteResult, ApiAssetGetMeasuresResult, ApiAssetGetResult, ApiAssetSearchResult, ApiAssetUpdateResult, ApiAssetMigrateTenantResult, ApiAssetMetadataReplaceResult, ApiAssetGetLastMeasuresResult, ApiAssetMGetLastMeasuredAtResult, ApiAssetMGetLastMeasuresResult, ApiAssetGetLastMeasuredAtResult } from "./types/AssetApi";
6
+ import { ApiAssetCreateResult, ApiAssetUpsertResult, ApiAssetDeleteResult, ApiAssetGetMeasuresResult, ApiAssetGetResult, ApiAssetSearchResult, ApiAssetUpdateResult, ApiAssetMigrateTenantResult, ApiAssetMetadataReplaceResult, ApiAssetGetLastMeasuresResult, ApiAssetMGetLastMeasuredAtResult, ApiAssetMGetLastMeasuresResult, ApiAssetGetLastMeasuredAtResult, ApiAssetUpdateModelLocales, ApiAssetLinkDevicesResult, ApiAssetUnlinkDevicesResult, ApiAssetAddMeasureSlotResult, ApiAssetRemoveMeasureSlotResult } from "./types/AssetApi";
5
7
  export declare class AssetsController {
6
- private plugin;
7
- private assetService;
8
+ readonly plugin: DeviceManagerPlugin;
9
+ readonly assetService: AssetService;
8
10
  definition: ControllerDefinition;
9
- private exporter;
10
- private measureExporter;
11
+ readonly exporter: DigitalTwinExporter;
12
+ readonly measureExporter: MeasureExporter;
11
13
  constructor(plugin: DeviceManagerPlugin, assetService: AssetService);
12
14
  get(request: KuzzleRequest): Promise<ApiAssetGetResult>;
13
15
  upsert(request: KuzzleRequest): Promise<ApiAssetUpsertResult>;
@@ -29,11 +31,33 @@ export declare class AssetsController {
29
31
  * @throws If the asset does not exists
30
32
  */
31
33
  private getTypeFromMeasureSlot;
32
- mMeasureIngest(request: KuzzleRequest): Promise<void>;
33
- measureIngest(request: KuzzleRequest): Promise<void>;
34
+ mIngestMeasure(request: KuzzleRequest): Promise<void>;
35
+ ingestMeasure(request: KuzzleRequest): Promise<void>;
34
36
  exportMeasures(request: KuzzleRequest): Promise<any>;
35
37
  export(request: KuzzleRequest): Promise<any>;
36
38
  migrateTenant(request: KuzzleRequest): Promise<ApiAssetMigrateTenantResult>;
37
39
  getLastMeasuredAt(request: KuzzleRequest): Promise<ApiAssetGetLastMeasuredAtResult>;
38
40
  mGetLastMeasuredAt(request: KuzzleRequest): Promise<ApiAssetMGetLastMeasuredAtResult>;
41
+ /**
42
+ * Update modelLocales of all assets related to the specified asset model.
43
+ * This operation is done to make the search assets feature up to date
44
+ * @param request
45
+ */
46
+ updateModelLocales(request: KuzzleRequest): Promise<ApiAssetUpdateModelLocales[]>;
47
+ /**
48
+ * Link an asset to devices.
49
+ */
50
+ linkDevices(request: KuzzleRequest): Promise<ApiAssetLinkDevicesResult>;
51
+ /**
52
+ * Unlink assets from a device.
53
+ */
54
+ unlinkDevices(request: KuzzleRequest): Promise<ApiAssetUnlinkDevicesResult>;
55
+ /**
56
+ * Remove a measure slot from an asset
57
+ */
58
+ addMeasureSlot(request: KuzzleRequest): Promise<ApiAssetAddMeasureSlotResult>;
59
+ /**
60
+ * Remove a measure slot from an asset
61
+ */
62
+ removeMeasureSlot(request: KuzzleRequest): Promise<ApiAssetRemoveMeasureSlotResult>;
39
63
  }
@@ -2,11 +2,7 @@ export * from "./types/AssetContent";
2
2
  export * from "./types/AssetHistoryContent";
3
3
  export * from "./types/AssetEvents";
4
4
  export * from "./types/AssetApi";
5
- export * from "./types/AssetGroupContent";
6
- export * from "./types/AssetGroupsApi";
7
5
  export * from "./roles/RoleAssetsAdmin";
8
6
  export * from "./roles/RoleAssetsReader";
9
- export * from "./roles/RoleAssetsGroupsAdmin";
10
- export * from "./roles/RoleAssetsGroupsReader";
11
7
  export * from "./collections/assetsMappings";
12
8
  export * from "./collections/assetsHistoryMappings";
@@ -1,6 +1,6 @@
1
1
  export * from "./collections/assetsMappings";
2
2
  export * from "./collections/assetsHistoryMappings";
3
- export * from "./collections/assetsGroupsMapping";
3
+ export * from "../group/collections/groupsMappings";
4
4
  export * from "./types/AssetContent";
5
5
  export * from "./types/AssetHistoryContent";
6
6
  export * from "./types/AssetEvents";
@@ -9,5 +9,3 @@ export * from "./model/AssetSerializer";
9
9
  export * from "./AssetModule";
10
10
  export * from "./roles/RoleAssetsAdmin";
11
11
  export * from "./roles/RoleAssetsReader";
12
- export * from "./roles/RoleAssetsGroupsAdmin";
13
- export * from "./roles/RoleAssetsGroupsReader";
@@ -1,9 +1,10 @@
1
- import { JSONObject, KDocument, KHit, SearchResult } from "kuzzle-sdk";
2
- import { MeasureContent, Measurement } from "../../../modules/measure";
1
+ import { JSONObject, KDocument, KHit, SearchResult, UpdateByQueryResponse } from "kuzzle-sdk";
2
+ import { MeasureContent, Measurement } from "../../measure";
3
3
  import { ApiDigitalTwinGetLastMeasuredAtRequest, ApiDigitalTwinGetLastMeasuredAtResult, ApiDigitalTwinGetLastMeasuresRequest, ApiDigitalTwinGetLastMeasuresResult, ApiDigitalTwinMGetLastMeasuredAtRequest, ApiDigitalTwinMGetLastMeasuredAtResult, ApiDigitalTwinMGetLastMeasuresRequest, ApiDigitalTwinMGetLastMeasuresResult, Metadata } from "../../shared";
4
4
  import { AssetContent } from "./AssetContent";
5
5
  type AssetsControllerName = "device-manager/assets";
6
6
  import { ApiMeasureSource } from "../../measure/types/MeasureSources";
7
+ import { DeviceContent } from "lib/modules/device";
7
8
  interface AssetsControllerRequest {
8
9
  controller: AssetsControllerName;
9
10
  engineId: string;
@@ -33,7 +34,6 @@ export interface ApiAssetMetadataReplaceRequest extends AssetsControllerRequest
33
34
  export type ApiAssetMetadataReplaceResult = KDocument<AssetContent>;
34
35
  export interface ApiAssetUpsertRequest extends AssetsControllerRequest {
35
36
  action: "upsert";
36
- _id: string;
37
37
  refresh?: string;
38
38
  body: {
39
39
  model: string;
@@ -88,10 +88,9 @@ export type ApiAssetGetMeasuresResult = {
88
88
  };
89
89
  type TypelessApiMeasureSource = Omit<ApiMeasureSource, "type">;
90
90
  export interface ApiAssetMeasureIngestRequest extends AssetsControllerRequest {
91
- action: "measureIngest";
91
+ action: "ingestMeasure";
92
92
  assetId: string;
93
93
  engineId: string;
94
- engineGroup?: string;
95
94
  slotName: string;
96
95
  body: {
97
96
  dataSource: TypelessApiMeasureSource;
@@ -104,10 +103,9 @@ type APIDecodedMeasurement = Omit<Measurement, "type"> & {
104
103
  slotName: string;
105
104
  };
106
105
  export interface ApiAssetmMeasureIngestRequest extends AssetsControllerRequest {
107
- action: "mMeasureIngest";
106
+ action: "mIngestMeasure";
108
107
  assetId: string;
109
108
  engineId: string;
110
- engineGroup?: string;
111
109
  body: {
112
110
  dataSource: TypelessApiMeasureSource;
113
111
  measurements: APIDecodedMeasurement[];
@@ -156,6 +154,7 @@ export interface ApiAssetMigrateTenantRequest extends AssetsControllerRequest {
156
154
  body: {
157
155
  assetsList: string[];
158
156
  newEngineId: string;
157
+ includeDevices?: boolean;
159
158
  };
160
159
  }
161
160
  export type ApiAssetMigrateTenantResult = {
@@ -166,4 +165,126 @@ export type ApiAssetGetLastMeasuredAtRequest = ApiDigitalTwinGetLastMeasuredAtRe
166
165
  export type ApiAssetGetLastMeasuredAtResult = ApiDigitalTwinGetLastMeasuredAtResult;
167
166
  export type ApiAssetMGetLastMeasuredAtRequest = ApiDigitalTwinMGetLastMeasuredAtRequest<AssetsControllerName>;
168
167
  export type ApiAssetMGetLastMeasuredAtResult = ApiDigitalTwinMGetLastMeasuredAtResult;
168
+ export type ApiAssetUpdateModelLocales = {
169
+ engineIndex: string;
170
+ result: UpdateByQueryResponse<AssetContent>;
171
+ };
172
+ export interface ApiAssetlinkDevicesRequest extends AssetsControllerRequest {
173
+ action: "linkDevices";
174
+ _id: string;
175
+ refresh?: string;
176
+ body: {
177
+ linkedMeasures: Array<{
178
+ deviceId: string;
179
+ /**
180
+ * This option allows to not specify the names of all the measures that should
181
+ * be linked to the asset.
182
+ *
183
+ * The algorithm will go through all the measures names provided by the device
184
+ * and add the one who are present with the same name in the asset.
185
+ *
186
+ * It will not add the measure if:
187
+ * - it has been specified in the link request
188
+ * - it was already present in the asset
189
+ *
190
+ * @example
191
+ * if the device provide a measure of type "temperature" with the name "temp"
192
+ * if the asset has declared a measure of type "temperature" with the name "temp"
193
+ * then the measure will be automatically added in the link and will later be propagated to the asset
194
+ */
195
+ implicitMeasuresLinking?: boolean;
196
+ /**
197
+ * Names of the linked measures.
198
+ *
199
+ * Array<{ asset: string, device: string }>
200
+ *
201
+ * @example
202
+ *
203
+ * [
204
+ * { asset: "externalTemperature", device: "temperature" }
205
+ * ]
206
+ */
207
+ measureSlots?: Array<{
208
+ asset: string;
209
+ device: string;
210
+ }>;
211
+ }>;
212
+ };
213
+ }
214
+ export type ApiAssetLinkDevicesResult = {
215
+ asset: KDocument<AssetContent>;
216
+ devices: KDocument<DeviceContent>[];
217
+ };
218
+ export interface ApiAssetUnlinkDevicesRequest extends AssetsControllerRequest {
219
+ action: "unlinkDevices";
220
+ _id: string;
221
+ strict?: boolean;
222
+ refresh?: string;
223
+ body: {
224
+ /**
225
+ * This options allows to unlink all the measures of the asset
226
+ */
227
+ allMeasures?: boolean;
228
+ /**
229
+ * Names of the measure slots of the asset to unlink.
230
+ *
231
+ * string[]
232
+ *
233
+ * @example
234
+ *
235
+ * ['externalTemperature','position']
236
+ */
237
+ measureSlots?: string[];
238
+ /**
239
+ * Ids of the devices to unlink.
240
+ *
241
+ * string[]
242
+ *
243
+ * @example
244
+ *
245
+ * ['First-asset','Second-asset']
246
+ */
247
+ devices?: string[];
248
+ };
249
+ }
250
+ export type ApiAssetUnlinkDevicesResult = {
251
+ asset: KDocument<AssetContent>;
252
+ devices: KDocument<DeviceContent>[];
253
+ };
254
+ export interface ApiAssetAddMeasureSlotRequest extends AssetsControllerRequest {
255
+ action: "addMeasureSlot";
256
+ _id: string;
257
+ body: {
258
+ /**
259
+ * Measure slot containing the name of the slot and it's type of measurement
260
+ *
261
+ * { name: string , type: string}
262
+ *
263
+ * @example
264
+ *
265
+ * { name: "externalTemperature", type: "temperature" }
266
+ */
267
+ measureSlot: {
268
+ name: string;
269
+ type: string;
270
+ };
271
+ };
272
+ }
273
+ export type ApiAssetAddMeasureSlotResult = KDocument<AssetContent>;
274
+ export interface ApiAssetRemoveMeasureSlotRequest extends AssetsControllerRequest {
275
+ action: "removeMeasureSlot";
276
+ _id: string;
277
+ body: {
278
+ /**
279
+ * Name of the measure slot to be removed
280
+ *
281
+ *
282
+ * @example
283
+ *
284
+ * measureSlot: "externalTemperature",
285
+ */
286
+ measureSlot: string;
287
+ };
288
+ }
289
+ export type ApiAssetRemoveMeasureSlotResult = KDocument<AssetContent>;
169
290
  export {};
@@ -1,17 +1,16 @@
1
- import { JSONObject } from "kuzzle-sdk";
2
1
  import { DigitalTwinContent, Metadata } from "../../shared";
3
2
  /**
4
3
  * Asset document content
5
4
  */
6
- export interface AssetContent<TMeasures extends JSONObject = any, TMetadata extends Metadata = any> extends DigitalTwinContent<TMeasures, TMetadata> {
5
+ export interface AssetContent<TMetadata extends Metadata = any> extends DigitalTwinContent<TMetadata> {
7
6
  /**
8
- * Link with attached device
7
+ * Link with attached devices
9
8
  */
10
- linkedDevices: Array<{
9
+ linkedMeasures: Array<{
11
10
  /**
12
11
  * Device ID
13
12
  */
14
- _id: string;
13
+ deviceId: string;
15
14
  /**
16
15
  * Names of the linked measures
17
16
  *
@@ -20,20 +19,19 @@ export interface AssetContent<TMeasures extends JSONObject = any, TMetadata exte
20
19
  * @example
21
20
  *
22
21
  * [
23
- * { asset: "externalTemperature", device: "temperature", type: "temperature" }
22
+ * { asset: "externalTemperature", device: "temperature" }
24
23
  * ]
25
24
  */
26
- measureNames: Array<{
25
+ measureSlots: Array<{
27
26
  asset: string;
28
27
  device: string;
29
- type: string;
30
28
  }>;
31
29
  }>;
32
30
  /**
33
- * Id's of asset groups
31
+ * Path's of asset groups
34
32
  */
35
33
  groups: Array<{
36
- id: string;
34
+ path: string;
37
35
  date: number;
38
36
  }>;
39
37
  }
@@ -49,4 +47,4 @@ export type AssetMeasureContext<TMetadata extends Metadata = Metadata> = {
49
47
  * Name of the measure for the Asset
50
48
  */
51
49
  measureName: string;
52
- } & Pick<AssetContent<JSONObject, TMetadata>, "model" | "reference" | "metadata" | "groups">;
50
+ } & Pick<AssetContent<TMetadata>, "model" | "reference" | "metadata" | "groups">;
@@ -1,16 +1,9 @@
1
- import { JSONObject, KDocumentContent } from "kuzzle-sdk";
1
+ import { KDocumentContent } from "kuzzle-sdk";
2
2
  import { Metadata } from "../../shared";
3
3
  import { AssetContent } from "./AssetContent";
4
4
  export type AssetHistoryMetadata = {
5
5
  names: string[];
6
6
  };
7
- export type AssetHistoryEventMeasure = {
8
- name: "measure";
9
- measure: {
10
- names: string[];
11
- };
12
- metadata?: AssetHistoryMetadata;
13
- };
14
7
  export type AssetHistoryEventMetadata = {
15
8
  name: "metadata";
16
9
  metadata: AssetHistoryMetadata;
@@ -27,11 +20,11 @@ export type AssetHistoryEventUnlink = {
27
20
  deviceId: string;
28
21
  };
29
22
  };
30
- export type AssetHistoryEvent = AssetHistoryEventMeasure | AssetHistoryEventMetadata | AssetHistoryEventLink | AssetHistoryEventUnlink;
23
+ export type AssetHistoryEvent = AssetHistoryEventMetadata | AssetHistoryEventLink | AssetHistoryEventUnlink;
31
24
  /**
32
25
  * Asset History document content
33
26
  */
34
- export interface AssetHistoryContent<TAssetHistoryEvent extends AssetHistoryEvent = any, TMeasures extends JSONObject = any, TMetadata extends Metadata = any> extends KDocumentContent {
27
+ export interface AssetHistoryContent<TAssetHistoryEvent extends AssetHistoryEvent = any, TMetadata extends Metadata = any> extends KDocumentContent {
35
28
  /**
36
29
  * Name of the event who caused the historization
37
30
  *
@@ -48,7 +41,7 @@ export interface AssetHistoryContent<TAssetHistoryEvent extends AssetHistoryEven
48
41
  /**
49
42
  * Asset content after the event
50
43
  */
51
- asset: AssetContent<TMeasures, TMetadata>;
44
+ asset: AssetContent<TMetadata>;
52
45
  /**
53
46
  * Timestamp of the event according to its type
54
47
  *
@@ -43,5 +43,7 @@ export declare class DecodedPayload<TDecoder extends Decoder = Decoder> {
43
43
  * Get the metadata for a device
44
44
  */
45
45
  getMetadata(deviceReference: string): JSONObject;
46
+ hasMeasurements(): boolean;
47
+ hasMetadata(): boolean;
46
48
  private validateMeasurement;
47
49
  }
@@ -15,4 +15,10 @@ export declare class DecodersController {
15
15
  * Clean payload collection for a time period
16
16
  */
17
17
  prunePayloads(request: KuzzleRequest): Promise<ApiDecoderPrunePayloadsResult>;
18
+ /**
19
+ * Route request to appropriate decoder
20
+ */
21
+ route(request: KuzzleRequest): Promise<{
22
+ valid: boolean;
23
+ }>;
18
24
  }
@@ -34,4 +34,5 @@ export declare class PayloadService extends BaseService {
34
34
  deviceModel?: string;
35
35
  }): Promise<number>;
36
36
  receiveUnknown(deviceModel: string, payload: JSONObject, apiAction: string): Promise<void>;
37
+ private getDeviceMeasureSource;
37
38
  }
@@ -4,7 +4,6 @@ interface DecodersControllerRequest {
4
4
  }
5
5
  export interface ApiDecoderListRequest extends DecodersControllerRequest {
6
6
  action: "list";
7
- _id: string;
8
7
  }
9
8
  export type ApiDecoderListResult = {
10
9
  decoders: DecoderContent[];
@@ -3,22 +3,19 @@ import { JSONObject, KDocument, KHit, SearchResult } from "kuzzle-sdk";
3
3
  import { DecodedMeasurement } from "../measure";
4
4
  import { DeviceManagerPlugin } from "../plugin";
5
5
  import { DigitalTwinService, Metadata, SearchParams } from "../shared";
6
- import { AssetContent } from "./../asset";
7
- import { ApiDeviceLinkAssetRequest } from "./types/DeviceApi";
8
- import { DeviceContent } from "./types/DeviceContent";
6
+ import { DeviceProvisioningContent, DeviceContent } from "./types/DeviceContent";
7
+ import { ApiDeviceUnlinkAssetsResult } from "./exports";
9
8
  export declare class DeviceService extends DigitalTwinService {
10
9
  constructor(plugin: DeviceManagerPlugin);
11
10
  registerAskEvents(): void;
11
+ private _create;
12
+ private _createDeviceProvisioning;
12
13
  /**
13
14
  * Create a new device.
14
15
  *
15
- * @todo creating a device in the "device-manager" index should be a separate
16
- * method since in this case "engineId" is not really an engine ID but still
17
- * required as an argument (in part to check the tenant rights)
18
16
  */
19
17
  create(model: string, reference: string, metadata: JSONObject, request: KuzzleRequest): Promise<KDocument<DeviceContent>>;
20
18
  get(engineId: string, deviceId: string, request: KuzzleRequest): Promise<KDocument<DeviceContent>>;
21
- private getInternalDevices;
22
19
  /**
23
20
  * Replace a device metadata
24
21
  */
@@ -30,6 +27,15 @@ export declare class DeviceService extends DigitalTwinService {
30
27
  update(engineId: string, deviceId: string, metadata: Metadata, request: KuzzleRequest): Promise<KDocument<DeviceContent>>;
31
28
  delete(engineId: string, deviceId: string, request: KuzzleRequest): Promise<void>;
32
29
  search(engineId: string, searchParams: SearchParams, request: KuzzleRequest): Promise<SearchResult<KHit<DeviceContent>>>;
30
+ unlinkAssets(deviceId: string, allMeasures: boolean, assetIds: string[], measureSlots: string[], request: KuzzleRequest): Promise<ApiDeviceUnlinkAssetsResult>;
31
+ /**
32
+ * Internal logic to attach the device to an engine
33
+ *
34
+ * @param engineId Engine id to attach to
35
+ * @param deviceId Device id to attach
36
+ * @param options.refresh Wait for ES indexation
37
+ */
38
+ private _attachEngine;
33
39
  /**
34
40
  * Attach the device to an engine
35
41
  *
@@ -45,41 +51,9 @@ export declare class DeviceService extends DigitalTwinService {
45
51
  * @param {string} deviceId Id of the device
46
52
  * @param {KuzzleRequest} request kuzzle request
47
53
  */
48
- detachEngine(deviceId: string, request: KuzzleRequest): Promise<KDocument<DeviceContent>>;
49
- /**
50
- * Link a device to an asset.
51
- */
52
- linkAsset(engineId: string, deviceId: string, assetId: string, measureNames: ApiDeviceLinkAssetRequest["body"]["measureNames"], implicitMeasuresLinking: boolean, request: KuzzleRequest): Promise<{
53
- asset: KDocument<AssetContent>;
54
- device: KDocument<DeviceContent>;
55
- }>;
54
+ detachEngine(deviceId: string, request: KuzzleRequest): Promise<KDocument<DeviceProvisioningContent>>;
56
55
  receiveMeasures(engineId: string, deviceId: string, measures: DecodedMeasurement[], payloadUuids: string[], request: KuzzleRequest): Promise<void>;
57
- /**
58
- * Checks if the asset does not already have a linked device using one of the
59
- * requested measure names.
60
- */
61
- private checkAlreadyProvidedMeasures;
62
- /**
63
- * Goes through the device available measures and add them into the link if:
64
- * - they are not already provided by another device
65
- * - they are not already present in the link request
66
- * - they are declared in the asset model
67
- */
68
- private generateMissingAssetMeasureNames;
69
- /**
70
- * Unlink a device of an asset
71
- *
72
- * @param {string} deviceId Id of the device
73
- * @param {KuzzleRequest} request kuzzle request
74
- */
75
- unlinkAsset(deviceId: string, request: KuzzleRequest): Promise<{
76
- asset: KDocument<AssetContent>;
77
- device: KDocument<DeviceContent>;
78
- }>;
79
56
  private checkEngineExists;
80
57
  private checkAttachedToEngine;
81
- private getEngine;
82
- private getDeviceModel;
83
- private getAssetModel;
84
58
  private refreshModel;
85
59
  }
@@ -1,7 +1,7 @@
1
1
  import { ControllerDefinition, KuzzleRequest } from "kuzzle";
2
2
  import { DeviceManagerPlugin } from "../plugin";
3
3
  import { DeviceService } from "./DeviceService";
4
- import { ApiDeviceAttachEngineResult, ApiDeviceCreateResult, ApiDeviceDeleteResult, ApiDeviceDetachEngineResult, ApiDeviceGetResult, ApiDeviceLinkAssetResult, ApiDeviceSearchResult, ApiDeviceUnlinkAssetResult, ApiDeviceUpdateResult, ApiDeviceGetMeasuresResult, ApiDeviceUpsertResult, ApiDeviceGetLastMeasuresResult, ApiDeviceMGetLastMeasuresResult, ApiDeviceGetLastMeasuredAtResult, ApiDeviceMGetLastMeasuredAtResult, ApiDeviceMetadataReplaceResult } from "./types/DeviceApi";
4
+ import { ApiDeviceAttachEngineResult, ApiDeviceCreateResult, ApiDeviceDeleteResult, ApiDeviceDetachEngineResult, ApiDeviceGetResult, ApiDeviceLinkAssetsResult, ApiDeviceSearchResult, ApiDeviceUnlinkAssetsResult, ApiDeviceUpdateResult, ApiDeviceGetMeasuresResult, ApiDeviceUpsertResult, ApiDeviceGetLastMeasuresResult, ApiDeviceMGetLastMeasuresResult, ApiDeviceGetLastMeasuredAtResult, ApiDeviceMGetLastMeasuredAtResult, ApiDeviceMetadataReplaceResult } from "./types/DeviceApi";
5
5
  export declare class DevicesController {
6
6
  private plugin;
7
7
  private deviceService;
@@ -28,13 +28,13 @@ export declare class DevicesController {
28
28
  */
29
29
  detachEngine(request: KuzzleRequest): Promise<ApiDeviceDetachEngineResult>;
30
30
  /**
31
- * Link a device to an asset.
31
+ * Link a device to several assets.
32
32
  */
33
- linkAsset(request: KuzzleRequest): Promise<ApiDeviceLinkAssetResult>;
33
+ linkAssets(request: KuzzleRequest): Promise<ApiDeviceLinkAssetsResult>;
34
34
  /**
35
- * Unlink a device from an asset.
35
+ * Unlink assets from a device.
36
36
  */
37
- unlinkAsset(request: KuzzleRequest): Promise<ApiDeviceUnlinkAssetResult>;
37
+ unlinkAssets(request: KuzzleRequest): Promise<ApiDeviceUnlinkAssetsResult>;
38
38
  getMeasures(request: KuzzleRequest): Promise<ApiDeviceGetMeasuresResult>;
39
39
  getLastMeasures(request: KuzzleRequest): Promise<ApiDeviceGetLastMeasuresResult>;
40
40
  mGetLastMeasures(request: KuzzleRequest): Promise<ApiDeviceMGetLastMeasuresResult>;
@@ -5,3 +5,9 @@ import { CollectionMappings } from "kuzzle";
5
5
  * Those mappings does not contains the `measures` and `metadata` mappings.
6
6
  */
7
7
  export declare const devicesMappings: CollectionMappings;
8
+ /**
9
+ * Mappings for the "devices" collection of the platform index.
10
+ *
11
+ * Those mappings does not contains the `measures`, `groups` and `metadata` mappings.
12
+ */
13
+ export declare const devicesPlatformMappings: CollectionMappings;
@@ -10,9 +10,9 @@ import { KuzzleRole } from "../../shared/types/KuzzleRole";
10
10
  create: true,
11
11
  delete: true,
12
12
  get: true,
13
- linkAsset: true,
13
+ linkAssets: true,
14
14
  search: true,
15
- unlinkAsset: true,
15
+ unlinkAssets: true,
16
16
  update: true,
17
17
  getMeasures: true,
18
18
  exportMeasures: true,