kuzzle-device-manager-types 3.0.0-next.25 → 3.0.0-next.27
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/lib/modules/asset/AssetHistoryService.d.ts +3 -1
- package/dist/lib/modules/asset/AssetModule.d.ts +3 -0
- package/dist/lib/modules/asset/AssetService.d.ts +3 -1
- package/dist/lib/modules/asset/AssetsController.d.ts +3 -1
- package/dist/lib/modules/decoder/Decoder.d.ts +2 -8
- package/dist/lib/modules/decoder/DecoderModule.d.ts +5 -0
- package/dist/lib/modules/decoder/DecodersController.d.ts +3 -1
- package/dist/lib/modules/decoder/DecodersRegister.d.ts +1 -0
- package/dist/lib/modules/decoder/PayloadService.d.ts +3 -1
- package/dist/lib/modules/decoder/PayloadsController.d.ts +3 -1
- package/dist/lib/modules/device/DeviceModule.d.ts +4 -0
- package/dist/lib/modules/device/DeviceService.d.ts +3 -1
- package/dist/lib/modules/device/DevicesController.d.ts +3 -1
- package/dist/lib/modules/group/GroupsController.d.ts +3 -1
- package/dist/lib/modules/group/GroupsModule.d.ts +4 -0
- package/dist/lib/modules/group/GroupsService.d.ts +3 -1
- package/dist/lib/modules/measure/MeasureModule.d.ts +4 -0
- package/dist/lib/modules/measure/MeasureService.d.ts +3 -1
- package/dist/lib/modules/measure/MeasureTargetBuilder.d.ts +1 -1
- package/dist/lib/modules/measure/types/MeasureTarget.d.ts +1 -1
- package/dist/lib/modules/model/ModelModule.d.ts +4 -0
- package/dist/lib/modules/model/ModelService.d.ts +11 -9
- package/dist/lib/modules/model/ModelsController.d.ts +3 -1
- package/dist/lib/modules/model/ModelsRegister.d.ts +5 -4
- package/dist/lib/modules/model/types/ModelApi.d.ts +8 -8
- package/dist/lib/modules/model/types/ModelContent.d.ts +3 -3
- package/dist/lib/modules/model/types/ModelEvents.d.ts +1 -1
- package/dist/lib/modules/plugin/DeviceManagerPlugin.d.ts +3 -3
- package/dist/lib/modules/shared/services/AbstractExporter.d.ts +1 -8
- package/package.json +1 -1
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
import { DeviceManagerPlugin } from "../plugin";
|
|
2
2
|
import { BaseService } from "../shared";
|
|
3
3
|
import { AssetHistoryContent, AssetHistoryEvent } from "./types/AssetHistoryContent";
|
|
4
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
4
5
|
export declare class AssetHistoryService extends BaseService {
|
|
5
|
-
|
|
6
|
+
readonly logger: KuzzleLogger;
|
|
7
|
+
constructor(plugin: DeviceManagerPlugin, assetLogger: KuzzleLogger);
|
|
6
8
|
add<TAssetHistoryEvent extends AssetHistoryEvent>(engineId: string, histories: AssetHistoryContent[]): Promise<void>;
|
|
7
9
|
}
|
|
@@ -1,7 +1,10 @@
|
|
|
1
|
+
import { DeviceManagerPlugin } from "../plugin";
|
|
1
2
|
import { Module } from "../shared/Module";
|
|
2
3
|
export declare class AssetModule extends Module {
|
|
3
4
|
private assetService;
|
|
4
5
|
private assetHistoryService;
|
|
5
6
|
private assetController;
|
|
7
|
+
private logger;
|
|
8
|
+
constructor(plugin: DeviceManagerPlugin);
|
|
6
9
|
init(): Promise<void>;
|
|
7
10
|
}
|
|
@@ -2,12 +2,14 @@ import { KuzzleRequest, User } from "kuzzle";
|
|
|
2
2
|
import { JSONObject, KDocument, KHit, SearchResult, mReplaceResponse } from "kuzzle-sdk";
|
|
3
3
|
import { DeviceManagerPlugin } from "../plugin";
|
|
4
4
|
import { DigitalTwinService, Metadata, SearchParams } from "../shared";
|
|
5
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
5
6
|
import { AssetHistoryService } from "./AssetHistoryService";
|
|
6
7
|
import { ApiAssetMigrateTenantResult, ApiAssetUnlinkDevicesResult, ApiAssetUpdateModelLocales } from "./types/AssetApi";
|
|
7
8
|
import { AssetContent } from "./types/AssetContent";
|
|
8
9
|
export declare class AssetService extends DigitalTwinService {
|
|
9
10
|
readonly assetHistoryService: AssetHistoryService;
|
|
10
|
-
|
|
11
|
+
readonly logger: KuzzleLogger;
|
|
12
|
+
constructor(plugin: DeviceManagerPlugin, assetHistoryService: AssetHistoryService, assetLogger: KuzzleLogger);
|
|
11
13
|
registerAskEvents(): void;
|
|
12
14
|
get(engineId: string, assetId: string, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
|
|
13
15
|
/**
|
|
@@ -4,13 +4,15 @@ import { DeviceManagerPlugin } from "../plugin";
|
|
|
4
4
|
import { DigitalTwinExporter } from "../shared";
|
|
5
5
|
import { AssetService } from "./AssetService";
|
|
6
6
|
import { ApiAssetCreateResult, ApiAssetUpsertResult, ApiAssetDeleteResult, ApiAssetGetMeasuresResult, ApiAssetGetResult, ApiAssetSearchResult, ApiAssetUpdateResult, ApiAssetMigrateTenantResult, ApiAssetMetadataReplaceResult, ApiAssetGetLastMeasuresResult, ApiAssetMGetLastMeasuredAtResult, ApiAssetMGetLastMeasuresResult, ApiAssetGetLastMeasuredAtResult, ApiAssetUpdateModelLocales, ApiAssetLinkDevicesResult, ApiAssetUnlinkDevicesResult, ApiAssetAddMeasureSlotResult, ApiAssetRemoveMeasureSlotResult } from "./types/AssetApi";
|
|
7
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
7
8
|
export declare class AssetsController {
|
|
8
9
|
readonly plugin: DeviceManagerPlugin;
|
|
9
10
|
readonly assetService: AssetService;
|
|
10
11
|
definition: ControllerDefinition;
|
|
11
12
|
readonly exporter: DigitalTwinExporter;
|
|
12
13
|
readonly measureExporter: MeasureExporter;
|
|
13
|
-
|
|
14
|
+
readonly logger: KuzzleLogger;
|
|
15
|
+
constructor(plugin: DeviceManagerPlugin, assetService: AssetService, assetlogger: KuzzleLogger);
|
|
14
16
|
get(request: KuzzleRequest): Promise<ApiAssetGetResult>;
|
|
15
17
|
upsert(request: KuzzleRequest): Promise<ApiAssetUpsertResult>;
|
|
16
18
|
update(request: KuzzleRequest): Promise<ApiAssetUpdateResult>;
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { HttpRoute, KuzzleRequest } from "kuzzle";
|
|
2
2
|
import { JSONObject } from "kuzzle-sdk";
|
|
3
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
3
4
|
import { DecodedPayload } from "./DecodedPayload";
|
|
4
5
|
import { DecoderContent } from "./types/DecoderContent";
|
|
5
6
|
/**
|
|
@@ -22,14 +23,7 @@ export declare abstract class Decoder {
|
|
|
22
23
|
/**
|
|
23
24
|
* Internal logger.
|
|
24
25
|
*/
|
|
25
|
-
log:
|
|
26
|
-
debug: (message: any) => void;
|
|
27
|
-
error: (message: any) => void;
|
|
28
|
-
info: (message: any) => void;
|
|
29
|
-
silly: (message: any) => void;
|
|
30
|
-
verbose: (message: any) => void;
|
|
31
|
-
warn: (message: any) => void;
|
|
32
|
-
};
|
|
26
|
+
log: KuzzleLogger;
|
|
33
27
|
/**
|
|
34
28
|
* Device model name.
|
|
35
29
|
*
|
|
@@ -1,8 +1,13 @@
|
|
|
1
|
+
import { DeviceManagerPlugin } from "../plugin";
|
|
1
2
|
import { Module } from "../shared/Module";
|
|
3
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
2
4
|
export declare class DecoderModule extends Module {
|
|
3
5
|
private payloadService;
|
|
4
6
|
private decoderController;
|
|
5
7
|
private payloadsController;
|
|
8
|
+
readonly decoderLogger: KuzzleLogger;
|
|
9
|
+
readonly payloadLogger: KuzzleLogger;
|
|
10
|
+
constructor(plugin: DeviceManagerPlugin);
|
|
6
11
|
private get decodersRegister();
|
|
7
12
|
init(): Promise<void>;
|
|
8
13
|
}
|
|
@@ -2,11 +2,13 @@ import { ControllerDefinition, KuzzleRequest } from "kuzzle";
|
|
|
2
2
|
import { DecodersRegister } from "./DecodersRegister";
|
|
3
3
|
import { PayloadService } from "./PayloadService";
|
|
4
4
|
import { ApiDecoderListResult, ApiDecoderPrunePayloadsResult } from "./types/DecoderApi";
|
|
5
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
5
6
|
export declare class DecodersController {
|
|
6
7
|
private payloadService;
|
|
7
8
|
private decodersRegister;
|
|
8
9
|
definition: ControllerDefinition;
|
|
9
|
-
|
|
10
|
+
readonly logger: KuzzleLogger;
|
|
11
|
+
constructor(payloadService: PayloadService, decodersRegister: DecodersRegister, logger: KuzzleLogger);
|
|
10
12
|
/**
|
|
11
13
|
* List all available decoders
|
|
12
14
|
*/
|
|
@@ -5,8 +5,10 @@ import { DecodedMeasurement } from "../measure";
|
|
|
5
5
|
import { DeviceManagerPlugin } from "../plugin";
|
|
6
6
|
import { BaseService } from "../shared";
|
|
7
7
|
import { Decoder } from "./Decoder";
|
|
8
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
8
9
|
export declare class PayloadService extends BaseService {
|
|
9
|
-
|
|
10
|
+
readonly logger: KuzzleLogger;
|
|
11
|
+
constructor(plugin: DeviceManagerPlugin, logger: KuzzleLogger);
|
|
10
12
|
/**
|
|
11
13
|
* Process a payload by validating and decode it with the `decoder` associated
|
|
12
14
|
* with the device model. It :
|
|
@@ -2,10 +2,12 @@ import { ControllerDefinition, KuzzleRequest } from "kuzzle";
|
|
|
2
2
|
import { DecodersRegister } from "./DecodersRegister";
|
|
3
3
|
import { PayloadService } from "./PayloadService";
|
|
4
4
|
import { ApiPayloadReceiveUnkownResult } from "./types/PayloadApi";
|
|
5
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
5
6
|
export declare class PayloadsController {
|
|
6
7
|
private payloadService;
|
|
7
8
|
private decodersRegister;
|
|
9
|
+
readonly logger: KuzzleLogger;
|
|
8
10
|
definition: ControllerDefinition;
|
|
9
|
-
constructor(payloadService: PayloadService, decodersRegister: DecodersRegister);
|
|
11
|
+
constructor(payloadService: PayloadService, decodersRegister: DecodersRegister, logger: KuzzleLogger);
|
|
10
12
|
receiveUnknown(request: KuzzleRequest): Promise<ApiPayloadReceiveUnkownResult>;
|
|
11
13
|
}
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
import { DeviceManagerPlugin } from "../plugin";
|
|
1
2
|
import { Module } from "../shared/Module";
|
|
3
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
2
4
|
export declare class DeviceModule extends Module {
|
|
3
5
|
private deviceService;
|
|
4
6
|
private deviceController;
|
|
7
|
+
readonly logger: KuzzleLogger;
|
|
8
|
+
constructor(plugin: DeviceManagerPlugin);
|
|
5
9
|
init(): Promise<void>;
|
|
6
10
|
}
|
|
@@ -5,8 +5,10 @@ import { DeviceManagerPlugin } from "../plugin";
|
|
|
5
5
|
import { DigitalTwinService, Metadata, SearchParams } from "../shared";
|
|
6
6
|
import { DeviceProvisioningContent, DeviceContent } from "./types/DeviceContent";
|
|
7
7
|
import { ApiDeviceUnlinkAssetsResult } from "./exports";
|
|
8
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
8
9
|
export declare class DeviceService extends DigitalTwinService {
|
|
9
|
-
|
|
10
|
+
readonly logger: KuzzleLogger;
|
|
11
|
+
constructor(plugin: DeviceManagerPlugin, logger: KuzzleLogger);
|
|
10
12
|
registerAskEvents(): void;
|
|
11
13
|
private _create;
|
|
12
14
|
private _createDeviceProvisioning;
|
|
@@ -2,13 +2,15 @@ import { ControllerDefinition, KuzzleRequest } from "kuzzle";
|
|
|
2
2
|
import { DeviceManagerPlugin } from "../plugin";
|
|
3
3
|
import { DeviceService } from "./DeviceService";
|
|
4
4
|
import { ApiDeviceAttachEngineResult, ApiDeviceCreateResult, ApiDeviceDeleteResult, ApiDeviceDetachEngineResult, ApiDeviceGetResult, ApiDeviceLinkAssetsResult, ApiDeviceSearchResult, ApiDeviceUnlinkAssetsResult, ApiDeviceUpdateResult, ApiDeviceGetMeasuresResult, ApiDeviceUpsertResult, ApiDeviceGetLastMeasuresResult, ApiDeviceMGetLastMeasuresResult, ApiDeviceGetLastMeasuredAtResult, ApiDeviceMGetLastMeasuredAtResult, ApiDeviceMetadataReplaceResult } from "./types/DeviceApi";
|
|
5
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
5
6
|
export declare class DevicesController {
|
|
6
7
|
private plugin;
|
|
7
8
|
private deviceService;
|
|
8
9
|
definition: ControllerDefinition;
|
|
9
10
|
private exporter;
|
|
10
11
|
private measureExporter;
|
|
11
|
-
|
|
12
|
+
readonly logger: KuzzleLogger;
|
|
13
|
+
constructor(plugin: DeviceManagerPlugin, deviceService: DeviceService, logger: KuzzleLogger);
|
|
12
14
|
get(request: KuzzleRequest): Promise<ApiDeviceGetResult>;
|
|
13
15
|
update(request: KuzzleRequest): Promise<ApiDeviceUpdateResult>;
|
|
14
16
|
replaceMetadata(request: KuzzleRequest): Promise<ApiDeviceMetadataReplaceResult>;
|
|
@@ -2,11 +2,13 @@ import { ControllerDefinition, KuzzleRequest } from "kuzzle";
|
|
|
2
2
|
import { DeviceManagerPlugin } from "../plugin";
|
|
3
3
|
import { ApiGroupAddAssetsResult, ApiGroupAddDevicesResult, ApiGroupCreateResult, ApiGroupDeleteResult, ApiGroupGetResult, ApiGroupListItemsResult, ApiGroupMCreateResult, ApiGroupMUpdateResult, ApiGroupMUpsertResult, ApiGroupRemoveAssetsResult, ApiGroupRemoveDevicesResult, ApiGroupSearchResult, ApiGroupUpdateResult, ApiGroupUpsertResult, GroupsBodyRequest } from "./types/GroupsApi";
|
|
4
4
|
import { GroupsService } from "./GroupsService";
|
|
5
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
5
6
|
export declare class GroupsController {
|
|
6
7
|
private plugin;
|
|
7
8
|
private groupsService;
|
|
8
9
|
definition: ControllerDefinition;
|
|
9
|
-
|
|
10
|
+
readonly logger: KuzzleLogger;
|
|
11
|
+
constructor(plugin: DeviceManagerPlugin, groupsService: GroupsService, logger: KuzzleLogger);
|
|
10
12
|
private get sdk();
|
|
11
13
|
private get as();
|
|
12
14
|
/**
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
import { DeviceManagerPlugin } from "../plugin";
|
|
1
2
|
import { Module } from "../shared/Module";
|
|
3
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
2
4
|
export declare class GroupsModule extends Module {
|
|
3
5
|
private groupsController;
|
|
4
6
|
private groupsService;
|
|
7
|
+
readonly logger: KuzzleLogger;
|
|
8
|
+
constructor(plugin: DeviceManagerPlugin);
|
|
5
9
|
init(): Promise<void>;
|
|
6
10
|
}
|
|
@@ -5,8 +5,10 @@ import { KuzzleRequest } from "kuzzle";
|
|
|
5
5
|
import { AssetContent } from "../asset/types/AssetContent";
|
|
6
6
|
import { ApiGroupMCreateResult, ApiGroupMUpdateResult, ApiGroupMUpsertResult, GroupContent } from "./exports";
|
|
7
7
|
import { DeviceContent } from "../device";
|
|
8
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
8
9
|
export declare class GroupsService extends BaseService {
|
|
9
|
-
|
|
10
|
+
readonly logger: KuzzleLogger;
|
|
11
|
+
constructor(plugin: DeviceManagerPlugin, logger: KuzzleLogger);
|
|
10
12
|
create(_id: string, engineId: string, metadata: JSONObject, model: string, name: string, path: string, request: KuzzleRequest): Promise<KDocument<GroupContent>>;
|
|
11
13
|
get(engineId: string, _id: string, request: KuzzleRequest): Promise<import("kuzzle").KDocument<GroupContent>>;
|
|
12
14
|
update(request: KuzzleRequest, _id: string, engineId: string, name?: string, path?: string, metadata?: Metadata): Promise<import("kuzzle").KDocument<GroupContent>>;
|
|
@@ -1,5 +1,9 @@
|
|
|
1
|
+
import { DeviceManagerPlugin } from "../plugin";
|
|
1
2
|
import { Module } from "../shared/Module";
|
|
3
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
2
4
|
export declare class MeasureModule extends Module {
|
|
3
5
|
private measureService;
|
|
6
|
+
readonly logger: KuzzleLogger;
|
|
7
|
+
constructor(plugin: DeviceManagerPlugin);
|
|
4
8
|
init(): Promise<void>;
|
|
5
9
|
}
|
|
@@ -4,8 +4,10 @@ import { BaseService } from "../shared";
|
|
|
4
4
|
import { DecodedMeasurement } from "./types/MeasureContent";
|
|
5
5
|
import { MeasureSource } from "./types/MeasureSources";
|
|
6
6
|
import { MeasureTarget } from "./types/MeasureTarget";
|
|
7
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
7
8
|
export declare class MeasureService extends BaseService {
|
|
8
|
-
|
|
9
|
+
readonly logger: KuzzleLogger;
|
|
10
|
+
constructor(plugin: DeviceManagerPlugin, logger: KuzzleLogger);
|
|
9
11
|
/**
|
|
10
12
|
* Register new measures updates :
|
|
11
13
|
* - asset
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
import { ApiMeasureTarget, DeviceMeasureTarget } from "./types/MeasureTarget";
|
|
2
|
-
export declare function toApiTarget(indexId: string, assetId: string,
|
|
2
|
+
export declare function toApiTarget(indexId: string, assetId: string, engineGroups?: string[]): ApiMeasureTarget;
|
|
3
3
|
export declare function toDeviceTarget(indexId: string, assetId?: string): DeviceMeasureTarget;
|
|
@@ -9,7 +9,7 @@ export interface DeviceMeasureTarget extends AbstractMeasureTarget {
|
|
|
9
9
|
export interface ApiMeasureTarget extends AbstractMeasureTarget {
|
|
10
10
|
type: "api";
|
|
11
11
|
assetId: string;
|
|
12
|
-
|
|
12
|
+
engineGroups?: string[];
|
|
13
13
|
}
|
|
14
14
|
export declare function isTarget(target: any): target is AbstractMeasureTarget;
|
|
15
15
|
export declare function isTargetDevice(target: any): target is DeviceMeasureTarget;
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
+
import { DeviceManagerPlugin } from "../plugin";
|
|
1
2
|
import { Module } from "../shared/Module";
|
|
3
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
2
4
|
export declare class ModelModule extends Module {
|
|
3
5
|
private modelService;
|
|
4
6
|
private modelController;
|
|
7
|
+
readonly logger: KuzzleLogger;
|
|
8
|
+
constructor(plugin: DeviceManagerPlugin);
|
|
5
9
|
init(): Promise<void>;
|
|
6
10
|
}
|
|
@@ -6,17 +6,19 @@ import { AssetModelContent, DeviceModelContent, GroupModelContent, LocaleDetails
|
|
|
6
6
|
import { SchemaObject } from "ajv";
|
|
7
7
|
import { MeasureValuesDetails } from "../measure";
|
|
8
8
|
import { NamedMeasures } from "../decoder";
|
|
9
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
9
10
|
export declare class ModelService extends BaseService {
|
|
10
|
-
|
|
11
|
+
readonly logger: KuzzleLogger;
|
|
12
|
+
constructor(plugin: DeviceManagerPlugin, logger: KuzzleLogger);
|
|
11
13
|
registerAskEvents(): void;
|
|
12
14
|
private checkModelsConflicts;
|
|
13
15
|
private checkDefaultValues;
|
|
14
16
|
private checkGroupAffinity;
|
|
15
|
-
writeAsset(
|
|
17
|
+
writeAsset(engineGroups: string[], model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: NamedMeasures, tooltipModels: TooltipModels, locales: {
|
|
16
18
|
[valueName: string]: LocaleDetails;
|
|
17
19
|
}, engineIds?: string[]): Promise<KDocument<AssetModelContent>>;
|
|
18
20
|
writeDevice(model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: NamedMeasures): Promise<KDocument<DeviceModelContent>>;
|
|
19
|
-
writeGroup(
|
|
21
|
+
writeGroup(engineGroups: string[], model: string, affinity: JSONObject, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups): Promise<KDocument<GroupModelContent>>;
|
|
20
22
|
writeMeasure(type: string, valuesMappings: JSONObject, validationSchema?: SchemaObject, valuesDetails?: MeasureValuesDetails, locales?: {
|
|
21
23
|
[valueName: string]: LocaleDetails;
|
|
22
24
|
}, engineIds?: string[]): Promise<KDocument<MeasureModelContent>>;
|
|
@@ -24,17 +26,17 @@ export declare class ModelService extends BaseService {
|
|
|
24
26
|
deleteDevice(_id: string): Promise<void>;
|
|
25
27
|
deleteGroup(_id: string): Promise<void>;
|
|
26
28
|
deleteMeasure(_id: string): Promise<void>;
|
|
27
|
-
listAsset(
|
|
29
|
+
listAsset(engineGroups: string[], engineId?: string): Promise<KDocument<AssetModelContent>[]>;
|
|
28
30
|
listDevices(): Promise<KDocument<DeviceModelContent>[]>;
|
|
29
|
-
listGroups(
|
|
31
|
+
listGroups(engineGroups: string[]): Promise<KDocument<GroupModelContent>[]>;
|
|
30
32
|
listMeasures(engineId?: string): Promise<KDocument<MeasureModelContent>[]>;
|
|
31
|
-
searchAssets(
|
|
33
|
+
searchAssets(engineGroups: string[], engineId: string | undefined, searchParams: Partial<SearchParams>): Promise<SearchResult<KHit<AssetModelContent>>>;
|
|
32
34
|
searchDevices(searchParams: Partial<SearchParams>): Promise<SearchResult<KHit<DeviceModelContent>>>;
|
|
33
|
-
searchGroups(
|
|
35
|
+
searchGroups(engineGroups: string[], searchParams: Partial<SearchParams>): Promise<SearchResult<KHit<GroupModelContent>>>;
|
|
34
36
|
searchMeasures(engineId: string | undefined, searchParams: Partial<SearchParams>): Promise<SearchResult<KHit<MeasureModelContent>>>;
|
|
35
37
|
assetExists(model: string): Promise<boolean>;
|
|
36
38
|
deviceExists(model: string): Promise<boolean>;
|
|
37
|
-
getAsset(
|
|
39
|
+
getAsset(engineGroups: string[], engineId: string | undefined, model: string): Promise<KDocument<AssetModelContent>>;
|
|
38
40
|
getDevice(model: string): Promise<KDocument<DeviceModelContent>>;
|
|
39
41
|
getGroup(model: string): Promise<KDocument<GroupModelContent>>;
|
|
40
42
|
getMeasure(type: string, engineId?: string): Promise<KDocument<MeasureModelContent>>;
|
|
@@ -46,7 +48,7 @@ export declare class ModelService extends BaseService {
|
|
|
46
48
|
/**
|
|
47
49
|
* Update an asset model
|
|
48
50
|
*/
|
|
49
|
-
updateAsset(
|
|
51
|
+
updateAsset(engineGroups: string[], model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: AssetModelContent["asset"]["measures"], tooltipModels: TooltipModels, locales: {
|
|
50
52
|
[valueName: string]: LocaleDetails;
|
|
51
53
|
}, request: KuzzleRequest): Promise<KDocument<AssetModelContent>>;
|
|
52
54
|
}
|
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import { ControllerDefinition, KuzzleRequest } from "kuzzle";
|
|
2
2
|
import { ModelService } from "./ModelService";
|
|
3
3
|
import { ApiModelWriteAssetResult, ApiModelWriteDeviceResult, ApiModelWriteMeasureResult, ApiModelUpdateAssetResult, ApiModelDeleteAssetResult, ApiModelDeleteDeviceResult, ApiModelDeleteMeasureResult, ApiModelListAssetsResult, ApiModelListDevicesResult, ApiModelListMeasuresResult, ApiModelGetAssetResult, ApiModelGetDeviceResult, ApiModelGetMeasureResult, ApiModelSearchAssetsResult, ApiModelSearchDevicesResult, ApiModelSearchMeasuresResult, ApiModelDeleteGroupResult, ApiModelGetGroupResult, ApiModelListGroupsResult, ApiModelSearchGroupsResult, ApiModelWriteGroupResult } from "./types/ModelApi";
|
|
4
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
4
5
|
export declare class ModelsController {
|
|
5
6
|
private modelService;
|
|
6
7
|
definition: ControllerDefinition;
|
|
7
|
-
|
|
8
|
+
readonly logger: KuzzleLogger;
|
|
9
|
+
constructor(modelService: ModelService, logger: KuzzleLogger);
|
|
8
10
|
getAsset(request: KuzzleRequest): Promise<ApiModelGetAssetResult>;
|
|
9
11
|
getDevice(request: KuzzleRequest): Promise<ApiModelGetDeviceResult>;
|
|
10
12
|
getGroup(request: KuzzleRequest): Promise<ApiModelGetGroupResult>;
|
|
@@ -10,13 +10,14 @@ export declare class ModelsRegister {
|
|
|
10
10
|
private deviceModels;
|
|
11
11
|
private groupModels;
|
|
12
12
|
private measureModels;
|
|
13
|
+
private logger;
|
|
13
14
|
private get sdk();
|
|
14
15
|
init(plugin: DeviceManagerPlugin): void;
|
|
15
16
|
loadModels(): Promise<void>;
|
|
16
17
|
/**
|
|
17
18
|
* Registers an asset model.
|
|
18
19
|
*
|
|
19
|
-
* @param
|
|
20
|
+
* @param engineGroups - The engine group names.
|
|
20
21
|
* @param model - The name of the asset model, which must be in PascalCase.
|
|
21
22
|
* @param measures - The measures associated with this asset model.
|
|
22
23
|
* @param metadataMappings - The metadata mappings for the model, defaults to an empty object.
|
|
@@ -26,7 +27,7 @@ export declare class ModelsRegister {
|
|
|
26
27
|
* @param tooltipModels - Optional model list for tooltip, containing labels and tooltip content.
|
|
27
28
|
* @throws PluginImplementationError if the model name is not in PascalCase.
|
|
28
29
|
*/
|
|
29
|
-
registerAsset(
|
|
30
|
+
registerAsset(engineGroups: string[], model: string, measures: NamedMeasures, metadataMappings?: MetadataMappings, defaultMetadata?: JSONObject, metadataDetails?: MetadataDetails, metadataGroups?: MetadataGroups, tooltipModels?: TooltipModels, locales?: {
|
|
30
31
|
[valueName: string]: LocaleDetails;
|
|
31
32
|
}): void;
|
|
32
33
|
/**
|
|
@@ -45,7 +46,7 @@ export declare class ModelsRegister {
|
|
|
45
46
|
* Registers a group model.
|
|
46
47
|
*
|
|
47
48
|
*
|
|
48
|
-
* @param
|
|
49
|
+
* @param engineGroups - The engine group names.
|
|
49
50
|
* @param model - The name of the group model, which must be in PascalCase.
|
|
50
51
|
* @param affinity - The type of object accepted and their model affinity.
|
|
51
52
|
* @param metadataMappings - The metadata mappings for the model, defaults to an empty object.
|
|
@@ -54,7 +55,7 @@ export declare class ModelsRegister {
|
|
|
54
55
|
* @param metadataGroups - Optional groups for organizing metadata, with localizations.
|
|
55
56
|
* @throws PluginImplementationError if the model name is not in PascalCase.
|
|
56
57
|
*/
|
|
57
|
-
registerGroup(
|
|
58
|
+
registerGroup(engineGroups: string[], model: string, affinity: GroupAffinity, metadataMappings?: MetadataMappings, defaultMetadata?: JSONObject, metadataDetails?: MetadataDetails, metadataGroups?: MetadataGroups): void;
|
|
58
59
|
registerMeasure(type: string, measureDefinition: MeasureDefinition): void;
|
|
59
60
|
private load;
|
|
60
61
|
}
|
|
@@ -8,7 +8,7 @@ interface ModelsControllerRequest {
|
|
|
8
8
|
export interface ApiModelGetAssetRequest extends ModelsControllerRequest {
|
|
9
9
|
action: "getAsset";
|
|
10
10
|
model: string;
|
|
11
|
-
|
|
11
|
+
engineGroups: string[];
|
|
12
12
|
}
|
|
13
13
|
export type ApiModelGetAssetResult = KDocument<AssetModelContent>;
|
|
14
14
|
export interface ApiModelGetDeviceRequest extends ModelsControllerRequest {
|
|
@@ -30,7 +30,7 @@ export type ApiModelGetMeasureResult = KDocument<MeasureModelContent>;
|
|
|
30
30
|
export interface ApiModelWriteAssetRequest extends ModelsControllerRequest {
|
|
31
31
|
action: "writeAsset";
|
|
32
32
|
body: {
|
|
33
|
-
|
|
33
|
+
engineGroups: string[];
|
|
34
34
|
model: string;
|
|
35
35
|
metadataDetails?: MetadataDetails;
|
|
36
36
|
metadataGroups?: MetadataGroups;
|
|
@@ -60,7 +60,7 @@ export interface ApiModelWriteGroupRequest extends ModelsControllerRequest {
|
|
|
60
60
|
action: "writeGroup";
|
|
61
61
|
body: {
|
|
62
62
|
affinity: GroupAffinity;
|
|
63
|
-
|
|
63
|
+
engineGroups: string[];
|
|
64
64
|
model: string;
|
|
65
65
|
metadataDetails?: MetadataDetails;
|
|
66
66
|
metadataGroups?: MetadataGroups;
|
|
@@ -85,7 +85,7 @@ export interface ApiModelWriteMeasureRequest extends ModelsControllerRequest {
|
|
|
85
85
|
export type ApiModelWriteMeasureResult = KDocument<MeasureModelContent>;
|
|
86
86
|
export interface ApiModelUpdateAssetRequest extends ModelsControllerRequest {
|
|
87
87
|
action: "updateAsset";
|
|
88
|
-
|
|
88
|
+
engineGroups: string[];
|
|
89
89
|
model: string;
|
|
90
90
|
body: {
|
|
91
91
|
metadataDetails?: MetadataDetails;
|
|
@@ -122,7 +122,7 @@ export interface ApiModelDeleteMeasureRequest extends ModelsControllerRequest {
|
|
|
122
122
|
export type ApiModelDeleteMeasureResult = void;
|
|
123
123
|
export interface ApiModelListAssetsRequest extends ModelsControllerRequest {
|
|
124
124
|
action: "listAssets";
|
|
125
|
-
|
|
125
|
+
engineGroups: string[];
|
|
126
126
|
}
|
|
127
127
|
export type ApiModelListAssetsResult = {
|
|
128
128
|
models: KDocument<AssetModelContent>[];
|
|
@@ -137,7 +137,7 @@ export type ApiModelListDevicesResult = {
|
|
|
137
137
|
};
|
|
138
138
|
export interface ApiModelListGroupsRequest extends ModelsControllerRequest {
|
|
139
139
|
action: "listGroups";
|
|
140
|
-
|
|
140
|
+
engineGroups: string[];
|
|
141
141
|
}
|
|
142
142
|
export type ApiModelListGroupsResult = {
|
|
143
143
|
models: KDocument<GroupModelContent>[];
|
|
@@ -153,7 +153,7 @@ export type ApiModelListMeasuresResult = {
|
|
|
153
153
|
};
|
|
154
154
|
export interface ApiModelSearchAssetsRequest extends ModelsControllerRequest {
|
|
155
155
|
action: "searchAssets";
|
|
156
|
-
|
|
156
|
+
engineGroups: string[];
|
|
157
157
|
from?: number;
|
|
158
158
|
size?: number;
|
|
159
159
|
scrollTTL?: string;
|
|
@@ -170,7 +170,7 @@ export interface ApiModelSearchDevicesRequest extends ModelsControllerRequest {
|
|
|
170
170
|
export type ApiModelSearchDevicesResult = SearchResult<KHit<DeviceModelContent>>;
|
|
171
171
|
export interface ApiModelSearchGroupsRequest extends ModelsControllerRequest {
|
|
172
172
|
action: "searchGroups";
|
|
173
|
-
|
|
173
|
+
engineGroups: string[];
|
|
174
174
|
from?: number;
|
|
175
175
|
size?: number;
|
|
176
176
|
scrollTTL?: string;
|
|
@@ -154,11 +154,11 @@ export interface TooltipModels {
|
|
|
154
154
|
}
|
|
155
155
|
export interface AssetModelContent extends KDocumentContent {
|
|
156
156
|
type: "asset";
|
|
157
|
-
|
|
157
|
+
engineGroups: string[];
|
|
158
158
|
/**
|
|
159
159
|
* Optional list of engine IDs (tenant IDs) this model is scoped to.
|
|
160
160
|
* When set, the model is only available to the specified tenants.
|
|
161
|
-
* When absent, the model is available to all tenants in the
|
|
161
|
+
* When absent, the model is available to all tenants in the engineGroups.
|
|
162
162
|
*/
|
|
163
163
|
engineIds?: string[];
|
|
164
164
|
asset: {
|
|
@@ -391,7 +391,7 @@ export interface DeviceModelContent extends KDocumentContent {
|
|
|
391
391
|
}
|
|
392
392
|
export interface GroupModelContent extends KDocumentContent {
|
|
393
393
|
type: "group";
|
|
394
|
-
|
|
394
|
+
engineGroups: string[];
|
|
395
395
|
group: {
|
|
396
396
|
/**
|
|
397
397
|
* Name of the model
|
|
@@ -23,7 +23,7 @@ export declare class DeviceManagerPlugin extends Plugin {
|
|
|
23
23
|
/**
|
|
24
24
|
* Register an asset model
|
|
25
25
|
*
|
|
26
|
-
* @param
|
|
26
|
+
* @param engineGroups Engine group names
|
|
27
27
|
* @param model Name of the asset model. Must follow a naming convention in PascalCase.
|
|
28
28
|
* @param definition Object containing the asset model definition, including:
|
|
29
29
|
* - measures: Array describing measure names and their types.
|
|
@@ -123,7 +123,7 @@ export declare class DeviceManagerPlugin extends Plugin {
|
|
|
123
123
|
* );
|
|
124
124
|
* ```
|
|
125
125
|
*/
|
|
126
|
-
registerAsset: (
|
|
126
|
+
registerAsset: (engineGroups: string[], model: string, definition: AssetModelDefinition) => void;
|
|
127
127
|
/**
|
|
128
128
|
* Register a device.
|
|
129
129
|
*
|
|
@@ -231,7 +231,7 @@ export declare class DeviceManagerPlugin extends Plugin {
|
|
|
231
231
|
* );
|
|
232
232
|
* ```
|
|
233
233
|
*/
|
|
234
|
-
registerGroup: (
|
|
234
|
+
registerGroup: (engineGroups: string[], model: string, definition: GroupModelDefinition) => void;
|
|
235
235
|
/**
|
|
236
236
|
* Register a new measure
|
|
237
237
|
*
|
|
@@ -31,14 +31,7 @@ export declare abstract class AbstractExporter<P extends ExportParams = ExportPa
|
|
|
31
31
|
constructor(plugin: DeviceManagerPlugin, target: InternalCollection, config?: Partial<ExporterOption>);
|
|
32
32
|
protected get sdk(): import("kuzzle").EmbeddedSDK;
|
|
33
33
|
protected get ms(): any;
|
|
34
|
-
protected get log():
|
|
35
|
-
debug: (message: any) => void;
|
|
36
|
-
error: (message: any) => void;
|
|
37
|
-
info: (message: any) => void;
|
|
38
|
-
silly: (message: any) => void;
|
|
39
|
-
verbose: (message: any) => void;
|
|
40
|
-
warn: (message: any) => void;
|
|
41
|
-
};
|
|
34
|
+
protected get log(): import("kuzzle-logger").KuzzleLogger;
|
|
42
35
|
protected getEngine(engineId: string): Promise<EngineContent>;
|
|
43
36
|
protected abstract exportRedisKey(engineId: string, exportId: string): string;
|
|
44
37
|
protected abstract getLink(engineId: string, exportId: UUID, params: P): string;
|