i18n-ai-translate/src/formats/format_adapter.ts

AI-powered localization CLI, Node library, and GitHub Action. Translate i18next JSON, Gettext PO, Java .properties, and iOS .strings with ChatGPT, Claude, Gemini, or local Ollama models.

/**
 * A format adapter translates between the on-disk file format and the
 * pipeline's flat `Record<string, string>` contract.
 *
 * `read` returns the flat map plus an opaque, format-specific
 * `sidecar` that carries everything the pipeline doesn't need to see
 * (comments, metadata, ordering, plural counts, original placeholder
 * syntax). `write` takes the translated flat map together with the
 * `sidecar` returned by `read` to reconstruct the output file — so
 * unchanged keys round-trip byte-for-byte.
 *
 * The `TSidecar` generic lets each adapter keep a precise type
 * internally; the registry erases it at its boundary so callers can
 * hold a heterogeneous list of adapters without unsafe casts.
 */
export default interface FormatAdapter<TSidecar = unknown> {
    /** Human-readable name; matches `--format <name>` on the CLI. */
    readonly name: string;

    /** File extensions this adapter claims (leading dot, e.g. `.json`). */
    readonly extensions: readonly string[];

    read(raw: string): { flat: Record<string, string>; sidecar: TSidecar };

    /**
     * Optional second read path for diff mode, where the file is an
     * existing *target* translation rather than a source. Formats that
     * store source and target text in the same slot (e.g. JSON, where a
     * key maps to its value regardless of language) don't need this —
     * callers fall back to `read`. Formats that separate them (e.g.
     * Gettext PO: source in `msgid`, target in `msgstr`) implement it so
     * already-translated values survive a diff.
     *
     * The returned flat map is keyed identically to `read` so unchanged
     * source keys line up; the sidecar is unused on the write side of a
     * diff (which rebuilds from the source catalogue) but returned for
     * interface symmetry.
     * @param raw - the existing target file's contents
     * @returns the flat map of existing translated values and a sidecar
     */
    readTranslated?(raw: string): {
        flat: Record<string, string>;
        sidecar: TSidecar;
    };

    write(
        translated: Record<string, string>,
        sidecar: TSidecar,
        inputLanguageCode: string,
        outputLanguageCode: string,
    ): string;
}