@i18nprune/core 0.1.0

package/dist/config.d.ts

@@ -0,0 +1,201 @@
+import { I as I18nPruneConfig, L as LocalesFilesystemConfig, b as LocalesFilesystemConfig$1, c as LocaleLeafPathApi, d as ScannerConfigInput, e as ScannerConfigResolved, R as ResolveScannerConfigOptions, f as I18nPruneConfigParsed, g as ReferenceCommandOverrides } from './root-2-kCaBvQ.js';
+export { C as CacheConfig, h as ConfigValidationError, E as EffectiveReferenceConfig, i as LocaleLeavesConfig, M as MissingCommandConfig, O as OutputConfig, j as OutputListConfig, P as ParityPolicy, k as PatchingConfig, l as Policies, a as PreservePolicy, m as ReferenceCommands, n as ReferenceConfig, o as ReferenceDefaults, S as StringPresencePolicy, p as TranslateConfig, q as TranslateMaxWorkersConfig, r as TranslatePolicyConfig, s as TranslateProviderRow, t as TranslateProviderRowDeepL, u as TranslateProviderRowGoogle, v as TranslateProviderRowLibre, w as TranslateProviderRowLlm, x as TranslateProviderRowMymemory, y as TranslateRateLimitConfig, U as UncertainKeyPolicy, z as configSchema, A as isConfigValidationError, B as localesFilesystemSchema, D as parseI18nPruneConfig } from './root-2-kCaBvQ.js';
+import { R as RuntimeFsPort } from './fs-BUYD8ZhA.js';
+import { C as CacheProfileId } from './profile-BwOP9WKh.js';
+import { L as ListWindowResolved, R as ResolveListWindowOptions } from './listWindow-XEFxQZi1.js';
+import { R as Result } from './index-X50E1FIX.js';
+import { b as ConfigPathSystemRuntime } from './capabilities-x74cD2Hu.js';
+import { T as TranslationProviderId } from './providers-0uMEfT6q.js';
+import { T as TranslateConfigInput, R as ResolvedTranslateConfig, b as ResolveTranslateWarning } from './translate-CIHYp7wi.js';
+export { c as ResolvedTranslateProviderRow, d as TranslatePolicyConfigInput, e as TranslateProviderRowInput, f as TranslateRateLimitConfigInput } from './translate-CIHYp7wi.js';
+import 'zod';
+import './path-Bfn3SAts.js';
+
+/**
+ * Typed helper for **`i18nprune.config.{ts,mts,cts,js,mjs,cjs}`** files. Merges partial user input
+ * with **`DEFAULT_CONFIG`** and normalizes a few fields (notably **`translate.workers`** clamping)
+ * so the returned value matches what the CLI / SDK see at runtime.
+ *
+ * Returns the public friendly **`I18nPruneConfig`** directly — drop it straight into
+ * **`createCoreContext`**:
+ *
+ * @example
+ * ```ts
+ * // i18nprune.config.ts
+ * import { defineConfig } from '@i18nprune/core';
+ *
+ * export default defineConfig({
+ *   locales: {
+ *     source: 'en',
+ *     directory: 'locales',
+ *   },
+ *   src: 'src',
+ *   functions: ['t'],
+ *   translate: {
+ *     primary: 'google',
+ *     providers: [{ id: 'google' }],
+ *   },
+ * });
+ * ```
+ *
+ * @remarks
+ * - **`.json`** configs are intentionally not loaded by the CLI - see
+ *   **`SUPPORTED_CONFIG_EXTENSIONS`** in **`packages/cli/src/shared/config/paths.ts`**.
+ * - **`locales.source`** and the zod schema are validated when the CLI loads the file via
+ *   **`parseI18nPruneConfig`** (same path as a plain `export default { … }` config). Use
+ *   **`parseI18nPruneConfig`** directly for REST / DB / generated sources.
+ * - Call this once per project; the file is loaded by the CLI host (or by an SDK consumer with
+ *   **`loadCoreConfigFromPath`**).
+ */
+declare function defineConfig(config: Partial<I18nPruneConfig>): I18nPruneConfig;
+
+/** Clamp `translate.workers` / CLI `--workers` to `1…64`. */
+declare function clampTranslateMaxWorkers(n: number): number;
+
+/**
+ * Soft compatibility checks for `locales.mode` + `locales.structure` (warn only — does not block parse).
+ *
+ * @remarks Prefer this over zod `.superRefine` when the config should still load; hosts log warnings via
+ * `normalizeConfigRuntimeFields` (CLI) or equivalent.
+ */
+declare function collectLocalesFilesystemConfigWarnings(locales: LocalesFilesystemConfig): string[];
+
+type LocalesSourceInputKind = 'language_code' | 'path' | 'json_filename' | 'invalid_shape';
+type LocalesSourceValidationResult = {
+    ok: true;
+    code: string;
+} | {
+    ok: false;
+    issueCode: string;
+    message: string;
+};
+
+/** Classify raw `locales.source` before catalog / bundle checks. */
+declare function classifyLocalesSourceInput(raw: string): LocalesSourceInputKind;
+/**
+ * Validate `locales.source` is a supported language code (not a path or `*.json` basename).
+ * Used at config parse, CLI normalize, and readiness.
+ */
+declare function validateLocalesSourceConfigValue(raw: string): LocalesSourceValidationResult;
+/** Readiness: configured source code has no matching locale segments under `locales.directory`. */
+declare function issueLocalesSourceNotInBundle(input: {
+    sourceCode: string;
+    directory: string;
+    presentCodes: readonly string[];
+}): {
+    issueCode: string;
+    message: string;
+};
+
+/** Resolve the on-disk primary source locale JSON file from `locales.source` (language code). */
+declare function resolveSourceLocaleAbsolutePath(input: {
+    locales: LocalesFilesystemConfig$1;
+    directoryAbsolute: string;
+    path: LocaleLeafPathApi;
+    fs?: RuntimeFsPort;
+}): string;
+/** Resolve source locale absolute path from project-relative archive paths (zip / upload prepare). */
+declare function resolveSourceLocaleAbsoluteFromRelPaths(input: {
+    locales: LocalesFilesystemConfig$1;
+    directoryAbsolute: string;
+    projectRootAbsolute: string;
+    path: LocaleLeafPathApi;
+    relPaths: readonly string[];
+}): string;
+
+type OutputListConfigInput = {
+    top?: number;
+    full?: boolean;
+    /** Optional override for the hard safety cap (still validated/clamped in core). */
+    maxCap?: number;
+};
+type CoreConfigInput = {
+    output?: {
+        list?: OutputListConfigInput;
+    };
+    scanner?: ScannerConfigInput;
+    cache?: {
+        enabled?: boolean;
+        dir?: string;
+        profile?: CacheProfileId;
+        mode?: 'readWrite' | 'readOnly';
+        rebuild?: 'partial' | 'full';
+        fullRescanThresholdPercent?: number;
+    };
+};
+type CoreConfigResolved = {
+    output: {
+        list: ListWindowResolved;
+    };
+    scanner: ScannerConfigResolved;
+    cache: {
+        enabled: boolean;
+        profile: CacheProfileId;
+        dir?: string;
+        mode: 'readWrite' | 'readOnly';
+        rebuild: 'partial' | 'full';
+        fullRescanThresholdPercent: number;
+    };
+};
+type ResolveCoreConfigOptions = {
+    listWindow?: ResolveListWindowOptions;
+    scanner?: ResolveScannerConfigOptions;
+};
+
+type CoreConfigLayer = {
+    /** Optional label for debugging/traceability (host-defined). */
+    name?: string;
+    input: CoreConfigInput;
+};
+type ParseConfigText = (text: string, configPath: string) => unknown | Promise<unknown>;
+type LoadCoreConfigFromPathInput = {
+    configPath: string;
+    readText: (configPath: string) => string | Promise<string>;
+    parseText?: ParseConfigText;
+    resolveOptions?: ResolveCoreConfigOptions;
+    runtime?: ConfigPathSystemRuntime;
+};
+
+/** Explicit base defaults for core-resolved config domains. */
+declare const CORE_CONFIG_DEFAULT_INPUT: CoreConfigInput;
+
+/** Baseline reference policy copied into defaults and per-command overrides. */
+declare const REFERENCE_POLICY_SAFE_DEFAULTS: ReferenceCommandOverrides;
+/** Canonical app config defaults (shared by all hosts). */
+declare const DEFAULT_CONFIG: I18nPruneConfigParsed;
+
+/** Load + parse + resolve core config from a given path using host-provided I/O. */
+declare function loadCoreConfigFromPath(input: LoadCoreConfigFromPathInput): Promise<CoreConfigResolved>;
+/**
+ * Non-throwing helper for clients that prefer Result envelopes over exceptions.
+ */
+declare function tryLoadCoreConfigFromPath(input: LoadCoreConfigFromPathInput, cwd?: string): Promise<Result<'core.config', CoreConfigResolved>>;
+
+declare function mergeCoreConfigInputs(a: CoreConfigInput | undefined, b: CoreConfigInput | undefined): CoreConfigInput;
+/** Resolve portable core config (defaults + clamp rules), independent of any host parser. */
+declare function resolveCoreConfig(input?: CoreConfigInput, options?: ResolveCoreConfigOptions): CoreConfigResolved;
+/**
+ * Resolve core config from multiple layers. Merge semantics: later layers override earlier.
+ * Hosts can use this to combine defaults + file config + flags in a deterministic order.
+ */
+declare function resolveCoreConfigLayers(layers: readonly CoreConfigLayer[], options?: ResolveCoreConfigOptions): CoreConfigResolved;
+
+/**
+ * Deep-merge a partial config object onto a base (typically zip-resolved config).
+ * Nested plain objects merge recursively; arrays and primitives replace.
+ */
+declare function mergePartialConfigIntoBase(base: Record<string, unknown> | null | undefined, partial: Record<string, unknown>): Record<string, unknown>;
+
+declare function resolveTranslateConfig(input: {
+    config: TranslateConfigInput | undefined;
+    env?: Record<string, string | undefined>;
+    pin?: {
+        providerId?: TranslationProviderId;
+        workers?: number;
+    };
+}): {
+    resolved: ResolvedTranslateConfig;
+    warnings: ResolveTranslateWarning[];
+};
+
+export { CORE_CONFIG_DEFAULT_INPUT, type CoreConfigInput, type CoreConfigLayer, type CoreConfigResolved, DEFAULT_CONFIG, I18nPruneConfig, type LoadCoreConfigFromPathInput, LocalesFilesystemConfig, type LocalesSourceInputKind, type LocalesSourceValidationResult, REFERENCE_POLICY_SAFE_DEFAULTS, ReferenceCommandOverrides, type ResolveCoreConfigOptions, ResolveTranslateWarning, ResolvedTranslateConfig, TranslateConfigInput, clampTranslateMaxWorkers, classifyLocalesSourceInput, collectLocalesFilesystemConfigWarnings, defineConfig, issueLocalesSourceNotInBundle, loadCoreConfigFromPath, mergeCoreConfigInputs, mergePartialConfigIntoBase, resolveCoreConfig, resolveCoreConfigLayers, resolveSourceLocaleAbsoluteFromRelPaths, resolveSourceLocaleAbsolutePath, resolveTranslateConfig, tryLoadCoreConfigFromPath, validateLocalesSourceConfigValue };