kuzzle-device-manager-types 2.9.0 → 3.0.0-next.10
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.
- package/dist/bin/migration/migration_platform_index.d.ts +2 -0
- package/dist/bin/migration/migration_tenant_index.d.ts +2 -0
- package/dist/bin/migration/utils.d.ts +18 -0
- package/dist/index.d.ts +1 -0
- package/dist/lib/modules/asset/AssetModule.d.ts +0 -2
- package/dist/lib/modules/asset/AssetService.d.ts +1 -2
- package/dist/lib/modules/asset/AssetsController.d.ts +9 -1
- package/dist/lib/modules/asset/exports.d.ts +0 -4
- package/dist/lib/modules/asset/index.d.ts +1 -3
- package/dist/lib/modules/asset/types/AssetApi.d.ts +83 -5
- package/dist/lib/modules/asset/types/AssetContent.d.ts +9 -16
- package/dist/lib/modules/asset/types/AssetHistoryContent.d.ts +4 -11
- package/dist/lib/modules/decoder/DecodedPayload.d.ts +2 -0
- package/dist/lib/modules/device/DeviceService.d.ts +4 -48
- package/dist/lib/modules/device/DevicesController.d.ts +5 -5
- package/dist/lib/modules/device/collections/deviceMappings.d.ts +6 -0
- package/dist/lib/modules/device/roles/RoleDevicesAdmin.d.ts +2 -2
- package/dist/lib/modules/device/types/DeviceApi.d.ts +68 -41
- package/dist/lib/modules/device/types/DeviceContent.d.ts +55 -4
- package/dist/lib/modules/device/types/DeviceEvents.d.ts +8 -23
- package/dist/lib/modules/group/GroupsController.d.ts +35 -0
- package/dist/lib/modules/group/GroupsModule.d.ts +6 -0
- package/dist/lib/modules/group/GroupsService.d.ts +116 -0
- package/dist/lib/modules/group/collections/groupsMappings.d.ts +2 -0
- package/dist/lib/modules/group/exports.d.ts +5 -0
- package/dist/lib/modules/group/index.d.ts +4 -0
- package/dist/lib/modules/{asset/roles/RoleAssetsGroupsAdmin.d.ts → group/roles/RoleGroupsAdmin.d.ts} +3 -3
- package/dist/lib/modules/{asset/roles/RoleAssetsGroupsReader.d.ts → group/roles/RoleGroupsReader.d.ts} +3 -3
- package/dist/lib/modules/group/types/GroupContent.d.ts +10 -0
- package/dist/lib/modules/group/types/GroupsApi.d.ts +141 -0
- package/dist/lib/modules/measure/MeasureService.d.ts +11 -43
- package/dist/lib/modules/measure/MeasureSourcesBuilder.d.ts +1 -2
- package/dist/lib/modules/measure/collections/measuresMappings.d.ts +2 -91
- package/dist/lib/modules/measure/exports.d.ts +0 -1
- package/dist/lib/modules/measure/index.d.ts +0 -1
- package/dist/lib/modules/measure/types/MeasureEvents.d.ts +5 -148
- package/dist/lib/modules/measure/types/MeasureSources.d.ts +1 -0
- package/dist/lib/modules/model/ModelService.d.ts +3 -2
- package/dist/lib/modules/model/ModelsRegister.d.ts +3 -2
- package/dist/lib/modules/model/types/ModelApi.d.ts +2 -1
- package/dist/lib/modules/model/types/ModelContent.d.ts +24 -0
- package/dist/lib/modules/model/types/ModelDefinition.d.ts +5 -1
- package/dist/lib/modules/plugin/DeviceManagerEngine.d.ts +15 -6
- package/dist/lib/modules/plugin/DeviceManagerPlugin.d.ts +3 -2
- package/dist/lib/modules/plugin/types/DeviceManagerConfiguration.d.ts +9 -14
- package/dist/lib/modules/plugin/types/InternalCollection.d.ts +1 -1
- package/dist/lib/modules/shared/services/AbstractExporter.d.ts +3 -1
- package/dist/lib/modules/shared/services/DigitalTwinExporter.d.ts +6 -1
- package/dist/lib/modules/shared/services/DigitalTwinService.d.ts +70 -0
- package/dist/lib/modules/shared/types/DigitalTwinContent.d.ts +4 -5
- package/dist/lib/modules/shared/types/DigitalTwinEvents.d.ts +30 -0
- package/dist/tests/application/assets/Container.d.ts +3 -2
- package/dist/tests/application/decoders/DummyTempDecoder.d.ts +10 -0
- package/dist/tests/application/decoders/DummyTempPositionDecoder.d.ts +10 -0
- package/dist/tests/application/decoders/EmptyTempDecoder.d.ts +8 -0
- package/dist/tests/application/devices/EmptyTemp.d.ts +2 -0
- package/dist/tests/application/devices/index.d.ts +1 -0
- package/dist/tests/application/groups/AssetRestricted.d.ts +8 -0
- package/dist/tests/application/groups/DeviceRestricted.d.ts +8 -0
- package/dist/tests/application/groups/Parking.d.ts +2 -2
- package/dist/tests/application/groups/index.d.ts +2 -0
- package/dist/tests/application/measures/BatteryMeasure.d.ts +5 -0
- package/dist/tests/application/measures/HumidityMeasure.d.ts +5 -0
- package/dist/tests/application/measures/MovementMeasure.d.ts +5 -0
- package/dist/{lib/modules/measure → tests/application}/measures/PositionMeasure.d.ts +2 -2
- package/dist/tests/application/measures/TemperatureMeasure.d.ts +5 -0
- package/dist/tests/application/measures/index.d.ts +5 -0
- package/dist/tests/application/tests/controller.d.ts +0 -1
- package/package.json +1 -1
- package/dist/lib/modules/asset/AssetsGroupsController.d.ts +0 -22
- package/dist/lib/modules/asset/AssetsGroupsService.d.ts +0 -47
- package/dist/lib/modules/asset/collections/assetsGroupsMapping.d.ts +0 -2
- package/dist/lib/modules/asset/types/AssetGroupContent.d.ts +0 -11
- package/dist/lib/modules/asset/types/AssetGroupsApi.d.ts +0 -59
- package/dist/lib/modules/measure/measures/BatteryMeasure.d.ts +0 -5
- package/dist/lib/modules/measure/measures/HumidityMeasure.d.ts +0 -5
- package/dist/lib/modules/measure/measures/MovementMeasure.d.ts +0 -5
- package/dist/lib/modules/measure/measures/TemperatureMeasure.d.ts +0 -5
- package/dist/lib/modules/measure/measures/index.d.ts +0 -5
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { JSONObject } from "kuzzle-sdk";
|
|
2
|
+
export declare function transformDocuments(collection: string, indexPath: string, callBack: (string: any) => JSONObject, endCallBack?: () => void): void;
|
|
3
|
+
export declare function clearProperties(obj: any, properties: any): {};
|
|
4
|
+
export interface ModelRegistry {
|
|
5
|
+
assets: {
|
|
6
|
+
[key: string]: {
|
|
7
|
+
type: string;
|
|
8
|
+
name: string;
|
|
9
|
+
}[];
|
|
10
|
+
};
|
|
11
|
+
devices: {
|
|
12
|
+
[key: string]: {
|
|
13
|
+
type: string;
|
|
14
|
+
name: string;
|
|
15
|
+
}[];
|
|
16
|
+
};
|
|
17
|
+
}
|
|
18
|
+
export declare function retrieveModelMeasureSlots(pathToPlatformIndex: string, callBack: (models: ModelRegistry) => void): void;
|
package/dist/index.d.ts
CHANGED
|
@@ -32,7 +32,7 @@ export declare class AssetService extends DigitalTwinService {
|
|
|
32
32
|
*/
|
|
33
33
|
delete(engineId: string, assetId: string, request: KuzzleRequest): Promise<void>;
|
|
34
34
|
search(engineId: string, searchParams: SearchParams, request: KuzzleRequest): Promise<SearchResult<KHit<AssetContent>>>;
|
|
35
|
-
migrateTenant(user: User, assetsList: string[], engineId: string, newEngineId: string): Promise<ApiAssetMigrateTenantResult>;
|
|
35
|
+
migrateTenant(user: User, assetsList: string[], engineId: string, newEngineId: string, includeDevices: boolean, request: KuzzleRequest): Promise<ApiAssetMigrateTenantResult>;
|
|
36
36
|
/**
|
|
37
37
|
* Replace an asset metadata
|
|
38
38
|
*/
|
|
@@ -46,6 +46,5 @@ export declare class AssetService extends DigitalTwinService {
|
|
|
46
46
|
* @param model
|
|
47
47
|
*/
|
|
48
48
|
updateModelLocales(request: KuzzleRequest, model: string): Promise<ApiAssetUpdateModelLocales[]>;
|
|
49
|
-
private getEngine;
|
|
50
49
|
private refreshModel;
|
|
51
50
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { ControllerDefinition, KuzzleRequest } from "kuzzle";
|
|
2
2
|
import { DeviceManagerPlugin } from "../plugin";
|
|
3
3
|
import { AssetService } from "./AssetService";
|
|
4
|
-
import { ApiAssetCreateResult, ApiAssetUpsertResult, ApiAssetDeleteResult, ApiAssetGetMeasuresResult, ApiAssetGetResult, ApiAssetSearchResult, ApiAssetUpdateResult, ApiAssetMigrateTenantResult, ApiAssetMetadataReplaceResult, ApiAssetGetLastMeasuresResult, ApiAssetMGetLastMeasuredAtResult, ApiAssetMGetLastMeasuresResult, ApiAssetGetLastMeasuredAtResult, ApiAssetUpdateModelLocales } from "./types/AssetApi";
|
|
4
|
+
import { ApiAssetCreateResult, ApiAssetUpsertResult, ApiAssetDeleteResult, ApiAssetGetMeasuresResult, ApiAssetGetResult, ApiAssetSearchResult, ApiAssetUpdateResult, ApiAssetMigrateTenantResult, ApiAssetMetadataReplaceResult, ApiAssetGetLastMeasuresResult, ApiAssetMGetLastMeasuredAtResult, ApiAssetMGetLastMeasuresResult, ApiAssetGetLastMeasuredAtResult, ApiAssetUpdateModelLocales, ApiAssetLinkDevicesResult, ApiAssetUnlinkDevicesResult } from "./types/AssetApi";
|
|
5
5
|
export declare class AssetsController {
|
|
6
6
|
private plugin;
|
|
7
7
|
private assetService;
|
|
@@ -42,4 +42,12 @@ export declare class AssetsController {
|
|
|
42
42
|
* @param request
|
|
43
43
|
*/
|
|
44
44
|
updateModelLocales(request: KuzzleRequest): Promise<ApiAssetUpdateModelLocales[]>;
|
|
45
|
+
/**
|
|
46
|
+
* Link an asset to devices.
|
|
47
|
+
*/
|
|
48
|
+
linkDevices(request: KuzzleRequest): Promise<ApiAssetLinkDevicesResult>;
|
|
49
|
+
/**
|
|
50
|
+
* Unlink assets from a device.
|
|
51
|
+
*/
|
|
52
|
+
unlinkDevices(request: KuzzleRequest): Promise<ApiAssetUnlinkDevicesResult>;
|
|
45
53
|
}
|
|
@@ -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 "
|
|
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";
|
|
@@ -4,14 +4,10 @@ import { ApiDigitalTwinGetLastMeasuredAtRequest, ApiDigitalTwinGetLastMeasuredAt
|
|
|
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;
|
|
10
|
-
/**
|
|
11
|
-
* ? Request parameter used by SoftTenant module
|
|
12
|
-
* ! Not used directly in this plugin
|
|
13
|
-
*/
|
|
14
|
-
softTenantId?: string | string[] | null;
|
|
15
11
|
}
|
|
16
12
|
export interface ApiAssetGetRequest extends AssetsControllerRequest {
|
|
17
13
|
action: "get";
|
|
@@ -160,6 +156,7 @@ export interface ApiAssetMigrateTenantRequest extends AssetsControllerRequest {
|
|
|
160
156
|
body: {
|
|
161
157
|
assetsList: string[];
|
|
162
158
|
newEngineId: string;
|
|
159
|
+
includeDevices?: boolean;
|
|
163
160
|
};
|
|
164
161
|
}
|
|
165
162
|
export type ApiAssetMigrateTenantResult = {
|
|
@@ -174,4 +171,85 @@ export type ApiAssetUpdateModelLocales = {
|
|
|
174
171
|
engineIndex: string;
|
|
175
172
|
result: UpdateByQueryResponse<AssetContent>;
|
|
176
173
|
};
|
|
174
|
+
export interface ApiAssetlinkDevicesRequest extends AssetsControllerRequest {
|
|
175
|
+
action: "linkDevices";
|
|
176
|
+
_id: string;
|
|
177
|
+
refresh?: string;
|
|
178
|
+
body: {
|
|
179
|
+
linkedMeasures: Array<{
|
|
180
|
+
deviceId: string;
|
|
181
|
+
/**
|
|
182
|
+
* This option allows to not specify the names of all the measures that should
|
|
183
|
+
* be linked to the asset.
|
|
184
|
+
*
|
|
185
|
+
* The algorithm will go through all the measures names provided by the device
|
|
186
|
+
* and add the one who are present with the same name in the asset.
|
|
187
|
+
*
|
|
188
|
+
* It will not add the measure if:
|
|
189
|
+
* - it has been specified in the link request
|
|
190
|
+
* - it was already present in the asset
|
|
191
|
+
*
|
|
192
|
+
* @example
|
|
193
|
+
* if the device provide a measure of type "temperature" with the name "temp"
|
|
194
|
+
* if the asset has declared a measure of type "temperature" with the name "temp"
|
|
195
|
+
* then the measure will be automatically added in the link and will later be propagated to the asset
|
|
196
|
+
*/
|
|
197
|
+
implicitMeasuresLinking?: boolean;
|
|
198
|
+
/**
|
|
199
|
+
* Names of the linked measures.
|
|
200
|
+
*
|
|
201
|
+
* Array<{ asset: string, device: string }>
|
|
202
|
+
*
|
|
203
|
+
* @example
|
|
204
|
+
*
|
|
205
|
+
* [
|
|
206
|
+
* { asset: "externalTemperature", device: "temperature" }
|
|
207
|
+
* ]
|
|
208
|
+
*/
|
|
209
|
+
measureSlots?: Array<{
|
|
210
|
+
asset: string;
|
|
211
|
+
device: string;
|
|
212
|
+
}>;
|
|
213
|
+
}>;
|
|
214
|
+
};
|
|
215
|
+
}
|
|
216
|
+
export type ApiAssetLinkDevicesResult = {
|
|
217
|
+
asset: KDocument<AssetContent>;
|
|
218
|
+
devices: KDocument<DeviceContent>[];
|
|
219
|
+
};
|
|
220
|
+
export interface ApiAssetUnlinkDevicesRequest extends AssetsControllerRequest {
|
|
221
|
+
action: "unlinkDevices";
|
|
222
|
+
_id: string;
|
|
223
|
+
strict?: boolean;
|
|
224
|
+
refresh?: string;
|
|
225
|
+
body: {
|
|
226
|
+
linkedMeasures: Array<{
|
|
227
|
+
deviceId: string;
|
|
228
|
+
/**
|
|
229
|
+
* This option allows to not specify the names of all the measures that should
|
|
230
|
+
* be unlinked from the asset.
|
|
231
|
+
*/
|
|
232
|
+
allMeasures?: boolean;
|
|
233
|
+
/**
|
|
234
|
+
* Names of the linked measures.
|
|
235
|
+
*
|
|
236
|
+
* Array<{ asset: string, device: string }>
|
|
237
|
+
*
|
|
238
|
+
* @example
|
|
239
|
+
*
|
|
240
|
+
* [
|
|
241
|
+
* { asset: "externalTemperature", device: "temperature" }
|
|
242
|
+
* ]
|
|
243
|
+
*/
|
|
244
|
+
measureSlots?: Array<{
|
|
245
|
+
asset: string;
|
|
246
|
+
device: string;
|
|
247
|
+
}>;
|
|
248
|
+
}>;
|
|
249
|
+
};
|
|
250
|
+
}
|
|
251
|
+
export type ApiAssetUnlinkDevicesResult = {
|
|
252
|
+
asset: KDocument<AssetContent>;
|
|
253
|
+
devices: KDocument<DeviceContent>[];
|
|
254
|
+
};
|
|
177
255
|
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<
|
|
5
|
+
export interface AssetContent<TMetadata extends Metadata = any> extends DigitalTwinContent<TMetadata> {
|
|
7
6
|
/**
|
|
8
|
-
* Link with attached
|
|
7
|
+
* Link with attached devices
|
|
9
8
|
*/
|
|
10
|
-
|
|
9
|
+
linkedMeasures: Array<{
|
|
11
10
|
/**
|
|
12
11
|
* Device ID
|
|
13
12
|
*/
|
|
14
|
-
|
|
13
|
+
deviceId: string;
|
|
15
14
|
/**
|
|
16
15
|
* Names of the linked measures
|
|
17
16
|
*
|
|
@@ -20,27 +19,21 @@ export interface AssetContent<TMeasures extends JSONObject = any, TMetadata exte
|
|
|
20
19
|
* @example
|
|
21
20
|
*
|
|
22
21
|
* [
|
|
23
|
-
* { asset: "externalTemperature", device: "temperature"
|
|
22
|
+
* { asset: "externalTemperature", device: "temperature" }
|
|
24
23
|
* ]
|
|
25
24
|
*/
|
|
26
|
-
|
|
25
|
+
measureSlots: Array<{
|
|
27
26
|
asset: string;
|
|
28
27
|
device: string;
|
|
29
|
-
type: string;
|
|
30
28
|
}>;
|
|
31
29
|
}>;
|
|
32
30
|
/**
|
|
33
|
-
*
|
|
31
|
+
* Path's of asset groups
|
|
34
32
|
*/
|
|
35
33
|
groups: Array<{
|
|
36
|
-
|
|
34
|
+
path: string;
|
|
37
35
|
date: number;
|
|
38
36
|
}>;
|
|
39
|
-
/**
|
|
40
|
-
* Id's of soft tenants
|
|
41
|
-
* ! Not used directly in this plugin
|
|
42
|
-
*/
|
|
43
|
-
softTenant?: Array<string>;
|
|
44
37
|
}
|
|
45
38
|
/**
|
|
46
39
|
* Asset description used to contextualize each measure data point
|
|
@@ -54,4 +47,4 @@ export type AssetMeasureContext<TMetadata extends Metadata = Metadata> = {
|
|
|
54
47
|
* Name of the measure for the Asset
|
|
55
48
|
*/
|
|
56
49
|
measureName: string;
|
|
57
|
-
} & Pick<AssetContent<
|
|
50
|
+
} & Pick<AssetContent<TMetadata>, "model" | "reference" | "metadata" | "groups">;
|
|
@@ -1,16 +1,9 @@
|
|
|
1
|
-
import {
|
|
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 =
|
|
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,
|
|
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<
|
|
44
|
+
asset: AssetContent<TMetadata>;
|
|
52
45
|
/**
|
|
53
46
|
* Timestamp of the event according to its type
|
|
54
47
|
*
|
|
@@ -3,23 +3,18 @@ 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 {
|
|
7
|
-
import { ApiDeviceLinkAssetRequest } from "./types/DeviceApi";
|
|
8
|
-
import { DeviceContent } from "./types/DeviceContent";
|
|
6
|
+
import { DeviceProvisioningContent, DeviceContent } from "./types/DeviceContent";
|
|
9
7
|
export declare class DeviceService extends DigitalTwinService {
|
|
10
8
|
constructor(plugin: DeviceManagerPlugin);
|
|
11
9
|
registerAskEvents(): void;
|
|
12
10
|
private _create;
|
|
11
|
+
private _createDeviceProvisioning;
|
|
13
12
|
/**
|
|
14
13
|
* Create a new device.
|
|
15
14
|
*
|
|
16
|
-
* @todo creating a device in the "device-manager" index should be a separate
|
|
17
|
-
* method since in this case "engineId" is not really an engine ID but still
|
|
18
|
-
* required as an argument (in part to check the tenant rights)
|
|
19
15
|
*/
|
|
20
16
|
create(model: string, reference: string, metadata: JSONObject, request: KuzzleRequest): Promise<KDocument<DeviceContent>>;
|
|
21
17
|
get(engineId: string, deviceId: string, request: KuzzleRequest): Promise<KDocument<DeviceContent>>;
|
|
22
|
-
private getInternalDevices;
|
|
23
18
|
/**
|
|
24
19
|
* Replace a device metadata
|
|
25
20
|
*/
|
|
@@ -37,7 +32,6 @@ export declare class DeviceService extends DigitalTwinService {
|
|
|
37
32
|
* @param engineId Engine id to attach to
|
|
38
33
|
* @param deviceId Device id to attach
|
|
39
34
|
* @param options.refresh Wait for ES indexation
|
|
40
|
-
* @param options.strict If true, throw if an operation isn't possible
|
|
41
35
|
*/
|
|
42
36
|
private _attachEngine;
|
|
43
37
|
/**
|
|
@@ -55,47 +49,9 @@ export declare class DeviceService extends DigitalTwinService {
|
|
|
55
49
|
* @param {string} deviceId Id of the device
|
|
56
50
|
* @param {KuzzleRequest} request kuzzle request
|
|
57
51
|
*/
|
|
58
|
-
detachEngine(deviceId: string, request: KuzzleRequest): Promise<KDocument<
|
|
59
|
-
/**
|
|
60
|
-
* Link a device to an asset.
|
|
61
|
-
*/
|
|
62
|
-
linkAsset(engineId: string, deviceId: string, assetId: string, measureNames: ApiDeviceLinkAssetRequest["body"]["measureNames"], implicitMeasuresLinking: boolean, request: KuzzleRequest): Promise<{
|
|
63
|
-
asset: KDocument<AssetContent>;
|
|
64
|
-
device: KDocument<DeviceContent>;
|
|
65
|
-
}>;
|
|
52
|
+
detachEngine(deviceId: string, request: KuzzleRequest): Promise<KDocument<DeviceProvisioningContent>>;
|
|
66
53
|
receiveMeasures(engineId: string, deviceId: string, measures: DecodedMeasurement[], payloadUuids: string[], request: KuzzleRequest): Promise<void>;
|
|
67
|
-
/**
|
|
68
|
-
* Checks if the asset does not already have a linked device using one of the
|
|
69
|
-
* requested measure names.
|
|
70
|
-
*/
|
|
71
|
-
private checkAlreadyProvidedMeasures;
|
|
72
|
-
/**
|
|
73
|
-
* Goes through the device available measures and add them into the link if:
|
|
74
|
-
* - they are not already provided by another device
|
|
75
|
-
* - they are not already present in the link request
|
|
76
|
-
* - they are declared in the asset model
|
|
77
|
-
*/
|
|
78
|
-
private generateMissingAssetMeasureNames;
|
|
79
|
-
/**
|
|
80
|
-
* Internal logic of unlink a device of an asset
|
|
81
|
-
*
|
|
82
|
-
* @param {string} deviceId Id of the device
|
|
83
|
-
* @param {KuzzleRequest} request kuzzle request
|
|
84
|
-
*/
|
|
85
|
-
private _unlinkAsset;
|
|
86
|
-
/**
|
|
87
|
-
* Unlink a device of an asset with lock
|
|
88
|
-
*
|
|
89
|
-
* @param {string} deviceId Id of the device
|
|
90
|
-
* @param {KuzzleRequest} request kuzzle request
|
|
91
|
-
*/
|
|
92
|
-
unlinkAsset(deviceId: string, request: KuzzleRequest): Promise<{
|
|
93
|
-
asset: KDocument<AssetContent>;
|
|
94
|
-
device: KDocument<DeviceContent>;
|
|
95
|
-
}>;
|
|
96
54
|
private checkEngineExists;
|
|
97
55
|
private checkAttachedToEngine;
|
|
98
|
-
private
|
|
99
|
-
private getDeviceModel;
|
|
100
|
-
private getAssetModel;
|
|
56
|
+
private refreshModel;
|
|
101
57
|
}
|
|
@@ -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,
|
|
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
|
|
31
|
+
* Link a device to several assets.
|
|
32
32
|
*/
|
|
33
|
-
|
|
33
|
+
linkAssets(request: KuzzleRequest): Promise<ApiDeviceLinkAssetsResult>;
|
|
34
34
|
/**
|
|
35
|
-
* Unlink
|
|
35
|
+
* Unlink assets from a device.
|
|
36
36
|
*/
|
|
37
|
-
|
|
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
|
-
|
|
13
|
+
linkAssets: true,
|
|
14
14
|
search: true,
|
|
15
|
-
|
|
15
|
+
unlinkAssets: true,
|
|
16
16
|
update: true,
|
|
17
17
|
getMeasures: true,
|
|
18
18
|
exportMeasures: true,
|
|
@@ -59,14 +59,39 @@ export interface ApiDeviceSearchRequest extends DevicesControllerRequest {
|
|
|
59
59
|
body: JSONObject;
|
|
60
60
|
}
|
|
61
61
|
export type ApiDeviceSearchResult = SearchResult<KHit<DeviceContent>>;
|
|
62
|
-
export interface
|
|
63
|
-
action: "
|
|
62
|
+
export interface ApiDeviceUnlinkAssetsRequest extends DevicesControllerRequest {
|
|
63
|
+
action: "unlinkAssets";
|
|
64
64
|
_id: string;
|
|
65
65
|
strict?: boolean;
|
|
66
66
|
refresh?: string;
|
|
67
|
+
body: {
|
|
68
|
+
linkedMeasures: Array<{
|
|
69
|
+
assetId: string;
|
|
70
|
+
/**
|
|
71
|
+
* This option allows to not specify the names of all the measures that should
|
|
72
|
+
* be unlinked from the asset.
|
|
73
|
+
*/
|
|
74
|
+
allMeasures?: boolean;
|
|
75
|
+
/**
|
|
76
|
+
* Names of the linked measures.
|
|
77
|
+
*
|
|
78
|
+
* Array<{ asset: string, device: string }>
|
|
79
|
+
*
|
|
80
|
+
* @example
|
|
81
|
+
*
|
|
82
|
+
* [
|
|
83
|
+
* { asset: "externalTemperature", device: "temperature" }
|
|
84
|
+
* ]
|
|
85
|
+
*/
|
|
86
|
+
measureSlots?: Array<{
|
|
87
|
+
asset: string;
|
|
88
|
+
device: string;
|
|
89
|
+
}>;
|
|
90
|
+
}>;
|
|
91
|
+
};
|
|
67
92
|
}
|
|
68
|
-
export type
|
|
69
|
-
|
|
93
|
+
export type ApiDeviceUnlinkAssetsResult = {
|
|
94
|
+
assets: KDocument<AssetContent>[];
|
|
70
95
|
device: KDocument<DeviceContent>;
|
|
71
96
|
};
|
|
72
97
|
export interface ApiDeviceAttachEngineRequest extends DevicesControllerRequest {
|
|
@@ -81,48 +106,50 @@ export interface ApiDeviceDetachEngineRequest extends DevicesControllerRequest {
|
|
|
81
106
|
refresh?: string;
|
|
82
107
|
}
|
|
83
108
|
export type ApiDeviceDetachEngineResult = void;
|
|
84
|
-
export interface
|
|
85
|
-
action: "
|
|
109
|
+
export interface ApiDeviceLinkAssetsRequest extends DevicesControllerRequest {
|
|
110
|
+
action: "linkAssets";
|
|
86
111
|
_id: string;
|
|
87
112
|
refresh?: string;
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
113
|
+
body: {
|
|
114
|
+
linkedMeasures: Array<{
|
|
115
|
+
assetId: string;
|
|
116
|
+
/**
|
|
117
|
+
* This option allows to not specify the names of all the measures that should
|
|
118
|
+
* be linked to the asset.
|
|
119
|
+
*
|
|
120
|
+
* The algorithm will go through all the measures names provided by the device
|
|
121
|
+
* and add the one who are present with the same name in the asset.
|
|
122
|
+
*
|
|
123
|
+
* It will not add the measure if:
|
|
124
|
+
* - it has been specified in the link request
|
|
125
|
+
* - it was already present in the asset
|
|
126
|
+
*
|
|
127
|
+
* @example
|
|
128
|
+
* if the device provide a measure of type "temperature" with the name "temp"
|
|
129
|
+
* if the asset has declared a measure of type "temperature" with the name "temp"
|
|
130
|
+
* then the measure will be automatically added in the link and will later be propagated to the asset
|
|
131
|
+
*/
|
|
132
|
+
implicitMeasuresLinking?: boolean;
|
|
133
|
+
/**
|
|
134
|
+
* Names of the linked measures.
|
|
135
|
+
*
|
|
136
|
+
* Array<{ asset: string, device: string }>
|
|
137
|
+
*
|
|
138
|
+
* @example
|
|
139
|
+
*
|
|
140
|
+
* [
|
|
141
|
+
* { asset: "externalTemperature", device: "temperature" }
|
|
142
|
+
* ]
|
|
143
|
+
*/
|
|
144
|
+
measureSlots?: Array<{
|
|
145
|
+
asset: string;
|
|
146
|
+
device: string;
|
|
147
|
+
}>;
|
|
121
148
|
}>;
|
|
122
149
|
};
|
|
123
150
|
}
|
|
124
|
-
export type
|
|
125
|
-
|
|
151
|
+
export type ApiDeviceLinkAssetsResult = {
|
|
152
|
+
assets: KDocument<AssetContent>[];
|
|
126
153
|
device: KDocument<DeviceContent>;
|
|
127
154
|
};
|
|
128
155
|
export interface ApiDeviceGetMeasuresRequest extends DevicesControllerRequest {
|