@longsightgroup/qti3-player 0.4.0 → 0.5.4

package/dist/player-message-catalog-validate.js

@@ -0,0 +1,327 @@
+import { defaultPlayerMessageCatalog } from "./player-message-catalog-default.js";
+import { extractMessagePlaceholders } from "./player-message-catalog.js";
+import { PLAYER_MESSAGE_MANIFEST, } from "./player-message-manifest.js";
+const MANIFEST_KEYS = new Set(PLAYER_MESSAGE_MANIFEST.map((entry) => entry.key));
+const MANIFEST_BY_KEY = new Map(PLAYER_MESSAGE_MANIFEST.map((entry) => [entry.key, entry]));
+const AUXILIARY_STRING_KEYS = new Set([
+    "characterUnit.one",
+    "characterUnit.other",
+    "wordUnit.one",
+    "wordUnit.other",
+]);
+const VALID_DIRECTION_KEYS = new Set(["up", "down", "left", "right"]);
+function isPlainObject(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function isNonEmptyString(value) {
+    return typeof value === "string";
+}
+function pushDiagnostic(diagnostics, diagnostic) {
+    diagnostics.push(diagnostic);
+}
+function isManifestStringKey(key) {
+    if (MANIFEST_KEYS.has(key))
+        return true;
+    if (AUXILIARY_STRING_KEYS.has(key))
+        return true;
+    const pluralMatch = /^(.+)\.(one|other)$/.exec(key);
+    if (pluralMatch && MANIFEST_KEYS.has(pluralMatch[1])) {
+        return MANIFEST_BY_KEY.get(pluralMatch[1])?.resolver === "plural";
+    }
+    return false;
+}
+/** Placeholders a host may use for a manifest entry (superset of manifest params). */
+export function allowedCatalogPlaceholders(entry) {
+    switch (entry.resolver) {
+        case "plain":
+        case "typeLabel":
+            return [];
+        case "template":
+        case "plural":
+        case "directionTemplate":
+            return entry.params ?? [];
+        case "typeTemplate":
+            return [...(entry.params?.filter((name) => name !== "type") ?? []), "typeName"];
+        case "extendedTextCounter":
+            return ["characters", "words", "characterUnit", "wordUnit"];
+        default:
+            return [];
+    }
+}
+/**
+ * Placeholders a host template must include for a catalog string key.
+ * Uses the English default for that key when present; otherwise no placeholders are required.
+ * Manifest `params` bound required fields for resolvers that inject extra values at runtime
+ * (e.g. `extendedTextCounter` supplies `{characterUnit}` / `{wordUnit}` even when omitted).
+ */
+export function requiredCatalogPlaceholders(catalogKey, entry) {
+    const manifestEntry = entry ?? manifestEntryForStringKey(catalogKey);
+    if (!manifestEntry) {
+        return [];
+    }
+    const allowed = new Set(allowedCatalogPlaceholders(manifestEntry));
+    const defaultTemplate = defaultPlayerMessageCatalog.strings[catalogKey];
+    const fromDefault = defaultTemplate
+        ? extractMessagePlaceholders(defaultTemplate).filter((name) => allowed.has(name))
+        : [];
+    if (manifestEntry.resolver === "extendedTextCounter") {
+        return (manifestEntry.params ?? []).filter((name) => allowed.has(name));
+    }
+    if (fromDefault.length > 0) {
+        return fromDefault;
+    }
+    return [];
+}
+function validateTemplate(key, template, entry, diagnostics) {
+    if (!template.trim()) {
+        pushDiagnostic(diagnostics, {
+            code: "empty-template",
+            key,
+            severity: "error",
+            message: `Message "${key}" is empty.`,
+        });
+        return;
+    }
+    const allowed = new Set(allowedCatalogPlaceholders(entry));
+    const actual = extractMessagePlaceholders(template);
+    const required = requiredCatalogPlaceholders(key, entry);
+    for (const placeholder of actual) {
+        if (!allowed.has(placeholder)) {
+            pushDiagnostic(diagnostics, {
+                code: "unknown-placeholder",
+                key,
+                severity: "error",
+                message: `Message "${key}" uses unknown placeholder "{${placeholder}}". Allowed: ${[...allowed].join(", ") || "(none)"}.`,
+            });
+        }
+    }
+    for (const placeholder of required) {
+        if (!actual.includes(placeholder)) {
+            pushDiagnostic(diagnostics, {
+                code: "missing-placeholder",
+                key,
+                severity: "error",
+                message: `Message "${key}" is missing required placeholder "{${placeholder}}" (required by English default for this key).`,
+            });
+        }
+    }
+}
+function manifestEntryForStringKey(key) {
+    const pluralMatch = /^(.+)\.(one|other)$/.exec(key);
+    const baseKey = (pluralMatch?.[1] ?? key);
+    return MANIFEST_BY_KEY.get(baseKey);
+}
+function normalizeCatalogInput(input, diagnostics) {
+    if (!isPlainObject(input)) {
+        pushDiagnostic(diagnostics, {
+            code: "invalid-catalog-root",
+            key: "(root)",
+            severity: "error",
+            message: "Player message catalog must be a JSON object.",
+        });
+        return null;
+    }
+    const normalized = {
+        strings: {},
+        interactionTypes: {},
+        directions: {},
+    };
+    if ("locale" in input) {
+        if (input.locale === undefined) {
+            // omit
+        }
+        else if (!isNonEmptyString(input.locale)) {
+            pushDiagnostic(diagnostics, {
+                code: "invalid-catalog-field",
+                key: "locale",
+                severity: "error",
+                message: "Catalog locale must be a string when provided.",
+            });
+        }
+        else {
+            normalized.locale = input.locale;
+        }
+    }
+    if (!("strings" in input) || input.strings === undefined) {
+        pushDiagnostic(diagnostics, {
+            code: "invalid-strings-field",
+            key: "strings",
+            severity: "error",
+            message: 'Catalog must include a "strings" object.',
+        });
+    }
+    else if (!isPlainObject(input.strings)) {
+        pushDiagnostic(diagnostics, {
+            code: "invalid-strings-field",
+            key: "strings",
+            severity: "error",
+            message: 'Catalog "strings" must be an object mapping message ids to template strings.',
+        });
+    }
+    else {
+        for (const [key, value] of Object.entries(input.strings)) {
+            if (!isNonEmptyString(value)) {
+                pushDiagnostic(diagnostics, {
+                    code: "invalid-string-value",
+                    key,
+                    severity: "error",
+                    message: `Catalog strings["${key}"] must be a string.`,
+                });
+                continue;
+            }
+            normalized.strings[key] = value;
+        }
+    }
+    if ("interactionTypes" in input && input.interactionTypes !== undefined) {
+        if (!isPlainObject(input.interactionTypes)) {
+            pushDiagnostic(diagnostics, {
+                code: "invalid-interaction-types-field",
+                key: "interactionTypes",
+                severity: "error",
+                message: 'Catalog "interactionTypes" must be an object mapping interaction type ids to labels.',
+            });
+        }
+        else {
+            for (const [typeId, label] of Object.entries(input.interactionTypes)) {
+                if (!isNonEmptyString(label)) {
+                    pushDiagnostic(diagnostics, {
+                        code: "invalid-interaction-type-value",
+                        key: typeId,
+                        severity: "error",
+                        message: `Catalog interactionTypes["${typeId}"] must be a string.`,
+                    });
+                    continue;
+                }
+                normalized.interactionTypes[typeId] = label;
+            }
+        }
+    }
+    if ("directions" in input && input.directions !== undefined) {
+        if (!isPlainObject(input.directions)) {
+            pushDiagnostic(diagnostics, {
+                code: "invalid-directions-field",
+                key: "directions",
+                severity: "error",
+                message: 'Catalog "directions" must be an object mapping direction ids to labels.',
+            });
+        }
+        else {
+            for (const [direction, label] of Object.entries(input.directions)) {
+                if (!VALID_DIRECTION_KEYS.has(direction)) {
+                    pushDiagnostic(diagnostics, {
+                        code: "invalid-direction-key",
+                        key: direction,
+                        severity: "error",
+                        message: `Unknown direction key "${direction}". Use up, down, left, or right.`,
+                    });
+                    continue;
+                }
+                if (!isNonEmptyString(label)) {
+                    pushDiagnostic(diagnostics, {
+                        code: "invalid-direction-value",
+                        key: direction,
+                        severity: "error",
+                        message: `Catalog directions["${direction}"] must be a string.`,
+                    });
+                    continue;
+                }
+                normalized.directions[direction] = label;
+            }
+        }
+    }
+    for (const field of Object.keys(input)) {
+        if (field === "locale" ||
+            field === "strings" ||
+            field === "interactionTypes" ||
+            field === "directions") {
+            continue;
+        }
+        pushDiagnostic(diagnostics, {
+            code: "invalid-catalog-field",
+            key: field,
+            severity: "error",
+            message: `Unknown catalog field "${field}".`,
+        });
+    }
+    return normalized;
+}
+function validateNormalizedCatalog(catalog, options, diagnostics) {
+    const strings = catalog.strings;
+    for (const key of Object.keys(strings)) {
+        if (!isManifestStringKey(key)) {
+            pushDiagnostic(diagnostics, {
+                code: "unknown-string-key",
+                key,
+                severity: "error",
+                message: `Unknown catalog string key "${key}". See PLAYER_MESSAGE_KEYS.`,
+            });
+            continue;
+        }
+        const entry = manifestEntryForStringKey(key);
+        const template = strings[key];
+        if (!entry || template === undefined)
+            continue;
+        validateTemplate(key, template, entry, diagnostics);
+    }
+    if (options.requireAllKeys) {
+        for (const entry of PLAYER_MESSAGE_MANIFEST) {
+            const hasBase = strings[entry.key] !== undefined;
+            const hasPlural = entry.resolver === "plural" &&
+                (strings[`${entry.key}.one`] !== undefined || strings[`${entry.key}.other`] !== undefined);
+            if (entry.resolver === "typeLabel") {
+                continue;
+            }
+            if (entry.resolver === "plural") {
+                if (!hasBase && !hasPlural) {
+                    pushDiagnostic(diagnostics, {
+                        code: "missing-message-key",
+                        key: entry.key,
+                        severity: "error",
+                        message: `Missing message "${entry.key}" (or "${entry.key}.one" / "${entry.key}.other").`,
+                    });
+                }
+                if (!strings[`${entry.key}.one`] &&
+                    defaultPlayerMessageCatalog.strings[`${entry.key}.one`]) {
+                    pushDiagnostic(diagnostics, {
+                        code: "missing-plural-form",
+                        key: `${entry.key}.one`,
+                        severity: "warning",
+                        message: `Missing plural form "${entry.key}.one". English fallback will be used.`,
+                    });
+                }
+                if (!strings[`${entry.key}.other`] &&
+                    defaultPlayerMessageCatalog.strings[`${entry.key}.other`]) {
+                    pushDiagnostic(diagnostics, {
+                        code: "missing-plural-form",
+                        key: `${entry.key}.other`,
+                        severity: "warning",
+                        message: `Missing plural form "${entry.key}.other". English fallback will be used.`,
+                    });
+                }
+            }
+            else if (!hasBase) {
+                pushDiagnostic(diagnostics, {
+                    code: "missing-message-key",
+                    key: entry.key,
+                    severity: "error",
+                    message: `Missing message "${entry.key}".`,
+                });
+            }
+        }
+    }
+}
+/**
+ * Validates host player chrome JSON against {@link PLAYER_MESSAGE_MANIFEST}.
+ * Accepts raw `JSON.parse` output (`unknown`); returns structured diagnostics instead of throwing.
+ */
+export function validatePlayerMessageCatalog(catalog, options = {}) {
+    const diagnostics = [];
+    const normalized = normalizeCatalogInput(catalog, diagnostics);
+    if (!normalized) {
+        return { valid: false, diagnostics };
+    }
+    validateNormalizedCatalog(normalized, options, diagnostics);
+    const errors = diagnostics.filter((item) => item.severity === "error");
+    return { valid: errors.length === 0, diagnostics };
+}
+//# sourceMappingURL=player-message-catalog-validate.js.map

package/dist/player-message-catalog-validate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"player-message-catalog-validate.js","sourceRoot":"","sources":["../src/player-message-catalog-validate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAC;AAClF,OAAO,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAC;AACzE,OAAO,EACL,uBAAuB,GAGxB,MAAM,8BAA8B,CAAC;AAqCtC,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;AACjF,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AAE5F,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAC;IACpC,mBAAmB;IACnB,qBAAqB;IACrB,cAAc;IACd,gBAAgB;CACjB,CAAC,CAAC;AAEH,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAA6B,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AASlG,SAAS,aAAa,CAAC,KAAc;IACnC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAc;IACtC,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC;AACnC,CAAC;AAED,SAAS,cAAc,CACrB,WAA6C,EAC7C,UAA0C;IAE1C,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;AAC/B,CAAC;AAED,SAAS,mBAAmB,CAAC,GAAW;IACtC,IAAI,aAAa,CAAC,GAAG,CAAC,GAAuB,CAAC;QAAE,OAAO,IAAI,CAAC;IAC5D,IAAI,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IAChD,MAAM,WAAW,GAAG,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,IAAI,WAAW,IAAI,aAAa,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAqB,CAAC,EAAE,CAAC;QACzE,OAAO,eAAe,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAqB,CAAC,EAAE,QAAQ,KAAK,QAAQ,CAAC;IACxF,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,sFAAsF;AACtF,MAAM,UAAU,0BAA0B,CAAC,KAAiC;IAC1E,QAAQ,KAAK,CAAC,QAAQ,EAAE,CAAC;QACvB,KAAK,OAAO,CAAC;QACb,KAAK,WAAW;YACd,OAAO,EAAE,CAAC;QACZ,KAAK,UAAU,CAAC;QAChB,KAAK,QAAQ,CAAC;QACd,KAAK,mBAAmB;YACtB,OAAO,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC;QAC5B,KAAK,cAAc;YACjB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC;QAClF,KAAK,qBAAqB;YACxB,OAAO,CAAC,YAAY,EAAE,OAAO,EAAE,eAAe,EAAE,UAAU,CAAC,CAAC;QAC9D;YACE,OAAO,EAAE,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CACzC,UAAkB,EAClB,KAAkC;IAElC,MAAM,aAAa,GAAG,KAAK,IAAI,yBAAyB,CAAC,UAAU,CAAC,CAAC;IACrE,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,0BAA0B,CAAC,aAAa,CAAC,CAAC,CAAC;IACnE,MAAM,eAAe,GAAG,2BAA2B,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACxE,MAAM,WAAW,GAAG,eAAe;QACjC,CAAC,CAAC,0BAA0B,CAAC,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACjF,CAAC,CAAC,EAAE,CAAC;IAEP,IAAI,aAAa,CAAC,QAAQ,KAAK,qBAAqB,EAAE,CAAC;QACrD,OAAO,CAAC,aAAa,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,gBAAgB,CACvB,GAAW,EACX,QAAgB,EAChB,KAAiC,EACjC,WAA6C;IAE7C,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC;QACrB,cAAc,CAAC,WAAW,EAAE;YAC1B,IAAI,EAAE,gBAAgB;YACtB,GAAG;YACH,QAAQ,EAAE,OAAO;YACjB,OAAO,EAAE,YAAY,GAAG,aAAa;SACtC,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IAED,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC,CAAC;IAC3D,MAAM,MAAM,GAAG,0BAA0B,CAAC,QAAQ,CAAC,CAAC;IACpD,MAAM,QAAQ,GAAG,2BAA2B,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAEzD,KAAK,MAAM,WAAW,IAAI,MAAM,EAAE,CAAC;QACjC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;YAC9B,cAAc,CAAC,WAAW,EAAE;gBAC1B,IAAI,EAAE,qBAAqB;gBAC3B,GAAG;gBACH,QAAQ,EAAE,OAAO;gBACjB,OAAO,EAAE,YAAY,GAAG,gCAAgC,WAAW,gBAAgB,CAAC,GAAG,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,QAAQ,GAAG;aAC1H,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,KAAK,MAAM,WAAW,IAAI,QAAQ,EAAE,CAAC;QACnC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YAClC,cAAc,CAAC,WAAW,EAAE;gBAC1B,IAAI,EAAE,qBAAqB;gBAC3B,GAAG;gBACH,QAAQ,EAAE,OAAO;gBACjB,OAAO,EAAE,YAAY,GAAG,uCAAuC,WAAW,gDAAgD;aAC3H,CAAC,CAAC;QACL,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,yBAAyB,CAAC,GAAW;IAC5C,MAAM,WAAW,GAAG,qBAAqB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpD,MAAM,OAAO,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,CAAqB,CAAC;IAC9D,OAAO,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AACtC,CAAC;AAED,SAAS,qBAAqB,CAC5B,KAAc,EACd,WAA6C;IAE7C,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,cAAc,CAAC,WAAW,EAAE;YAC1B,IAAI,EAAE,sBAAsB;YAC5B,GAAG,EAAE,QAAQ;YACb,QAAQ,EAAE,OAAO;YACjB,OAAO,EAAE,+CAA+C;SACzD,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,UAAU,GAAsB;QACpC,OAAO,EAAE,EAAE;QACX,gBAAgB,EAAE,EAAE;QACpB,UAAU,EAAE,EAAE;KACf,CAAC;IAEF,IAAI,QAAQ,IAAI,KAAK,EAAE,CAAC;QACtB,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC/B,OAAO;QACT,CAAC;aAAM,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3C,cAAc,CAAC,WAAW,EAAE;gBAC1B,IAAI,EAAE,uBAAuB;gBAC7B,GAAG,EAAE,QAAQ;gBACb,QAAQ,EAAE,OAAO;gBACjB,OAAO,EAAE,gDAAgD;aAC1D,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,UAAU,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QACnC,CAAC;IACH,CAAC;IAED,IAAI,CAAC,CAAC,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACzD,cAAc,CAAC,WAAW,EAAE;YAC1B,IAAI,EAAE,uBAAuB;YAC7B,GAAG,EAAE,SAAS;YACd,QAAQ,EAAE,OAAO;YACjB,OAAO,EAAE,0CAA0C;SACpD,CAAC,CAAC;IACL,CAAC;SAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QACzC,cAAc,CAAC,WAAW,EAAE;YAC1B,IAAI,EAAE,uBAAuB;YAC7B,GAAG,EAAE,SAAS;YACd,QAAQ,EAAE,OAAO;YACjB,OAAO,EAAE,8EAA8E;SACxF,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;YACzD,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC7B,cAAc,CAAC,WAAW,EAAE;oBAC1B,IAAI,EAAE,sBAAsB;oBAC5B,GAAG;oBACH,QAAQ,EAAE,OAAO;oBACjB,OAAO,EAAE,oBAAoB,GAAG,sBAAsB;iBACvD,CAAC,CAAC;gBACH,SAAS;YACX,CAAC;YACD,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAClC,CAAC;IACH,CAAC;IAED,IAAI,kBAAkB,IAAI,KAAK,IAAI,KAAK,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;QACxE,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC;YAC3C,cAAc,CAAC,WAAW,EAAE;gBAC1B,IAAI,EAAE,iCAAiC;gBACvC,GAAG,EAAE,kBAAkB;gBACvB,QAAQ,EAAE,OAAO;gBACjB,OAAO,EACL,sFAAsF;aACzF,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,KAAK,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBACrE,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC7B,cAAc,CAAC,WAAW,EAAE;wBAC1B,IAAI,EAAE,gCAAgC;wBACtC,GAAG,EAAE,MAAM;wBACX,QAAQ,EAAE,OAAO;wBACjB,OAAO,EAAE,6BAA6B,MAAM,sBAAsB;qBACnE,CAAC,CAAC;oBACH,SAAS;gBACX,CAAC;gBACD,UAAU,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;YAC9C,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,YAAY,IAAI,KAAK,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QAC5D,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;YACrC,cAAc,CAAC,WAAW,EAAE;gBAC1B,IAAI,EAAE,0BAA0B;gBAChC,GAAG,EAAE,YAAY;gBACjB,QAAQ,EAAE,OAAO;gBACjB,OAAO,EAAE,yEAAyE;aACnF,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;gBAClE,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,SAAuC,CAAC,EAAE,CAAC;oBACvE,cAAc,CAAC,WAAW,EAAE;wBAC1B,IAAI,EAAE,uBAAuB;wBAC7B,GAAG,EAAE,SAAS;wBACd,QAAQ,EAAE,OAAO;wBACjB,OAAO,EAAE,0BAA0B,SAAS,kCAAkC;qBAC/E,CAAC,CAAC;oBACH,SAAS;gBACX,CAAC;gBACD,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC7B,cAAc,CAAC,WAAW,EAAE;wBAC1B,IAAI,EAAE,yBAAyB;wBAC/B,GAAG,EAAE,SAAS;wBACd,QAAQ,EAAE,OAAO;wBACjB,OAAO,EAAE,uBAAuB,SAAS,sBAAsB;qBAChE,CAAC,CAAC;oBACH,SAAS;gBACX,CAAC;gBACD,UAAU,CAAC,UAAU,CAAC,SAAuC,CAAC,GAAG,KAAK,CAAC;YACzE,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACvC,IACE,KAAK,KAAK,QAAQ;YAClB,KAAK,KAAK,SAAS;YACnB,KAAK,KAAK,kBAAkB;YAC5B,KAAK,KAAK,YAAY,EACtB,CAAC;YACD,SAAS;QACX,CAAC;QACD,cAAc,CAAC,WAAW,EAAE;YAC1B,IAAI,EAAE,uBAAuB;YAC7B,GAAG,EAAE,KAAK;YACV,QAAQ,EAAE,OAAO;YACjB,OAAO,EAAE,0BAA0B,KAAK,IAAI;SAC7C,CAAC,CAAC;IACL,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAS,yBAAyB,CAChC,OAA0B,EAC1B,OAA4C,EAC5C,WAA6C;IAE7C,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAEhC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACvC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9B,cAAc,CAAC,WAAW,EAAE;gBAC1B,IAAI,EAAE,oBAAoB;gBAC1B,GAAG;gBACH,QAAQ,EAAE,OAAO;gBACjB,OAAO,EAAE,+BAA+B,GAAG,6BAA6B;aACzE,CAAC,CAAC;YACH,SAAS;QACX,CAAC;QAED,MAAM,KAAK,GAAG,yBAAyB,CAAC,GAAG,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,CAAC,KAAK,IAAI,QAAQ,KAAK,SAAS;YAAE,SAAS;QAE/C,gBAAgB,CAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;IACtD,CAAC;IAED,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;QAC3B,KAAK,MAAM,KAAK,IAAI,uBAAuB,EAAE,CAAC;YAC5C,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC;YACjD,MAAM,SAAS,GACb,KAAK,CAAC,QAAQ,KAAK,QAAQ;gBAC3B,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,GAAG,MAAM,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,GAAG,KAAK,CAAC,GAAG,QAAQ,CAAC,KAAK,SAAS,CAAC,CAAC;YAC7F,IAAI,KAAK,CAAC,QAAQ,KAAK,WAAW,EAAE,CAAC;gBACnC,SAAS;YACX,CAAC;YACD,IAAI,KAAK,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAChC,IAAI,CAAC,OAAO,IAAI,CAAC,SAAS,EAAE,CAAC;oBAC3B,cAAc,CAAC,WAAW,EAAE;wBAC1B,IAAI,EAAE,qBAAqB;wBAC3B,GAAG,EAAE,KAAK,CAAC,GAAG;wBACd,QAAQ,EAAE,OAAO;wBACjB,OAAO,EAAE,oBAAoB,KAAK,CAAC,GAAG,UAAU,KAAK,CAAC,GAAG,YAAY,KAAK,CAAC,GAAG,WAAW;qBAC1F,CAAC,CAAC;gBACL,CAAC;gBACD,IACE,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,GAAG,MAAM,CAAC;oBAC5B,2BAA2B,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,GAAG,MAAM,CAAC,EACvD,CAAC;oBACD,cAAc,CAAC,WAAW,EAAE;wBAC1B,IAAI,EAAE,qBAAqB;wBAC3B,GAAG,EAAE,GAAG,KAAK,CAAC,GAAG,MAAM;wBACvB,QAAQ,EAAE,SAAS;wBACnB,OAAO,EAAE,wBAAwB,KAAK,CAAC,GAAG,uCAAuC;qBAClF,CAAC,CAAC;gBACL,CAAC;gBACD,IACE,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,GAAG,QAAQ,CAAC;oBAC9B,2BAA2B,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,GAAG,QAAQ,CAAC,EACzD,CAAC;oBACD,cAAc,CAAC,WAAW,EAAE;wBAC1B,IAAI,EAAE,qBAAqB;wBAC3B,GAAG,EAAE,GAAG,KAAK,CAAC,GAAG,QAAQ;wBACzB,QAAQ,EAAE,SAAS;wBACnB,OAAO,EAAE,wBAAwB,KAAK,CAAC,GAAG,yCAAyC;qBACpF,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;iBAAM,IAAI,CAAC,OAAO,EAAE,CAAC;gBACpB,cAAc,CAAC,WAAW,EAAE;oBAC1B,IAAI,EAAE,qBAAqB;oBAC3B,GAAG,EAAE,KAAK,CAAC,GAAG;oBACd,QAAQ,EAAE,OAAO;oBACjB,OAAO,EAAE,oBAAoB,KAAK,CAAC,GAAG,IAAI;iBAC3C,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,4BAA4B,CAC1C,OAAgB,EAChB,UAA+C,EAAE;IAEjD,MAAM,WAAW,GAAqC,EAAE,CAAC;IACzD,MAAM,UAAU,GAAG,qBAAqB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC/D,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;IACvC,CAAC;IAED,yBAAyB,CAAC,UAAU,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAE5D,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC;IACvE,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,WAAW,EAAE,CAAC;AACrD,CAAC"}

package/dist/player-message-catalog.d.ts

@@ -0,0 +1,18 @@
+import type { QtiPlayerMovementDirection } from "./player-messages.js";
+export { defaultPlayerMessageCatalog } from "./player-message-catalog-default.js";
+export { createPlayerMessageResolver, defaultPlayerMessageResolver, type PlayerMessageOverride, type PlayerMessageParams, type PlayerMessageResolver, type QtiPlayerMessageOverrides, } from "./player-message-resolver.js";
+/** JSON-serializable chrome strings for Harbor/LMS locale files. */
+export interface PlayerMessageCatalog {
+    /** BCP 47 tag (metadata only). */
+    locale?: string;
+    /** Message templates; use `{name}` placeholders. Plural forms: `key.one` / `key.other`. */
+    strings: Record<string, string>;
+    /** QTI interaction type id → short label inserted as `{typeName}`. */
+    interactionTypes?: Record<string, string>;
+    /** Labels for moveChoice / movePoint / moveObject (`{direction}`). */
+    directions?: Partial<Record<QtiPlayerMovementDirection, string>>;
+}
+export declare function mergePlayerMessageCatalogs(base: PlayerMessageCatalog, partial: Partial<PlayerMessageCatalog>): PlayerMessageCatalog;
+export declare function extractMessagePlaceholders(template: string): string[];
+export declare function formatPlayerMessage(template: string, values: Record<string, string | number>): string;
+//# sourceMappingURL=player-message-catalog.d.ts.map

package/dist/player-message-catalog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"player-message-catalog.d.ts","sourceRoot":"","sources":["../src/player-message-catalog.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,sBAAsB,CAAC;AAEvE,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAC;AAClF,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,yBAAyB,GAC/B,MAAM,8BAA8B,CAAC;AAEtC,oEAAoE;AACpE,MAAM,WAAW,oBAAoB;IACnC,kCAAkC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2FAA2F;IAC3F,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,sEAAsE;IACtE,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,sEAAsE;IACtE,UAAU,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC,CAAC;CAClE;AAED,wBAAgB,0BAA0B,CACxC,IAAI,EAAE,oBAAoB,EAC1B,OAAO,EAAE,OAAO,CAAC,oBAAoB,CAAC,GACrC,oBAAoB,CAiBtB;AAED,wBAAgB,0BAA0B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAMrE;AAED,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GACtC,MAAM,CAaR"}

package/dist/player-message-catalog.js

@@ -0,0 +1,40 @@
+import { playerDevWarningsEnabled, warnPlayerMessageOnce } from "./player-dev.js";
+export { defaultPlayerMessageCatalog } from "./player-message-catalog-default.js";
+export { createPlayerMessageResolver, defaultPlayerMessageResolver, } from "./player-message-resolver.js";
+export function mergePlayerMessageCatalogs(base, partial) {
+    const merged = {
+        strings: { ...base.strings, ...partial.strings },
+    };
+    const interactionTypes = { ...base.interactionTypes, ...partial.interactionTypes };
+    if (Object.keys(interactionTypes).length > 0) {
+        merged.interactionTypes = interactionTypes;
+    }
+    const directions = { ...base.directions, ...partial.directions };
+    if (Object.keys(directions).length > 0) {
+        merged.directions = directions;
+    }
+    const locale = partial.locale ?? base.locale;
+    if (locale !== undefined) {
+        merged.locale = locale;
+    }
+    return merged;
+}
+export function extractMessagePlaceholders(template) {
+    const names = new Set();
+    for (const match of template.matchAll(/\{(\w+)\}/g)) {
+        names.add(match[1] ?? "");
+    }
+    return [...names].filter(Boolean);
+}
+export function formatPlayerMessage(template, values) {
+    const placeholders = extractMessagePlaceholders(template);
+    const missing = placeholders.filter((name) => values[name] === undefined);
+    if (missing.length > 0 && playerDevWarningsEnabled()) {
+        warnPlayerMessageOnce(`missing-placeholder-values:${missing.join(",")}`, `Player message template is missing values for: ${missing.map((name) => `{${name}}`).join(", ")}.`);
+    }
+    return template.replace(/\{(\w+)\}/g, (_, key) => {
+        const value = values[key];
+        return value === undefined ? `{${key}}` : String(value);
+    });
+}
+//# sourceMappingURL=player-message-catalog.js.map

package/dist/player-message-catalog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"player-message-catalog.js","sourceRoot":"","sources":["../src/player-message-catalog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAGlF,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAC;AAClF,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,GAK7B,MAAM,8BAA8B,CAAC;AActC,MAAM,UAAU,0BAA0B,CACxC,IAA0B,EAC1B,OAAsC;IAEtC,MAAM,MAAM,GAAyB;QACnC,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE;KACjD,CAAC;IACF,MAAM,gBAAgB,GAAG,EAAE,GAAG,IAAI,CAAC,gBAAgB,EAAE,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IACnF,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7C,MAAM,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;IAC7C,CAAC;IACD,MAAM,UAAU,GAAG,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IACjE,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvC,MAAM,CAAC,UAAU,GAAG,UAAU,CAAC;IACjC,CAAC;IACD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC;IAC7C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,QAAgB;IACzD,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;QACpD,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAC5B,CAAC;IACD,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,QAAgB,EAChB,MAAuC;IAEvC,MAAM,YAAY,GAAG,0BAA0B,CAAC,QAAQ,CAAC,CAAC;IAC1D,MAAM,OAAO,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC;IAC1E,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,wBAAwB,EAAE,EAAE,CAAC;QACrD,qBAAqB,CACnB,8BAA8B,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EACjD,kDAAkD,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACnG,CAAC;IACJ,CAAC;IACD,OAAO,QAAQ,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,GAAW,EAAE,EAAE;QACvD,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/player-message-keys.d.ts

@@ -0,0 +1,6 @@
+import { type PlayerMessageKey } from "./player-message-manifest.js";
+/** Chrome message ids (from {@link PLAYER_MESSAGE_MANIFEST}). */
+export declare const PLAYER_MESSAGE_KEYS: readonly PlayerMessageKey[];
+/** All `strings` keys in the English catalog (including plural/unit suffix keys). */
+export declare const PLAYER_MESSAGE_STRING_KEYS: ReadonlyArray<string>;
+//# sourceMappingURL=player-message-keys.d.ts.map

package/dist/player-message-keys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"player-message-keys.d.ts","sourceRoot":"","sources":["../src/player-message-keys.ts"],"names":[],"mappings":"AACA,OAAO,EAA2B,KAAK,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAE9F,iEAAiE;AACjE,eAAO,MAAM,mBAAmB,EAE3B,SAAS,gBAAgB,EAAE,CAAC;AAEjC,qFAAqF;AACrF,eAAO,MAAM,0BAA0B,EAElC,aAAa,CAAC,MAAM,CAAC,CAAC"}

package/dist/player-message-keys.js

@@ -0,0 +1,7 @@
+import { defaultPlayerMessageCatalog } from "./player-message-catalog-default.js";
+import { PLAYER_MESSAGE_MANIFEST } from "./player-message-manifest.js";
+/** Chrome message ids (from {@link PLAYER_MESSAGE_MANIFEST}). */
+export const PLAYER_MESSAGE_KEYS = PLAYER_MESSAGE_MANIFEST.map((entry) => entry.key);
+/** All `strings` keys in the English catalog (including plural/unit suffix keys). */
+export const PLAYER_MESSAGE_STRING_KEYS = Object.keys(defaultPlayerMessageCatalog.strings);
+//# sourceMappingURL=player-message-keys.js.map

package/dist/player-message-keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"player-message-keys.js","sourceRoot":"","sources":["../src/player-message-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAC;AAClF,OAAO,EAAE,uBAAuB,EAAyB,MAAM,8BAA8B,CAAC;AAE9F,iEAAiE;AACjE,MAAM,CAAC,MAAM,mBAAmB,GAAG,uBAAuB,CAAC,GAAG,CAC5D,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CACU,CAAC;AAEjC,qFAAqF;AACrF,MAAM,CAAC,MAAM,0BAA0B,GAAG,MAAM,CAAC,IAAI,CACnD,2BAA2B,CAAC,OAAO,CACX,CAAC"}