kuzzle-device-manager-types 2.4.0-beta.2 → 2.4.0-beta.21

package/dist/lib/modules/shared/services/BaseService.d.ts

@@ -0,0 +1,69 @@
+import { ArgsDocumentControllerCreate, ArgsDocumentControllerDelete, ArgsDocumentControllerUpdate, Backend, EmbeddedSDK, KDocument, KDocumentContent, KHit, KuzzleRequest, SearchResult, User } from "kuzzle";
+import { DeviceManagerPlugin, DeviceManagerConfiguration, InternalCollection } from "../../plugin";
+interface PayloadRequest {
+    collection: InternalCollection;
+    engineId: string;
+}
+export type SearchParams = ReturnType<KuzzleRequest["getSearchParams"]>;
+export declare abstract class BaseService {
+    private plugin;
+    constructor(plugin: DeviceManagerPlugin);
+    protected get app(): Backend;
+    protected get sdk(): EmbeddedSDK;
+    protected get config(): DeviceManagerConfiguration;
+    protected get impersonatedSdk(): (user: User) => EmbeddedSDK;
+    protected normalizeKuzzleRequest(request: KuzzleRequest, { collection, engineId }: PayloadRequest): KuzzleRequest;
+    /**
+     * Wrapper to SDK create method with trigger generic:document events
+     *
+     * @param {KuzzleRequest} request
+     * @param {KDocument} documentId
+     * @param {PayloadRequest} payload
+     * @param {ArgsDocumentControllerCreate} [options]
+     * @returns {Promise<KDocument>}
+     */
+    protected getDocument<T extends KDocumentContent = KDocumentContent>(request: KuzzleRequest, documentId: string, { collection, engineId }: PayloadRequest, options?: ArgsDocumentControllerCreate): Promise<KDocument<T>>;
+    /**
+     * Wrapper to SDK create method with trigger generic:document events
+     *
+     * @param {KuzzleRequest} request
+     * @param {KDocument} document
+     * @param {PayloadRequest} payload
+     * @param {ArgsDocumentControllerCreate} [options]
+     * @returns {Promise<KDocument>}
+     */
+    protected createDocument<T extends KDocumentContent = KDocumentContent>(request: KuzzleRequest, document: KDocument<T>, { collection, engineId }: PayloadRequest, options?: ArgsDocumentControllerCreate): Promise<KDocument<T>>;
+    /**
+     * Wrapper to SDK update method with trigger generic:document events
+     *
+     * @param {KuzzleRequest} request
+     * @param {KDocument} document
+     * @param {PayloadRequest} payload
+     * @param {ArgsDocumentControllerUpdate} [options]
+     * @returns {Promise<KDocument>}
+     */
+    protected updateDocument<T extends KDocumentContent = KDocumentContent>(request: KuzzleRequest, document: KDocument<Partial<T>>, { collection, engineId }: PayloadRequest, options?: ArgsDocumentControllerUpdate): Promise<KDocument<T>>;
+    /**
+     * Wrapper to SDK delete method with trigger generic:document events
+     *
+     * @param {KuzzleRequest} request
+     * @param {string} documentId
+     * @param {PayloadRequest} payload
+     * @param {ArgsDocumentControllerUpdate} [options]
+     * @returns {Promise<{ _id: string }>}
+     */
+    protected deleteDocument(request: KuzzleRequest, documentId: string, { collection, engineId }: PayloadRequest, options?: ArgsDocumentControllerDelete): Promise<{
+        _id: string;
+    }>;
+    /**
+     * Wrapper to SDK search method with trigger generic:document events
+     * ! Caution the pipes are not applied on next()
+     *
+     * @param {KuzzleRequest} request
+     * @param {ArgsDocumentControllerUpdate} [options]
+     * @param {PayloadRequest} payload
+     * @returns {Promise<SearchResult<KHit>>}
+     */
+    protected searchDocument<T extends KDocumentContent = KDocumentContent>(request: KuzzleRequest, { from, size, scrollTTL: scroll }: SearchParams, { collection, engineId }: PayloadRequest): Promise<SearchResult<KHit<T>>>;
+}
+export {};

package/dist/lib/modules/shared/services/DigitalTwinService.d.ts

@@ -0,0 +1,21 @@
+import { MeasureContent } from "../../measure";
+import { DeviceManagerPlugin, InternalCollection } from "../../plugin";
+import { ApiDigitalTwinMGetLastMeasuredAtResult } from "../types/DigitalTwinApi";
+import { BaseService } from "./BaseService";
+export declare class DigitalTwinService extends BaseService {
+    private targetCollection;
+    private readonly digitalTwinType;
+    constructor(plugin: DeviceManagerPlugin, targetCollection: InternalCollection);
+    protected registerAskEvents(): void;
+    /**
+     * Gets the last measures of a digital twin
+     */
+    getLastMeasures(engineId: string, digitalTwinId: string, measureCount?: number): Promise<MeasureContent[]>;
+    /**
+     * Gets the last measures of multiple digital twins
+     */
+    mGetLastMeasures(engineId: string, digitalTwinIds: string[], measureCount?: number): Promise<Record<string, MeasureContent[]>>;
+    getLastMeasuredAt(engineId: string, digitalTwinId: string): Promise<number>;
+    mGetLastMeasuredAt(engineId: string, digitalTwinIds: string[]): Promise<ApiDigitalTwinMGetLastMeasuredAtResult>;
+    private getAggregationQueryParameters;
+}

package/dist/lib/modules/shared/services/index.d.ts

@@ -1,2 +1,4 @@
 export * from "./AbstractExporter";
+export * from "./BaseService";
 export * from "./DigitalTwinExporter";
+export * from "./DigitalTwinService";

package/dist/lib/modules/shared/types/DigitalTwinApi.d.ts

@@ -0,0 +1,34 @@
+import { DigitalTwinMeasures } from "./DigitalTwinMeasures";
+interface DigitalTwinControllerRequest<ControllerName extends string> {
+    controller: ControllerName;
+    engineId: string;
+}
+export interface ApiDigitalTwinGetLastMeasuresRequest<ControllerName extends string> extends DigitalTwinControllerRequest<ControllerName> {
+    action: "getLastMeasures";
+    _id: string;
+    measureCount?: number;
+}
+export type ApiDigitalTwinGetLastMeasuresResult = DigitalTwinMeasures;
+export interface ApiDigitalTwinMGetLastMeasuresRequest<ControllerName extends string> extends DigitalTwinControllerRequest<ControllerName> {
+    action: "mGetLastMeasures";
+    measureCount?: number;
+    body: {
+        ids: string[];
+    };
+}
+export type ApiDigitalTwinMGetLastMeasuresResult = Record<string, DigitalTwinMeasures>;
+export interface ApiDigitalTwinGetLastMeasuredAtRequest<ControllerName extends string> extends DigitalTwinControllerRequest<ControllerName> {
+    action: "getLastMeasuredAt";
+    _id: string;
+}
+export type ApiDigitalTwinGetLastMeasuredAtResult = {
+    lastMeasuredAt: number;
+};
+export interface ApiDigitalTwinMGetLastMeasuredAtRequest<ControllerName extends string> extends DigitalTwinControllerRequest<ControllerName> {
+    action: "mGetLastMeasuredAt";
+    body: {
+        ids: string[];
+    };
+}
+export type ApiDigitalTwinMGetLastMeasuredAtResult = Record<string, number>;
+export {};

package/dist/lib/modules/shared/types/DigitalTwinContent.d.ts

@@ -1,12 +1,10 @@
 import { JSONObject, KDocumentContent } from "kuzzle-sdk";
-import { EmbeddedMeasure } from "./EmbeddedMeasure";
 import { Metadata } from "./Metadata";
+import { DigitalTwinMeasures } from "./DigitalTwinMeasures";
 export interface DigitalTwinContent<TMeasures extends JSONObject = JSONObject, TMetadata extends Metadata = Metadata> extends KDocumentContent {
     model: string;
     reference: string;
     metadata: TMetadata;
-    measures: {
-        [Property in keyof TMeasures]: EmbeddedMeasure<TMeasures[Property]> | null;
-    };
+    measures: DigitalTwinMeasures<TMeasures>;
     lastMeasuredAt: number;
 }

package/dist/lib/modules/shared/types/DigitalTwinEvents.d.ts

@@ -0,0 +1,9 @@
+import { MeasureContent } from "../../measure";
+export type AskDigitalTwinLastMeasuresGet = {
+    name: "ask:device-manager:asset:get-last-measures" | "ask:device-manager:device:get-last-measures";
+    payload: {
+        engineId: string;
+        digitalTwinId: string;
+    };
+    result: MeasureContent[];
+};

package/dist/lib/modules/shared/types/DigitalTwinMeasures.d.ts

@@ -0,0 +1,5 @@
+import { JSONObject } from "kuzzle-sdk";
+import { EmbeddedMeasure } from "./EmbeddedMeasure";
+export type DigitalTwinMeasures<TMeasures extends JSONObject = JSONObject> = {
+    [Property in keyof TMeasures]: EmbeddedMeasure<TMeasures[Property]> | null;
+};

package/dist/tests/application/assets/Container.d.ts

@@ -6,6 +6,9 @@ export interface ContainerMetadata extends Metadata {
         weight: number;
         capacity: number;
     };
+    person: {
+        company: string;
+    };
 }
 export type ContainerMeasurements = {
     temperatureExt: TemperatureMeasurement;

package/dist/tests/application/assets/Room.d.ts

@@ -0,0 +1,2 @@
+import { AssetModelDefinition } from "../../../index";
+export declare const roomAssetDefinition: AssetModelDefinition;

package/dist/tests/application/assets/StreetLamp.d.ts

@@ -0,0 +1,2 @@
+import { AssetModelDefinition } from "../../../index";
+export declare const streetLampAssetDefinition: AssetModelDefinition;

package/dist/tests/application/decoders/DummyTempPositionDecoder.d.ts

@@ -11,6 +11,7 @@ export declare class DummyTempPositionDecoder extends Decoder {
         readonly name: "position";
         readonly type: "position";
     }];
+    constructor();
     validate(payload: JSONObject): Promise<boolean>;
     decode(decodedPayload: DecodedPayload<DummyTempPositionDecoder>, payload: JSONObject): Promise<DecodedPayload<DummyTempPositionDecoder>>;
 }

package/dist/tests/application/measures/BrightnessMeasure.d.ts

@@ -0,0 +1,2 @@
+import { MeasureDefinition } from "lib/modules/measure";
+export declare const brightnessMeasureDefinition: MeasureDefinition;

package/dist/tests/application/measures/CO2Measure.d.ts

@@ -0,0 +1,2 @@
+import { MeasureDefinition } from "lib/modules/measure";
+export declare const co2MeasureDefinition: MeasureDefinition;

package/dist/tests/application/measures/IlluminanceMeasure.d.ts

@@ -0,0 +1,2 @@
+import { MeasureDefinition } from "lib/modules/measure";
+export declare const illuminanceMeasureDefinition: MeasureDefinition;

package/dist/tests/application/measures/PowerConsumptionMeasure.d.ts

@@ -0,0 +1,2 @@
+import { MeasureDefinition } from "lib/modules/measure";
+export declare const powerConsumptionMeasureDefinition: MeasureDefinition;

package/package.json

@@ -1,17 +1,18 @@
 {
   "name": "kuzzle-device-manager-types",
-  "version": "2.4.0-beta.2",
+  "version": "2.4.0-beta.21",
   "description": "Shared types for Kuzzle Device Manager",
   "author": "The Kuzzle Team (support@kuzzle.io)",
   "main": "index.js",
   "types": "dist/index.d.ts",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/kuzzleio/kuzzle-plugin-device-manager.git"
+    "url": "git+https://github.com/kuzzleio/kuzzle-plugin-device-manager.git",
+    "directory": "types"
   },
   "scripts": {
     "prepack": "npm run build",
-    "build": "./copy-types.sh && node scripts/copy-version.js"
+    "build": "./copy-types.sh"
   },
   "license": "Apache-2.0",
   "files": [

package/dist/lib/modules/shared/utils/ask.d.ts

@@ -1,8 +0,0 @@
-export type AskEventDefinition = {
-    name: string;
-    payload: any;
-    result: any;
-};
-export type AskEventHandler<TAskEventDefinition extends AskEventDefinition = AskEventDefinition> = (payload?: TAskEventDefinition["payload"]) => Promise<TAskEventDefinition["result"]>;
-export declare function onAsk<TAskEventDefinition extends AskEventDefinition = AskEventDefinition>(event: TAskEventDefinition["name"], handler: AskEventHandler<TAskEventDefinition>): any;
-export declare function ask<TAskEventDefinition extends AskEventDefinition = AskEventDefinition>(event: TAskEventDefinition["name"], payload?: TAskEventDefinition["payload"]): Promise<TAskEventDefinition["result"]>;