kuzzle-device-manager 2.3.2 → 2.4.0-beta.1-1

package/dist/lib/modules/shared/services/DigitalTwinExporter.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DigitalTwinExporter = void 0;
+const plugin_1 = require("../../plugin");
+const __1 = require("../");
+const AbstractExporter_1 = require("./AbstractExporter");
+class DigitalTwinExporter extends AbstractExporter_1.AbstractExporter {
+    exportRedisKey(engineId, exportId) {
+        return `exports:${engineId}:${this.target}:${exportId}`;
+    }
+    getLink(engineId, exportId) {
+        return `/_/device-manager/${engineId}/${this.target}/_export/${exportId}`;
+    }
+    async sendExport(engineId, exportId) {
+        try {
+            const { query, sort } = await this.getExport(engineId, exportId);
+            const digitalTwins = await this.sdk.document.search(engineId, this.target, { query, sort }, { lang: "koncorde", size: 200 });
+            const namedMeasures = await this.getNamedMeasures(engineId);
+            const measureColumns = await this.generateMeasureColumns(namedMeasures);
+            const columns = [
+                { header: "Model", path: "_source.model" },
+                { header: "Reference", path: "_source.reference" },
+                ...measureColumns,
+                { header: "lastMeasuredAt", path: "_source.lastMeasuredAt" },
+            ];
+            const stream = this.getExportStream(digitalTwins, columns);
+            await this.sdk.ms.del(this.exportRedisKey(engineId, exportId));
+            return stream;
+        }
+        catch (error) {
+            this.log.error(error);
+        }
+    }
+    /**
+     * Get the deduplicated Named Measures get from models
+     */
+    async getNamedMeasures(engineId) {
+        const type = this.target === plugin_1.InternalCollection.ASSETS ? "asset" : "device";
+        const query = {
+            and: [{ equals: { type } }],
+        };
+        if (this.target === plugin_1.InternalCollection.ASSETS) {
+            const engine = await this.getEngine(engineId);
+            query.and.push({ equals: { engineGroup: engine.group } });
+        }
+        let result = await this.sdk.document.search(this.plugin.config.adminIndex, plugin_1.InternalCollection.MODELS, {
+            query: { equals: { type } },
+        }, { lang: "koncorde" });
+        // ? Use a map to dedup the NamedMeasures get from models
+        const namedMeasures = new Map();
+        while (result) {
+            for (const { _source } of result.hits) {
+                for (const namedMeasure of _source[type].measures) {
+                    if (!namedMeasures.has(namedMeasure.name)) {
+                        namedMeasures.set(namedMeasure.name, namedMeasure);
+                    }
+                }
+            }
+            result = await result.next();
+        }
+        // ? Ensure stable measures order
+        return [...namedMeasures.values()].sort((a, b) => {
+            if (a.name < b.name) {
+                return -1;
+            }
+            if (a.name > b.name) {
+                return 1;
+            }
+            return 0;
+        });
+    }
+    async generateMeasureColumns(namedMeasures) {
+        const columns = [];
+        const measuresPath = new Map();
+        for (const { name, type } of namedMeasures) {
+            if (!measuresPath.has(name)) {
+                const { measure: measureDefinition } = await (0, __1.ask)("ask:device-manager:model:measure:get", { type });
+                const flattenMeasuresPath = Object.keys((0, __1.flattenObject)(measureDefinition.valuesMappings)).map((path) => path.replace(".type", "").replace(".properties", ""));
+                measuresPath.set(name, flattenMeasuresPath);
+            }
+            for (const path of measuresPath.get(name)) {
+                const header = `${name}.${path}`.replace(`${name}.${type}`, name);
+                columns.push({
+                    header,
+                    isMeasure: true,
+                    path: `_source.measures.${name}.values.${path}`,
+                });
+            }
+        }
+        return columns;
+    }
+}
+exports.DigitalTwinExporter = DigitalTwinExporter;
+//# sourceMappingURL=DigitalTwinExporter.js.map

package/dist/lib/modules/shared/services/DigitalTwinExporter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DigitalTwinExporter.js","sourceRoot":"","sources":["../../../../../lib/modules/shared/services/DigitalTwinExporter.ts"],"names":[],"mappings":";;;AAIA,yCAAkD;AAMlD,2BAA6D;AAC7D,yDAA8D;AAM9D,MAAa,mBAAoB,SAAQ,mCAAgB;IAC7C,cAAc,CAAC,QAAgB,EAAE,QAAgB;QACzD,OAAO,WAAW,QAAQ,IAAI,IAAI,CAAC,MAAM,IAAI,QAAQ,EAAE,CAAC;IAC1D,CAAC;IAES,OAAO,CAAC,QAAgB,EAAE,QAAc;QAChD,OAAO,qBAAqB,QAAQ,IAAI,IAAI,CAAC,MAAM,YAAY,QAAQ,EAAE,CAAC;IAC5E,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,QAAgB,EAAE,QAAgB;QACjD,IAAI;YACF,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAEjE,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CACjD,QAAQ,EACR,IAAI,CAAC,MAAM,EACX,EAAE,KAAK,EAAE,IAAI,EAAE,EACf,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,EAAE,CAChC,CAAC;YAEF,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YAC5D,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;YAExE,MAAM,OAAO,GAAa;gBACxB,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,eAAe,EAAE;gBAC1C,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,mBAAmB,EAAE;gBAClD,GAAG,cAAc;gBACjB,EAAE,MAAM,EAAE,gBAAgB,EAAE,IAAI,EAAE,wBAAwB,EAAE;aAC7D,CAAC;YAEF,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YAC3D,MAAM,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;YAE/D,OAAO,MAAM,CAAC;SACf;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SACvB;IACH,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,gBAAgB,CAAC,QAAgB;QAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,KAAK,2BAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC5E,MAAM,KAAK,GAAe;YACxB,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC;SAC5B,CAAC;QAEF,IAAI,IAAI,CAAC,MAAM,KAAK,2BAAkB,CAAC,MAAM,EAAE;YAC7C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YAC9C,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,WAAW,EAAE,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;SAC3D;QAED,IAAI,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAGzC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAC7B,2BAAkB,CAAC,MAAM,EACzB;YACE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE;SAC5B,EACD,EAAE,IAAI,EAAE,UAAU,EAAE,CACrB,CAAC;QAEF,yDAAyD;QACzD,MAAM,aAAa,GAAG,IAAI,GAAG,EAA4B,CAAC;QAC1D,OAAO,MAAM,EAAE;YACb,KAAK,MAAM,EAAE,OAAO,EAAE,IAAI,MAAM,CAAC,IAAI,EAAE;gBACrC,KAAK,MAAM,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,QAAyB,EAAE;oBAClE,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE;wBACzC,aAAa,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;qBACpD;iBACF;aACF;YACD,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;SAC9B;QAED,iCAAiC;QACjC,OAAO,CAAC,GAAG,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YAC/C,IAAI,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE;gBACnB,OAAO,CAAC,CAAC,CAAC;aACX;YACD,IAAI,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE;gBACnB,OAAO,CAAC,CAAC;aACV;YACD,OAAO,CAAC,CAAC;QACX,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,sBAAsB,CAClC,aAA4B;QAE5B,MAAM,OAAO,GAAoB,EAAE,CAAC;QAEpC,MAAM,YAAY,GAAG,IAAI,GAAG,EAAoB,CAAC;QACjD,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,aAAa,EAAE;YAC1C,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;gBAC3B,MAAM,EAAE,OAAO,EAAE,iBAAiB,EAAE,GAAG,MAAM,IAAA,OAAG,EAC9C,sCAAsC,EACtC,EAAE,IAAI,EAAE,CACT,CAAC;gBAEF,MAAM,mBAAmB,GAAG,MAAM,CAAC,IAAI,CACrC,IAAA,iBAAa,EAAC,iBAAiB,CAAC,cAAc,CAAC,CAChD,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,CAAC;gBAEtE,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;aAC7C;YAED,KAAK,MAAM,IAAI,IAAI,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;gBACzC,MAAM,MAAM,GAAG,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC,OAAO,CAAC,GAAG,IAAI,IAAI,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;gBAElE,OAAO,CAAC,IAAI,CAAC;oBACX,MAAM;oBACN,SAAS,EAAE,IAAI;oBACf,IAAI,EAAE,oBAAoB,IAAI,WAAW,IAAI,EAAE;iBAChD,CAAC,CAAC;aACJ;SACF;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;CACF;AA1HD,kDA0HC"}

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

@@ -0,0 +1,2 @@
+export * from "./AbstractExporter";
+export * from "./DigitalTwinExporter";

package/dist/lib/modules/shared/services/index.js

@@ -0,0 +1,19 @@
+"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("./AbstractExporter"), exports);
+__exportStar(require("./DigitalTwinExporter"), exports);
+//# sourceMappingURL=index.js.map

package/dist/lib/modules/shared/services/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../lib/modules/shared/services/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmC;AACnC,wDAAsC"}

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

@@ -8,4 +8,5 @@ export interface DigitalTwinContent<TMeasures extends JSONObject = JSONObject, T
     measures: {
         [Property in keyof TMeasures]: EmbeddedMeasure<TMeasures[Property]> | null;
     };
+    lastMeasuredAt: number;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kuzzle-device-manager",
-  "version": "2.3.2",
+  "version": "2.4.0-beta.1-1",
   "description": "Manage your IoT devices and assets. Choose a provisioning strategy, receive and decode payload, handle your IoT business logic.",
   "author": "The Kuzzle Team (support@kuzzle.io)",
   "repository": {
@@ -40,6 +40,7 @@
     "@types/lodash": "^4.14.195",
     "@types/node": "^18.15.13",
     "axios": "^1.3.6",
+    "csv-parse": "^5.4.0",
     "cz-conventional-changelog": "^3.3.0",
     "ergol": "^1.0.2",
     "eslint-plugin-jest": "^27.2.1",