@verbaly/compiler 0.10.0 → 0.12.0

package/dist/index.d.ts

@@ -1,84 +1,93 @@
-import MagicString from 'magic-string';
-
+import { RichLink } from "verbaly";
+import MagicString from "magic-string";
+//#region src/analyze.d.ts
 interface TaggedParam {
-    name: string;
-    start: number;
-    end: number;
+  name: string;
+  start: number;
+  end: number;
 }
 interface TransComponent {
-    name: string;
-    source: string;
+  name: string;
+  source: string;
 }
 interface TaggedMessage {
-    key: string;
-    message: string;
-    params: TaggedParam[];
-    start: number;
-    end: number;
-    tagStart: number;
-    tagEnd: number;
-    file: string;
-    jsx?: {
-        name: string;
-        components: TransComponent[];
-    };
+  key: string;
+  message: string;
+  params: TaggedParam[];
+  start: number;
+  end: number;
+  tagStart: number;
+  tagEnd: number;
+  file: string;
+  jsx?: {
+    name: string;
+    components: TransComponent[];
+  };
 }
 interface UsedKey {
-    key: string;
-    file: string;
+  key: string;
+  file: string;
 }
 interface Analysis {
-    tagged: TaggedMessage[];
-    usedKeys: UsedKey[];
+  tagged: TaggedMessage[];
+  usedKeys: UsedKey[];
 }
 declare function analyze(code: string, file: string): Analysis;
-
+//#endregion
+//#region src/translate.d.ts
 interface TranslateRequest {
-    sourceLocale: string;
-    targetLocale: string;
-    messages: Record<string, string>;
+  sourceLocale: string;
+  targetLocale: string;
+  messages: Record<string, string>;
 }
 type TranslateProvider = (request: TranslateRequest) => Promise<Record<string, string>>;
 interface TranslateOptions {
-    locales?: string[];
-    batchSize?: number;
-    dryRun?: boolean;
+  locales?: string[];
+  batchSize?: number;
+  dryRun?: boolean;
 }
 interface TranslateResult {
-    translated: Record<string, string[]>;
-    invalid: Record<string, string[]>;
-    pending: Record<string, string[]>;
+  translated: Record<string, string[]>;
+  invalid: Record<string, string[]>;
+  pending: Record<string, string[]>;
 }
 declare function translateCatalogs(cfg: ResolvedConfig, catalogs: Catalogs, provider: TranslateProvider, options?: TranslateOptions): Promise<TranslateResult>;
 declare function structureMatches(source: string, translated: string): boolean;
-
+//#endregion
+//#region src/config.d.ts
 interface TranslateConfig {
-    provider?: 'claude' | TranslateProvider;
-    model?: string;
-    batchSize?: number;
+  provider?: 'claude' | TranslateProvider;
+  model?: string;
+  batchSize?: number;
+}
+interface RenderConfig {
+  links?: Record<string, RichLink>;
 }
 interface VerbalyConfig {
-    root?: string;
-    dir?: string;
-    sourceLocale?: string;
-    locales?: string[];
-    include?: string[];
-    exclude?: string[];
-    translate?: TranslateConfig;
+  root?: string;
+  dir?: string;
+  sourceLocale?: string;
+  locales?: string[];
+  include?: string[];
+  exclude?: string[];
+  translate?: TranslateConfig;
+  render?: RenderConfig;
 }
 interface ResolvedConfig {
-    root: string;
-    dir: string;
-    sourceLocale: string;
-    locales: string[];
-    include: string[];
-    exclude: string[];
-    translate: TranslateConfig;
+  root: string;
+  dir: string;
+  sourceLocale: string;
+  locales: string[];
+  include: string[];
+  exclude: string[];
+  translate: TranslateConfig;
+  render: RenderConfig;
 }
 declare function resolveConfig(config?: VerbalyConfig): ResolvedConfig;
 declare function loadConfigFile(root: string): Promise<VerbalyConfig>;
 declare function loadConfig(root: string, overrides?: VerbalyConfig): Promise<ResolvedConfig>;
-
+//#endregion
+//#region src/catalog.d.ts
 type Catalog = Record<string, string>;
 type Catalogs = Record<string, Catalog>;
 declare function catalogPath(cfg: ResolvedConfig, locale: string): string;
@@ -86,92 +95,122 @@ declare function readCatalog(cfg: ResolvedConfig, locale: string): Catalog;
 declare function loadCatalogs(cfg: ResolvedConfig): Catalogs;
 declare function serializeCatalog(catalog: Catalog): string;
 declare function writeCatalog(cfg: ResolvedConfig, locale: string, catalog: Catalog): string;
-
+//#endregion
+//#region src/registry.d.ts
 declare class MessageRegistry {
-    private files;
-    update(file: string, analysis: Analysis): void;
-    remove(file: string): void;
-    messages(): Map<string, TaggedMessage>;
-    usedKeys(): Map<string, string[]>;
-}
-
+  private files;
+  update(file: string, analysis: Analysis): void;
+  remove(file: string): void;
+  messages(): Map<string, TaggedMessage>;
+  usedKeys(): Map<string, string[]>;
+}
+//#endregion
+//#region src/check.d.ts
 interface MissingEntry {
-    locale: string;
-    key: string;
-    source?: string;
+  locale: string;
+  key: string;
+  source?: string;
 }
 interface UnknownEntry {
-    key: string;
-    files: string[];
+  key: string;
+  files: string[];
 }
 interface CheckResult {
-    ok: boolean;
-    missing: MissingEntry[];
-    unknown: UnknownEntry[];
+  ok: boolean;
+  missing: MissingEntry[];
+  unknown: UnknownEntry[];
 }
 declare function check(cfg: ResolvedConfig, catalogs: Catalogs, registry: MessageRegistry): CheckResult;
 declare function formatCheckResult(result: CheckResult): string;
-
+//#endregion
+//#region src/codegen.d.ts
 declare const VIRTUAL_ID = "virtual:verbaly";
 declare function generateRuntimeModule(cfg: ResolvedConfig): string;
 declare function generateLocaleModule(catalog: Catalog): string;
 declare function generateDts(entries: Map<string, string>): string;
 declare function writeDts(cfg: ResolvedConfig, entries: Map<string, string>): void;
-
+//#endregion
+//#region src/extract.d.ts
 declare function extractProject(cfg: ResolvedConfig): Promise<MessageRegistry>;
 interface SyncResult {
-    added: Record<string, string[]>;
+  added: Record<string, string[]>;
 }
 declare function syncCatalogs(cfg: ResolvedConfig, catalogs: Catalogs, registry: MessageRegistry): SyncResult;
 declare function pruneCatalogs(cfg: ResolvedConfig, catalogs: Catalogs, registry: MessageRegistry): Record<string, string[]>;
-
+//#endregion
+//#region src/init.d.ts
+interface InitOptions {
+  root?: string;
+  dir?: string;
+  sourceLocale?: string;
+  locales?: string[];
+}
+interface InitResult {
+  created: string[];
+  skipped: string[];
+  bundler: 'vite' | 'webpack' | 'rollup' | 'rspack' | 'esbuild' | undefined;
+  configFile: string;
+  next: string[];
+}
+declare function detectBundler(root: string): InitResult['bundler'];
+declare function init(options?: InitOptions): InitResult;
+//#endregion
+//#region src/key.d.ts
 declare function stableKey(message: string): string;
-
+//#endregion
+//#region src/params.d.ts
 type ParamType = 'number' | 'string' | 'date' | 'unknown';
 declare function collectParams(message: string): Map<string, Set<ParamType>>;
 declare function renderParamType(types: Set<ParamType>): string;
-
+//#endregion
+//#region src/providers/claude.d.ts
 interface ClaudeProviderOptions {
-    model?: string;
-    apiKey?: string;
-    maxTokens?: number;
+  model?: string;
+  apiKey?: string;
+  maxTokens?: number;
 }
 declare function claudeProvider(options?: ClaudeProviderOptions): TranslateProvider;
-
+//#endregion
+//#region src/pseudo.d.ts
 declare const PSEUDO_LOCALE = "en-XA";
 declare function pseudoLocalize(message: string): string;
 declare function pseudoCatalogs(cfg: ResolvedConfig, catalogs: Catalogs, locale?: string): string[];
-
+//#endregion
+//#region src/render.d.ts
 interface RenderHtmlOptions {
-    locale: string;
-    catalogs: Catalogs;
-    sourceLocale?: string;
-    attribute?: string;
-    richTags?: string[];
-    setLang?: boolean;
+  locale: string;
+  catalogs: Catalogs;
+  sourceLocale?: string;
+  attribute?: string;
+  richTags?: string[];
+  richLinks?: Record<string, RichLink>;
+  setLang?: boolean;
 }
 interface RenderHtmlResult {
-    html: string;
-    missing: string[];
+  html: string;
+  missing: string[];
 }
 declare function renderHtml(html: string, options: RenderHtmlOptions): RenderHtmlResult;
 interface RenderSiteOptions {
-    site?: string;
-    locales?: string[];
-    attribute?: string;
-    richTags?: string[];
+  site?: string;
+  locales?: string[];
+  attribute?: string;
+  richTags?: string[];
+  richLinks?: Record<string, RichLink>;
 }
 interface RenderSiteResult {
-    files: number;
-    locales: string[];
-    missing: Record<string, string[]>;
+  files: number;
+  locales: string[];
+  missing: Record<string, string[]>;
 }
 declare function renderSite(cfg: ResolvedConfig, options?: RenderSiteOptions): Promise<RenderSiteResult>;
-
+//#endregion
+//#region src/transform.d.ts
 interface TransformResult {
-    code: string;
-    map: ReturnType<MagicString['generateMap']>;
+  code: string;
+  map: ReturnType<MagicString['generateMap']>;
 }
 declare function transformCode(code: string, file: string, analysis?: Analysis): TransformResult | null;
-
-export { type Analysis, type Catalog, type Catalogs, type CheckResult, type ClaudeProviderOptions, MessageRegistry, type MissingEntry, PSEUDO_LOCALE, type ParamType, type RenderHtmlOptions, type RenderHtmlResult, type RenderSiteOptions, type RenderSiteResult, type ResolvedConfig, type SyncResult, type TaggedMessage, type TaggedParam, type TransComponent, type TransformResult, type TranslateConfig, type TranslateOptions, type TranslateProvider, type TranslateRequest, type TranslateResult, type UnknownEntry, type UsedKey, VIRTUAL_ID, type VerbalyConfig, analyze, catalogPath, check, claudeProvider, collectParams, extractProject, formatCheckResult, generateDts, generateLocaleModule, generateRuntimeModule, loadCatalogs, loadConfig, loadConfigFile, pruneCatalogs, pseudoCatalogs, pseudoLocalize, readCatalog, renderHtml, renderParamType, renderSite, resolveConfig, serializeCatalog, stableKey, structureMatches, syncCatalogs, transformCode, translateCatalogs, writeCatalog, writeDts };
+//#endregion
+export { type Analysis, type Catalog, type Catalogs, type CheckResult, type ClaudeProviderOptions, type InitOptions, type InitResult, MessageRegistry, type MissingEntry, PSEUDO_LOCALE, type ParamType, type RenderConfig, type RenderHtmlOptions, type RenderHtmlResult, type RenderSiteOptions, type RenderSiteResult, type ResolvedConfig, type SyncResult, type TaggedMessage, type TaggedParam, type TransComponent, type TransformResult, type TranslateConfig, type TranslateOptions, type TranslateProvider, type TranslateRequest, type TranslateResult, type UnknownEntry, type UsedKey, VIRTUAL_ID, type VerbalyConfig, analyze, catalogPath, check, claudeProvider, collectParams, detectBundler, extractProject, formatCheckResult, generateDts, generateLocaleModule, generateRuntimeModule, init, loadCatalogs, loadConfig, loadConfigFile, pruneCatalogs, pseudoCatalogs, pseudoLocalize, readCatalog, renderHtml, renderParamType, renderSite, resolveConfig, serializeCatalog, stableKey, structureMatches, syncCatalogs, transformCode, translateCatalogs, writeCatalog, writeDts };
+//# sourceMappingURL=index.d.ts.map