kuzzle-device-manager 3.0.0-3-dev.19 → 3.0.0-3-dev.20

package/dist/bin/migration/migrate-tenant-classes.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/bin/migration/migrate-tenant-classes.js

@@ -0,0 +1,133 @@
+#!/usr/bin/env node
+"use strict";
+/* eslint-disable no-console */
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Renames the `engineGroups` field of the model documents to `tenantClasses`,
+ * then updates every device-manager engine so the tenant collections get the
+ * mappings of the migrated models.
+ *
+ * Run it against a Kuzzle that already runs the new Device Manager version.
+ * See doc/3/guides/rename-engine-groups-to-tenant-classes.
+ */
+const kuzzle_sdk_1 = require("kuzzle-sdk");
+const args = {};
+for (const val of process.argv.slice(2)) {
+    if (val.startsWith("--")) {
+        const [key, ...value] = val.slice(2).split("=");
+        args[key] = value.length > 0 ? value.join("=") : true;
+    }
+}
+function option(name, env, defaultValue) {
+    const value = args[name] ?? process.env[env] ?? defaultValue;
+    return typeof value === "string" ? value : undefined;
+}
+const host = option("host", "KUZZLE_HOST", "localhost");
+const port = Number(option("port", "KUZZLE_PORT", "7512"));
+const protocol = option("protocol", "KUZZLE_PROTOCOL", "websocket");
+const ssl = args.ssl === true || process.env.KUZZLE_SSL === "true";
+const username = option("username", "KUZZLE_USERNAME");
+const password = option("password", "KUZZLE_PASSWORD");
+const platformIndex = option("platform-index", "PLATFORM_INDEX", "device-manager");
+const dryRun = args["dry-run"] === true;
+const skipEngines = args["skip-engines"] === true;
+const MODELS = "models";
+const CHUNK_SIZE = 200;
+async function connect() {
+    const Protocol = protocol === "http" ? kuzzle_sdk_1.Http : kuzzle_sdk_1.WebSocket;
+    const sdk = new kuzzle_sdk_1.Kuzzle(new Protocol(host, { port, ssl }));
+    await sdk.connect();
+    if (username) {
+        await sdk.auth.login("local", { password, username });
+    }
+    return sdk;
+}
+async function assertNewMappings(sdk) {
+    const mappings = await sdk.collection.getMapping(platformIndex, MODELS);
+    if (!mappings.properties?.tenantClasses) {
+        throw new Error(`The "${platformIndex}:${MODELS}" collection has no "tenantClasses" field. ` +
+            "Start Kuzzle with the new Device Manager version before running this script.");
+    }
+}
+async function fetchLegacyModels(sdk) {
+    const documents = [];
+    let result = await sdk.document.search(platformIndex, MODELS, { query: { exists: { field: "engineGroups" } } }, { lang: "elasticsearch", scroll: "1m", size: CHUNK_SIZE });
+    while (result) {
+        documents.push(...result.hits);
+        result = await result.next();
+    }
+    return documents;
+}
+async function migrateModels(sdk) {
+    const legacyModels = await fetchLegacyModels(sdk);
+    console.info(`${legacyModels.length} model(s) still use "engineGroups"`);
+    const documents = legacyModels.map(({ _id, _source }) => {
+        const { engineGroups, ...body } = _source;
+        delete body._kuzzle_info;
+        // A model registered by the application at startup may already have
+        // been rewritten with `tenantClasses`: the new value wins.
+        body.tenantClasses ?? (body.tenantClasses = engineGroups);
+        console.info(`  ${_id}: ${JSON.stringify(body.tenantClasses)}`);
+        return { _id, body };
+    });
+    if (dryRun) {
+        return;
+    }
+    for (let i = 0; i < documents.length; i += CHUNK_SIZE) {
+        const { errors } = await sdk.document.mReplace(platformIndex, MODELS, documents.slice(i, i + CHUNK_SIZE), { refresh: "wait_for" });
+        if (errors.length > 0) {
+            for (const error of errors) {
+                console.error(`  Cannot migrate ${error.document._id}: ${error.reason}`);
+            }
+            throw new Error(`${errors.length} model(s) could not be migrated`);
+        }
+    }
+    const remaining = await sdk.document.count(platformIndex, MODELS, {
+        query: { exists: { field: "engineGroups" } },
+    });
+    if (remaining > 0) {
+        throw new Error(`${remaining} model(s) still use "engineGroups"`);
+    }
+}
+async function updateEngines(sdk) {
+    const { result } = await sdk.query({
+        action: "list",
+        controller: "device-manager/engine",
+    });
+    const engines = result.engines;
+    console.info(`Updating ${engines.length} engine(s)`);
+    for (const engine of engines) {
+        console.info(`  ${engine.index} (${engine.group})`);
+        if (dryRun) {
+            continue;
+        }
+        await sdk.query({
+            action: "update",
+            controller: "device-manager/engine",
+            group: engine.group,
+            index: engine.index,
+        });
+    }
+}
+async function run() {
+    const sdk = await connect();
+    try {
+        if (dryRun) {
+            console.info("Dry run: nothing will be written");
+        }
+        await assertNewMappings(sdk);
+        await migrateModels(sdk);
+        if (!skipEngines) {
+            await updateEngines(sdk);
+        }
+        console.info("Done");
+    }
+    finally {
+        sdk.disconnect();
+    }
+}
+run().catch((error) => {
+    console.error(error.message ?? error);
+    process.exitCode = 1;
+});
+//# sourceMappingURL=migrate-tenant-classes.js.map

package/dist/bin/migration/migrate-tenant-classes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrate-tenant-classes.js","sourceRoot":"","sources":["../../../bin/migration/migrate-tenant-classes.ts"],"names":[],"mappings":";;AACA,+BAA+B;;AAE/B;;;;;;;GAOG;AAEH,2CAAiE;AAEjE,MAAM,IAAI,GAAkC,EAAE,CAAC;AAC/C,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IACxC,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,MAAM,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAChD,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACxD,CAAC;AACH,CAAC;AAED,SAAS,MAAM,CAAC,IAAY,EAAE,GAAW,EAAE,YAAqB;IAC9D,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC;IAC7D,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AACvD,CAAC;AAED,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;AACxD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC;AAC3D,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,EAAE,iBAAiB,EAAE,WAAW,CAAC,CAAC;AACpE,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,KAAK,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,KAAK,MAAM,CAAC;AACnE,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;AACvD,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;AACvD,MAAM,aAAa,GAAG,MAAM,CAC1B,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,CACjB,CAAC;AACF,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,IAAI,CAAC;AACxC,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,IAAI,CAAC;AAElD,MAAM,MAAM,GAAG,QAAQ,CAAC;AACxB,MAAM,UAAU,GAAG,GAAG,CAAC;AAEvB,KAAK,UAAU,OAAO;IACpB,MAAM,QAAQ,GAAG,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,iBAAI,CAAC,CAAC,CAAC,sBAAS,CAAC;IACxD,MAAM,GAAG,GAAG,IAAI,mBAAM,CAAC,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IAE1D,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;IAEpB,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AAED,KAAK,UAAU,iBAAiB,CAAC,GAAW;IAC1C,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;IAExE,IAAI,CAAE,QAAQ,CAAC,UAAyB,EAAE,aAAa,EAAE,CAAC;QACxD,MAAM,IAAI,KAAK,CACb,QAAQ,aAAa,IAAI,MAAM,6CAA6C;YAC1E,8EAA8E,CACjF,CAAC;IACJ,CAAC;AACH,CAAC;AAED,KAAK,UAAU,iBAAiB,CAAC,GAAW;IAC1C,MAAM,SAAS,GAAgD,EAAE,CAAC;IAClE,IAAI,MAAM,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,CACpC,aAAa,EACb,MAAM,EACN,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE,EAAE,EAChD,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,CAC1D,CAAC;IAEF,OAAO,MAAM,EAAE,CAAC;QACd,SAAS,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QAC/B,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;IAC/B,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,GAAW;IACtC,MAAM,YAAY,GAAG,MAAM,iBAAiB,CAAC,GAAG,CAAC,CAAC;IAElD,OAAO,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,MAAM,oCAAoC,CAAC,CAAC;IAEzE,MAAM,SAAS,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE;QACtD,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;QAC1C,OAAO,IAAI,CAAC,YAAY,CAAC;QAEzB,oEAAoE;QACpE,2DAA2D;QAC3D,IAAI,CAAC,aAAa,KAAlB,IAAI,CAAC,aAAa,GAAK,YAAY,EAAC;QAEpC,OAAO,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;QAEhE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,IAAI,MAAM,EAAE,CAAC;QACX,OAAO;IACT,CAAC;IAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,IAAI,UAAU,EAAE,CAAC;QACtD,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAC5C,aAAa,EACb,MAAM,EACN,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,EAClC,EAAE,OAAO,EAAE,UAAU,EAAE,CACxB,CAAC;QAEF,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBAC3B,OAAO,CAAC,KAAK,CACX,oBAAoB,KAAK,CAAC,QAAQ,CAAC,GAAG,KAAK,KAAK,CAAC,MAAM,EAAE,CAC1D,CAAC;YACJ,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,iCAAiC,CAAC,CAAC;QACrE,CAAC;IACH,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,aAAa,EAAE,MAAM,EAAE;QAChE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE;KAC7C,CAAC,CAAC;IAEH,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CAAC,GAAG,SAAS,oCAAoC,CAAC,CAAC;IACpE,CAAC;AACH,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,GAAW;IACtC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,CAAC,KAAK,CAAC;QACjC,MAAM,EAAE,MAAM;QACd,UAAU,EAAE,uBAAuB;KACpC,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,MAAM,CAAC,OAAkD,CAAC;IAE1E,OAAO,CAAC,IAAI,CAAC,YAAY,OAAO,CAAC,MAAM,YAAY,CAAC,CAAC;IAErD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,OAAO,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC,KAAK,KAAK,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC;QAEpD,IAAI,MAAM,EAAE,CAAC;YACX,SAAS;QACX,CAAC;QAED,MAAM,GAAG,CAAC,KAAK,CAAC;YACd,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE,uBAAuB;YACnC,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,KAAK,EAAE,MAAM,CAAC,KAAK;SACpB,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED,KAAK,UAAU,GAAG;IAChB,MAAM,GAAG,GAAG,MAAM,OAAO,EAAE,CAAC;IAE5B,IAAI,CAAC;QACH,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;QACnD,CAAC;QAED,MAAM,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAC7B,MAAM,aAAa,CAAC,GAAG,CAAC,CAAC;QAEzB,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,aAAa,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvB,CAAC;YAAS,CAAC;QACT,GAAG,CAAC,UAAU,EAAE,CAAC;IACnB,CAAC;AACH,CAAC;AAED,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACpB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,CAAC;IACtC,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACvB,CAAC,CAAC,CAAC"}

package/dist/lib/modules/asset/AssetHistoryService.d.ts

@@ -5,5 +5,5 @@ import { KuzzleLogger } from "kuzzle-logger";
 export declare class AssetHistoryService extends BaseService {
     readonly logger: KuzzleLogger;
     constructor(plugin: DeviceManagerPlugin, assetLogger: KuzzleLogger);
-    add<TAssetHistoryEvent extends AssetHistoryEvent>(engineId: string, histories: AssetHistoryContent[]): Promise<void>;
+    add<TAssetHistoryEvent extends AssetHistoryEvent>(index: string, histories: AssetHistoryContent[]): Promise<void>;
 }

package/dist/lib/modules/asset/AssetHistoryService.js

@@ -8,9 +8,9 @@ class AssetHistoryService extends shared_1.BaseService {
     constructor(plugin, assetLogger) {
         super(plugin);
         this.logger = assetLogger;
-        (0, kuzzle_plugin_commons_1.onAsk)("ask:device-manager:asset:history:add", async ({ engineId, histories }) => this.add(engineId, histories));
+        (0, kuzzle_plugin_commons_1.onAsk)("ask:device-manager:asset:history:add", async ({ index, histories }) => this.add(index, histories));
     }
-    async add(engineId, histories) {
+    async add(index, histories) {
         const contents = [];
         for (const { asset, event, id, timestamp } of histories) {
             contents.push({
@@ -22,7 +22,7 @@ class AssetHistoryService extends shared_1.BaseService {
                 },
             });
         }
-        await this.sdk.document.mCreate(engineId, plugin_1.InternalCollection.ASSETS_HISTORY, contents, { strict: true });
+        await this.sdk.document.mCreate(index, plugin_1.InternalCollection.ASSETS_HISTORY, contents, { strict: true });
     }
 }
 exports.AssetHistoryService = AssetHistoryService;

package/dist/lib/modules/asset/AssetHistoryService.js.map

@@ -1 +1 @@
-{"version":3,"file":"AssetHistoryService.js","sourceRoot":"","sources":["../../../../lib/modules/asset/AssetHistoryService.ts"],"names":[],"mappings":";;;AAAA,iEAA8C;AAG9C,sCAAoE;AACpE,sCAAwC;AASxC,MAAa,mBAAoB,SAAQ,oBAAW;IAElD,YAAY,MAA2B,EAAE,WAAyB;QAChE,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC;QAC1B,IAAA,6BAAK,EACH,sCAAsC,EACtC,KAAK,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CACjE,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,GAAG,CACP,QAAgB,EAChB,SAAgC;QAEhC,MAAM,QAAQ,GAEV,EAAE,CAAC;QAEP,KAAK,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,SAAS,EAAE,CAAC;YACxD,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE;oBACJ,KAAK;oBACL,KAAK;oBACL,EAAE;oBACF,SAAS;iBACV;aACF,CAAC,CAAC;QACL,CAAC;QAED,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAC7B,QAAQ,EACR,2BAAkB,CAAC,cAAc,EACjC,QAAQ,EACR,EAAE,MAAM,EAAE,IAAI,EAAE,CACjB,CAAC;IACJ,CAAC;CACF;AArCD,kDAqCC"}
+{"version":3,"file":"AssetHistoryService.js","sourceRoot":"","sources":["../../../../lib/modules/asset/AssetHistoryService.ts"],"names":[],"mappings":";;;AAAA,iEAA8C;AAG9C,sCAAoE;AACpE,sCAAwC;AASxC,MAAa,mBAAoB,SAAQ,oBAAW;IAElD,YAAY,MAA2B,EAAE,WAAyB;QAChE,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC;QAC1B,IAAA,6BAAK,EACH,sCAAsC,EACtC,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,CAAC,CAC3D,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,GAAG,CACP,KAAa,EACb,SAAgC;QAEhC,MAAM,QAAQ,GAEV,EAAE,CAAC;QAEP,KAAK,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,SAAS,EAAE,CAAC;YACxD,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE;oBACJ,KAAK;oBACL,KAAK;oBACL,EAAE;oBACF,SAAS;iBACV;aACF,CAAC,CAAC;QACL,CAAC;QAED,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAC7B,KAAK,EACL,2BAAkB,CAAC,cAAc,EACjC,QAAQ,EACR,EAAE,MAAM,EAAE,IAAI,EAAE,CACjB,CAAC;IACJ,CAAC;CACF;AArCD,kDAqCC"}

package/dist/lib/modules/asset/AssetService.d.ts

@@ -11,35 +11,35 @@ export declare class AssetService extends DigitalTwinService {
     readonly logger: KuzzleLogger;
     constructor(plugin: DeviceManagerPlugin, assetHistoryService: AssetHistoryService, assetLogger: KuzzleLogger);
     registerAskEvents(): void;
-    get(engineId: string, assetId: string, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
+    get(index: string, assetId: string, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
     /**
      * Update an asset metadata
      */
-    update(engineId: string, assetId: string, metadata: Metadata, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
+    update(index: string, assetId: string, metadata: Metadata, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
     /**
      * Replace an asset metadata
      */
-    replaceMetadata(engineId: string, assetId: string, metadata: Metadata, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
+    replaceMetadata(index: string, assetId: string, metadata: Metadata, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
     /**
      * Update or Create an asset metadata
      */
-    upsert(engineId: string, model: string, reference: string, metadata: Metadata, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
+    upsert(index: string, model: string, reference: string, metadata: Metadata, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
     private _create;
     /**
      * Create an asset metadata
      */
-    create(engineId: string, model: string, reference: string, metadata: JSONObject, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
+    create(index: string, model: string, reference: string, metadata: JSONObject, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
     /**
      * Delete an asset metadata
      */
-    delete(engineId: string, assetId: string, request: KuzzleRequest): Promise<void>;
-    search(engineId: string, searchParams: SearchParams, request: KuzzleRequest): Promise<SearchResult<KHit<AssetContent>>>;
+    delete(index: string, assetId: string, request: KuzzleRequest): Promise<void>;
+    search(index: string, searchParams: SearchParams, request: KuzzleRequest): Promise<SearchResult<KHit<AssetContent>>>;
     unlinkDevices(assetId: string, allMeasures: boolean, deviceIds: string[], measureSlots: string[], request: KuzzleRequest): Promise<ApiAssetUnlinkDevicesResult>;
-    migrateTenant(user: User, assetsList: string[], engineId: string, newEngineId: string, includeDevices: boolean, request: KuzzleRequest): Promise<ApiAssetMigrateTenantResult>;
+    migrateTenant(user: User, assetsList: string[], index: string, newIndex: string, includeDevices: boolean, request: KuzzleRequest): Promise<ApiAssetMigrateTenantResult>;
     /**
      * Replace an asset metadata
      */
-    mReplaceAndHistorize(engineId: string, assets: KDocument<AssetContent>[], removedMetadata: string[], { refresh }: {
+    mReplaceAndHistorize(index: string, assets: KDocument<AssetContent>[], removedMetadata: string[], { refresh }: {
         refresh: any;
     }): Promise<mReplaceResponse>;
     /**
@@ -49,13 +49,13 @@ export declare class AssetService extends DigitalTwinService {
      * @param model
      */
     updateModelLocales(request: KuzzleRequest, model: string): Promise<ApiAssetUpdateModelLocales[]>;
-    addMeasureSlot(assetId: string, measureSlot: AssetContent["measureSlots"][0], engineId: string, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
-    removeMeasureSlot(assetId: string, measureSlotName: string, engineId: string, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
+    addMeasureSlot(assetId: string, measureSlot: AssetContent["measureSlots"][0], index: string, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
+    removeMeasureSlot(assetId: string, measureSlotName: string, index: string, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
     /**
      * Update the display name of a measure slot on an asset
      */
     updateMeasureSlotDisplayName(assetId: string, measureSlotName: string, displayName: {
         [locale: string]: string;
-    }, engineId: string, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
+    }, index: string, request: KuzzleRequest): Promise<KDocument<AssetContent>>;
     private refreshModel;
 }

package/dist/lib/modules/asset/AssetService.js

@@ -21,27 +21,27 @@ class AssetService extends shared_1.DigitalTwinService {
         super.registerAskEvents();
         (0, kuzzle_plugin_commons_1.onAsk)("ask:device-manager:asset:refresh-model", this.refreshModel.bind(this));
     }
-    async get(engineId, assetId, request) {
+    async get(index, assetId, request) {
         return this.getDocument(request, assetId, {
             collection: plugin_1.InternalCollection.ASSETS,
-            engineId,
+            index,
         });
     }
     /**
      * Update an asset metadata
      */
-    async update(engineId, assetId, metadata, request) {
-        return (0, shared_1.lock)(`asset:${engineId}:${assetId}`, async () => {
-            const asset = await this.get(engineId, assetId, request);
+    async update(index, assetId, metadata, request) {
+        return (0, shared_1.lock)(`asset:${index}:${assetId}`, async () => {
+            const asset = await this.get(index, assetId, request);
             const updatedPayload = await this.app.trigger("device-manager:asset:update:before", { asset, metadata });
             const updatedAsset = await this.updateDocument(request, {
                 _id: assetId,
                 _source: { metadata: updatedPayload.metadata },
             }, {
                 collection: plugin_1.InternalCollection.ASSETS,
-                engineId,
+                index,
             }, { source: true });
-            await this.assetHistoryService.add(engineId, [
+            await this.assetHistoryService.add(index, [
                 {
                     asset: updatedAsset._source,
                     event: {
@@ -64,9 +64,9 @@ class AssetService extends shared_1.DigitalTwinService {
     /**
      * Replace an asset metadata
      */
-    async replaceMetadata(engineId, assetId, metadata, request) {
-        return (0, shared_1.lock)(`asset:${engineId}:${assetId}`, async () => {
-            const asset = await this.get(engineId, assetId, request);
+    async replaceMetadata(index, assetId, metadata, request) {
+        return (0, shared_1.lock)(`asset:${index}:${assetId}`, async () => {
+            const asset = await this.get(index, assetId, request);
             const unknownMetadata = {};
             for (const key in metadata) {
                 if (key in asset._source.metadata) {
@@ -79,8 +79,8 @@ class AssetService extends shared_1.DigitalTwinService {
             // ? If metadata key is unknown on the asset we check that it exists in the assetModel mappings
             if (Object.keys(unknownMetadata).length > 0) {
                 const assetModel = await (0, kuzzle_plugin_commons_1.ask)("ask:device-manager:model:asset:get", {
-                    engineGroups: [engineId.split("-")[1]],
-                    engineId,
+                    tenantClasses: [index.split("-")[1]],
+                    index,
                     model: asset._source.model,
                 });
                 for (const key in unknownMetadata) {
@@ -90,8 +90,8 @@ class AssetService extends shared_1.DigitalTwinService {
                 }
             }
             const updatedPayload = await this.app.trigger("device-manager:asset:update:before", { asset, metadata });
-            const updatedAsset = await this.sdk.document.replace(engineId, plugin_1.InternalCollection.ASSETS, assetId, updatedPayload.asset._source, { triggerEvents: true });
-            await this.assetHistoryService.add(engineId, [
+            const updatedAsset = await this.sdk.document.replace(index, plugin_1.InternalCollection.ASSETS, assetId, updatedPayload.asset._source, { triggerEvents: true });
+            await this.assetHistoryService.add(index, [
                 {
                     asset: updatedAsset._source,
                     event: {
@@ -114,12 +114,12 @@ class AssetService extends shared_1.DigitalTwinService {
     /**
      * Update or Create an asset metadata
      */
-    async upsert(engineId, model, reference, metadata, request) {
+    async upsert(index, model, reference, metadata, request) {
         const assetId = AssetSerializer_1.AssetSerializer.id(model, reference);
-        return (0, shared_1.lock)(`asset:${engineId}:${assetId}`, async () => {
-            const asset = await this.get(engineId, assetId, request).catch(() => null);
+        return (0, shared_1.lock)(`asset:${index}:${assetId}`, async () => {
+            const asset = await this.get(index, assetId, request).catch(() => null);
             if (!asset) {
-                return this._create(assetId, engineId, model, reference, metadata, request);
+                return this._create(assetId, index, model, reference, metadata, request);
             }
             const updatedPayload = await this.app.trigger("device-manager:asset:update:before", { asset, metadata });
             const updatedAsset = await this.updateDocument(request, {
@@ -127,9 +127,9 @@ class AssetService extends shared_1.DigitalTwinService {
                 _source: { metadata: updatedPayload.metadata },
             }, {
                 collection: plugin_1.InternalCollection.ASSETS,
-                engineId,
+                index,
             }, { source: true });
-            await this.assetHistoryService.add(engineId, [
+            await this.assetHistoryService.add(index, [
                 {
                     asset: updatedAsset._source,
                     event: {
@@ -149,11 +149,11 @@ class AssetService extends shared_1.DigitalTwinService {
             return updatedAsset;
         });
     }
-    async _create(assetId, engineId, model, reference, metadata, request) {
-        const engine = await this.getEngine(engineId);
+    async _create(assetId, index, model, reference, metadata, request) {
+        const engine = await this.getEngine(index);
         const assetModel = await (0, kuzzle_plugin_commons_1.ask)("ask:device-manager:model:asset:get", {
-            engineGroups: [engine.group],
-            engineId,
+            tenantClasses: [engine.group],
+            index,
             model,
         });
         const assetMetadata = {};
@@ -176,9 +176,9 @@ class AssetService extends shared_1.DigitalTwinService {
             },
         }, {
             collection: plugin_1.InternalCollection.ASSETS,
-            engineId,
+            index,
         });
-        await this.assetHistoryService.add(engineId, [
+        await this.assetHistoryService.add(index, [
             {
                 asset: asset._source,
                 event: {
@@ -196,17 +196,17 @@ class AssetService extends shared_1.DigitalTwinService {
     /**
      * Create an asset metadata
      */
-    async create(engineId, model, reference, metadata, request) {
+    async create(index, model, reference, metadata, request) {
         const assetId = AssetSerializer_1.AssetSerializer.id(model, reference);
-        return (0, shared_1.lock)(`asset:${engineId}:${assetId}`, async () => this._create(assetId, engineId, model, reference, metadata, request));
+        return (0, shared_1.lock)(`asset:${index}:${assetId}`, async () => this._create(assetId, index, model, reference, metadata, request));
     }
     /**
      * Delete an asset metadata
      */
-    async delete(engineId, assetId, request) {
+    async delete(index, assetId, request) {
         const strict = request.getBoolean("strict");
-        return (0, shared_1.lock)(`asset:${engineId}:${assetId}`, async () => {
-            const asset = await this.get(engineId, assetId, request);
+        return (0, shared_1.lock)(`asset:${index}:${assetId}`, async () => {
+            const asset = await this.get(index, assetId, request);
             if (strict && asset._source.linkedMeasures.length !== 0) {
                 throw new kuzzle_1.BadRequestError(`Asset "${assetId}" is still linked to devices.`);
             }
@@ -215,19 +215,19 @@ class AssetService extends shared_1.DigitalTwinService {
             }
             await this.deleteDocument(request, assetId, {
                 collection: plugin_1.InternalCollection.ASSETS,
-                engineId,
+                index,
             });
         });
     }
-    async search(engineId, searchParams, request) {
+    async search(index, searchParams, request) {
         return this.searchDocument(request, searchParams, {
             collection: plugin_1.InternalCollection.ASSETS,
-            engineId,
+            index,
         });
     }
     async unlinkDevices(assetId, allMeasures, deviceIds, measureSlots, request) {
-        const engineId = request.getString("engineId");
-        let asset = await this.get(engineId, assetId, request);
+        const index = request.getIndex();
+        let asset = await this.get(index, assetId, request);
         const devices = [];
         // CASE ALL MEASURES TO UNLINK
         if (allMeasures) {
@@ -257,26 +257,26 @@ class AssetService extends shared_1.DigitalTwinService {
         }
         return { asset, devices };
     }
-    async migrateTenant(user, assetsList, engineId, newEngineId, includeDevices, request) {
+    async migrateTenant(user, assetsList, index, newIndex, includeDevices, request) {
         let errors = [];
         let successes = [];
         //Sanity check
         if (assetsList.length === 0) {
             throw new kuzzle_1.BadRequestError("No assets to migrate");
         }
-        await (0, shared_1.lock)(`engine:${engineId}:${newEngineId}`, async () => {
+        await (0, shared_1.lock)(`engine:${index}:${newIndex}`, async () => {
             if (!user.profileIds.includes("admin")) {
                 throw new kuzzle_1.BadRequestError(`User ${user._id} is not authorized to migrate assets`);
             }
-            // check if tenant destination is in the same group
-            const engine = await this.getEngine(engineId);
-            const newEngine = await this.getEngine(newEngineId);
+            // check if tenant destination is of the same tenant class
+            const engine = await this.getEngine(index);
+            const newEngine = await this.getEngine(newIndex);
             if (engine.group !== newEngine.group) {
-                throw new kuzzle_1.BadRequestError(`Engine ${newEngineId} is not in the same group as ${engineId}`);
+                throw new kuzzle_1.BadRequestError(`Engine ${newIndex} is not of the same tenant class as ${index}`);
             }
             //First of all, as mCreate seems to be buggy, ensure some assets don't
             //already exists in the destination tenant
-            const assetsCheck = await this.sdk.document.mGet(newEngineId, plugin_1.InternalCollection.ASSETS, assetsList);
+            const assetsCheck = await this.sdk.document.mGet(newIndex, plugin_1.InternalCollection.ASSETS, assetsList);
             const assetsCheckedIdExisting = assetsCheck.successes.map((a) => a._id);
             errors = [...assetsCheckedIdExisting];
             //Get all assets to migrate
@@ -284,7 +284,7 @@ class AssetService extends shared_1.DigitalTwinService {
             if (assetsCheckedList.length === 0) {
                 throw new kuzzle_1.BadRequestError("All assets to migrate already exists in destination tenant.");
             }
-            const assets = await this.sdk.document.mGet(engineId, plugin_1.InternalCollection.ASSETS, assetsCheckedList);
+            const assets = await this.sdk.document.mGet(index, plugin_1.InternalCollection.ASSETS, assetsCheckedList);
             errors = errors.concat(...assets.errors);
             if (assets.successes.length === 0) {
                 this.logger.error("No assets found to migrate");
@@ -303,7 +303,7 @@ class AssetService extends shared_1.DigitalTwinService {
             }
             //Even if they exist in the destination tenant, try creating them all
             //using batch
-            const assetsCreated = await this.sdk.document.mCreate(newEngineId, plugin_1.InternalCollection.ASSETS, assetsContentCopy);
+            const assetsCreated = await this.sdk.document.mCreate(newIndex, plugin_1.InternalCollection.ASSETS, assetsContentCopy);
             //We consider here we will return as success what we have been able
             //to create, and related errors
             const assetsCreatedId = assetsCreated.successes.map((a) => a._id);
@@ -328,11 +328,11 @@ class AssetService extends shared_1.DigitalTwinService {
                         // ... and attach to new tenant
                         await (0, kuzzle_plugin_commons_1.ask)("ask:device-manager:device:attach-engine", {
                             deviceId: link.deviceId,
-                            engineId: newEngineId,
+                            index: newIndex,
                             user,
                         });
                         // ... and link this device to the asset in the new tenant
-                        await this.linkAssetDevice(newEngineId, link.deviceId, asset._id, link.measureSlots, false, request);
+                        await this.linkAssetDevice(newIndex, link.deviceId, asset._id, link.measureSlots, false, request);
                     }
                     else {
                         await this.unlinkAssetDevice(link.deviceId, asset._id, link.measureSlots, false, request);
@@ -340,31 +340,31 @@ class AssetService extends shared_1.DigitalTwinService {
                 }
             }
             // Finally here, we can delete the successefully migrated assets from the source engine !
-            await this.sdk.document.mDelete(engineId, plugin_1.InternalCollection.ASSETS, assetsCreatedId);
+            await this.sdk.document.mDelete(index, plugin_1.InternalCollection.ASSETS, assetsCreatedId);
             //Refresh ES indexes and collections
             const collectionsToRefresh = [
                 {
                     collection: plugin_1.InternalCollection.ASSETS,
-                    index: engineId,
+                    index: index,
                 },
                 {
                     collection: plugin_1.InternalCollection.DEVICES,
-                    index: engineId,
+                    index: index,
                 },
                 {
                     collection: plugin_1.InternalCollection.ASSETS,
-                    index: newEngineId,
+                    index: newIndex,
                 },
                 {
                     collection: plugin_1.InternalCollection.DEVICES,
-                    index: newEngineId,
+                    index: newIndex,
                 },
                 {
                     collection: plugin_1.InternalCollection.DEVICES,
                     index: this.config.platformIndex,
                 },
-            ].map(({ index, collection }) => {
-                return this.sdk.collection.refresh(index, collection);
+            ].map((target) => {
+                return this.sdk.collection.refresh(target.index, target.collection);
             });
             await Promise.all(collectionsToRefresh);
         });
@@ -373,8 +373,8 @@ class AssetService extends shared_1.DigitalTwinService {
     /**
      * Replace an asset metadata
      */
-    async mReplaceAndHistorize(engineId, assets, removedMetadata, { refresh }) {
-        const replacedAssets = await this.sdk.document.mReplace(engineId, plugin_1.InternalCollection.ASSETS, assets.map((asset) => ({ _id: asset._id, body: asset._source })), { refresh, source: true });
+    async mReplaceAndHistorize(index, assets, removedMetadata, { refresh }) {
+        const replacedAssets = await this.sdk.document.mReplace(index, plugin_1.InternalCollection.ASSETS, assets.map((asset) => ({ _id: asset._id, body: asset._source })), { refresh, source: true });
         const histories = replacedAssets.successes.map((asset) => ({
             asset: asset._source,
             event: {
@@ -386,7 +386,7 @@ class AssetService extends shared_1.DigitalTwinService {
             id: asset._id,
             timestamp: Date.now(),
         }));
-        await this.assetHistoryService.add(engineId, histories);
+        await this.assetHistoryService.add(index, histories);
         return replacedAssets;
     }
     /**
@@ -444,15 +444,15 @@ class AssetService extends shared_1.DigitalTwinService {
         }
         return results;
     }
-    async addMeasureSlot(assetId, measureSlot, engineId, request) {
-        const asset = await this.get(engineId, assetId, request);
+    async addMeasureSlot(assetId, measureSlot, index, request) {
+        const asset = await this.get(index, assetId, request);
         if (asset._source.measureSlots.some((slot) => slot.name === measureSlot.name)) {
             throw new kuzzle_1.BadRequestError(`A measure slot with ${measureSlot.name} as a name already exists for ${assetId}`);
         }
         try {
             await (0, kuzzle_plugin_commons_1.ask)("ask:device-manager:model:measure:get", {
                 type: measureSlot.type,
-                engineId,
+                index,
             });
         }
         catch {
@@ -461,12 +461,12 @@ class AssetService extends shared_1.DigitalTwinService {
         asset._source.measureSlots.push(measureSlot);
         const updatedAsset = await this.updateDocument(request, asset, {
             collection: plugin_1.InternalCollection.ASSETS,
-            engineId,
+            index,
         });
         return updatedAsset;
     }
-    async removeMeasureSlot(assetId, measureSlotName, engineId, request) {
-        const asset = await this.get(engineId, assetId, request);
+    async removeMeasureSlot(assetId, measureSlotName, index, request) {
+        const asset = await this.get(index, assetId, request);
         if (!asset._source.measureSlots.some((slot) => slot.name === measureSlotName)) {
             throw new kuzzle_1.BadRequestError(`Asset ${assetId} does not have a measure slot named ${measureSlotName}`);
         }
@@ -474,8 +474,8 @@ class AssetService extends shared_1.DigitalTwinService {
         if (linkedDevice) {
             throw new kuzzle_1.BadRequestError(`Measure slot ${measureSlotName} can not be removed as it is currently linked to ${linkedDevice.deviceId}`);
         }
-        const engine = await this.getEngine(engineId);
-        const assetModel = await this.getAssetModel(engine.group, asset._source.model, engineId);
+        const engine = await this.getEngine(index);
+        const assetModel = await this.getAssetModel(engine.group, asset._source.model, index);
         if (!assetModel) {
             throw new kuzzle_1.NotFoundError(`Model ${asset._source.model} not found`);
         }
@@ -485,15 +485,15 @@ class AssetService extends shared_1.DigitalTwinService {
         asset._source.measureSlots = asset._source.measureSlots.filter((slot) => slot.name !== measureSlotName);
         const updatedAsset = await this.updateDocument(request, asset, {
             collection: plugin_1.InternalCollection.ASSETS,
-            engineId,
+            index,
         });
         return updatedAsset;
     }
     /**
      * Update the display name of a measure slot on an asset
      */
-    async updateMeasureSlotDisplayName(assetId, measureSlotName, displayName, engineId, request) {
-        const asset = await this.get(engineId, assetId, request);
+    async updateMeasureSlotDisplayName(assetId, measureSlotName, displayName, index, request) {
+        const asset = await this.get(index, assetId, request);
         const slot = asset._source.measureSlots.find((s) => s.name === measureSlotName);
         if (!slot) {
             throw new kuzzle_1.BadRequestError(`Asset ${assetId} does not have a measure slot named ${measureSlotName}`);
@@ -501,16 +501,16 @@ class AssetService extends shared_1.DigitalTwinService {
         slot.displayName = displayName;
         const updatedAsset = await this.updateDocument(request, asset, {
             collection: plugin_1.InternalCollection.ASSETS,
-            engineId,
+            index,
         });
         return updatedAsset;
     }
     async refreshModel({ assetModel, }) {
-        // For engine group 'commons', fetch all engines
+        // For tenant class 'commons', fetch all engines
         const engines = await (0, kuzzle_plugin_commons_1.ask)("ask:device-manager:engine:list", {
-            group: assetModel.engineGroups?.includes("commons")
+            tenantClass: assetModel.tenantClasses?.includes("commons")
                 ? null
-                : assetModel.engineGroups?.[0],
+                : assetModel.tenantClasses?.[0],
         });
         const targets = engines.map((engine) => ({
             collections: [plugin_1.InternalCollection.ASSETS],