intl-watcher/lib/types.d.ts

Automated translation key extraction and dictionary management plugin for Next.js

import { SimplifyDeep, RequiredDeep } from 'type-fest';

/**
 * Configuration options for creating the intl watcher, with or without partitioning.
 */
type CreateIntlWatcherOptions = SimplifyDeep<WithPartitioning | WithoutPartitioning>;
/**
 * Configuration options for creating the intl watcher, with or without partitioning.
 */
type BaseOptions = {
    /** Function to generate a default translation for new keys. */
    defaultValue?(key: string): string;
    /** Paths to JSON dictionary files for each language. */
    dictionaryPaths: string[];
    /** Remove keys not found in source files when true; otherwise warn on unused keys. */
    removeUnusedKeys?: boolean;
    /** Delay in milliseconds before scanning after file changes. */
    scanDelay?: number;
    /** Paths that the plugin watches for changes to trigger a rescan. */
    watchPaths?: string[];
    /**
     * Directory paths to scan for source files.
     * @deprecated Use `watchPaths` instead. This option will be removed in the next major version.
     */
    sourceDirectories?: string[];
    /**
     * Directory path to scan for source files.
     * @deprecated Use `watchPaths` instead. This option will be removed in the next major version.
     */
    sourceDirectory?: string;
    /** Path to tsconfig.json for project resolution. */
    tsConfigFilePath?: string;
};
type WithPartitioning = BaseOptions & {
    /** Enable splitting translation keys into separate client and server bundles. */
    applyPartitioning: true;
    /** Identifiers for client- and server-side translation functions. */
    partitioningOptions?: {
        /** Name of the client-side translation function. */
        clientFunction?: string;
        /** Name of the server-side translation function. */
        serverFunction?: string;
    };
};
type WithoutPartitioning = BaseOptions & {
    /** Disable partitioning; scan all translation functions together. */
    applyPartitioning?: false;
    /** Function name or names to scan for translation keys. */
    translationFunctions?: string[];
};
type IntlWatcherOptions = SimplifyDeep<RequiredDeep<CreateIntlWatcherOptions>>;

export type { CreateIntlWatcherOptions, IntlWatcherOptions, WithPartitioning, WithoutPartitioning };