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

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

@@ -0,0 +1,342 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchReferencingModels = exports.fetchMetadataModels = exports.saveMetadataReferential = exports.fetchMetadataReferential = exports.getAddedInlineMetadata = exports.getEntryModelsConflicts = exports.enrichModelMetadata = exports.checkMetadataReferentialEntry = exports.resolveModelMetadata = exports.resolveModelMappings = exports.resolveMetadataMappings = exports.getReferentialNames = exports.isReferentialMapping = exports.withMetadataReferentialLock = exports.METADATA_REFERENTIAL_ID = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+const InternalCollection_1 = require("../plugin/types/InternalCollection");
+const lock_1 = require("../shared/utils/lock");
+const MappingsConflictsError_1 = require("./MappingsConflictsError");
+const ModelsConflicts_1 = require("./ModelsConflicts");
+exports.METADATA_REFERENTIAL_ID = "model-metadata-referential";
+/**
+ * TTL of the metadata referential lock. Kuzzle locks expire after 5s by default,
+ * less than a model write updating the engines collections.
+ */
+const METADATA_REFERENTIAL_LOCK_TTL = 120000;
+/**
+ * Runs cb holding the metadata referential lock, taken by every write of the referential
+ * and of asset, device and group models, so their conflicts checks see each other writes
+ */
+async function withMetadataReferentialLock(cb) {
+    return (0, lock_1.lock)("device-manager/metadataReferential", cb, {
+        ttl: METADATA_REFERENTIAL_LOCK_TTL,
+    });
+}
+exports.withMetadataReferentialLock = withMetadataReferentialLock;
+/**
+ * @returns true if the metadata mappings mark a metadata of the referential
+ */
+function isReferentialMapping(mapping) {
+    return (lodash_1.default.isPlainObject(mapping) && mapping.referential === true);
+}
+exports.isReferentialMapping = isReferentialMapping;
+/**
+ * Lists the metadata of a model coming from the metadata referential
+ */
+function getReferentialNames(metadataMappings = {}) {
+    return Object.keys(metadataMappings).filter((name) => isReferentialMapping(metadataMappings[name]));
+}
+exports.getReferentialNames = getReferentialNames;
+/**
+ * Replaces the referential markers of metadata mappings by the referential mappings.
+ * A marker of a metadata missing from the referential is dropped.
+ */
+function resolveMetadataMappings(referential, metadataMappings = {}) {
+    const resolved = {};
+    for (const [name, mapping] of Object.entries(metadataMappings)) {
+        if (!isReferentialMapping(mapping)) {
+            resolved[name] = mapping;
+        }
+        else if (referential[name]) {
+            resolved[name] = lodash_1.default.cloneDeep(referential[name].mappings);
+        }
+    }
+    return resolved;
+}
+exports.resolveMetadataMappings = resolveMetadataMappings;
+/**
+ * @returns The model with the referential markers of its metadata mappings resolved
+ */
+function resolveModelMappings(referential, content) {
+    const twin = content[content.type];
+    return {
+        ...content,
+        [content.type]: {
+            ...twin,
+            metadataMappings: resolveMetadataMappings(referential, twin.metadataMappings),
+        },
+    };
+}
+exports.resolveModelMappings = resolveModelMappings;
+function isDefaultOf(key, name) {
+    return key === name || key.startsWith(`${name}.`);
+}
+/**
+ * Merges, per locale, the model translations over the referential ones.
+ * A locale missing from the referential falls back to the metadata name and an empty description.
+ */
+function mergeLocales(name, entryLocales = {}, modelLocales = {}) {
+    const locales = {};
+    for (const locale of lodash_1.default.union(Object.keys(entryLocales), Object.keys(modelLocales))) {
+        locales[locale] = {
+            description: "",
+            friendlyName: name,
+            ...entryLocales[locale],
+            ...modelLocales[locale],
+        };
+    }
+    return locales;
+}
+/**
+ * Builds the details of a metadata of the referential, the model values taking precedence
+ */
+function enrichDetails(name, entry, details = {}) {
+    return {
+        ...(entry.editorHint ? { editorHint: lodash_1.default.cloneDeep(entry.editorHint) } : {}),
+        ...(entry.icon !== undefined ? { icon: entry.icon } : {}),
+        ...details,
+        locales: mergeLocales(name, entry.locales, details.locales),
+    };
+}
+/**
+ * Fills the details and default value of a referential metadata with the referential values,
+ * the model values taking precedence
+ */
+function applyReferentialValues(name, entry, metadataDetails, defaultMetadata) {
+    metadataDetails[name] = enrichDetails(name, entry, metadataDetails[name]);
+    const hasDefault = Object.keys(defaultMetadata).some((key) => isDefaultOf(key, name));
+    if (!hasDefault && entry.defaultValue !== undefined) {
+        defaultMetadata[name] = lodash_1.default.cloneDeep(entry.defaultValue);
+    }
+}
+/**
+ * Resolves the referential metadata of a stored model, to be read:
+ * the markers are replaced by the referential mappings, the details and default values
+ * are merged over the current referential values.
+ * A marker of a metadata missing from the referential is dropped.
+ *
+ * @returns The model with its referential metadata resolved
+ */
+function resolveModelMetadata(referential, content) {
+    const twin = content[content.type];
+    const metadataDetails = { ...twin.metadataDetails };
+    const defaultMetadata = { ...twin.defaultMetadata };
+    for (const name of getReferentialNames(twin.metadataMappings)) {
+        if (referential[name]) {
+            applyReferentialValues(name, referential[name], metadataDetails, defaultMetadata);
+        }
+    }
+    return {
+        ...content,
+        [content.type]: {
+            ...twin,
+            defaultMetadata,
+            metadataDetails,
+            metadataMappings: resolveMetadataMappings(referential, twin.metadataMappings),
+        },
+    };
+}
+exports.resolveModelMetadata = resolveModelMetadata;
+/**
+ * Validates the shape of a metadata referential entry
+ *
+ * @throws The error built by createError if the entry is invalid
+ */
+function checkMetadataReferentialEntry(name, entry, createError) {
+    if (typeof name !== "string" || name.length === 0 || name.includes(".")) {
+        throw createError(`Metadata name "${name}" is invalid: it must be a non empty string without "."`);
+    }
+    if (!lodash_1.default.isPlainObject(entry)) {
+        throw createError(`Metadata "${name}" definition must be an object`);
+    }
+    const mappings = entry.mappings;
+    if (!lodash_1.default.isPlainObject(mappings) ||
+        (typeof mappings.type !== "string" && !lodash_1.default.isPlainObject(mappings.properties))) {
+        throw createError(`Metadata "${name}" mappings must define either a "type" or "properties"`);
+    }
+    if (entry.locales !== undefined && !lodash_1.default.isPlainObject(entry.locales)) {
+        throw createError(`Metadata "${name}" locales must be an object`);
+    }
+    if (entry.editorHint !== undefined &&
+        (!lodash_1.default.isPlainObject(entry.editorHint) ||
+            typeof entry.editorHint.type !== "string")) {
+        throw createError(`Metadata "${name}" editorHint must be an object with a "type"`);
+    }
+    if (entry.icon !== undefined && typeof entry.icon !== "string") {
+        throw createError(`Metadata "${name}" icon must be a string`);
+    }
+}
+exports.checkMetadataReferentialEntry = checkMetadataReferentialEntry;
+/**
+ * Lists the conflicts between an inline metadata and a referential entry of the same name.
+ * Any difference is a conflict: an inline metadata must be identical to the referential one.
+ */
+function getInlineConflicts(name, inlineMappings, entry, basePath) {
+    if (lodash_1.default.isEqual(inlineMappings, entry.mappings)) {
+        return [];
+    }
+    const conflicts = (0, ModelsConflicts_1.findMappingsConflicts)({ [name]: entry.mappings }, { [name]: inlineMappings }, basePath);
+    // ? Same leaves but different structure (e.g. additional properties)
+    if (conflicts.length === 0) {
+        return [
+            {
+                currentType: JSON.stringify(entry.mappings),
+                newType: JSON.stringify(inlineMappings),
+                path: `${basePath}.${name}`,
+            },
+        ];
+    }
+    return conflicts;
+}
+function describeModel(context) {
+    return `${context.modelType} model "${context.model}"`;
+}
+/**
+ * Validates the metadata mappings of a model against the metadata referential and enriches
+ * the details and default values of the metadata coming from the referential.
+ *
+ * A metadata of the referential is marked `{ referential: true }` in metadataMappings, the marker is kept.
+ * Its details are the referential locales (merged per locale), editorHint and icon, overridden by the
+ * model ones. Its default value is the referential one, unless the model defines one.
+ *
+ * An inline metadata with the name of a referential entry must have the same mappings (legacy).
+ *
+ * @throws The error built by createError on an invalid marker or an unknown metadata
+ * @throws MappingsConflictsError if an inline metadata conflicts with the referential
+ */
+function enrichModelMetadata(referential, fields, context) {
+    const model = describeModel(context);
+    const metadataMappings = fields.metadataMappings ?? {};
+    const metadataDetails = { ...fields.metadataDetails };
+    const defaultMetadata = { ...fields.defaultMetadata };
+    const warnings = [];
+    const conflicts = [];
+    if (!lodash_1.default.isPlainObject(metadataMappings)) {
+        throw context.createError(`Metadata mappings of ${model} must be an object`);
+    }
+    for (const [name, mapping] of Object.entries(metadataMappings)) {
+        const entry = referential[name];
+        if (lodash_1.default.isPlainObject(mapping) && "referential" in mapping) {
+            if (!isReferentialMapping(mapping) || Object.keys(mapping).length !== 1) {
+                throw context.createError(`The metadata "${name}" of ${model} must be { referential: true } to use the metadata referential`);
+            }
+            if (!entry) {
+                throw context.createError(`The ${model} uses the unknown referential metadata "${name}"`);
+            }
+            applyReferentialValues(name, entry, metadataDetails, defaultMetadata);
+            continue;
+        }
+        if (!entry) {
+            continue;
+        }
+        conflicts.push(...getInlineConflicts(name, mapping, entry, `${context.modelType}.metadataMappings`));
+        warnings.push(`The ${model} defines the metadata "${name}" inline, it should use the metadata referential instead with { referential: true }`);
+    }
+    if (conflicts.length > 0) {
+        throw new MappingsConflictsError_1.MappingsConflictsError(`Metadata of ${model} conflict with the metadata referential`, [
+            {
+                conflicts,
+                modelType: context.modelType,
+                newModel: context.model,
+                sourceModel: "metadata-referential",
+            },
+        ]);
+    }
+    return {
+        fields: { defaultMetadata, metadataDetails, metadataMappings },
+        resolvedMappings: resolveMetadataMappings(referential, metadataMappings),
+        warnings,
+    };
+}
+exports.enrichModelMetadata = enrichModelMetadata;
+/**
+ * Lists the conflicts between a referential entry and the inline metadata of the same name of models
+ */
+function getEntryModelsConflicts(name, entry, models) {
+    const chunks = [];
+    for (const content of models) {
+        const twin = content[content.type];
+        const mapping = twin.metadataMappings?.[name];
+        if (mapping === undefined || isReferentialMapping(mapping)) {
+            continue;
+        }
+        const conflicts = getInlineConflicts(name, mapping, entry, `${content.type}.metadataMappings`);
+        if (conflicts.length > 0) {
+            chunks.push({
+                conflicts,
+                modelType: content.type,
+                newModel: "metadata-referential",
+                sourceModel: twin.model,
+            });
+        }
+    }
+    return chunks;
+}
+exports.getEntryModelsConflicts = getEntryModelsConflicts;
+/**
+ * Lists the inline metadata a model write adds: metadataMappings keys that neither
+ * use the referential nor are already defined inline by the stored model.
+ */
+function getAddedInlineMetadata(metadataMappings, stored) {
+    const storedMappings = stored?.[stored.type]?.metadataMappings ?? {};
+    return Object.keys(metadataMappings).filter((name) => !isReferentialMapping(metadataMappings[name]) &&
+        !(name in storedMappings && !isReferentialMapping(storedMappings[name])));
+}
+exports.getAddedInlineMetadata = getAddedInlineMetadata;
+/**
+ * Reads the metadata referential document
+ *
+ * @returns The referential metadata, empty if the document does not exist yet
+ */
+async function fetchMetadataReferential(sdk, platformIndex) {
+    try {
+        const document = await sdk.document.get(platformIndex, InternalCollection_1.InternalCollection.MODELS, exports.METADATA_REFERENTIAL_ID);
+        return document._source.metadata ?? {};
+    }
+    catch (error) {
+        if (error.status === 404) {
+            return {};
+        }
+        throw error;
+    }
+}
+exports.fetchMetadataReferential = fetchMetadataReferential;
+/**
+ * Writes the whole metadata referential document
+ */
+async function saveMetadataReferential(sdk, platformIndex, referential) {
+    const content = {
+        metadata: referential,
+        type: "metadata-referential",
+    };
+    return sdk.document.createOrReplace(platformIndex, InternalCollection_1.InternalCollection.MODELS, exports.METADATA_REFERENTIAL_ID, content, { refresh: "wait_for" });
+}
+exports.saveMetadataReferential = saveMetadataReferential;
+/**
+ * Lists every stored asset, device and group model
+ */
+async function fetchMetadataModels(sdk, platformIndex) {
+    const models = [];
+    let result = await sdk.document.search(platformIndex, InternalCollection_1.InternalCollection.MODELS, { query: { terms: { type: ["asset", "device", "group"] } } }, { lang: "elasticsearch", scroll: "10s", size: 500 });
+    while (result) {
+        for (const hit of result.hits) {
+            models.push({ _id: hit._id, _source: hit._source });
+        }
+        result = await result.next();
+    }
+    return models;
+}
+exports.fetchMetadataModels = fetchMetadataModels;
+/**
+ * Lists every stored asset, device and group model using the given metadata of the referential.
+ *
+ * metadataMappings is not indexed, the filtering is done after fetching the models.
+ */
+async function fetchReferencingModels(sdk, platformIndex, name) {
+    const models = await fetchMetadataModels(sdk, platformIndex);
+    return models.filter(({ _source }) => isReferentialMapping(_source[_source.type]?.metadataMappings?.[name]));
+}
+exports.fetchReferencingModels = fetchReferencingModels;
+//# sourceMappingURL=MetadataReferential.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"MetadataReferential.js","sourceRoot":"","sources":["../../../../lib/modules/model/MetadataReferential.ts"],"names":[],"mappings":";;;;;;AAEA,oDAAuB;AAEvB,2EAAwE;AACxE,+CAA4C;AAE5C,qEAAkE;AAClE,uDAI2B;AAed,QAAA,uBAAuB,GAAG,4BAA4B,CAAC;AAEpE;;;GAGG;AACH,MAAM,6BAA6B,GAAG,MAAO,CAAC;AAE9C;;;GAGG;AACI,KAAK,UAAU,2BAA2B,CAC/C,EAAoB;IAEpB,OAAO,IAAA,WAAI,EAAC,oCAAoC,EAAE,EAAE,EAAE;QACpD,GAAG,EAAE,6BAA6B;KACnC,CAAC,CAAC;AACL,CAAC;AAND,kEAMC;AA4CD;;GAEG;AACH,SAAgB,oBAAoB,CAClC,OAAgB;IAEhB,OAAO,CACL,gBAAC,CAAC,aAAa,CAAC,OAAO,CAAC,IAAK,OAAsB,CAAC,WAAW,KAAK,IAAI,CACzE,CAAC;AACJ,CAAC;AAND,oDAMC;AAED;;GAEG;AACH,SAAgB,mBAAmB,CACjC,mBAAqC,EAAE;IAEvC,OAAO,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CACnD,oBAAoB,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAC7C,CAAC;AACJ,CAAC;AAND,kDAMC;AAED;;;GAGG;AACH,SAAgB,uBAAuB,CACrC,WAAgC,EAChC,mBAAqC,EAAE;IAEvC,MAAM,QAAQ,GAA6B,EAAE,CAAC;IAE9C,KAAK,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC;QAC/D,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,EAAE,CAAC;YACnC,QAAQ,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC;QAC3B,CAAC;aAAM,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7B,QAAQ,CAAC,IAAI,CAAC,GAAG,gBAAC,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAfD,0DAeC;AAED;;GAEG;AACH,SAAgB,oBAAoB,CAClC,WAAgC,EAChC,OAAU;IAEV,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnC,OAAO;QACL,GAAG,OAAO;QACV,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACd,GAAG,IAAI;YACP,gBAAgB,EAAE,uBAAuB,CACvC,WAAW,EACX,IAAI,CAAC,gBAAgB,CACtB;SACF;KACF,CAAC;AACJ,CAAC;AAhBD,oDAgBC;AAED,SAAS,WAAW,CAAC,GAAW,EAAE,IAAY;IAC5C,OAAO,GAAG,KAAK,IAAI,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC;AACpD,CAAC;AAED;;;GAGG;AACH,SAAS,YAAY,CACnB,IAAY,EACZ,eAAoD,EAAE,EACtD,eAAmD,EAAE;IAErD,MAAM,OAAO,GAAwC,EAAE,CAAC;IAExD,KAAK,MAAM,MAAM,IAAI,gBAAC,CAAC,KAAK,CAC1B,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EACzB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAC1B,EAAE,CAAC;QACF,OAAO,CAAC,MAAM,CAAC,GAAG;YAChB,WAAW,EAAE,EAAE;YACf,YAAY,EAAE,IAAI;YAClB,GAAG,YAAY,CAAC,MAAM,CAAC;YACvB,GAAG,YAAY,CAAC,MAAM,CAAC;SACxB,CAAC;IACJ,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;GAEG;AACH,SAAS,aAAa,CACpB,IAAY,EACZ,KAA+B,EAC/B,UAA4C,EAAE;IAE9C,OAAO;QACL,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,gBAAC,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1E,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACzD,GAAG,OAAO;QACV,OAAO,EAAE,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC;KAC5D,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAS,sBAAsB,CAC7B,IAAY,EACZ,KAA+B,EAC/B,eAAgC,EAChC,eAA2B;IAE3B,eAAe,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,IAAI,EAAE,KAAK,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;IAE1E,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAC3D,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,CACvB,CAAC;IAEF,IAAI,CAAC,UAAU,IAAI,KAAK,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;QACpD,eAAe,CAAC,IAAI,CAAC,GAAG,gBAAC,CAAC,SAAS,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAC1D,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,oBAAoB,CAClC,WAAgC,EAChC,OAAU;IAEV,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,eAAe,GAAoB,EAAE,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;IACrE,MAAM,eAAe,GAAe,EAAE,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;IAEhE,KAAK,MAAM,IAAI,IAAI,mBAAmB,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC;QAC9D,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,sBAAsB,CACpB,IAAI,EACJ,WAAW,CAAC,IAAI,CAAC,EACjB,eAAe,EACf,eAAe,CAChB,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO;QACL,GAAG,OAAO;QACV,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACd,GAAG,IAAI;YACP,eAAe;YACf,eAAe;YACf,gBAAgB,EAAE,uBAAuB,CACvC,WAAW,EACX,IAAI,CAAC,gBAAgB,CACtB;SACF;KACF,CAAC;AACJ,CAAC;AA/BD,oDA+BC;AAED;;;;GAIG;AACH,SAAgB,6BAA6B,CAC3C,IAAY,EACZ,KAA+B,EAC/B,WAAuC;IAEvC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACxE,MAAM,WAAW,CACf,kBAAkB,IAAI,yDAAyD,CAChF,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,gBAAC,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,MAAM,WAAW,CAAC,aAAa,IAAI,gCAAgC,CAAC,CAAC;IACvE,CAAC;IAED,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAsB,CAAC;IAE9C,IACE,CAAC,gBAAC,CAAC,aAAa,CAAC,QAAQ,CAAC;QAC1B,CAAC,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,gBAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,EAC5E,CAAC;QACD,MAAM,WAAW,CACf,aAAa,IAAI,wDAAwD,CAC1E,CAAC;IACJ,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,gBAAC,CAAC,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QACnE,MAAM,WAAW,CAAC,aAAa,IAAI,6BAA6B,CAAC,CAAC;IACpE,CAAC;IAED,IACE,KAAK,CAAC,UAAU,KAAK,SAAS;QAC9B,CAAC,CAAC,gBAAC,CAAC,aAAa,CAAC,KAAK,CAAC,UAAU,CAAC;YACjC,OAAO,KAAK,CAAC,UAAU,CAAC,IAAI,KAAK,QAAQ,CAAC,EAC5C,CAAC;QACD,MAAM,WAAW,CACf,aAAa,IAAI,8CAA8C,CAChE,CAAC;IACJ,CAAC;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC/D,MAAM,WAAW,CAAC,aAAa,IAAI,yBAAyB,CAAC,CAAC;IAChE,CAAC;AACH,CAAC;AA3CD,sEA2CC;AAED;;;GAGG;AACH,SAAS,kBAAkB,CACzB,IAAY,EACZ,cAAuB,EACvB,KAA+B,EAC/B,QAAgB;IAEhB,IAAI,gBAAC,CAAC,OAAO,CAAC,cAAc,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC9C,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,SAAS,GAAG,IAAA,uCAAqB,EACrC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,QAAQ,EAAE,EAC1B,EAAE,CAAC,IAAI,CAAC,EAAE,cAAc,EAAE,EAC1B,QAAQ,CACT,CAAC;IAEF,qEAAqE;IACrE,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO;YACL;gBACE,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC;gBAC3C,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC;gBACvC,IAAI,EAAE,GAAG,QAAQ,IAAI,IAAI,EAAE;aAC5B;SACF,CAAC;IACJ,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,aAAa,CAAC,OAAkC;IACvD,OAAO,GAAG,OAAO,CAAC,SAAS,WAAW,OAAO,CAAC,KAAK,GAAG,CAAC;AACzD,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,mBAAmB,CACjC,WAAgC,EAChC,MAAoC,EACpC,OAAkC;IAElC,MAAM,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IACrC,MAAM,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,IAAI,EAAE,CAAC;IACvD,MAAM,eAAe,GAAoB,EAAE,GAAG,MAAM,CAAC,eAAe,EAAE,CAAC;IACvE,MAAM,eAAe,GAAe,EAAE,GAAG,MAAM,CAAC,eAAe,EAAE,CAAC;IAClE,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,SAAS,GAAuB,EAAE,CAAC;IAEzC,IAAI,CAAC,gBAAC,CAAC,aAAa,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACvC,MAAM,OAAO,CAAC,WAAW,CACvB,wBAAwB,KAAK,oBAAoB,CAClD,CAAC;IACJ,CAAC;IAED,KAAK,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC;QAC/D,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QAEhC,IAAI,gBAAC,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,aAAa,IAAI,OAAO,EAAE,CAAC;YACzD,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACxE,MAAM,OAAO,CAAC,WAAW,CACvB,iBAAiB,IAAI,QAAQ,KAAK,gEAAgE,CACnG,CAAC;YACJ,CAAC;YAED,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,MAAM,OAAO,CAAC,WAAW,CACvB,OAAO,KAAK,2CAA2C,IAAI,GAAG,CAC/D,CAAC;YACJ,CAAC;YAED,sBAAsB,CAAC,IAAI,EAAE,KAAK,EAAE,eAAe,EAAE,eAAe,CAAC,CAAC;YAEtE,SAAS;QACX,CAAC;QAED,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,SAAS;QACX,CAAC;QAED,SAAS,CAAC,IAAI,CACZ,GAAG,kBAAkB,CACnB,IAAI,EACJ,OAAO,EACP,KAAK,EACL,GAAG,OAAO,CAAC,SAAS,mBAAmB,CACxC,CACF,CAAC;QAEF,QAAQ,CAAC,IAAI,CACX,OAAO,KAAK,0BAA0B,IAAI,qFAAqF,CAChI,CAAC;IACJ,CAAC;IAED,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,+CAAsB,CAC9B,eAAe,KAAK,yCAAyC,EAC7D;YACE;gBACE,SAAS;gBACT,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,QAAQ,EAAE,OAAO,CAAC,KAAK;gBACvB,WAAW,EAAE,sBAAsB;aACpC;SACF,CACF,CAAC;IACJ,CAAC;IAED,OAAO;QACL,MAAM,EAAE,EAAE,eAAe,EAAE,eAAe,EAAE,gBAAgB,EAAE;QAC9D,gBAAgB,EAAE,uBAAuB,CAAC,WAAW,EAAE,gBAAgB,CAAC;QACxE,QAAQ;KACT,CAAC;AACJ,CAAC;AA5ED,kDA4EC;AAED;;GAEG;AACH,SAAgB,uBAAuB,CACrC,IAAY,EACZ,KAA+B,EAC/B,MAA8B;IAE9B,MAAM,MAAM,GAAoB,EAAE,CAAC;IAEnC,KAAK,MAAM,OAAO,IAAI,MAAM,EAAE,CAAC;QAC7B,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnC,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC,IAAI,CAAC,CAAC;QAE9C,IAAI,OAAO,KAAK,SAAS,IAAI,oBAAoB,CAAC,OAAO,CAAC,EAAE,CAAC;YAC3D,SAAS;QACX,CAAC;QAED,MAAM,SAAS,GAAG,kBAAkB,CAClC,IAAI,EACJ,OAAO,EACP,KAAK,EACL,GAAG,OAAO,CAAC,IAAI,mBAAmB,CACnC,CAAC;QAEF,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,MAAM,CAAC,IAAI,CAAC;gBACV,SAAS;gBACT,SAAS,EAAE,OAAO,CAAC,IAAI;gBACvB,QAAQ,EAAE,sBAAsB;gBAChC,WAAW,EAAE,IAAI,CAAC,KAAK;aACxB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAjCD,0DAiCC;AAED;;;GAGG;AACH,SAAgB,sBAAsB,CACpC,gBAAkC,EAClC,MAAmC;IAEnC,MAAM,cAAc,GAAG,MAAM,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,gBAAgB,IAAI,EAAE,CAAC;IAErE,OAAO,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,MAAM,CACzC,CAAC,IAAI,EAAE,EAAE,CACP,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC,CAAC,IAAI,IAAI,cAAc,IAAI,CAAC,oBAAoB,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAC3E,CAAC;AACJ,CAAC;AAXD,wDAWC;AAED;;;;GAIG;AACI,KAAK,UAAU,wBAAwB,CAC5C,GAAgB,EAChB,aAAqB;IAErB,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,GAAG,CACrC,aAAa,EACb,uCAAkB,CAAC,MAAM,EACzB,+BAAuB,CACxB,CAAC;QAEF,OAAO,QAAQ,CAAC,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC;IACzC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YACzB,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAnBD,4DAmBC;AAED;;GAEG;AACI,KAAK,UAAU,uBAAuB,CAC3C,GAAgB,EAChB,aAAqB,EACrB,WAAgC;IAEhC,MAAM,OAAO,GAA+B;QAC1C,QAAQ,EAAE,WAAW;QACrB,IAAI,EAAE,sBAAsB;KAC7B,CAAC;IAEF,OAAO,GAAG,CAAC,QAAQ,CAAC,eAAe,CACjC,aAAa,EACb,uCAAkB,CAAC,MAAM,EACzB,+BAAuB,EACvB,OAAO,EACP,EAAE,OAAO,EAAE,UAAU,EAAE,CACxB,CAAC;AACJ,CAAC;AAjBD,0DAiBC;AAED;;GAEG;AACI,KAAK,UAAU,mBAAmB,CACvC,GAAgB,EAChB,aAAqB;IAErB,MAAM,MAAM,GAAsC,EAAE,CAAC;IAErD,IAAI,MAAM,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,CACpC,aAAa,EACb,uCAAkB,CAAC,MAAM,EACzB,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,EAAE,EAAE,EAC5D,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,CACpD,CAAC;IAEF,OAAO,MAAM,EAAE,CAAC;QACd,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YAC9B,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;QACtD,CAAC;QAED,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;IAC/B,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAtBD,kDAsBC;AAED;;;;GAIG;AACI,KAAK,UAAU,sBAAsB,CAC1C,GAAgB,EAChB,aAAqB,EACrB,IAAY;IAEZ,MAAM,MAAM,GAAG,MAAM,mBAAmB,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;IAE7D,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CACnC,oBAAoB,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,gBAAgB,EAAE,CAAC,IAAI,CAAC,CAAC,CACtE,CAAC;AACJ,CAAC;AAVD,wDAUC"}

package/dist/lib/modules/model/ModelService.d.ts

@@ -2,11 +2,36 @@ import { KuzzleRequest } from "kuzzle";
 import { JSONObject, KDocument, KHit, SearchResult } from "kuzzle-sdk";
 import { DeviceManagerPlugin } from "../plugin";
 import { BaseService, SearchParams } from "../shared";
-import { AssetModelContent, DeviceModelContent, GroupModelContent, LocaleDetails, MeasureModelContent, MetadataDetails, MetadataGroups, MetadataMappings, TooltipModels } from "./types/ModelContent";
+import { AssetModelContent, DeviceModelContent, GroupModelContent, LocaleDetails, MeasureModelContent, MetadataDetails, MetadataGroups, MetadataMappings, MetadataReferential, MetadataReferentialEntry, TooltipModels } from "./types/ModelContent";
 import { SchemaObject } from "ajv";
 import { MeasureValuesDetails } from "../measure";
 import { NamedMeasures } from "../decoder";
 import { KuzzleLogger } from "kuzzle-logger";
+import { MetadataModelContent } from "./MetadataReferential";
+/**
+ * Fields of a group model update.
+ * Affinity and icon are kept when omitted.
+ */
+export type GroupModelUpdate = {
+    affinity?: JSONObject;
+    defaultMetadata: JSONObject;
+    icon?: string;
+    locales: {
+        [valueName: string]: LocaleDetails;
+    };
+    metadataDetails: MetadataDetails;
+    metadataGroups: MetadataGroups;
+    metadataMappings: MetadataMappings;
+};
+/**
+ * Fields of a device model update.
+ * Metadata details and default values are kept when omitted.
+ */
+export type DeviceModelUpdate = {
+    defaultMetadata?: JSONObject;
+    metadataDetails?: MetadataDetails;
+    metadataMappings: MetadataMappings;
+};
 export declare class ModelService extends BaseService {
     readonly logger: KuzzleLogger;
     constructor(plugin: DeviceManagerPlugin, logger: KuzzleLogger);
@@ -66,4 +91,81 @@ export declare class ModelService extends BaseService {
     updateAsset(tenantClasses: string[], index: string | undefined, model: string, metadataMappings: MetadataMappings, defaultMetadata: JSONObject, metadataDetails: MetadataDetails, metadataGroups: MetadataGroups, measures: AssetModelContent["asset"]["measures"], tooltipModels: TooltipModels, locales: {
         [valueName: string]: LocaleDetails;
     }, icon: string | undefined, request: KuzzleRequest): Promise<KDocument<AssetModelContent>>;
+    /**
+     * Adds metadata of the metadata referential to a device model.
+     *
+     * Device models are additive only from the API: every existing metadata must be kept unchanged,
+     * new metadata must come from the referential. Metadata details and default values can change.
+     * The engines mappings are updated and the devices get the new metadata with their default value.
+     *
+     * @throws BadRequestError if an existing metadata is missing or changed, or a new one is inline
+     * @throws MappingsConflictsError if the new metadata conflict with the existing mappings
+     */
+    updateDevice(model: string, { defaultMetadata, metadataDetails, metadataMappings }: DeviceModelUpdate): Promise<KDocument<DeviceModelContent>>;
+    /**
+     * Returns the group model available for the given tenant classes:
+     * a model of these classes first, then a commons model.
+     *
+     * @throws NotFoundError if no group model with this name is available
+     */
+    private getScopedGroup;
+    /**
+     * Updates a group model, keeping its scope.
+     * Affinity and icon are kept when omitted.
+     *
+     * The engines mappings are updated and the groups of the model are refreshed.
+     *
+     * @throws MappingsConflictsError if the new mappings conflict with the existing ones
+     */
+    updateGroup(tenantClasses: string[], model: string, { affinity, defaultMetadata, icon, locales, metadataDetails, metadataGroups, metadataMappings, }: GroupModelUpdate): Promise<KDocument<GroupModelContent>>;
+    /**
+     * Validates the metadata of a model written through the API against the metadata referential
+     * and enriches the details and default values of the metadata coming from it
+     */
+    private resolveMetadata;
+    /**
+     * Resolves the referential metadata of stored models, to be returned by the API
+     */
+    resolveModels<D extends {
+        _source: MetadataModelContent;
+    }>(documents: D[]): Promise<D[]>;
+    getMetadataReferential(): Promise<MetadataReferential>;
+    /**
+     * Creates a metadata of the metadata referential, or updates its details.
+     *
+     * The mappings of a new metadata are merged into the assets, devices and groups collections
+     * of every engine. They cannot be modified afterwards: only the locales, editor hint,
+     * default value and icon of an existing metadata can change. These are copied into the models
+     * using the metadata when they are written, the existing models are not modified.
+     *
+     * @throws BadRequestError if the mappings of an existing metadata are modified
+     * @throws MappingsConflictsError if the new metadata conflicts with an inline metadata of a model
+     *  or with the actual mappings of an engine collection
+     */
+    writeMetadata(name: string, definition: MetadataReferentialEntry): Promise<MetadataReferential>;
+    /**
+     * Deletes a metadata of the metadata referential.
+     * Its mappings stay in the engines collections, Elasticsearch cannot remove them.
+     *
+     * @throws BadRequestError if a model still uses the metadata
+     */
+    deleteMetadata(name: string): Promise<MetadataReferential>;
+    /**
+     * With the referentialOnly option, rejects the inline metadata a model write adds.
+     * The inline metadata already defined by the stored model are kept (legacy).
+     *
+     * @throws BadRequestError if new inline metadata are added
+     */
+    private checkReferentialOnly;
+    /**
+     * Updates the engines collections. If Elasticsearch rejects the new mappings, the model is
+     * restored to its previous version (or deleted if it is new), otherwise every next engines
+     * update would fail on it.
+     */
+    private updateEnginesOrRestore;
+    private getStoredModel;
+    /**
+     * @throws BadRequestError if the metadata is registered from code
+     */
+    private checkUnmanagedMetadata;
 }