kuzzle-device-manager 2.0.0-rc8 → 2.0.0

package/dist/lib/modules/device/exports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exports.js","sourceRoot":"","sources":["../../../../lib/modules/device/exports.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC;AACtC,oDAAkC;AAClC,uDAAqC;AACrC,2DAAyC;AACzC,mEAAiD;AACjD,4DAA0C"}

package/dist/lib/modules/device/index.d.ts

@@ -0,0 +1,9 @@
+export * from "./collections/deviceMappings";
+export * from "./types/DeviceContent";
+export * from "./types/DeviceApi";
+export * from "./types/DeviceEvents";
+export * from "./model/DeviceSerializer";
+export * from "./DeviceModule";
+export * from "./roles/RoleDevicesAdmin";
+export * from "./roles/RoleDevicesPlatformAdmin";
+export * from "./roles/RoleDevicesReader";

package/dist/lib/modules/device/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./collections/deviceMappings"), exports);
+__exportStar(require("./types/DeviceContent"), exports);
+__exportStar(require("./types/DeviceApi"), exports);
+__exportStar(require("./types/DeviceEvents"), exports);
+__exportStar(require("./model/DeviceSerializer"), exports);
+__exportStar(require("./DeviceModule"), exports);
+__exportStar(require("./roles/RoleDevicesAdmin"), exports);
+__exportStar(require("./roles/RoleDevicesPlatformAdmin"), exports);
+__exportStar(require("./roles/RoleDevicesReader"), exports);
+//# sourceMappingURL=index.js.map

package/dist/lib/modules/device/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../lib/modules/device/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+DAA6C;AAC7C,wDAAsC;AACtC,oDAAkC;AAClC,uDAAqC;AACrC,2DAAyC;AACzC,iDAA+B;AAC/B,2DAAyC;AACzC,mEAAiD;AACjD,4DAA0C"}

package/dist/lib/modules/device/model/DeviceSerializer.d.ts

@@ -0,0 +1,6 @@
+import { KDocument } from "kuzzle";
+import { DeviceContent } from "../types/DeviceContent";
+export declare class DeviceSerializer {
+    static id(model: string, reference: string): string;
+    static serialize(device: KDocument<DeviceContent>): KDocument<DeviceContent>;
+}

package/dist/lib/modules/device/model/DeviceSerializer.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeviceSerializer = void 0;
+class DeviceSerializer {
+    static id(model, reference) {
+        return `${model}-${reference}`;
+    }
+    static serialize(device) {
+        return {
+            _id: device._id,
+            _source: device._source,
+        };
+    }
+}
+exports.DeviceSerializer = DeviceSerializer;
+//# sourceMappingURL=DeviceSerializer.js.map

package/dist/lib/modules/device/model/DeviceSerializer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeviceSerializer.js","sourceRoot":"","sources":["../../../../../lib/modules/device/model/DeviceSerializer.ts"],"names":[],"mappings":";;;AAIA,MAAa,gBAAgB;IAC3B,MAAM,CAAC,EAAE,CAAC,KAAa,EAAE,SAAiB;QACxC,OAAO,GAAG,KAAK,IAAI,SAAS,EAAE,CAAC;IACjC,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,MAAgC;QAC/C,OAAO;YACL,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,OAAO,EAAE,MAAM,CAAC,OAAO;SACxB,CAAC;IACJ,CAAC;CACF;AAXD,4CAWC"}

package/dist/lib/modules/device/roles/RoleDevicesAdmin.d.ts

@@ -0,0 +1,27 @@
+import { KuzzleRole } from "../../shared/types/KuzzleRole";
+/**
+ * This role allows to manage devices.
+ *
+ * It's a tenant role.
+ *
+ * @example
+    "device-manager/devices": {
+      actions: {
+        create: true,
+        delete: true,
+        get: true,
+        linkAsset: true,
+        search: true,
+        unlinkAsset: true,
+        update: true,
+      },
+    },
+    "device-manager/models": {
+      actions: {
+        deleteDevice: true,
+        listDevices: true,
+        writeDevice: true,
+      },
+    },
+ */
+export declare const RoleDevicesAdmin: KuzzleRole;

package/dist/lib/modules/device/roles/RoleDevicesAdmin.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RoleDevicesAdmin = void 0;
+/**
+ * This role allows to manage devices.
+ *
+ * It's a tenant role.
+ *
+ * @example
+    "device-manager/devices": {
+      actions: {
+        create: true,
+        delete: true,
+        get: true,
+        linkAsset: true,
+        search: true,
+        unlinkAsset: true,
+        update: true,
+      },
+    },
+    "device-manager/models": {
+      actions: {
+        deleteDevice: true,
+        listDevices: true,
+        writeDevice: true,
+      },
+    },
+ */
+exports.RoleDevicesAdmin = {
+    name: "devices.admin",
+    definition: {
+        controllers: {
+            "device-manager/devices": {
+                actions: {
+                    create: true,
+                    delete: true,
+                    get: true,
+                    linkAsset: true,
+                    search: true,
+                    unlinkAsset: true,
+                    update: true,
+                },
+            },
+            "device-manager/models": {
+                actions: {
+                    deleteDevice: true,
+                    listDevices: true,
+                    writeDevice: true,
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=RoleDevicesAdmin.js.map

package/dist/lib/modules/device/roles/RoleDevicesAdmin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RoleDevicesAdmin.js","sourceRoot":"","sources":["../../../../../lib/modules/device/roles/RoleDevicesAdmin.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACU,QAAA,gBAAgB,GAAe;IAC1C,IAAI,EAAE,eAAe;IACrB,UAAU,EAAE;QACV,WAAW,EAAE;YACX,wBAAwB,EAAE;gBACxB,OAAO,EAAE;oBACP,MAAM,EAAE,IAAI;oBACZ,MAAM,EAAE,IAAI;oBACZ,GAAG,EAAE,IAAI;oBACT,SAAS,EAAE,IAAI;oBACf,MAAM,EAAE,IAAI;oBACZ,WAAW,EAAE,IAAI;oBACjB,MAAM,EAAE,IAAI;iBACb;aACF;YACD,uBAAuB,EAAE;gBACvB,OAAO,EAAE;oBACP,YAAY,EAAE,IAAI;oBAClB,WAAW,EAAE,IAAI;oBACjB,WAAW,EAAE,IAAI;iBAClB;aACF;SACF;KACF;CACF,CAAC"}

package/dist/lib/modules/device/roles/RoleDevicesPlatformAdmin.d.ts

@@ -0,0 +1,21 @@
+import { KuzzleRole } from "../../shared/types/KuzzleRole";
+/**
+ * This role allows to manage devices and also assign them to tenants.
+ *
+ * It's a platform role.
+ *
+ * @example
+    "device-manager/devices": {
+      actions: {
+        "*": true,
+      },
+    },
+    "device-manager/models": {
+      actions: {
+        deleteDevice: true,
+        listDevices: true,
+        writeDevice: true,
+      },
+    },
+ */
+export declare const RoleDevicesPlatformAdmin: KuzzleRole;

package/dist/lib/modules/device/roles/RoleDevicesPlatformAdmin.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RoleDevicesPlatformAdmin = void 0;
+/**
+ * This role allows to manage devices and also assign them to tenants.
+ *
+ * It's a platform role.
+ *
+ * @example
+    "device-manager/devices": {
+      actions: {
+        "*": true,
+      },
+    },
+    "device-manager/models": {
+      actions: {
+        deleteDevice: true,
+        listDevices: true,
+        writeDevice: true,
+      },
+    },
+ */
+exports.RoleDevicesPlatformAdmin = {
+    name: "devices.platform-admin",
+    definition: {
+        controllers: {
+            "device-manager/devices": {
+                actions: {
+                    "*": true,
+                },
+            },
+            "device-manager/models": {
+                actions: {
+                    deleteDevice: true,
+                    listDevices: true,
+                    writeDevice: true,
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=RoleDevicesPlatformAdmin.js.map

package/dist/lib/modules/device/roles/RoleDevicesPlatformAdmin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RoleDevicesPlatformAdmin.js","sourceRoot":"","sources":["../../../../../lib/modules/device/roles/RoleDevicesPlatformAdmin.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;;;;GAkBG;AACU,QAAA,wBAAwB,GAAe;IAClD,IAAI,EAAE,wBAAwB;IAC9B,UAAU,EAAE;QACV,WAAW,EAAE;YACX,wBAAwB,EAAE;gBACxB,OAAO,EAAE;oBACP,GAAG,EAAE,IAAI;iBACV;aACF;YACD,uBAAuB,EAAE;gBACvB,OAAO,EAAE;oBACP,YAAY,EAAE,IAAI;oBAClB,WAAW,EAAE,IAAI;oBACjB,WAAW,EAAE,IAAI;iBAClB;aACF;SACF;KACF;CACF,CAAC"}

package/dist/lib/modules/device/roles/RoleDevicesReader.d.ts

@@ -0,0 +1,21 @@
+import { KuzzleRole } from "../../shared/types/KuzzleRole";
+/**
+ * This role only gives a read-only access to devices and their models.
+ *
+ * It's a tenant role.
+ *
+ * @example
+    "device-manager/devices": {
+      actions: {
+        get: true,
+        search: true,
+      },
+    },
+    "device-manager/models": {
+      actions: {
+        listDevices: true,
+      },
+    },
+    }
+ */
+export declare const RoleDevicesReader: KuzzleRole;

package/dist/lib/modules/device/roles/RoleDevicesReader.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RoleDevicesReader = void 0;
+/**
+ * This role only gives a read-only access to devices and their models.
+ *
+ * It's a tenant role.
+ *
+ * @example
+    "device-manager/devices": {
+      actions: {
+        get: true,
+        search: true,
+      },
+    },
+    "device-manager/models": {
+      actions: {
+        listDevices: true,
+      },
+    },
+    }
+ */
+exports.RoleDevicesReader = {
+    name: "devices.reader",
+    definition: {
+        controllers: {
+            "device-manager/devices": {
+                actions: {
+                    get: true,
+                    search: true,
+                },
+            },
+            "device-manager/models": {
+                actions: {
+                    listDevices: true,
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=RoleDevicesReader.js.map

package/dist/lib/modules/device/roles/RoleDevicesReader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RoleDevicesReader.js","sourceRoot":"","sources":["../../../../../lib/modules/device/roles/RoleDevicesReader.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;;;;GAkBG;AACU,QAAA,iBAAiB,GAAe;IAC3C,IAAI,EAAE,gBAAgB;IACtB,UAAU,EAAE;QACV,WAAW,EAAE;YACX,wBAAwB,EAAE;gBACxB,OAAO,EAAE;oBACP,GAAG,EAAE,IAAI;oBACT,MAAM,EAAE,IAAI;iBACb;aACF;YACD,uBAAuB,EAAE;gBACvB,OAAO,EAAE;oBACP,WAAW,EAAE,IAAI;iBAClB;aACF;SACF;KACF;CACF,CAAC"}

package/dist/lib/modules/device/types/DeviceApi.d.ts

@@ -0,0 +1,97 @@
+import { JSONObject, KDocument, KHit, SearchResult } from "kuzzle";
+import { AssetContent } from "../../asset";
+import { Metadata } from "../../shared";
+import { DeviceContent } from "./DeviceContent";
+interface DevicesControllerRequest {
+    controller: "device-manager/devices";
+    engineId: string;
+}
+export interface ApiDeviceGetRequest extends DevicesControllerRequest {
+    action: "get";
+    _id: string;
+}
+export type ApiDeviceGetResult = KDocument<DeviceContent>;
+export interface ApiDeviceUpdateRequest extends DevicesControllerRequest {
+    action: "update";
+    _id: string;
+    refresh?: string;
+    body: {
+        metadata: Metadata;
+    };
+}
+export type ApiDeviceUpdateResult = KDocument<DeviceContent>;
+export interface ApiDeviceCreateRequest extends DevicesControllerRequest {
+    action: "create";
+    refresh?: string;
+    body: {
+        model: string;
+        reference: string;
+        metadata?: Metadata;
+    };
+}
+export type ApiDeviceCreateResult = KDocument<DeviceContent>;
+export interface ApiDeviceDeleteRequest extends DevicesControllerRequest {
+    action: "delete";
+    _id: string;
+    refresh?: string;
+    strict?: boolean;
+}
+export type ApiDeviceDeleteResult = void;
+export interface ApiDeviceSearchRequest extends DevicesControllerRequest {
+    action: "search";
+    from?: number;
+    size?: number;
+    scrollTTL?: string;
+    body: JSONObject;
+}
+export type ApiDeviceSearchResult = SearchResult<KHit<DeviceContent>>;
+export interface ApiDeviceUnlinkAssetRequest extends DevicesControllerRequest {
+    action: "unlinkAsset";
+    _id: string;
+    strict?: boolean;
+    refresh?: string;
+}
+export type ApiDeviceUnlinkAssetResult = {
+    asset: KDocument<AssetContent>;
+    device: KDocument<DeviceContent>;
+};
+export interface ApiDeviceAttachEngineRequest extends DevicesControllerRequest {
+    action: "attachEngine";
+    _id: string;
+    refresh?: string;
+}
+export type ApiDeviceAttachEngineResult = void;
+export interface ApiDeviceDetachEngineRequest extends DevicesControllerRequest {
+    action: "detachEngine";
+    _id: string;
+    refresh?: string;
+}
+export type ApiDeviceDetachEngineResult = void;
+export interface ApiDeviceLinkAssetRequest extends DevicesControllerRequest {
+    action: "linkAsset";
+    _id: string;
+    refresh?: string;
+    assetId: string;
+    body?: {
+        /**
+         * Names of the linked measures
+         *
+         * Array<{ asset: string, device: string }>
+         *
+         * @example
+         *
+         * [
+         *   { asset: "externalTemperature", device: "temperature" }
+         * ]
+         */
+        measureNames: Array<{
+            asset: string;
+            device: string;
+        }>;
+    };
+}
+export type ApiDeviceLinkAssetResult = {
+    asset: KDocument<AssetContent>;
+    device: KDocument<DeviceContent>;
+};
+export {};

package/dist/lib/modules/device/types/DeviceApi.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=DeviceApi.js.map

package/dist/lib/modules/device/types/DeviceApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeviceApi.js","sourceRoot":"","sources":["../../../../../lib/modules/device/types/DeviceApi.ts"],"names":[],"mappings":""}

package/dist/lib/modules/device/types/DeviceContent.d.ts

@@ -0,0 +1,14 @@
+import { JSONObject } from "kuzzle";
+import { DigitalTwinContent, Metadata } from "../../shared";
+/**
+ * Device document content
+ */
+export interface DeviceContent<TMeasures extends JSONObject = any, TMetadata extends Metadata = any> extends DigitalTwinContent<TMeasures, TMetadata> {
+    /**
+     * Linked asset unique identifier
+     */
+    assetId?: string;
+    /**
+     */
+    engineId?: string;
+}

package/dist/lib/modules/device/types/DeviceContent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeviceContent.js","sourceRoot":"","sources":["../../../../../lib/modules/device/types/DeviceContent.ts"],"names":[],"mappings":""}

package/dist/lib/modules/device/types/DeviceEvents.d.ts

@@ -0,0 +1,28 @@
+import { KDocument, User } from "kuzzle";
+import { Metadata } from "../../../modules/shared";
+import { DeviceContent } from "./DeviceContent";
+export type EventDeviceUpdateBefore = {
+    name: "device-manager:device:update:before";
+    args: [{
+        device: KDocument<DeviceContent>;
+        metadata: Metadata;
+    }];
+};
+export type EventDeviceUpdateAfter = {
+    name: "device-manager:device:update:after";
+    args: [{
+        device: KDocument<DeviceContent>;
+        metadata: Metadata;
+    }];
+};
+/**
+ * @internal
+ */
+export type AskDeviceUnlinkAsset = {
+    name: "ask:device-manager:device:unlink-asset";
+    payload: {
+        deviceId: string;
+        user: User;
+    };
+    result: void;
+};

package/dist/lib/modules/device/types/DeviceEvents.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=DeviceEvents.js.map

package/dist/lib/modules/device/types/DeviceEvents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeviceEvents.js","sourceRoot":"","sources":["../../../../../lib/modules/device/types/DeviceEvents.ts"],"names":[],"mappings":""}

package/dist/lib/modules/measure/MeasureModule.d.ts

@@ -0,0 +1,5 @@
+import { Module } from "../shared/Module";
+export declare class MeasureModule extends Module {
+    private measureService;
+    init(): Promise<void>;
+}

package/dist/lib/modules/measure/MeasureModule.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MeasureModule = void 0;
+const Module_1 = require("../shared/Module");
+const MeasureService_1 = require("./MeasureService");
+const RoleMeasuresAdmin_1 = require("./roles/RoleMeasuresAdmin");
+const RoleMeasuresReader_1 = require("./roles/RoleMeasuresReader");
+class MeasureModule extends Module_1.Module {
+    async init() {
+        this.measureService = new MeasureService_1.MeasureService(this.plugin);
+        this.plugin.roles.push(RoleMeasuresAdmin_1.RoleMeasuresAdmin);
+        this.plugin.roles.push(RoleMeasuresReader_1.RoleMeasuresReader);
+    }
+}
+exports.MeasureModule = MeasureModule;
+//# sourceMappingURL=MeasureModule.js.map

package/dist/lib/modules/measure/MeasureModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MeasureModule.js","sourceRoot":"","sources":["../../../../lib/modules/measure/MeasureModule.ts"],"names":[],"mappings":";;;AAAA,6CAA0C;AAE1C,qDAAkD;AAClD,iEAA8D;AAC9D,mEAAgE;AAEhE,MAAa,aAAc,SAAQ,eAAM;IAGhC,KAAK,CAAC,IAAI;QACf,IAAI,CAAC,cAAc,GAAG,IAAI,+BAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEtD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,qCAAiB,CAAC,CAAC;QAC1C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,uCAAkB,CAAC,CAAC;IAC7C,CAAC;CACF;AATD,sCASC"}

package/dist/lib/modules/measure/MeasureService.d.ts

@@ -0,0 +1,40 @@
+import { JSONObject, KDocument } from "kuzzle";
+import { DeviceManagerPlugin } from "../../core";
+import { DeviceContent } from "./../device";
+import { Metadata } from "../shared";
+import { DecodedMeasurement } from "./types/MeasureContent";
+export declare class MeasureService {
+    private config;
+    private context;
+    private get sdk();
+    private get app();
+    constructor(plugin: DeviceManagerPlugin);
+    /**
+     * Register new measures from a device, updates :
+     * - admin device
+     * - engine device
+     * - linked asset
+     * - engine measures
+     *
+     * A mutex ensure that a device can ingest one measure at a time.
+     *
+     * This method represents the ingestion pipeline:
+     *  - build measures documents and update digital twins (device and asset)
+     *  - trigger events to enrich measures documents
+     *  - save documents (measures, device and asset)
+     *  - trigger events to trigger business rules
+     */
+    ingest(device: KDocument<DeviceContent>, measurements: DecodedMeasurement<JSONObject>[], metadata: Metadata, payloadUuids: string[]): Promise<void>;
+    private compareMetadata;
+    private updateDeviceMeasures;
+    private updateAssetMeasures;
+    /**
+     * Build the measures documents to save
+     */
+    private buildMeasures;
+    private tryGetLinkedAsset;
+    /**
+     * Retrieve the measure name for the asset
+     */
+    private tryFindAssetMeasureName;
+}