kuzzle-device-manager-types 2.10.2 → 2.11.0-dev.1
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 +4 -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/asset/AssetsGroupsController.d.ts +3 -1
- package/dist/lib/modules/asset/AssetsGroupsService.d.ts +5 -3
- package/dist/lib/modules/asset/types/AssetApi.d.ts +1 -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/measure/MeasureModule.d.ts +4 -0
- package/dist/lib/modules/measure/MeasureService.d.ts +3 -1
- package/dist/lib/modules/model/ModelModule.d.ts +4 -0
- package/dist/lib/modules/model/ModelService.d.ts +3 -1
- package/dist/lib/modules/model/ModelsController.d.ts +3 -1
- package/dist/lib/modules/model/ModelsRegister.d.ts +1 -0
- 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,9 +1,13 @@
|
|
|
1
1
|
import { Module } from "../shared/Module";
|
|
2
|
+
import { DeviceManagerPlugin } from "../plugin";
|
|
2
3
|
export declare class AssetModule extends Module {
|
|
3
4
|
private assetService;
|
|
4
5
|
private assetHistoryService;
|
|
5
6
|
private assetController;
|
|
6
7
|
private assetGroupsController;
|
|
7
8
|
private assetsGroupsService;
|
|
9
|
+
private logger;
|
|
10
|
+
private assetsGroupsLogger;
|
|
11
|
+
constructor(plugin: DeviceManagerPlugin);
|
|
8
12
|
init(): Promise<void>;
|
|
9
13
|
}
|
|
@@ -5,9 +5,11 @@ import { DigitalTwinService, Metadata, SearchParams } from "../shared";
|
|
|
5
5
|
import { AssetHistoryService } from "./AssetHistoryService";
|
|
6
6
|
import { ApiAssetMigrateTenantResult, ApiAssetUpdateModelLocales } from "./types/AssetApi";
|
|
7
7
|
import { AssetContent } from "./types/AssetContent";
|
|
8
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
8
9
|
export declare class AssetService extends DigitalTwinService {
|
|
10
|
+
readonly logger: KuzzleLogger;
|
|
9
11
|
private assetHistoryService;
|
|
10
|
-
constructor(plugin: DeviceManagerPlugin, assetHistoryService: AssetHistoryService);
|
|
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
|
/**
|
|
@@ -2,13 +2,15 @@ import { ControllerDefinition, KuzzleRequest } from "kuzzle";
|
|
|
2
2
|
import { DeviceManagerPlugin } from "../plugin";
|
|
3
3
|
import { AssetService } from "./AssetService";
|
|
4
4
|
import { ApiAssetCreateResult, ApiAssetUpsertResult, ApiAssetDeleteResult, ApiAssetGetMeasuresResult, ApiAssetGetResult, ApiAssetSearchResult, ApiAssetUpdateResult, ApiAssetMigrateTenantResult, ApiAssetMetadataReplaceResult, ApiAssetGetLastMeasuresResult, ApiAssetMGetLastMeasuredAtResult, ApiAssetMGetLastMeasuresResult, ApiAssetGetLastMeasuredAtResult, ApiAssetUpdateModelLocales } from "./types/AssetApi";
|
|
5
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
5
6
|
export declare class AssetsController {
|
|
6
7
|
private plugin;
|
|
7
8
|
private assetService;
|
|
8
9
|
definition: ControllerDefinition;
|
|
9
10
|
private exporter;
|
|
10
11
|
private measureExporter;
|
|
11
|
-
|
|
12
|
+
readonly logger: KuzzleLogger;
|
|
13
|
+
constructor(plugin: DeviceManagerPlugin, assetService: AssetService, assetlogger: KuzzleLogger);
|
|
12
14
|
get(request: KuzzleRequest): Promise<ApiAssetGetResult>;
|
|
13
15
|
upsert(request: KuzzleRequest): Promise<ApiAssetUpsertResult>;
|
|
14
16
|
update(request: KuzzleRequest): Promise<ApiAssetUpdateResult>;
|
|
@@ -2,11 +2,13 @@ import { ControllerDefinition, KuzzleRequest } from "kuzzle";
|
|
|
2
2
|
import { DeviceManagerPlugin } from "../plugin";
|
|
3
3
|
import { ApiGroupAddAssetsResult, ApiGroupCreateResult, ApiGroupDeleteResult, ApiGroupGetResult, ApiGroupRemoveAssetsResult, ApiGroupSearchResult, ApiGroupUpdateResult, AssetsGroupsBodyRequest } from "./types/AssetGroupsApi";
|
|
4
4
|
import { AssetsGroupsService } from "./AssetsGroupsService";
|
|
5
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
5
6
|
export declare class AssetsGroupsController {
|
|
6
7
|
private plugin;
|
|
7
8
|
private assetsGroupsService;
|
|
8
9
|
definition: ControllerDefinition;
|
|
9
|
-
|
|
10
|
+
readonly logger: KuzzleLogger;
|
|
11
|
+
constructor(plugin: DeviceManagerPlugin, assetsGroupsService: AssetsGroupsService, logger: KuzzleLogger);
|
|
10
12
|
private get sdk();
|
|
11
13
|
private get as();
|
|
12
14
|
checkParent(engineId: string, parent: AssetsGroupsBodyRequest["parent"]): Promise<void>;
|
|
@@ -3,8 +3,10 @@ import { DeviceManagerPlugin } from "../plugin";
|
|
|
3
3
|
import { BaseService, SearchParams } from "../shared";
|
|
4
4
|
import { KuzzleRequest } from "kuzzle";
|
|
5
5
|
import { AssetsGroupContent } from "./types/AssetGroupContent";
|
|
6
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
6
7
|
export declare class AssetsGroupsService extends BaseService {
|
|
7
|
-
|
|
8
|
+
readonly logger: KuzzleLogger;
|
|
9
|
+
constructor(plugin: DeviceManagerPlugin, logger: KuzzleLogger);
|
|
8
10
|
create(_id: string, engineId: string, metadata: JSONObject, model: string, name: string, parent: string | null, request: KuzzleRequest): Promise<KDocument<AssetsGroupContent>>;
|
|
9
11
|
get(engineId: string, _id: string, request: KuzzleRequest): Promise<KDocument<AssetsGroupContent>>;
|
|
10
12
|
update(request: KuzzleRequest, _id: string, engineId: string, updateContent: JSONObject): Promise<KDocument<AssetsGroupContent>>;
|
|
@@ -22,7 +24,7 @@ export declare class AssetsGroupsService extends BaseService {
|
|
|
22
24
|
errors: {
|
|
23
25
|
document: {
|
|
24
26
|
_id: string;
|
|
25
|
-
|
|
27
|
+
body: JSONObject;
|
|
26
28
|
};
|
|
27
29
|
status: number;
|
|
28
30
|
reason: string;
|
|
@@ -38,7 +40,7 @@ export declare class AssetsGroupsService extends BaseService {
|
|
|
38
40
|
errors: {
|
|
39
41
|
document: {
|
|
40
42
|
_id: string;
|
|
41
|
-
|
|
43
|
+
body: JSONObject;
|
|
42
44
|
};
|
|
43
45
|
status: number;
|
|
44
46
|
reason: string;
|
|
@@ -2,6 +2,7 @@ import { HttpRoute, KuzzleRequest } from "kuzzle";
|
|
|
2
2
|
import { JSONObject } from "kuzzle-sdk";
|
|
3
3
|
import { DecodedPayload } from "./DecodedPayload";
|
|
4
4
|
import { DecoderContent } from "./types/DecoderContent";
|
|
5
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
5
6
|
/**
|
|
6
7
|
* Array of measures declaration
|
|
7
8
|
*
|
|
@@ -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;
|
|
9
|
+
readonly logger: KuzzleLogger;
|
|
8
10
|
definition: ControllerDefinition;
|
|
9
|
-
constructor(payloadService: PayloadService, decodersRegister: DecodersRegister);
|
|
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
|
}
|
|
@@ -6,8 +6,10 @@ import { DigitalTwinService, Metadata, SearchParams } from "../shared";
|
|
|
6
6
|
import { AssetContent } from "./../asset";
|
|
7
7
|
import { ApiDeviceLinkAssetRequest } from "./types/DeviceApi";
|
|
8
8
|
import { DeviceContent } from "./types/DeviceContent";
|
|
9
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
9
10
|
export declare class DeviceService extends DigitalTwinService {
|
|
10
|
-
|
|
11
|
+
readonly logger: KuzzleLogger;
|
|
12
|
+
constructor(plugin: DeviceManagerPlugin, logger: KuzzleLogger);
|
|
11
13
|
registerAskEvents(): void;
|
|
12
14
|
private _create;
|
|
13
15
|
/**
|
|
@@ -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, ApiDeviceLinkAssetResult, ApiDeviceSearchResult, ApiDeviceUnlinkAssetResult, 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>;
|
|
@@ -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
|
}
|
|
@@ -5,8 +5,10 @@ import { BaseService, Metadata } from "../shared";
|
|
|
5
5
|
import { DecodedMeasurement } from "./types/MeasureContent";
|
|
6
6
|
import { ApiMeasureSource } from "./types/MeasureSources";
|
|
7
7
|
import { ApiMeasureTarget } from "./types/MeasureTarget";
|
|
8
|
+
import { KuzzleLogger } from "kuzzle-logger";
|
|
8
9
|
export declare class MeasureService extends BaseService {
|
|
9
|
-
|
|
10
|
+
readonly logger: KuzzleLogger;
|
|
11
|
+
constructor(plugin: DeviceManagerPlugin, logger: KuzzleLogger);
|
|
10
12
|
/**
|
|
11
13
|
* Register new measures from an API, updates :
|
|
12
14
|
* - asset
|
|
@@ -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,8 +6,10 @@ 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
|
writeAsset(engineGroup: string, model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: NamedMeasures, tooltipModels: TooltipModels, locales: {
|
|
@@ -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>;
|
|
@@ -29,14 +29,7 @@ export declare abstract class AbstractExporter<P extends ExportParams = ExportPa
|
|
|
29
29
|
constructor(plugin: DeviceManagerPlugin, target: InternalCollection, config?: Partial<ExporterOption>);
|
|
30
30
|
protected get sdk(): import("kuzzle").EmbeddedSDK;
|
|
31
31
|
protected get ms(): any;
|
|
32
|
-
protected get log():
|
|
33
|
-
debug: (message: any) => void;
|
|
34
|
-
error: (message: any) => void;
|
|
35
|
-
info: (message: any) => void;
|
|
36
|
-
silly: (message: any) => void;
|
|
37
|
-
verbose: (message: any) => void;
|
|
38
|
-
warn: (message: any) => void;
|
|
39
|
-
};
|
|
32
|
+
protected get log(): import("kuzzle-logger").KuzzleLogger;
|
|
40
33
|
protected getEngine(engineId: string): Promise<EngineContent>;
|
|
41
34
|
protected abstract exportRedisKey(engineId: string, exportId: string): string;
|
|
42
35
|
protected abstract getLink(engineId: string, exportId: UUID, params: P): string;
|