kuzzle-device-manager-types 2.11.0 → 3.0.0-3-dev.2
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/index.d.ts +1 -0
- package/dist/lib/modules/asset/AssetModule.d.ts +1 -4
- package/dist/lib/modules/asset/AssetService.d.ts +7 -4
- package/dist/lib/modules/asset/AssetsController.d.ts +25 -7
- 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 +124 -9
- 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/decoder/Decoder.d.ts +1 -1
- package/dist/lib/modules/decoder/DecodersController.d.ts +4 -1
- package/dist/lib/modules/decoder/PayloadService.d.ts +1 -0
- package/dist/lib/modules/device/DeviceService.d.ts +6 -47
- 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 +69 -41
- package/dist/lib/modules/device/types/DeviceContent.d.ts +56 -5
- package/dist/lib/modules/device/types/DeviceEvents.d.ts +9 -24
- package/dist/lib/modules/group/GroupsController.d.ts +37 -0
- package/dist/lib/modules/group/GroupsModule.d.ts +10 -0
- package/dist/lib/modules/group/GroupsService.d.ts +118 -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/MeasureTargetBuilder.d.ts +1 -1
- 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/MeasureContent.d.ts +9 -2
- package/dist/lib/modules/measure/types/MeasureEvents.d.ts +6 -149
- package/dist/lib/modules/measure/types/MeasureSources.d.ts +5 -0
- package/dist/lib/modules/measure/types/MeasureTarget.d.ts +1 -1
- package/dist/lib/modules/model/ModelService.d.ts +20 -14
- package/dist/lib/modules/model/ModelsController.d.ts +1 -1
- package/dist/lib/modules/model/ModelsRegister.d.ts +6 -5
- package/dist/lib/modules/model/types/ModelApi.d.ts +15 -9
- package/dist/lib/modules/model/types/ModelContent.d.ts +35 -3
- package/dist/lib/modules/model/types/ModelDefinition.d.ts +6 -2
- package/dist/lib/modules/model/types/ModelEvents.d.ts +3 -1
- package/dist/lib/modules/plugin/DeviceManagerEngine.d.ts +15 -6
- package/dist/lib/modules/plugin/DeviceManagerPlugin.d.ts +10 -8
- 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/plugin/types/exports.d.ts +1 -0
- 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 -2
- 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 -24
- package/dist/lib/modules/asset/AssetsGroupsService.d.ts +0 -49
- 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,8 @@
|
|
|
1
|
+
import { JSONObject } from "kuzzle-sdk";
|
|
2
|
+
import { Decoder, DecodedPayload } from "../../../index";
|
|
3
|
+
export declare class EmptyTempDecoder extends Decoder {
|
|
4
|
+
measures: any[];
|
|
5
|
+
constructor();
|
|
6
|
+
validate(rawPayload: JSONObject): Promise<boolean>;
|
|
7
|
+
decode(decodedPayload: DecodedPayload<EmptyTempDecoder>, rawPayload: JSONObject): Promise<DecodedPayload<EmptyTempDecoder>>;
|
|
8
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { GroupContent } from "lib/modules/group/exports";
|
|
2
|
+
import { GroupModel } from "lib/modules/shared";
|
|
3
|
+
declare const modelName = "AssetRestricted";
|
|
4
|
+
export interface AssetRestrictedContent extends GroupContent {
|
|
5
|
+
model: typeof modelName;
|
|
6
|
+
}
|
|
7
|
+
export declare const AssetRestricted: GroupModel;
|
|
8
|
+
export {};
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { GroupContent } from "lib/modules/group/exports";
|
|
2
|
+
import { GroupModel } from "lib/modules/shared";
|
|
3
|
+
declare const modelName = "DeviceRestricted";
|
|
4
|
+
export interface DeviceRestrictedContent extends GroupContent {
|
|
5
|
+
model: typeof modelName;
|
|
6
|
+
}
|
|
7
|
+
export declare const DeviceRestricted: GroupModel;
|
|
8
|
+
export {};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { GroupContent } from "lib/modules/group/exports";
|
|
2
2
|
import { GroupModel, Metadata } from "lib/modules/shared";
|
|
3
3
|
declare const modelName = "Parking";
|
|
4
4
|
export interface ParkingMetadata extends Metadata {
|
|
@@ -7,7 +7,7 @@ export interface ParkingMetadata extends Metadata {
|
|
|
7
7
|
lon: number;
|
|
8
8
|
};
|
|
9
9
|
}
|
|
10
|
-
export interface ParkingGroupContent extends
|
|
10
|
+
export interface ParkingGroupContent extends GroupContent<ParkingMetadata> {
|
|
11
11
|
model: typeof modelName;
|
|
12
12
|
}
|
|
13
13
|
export declare const Parking: GroupModel;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { MeasureModel } from "lib/modules/shared";
|
|
2
2
|
export type PositionMeasurement = {
|
|
3
3
|
position: {
|
|
4
4
|
lat: number;
|
|
@@ -7,4 +7,4 @@ export type PositionMeasurement = {
|
|
|
7
7
|
altitude?: number;
|
|
8
8
|
accuracy?: number;
|
|
9
9
|
};
|
|
10
|
-
export declare const
|
|
10
|
+
export declare const positionMeasureModel: MeasureModel;
|
|
@@ -4,3 +4,8 @@ export * from "./CO2";
|
|
|
4
4
|
export * from "./Illuminance";
|
|
5
5
|
export * from "./Magicule";
|
|
6
6
|
export * from "./PowerConsumption";
|
|
7
|
+
export * from "./MovementMeasure";
|
|
8
|
+
export * from "./PositionMeasure";
|
|
9
|
+
export * from "./TemperatureMeasure";
|
|
10
|
+
export * from "./HumidityMeasure";
|
|
11
|
+
export * from "./BatteryMeasure";
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { Backend, Controller, KuzzleRequest } from "kuzzle";
|
|
2
2
|
export declare class TestsController extends Controller {
|
|
3
3
|
constructor(app: Backend);
|
|
4
|
-
setAssetsHistorizesMeasuresConfig(request: KuzzleRequest): Promise<void>;
|
|
5
4
|
createDigitalTwinFromBackend(request: KuzzleRequest): Promise<void>;
|
|
6
5
|
}
|
package/package.json
CHANGED
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
import { ControllerDefinition, KuzzleRequest } from "kuzzle";
|
|
2
|
-
import { DeviceManagerPlugin } from "../plugin";
|
|
3
|
-
import { ApiGroupAddAssetsResult, ApiGroupCreateResult, ApiGroupDeleteResult, ApiGroupGetResult, ApiGroupRemoveAssetsResult, ApiGroupSearchResult, ApiGroupUpdateResult, AssetsGroupsBodyRequest } from "./types/AssetGroupsApi";
|
|
4
|
-
import { AssetsGroupsService } from "./AssetsGroupsService";
|
|
5
|
-
import { KuzzleLogger } from "kuzzle-logger";
|
|
6
|
-
export declare class AssetsGroupsController {
|
|
7
|
-
private plugin;
|
|
8
|
-
private assetsGroupsService;
|
|
9
|
-
definition: ControllerDefinition;
|
|
10
|
-
readonly logger: KuzzleLogger;
|
|
11
|
-
constructor(plugin: DeviceManagerPlugin, assetsGroupsService: AssetsGroupsService, logger: KuzzleLogger);
|
|
12
|
-
private get sdk();
|
|
13
|
-
private get as();
|
|
14
|
-
checkParent(engineId: string, parent: AssetsGroupsBodyRequest["parent"]): Promise<void>;
|
|
15
|
-
checkChildren(engineId: string, children: AssetsGroupsBodyRequest["children"]): Promise<void>;
|
|
16
|
-
checkGroupName(engineId: string, name: AssetsGroupsBodyRequest["name"], groupId?: string): Promise<void>;
|
|
17
|
-
create(request: KuzzleRequest): Promise<ApiGroupCreateResult>;
|
|
18
|
-
get(request: KuzzleRequest): Promise<ApiGroupGetResult>;
|
|
19
|
-
update(request: KuzzleRequest): Promise<ApiGroupUpdateResult>;
|
|
20
|
-
delete(request: KuzzleRequest): Promise<ApiGroupDeleteResult>;
|
|
21
|
-
search(request: KuzzleRequest): Promise<ApiGroupSearchResult>;
|
|
22
|
-
addAsset(request: KuzzleRequest): Promise<ApiGroupAddAssetsResult>;
|
|
23
|
-
removeAsset(request: KuzzleRequest): Promise<ApiGroupRemoveAssetsResult>;
|
|
24
|
-
}
|
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
import { JSONObject, KDocument } from "kuzzle-sdk";
|
|
2
|
-
import { DeviceManagerPlugin } from "../plugin";
|
|
3
|
-
import { BaseService, SearchParams } from "../shared";
|
|
4
|
-
import { KuzzleRequest } from "kuzzle";
|
|
5
|
-
import { AssetsGroupContent } from "./types/AssetGroupContent";
|
|
6
|
-
import { KuzzleLogger } from "kuzzle-logger";
|
|
7
|
-
export declare class AssetsGroupsService extends BaseService {
|
|
8
|
-
readonly logger: KuzzleLogger;
|
|
9
|
-
constructor(plugin: DeviceManagerPlugin, logger: KuzzleLogger);
|
|
10
|
-
create(_id: string, engineId: string, metadata: JSONObject, model: string, name: string, parent: string | null, request: KuzzleRequest): Promise<KDocument<AssetsGroupContent>>;
|
|
11
|
-
get(engineId: string, _id: string, request: KuzzleRequest): Promise<KDocument<AssetsGroupContent>>;
|
|
12
|
-
update(request: KuzzleRequest, _id: string, engineId: string, updateContent: JSONObject): Promise<KDocument<AssetsGroupContent>>;
|
|
13
|
-
delete(_id: string, engineId: string, request: KuzzleRequest): Promise<{
|
|
14
|
-
_id: string;
|
|
15
|
-
}>;
|
|
16
|
-
search(engineId: string, searchParams: SearchParams, request: KuzzleRequest): Promise<import("kuzzle-sdk").SearchResult<import("kuzzle-sdk").KHit<AssetsGroupContent>>>;
|
|
17
|
-
addAsset(engineId: string, _id: string, assetIds: string[], request: KuzzleRequest): Promise<{
|
|
18
|
-
assetsGroups: KDocument<AssetsGroupContent>;
|
|
19
|
-
successes: {
|
|
20
|
-
_id: string;
|
|
21
|
-
_source: JSONObject;
|
|
22
|
-
_version: number;
|
|
23
|
-
}[];
|
|
24
|
-
errors: {
|
|
25
|
-
document: {
|
|
26
|
-
_id: string;
|
|
27
|
-
body: JSONObject;
|
|
28
|
-
};
|
|
29
|
-
status: number;
|
|
30
|
-
reason: string;
|
|
31
|
-
}[];
|
|
32
|
-
}>;
|
|
33
|
-
removeAsset(engineId: string, _id: string, assetIds: string[], request: KuzzleRequest): Promise<{
|
|
34
|
-
assetsGroups: KDocument<AssetsGroupContent>;
|
|
35
|
-
successes: {
|
|
36
|
-
_id: string;
|
|
37
|
-
_source: JSONObject;
|
|
38
|
-
_version: number;
|
|
39
|
-
}[];
|
|
40
|
-
errors: {
|
|
41
|
-
document: {
|
|
42
|
-
_id: string;
|
|
43
|
-
body: JSONObject;
|
|
44
|
-
};
|
|
45
|
-
status: number;
|
|
46
|
-
reason: string;
|
|
47
|
-
}[];
|
|
48
|
-
}>;
|
|
49
|
-
}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { KDocumentContent } from "kuzzle-sdk";
|
|
2
|
-
import { Metadata } from "lib/modules/shared";
|
|
3
|
-
export interface AssetsGroupsBody<TMetadata extends Metadata = Metadata> extends KDocumentContent {
|
|
4
|
-
name: string;
|
|
5
|
-
model?: string | null;
|
|
6
|
-
children: string[];
|
|
7
|
-
parent: string | null;
|
|
8
|
-
lastUpdate: number;
|
|
9
|
-
metadata?: TMetadata;
|
|
10
|
-
}
|
|
11
|
-
export type AssetsGroupContent<TMetadata extends Metadata = any> = AssetsGroupsBody<TMetadata>;
|
|
@@ -1,59 +0,0 @@
|
|
|
1
|
-
import { JSONObject, KDocument, KHit, SearchResult, mUpdateResponse } from "kuzzle-sdk";
|
|
2
|
-
import { AssetsGroupsBody, AssetsGroupContent } from "./AssetGroupContent";
|
|
3
|
-
type AssetsGroupsRequest = Omit<AssetsGroupsBody, "lastUpdate">;
|
|
4
|
-
export type AssetsGroupsBodyRequest = Partial<AssetsGroupsRequest> & Omit<AssetsGroupsRequest, "parent" | "type">;
|
|
5
|
-
export type UpdateAssetLinkResponse = mUpdateResponse & {
|
|
6
|
-
assetsGroups: KDocument<AssetsGroupContent>;
|
|
7
|
-
};
|
|
8
|
-
interface GroupControllerRequest {
|
|
9
|
-
controller: "device-manager/assetsGroup";
|
|
10
|
-
engineId: string;
|
|
11
|
-
}
|
|
12
|
-
export interface ApiGroupCreateRequest extends GroupControllerRequest {
|
|
13
|
-
action: "create";
|
|
14
|
-
_id?: string;
|
|
15
|
-
body: Omit<AssetsGroupsBodyRequest, "children">;
|
|
16
|
-
}
|
|
17
|
-
export type ApiGroupCreateResult = KDocument<AssetsGroupContent>;
|
|
18
|
-
export interface ApiGroupGetRequest extends GroupControllerRequest {
|
|
19
|
-
action: "get";
|
|
20
|
-
_id: string;
|
|
21
|
-
}
|
|
22
|
-
export type ApiGroupGetResult = KDocument<AssetsGroupContent>;
|
|
23
|
-
export interface ApiGroupUpdateRequest extends GroupControllerRequest {
|
|
24
|
-
action: "update";
|
|
25
|
-
_id: string;
|
|
26
|
-
body: AssetsGroupsBodyRequest;
|
|
27
|
-
}
|
|
28
|
-
export type ApiGroupUpdateResult = KDocument<AssetsGroupContent>;
|
|
29
|
-
export interface ApiGroupDeleteRequest extends GroupControllerRequest {
|
|
30
|
-
action: "delete";
|
|
31
|
-
_id: string;
|
|
32
|
-
}
|
|
33
|
-
export type ApiGroupDeleteResult = void;
|
|
34
|
-
export interface ApiGroupSearchRequest extends GroupControllerRequest {
|
|
35
|
-
action: "search";
|
|
36
|
-
from?: number;
|
|
37
|
-
size?: number;
|
|
38
|
-
scrollTTL?: string;
|
|
39
|
-
lang?: "koncorde" | "elasticsearch";
|
|
40
|
-
body: JSONObject;
|
|
41
|
-
}
|
|
42
|
-
export type ApiGroupSearchResult = SearchResult<KHit<AssetsGroupContent>>;
|
|
43
|
-
export interface ApiGroupAddAssetsRequest extends GroupControllerRequest {
|
|
44
|
-
action: "addAsset";
|
|
45
|
-
_id: string;
|
|
46
|
-
body: {
|
|
47
|
-
assetIds: string[];
|
|
48
|
-
};
|
|
49
|
-
}
|
|
50
|
-
export type ApiGroupAddAssetsResult = UpdateAssetLinkResponse;
|
|
51
|
-
export interface ApiGroupRemoveAssetsRequest extends GroupControllerRequest {
|
|
52
|
-
action: "removeAsset";
|
|
53
|
-
_id: string;
|
|
54
|
-
body: {
|
|
55
|
-
assetIds: string[];
|
|
56
|
-
};
|
|
57
|
-
}
|
|
58
|
-
export type ApiGroupRemoveAssetsResult = UpdateAssetLinkResponse;
|
|
59
|
-
export {};
|