i18n-ai-translate/src/interfaces/options.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.

import type { ChatParams, Model } from "../types";
import type { TranslationCache } from "../cache";
import type ChatPool from "../chat_pool";
import type Engine from "../enums/engine";
import type Glossary from "./glossary";
import type OverridePrompt from "./override_prompt";
import type PromptMode from "../enums/prompt_mode";
import type RateLimiter from "../rate_limiter";

export default interface Options {
    engine: Engine;
    model: Model;
    chatParams: ChatParams;
    rateLimitMs: number;
    apiKey?: string;
    host?: string;
    templatedStringPrefix?: string;
    templatedStringSuffix?: string;
    verbose?: boolean;
    ensureChangedTranslation?: boolean;
    batchSize?: number;
    batchMaxTokens?: number;
    skipTranslationVerification?: boolean;
    skipStylingVerification?: boolean;
    overridePrompt?: OverridePrompt;
    promptMode: PromptMode;
    continueOnError?: boolean;
    concurrency?: number;
    /**
     * Optional product/domain context injected into prompts — e.g.
     * "a music trivia game for Discord" or "a B2B invoicing SaaS".
     * Helps the model pick domain-specific terminology and tone.
     */
    context?: string;
    /**
     * Language codes (or filenames) to skip when translating or
     * running diff. Useful when certain locales are maintained
     * manually and shouldn't be machine-translated over.
     */
    excludeLanguages?: string[];
    /**
     * Cap on tokens-per-minute across all concurrent workers. When
     * set, RateLimiter holds each call until both the RPM slot and
     * the TPM budget are available. 0 / undefined disables the check.
     */
    tokensPerMinute?: number;
    /**
     * When set, translate() / check() skip their internal ChatPool +
     * RateLimiter construction and use the provided ones instead. Used
     * by the CLI at `--language-concurrency > 1` to share one pool and
     * one rate-limit budget across every target language — otherwise
     * each language would get its own budget and the TPM cap wouldn't
     * actually constrain parallel language fan-out.
     */
    pool?: ChatPool;
    rateLimiter?: RateLimiter;
    /**
     * Optional translation memory. When provided, translate() skips any
     * source string already present (keyed by source text + input/output
     * language + context, deliberately model-agnostic) and records newly
     * translated strings into it for reuse on later runs. The CLI wires
     * this up behind `--cache`; library callers may pass their own.
     */
    cache?: TranslationCache;
    /**
     * Optional glossary steering terminology: terms to keep verbatim
     * (brand/product names) and forced per-language translations. Injected
     * into the generation and verification prompts. The CLI wires this up
     * behind `--glossary`; library callers may pass their own.
     */
    glossary?: Glossary;
}