@researchdatabox/redbox-core 0.0.1-beta.10213 → 0.0.1-beta.10760

package/dist/services/figshare-v2/bindings.js

@@ -3,19 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ensureHandlebarsHelpersRegistered = ensureHandlebarsHelpersRegistered;
 exports.validateHandlebarsTemplate = validateHandlebarsTemplate;
+exports.resolveCrosswalkBinding = resolveCrosswalkBinding;
 exports.evaluateBinding = evaluateBinding;
 const lodash_1 = __importDefault(require("lodash"));
-const handlebars_1 = __importDefault(require("handlebars"));
 const sails_ng_common_1 = require("@researchdatabox/sails-ng-common");
-let handlebarsHelpersRegistered = false;
-function ensureHandlebarsHelpersRegistered() {
-    if (!handlebarsHelpersRegistered) {
-        (0, sails_ng_common_1.registerSharedHandlebarsHelpers)(handlebars_1.default);
-        handlebarsHelpersRegistered = true;
-    }
-}
+const categories_1 = require("./categories");
 function validateHandlebarsTemplate(template) {
     const allowedHelpers = new Set(['default', 'join', 'lower', 'upper', 'trim', 'formatDate']);
     const tagPattern = /{{{?\s*([#/!>]?)\s*([A-Za-z_][A-Za-z0-9_]*)?/g;
@@ -37,22 +30,87 @@ function validateHandlebarsTemplate(template) {
         throw new Error(`Unsupported Handlebars helper '${token}' in Figshare binding`);
     }
 }
-async function evaluateBinding(binding, record) {
+/**
+ * Resolve a crosswalk binding: evaluate its inner source for codes, then push those
+ * through the approved revision of the configured crosswalk.
+ *
+ * Returns the full resolution rather than just the values, because the categories
+ * payload has to enforce `allowUnmapped` against the historical targets.
+ */
+async function resolveCrosswalkBinding(binding, target, context) {
+    // Config arrives as JSON, so the type-level ban on nesting needs a runtime guard.
+    if (String(binding.source?.kind ?? '') === 'crosswalk') {
+        throw new Error('Figshare crosswalk bindings cannot nest another crosswalk binding');
+    }
+    const rawValue = await evaluateBinding(binding.source, target, context);
+    const sourceCodes = (0, categories_1.toSourceCodeCandidates)(rawValue);
+    if (sourceCodes.length === 0) {
+        return { values: [], sourceCodes: [], normalizedCodes: [], unresolvedCodes: [], historicalTargets: [] };
+    }
+    const brandId = String(context?.brandId ?? '').trim();
+    if (brandId === '') {
+        throw new Error('Unable to resolve the brand for Figshare crosswalk binding resolution');
+    }
+    const crosswalkId = String(binding.crosswalkId ?? '').trim();
+    const sourceVocabularyId = String(binding.sourceVocabularyId ?? '').trim();
+    if (crosswalkId === '' || sourceVocabularyId === '') {
+        throw new Error('Figshare crosswalk bindings require both a source vocabulary and an approved crosswalk');
+    }
+    // Reached through the sails global rather than an import, to avoid a module cycle
+    // between this file and FigshareVocabularyService.
+    const service = (typeof FigshareVocabularyService === 'undefined'
+        ? undefined
+        : FigshareVocabularyService);
+    if (typeof service?.resolveCrosswalkValues !== 'function') {
+        throw new Error('FigshareVocabularyService.resolveCrosswalkValues is unavailable');
+    }
+    const resolution = await service.resolveCrosswalkValues({
+        brandId,
+        crosswalkId,
+        sourceVocabularyId,
+        codes: sourceCodes,
+        // `||` not `??`: an unset select in the config editor arrives as an empty string.
+        outputs: binding.outputs || 'categoryId'
+    });
+    return { ...resolution, sourceCodes };
+}
+/**
+ * Evaluate a binding against `target`. `context` carries ambient information such
+ * as the brand, which the crosswalk kind needs and which `target` may not hold —
+ * author lookup rules evaluate against a contributor object, not the record.
+ */
+async function evaluateBinding(binding, target, context) {
     if (binding == null) {
         return undefined;
     }
     if (binding.kind === 'path') {
-        const value = lodash_1.default.get(record, binding.path, binding.defaultValue);
+        const value = lodash_1.default.get(target, binding.path, binding.defaultValue);
         return value ?? binding.defaultValue;
     }
     if (binding.kind === 'handlebars') {
-        ensureHandlebarsHelpersRegistered();
         validateHandlebarsTemplate(binding.template);
-        const compiled = handlebars_1.default.compile(binding.template);
-        const value = compiled(record);
+        const compiled = (0, sails_ng_common_1.handlebarsCompile)(binding.template);
+        const value = compiled(target);
         return value === '' ? binding.defaultValue : value;
     }
-    const value = await (0, sails_ng_common_1.jsonataCompileAndEvaluate)(binding.expression, record);
-    return value ?? binding.defaultValue;
+    if (binding.kind === 'jsonata') {
+        const value = await (0, sails_ng_common_1.jsonataCompileAndEvaluate)(binding.expression, target);
+        return value ?? binding.defaultValue;
+    }
+    if (binding.kind === 'crosswalk') {
+        const resolution = await resolveCrosswalkBinding(binding, target, context);
+        // Outside the categories payload there is nowhere to surface these, and they
+        // must not silently vanish.
+        if (resolution.historicalTargets.length > 0) {
+            sails.log.warn(`Figshare crosswalk binding omitted historical targets: ${resolution.historicalTargets
+                .map((historicalTarget) => `${historicalTarget.code} → ${historicalTarget.sourceId}`)
+                .join(', ')}`);
+        }
+        if (resolution.unresolvedCodes.length > 0) {
+            sails.log.warn(`Figshare crosswalk binding could not resolve: ${resolution.unresolvedCodes.join(', ')}`);
+        }
+        return resolution.values.length > 0 ? resolution.values : binding.defaultValue;
+    }
+    throw new Error(`Unsupported Figshare binding kind '${String(binding.kind)}'`);
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmluZGluZ3MuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvc2VydmljZXMvZmlnc2hhcmUtdjIvYmluZGluZ3MudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFRQSw4RUFLQztBQUVELGdFQW9CQztBQUVELDBDQXFCQztBQTFERCxvREFBdUI7QUFDdkIsNERBQW9DO0FBQ3BDLHNFQUE0RztBQUk1RyxJQUFJLDJCQUEyQixHQUFHLEtBQUssQ0FBQztBQUV4QyxTQUFnQixpQ0FBaUM7SUFDL0MsSUFBSSxDQUFDLDJCQUEyQixFQUFFLENBQUM7UUFDakMsSUFBQSxpREFBK0IsRUFBQyxvQkFBVSxDQUFDLENBQUM7UUFDNUMsMkJBQTJCLEdBQUcsSUFBSSxDQUFDO0lBQ3JDLENBQUM7QUFDSCxDQUFDO0FBRUQsU0FBZ0IsMEJBQTBCLENBQUMsUUFBZ0I7SUFDekQsTUFBTSxjQUFjLEdBQUcsSUFBSSxHQUFHLENBQUMsQ0FBQyxTQUFTLEVBQUUsTUFBTSxFQUFFLE9BQU8sRUFBRSxPQUFPLEVBQUUsTUFBTSxFQUFFLFlBQVksQ0FBQyxDQUFDLENBQUM7SUFDNUYsTUFBTSxVQUFVLEdBQUcsK0NBQStDLENBQUM7SUFDbkUsSUFBSSxLQUE2QixDQUFDO0lBQ2xDLE9BQU8sQ0FBQyxLQUFLLEdBQUcsVUFBVSxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUMsQ0FBQyxJQUFJLElBQUksRUFBRSxDQUFDO1FBQ25ELE1BQU0sS0FBSyxHQUFHLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUN2QixNQUFNLEtBQUssR0FBRyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDdkIsSUFBSSxLQUFLLEtBQUssR0FBRyxJQUFJLEtBQUssS0FBSyxHQUFHLElBQUksQ0FBQyxLQUFLLEVBQUUsQ0FBQztZQUM3QyxTQUFTO1FBQ1gsQ0FBQztRQUNELElBQUksS0FBSyxLQUFLLEdBQUcsRUFBRSxDQUFDO1lBQ2xCLE1BQU0sSUFBSSxLQUFLLENBQUMsd0NBQXdDLEtBQUssdUJBQXVCLENBQUMsQ0FBQztRQUN4RixDQUFDO1FBQ0QsTUFBTSxVQUFVLEdBQUcsUUFBUSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsU0FBUyxDQUFDLENBQUMsU0FBUyxFQUFFLENBQUM7UUFDcEUsTUFBTSxjQUFjLEdBQUcsVUFBVSxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsSUFBSSxVQUFVLENBQUMsVUFBVSxDQUFDLEtBQUssQ0FBQyxJQUFJLFVBQVUsQ0FBQyxVQUFVLENBQUMsR0FBRyxDQUFDLENBQUM7UUFDakgsSUFBSSxjQUFjLElBQUksY0FBYyxDQUFDLEdBQUcsQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDO1lBQ2hELFNBQVM7UUFDWCxDQUFDO1FBQ0QsTUFBTSxJQUFJLEtBQUssQ0FBQyxrQ0FBa0MsS0FBSyx1QkFBdUIsQ0FBQyxDQUFDO0lBQ2xGLENBQUM7QUFDSCxDQUFDO0FBRU0sS0FBSyxVQUFVLGVBQWUsQ0FBQyxPQUFpQyxFQUFFLE1BQWlCO0lBQ3hGLElBQUksT0FBTyxJQUFJLElBQUksRUFBRSxDQUFDO1FBQ3BCLE9BQU8sU0FBUyxDQUFDO0lBQ25CLENBQUM7SUFFRCxJQUFJLE9BQU8sQ0FBQyxJQUFJLEtBQUssTUFBTSxFQUFFLENBQUM7UUFDNUIsTUFBTSxLQUFLLEdBQUcsZ0JBQUMsQ0FBQyxHQUFHLENBQUMsTUFBTSxFQUFFLE9BQU8sQ0FBQyxJQUFJLEVBQUUsT0FBTyxDQUFDLFlBQVksQ0FBQyxDQUFDO1FBQ2hFLE9BQU8sS0FBSyxJQUFJLE9BQU8sQ0FBQyxZQUFZLENBQUM7SUFDdkMsQ0FBQztJQUVELElBQUksT0FBTyxDQUFDLElBQUksS0FBSyxZQUFZLEVBQUUsQ0FBQztRQUNsQyxpQ0FBaUMsRUFBRSxDQUFDO1FBQ3BDLDBCQUEwQixDQUFDLE9BQU8sQ0FBQyxRQUFRLENBQUMsQ0FBQztRQUM3QyxNQUFNLFFBQVEsR0FBRyxvQkFBVSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsUUFBUSxDQUFDLENBQUM7UUFDdEQsTUFBTSxLQUFLLEdBQUcsUUFBUSxDQUFDLE1BQU0sQ0FBQyxDQUFDO1FBQy9CLE9BQU8sS0FBSyxLQUFLLEVBQUUsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLFlBQVksQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDO0lBQ3JELENBQUM7SUFFRCxNQUFNLEtBQUssR0FBRyxNQUFNLElBQUEsMkNBQXlCLEVBQUMsT0FBTyxDQUFDLFVBQVUsRUFBRSxNQUFNLENBQUMsQ0FBQztJQUUxRSxPQUFPLEtBQUssSUFBSSxPQUFPLENBQUMsWUFBWSxDQUFDO0FBQ3ZDLENBQUMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmluZGluZ3MuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvc2VydmljZXMvZmlnc2hhcmUtdjIvYmluZGluZ3MudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFnQ0EsZ0VBb0JDO0FBU0QsMERBOENDO0FBT0QsMENBNENDO0FBOUpELG9EQUF1QjtBQUN2QixzRUFBOEY7QUFJOUYsNkNBQXNEO0FBMkJ0RCxTQUFnQiwwQkFBMEIsQ0FBQyxRQUFnQjtJQUN6RCxNQUFNLGNBQWMsR0FBRyxJQUFJLEdBQUcsQ0FBQyxDQUFDLFNBQVMsRUFBRSxNQUFNLEVBQUUsT0FBTyxFQUFFLE9BQU8sRUFBRSxNQUFNLEVBQUUsWUFBWSxDQUFDLENBQUMsQ0FBQztJQUM1RixNQUFNLFVBQVUsR0FBRywrQ0FBK0MsQ0FBQztJQUNuRSxJQUFJLEtBQTZCLENBQUM7SUFDbEMsT0FBTyxDQUFDLEtBQUssR0FBRyxVQUFVLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxDQUFDLElBQUksSUFBSSxFQUFFLENBQUM7UUFDbkQsTUFBTSxLQUFLLEdBQUcsS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDO1FBQ3ZCLE1BQU0sS0FBSyxHQUFHLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUN2QixJQUFJLEtBQUssS0FBSyxHQUFHLElBQUksS0FBSyxLQUFLLEdBQUcsSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDO1lBQzdDLFNBQVM7UUFDWCxDQUFDO1FBQ0QsSUFBSSxLQUFLLEtBQUssR0FBRyxFQUFFLENBQUM7WUFDbEIsTUFBTSxJQUFJLEtBQUssQ0FBQyx3Q0FBd0MsS0FBSyx1QkFBdUIsQ0FBQyxDQUFDO1FBQ3hGLENBQUM7UUFDRCxNQUFNLFVBQVUsR0FBRyxRQUFRLENBQUMsS0FBSyxDQUFDLFVBQVUsQ0FBQyxTQUFTLENBQUMsQ0FBQyxTQUFTLEVBQUUsQ0FBQztRQUNwRSxNQUFNLGNBQWMsR0FBRyxVQUFVLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxJQUFJLFVBQVUsQ0FBQyxVQUFVLENBQUMsS0FBSyxDQUFDLElBQUksVUFBVSxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUNqSCxJQUFJLGNBQWMsSUFBSSxjQUFjLENBQUMsR0FBRyxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQUM7WUFDaEQsU0FBUztRQUNYLENBQUM7UUFDRCxNQUFNLElBQUksS0FBSyxDQUFDLGtDQUFrQyxLQUFLLHVCQUF1QixDQUFDLENBQUM7SUFDbEYsQ0FBQztBQUNILENBQUM7QUFFRDs7Ozs7O0dBTUc7QUFDSSxLQUFLLFVBQVUsdUJBQXVCLENBQzNDLE9BQXlCLEVBQ3pCLE1BQWlCLEVBQ2pCLE9BQXdCO0lBRXhCLGtGQUFrRjtJQUNsRixJQUFJLE1BQU0sQ0FBRSxPQUFPLENBQUMsTUFBeUMsRUFBRSxJQUFJLElBQUksRUFBRSxDQUFDLEtBQUssV0FBVyxFQUFFLENBQUM7UUFDM0YsTUFBTSxJQUFJLEtBQUssQ0FBQyxtRUFBbUUsQ0FBQyxDQUFDO0lBQ3ZGLENBQUM7SUFFRCxNQUFNLFFBQVEsR0FBRyxNQUFNLGVBQWUsQ0FBQyxPQUFPLENBQUMsTUFBTSxFQUFFLE1BQU0sRUFBRSxPQUFPLENBQUMsQ0FBQztJQUN4RSxNQUFNLFdBQVcsR0FBRyxJQUFBLG1DQUFzQixFQUFDLFFBQVEsQ0FBQyxDQUFDO0lBQ3JELElBQUksV0FBVyxDQUFDLE1BQU0sS0FBSyxDQUFDLEVBQUUsQ0FBQztRQUM3QixPQUFPLEVBQUUsTUFBTSxFQUFFLEVBQUUsRUFBRSxXQUFXLEVBQUUsRUFBRSxFQUFFLGVBQWUsRUFBRSxFQUFFLEVBQUUsZUFBZSxFQUFFLEVBQUUsRUFBRSxpQkFBaUIsRUFBRSxFQUFFLEVBQUUsQ0FBQztJQUMxRyxDQUFDO0lBRUQsTUFBTSxPQUFPLEdBQUcsTUFBTSxDQUFDLE9BQU8sRUFBRSxPQUFPLElBQUksRUFBRSxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUM7SUFDdEQsSUFBSSxPQUFPLEtBQUssRUFBRSxFQUFFLENBQUM7UUFDbkIsTUFBTSxJQUFJLEtBQUssQ0FBQyx1RUFBdUUsQ0FBQyxDQUFDO0lBQzNGLENBQUM7SUFFRCxNQUFNLFdBQVcsR0FBRyxNQUFNLENBQUMsT0FBTyxDQUFDLFdBQVcsSUFBSSxFQUFFLENBQUMsQ0FBQyxJQUFJLEVBQUUsQ0FBQztJQUM3RCxNQUFNLGtCQUFrQixHQUFHLE1BQU0sQ0FBQyxPQUFPLENBQUMsa0JBQWtCLElBQUksRUFBRSxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUM7SUFDM0UsSUFBSSxXQUFXLEtBQUssRUFBRSxJQUFJLGtCQUFrQixLQUFLLEVBQUUsRUFBRSxDQUFDO1FBQ3BELE1BQU0sSUFBSSxLQUFLLENBQUMsd0ZBQXdGLENBQUMsQ0FBQztJQUM1RyxDQUFDO0lBRUQsa0ZBQWtGO0lBQ2xGLG1EQUFtRDtJQUNuRCxNQUFNLE9BQU8sR0FBRyxDQUFDLE9BQU8seUJBQXlCLEtBQUssV0FBVztRQUMvRCxDQUFDLENBQUMsU0FBUztRQUNYLENBQUMsQ0FBQyx5QkFBeUIsQ0FBa0MsQ0FBQztJQUNoRSxJQUFJLE9BQU8sT0FBTyxFQUFFLHNCQUFzQixLQUFLLFVBQVUsRUFBRSxDQUFDO1FBQzFELE1BQU0sSUFBSSxLQUFLLENBQUMsaUVBQWlFLENBQUMsQ0FBQztJQUNyRixDQUFDO0lBRUQsTUFBTSxVQUFVLEdBQUcsTUFBTSxPQUFPLENBQUMsc0JBQXNCLENBQUM7UUFDdEQsT0FBTztRQUNQLFdBQVc7UUFDWCxrQkFBa0I7UUFDbEIsS0FBSyxFQUFFLFdBQVc7UUFDbEIsa0ZBQWtGO1FBQ2xGLE9BQU8sRUFBRSxPQUFPLENBQUMsT0FBTyxJQUFJLFlBQVk7S0FDekMsQ0FBQyxDQUFDO0lBRUgsT0FBTyxFQUFFLEdBQUcsVUFBVSxFQUFFLFdBQVcsRUFBRSxDQUFDO0FBQ3hDLENBQUM7QUFFRDs7OztHQUlHO0FBQ0ksS0FBSyxVQUFVLGVBQWUsQ0FDbkMsT0FBaUMsRUFDakMsTUFBaUIsRUFDakIsT0FBd0I7SUFFeEIsSUFBSSxPQUFPLElBQUksSUFBSSxFQUFFLENBQUM7UUFDcEIsT0FBTyxTQUFTLENBQUM7SUFDbkIsQ0FBQztJQUVELElBQUksT0FBTyxDQUFDLElBQUksS0FBSyxNQUFNLEVBQUUsQ0FBQztRQUM1QixNQUFNLEtBQUssR0FBRyxnQkFBQyxDQUFDLEdBQUcsQ0FBQyxNQUFNLEVBQUUsT0FBTyxDQUFDLElBQUksRUFBRSxPQUFPLENBQUMsWUFBWSxDQUFDLENBQUM7UUFDaEUsT0FBTyxLQUFLLElBQUksT0FBTyxDQUFDLFlBQVksQ0FBQztJQUN2QyxDQUFDO0lBRUQsSUFBSSxPQUFPLENBQUMsSUFBSSxLQUFLLFlBQVksRUFBRSxDQUFDO1FBQ2xDLDBCQUEwQixDQUFDLE9BQU8sQ0FBQyxRQUFRLENBQUMsQ0FBQztRQUM3QyxNQUFNLFFBQVEsR0FBRyxJQUFBLG1DQUFpQixFQUFDLE9BQU8sQ0FBQyxRQUFRLENBQUMsQ0FBQztRQUNyRCxNQUFNLEtBQUssR0FBRyxRQUFRLENBQUMsTUFBTSxDQUFDLENBQUM7UUFDL0IsT0FBTyxLQUFLLEtBQUssRUFBRSxDQUFDLENBQUMsQ0FBQyxPQUFPLENBQUMsWUFBWSxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUM7SUFDckQsQ0FBQztJQUVELElBQUksT0FBTyxDQUFDLElBQUksS0FBSyxTQUFTLEVBQUUsQ0FBQztRQUMvQixNQUFNLEtBQUssR0FBRyxNQUFNLElBQUEsMkNBQXlCLEVBQUMsT0FBTyxDQUFDLFVBQVUsRUFBRSxNQUFNLENBQUMsQ0FBQztRQUMxRSxPQUFPLEtBQUssSUFBSSxPQUFPLENBQUMsWUFBWSxDQUFDO0lBQ3ZDLENBQUM7SUFFRCxJQUFJLE9BQU8sQ0FBQyxJQUFJLEtBQUssV0FBVyxFQUFFLENBQUM7UUFDakMsTUFBTSxVQUFVLEdBQUcsTUFBTSx1QkFBdUIsQ0FBQyxPQUFPLEVBQUUsTUFBTSxFQUFFLE9BQU8sQ0FBQyxDQUFDO1FBQzNFLDZFQUE2RTtRQUM3RSw0QkFBNEI7UUFDNUIsSUFBSSxVQUFVLENBQUMsaUJBQWlCLENBQUMsTUFBTSxHQUFHLENBQUMsRUFBRSxDQUFDO1lBQzVDLEtBQUssQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUNaLDBEQUEwRCxVQUFVLENBQUMsaUJBQWlCO2lCQUNuRixHQUFHLENBQUMsQ0FBQyxnQkFBZ0IsRUFBRSxFQUFFLENBQUMsR0FBRyxnQkFBZ0IsQ0FBQyxJQUFJLE1BQU0sZ0JBQWdCLENBQUMsUUFBUSxFQUFFLENBQUM7aUJBQ3BGLElBQUksQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUNoQixDQUFDO1FBQ0osQ0FBQztRQUNELElBQUksVUFBVSxDQUFDLGVBQWUsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxFQUFFLENBQUM7WUFDMUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsaURBQWlELFVBQVUsQ0FBQyxlQUFlLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQztRQUMzRyxDQUFDO1FBQ0QsT0FBTyxVQUFVLENBQUMsTUFBTSxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDLFVBQVUsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxZQUFZLENBQUM7SUFDakYsQ0FBQztJQUVELE1BQU0sSUFBSSxLQUFLLENBQUMsc0NBQXNDLE1BQU0sQ0FBRSxPQUE4QixDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztBQUN6RyxDQUFDIn0=

package/dist/services/figshare-v2/categories.d.ts

@@ -0,0 +1,142 @@
+/**
+ * Bumped whenever normalisation or proposal rules change so that stored sync runs
+ * remain reproducible and comparable.
+ */
+export declare const FIGSHARE_NORMALIZER_VERSION = "1";
+/** Guard rails that keep a preview inside Mongo's document size limit. */
+export declare const FIGSHARE_SNAPSHOT_LIMITS: {
+    readonly maxCategories: 20000;
+    readonly maxSnapshotBytes: number;
+};
+export interface NormalizedFigshareCategory {
+    sourceId: string;
+    categoryId: number;
+    taxonomyId: string;
+    title: string;
+    parentSourceId: string | null;
+    path: string[];
+    selectable: boolean;
+    hasChildren: boolean;
+    contentHash: string;
+}
+export interface FigshareNormalizationWarning {
+    code: 'missing-parent' | 'cycle-detected' | 'missing-taxonomy';
+    sourceId: string;
+    detail: string;
+}
+export interface FigshareNormalizationResult {
+    rows: NormalizedFigshareCategory[];
+    warnings: FigshareNormalizationWarning[];
+}
+export interface FigshareTaxonomySummary {
+    taxonomyId: string;
+    title: string;
+    categoryCount: number;
+    selectableCount: number;
+    missingParentCount: number;
+}
+export type FigshareChangeClass = 'added' | 'changed' | 'removed' | 'reappeared' | 'unchanged';
+export interface FigshareDiffRow {
+    changeClass: FigshareChangeClass;
+    sourceId: string;
+    title: string;
+    categoryId?: number;
+    previousCategoryId?: number;
+    previousTitle?: string;
+}
+export interface FigshareDiffSummary {
+    added: number;
+    changed: number;
+    removed: number;
+    reappeared: number;
+    unchanged: number;
+}
+export interface FigshareDiffResult {
+    rows: FigshareDiffRow[];
+    summary: FigshareDiffSummary;
+}
+/** The mirror state a diff is computed against. */
+export interface ExistingMirrorCategory {
+    sourceId: string;
+    categoryId: number;
+    title: string;
+    contentHash: string;
+    historical: boolean;
+}
+export type FigshareProposalMatchType = 'exact-code' | 'identity' | 'label-suggestion' | 'manual' | 'historical';
+export interface FigshareProposal {
+    proposalId: string;
+    localEntryId: string;
+    localLabel: string;
+    localValue: string;
+    localIdentifier?: string;
+    targetSourceId: string;
+    targetCategoryId: number;
+    targetTitle: string;
+    matchType: FigshareProposalMatchType;
+    /** Exact code/identity matches arrive preselected; label suggestions never do. */
+    preselected: boolean;
+    historical: boolean;
+    evidence: Record<string, unknown>;
+}
+export interface FigshareProposalResult {
+    proposals: FigshareProposal[];
+    unresolvedLocalEntryIds: string[];
+}
+/** Local entry projection used by the matching engine. */
+export interface LocalEntryCandidate {
+    id: string;
+    label: string;
+    labelLower: string;
+    value: string;
+    valueLower: string;
+    identifier?: string;
+}
+/**
+ * Trim, drop any query string and keep the final URI/hash segment so that
+ * `http://purl.org/au-research/vocabulary/anzsrc-for/2020/300101` and `300101`
+ * compare equal.
+ */
+export declare function normalizeCategoryCode(value: unknown): string;
+/**
+ * Coerce the result of a categories binding into candidate code strings: arrays are
+ * flattened, and object entries are reduced through their `notation` or `code` field.
+ * No normalisation is applied — callers pick the normaliser that suits their matcher.
+ */
+export declare function toSourceCodeCandidates(value: unknown): string[];
+/** Collapse internal whitespace and normalise Unicode so labels compare stably. */
+export declare function normalizeLabel(value: unknown): string;
+/**
+ * Validate and canonicalise a raw Figshare category response.
+ *
+ * Identity is the Figshare `source_id` when present (Q-01: prefer the taxonomy code,
+ * keep the numeric id as the mutable publishing relationship), falling back to the
+ * numeric id for catalogues that omit it.
+ */
+export declare function normalizeFigshareCategories(raw: unknown): FigshareNormalizationResult;
+/** Group a normalized catalogue into the taxonomies an administrator can select. */
+export declare function groupTaxonomies(result: FigshareNormalizationResult): FigshareTaxonomySummary[];
+/** Restrict a normalized catalogue to a single taxonomy. */
+export declare function filterByTaxonomy(result: FigshareNormalizationResult, taxonomyId: string): FigshareNormalizationResult;
+/**
+ * Serialise the canonical ordered row set and hash it. The same Figshare content
+ * always produces the same hash.
+ */
+export declare function hashSnapshot(rows: readonly NormalizedFigshareCategory[]): string;
+/** Reject an over-limit snapshot before any database write. */
+export declare function assertSnapshotWithinLimits(rows: readonly NormalizedFigshareCategory[]): void;
+/** Classify remote changes against the currently mirrored categories. */
+export declare function classifyChanges(existing: readonly ExistingMirrorCategory[], snapshot: readonly NormalizedFigshareCategory[]): FigshareDiffResult;
+/**
+ * Deterministic proposal rules. Exact code and identity matches are preselected;
+ * a unique exact label match is offered but never preselected; anything ambiguous
+ * stays unresolved. No fuzzy matching is performed.
+ */
+export declare function buildProposals(localEntries: readonly LocalEntryCandidate[], snapshot: readonly NormalizedFigshareCategory[], options?: {
+    historicalSourceIds?: ReadonlySet<string>;
+}): FigshareProposalResult;
+/** Identity proposals for a freshly created clone: every entry maps to its own source term. */
+export declare function buildIdentityProposals(clonedEntries: readonly (LocalEntryCandidate & {
+    sourceId: string;
+})[], snapshot: readonly NormalizedFigshareCategory[]): FigshareProposalResult;
+//# sourceMappingURL=categories.d.ts.map

package/dist/services/figshare-v2/categories.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"categories.d.ts","sourceRoot":"","sources":["../../../src/services/figshare-v2/categories.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,eAAO,MAAM,2BAA2B,MAAM,CAAC;AAE/C,0EAA0E;AAC1E,eAAO,MAAM,wBAAwB;;;CAG3B,CAAC;AAEX,MAAM,WAAW,0BAA0B;IACzC,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,UAAU,EAAE,OAAO,CAAC;IACpB,WAAW,EAAE,OAAO,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,gBAAgB,GAAG,gBAAgB,GAAG,kBAAkB,CAAC;IAC/D,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,0BAA0B,EAAE,CAAC;IACnC,QAAQ,EAAE,4BAA4B,EAAE,CAAC;CAC1C;AAED,MAAM,WAAW,uBAAuB;IACtC,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,MAAM,mBAAmB,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,YAAY,GAAG,WAAW,CAAC;AAE/F,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,mBAAmB,CAAC;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,eAAe,EAAE,CAAC;IACxB,OAAO,EAAE,mBAAmB,CAAC;CAC9B;AAED,mDAAmD;AACnD,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,MAAM,yBAAyB,GAAG,YAAY,GAAG,UAAU,GAAG,kBAAkB,GAAG,QAAQ,GAAG,YAAY,CAAC;AAEjH,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,yBAAyB,CAAC;IACrC,kFAAkF;IAClF,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,gBAAgB,EAAE,CAAC;IAC9B,uBAAuB,EAAE,MAAM,EAAE,CAAC;CACnC;AAED,0DAA0D;AAC1D,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAS5D;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,EAAE,CAa/D;AAED,mFAAmF;AACnF,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAErD;AAwBD;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CAAC,GAAG,EAAE,OAAO,GAAG,2BAA2B,CA2IrF;AAED,oFAAoF;AACpF,wBAAgB,eAAe,CAC7B,MAAM,EAAE,2BAA2B,GAClC,uBAAuB,EAAE,CAyB3B;AAED,4DAA4D;AAC5D,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,2BAA2B,EACnC,UAAU,EAAE,MAAM,GACjB,2BAA2B,CAQ7B;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,SAAS,0BAA0B,EAAE,GAAG,MAAM,CAIhF;AAED,+DAA+D;AAC/D,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,SAAS,0BAA0B,EAAE,GAAG,IAAI,CAY5F;AAED,yEAAyE;AACzE,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,SAAS,sBAAsB,EAAE,EAC3C,QAAQ,EAAE,SAAS,0BAA0B,EAAE,GAC9C,kBAAkB,CAyDpB;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,YAAY,EAAE,SAAS,mBAAmB,EAAE,EAC5C,QAAQ,EAAE,SAAS,0BAA0B,EAAE,EAC/C,OAAO,GAAE;IAAE,mBAAmB,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CAAO,GAC1D,sBAAsB,CAwExB;AAED,+FAA+F;AAC/F,wBAAgB,sBAAsB,CACpC,aAAa,EAAE,SAAS,CAAC,mBAAmB,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,EAAE,EACtE,QAAQ,EAAE,SAAS,0BAA0B,EAAE,GAC9C,sBAAsB,CA4BxB"}