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

package/dist/lib/modules/model/ModelsRegister.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ModelsRegister = void 0;
 const kuzzle_1 = require("kuzzle");
@@ -8,12 +11,16 @@ const AJValidator_1 = require("../shared/utils/AJValidator");
 const SchemaValidationError_1 = require("../shared/errors/SchemaValidationError");
 const MeasuresDuplicates_1 = require("./MeasuresDuplicates");
 const MeasuresNamesDuplicatesError_1 = require("./MeasuresNamesDuplicatesError");
+const MetadataReferential_1 = require("./MetadataReferential");
+const kuzzle_plugin_commons_1 = require("kuzzle-plugin-commons");
+const lodash_1 = __importDefault(require("lodash"));
 class ModelsRegister {
     constructor() {
         this.assetModels = [];
         this.deviceModels = [];
         this.groupModels = [];
         this.measureModels = [];
+        this.metadataReferential = {};
     }
     get sdk() {
         return this.context.accessors.sdk;
@@ -24,18 +31,109 @@ class ModelsRegister {
         this.logger = this.context.logger.child("models-module:register");
     }
     async loadModels() {
+        const referential = await this.loadMetadataReferential();
         await Promise.all([
-            this.load("asset", this.assetModels),
-            this.load("device", this.deviceModels),
-            this.load("group", this.groupModels),
+            this.load("asset", this.resolveModels(referential, this.assetModels)),
+            this.load("device", this.resolveModels(referential, this.deviceModels)),
+            this.load("group", this.resolveModels(referential, this.groupModels)),
             this.load("measure", this.measureModels),
         ]);
         await this.sdk.collection.refresh(this.config.platformIndex, plugin_1.InternalCollection.MODELS);
     }
+    /**
+     * Merges the metadata registered from code over the stored metadata referential and saves it.
+     * Metadata added through the API are kept, the details of metadata registered from code win.
+     *
+     * @throws PluginImplementationError if the mappings of a stored metadata are modified, or if a new
+     *  metadata conflicts with the stored models or the engines collections mappings
+     */
+    async loadMetadataReferential() {
+        const stored = await (0, MetadataReferential_1.fetchMetadataReferential)(this.sdk, this.config.platformIndex);
+        const added = Object.keys(this.metadataReferential).filter((name) => !stored[name]);
+        for (const [name, entry] of Object.entries(this.metadataReferential)) {
+            if (stored[name] && !lodash_1.default.isEqual(stored[name].mappings, entry.mappings)) {
+                throw new kuzzle_1.PluginImplementationError(`The mappings of metadata "${name}" cannot be modified, they are already merged into the engines collections`);
+            }
+        }
+        await this.checkNewMetadata(added);
+        // ? Only the metadata still registered from code are managed, the others become editable through the API
+        const referential = {
+            ...lodash_1.default.mapValues(stored, (entry) => lodash_1.default.omit(entry, "managed")),
+            ...lodash_1.default.mapValues(this.metadataReferential, (entry) => ({
+                ...entry,
+                managed: true,
+            })),
+        };
+        if (!lodash_1.default.isEqual(stored, referential)) {
+            await (0, MetadataReferential_1.saveMetadataReferential)(this.sdk, this.config.platformIndex, referential);
+        }
+        this.logger.info(`Successfully load metadata referential: ${Object.keys(referential).join(", ")}`);
+        return referential;
+    }
+    /**
+     * Checks the metadata registered from code that are not in the stored referential yet
+     * against the inline metadata of the stored models and the engines collections mappings
+     *
+     * @throws PluginImplementationError on a conflict
+     */
+    async checkNewMetadata(names) {
+        if (names.length === 0) {
+            return;
+        }
+        const models = (await (0, MetadataReferential_1.fetchMetadataModels)(this.sdk, this.config.platformIndex)).map(({ _source }) => _source);
+        const conflicts = [];
+        for (const name of names) {
+            conflicts.push(...(0, MetadataReferential_1.getEntryModelsConflicts)(name, this.metadataReferential[name], models));
+        }
+        conflicts.push(...(await (0, kuzzle_plugin_commons_1.ask)("ask:device-manager:engine:doesMetadataConflict", {
+            metadataMappings: lodash_1.default.mapValues(lodash_1.default.pick(this.metadataReferential, names), (entry) => entry.mappings),
+        })));
+        if (conflicts.length > 0) {
+            throw new kuzzle_1.PluginImplementationError(`Metadata registered from code conflict with the existing mappings: ${JSON.stringify(conflicts)}`);
+        }
+    }
+    /**
+     * Validates the metadata of models registered from code against the metadata referential
+     * and enriches the details and default values of the metadata coming from it
+     */
+    resolveModels(referential, models) {
+        return models.map((content) => {
+            const twin = content[content.type];
+            const { fields, warnings } = (0, MetadataReferential_1.enrichModelMetadata)(referential, twin, {
+                createError: (message) => new kuzzle_1.PluginImplementationError(message),
+                model: twin.model,
+                modelType: content.type,
+            });
+            // ? Only logged, rejecting would prevent the application from starting
+            for (const warning of warnings) {
+                this.logger.warn(warning);
+            }
+            return { ...content, [content.type]: { ...twin, ...fields } };
+        });
+    }
+    /**
+     * Registers a metadata in the metadata referential.
+     * Asset, device and group models can then use it with `{ referential: true }` in their metadataMappings.
+     * Its mappings cannot be modified once loaded, they are merged into the engines collections.
+     * Registering again an identical definition is allowed, so several modules can share a metadata.
+     *
+     * @param name - Name of the metadata
+     * @param definition - Mappings, default translations, editor hint, default value and icon of the metadata
+     * @throws PluginImplementationError if the metadata is invalid or already registered with another definition
+     */
+    registerMetadata(name, definition) {
+        (0, MetadataReferential_1.checkMetadataReferentialEntry)(name, definition, (message) => new kuzzle_1.PluginImplementationError(message));
+        const entry = { locales: {}, ...lodash_1.default.omit(definition, "managed") };
+        const registered = this.metadataReferential[name];
+        if (registered && !lodash_1.default.isEqual(registered, entry)) {
+            throw new kuzzle_1.PluginImplementationError(`Metadata "${name}" is already registered in the metadata referential with another definition`);
+        }
+        this.metadataReferential[name] = entry;
+    }
     /**
      * Registers an asset model.
      *
-     * @param engineGroups - The engine group names.
+     * @param tenantClasses - The tenant class names.
      * @param model - The name of the asset model, which must be in PascalCase.
      * @param measures - The measures associated with this asset model.
      * @param metadataMappings - The metadata mappings for the model, defaults to an empty object.
@@ -46,7 +144,7 @@ class ModelsRegister {
      * @param icon - Optional icon representing the model.
      * @throws PluginImplementationError if the model name is not in PascalCase.
      */
-    registerAsset(engineGroups, model, measures, metadataMappings = {}, defaultMetadata = {}, metadataDetails = {}, metadataGroups = {}, tooltipModels = {}, locales = {}, icon) {
+    registerAsset(tenantClasses, model, measures, metadataMappings = {}, defaultMetadata = {}, metadataDetails = {}, metadataGroups = {}, tooltipModels = {}, locales = {}, icon) {
         if (kuzzle_1.Inflector.pascalCase(model) !== model) {
             throw new kuzzle_1.PluginImplementationError(`Asset model "${model}" must be PascalCase`);
         }
@@ -67,7 +165,7 @@ class ModelsRegister {
                 model,
                 tooltipModels,
             },
-            engineGroups,
+            tenantClasses,
             type: "asset",
         });
     }
@@ -109,7 +207,7 @@ class ModelsRegister {
      * Registers a group model.
      *
      *
-     * @param engineGroups - The engine group names.
+     * @param tenantClasses - The tenant class names.
      * @param model - The name of the group model, which must be in PascalCase.
      * @param affinity - The type of object accepted and their model affinity.
      * @param metadataMappings - The metadata mappings for the model, defaults to an empty object.
@@ -120,13 +218,13 @@ class ModelsRegister {
      * @param locales - Optional translations specific to the model.
      * @throws PluginImplementationError if the model name is not in PascalCase.
      */
-    registerGroup(engineGroups, model, affinity, metadataMappings = {}, defaultMetadata = {}, metadataDetails = {}, metadataGroups = {}, icon, locales = {}) {
+    registerGroup(tenantClasses, model, affinity, metadataMappings = {}, defaultMetadata = {}, metadataDetails = {}, metadataGroups = {}, icon, locales = {}) {
         if (kuzzle_1.Inflector.pascalCase(model) !== model) {
             throw new kuzzle_1.PluginImplementationError(`Group model "${model}" must be PascalCase`);
         }
         // Construct and push the new group model to the groupModels array
         this.groupModels.push({
-            engineGroups,
+            tenantClasses,
             group: {
                 affinity,
                 defaultMetadata,

package/dist/lib/modules/model/ModelsRegister.js.map

@@ -1 +1 @@
-{"version":3,"file":"ModelsRegister.js","sourceRoot":"","sources":["../../../../lib/modules/model/ModelsRegister.ts"],"names":[],"mappings":";;;AAAA,mCAA6E;AAE7E,sCAImB;AAiBnB,uDAAoD;AAEpD,6DAA6E;AAC7E,kFAA+E;AAC/E,6DAAkE;AAClE,iFAA8E;AAE9E,MAAa,cAAc;IAA3B;QAGU,gBAAW,GAAwB,EAAE,CAAC;QACtC,iBAAY,GAAyB,EAAE,CAAC;QACxC,gBAAW,GAAwB,EAAE,CAAC;QACtC,kBAAa,GAA0B,EAAE,CAAC;IA4OpD,CAAC;IAzOC,IAAY,GAAG;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC;IACpC,CAAC;IAED,IAAI,CAAC,MAA2B;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAa,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;IACpE,CAAC;IAED,KAAK,CAAC,UAAU;QACd,MAAM,OAAO,CAAC,GAAG,CAAC;YAChB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC;YACpC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC;YACtC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC;YACpC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC;SACzC,CAAC,CAAC;QAEH,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,CAC/B,IAAI,CAAC,MAAM,CAAC,aAAa,EACzB,2BAAkB,CAAC,MAAM,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,YAAsB,EACtB,KAAa,EACb,QAAuB,EACvB,mBAAqC,EAAE,EACvC,kBAA8B,EAAE,EAChC,kBAAmC,EAAE,EACrC,iBAAiC,EAAE,EACnC,gBAA+B,EAAE,EACjC,UAAkD,EAAE,EACpD,IAAa;QAEb,IAAI,kBAAS,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,KAAK,EAAE,CAAC;YAC1C,MAAM,IAAI,kCAAyB,CACjC,gBAAgB,KAAK,sBAAsB,CAC5C,CAAC;QACJ,CAAC;QAED,MAAM,UAAU,GAAG,IAAA,+CAA0B,EAAC,QAAQ,CAAC,CAAC;QAExD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,2DAA4B,CACpC,qEAAqE,EACrE,UAAU,CACX,CAAC;QACJ,CAAC;QAED,kEAAkE;QAClE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;YACpB,KAAK,EAAE;gBACL,eAAe;gBACf,IAAI;gBACJ,OAAO;gBACP,QAAQ;gBACR,eAAe;gBACf,cAAc;gBACd,gBAAgB;gBAChB,KAAK;gBACL,aAAa;aACd;YACD,YAAY;YACZ,IAAI,EAAE,OAAO;SACd,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,KAAa,EACb,QAAuB,EACvB,mBAAqC,EAAE,EACvC,kBAA8B,EAAE,EAChC,kBAAmC,EAAE,EACrC,iBAAiC,EAAE,EACnC,IAAa;QAEb,IAAI,kBAAS,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,KAAK,EAAE,CAAC;YAC1C,MAAM,IAAI,kCAAyB,CACjC,iBAAiB,KAAK,sBAAsB,CAC7C,CAAC;QACJ,CAAC;QAED,MAAM,UAAU,GAAG,IAAA,+CAA0B,EAAC,QAAQ,CAAC,CAAC;QAExD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,2DAA4B,CACpC,sEAAsE,EACtE,UAAU,CACX,CAAC;QACJ,CAAC;QAED,oEAAoE;QACpE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;YACrB,MAAM,EAAE;gBACN,eAAe;gBACf,IAAI;gBACJ,QAAQ;gBACR,eAAe;gBACf,cAAc;gBACd,gBAAgB;gBAChB,KAAK;aACN;YACD,IAAI,EAAE,QAAQ;SACf,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,aAAa,CACX,YAAsB,EACtB,KAAa,EACb,QAAuB,EACvB,mBAAqC,EAAE,EACvC,kBAA8B,EAAE,EAChC,kBAAmC,EAAE,EACrC,iBAAiC,EAAE,EACnC,IAAa,EACb,UAAkD,EAAE;QAEpD,IAAI,kBAAS,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,KAAK,EAAE,CAAC;YAC1C,MAAM,IAAI,kCAAyB,CACjC,gBAAgB,KAAK,sBAAsB,CAC5C,CAAC;QACJ,CAAC;QAED,kEAAkE;QAClE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;YACpB,YAAY;YACZ,KAAK,EAAE;gBACL,QAAQ;gBACR,eAAe;gBACf,IAAI;gBACJ,OAAO;gBACP,eAAe;gBACf,cAAc;gBACd,gBAAgB;gBAChB,KAAK;aACN;YACD,IAAI,EAAE,OAAO;SACd,CAAC,CAAC;IACL,CAAC;IAED,eAAe,CAAC,IAAY,EAAE,iBAAoC;QAChE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,aAAa,EAAE,GACtE,iBAAiB,CAAC;QACpB,IAAI,gBAAgB,EAAE,CAAC;YACrB,IAAI,CAAC;gBACH,IAAA,8BAAgB,EAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;YAC3C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,IAAI,6CAAqB,CAC7B,8BAA8B,EAC9B,IAAA,0BAAY,GAAE,CACf,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;YACtB,OAAO,EAAE;gBACP,IAAI;gBACJ,OAAO;gBACP,IAAI;gBACJ,gBAAgB;gBAChB,aAAa;gBACb,cAAc;aACf;YACD,IAAI,EAAE,SAAS;SAChB,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,IAAI,CAAC,IAAY,EAAE,MAAsB;QACrD,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YACrC,OAAO;gBACL,GAAG,EAAE,iCAAe,CAAC,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC;gBACpC,IAAI,EAAE,KAAK;aACZ,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACvC,iCAAe,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CACnC,CAAC;QAEF,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,gBAAgB,CACtC,IAAI,CAAC,MAAM,CAAC,aAAa,EACzB,2BAAkB,CAAC,MAAM,EACzB,SAAgB,EAChB,EAAE,MAAM,EAAE,IAAI,EAAE,CACjB,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,sBAAsB,IAAI,aAAa,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAChE,CAAC;IACJ,CAAC;CACF;AAlPD,wCAkPC"}
+{"version":3,"file":"ModelsRegister.js","sourceRoot":"","sources":["../../../../lib/modules/model/ModelsRegister.ts"],"names":[],"mappings":";;;;;;AAAA,mCAA6E;AAE7E,sCAImB;AAmBnB,uDAAoD;AAEpD,6DAA6E;AAC7E,kFAA+E;AAC/E,6DAAkE;AAClE,iFAA8E;AAE9E,+DAQ+B;AAC/B,iEAA4C;AAG5C,oDAAuB;AAEvB,MAAa,cAAc;IAA3B;QAGU,gBAAW,GAAwB,EAAE,CAAC;QACtC,iBAAY,GAAyB,EAAE,CAAC;QACxC,gBAAW,GAAwB,EAAE,CAAC;QACtC,kBAAa,GAA0B,EAAE,CAAC;QAC1C,wBAAmB,GAAwB,EAAE,CAAC;IAoYxD,CAAC;IAjYC,IAAY,GAAG;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC;IACpC,CAAC;IAED,IAAI,CAAC,MAA2B;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAa,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;IACpE,CAAC;IAED,KAAK,CAAC,UAAU;QACd,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAEzD,MAAM,OAAO,CAAC,GAAG,CAAC;YAChB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACrE,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;YACvE,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACrE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC;SACzC,CAAC,CAAC;QAEH,MAAM,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,CAC/B,IAAI,CAAC,MAAM,CAAC,aAAa,EACzB,2BAAkB,CAAC,MAAM,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,uBAAuB;QACnC,MAAM,MAAM,GAAG,MAAM,IAAA,8CAAwB,EAC3C,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,MAAM,CAAC,aAAa,CAC1B,CAAC;QAEF,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,MAAM,CACxD,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CACxB,CAAC;QAEF,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC;YACrE,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACtE,MAAM,IAAI,kCAAyB,CACjC,6BAA6B,IAAI,4EAA4E,CAC9G,CAAC;YACJ,CAAC;QACH,CAAC;QAED,MAAM,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAEnC,yGAAyG;QACzG,MAAM,WAAW,GAAwB;YACvC,GAAG,gBAAC,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,gBAAC,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;YAC3D,GAAG,gBAAC,CAAC,SAAS,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBACnD,GAAG,KAAK;gBACR,OAAO,EAAE,IAAI;aACd,CAAC,CAAC;SACJ,CAAC;QAEF,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,EAAE,CAAC;YACpC,MAAM,IAAA,6CAAuB,EAC3B,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,MAAM,CAAC,aAAa,EACzB,WAAW,CACZ,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,2CAA2C,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACjF,CAAC;QAEF,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,gBAAgB,CAAC,KAAe;QAC5C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,OAAO;QACT,CAAC;QAED,MAAM,MAAM,GAAG,CACb,MAAM,IAAA,yCAAmB,EAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAC/D,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC;QAChC,MAAM,SAAS,GAAoB,EAAE,CAAC;QAEtC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,SAAS,CAAC,IAAI,CACZ,GAAG,IAAA,6CAAuB,EACxB,IAAI,EACJ,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAC9B,MAAM,CACP,CACF,CAAC;QACJ,CAAC;QAED,SAAS,CAAC,IAAI,CACZ,GAAG,CAAC,MAAM,IAAA,2BAAG,EACX,gDAAgD,EAChD;YACE,gBAAgB,EAAE,gBAAC,CAAC,SAAS,CAC3B,gBAAC,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,CAAC,EACvC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAC1B;SACF,CACF,CAAC,CACH,CAAC;QAEF,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,kCAAyB,CACjC,sEAAsE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAClG,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,aAAa,CACnB,WAAgC,EAChC,MAAW;QAEX,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YAC5B,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACnC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,yCAAmB,EAAC,WAAW,EAAE,IAAI,EAAE;gBAClE,WAAW,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,kCAAyB,CAAC,OAAO,CAAC;gBAChE,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,SAAS,EAAE,OAAO,CAAC,IAAI;aACxB,CAAC,CAAC;YAEH,uEAAuE;YACvE,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;gBAC/B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC5B,CAAC;YAED,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC;QAChE,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,gBAAgB,CAAC,IAAY,EAAE,UAAoC;QACjE,IAAA,mDAA6B,EAC3B,IAAI,EACJ,UAAU,EACV,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,kCAAyB,CAAC,OAAO,CAAC,CACpD,CAAC;QAEF,MAAM,KAAK,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,GAAG,gBAAC,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,CAAC;QAChE,MAAM,UAAU,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAElD,IAAI,UAAU,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC;YAChD,MAAM,IAAI,kCAAyB,CACjC,aAAa,IAAI,6EAA6E,CAC/F,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;IACzC,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,aAAuB,EACvB,KAAa,EACb,QAAuB,EACvB,mBAAqC,EAAE,EACvC,kBAA8B,EAAE,EAChC,kBAAmC,EAAE,EACrC,iBAAiC,EAAE,EACnC,gBAA+B,EAAE,EACjC,UAAkD,EAAE,EACpD,IAAa;QAEb,IAAI,kBAAS,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,KAAK,EAAE,CAAC;YAC1C,MAAM,IAAI,kCAAyB,CACjC,gBAAgB,KAAK,sBAAsB,CAC5C,CAAC;QACJ,CAAC;QAED,MAAM,UAAU,GAAG,IAAA,+CAA0B,EAAC,QAAQ,CAAC,CAAC;QAExD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,2DAA4B,CACpC,qEAAqE,EACrE,UAAU,CACX,CAAC;QACJ,CAAC;QAED,kEAAkE;QAClE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;YACpB,KAAK,EAAE;gBACL,eAAe;gBACf,IAAI;gBACJ,OAAO;gBACP,QAAQ;gBACR,eAAe;gBACf,cAAc;gBACd,gBAAgB;gBAChB,KAAK;gBACL,aAAa;aACd;YACD,aAAa;YACb,IAAI,EAAE,OAAO;SACd,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,KAAa,EACb,QAAuB,EACvB,mBAAqC,EAAE,EACvC,kBAA8B,EAAE,EAChC,kBAAmC,EAAE,EACrC,iBAAiC,EAAE,EACnC,IAAa;QAEb,IAAI,kBAAS,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,KAAK,EAAE,CAAC;YAC1C,MAAM,IAAI,kCAAyB,CACjC,iBAAiB,KAAK,sBAAsB,CAC7C,CAAC;QACJ,CAAC;QAED,MAAM,UAAU,GAAG,IAAA,+CAA0B,EAAC,QAAQ,CAAC,CAAC;QAExD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,2DAA4B,CACpC,sEAAsE,EACtE,UAAU,CACX,CAAC;QACJ,CAAC;QAED,oEAAoE;QACpE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;YACrB,MAAM,EAAE;gBACN,eAAe;gBACf,IAAI;gBACJ,QAAQ;gBACR,eAAe;gBACf,cAAc;gBACd,gBAAgB;gBAChB,KAAK;aACN;YACD,IAAI,EAAE,QAAQ;SACf,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,aAAa,CACX,aAAuB,EACvB,KAAa,EACb,QAAuB,EACvB,mBAAqC,EAAE,EACvC,kBAA8B,EAAE,EAChC,kBAAmC,EAAE,EACrC,iBAAiC,EAAE,EACnC,IAAa,EACb,UAAkD,EAAE;QAEpD,IAAI,kBAAS,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,KAAK,EAAE,CAAC;YAC1C,MAAM,IAAI,kCAAyB,CACjC,gBAAgB,KAAK,sBAAsB,CAC5C,CAAC;QACJ,CAAC;QAED,kEAAkE;QAClE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;YACpB,aAAa;YACb,KAAK,EAAE;gBACL,QAAQ;gBACR,eAAe;gBACf,IAAI;gBACJ,OAAO;gBACP,eAAe;gBACf,cAAc;gBACd,gBAAgB;gBAChB,KAAK;aACN;YACD,IAAI,EAAE,OAAO;SACd,CAAC,CAAC;IACL,CAAC;IAED,eAAe,CAAC,IAAY,EAAE,iBAAoC;QAChE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,aAAa,EAAE,GACtE,iBAAiB,CAAC;QACpB,IAAI,gBAAgB,EAAE,CAAC;YACrB,IAAI,CAAC;gBACH,IAAA,8BAAgB,EAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;YAC3C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,IAAI,6CAAqB,CAC7B,8BAA8B,EAC9B,IAAA,0BAAY,GAAE,CACf,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;YACtB,OAAO,EAAE;gBACP,IAAI;gBACJ,OAAO;gBACP,IAAI;gBACJ,gBAAgB;gBAChB,aAAa;gBACb,cAAc;aACf;YACD,IAAI,EAAE,SAAS;SAChB,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,IAAI,CAAC,IAAY,EAAE,MAAsB;QACrD,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YACrC,OAAO;gBACL,GAAG,EAAE,iCAAe,CAAC,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC;gBACpC,IAAI,EAAE,KAAK;aACZ,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACvC,iCAAe,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CACnC,CAAC;QAEF,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,gBAAgB,CACtC,IAAI,CAAC,MAAM,CAAC,aAAa,EACzB,2BAAkB,CAAC,MAAM,EACzB,SAAgB,EAChB,EAAE,MAAM,EAAE,IAAI,EAAE,CACjB,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,sBAAsB,IAAI,aAAa,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAChE,CAAC;IACJ,CAAC;CACF;AA3YD,wCA2YC"}

package/dist/lib/modules/model/collections/modelsMappings.js

@@ -9,8 +9,22 @@ exports.modelsMappings = {
     dynamic: "strict",
     properties: {
         type: { type: "keyword" },
-        engineGroups: { type: "keyword" },
+        tenantClasses: { type: "keyword" },
+        indexes: { type: "keyword" },
+        /**
+         * @deprecated Former name of `indexes`. Kept in the mapping so the documents
+         * written before the rename stay valid under the strict mapping; their
+         * values are moved to `indexes` at startup (see
+         * `DeviceManagerPlugin.migrateModelIndexes`), after which nothing writes it.
+         */
         engineIds: { type: "keyword" },
+        /**
+         * Metadata referential
+         */
+        metadata: {
+            dynamic: "false",
+            properties: {},
+        },
         /**
          * Measure model
          */

package/dist/lib/modules/model/collections/modelsMappings.js.map

@@ -1 +1 @@
-{"version":3,"file":"modelsMappings.js","sourceRoot":"","sources":["../../../../../lib/modules/model/collections/modelsMappings.ts"],"names":[],"mappings":";;;AAEA,8BAA8B;AAE9B;;GAEG;AACU,QAAA,cAAc,GAAuB;IAChD,OAAO,EAAE,QAAQ;IACjB,UAAU,EAAE;QACV,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QACzB,YAAY,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QACjC,SAAS,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAE9B;;WAEG;QACH,OAAO,EAAE;YACP,UAAU,EAAE;gBACV,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;gBACzB,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE;gBACpC,cAAc,EAAE;oBACd,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,gBAAgB,EAAE;oBAChB,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,aAAa,EAAE;oBACb,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,OAAO,EAAE;oBACP,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;aACF;SACF;QAED;;WAEG;QACH,KAAK,EAAE;YACL,UAAU,EAAE;gBACV,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;gBAC1B,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE;gBACpC,gBAAgB,EAAE;oBAChB,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,eAAe,EAAE;oBACf,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,eAAe,EAAE;oBACf,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,cAAc,EAAE;oBACd,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,QAAQ,EAAE;oBACR,UAAU,EAAE;wBACV,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;wBACzB,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;wBACzB,WAAW,EAAE;4BACX,OAAO,EAAE,OAAO;4BAChB,UAAU,EAAE,EAAE;yBACf;qBACF;iBACF;gBACD,aAAa,EAAE;oBACb,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,OAAO,EAAE;oBACP,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;aACF;SACF;QAED;;WAEG;QACH,MAAM,EAAE;YACN,UAAU,EAAE;gBACV,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;gBAC1B,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE;gBACpC,gBAAgB,EAAE;oBAChB,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,eAAe,EAAE;oBACf,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,eAAe,EAAE;oBACf,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,cAAc,EAAE;oBACd,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,QAAQ,EAAE;oBACR,UAAU,EAAE;wBACV,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;wBACzB,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;wBACzB,WAAW,EAAE;4BACX,OAAO,EAAE,OAAO;4BAChB,UAAU,EAAE,EAAE;yBACf;qBACF;iBACF;aACF;SACF;QAED;;WAEG;QACH,KAAK,EAAE;YACL,UAAU,EAAE;gBACV,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;gBAC1B,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE;gBACpC,QAAQ,EAAE;oBACR,UAAU,EAAE;wBACV,IAAI,EAAE;4BACJ,IAAI,EAAE,SAAS;yBAChB;wBACD,MAAM,EAAE;4BACN,UAAU,EAAE;gCACV,MAAM,EAAE;oCACN,IAAI,EAAE,SAAS;iCAChB;gCACD,OAAO,EAAE;oCACP,IAAI,EAAE,SAAS;iCAChB;6BACF;yBACF;wBACD,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;qBAC5B;iBACF;gBACD,gBAAgB,EAAE;oBAChB,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,eAAe,EAAE;oBACf,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,eAAe,EAAE;oBACf,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,cAAc,EAAE;oBACd,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,aAAa,EAAE;oBACb,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,OAAO,EAAE;oBACP,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;aACF;SACF;KACF;CACF,CAAC"}
+{"version":3,"file":"modelsMappings.js","sourceRoot":"","sources":["../../../../../lib/modules/model/collections/modelsMappings.ts"],"names":[],"mappings":";;;AAEA,8BAA8B;AAE9B;;GAEG;AACU,QAAA,cAAc,GAAuB;IAChD,OAAO,EAAE,QAAQ;IACjB,UAAU,EAAE;QACV,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QACzB,aAAa,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAClC,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAC5B;;;;;WAKG;QACH,SAAS,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAE9B;;WAEG;QACH,QAAQ,EAAE;YACR,OAAO,EAAE,OAAO;YAChB,UAAU,EAAE,EAAE;SACf;QAED;;WAEG;QACH,OAAO,EAAE;YACP,UAAU,EAAE;gBACV,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;gBACzB,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE;gBACpC,cAAc,EAAE;oBACd,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,gBAAgB,EAAE;oBAChB,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,aAAa,EAAE;oBACb,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,OAAO,EAAE;oBACP,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;aACF;SACF;QAED;;WAEG;QACH,KAAK,EAAE;YACL,UAAU,EAAE;gBACV,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;gBAC1B,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE;gBACpC,gBAAgB,EAAE;oBAChB,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,eAAe,EAAE;oBACf,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,eAAe,EAAE;oBACf,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,cAAc,EAAE;oBACd,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,QAAQ,EAAE;oBACR,UAAU,EAAE;wBACV,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;wBACzB,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;wBACzB,WAAW,EAAE;4BACX,OAAO,EAAE,OAAO;4BAChB,UAAU,EAAE,EAAE;yBACf;qBACF;iBACF;gBACD,aAAa,EAAE;oBACb,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,OAAO,EAAE;oBACP,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;aACF;SACF;QAED;;WAEG;QACH,MAAM,EAAE;YACN,UAAU,EAAE;gBACV,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;gBAC1B,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE;gBACpC,gBAAgB,EAAE;oBAChB,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,eAAe,EAAE;oBACf,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,eAAe,EAAE;oBACf,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,cAAc,EAAE;oBACd,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,QAAQ,EAAE;oBACR,UAAU,EAAE;wBACV,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;wBACzB,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;wBACzB,WAAW,EAAE;4BACX,OAAO,EAAE,OAAO;4BAChB,UAAU,EAAE,EAAE;yBACf;qBACF;iBACF;aACF;SACF;QAED;;WAEG;QACH,KAAK,EAAE;YACL,UAAU,EAAE;gBACV,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;gBAC1B,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE;gBACpC,QAAQ,EAAE;oBACR,UAAU,EAAE;wBACV,IAAI,EAAE;4BACJ,IAAI,EAAE,SAAS;yBAChB;wBACD,MAAM,EAAE;4BACN,UAAU,EAAE;gCACV,MAAM,EAAE;oCACN,IAAI,EAAE,SAAS;iCAChB;gCACD,OAAO,EAAE;oCACP,IAAI,EAAE,SAAS;iCAChB;6BACF;yBACF;wBACD,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;qBAC5B;iBACF;gBACD,gBAAgB,EAAE;oBAChB,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,eAAe,EAAE;oBACf,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,eAAe,EAAE;oBACf,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,cAAc,EAAE;oBACd,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,aAAa,EAAE;oBACb,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;gBACD,OAAO,EAAE;oBACP,OAAO,EAAE,OAAO;oBAChB,UAAU,EAAE,EAAE;iBACf;aACF;SACF;KACF;CACF,CAAC"}

package/dist/lib/modules/model/types/ModelApi.d.ts

@@ -1,5 +1,5 @@
 import { JSONObject, KDocument, KHit, SearchResult } from "kuzzle-sdk";
-import { AssetModelContent, DeviceModelContent, GroupAffinity, GroupModelContent, LocaleDetails, MeasureModelContent, MetadataDetails, MetadataGroups, MetadataMappings, TooltipModels } from "./ModelContent";
+import { AssetModelContent, DeviceModelContent, GroupAffinity, GroupModelContent, LocaleDetails, MeasureModelContent, MetadataDetails, MetadataGroups, MetadataMappings, MetadataReferential, MetadataReferentialEntry, TooltipModels } from "./ModelContent";
 import { SchemaObject } from "ajv";
 import { MeasureValuesDetails } from "../../measure/types/MeasureDefinition";
 interface ModelsControllerRequest {
@@ -8,30 +8,45 @@ interface ModelsControllerRequest {
 export interface ApiModelGetAssetRequest extends ModelsControllerRequest {
     action: "getAsset";
     model: string;
-    engineGroups: string[];
+    tenantClasses: string[];
+    /**
+     * Returns the stored model, without resolving its referential metadata
+     */
+    rawModel?: boolean;
 }
 export type ApiModelGetAssetResult = KDocument<AssetModelContent>;
 export interface ApiModelGetDeviceRequest extends ModelsControllerRequest {
     action: "getDevice";
     model: string;
+    /**
+     * Returns the stored model, without resolving its referential metadata
+     */
+    rawModel?: boolean;
 }
 export type ApiModelGetDeviceResult = KDocument<DeviceModelContent>;
 export interface ApiModelGetGroupRequest extends ModelsControllerRequest {
     action: "getGroup";
     model: string;
+    /**
+     * Returns the stored model, without resolving its referential metadata
+     */
+    rawModel?: boolean;
 }
 export type ApiModelGetGroupResult = KDocument<GroupModelContent>;
 export interface ApiModelGetMeasureRequest extends ModelsControllerRequest {
     action: "getMeasure";
     type: string;
-    engineId?: string;
+    index?: string;
 }
 export type ApiModelGetMeasureResult = KDocument<MeasureModelContent>;
 export interface ApiModelWriteAssetRequest extends ModelsControllerRequest {
     action: "writeAsset";
     body: {
-        engineGroups: string[];
-        engineIds?: string[];
+        /**
+         * Mutually exclusive with `indexes`
+         */
+        tenantClasses?: string[];
+        indexes?: string[];
         model: string;
         icon?: string;
         metadataDetails?: MetadataDetails;
@@ -63,7 +78,7 @@ export interface ApiModelWriteGroupRequest extends ModelsControllerRequest {
     action: "writeGroup";
     body: {
         affinity: GroupAffinity;
-        engineGroups: string[];
+        tenantClasses: string[];
         model: string;
         icon?: string;
         metadataDetails?: MetadataDetails;
@@ -76,11 +91,48 @@ export interface ApiModelWriteGroupRequest extends ModelsControllerRequest {
     };
 }
 export type ApiModelWriteGroupResult = KDocument<GroupModelContent>;
+export interface ApiModelUpdateDeviceRequest extends ModelsControllerRequest {
+    action: "updateDevice";
+    model: string;
+    body: {
+        /**
+         * Full set of metadata mappings: the existing ones, unchanged, and the new ones,
+         * which must be metadata of the referential (`{ referential: true }`)
+         */
+        metadataMappings: MetadataMappings;
+        /**
+         * Replaces the metadata details when present
+         */
+        metadataDetails?: MetadataDetails;
+        /**
+         * Replaces the default values when present
+         */
+        defaultValues?: JSONObject;
+    };
+}
+export type ApiModelUpdateDeviceResult = KDocument<DeviceModelContent>;
+export interface ApiModelUpdateGroupRequest extends ModelsControllerRequest {
+    action: "updateGroup";
+    tenantClasses?: string[];
+    model: string;
+    body: {
+        affinity?: GroupAffinity;
+        icon?: string;
+        metadataDetails?: MetadataDetails;
+        metadataGroups?: MetadataGroups;
+        metadataMappings?: MetadataMappings;
+        defaultValues?: JSONObject;
+        locales?: {
+            [valueName: string]: LocaleDetails;
+        };
+    };
+}
+export type ApiModelUpdateGroupResult = KDocument<GroupModelContent>;
 export interface ApiModelWriteMeasureRequest extends ModelsControllerRequest {
     action: "writeMeasure";
     body: {
         type: string;
-        engineIds?: string[];
+        indexes?: string[];
         icon?: string;
         locales?: {
             [valueName: string]: LocaleDetails;
@@ -93,7 +145,7 @@ export interface ApiModelWriteMeasureRequest extends ModelsControllerRequest {
 export type ApiModelWriteMeasureResult = KDocument<MeasureModelContent>;
 export interface ApiModelUpdateAssetRequest extends ModelsControllerRequest {
     action: "updateAsset";
-    engineGroups: string[];
+    tenantClasses: string[];
     model: string;
     body: {
         icon?: string;
@@ -131,7 +183,11 @@ export interface ApiModelDeleteMeasureRequest extends ModelsControllerRequest {
 export type ApiModelDeleteMeasureResult = void;
 export interface ApiModelListAssetsRequest extends ModelsControllerRequest {
     action: "listAssets";
-    engineGroups: string[];
+    tenantClasses: string[];
+    /**
+     * Returns the stored model, without resolving its referential metadata
+     */
+    rawModel?: boolean;
 }
 export type ApiModelListAssetsResult = {
     models: KDocument<AssetModelContent>[];
@@ -139,6 +195,10 @@ export type ApiModelListAssetsResult = {
 };
 export interface ApiModelListDevicesRequest extends ModelsControllerRequest {
     action: "listDevices";
+    /**
+     * Returns the stored model, without resolving its referential metadata
+     */
+    rawModel?: boolean;
 }
 export type ApiModelListDevicesResult = {
     models: KDocument<DeviceModelContent>[];
@@ -146,7 +206,11 @@ export type ApiModelListDevicesResult = {
 };
 export interface ApiModelListGroupsRequest extends ModelsControllerRequest {
     action: "listGroups";
-    engineGroups: string[];
+    tenantClasses: string[];
+    /**
+     * Returns the stored model, without resolving its referential metadata
+     */
+    rawModel?: boolean;
 }
 export type ApiModelListGroupsResult = {
     models: KDocument<GroupModelContent>[];
@@ -154,7 +218,7 @@ export type ApiModelListGroupsResult = {
 };
 export interface ApiModelListMeasuresRequest extends ModelsControllerRequest {
     action: "listMeasures";
-    engineId?: string;
+    index?: string;
 }
 export type ApiModelListMeasuresResult = {
     models: KDocument<MeasureModelContent>[];
@@ -162,7 +226,11 @@ export type ApiModelListMeasuresResult = {
 };
 export interface ApiModelSearchAssetsRequest extends ModelsControllerRequest {
     action: "searchAssets";
-    engineGroups: string[];
+    tenantClasses: string[];
+    /**
+     * Returns the stored model, without resolving its referential metadata
+     */
+    rawModel?: boolean;
     from?: number;
     size?: number;
     scrollTTL?: string;
@@ -171,6 +239,10 @@ export interface ApiModelSearchAssetsRequest extends ModelsControllerRequest {
 export type ApiModelSearchAssetsResult = SearchResult<KHit<AssetModelContent>>;
 export interface ApiModelSearchDevicesRequest extends ModelsControllerRequest {
     action: "searchDevices";
+    /**
+     * Returns the stored model, without resolving its referential metadata
+     */
+    rawModel?: boolean;
     from?: number;
     size?: number;
     scrollTTL?: string;
@@ -179,7 +251,11 @@ export interface ApiModelSearchDevicesRequest extends ModelsControllerRequest {
 export type ApiModelSearchDevicesResult = SearchResult<KHit<DeviceModelContent>>;
 export interface ApiModelSearchGroupsRequest extends ModelsControllerRequest {
     action: "searchGroups";
-    engineGroups: string[];
+    tenantClasses: string[];
+    /**
+     * Returns the stored model, without resolving its referential metadata
+     */
+    rawModel?: boolean;
     from?: number;
     size?: number;
     scrollTTL?: string;
@@ -188,11 +264,26 @@ export interface ApiModelSearchGroupsRequest extends ModelsControllerRequest {
 export type ApiModelSearchGroupsResult = SearchResult<KHit<GroupModelContent>>;
 export interface ApiModelSearchMeasuresRequest extends ModelsControllerRequest {
     action: "searchMeasures";
-    engineId?: string;
+    index?: string;
     from?: number;
     size?: number;
     scrollTTL?: string;
     body?: JSONObject;
 }
 export type ApiModelSearchMeasuresResult = SearchResult<KHit<MeasureModelContent>>;
+export interface ApiModelGetMetadataReferentialRequest extends ModelsControllerRequest {
+    action: "getMetadataReferential";
+}
+export type ApiModelGetMetadataReferentialResult = MetadataReferential;
+export interface ApiModelWriteMetadataRequest extends ModelsControllerRequest {
+    action: "writeMetadata";
+    name: string;
+    body: MetadataReferentialEntry;
+}
+export type ApiModelWriteMetadataResult = MetadataReferential;
+export interface ApiModelDeleteMetadataRequest extends ModelsControllerRequest {
+    action: "deleteMetadata";
+    name: string;
+}
+export type ApiModelDeleteMetadataResult = MetadataReferential;
 export {};

package/dist/lib/modules/model/types/ModelContent.d.ts

@@ -3,8 +3,8 @@ import { NamedMeasures } from "../../decoder";
 import { MeasureDefinition } from "../../measure";
 export interface MeasureModelContent extends KDocumentContent {
     type: "measure";
-    engineGroups?: string[];
-    engineIds?: string[];
+    tenantClasses?: string[];
+    indexes?: string[];
     measure: MeasureDefinition & {
         type: string;
         locales?: {
@@ -22,7 +22,20 @@ export interface MetadataObject {
         [key: string]: MetadataProperty | MetadataObject;
     };
 }
+/**
+ * Marks, in the metadataMappings of a model, a metadata defined in the metadata referential.
+ * Its mappings are the referential ones, they are already merged into the engines collections.
+ */
+export interface ReferentialMetadataMapping {
+    referential: true;
+}
 export interface MetadataMappings {
+    [key: string]: MetadataProperty | MetadataObject | ReferentialMetadataMapping;
+}
+/**
+ * Metadata mappings without referential markers, as merged into the engines collections
+ */
+export interface ResolvedMetadataMappings {
     [key: string]: MetadataProperty | MetadataObject;
 }
 export interface GroupAffinity {
@@ -95,9 +108,62 @@ export interface MetadataDetails {
          * Then add a new field in EditorHintEnum to define the type of your hint.
          * Finally add the new editor hint interface with a pipe to take in account the new type.
          */
-        editorHint?: BaseEditorHint | OptionsSelectorEditorHint | DatetimeEditorHint;
+        editorHint?: EditorHint;
+        /**
+         * Icon representing the metadata.
+         * Free-form string, e.g. a FontAwesome icon name, a URL to a PNG/SVG image, or inline SVG markup.
+         */
+        icon?: string;
     };
 }
+export type EditorHint = BaseEditorHint | OptionsSelectorEditorHint | DatetimeEditorHint;
+/**
+ * A metadata defined once in the application metadata referential.
+ * Its mappings are merged into the engines collections when it is written,
+ * models use it with `{ referential: true }` in their metadataMappings.
+ */
+export interface MetadataReferentialEntry {
+    /**
+     * Mappings of the metadata.
+     * They cannot be modified once written, as they are merged into the engines collections.
+     *
+     * @example
+     * { type: "keyword" }
+     * { properties: { name: { type: "keyword" } } }
+     */
+    mappings: MetadataProperty | MetadataObject;
+    /**
+     * Default translations of the metadata, copied into the metadataDetails of a model using it
+     */
+    locales: {
+        [locale: string]: LocaleDetails;
+    };
+    /**
+     * Default editor hint of the metadata
+     */
+    editorHint?: EditorHint;
+    /**
+     * Default value of the metadata
+     */
+    defaultValue?: unknown;
+    /**
+     * Default icon of the metadata.
+     * Free-form string, e.g. a FontAwesome icon name, a URL to a PNG/SVG image, or inline SVG markup.
+     */
+    icon?: string;
+    /**
+     * Set by the plugin: true for a metadata registered from code.
+     * It is written at every startup and cannot be modified or deleted through the API.
+     */
+    managed?: boolean;
+}
+export interface MetadataReferential {
+    [name: string]: MetadataReferentialEntry;
+}
+export interface MetadataReferentialContent extends KDocumentContent {
+    type: "metadata-referential";
+    metadata: MetadataReferential;
+}
 export interface MetadataGroupLocale {
     groupFriendlyName: string;
     description: string;
@@ -155,13 +221,13 @@ export interface TooltipModels {
 }
 export interface AssetModelContent extends KDocumentContent {
     type: "asset";
-    engineGroups: string[];
+    tenantClasses: string[];
     /**
      * Optional list of engine IDs (tenant IDs) this model is scoped to.
      * When set, the model is only available to the specified tenants.
-     * When absent, the model is available to all tenants in the engineGroups.
+     * When absent, the model is available to all tenants in the tenantClasses.
      */
-    engineIds?: string[];
+    indexes?: string[];
     asset: {
         /**
          * Name of the model
@@ -408,7 +474,7 @@ export interface DeviceModelContent extends KDocumentContent {
 }
 export interface GroupModelContent extends KDocumentContent {
     type: "group";
-    engineGroups: string[];
+    tenantClasses: string[];
     group: {
         /**
          * Name of the model

package/dist/lib/modules/model/types/ModelContent.js.map

@@ -1 +1 @@
-{"version":3,"file":"ModelContent.js","sourceRoot":"","sources":["../../../../../lib/modules/model/types/ModelContent.ts"],"names":[],"mappings":";;;AA8DA,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,+BAAa,CAAA;IACb,oDAAkC,CAAA;IAClC,uCAAqB,CAAA;AACvB,CAAC,EAJW,cAAc,8BAAd,cAAc,QAIzB;AAgGD,IAAY,wBAMX;AAND,WAAY,wBAAwB;IAClC,yCAAa,CAAA;IACb,2CAAe,CAAA;IACf,yCAAa,CAAA;IACb,2CAAe,CAAA;IACf,mDAAuB,CAAA;AACzB,CAAC,EANW,wBAAwB,wCAAxB,wBAAwB,QAMnC"}
+{"version":3,"file":"ModelContent.js","sourceRoot":"","sources":["../../../../../lib/modules/model/types/ModelContent.ts"],"names":[],"mappings":";;;AA6EA,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,+BAAa,CAAA;IACb,oDAAkC,CAAA;IAClC,uCAAqB,CAAA;AACvB,CAAC,EAJW,cAAc,8BAAd,cAAc,QAIzB;AA0JD,IAAY,wBAMX;AAND,WAAY,wBAAwB;IAClC,yCAAa,CAAA;IACb,2CAAe,CAAA;IACf,yCAAa,CAAA;IACb,2CAAe,CAAA;IACf,mDAAuB,CAAA;AACzB,CAAC,EANW,wBAAwB,wCAAxB,wBAAwB,QAMnC"}

package/dist/lib/modules/model/types/ModelDefinition.d.ts

@@ -118,7 +118,8 @@ export type AssetModelDefinition = {
      */
     icon?: string;
     /**
-     * Metadata mappings definition
+     * Metadata mappings definition.
+     * Use `{ referential: true }` for a metadata of the metadata referential.
      */
     metadataMappings?: MetadataMappings;
     /**
@@ -201,7 +202,8 @@ export type DeviceModelDefinition = {
      */
     icon?: string;
     /**
-     * Metadata mappings definition
+     * Metadata mappings definition.
+     * Use `{ referential: true }` for a metadata of the metadata referential.
      */
     metadataMappings?: MetadataMappings;
     /**
@@ -296,7 +298,8 @@ export type GroupModelDefinition = {
      */
     icon?: string;
     /**
-     * Metadata mappings definition
+     * Metadata mappings definition.
+     * Use `{ referential: true }` for a metadata of the metadata referential.
      */
     metadataMappings?: MetadataMappings;
     /**

package/dist/lib/modules/model/types/ModelEvents.d.ts

@@ -1,9 +1,9 @@
-import { AssetModelContent, DeviceModelContent, GroupModelContent, MeasureModelContent } from "./ModelContent";
+import { AssetModelContent, DeviceModelContent, GroupModelContent, MeasureModelContent, MetadataReferential } from "./ModelContent";
 export type AskModelAssetGet = {
     name: "ask:device-manager:model:asset:get";
     payload: {
-        engineGroups: string[];
-        engineId?: string;
+        tenantClasses: string[];
+        index?: string;
         model: string;
     };
     result: AssetModelContent;
@@ -19,7 +19,7 @@ export type AskModelMeasureGet = {
     name: "ask:device-manager:model:measure:get";
     payload: {
         type: string;
-        engineId?: string;
+        index?: string;
     };
     result: MeasureModelContent;
 };
@@ -30,3 +30,8 @@ export type AskModelGroupGet = {
     };
     result: GroupModelContent;
 };
+export type AskModelMetadataReferentialGet = {
+    name: "ask:device-manager:model:metadata-referential:get";
+    payload: void;
+    result: MetadataReferential;
+};