react-cheminfo 0.22.0 → 0.24.0

package/lib/translate/core/session.d.ts

@@ -0,0 +1,102 @@
+import type { CatalogSource, MessageRef, Messages } from './catalog.ts';
+import type { TranslatableTable } from './tables.ts';
+/** The values a message's placeholders are filled with. */
+export type MessageValues = Record<string, string | number | Date>;
+/** The version of the page ↔ overlay protocol this session speaks. */
+export declare const BRIDGE_PROTOCOL = 2;
+/** Where a page in translate mode exposes its session to the overlay. */
+export declare const BRIDGE_GLOBAL = "__cheminfoTranslate";
+/** A catalog as the overlay sees it: the source, what is published, the edits. */
+export interface CatalogSnapshot extends CatalogSource {
+    /** The locale file as published with the site. */
+    translation: Messages;
+    /** The messages edited in the overlay and not yet submitted. */
+    drafts: Messages;
+}
+/**
+ * What a page in translate mode offers the overlay. It is the only contract
+ * between the two, so an overlay released later still drives a page built
+ * earlier as long as the protocol number matches.
+ */
+export interface TranslateBridge {
+    /** The protocol version; the overlay refuses a page speaking another. */
+    readonly protocol: typeof BRIDGE_PROTOCOL;
+    /** The locale being translated into. */
+    readonly locale: string;
+    /** Every catalog the page registered. */
+    catalogs: () => CatalogSnapshot[];
+    /**
+     * The tables of the page whose rows a translator may write — the element
+     * sheet, a list of ions — with the columns that are text rather than
+     * measurement. Empty on a page that shows no table.
+     */
+    tables: () => TranslatableTable[];
+    /** The message a marker found in the DOM stands for. */
+    resolveMarker: (id: number) => MessageRef | undefined;
+    /** Show an edited message on the page; `undefined` removes the edit. */
+    setDraft: (ref: MessageRef, message: string | undefined) => void;
+    /** Be told whenever a draft changes; returns the function that stops it. */
+    subscribe: (listener: () => void) => () => void;
+}
+/** How a session is set up. */
+export interface TranslateSessionOptions {
+    /** The locale messages are shown in. */
+    locale: string;
+    /** Every catalog the page renders from. */
+    catalogs: readonly CatalogSource[];
+    /**
+     * The published messages of `locale`, by catalog id.
+     * @default {}
+     */
+    translations?: Readonly<Record<string, Messages>>;
+    /**
+     * Whether every formatted message carries its invisible marker, which is
+     * what translate mode is.
+     * @default false
+     */
+    marked?: boolean;
+    /**
+     * The tables whose rows are translated, declared so the overlay can offer
+     * them as a grid: a cell of a table is rarely on the page being looked at,
+     * and 118 of them are never Alt-clicked one by one.
+     * @default []
+     */
+    tables?: readonly TranslatableTable[];
+}
+/**
+ * Formats the messages of a page, and in translate mode lets the overlay edit
+ * them live: a draft replaces the published message as soon as it can be
+ * formatted, and a draft that cannot is ignored rather than breaking the page.
+ */
+export declare class TranslateSession implements TranslateBridge {
+    #private;
+    readonly protocol = 2;
+    readonly locale: string;
+    constructor(options: TranslateSessionOptions);
+    /**
+     * Increases on every draft change, for a view that re-renders on it.
+     * @returns The current version.
+     */
+    get version(): number;
+    /**
+     * Format one message: the draft, else the published translation, else the
+     * English message — the first that passes its check against the English
+     * one and formats. A draft that drops a placeholder formats without error,
+     * so the check, not the formatting, is what keeps it off the page.
+     * @param catalogId - The catalog the message belongs to.
+     * @param key - The key of the message.
+     * @param values - What the placeholders are filled with.
+     * @returns The text to show; the key itself when no catalog has it.
+     */
+    format(catalogId: string, key: string, values?: MessageValues): string;
+    catalogs(): CatalogSnapshot[];
+    /**
+     * The tables whose rows a translator may write.
+     * @returns One entry per table the page declared.
+     */
+    tables(): TranslatableTable[];
+    resolveMarker(id: number): MessageRef | undefined;
+    setDraft(ref: MessageRef, message: string | undefined): void;
+    subscribe(listener: () => void): () => void;
+}
+//# sourceMappingURL=session.d.ts.map

package/lib/translate/core/session.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"session.d.ts","sourceRoot":"","sources":["../../../src/translate/core/session.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAIxE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAErD,2DAA2D;AAC3D,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC,CAAC;AAEnE,sEAAsE;AACtE,eAAO,MAAM,eAAe,IAAI,CAAC;AAEjC,yEAAyE;AACzE,eAAO,MAAM,aAAa,wBAAwB,CAAC;AAEnD,kFAAkF;AAClF,MAAM,WAAW,eAAgB,SAAQ,aAAa;IACpD,kDAAkD;IAClD,WAAW,EAAE,QAAQ,CAAC;IACtB,gEAAgE;IAChE,MAAM,EAAE,QAAQ,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,yEAAyE;IACzE,QAAQ,CAAC,QAAQ,EAAE,OAAO,eAAe,CAAC;IAC1C,wCAAwC;IACxC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,yCAAyC;IACzC,QAAQ,EAAE,MAAM,eAAe,EAAE,CAAC;IAClC;;;;OAIG;IACH,MAAM,EAAE,MAAM,iBAAiB,EAAE,CAAC;IAClC,wDAAwD;IACxD,aAAa,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,UAAU,GAAG,SAAS,CAAC;IACtD,wEAAwE;IACxE,QAAQ,EAAE,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS,KAAK,IAAI,CAAC;IACjE,4EAA4E;IAC5E,SAAS,EAAE,CAAC,QAAQ,EAAE,MAAM,IAAI,KAAK,MAAM,IAAI,CAAC;CACjD;AAED,+BAA+B;AAC/B,MAAM,WAAW,uBAAuB;IACtC,wCAAwC;IACxC,MAAM,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,QAAQ,EAAE,SAAS,aAAa,EAAE,CAAC;IACnC;;;OAGG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IAClD;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,SAAS,iBAAiB,EAAE,CAAC;CACvC;AAQD;;;;GAIG;AACH,qBAAa,gBAAiB,YAAW,eAAe;;IACtD,SAAgB,QAAQ,KAAmB;IAC3C,SAAgB,MAAM,EAAE,MAAM,CAAC;gBAWZ,OAAO,EAAE,uBAAuB;IAoBnD;;;OAGG;IACH,IAAW,OAAO,IAAI,MAAM,CAE3B;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,aAAa;IAmB7D,QAAQ,IAAI,eAAe,EAAE;IAYpC;;;OAGG;IACI,MAAM,IAAI,iBAAiB,EAAE;IAI7B,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAIjD,QAAQ,CAAC,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAc5D,SAAS,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI;CAqDnD"}

package/lib/translate/core/session.js

@@ -0,0 +1,162 @@
+import { IntlMessageFormat } from 'intl-messageformat';
+import { SOURCE_LOCALE, ownMessage } from "./catalog.js";
+import { checkTranslation } from "./checkTranslation.js";
+import { markText } from "./marker.js";
+/** The version of the page ↔ overlay protocol this session speaks. */
+export const BRIDGE_PROTOCOL = 2;
+/** Where a page in translate mode exposes its session to the overlay. */
+export const BRIDGE_GLOBAL = '__cheminfoTranslate';
+/**
+ * Formats the messages of a page, and in translate mode lets the overlay edit
+ * them live: a draft replaces the published message as soon as it can be
+ * formatted, and a draft that cannot is ignored rather than breaking the page.
+ */
+export class TranslateSession {
+    protocol = BRIDGE_PROTOCOL;
+    locale;
+    #marked;
+    #catalogs = new Map();
+    #ids = new Map();
+    #refs = [];
+    #listeners = new Set();
+    #formatters = new Map();
+    #checked = new Map();
+    #tables;
+    #version = 0;
+    constructor(options) {
+        const { locale, catalogs, translations = {}, marked = false, tables = [], } = options;
+        this.locale = locale;
+        this.#marked = marked;
+        this.#tables = tables;
+        for (const source of catalogs) {
+            this.#catalogs.set(source.id, {
+                source,
+                translation: translations[source.id] ?? {},
+                drafts: new Map(),
+            });
+        }
+    }
+    /**
+     * Increases on every draft change, for a view that re-renders on it.
+     * @returns The current version.
+     */
+    get version() {
+        return this.#version;
+    }
+    /**
+     * Format one message: the draft, else the published translation, else the
+     * English message — the first that passes its check against the English
+     * one and formats. A draft that drops a placeholder formats without error,
+     * so the check, not the formatting, is what keeps it off the page.
+     * @param catalogId - The catalog the message belongs to.
+     * @param key - The key of the message.
+     * @param values - What the placeholders are filled with.
+     * @returns The text to show; the key itself when no catalog has it.
+     */
+    format(catalogId, key, values) {
+        const catalog = this.#catalogs.get(catalogId);
+        if (catalog === undefined)
+            return key;
+        const source = ownMessage(catalog.source.messages, key);
+        if (source === undefined)
+            return key;
+        const draft = this.#usable(source, catalog.drafts.get(key));
+        const translation = this.#usable(source, ownMessage(catalog.translation, key));
+        const text = this.#tryFormat(draft, this.locale, values) ??
+            this.#tryFormat(translation, this.locale, values) ??
+            this.#tryFormat(source, SOURCE_LOCALE, values) ??
+            source;
+        return this.#marked ? markText(text, this.#idOf(catalogId, key)) : text;
+    }
+    catalogs() {
+        const snapshots = [];
+        for (const { source, translation, drafts } of this.#catalogs.values()) {
+            snapshots.push({
+                ...source,
+                translation,
+                drafts: Object.fromEntries(drafts),
+            });
+        }
+        return snapshots;
+    }
+    /**
+     * The tables whose rows a translator may write.
+     * @returns One entry per table the page declared.
+     */
+    tables() {
+        return [...this.#tables];
+    }
+    resolveMarker(id) {
+        return this.#refs[id];
+    }
+    setDraft(ref, message) {
+        const catalog = this.#catalogs.get(ref.catalogId);
+        if (catalog === undefined)
+            return;
+        if (ownMessage(catalog.source.messages, ref.key) === undefined)
+            return;
+        if (catalog.drafts.get(ref.key) === message)
+            return;
+        if (message === undefined) {
+            catalog.drafts.delete(ref.key);
+        }
+        else {
+            catalog.drafts.set(ref.key, message);
+        }
+        this.#version++;
+        for (const listener of this.#listeners)
+            listener();
+    }
+    subscribe(listener) {
+        this.#listeners.add(listener);
+        return () => {
+            this.#listeners.delete(listener);
+        };
+    }
+    #idOf(catalogId, key) {
+        const name = `${catalogId}\n${key}`;
+        let id = this.#ids.get(name);
+        if (id === undefined) {
+            id = this.#refs.length;
+            this.#refs.push({ catalogId, key });
+            this.#ids.set(name, id);
+        }
+        return id;
+    }
+    #usable(source, message) {
+        if (message === undefined)
+            return undefined;
+        const name = JSON.stringify([source, message]);
+        let usable = this.#checked.get(name);
+        if (usable === undefined) {
+            usable = checkTranslation(source, message).length === 0;
+            this.#checked.set(name, usable);
+        }
+        return usable ? message : undefined;
+    }
+    #tryFormat(message, locale, values) {
+        if (message === undefined)
+            return undefined;
+        const name = `${locale}\n${message}`;
+        let formatter = this.#formatters.get(name);
+        if (formatter === undefined) {
+            try {
+                formatter = new IntlMessageFormat(message, locale);
+            }
+            catch {
+                formatter = null;
+            }
+            this.#formatters.set(name, formatter);
+        }
+        if (formatter === null)
+            return undefined;
+        try {
+            const output = formatter.format(values);
+            return Array.isArray(output) ? output.join('') : String(output);
+        }
+        catch {
+            return undefined;
+        }
+    }
+}
+//# sourceMappingURL=session.js.map

package/lib/translate/core/session.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"session.js","sourceRoot":"","sources":["../../../src/translate/core/session.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAGvD,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAMvC,sEAAsE;AACtE,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC;AAEjC,yEAAyE;AACzE,MAAM,CAAC,MAAM,aAAa,GAAG,qBAAqB,CAAC;AAoEnD;;;;GAIG;AACH,MAAM,OAAO,gBAAgB;IACX,QAAQ,GAAG,eAAe,CAAC;IAC3B,MAAM,CAAS;IACtB,OAAO,CAAU;IACjB,SAAS,GAAG,IAAI,GAAG,EAAwB,CAAC;IAC5C,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;IACjC,KAAK,GAAiB,EAAE,CAAC;IACzB,UAAU,GAAG,IAAI,GAAG,EAAc,CAAC;IACnC,WAAW,GAAG,IAAI,GAAG,EAAoC,CAAC;IAC1D,QAAQ,GAAG,IAAI,GAAG,EAAmB,CAAC;IACtC,OAAO,CAA+B;IAC/C,QAAQ,GAAG,CAAC,CAAC;IAEb,YAAmB,OAAgC;QACjD,MAAM,EACJ,MAAM,EACN,QAAQ,EACR,YAAY,GAAG,EAAE,EACjB,MAAM,GAAG,KAAK,EACd,MAAM,GAAG,EAAE,GACZ,GAAG,OAAO,CAAC;QACZ,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE,CAAC;YAC9B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE;gBAC5B,MAAM;gBACN,WAAW,EAAE,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE;gBAC1C,MAAM,EAAE,IAAI,GAAG,EAAE;aAClB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,SAAiB,EAAE,GAAW,EAAE,MAAsB;QAClE,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC9C,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO,GAAG,CAAC;QACtC,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QACxD,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,GAAG,CAAC;QAErC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QAC5D,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAC9B,MAAM,EACN,UAAU,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CACrC,CAAC;QACF,MAAM,IAAI,GACR,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;YAC3C,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;YACjD,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,CAAC;YAC9C,MAAM,CAAC;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC1E,CAAC;IAEM,QAAQ;QACb,MAAM,SAAS,GAAsB,EAAE,CAAC;QACxC,KAAK,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC;YACtE,SAAS,CAAC,IAAI,CAAC;gBACb,GAAG,MAAM;gBACT,WAAW;gBACX,MAAM,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC;aACnC,CAAC,CAAC;QACL,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,MAAM;QACX,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;IAEM,aAAa,CAAC,EAAU;QAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACxB,CAAC;IAEM,QAAQ,CAAC,GAAe,EAAE,OAA2B;QAC1D,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO;QAClC,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS;YAAE,OAAO;QACvE,IAAI,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,OAAO;YAAE,OAAO;QACpD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACjC,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACvC,CAAC;QACD,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChB,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU;YAAE,QAAQ,EAAE,CAAC;IACrD,CAAC;IAEM,SAAS,CAAC,QAAoB;QACnC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC9B,OAAO,GAAG,EAAE;YACV,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACnC,CAAC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,SAAiB,EAAE,GAAW;QAClC,MAAM,IAAI,GAAG,GAAG,SAAS,KAAK,GAAG,EAAE,CAAC;QACpC,IAAI,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;YACrB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;YACvB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC;YACpC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC1B,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,CAAC,MAAc,EAAE,OAA2B;QACjD,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO,SAAS,CAAC;QAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QAC/C,IAAI,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,GAAG,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;YACxD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAClC,CAAC;QACD,OAAO,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IACtC,CAAC;IAED,UAAU,CACR,OAA2B,EAC3B,MAAc,EACd,MAAiC;QAEjC,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO,SAAS,CAAC;QAC5C,MAAM,IAAI,GAAG,GAAG,MAAM,KAAK,OAAO,EAAE,CAAC;QACrC,IAAI,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,IAAI,CAAC;gBACH,SAAS,GAAG,IAAI,iBAAiB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YACrD,CAAC;YAAC,MAAM,CAAC;gBACP,SAAS,GAAG,IAAI,CAAC;YACnB,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACxC,CAAC;QACD,IAAI,SAAS,KAAK,IAAI;YAAE,OAAO,SAAS,CAAC;QACzC,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACxC,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAClE,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;CACF"}

package/lib/translate/core/start.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Turning a page into a translatable one.
+ *
+ * A site opened with `?translate=<locale>` formats every message with its
+ * invisible marker, hands its session to the overlay as
+ * `window.__cheminfoTranslate`, and loads that overlay from
+ * translate.cheminfo.org. Nothing of this is paid for by an ordinary visit:
+ * the site imports this module only once it has seen the parameter.
+ */
+import type { CatalogSource, Messages } from './catalog.ts';
+import { TranslateSession } from './session.ts';
+import type { TranslatableTable } from './tables.ts';
+/** The query parameter that opens a page in translate mode. */
+export declare const TRANSLATE_PARAM = "translate";
+/** Where the overlay is served from unless a site says otherwise. */
+export declare const TRANSLATE_ORIGIN = "https://translate.cheminfo.org";
+/**
+ * The locale a page is being translated into, from its address:
+ * `?translate=fr` opens the overlay for French.
+ * @param search - The query string, e.g. `location.search`.
+ * @returns The locale, or `undefined` when the page is not in translate mode,
+ *   or names English, or names something that is not a language at all.
+ */
+export declare function readTranslateLocale(search: string): string | undefined;
+/** How a page enters translate mode. */
+export interface StartTranslatingOptions {
+    /** The locale being translated into, from {@link readTranslateLocale}. */
+    locale: string;
+    /** Every catalog the page renders messages from. */
+    catalogs: readonly CatalogSource[];
+    /**
+     * The published messages of the locale, by catalog id, so the overlay opens
+     * on what the site already ships rather than on English.
+     * @default {}
+     */
+    translations?: Readonly<Record<string, Messages>>;
+    /**
+     * The tables whose rows a translator may write.
+     * @default []
+     */
+    tables?: readonly TranslatableTable[];
+    /**
+     * Where the overlay is loaded from.
+     * @default 'https://translate.cheminfo.org'
+     */
+    origin?: string;
+    /**
+     * The document the overlay script is added to.
+     * @default globalThis.document
+     */
+    document?: Document;
+}
+/**
+ * Put a page into translate mode.
+ *
+ * The session is exposed before the overlay is loaded, so the overlay finds a
+ * page already formatting marked messages. The site is handed the session back
+ * and must format through it from then on — that is what makes an edit show up
+ * as it is typed.
+ * @param options - See {@link StartTranslatingOptions}.
+ * @returns The session the page formats through.
+ */
+export declare function startTranslating(options: StartTranslatingOptions): TranslateSession;
+/**
+ * Add the overlay script to the page, once.
+ * @param origin - Where the overlay is served from.
+ * @param target - The document to add it to.
+ */
+export declare function loadOverlay(origin: string, target?: Document): void;
+//# sourceMappingURL=start.d.ts.map

package/lib/translate/core/start.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"start.d.ts","sourceRoot":"","sources":["../../../src/translate/core/start.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE5D,OAAO,EAAiB,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAErD,+DAA+D;AAC/D,eAAO,MAAM,eAAe,cAAc,CAAC;AAE3C,qEAAqE;AACrE,eAAO,MAAM,gBAAgB,mCAAmC,CAAC;AAEjE;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAMtE;AAED,wCAAwC;AACxC,MAAM,WAAW,uBAAuB;IACtC,0EAA0E;IAC1E,MAAM,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,QAAQ,EAAE,SAAS,aAAa,EAAE,CAAC;IACnC;;;;OAIG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IAClD;;;OAGG;IACH,MAAM,CAAC,EAAE,SAAS,iBAAiB,EAAE,CAAC;IACtC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,uBAAuB,GAC/B,gBAAgB,CAoBlB;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,MAAM,EACd,MAAM,WAAsB,GAC3B,IAAI,CAWN"}

package/lib/translate/core/start.js

@@ -0,0 +1,73 @@
+/**
+ * Turning a page into a translatable one.
+ *
+ * A site opened with `?translate=<locale>` formats every message with its
+ * invisible marker, hands its session to the overlay as
+ * `window.__cheminfoTranslate`, and loads that overlay from
+ * translate.cheminfo.org. Nothing of this is paid for by an ordinary visit:
+ * the site imports this module only once it has seen the parameter.
+ */
+import { isLanguageTag } from "../../language/core/languageParam.js";
+import { SOURCE_LOCALE } from "./catalog.js";
+import { BRIDGE_GLOBAL, TranslateSession } from "./session.js";
+/** The query parameter that opens a page in translate mode. */
+export const TRANSLATE_PARAM = 'translate';
+/** Where the overlay is served from unless a site says otherwise. */
+export const TRANSLATE_ORIGIN = 'https://translate.cheminfo.org';
+/**
+ * The locale a page is being translated into, from its address:
+ * `?translate=fr` opens the overlay for French.
+ * @param search - The query string, e.g. `location.search`.
+ * @returns The locale, or `undefined` when the page is not in translate mode,
+ *   or names English, or names something that is not a language at all.
+ */
+export function readTranslateLocale(search) {
+    const value = new URLSearchParams(search).get(TRANSLATE_PARAM);
+    if (value === null || value === SOURCE_LOCALE || !isLanguageTag(value)) {
+        return undefined;
+    }
+    return value;
+}
+/**
+ * Put a page into translate mode.
+ *
+ * The session is exposed before the overlay is loaded, so the overlay finds a
+ * page already formatting marked messages. The site is handed the session back
+ * and must format through it from then on — that is what makes an edit show up
+ * as it is typed.
+ * @param options - See {@link StartTranslatingOptions}.
+ * @returns The session the page formats through.
+ */
+export function startTranslating(options) {
+    const { locale, catalogs, translations = {}, tables = [], origin = TRANSLATE_ORIGIN, document: target = globalThis.document, } = options;
+    const session = new TranslateSession({
+        locale,
+        catalogs,
+        translations,
+        tables,
+        marked: true,
+    });
+    Object.assign(globalThis, { [BRIDGE_GLOBAL]: session });
+    loadOverlay(origin, target);
+    return session;
+}
+/**
+ * Add the overlay script to the page, once.
+ * @param origin - Where the overlay is served from.
+ * @param target - The document to add it to.
+ */
+export function loadOverlay(origin, target = globalThis.document) {
+    if (target === undefined)
+        return;
+    const src = `${origin.replace(/\/$/, '')}/overlay.js`;
+    for (const loaded of target.querySelectorAll('script')) {
+        if (loaded.src === src)
+            return;
+    }
+    const script = target.createElement('script');
+    script.type = 'module';
+    script.src = src;
+    script.async = true;
+    target.head.append(script);
+}
+//# sourceMappingURL=start.js.map

package/lib/translate/core/start.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"start.js","sourceRoot":"","sources":["../../../src/translate/core/start.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AAGrE,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAG/D,+DAA+D;AAC/D,MAAM,CAAC,MAAM,eAAe,GAAG,WAAW,CAAC;AAE3C,qEAAqE;AACrE,MAAM,CAAC,MAAM,gBAAgB,GAAG,gCAAgC,CAAC;AAEjE;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,MAAc;IAChD,MAAM,KAAK,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IAC/D,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,aAAa,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QACvE,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AA+BD;;;;;;;;;GASG;AACH,MAAM,UAAU,gBAAgB,CAC9B,OAAgC;IAEhC,MAAM,EACJ,MAAM,EACN,QAAQ,EACR,YAAY,GAAG,EAAE,EACjB,MAAM,GAAG,EAAE,EACX,MAAM,GAAG,gBAAgB,EACzB,QAAQ,EAAE,MAAM,GAAG,UAAU,CAAC,QAAQ,GACvC,GAAG,OAAO,CAAC;IAEZ,MAAM,OAAO,GAAG,IAAI,gBAAgB,CAAC;QACnC,MAAM;QACN,QAAQ;QACR,YAAY;QACZ,MAAM;QACN,MAAM,EAAE,IAAI;KACb,CAAC,CAAC;IACH,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;IACxD,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5B,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CACzB,MAAc,EACd,MAAM,GAAG,UAAU,CAAC,QAAQ;IAE5B,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO;IACjC,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC;IACtD,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE,CAAC;QACvD,IAAI,MAAM,CAAC,GAAG,KAAK,GAAG;YAAE,OAAO;IACjC,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC9C,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC;IACvB,MAAM,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAC7B,CAAC"}

package/lib/translate/core/suggestions.d.ts

@@ -0,0 +1,77 @@
+/**
+ * What a translator is offered before typing: the translations already made
+ * for the same English, for English that differs only where the text is not
+ * language, and for English that merely looks like it.
+ *
+ * A table is where this earns its place. Half of 118 element names are the
+ * same word in two languages and the other half differ by an ending; a column
+ * of quantities is a handful of phrases repeated with one word changed. A
+ * translator who is shown what was done three rows above confirms instead of
+ * typing, and the column stays consistent with itself — which is the thing a
+ * long table loses first.
+ *
+ * Nothing here invents a translation. Every suggestion is a translation
+ * somebody already wrote, either as it stands or with the part that is not
+ * language put back.
+ */
+/** One message already translated, which a suggestion is drawn from. */
+export interface TranslatedPair {
+    /** The key it is kept under, so the translator can see where it came from. */
+    key: string;
+    /** The English message. */
+    source: string;
+    /** Its translation. */
+    target: string;
+}
+/**
+ * How a suggestion was arrived at.
+ *
+ * - `exact` — the same English message, translated elsewhere.
+ * - `pattern` — English that differs only in a part that is not language (a
+ *   number, a symbol, a formula), with that part put back into the
+ *   translation.
+ * - `similar` — English that looks like this one; the translation is offered
+ *   to be adapted, not to be taken as it is.
+ */
+export type SuggestionKind = 'exact' | 'pattern' | 'similar';
+/** One translation offered for a message. */
+export interface MessageSuggestion {
+    /** What goes in the box if the translator takes it. */
+    message: string;
+    /** How it was arrived at. */
+    kind: SuggestionKind;
+    /** Between 0 and 1; 1 is the same English message. */
+    score: number;
+    /** The already-translated message it was drawn from. */
+    from: TranslatedPair;
+}
+/** How suggestions are chosen. */
+export interface SuggestionOptions {
+    /**
+     * The most suggestions to return.
+     * @default 5
+     */
+    limit?: number;
+    /**
+     * How alike two English messages must be before one is offered for the
+     * other, between 0 and 1.
+     * @default 0.55
+     */
+    minimumScore?: number;
+}
+/**
+ * The translations worth offering for one English message.
+ * @param source - The English message being translated.
+ * @param pairs - Every message already translated in this language.
+ * @param options - See {@link SuggestionOptions}.
+ * @returns The suggestions, best first; empty when nothing is close enough.
+ */
+export declare function messageSuggestions(source: string, pairs: readonly TranslatedPair[], options?: SuggestionOptions): MessageSuggestion[];
+/**
+ * How alike two messages are, as the suggestions rank them.
+ * @param first - One message.
+ * @param second - The other.
+ * @returns 1 when they are the same, 0 when they share nothing.
+ */
+export declare function messageSimilarity(first: string, second: string): number;
+//# sourceMappingURL=suggestions.d.ts.map

package/lib/translate/core/suggestions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"suggestions.d.ts","sourceRoot":"","sources":["../../../src/translate/core/suggestions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAIH,wEAAwE;AACxE,MAAM,WAAW,cAAc;IAC7B,8EAA8E;IAC9E,GAAG,EAAE,MAAM,CAAC;IACZ,2BAA2B;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,uBAAuB;IACvB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;AAE7D,6CAA6C;AAC7C,MAAM,WAAW,iBAAiB;IAChC,uDAAuD;IACvD,OAAO,EAAE,MAAM,CAAC;IAChB,6BAA6B;IAC7B,IAAI,EAAE,cAAc,CAAC;IACrB,sDAAsD;IACtD,KAAK,EAAE,MAAM,CAAC;IACd,wDAAwD;IACxD,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,kCAAkC;AAClC,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAUD;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,SAAS,cAAc,EAAE,EAChC,OAAO,GAAE,iBAAsB,GAC9B,iBAAiB,EAAE,CAqBrB;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAIvE"}

package/lib/translate/core/suggestions.js

@@ -0,0 +1,143 @@
+/**
+ * What a translator is offered before typing: the translations already made
+ * for the same English, for English that differs only where the text is not
+ * language, and for English that merely looks like it.
+ *
+ * A table is where this earns its place. Half of 118 element names are the
+ * same word in two languages and the other half differ by an ending; a column
+ * of quantities is a handful of phrases repeated with one word changed. A
+ * translator who is shown what was done three rows above confirms instead of
+ * typing, and the column stays consistent with itself — which is the thing a
+ * long table loses first.
+ *
+ * Nothing here invents a translation. Every suggestion is a translation
+ * somebody already wrote, either as it stands or with the part that is not
+ * language put back.
+ */
+import leven from 'leven';
+const DEFAULT_LIMIT = 5;
+const DEFAULT_MINIMUM = 0.55;
+const KIND_ORDER = {
+    exact: 0,
+    pattern: 1,
+    similar: 2,
+};
+/**
+ * The translations worth offering for one English message.
+ * @param source - The English message being translated.
+ * @param pairs - Every message already translated in this language.
+ * @param options - See {@link SuggestionOptions}.
+ * @returns The suggestions, best first; empty when nothing is close enough.
+ */
+export function messageSuggestions(source, pairs, options = {}) {
+    const { limit = DEFAULT_LIMIT, minimumScore = DEFAULT_MINIMUM } = options;
+    if (source === '' || limit <= 0)
+        return [];
+    const found = [];
+    for (const pair of pairs) {
+        if (pair.target === '' || pair.source === '')
+            continue;
+        const suggestion = suggestFrom(source, pair, minimumScore);
+        if (suggestion !== undefined)
+            found.push(suggestion);
+    }
+    found.sort(compareSuggestions);
+    const best = [];
+    const taken = new Set();
+    for (const suggestion of found) {
+        if (taken.has(suggestion.message))
+            continue;
+        taken.add(suggestion.message);
+        best.push(suggestion);
+        if (best.length === limit)
+            break;
+    }
+    return best;
+}
+/**
+ * How alike two messages are, as the suggestions rank them.
+ * @param first - One message.
+ * @param second - The other.
+ * @returns 1 when they are the same, 0 when they share nothing.
+ */
+export function messageSimilarity(first, second) {
+    const longest = Math.max(first.length, second.length);
+    if (longest === 0)
+        return 1;
+    return 1 - leven(first, second) / longest;
+}
+/**
+ * The best offer one already-translated message can make for another.
+ * @param source - The English being translated.
+ * @param pair - The already-translated message to draw from.
+ * @param minimumScore - How alike the two must be to be worth offering.
+ * @returns The suggestion, or `undefined` when the pair is too far away.
+ */
+function suggestFrom(source, pair, minimumScore) {
+    if (pair.source === source) {
+        return { message: pair.target, kind: 'exact', score: 1, from: pair };
+    }
+    // An edit can never be smaller than the difference in length, so a pair that
+    // cannot reach the threshold is dropped before the distance is computed.
+    const longest = Math.max(source.length, pair.source.length);
+    const shortest = Math.min(source.length, pair.source.length);
+    if (longest === 0 || shortest / longest < minimumScore)
+        return undefined;
+    const pattern = patternSuggestion(source, pair);
+    if (pattern !== undefined && pattern.score >= minimumScore)
+        return pattern;
+    const score = messageSimilarity(source, pair.source);
+    if (score < minimumScore)
+        return undefined;
+    return { message: pair.target, kind: 'similar', score, from: pair };
+}
+/**
+ * A translation whose English differs from this one only in a run of text
+ * that survives into the translation unchanged — a number, a symbol, a
+ * formula. That run is the only thing put back, so nothing is invented.
+ * @param source - The English being translated.
+ * @param pair - The already-translated message to draw from.
+ * @returns The suggestion, or `undefined` when the run cannot be put back.
+ */
+function patternSuggestion(source, pair) {
+    const prefix = commonPrefix(source, pair.source);
+    const suffix = commonSuffix(source.slice(prefix), pair.source.slice(prefix));
+    const own = source.slice(prefix, source.length - suffix);
+    const theirs = pair.source.slice(prefix, pair.source.length - suffix);
+    if (theirs === '')
+        return undefined;
+    // The varying run must appear once and only once, or putting it back would
+    // be a guess about which occurrence was meant.
+    const at = pair.target.indexOf(theirs);
+    if (at === -1 || pair.target.includes(theirs, at + 1))
+        return undefined;
+    const message = pair.target.slice(0, at) + own + pair.target.slice(at + theirs.length);
+    const kept = prefix + suffix;
+    const score = kept / Math.max(source.length, pair.source.length);
+    return { message, kind: 'pattern', score, from: pair };
+}
+function commonPrefix(first, second) {
+    const limit = Math.min(first.length, second.length);
+    let length = 0;
+    while (length < limit && first[length] === second[length])
+        length++;
+    return length;
+}
+function commonSuffix(first, second) {
+    const limit = Math.min(first.length, second.length);
+    let length = 0;
+    while (length < limit &&
+        first[first.length - 1 - length] === second[second.length - 1 - length]) {
+        length++;
+    }
+    return length;
+}
+function compareSuggestions(first, second) {
+    if (first.kind !== second.kind) {
+        return KIND_ORDER[first.kind] - KIND_ORDER[second.kind];
+    }
+    if (first.score !== second.score)
+        return second.score - first.score;
+    return first.from.key < second.from.key ? -1 : 1;
+}
+//# sourceMappingURL=suggestions.js.map