rendercv-ts 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,195 @@
+import { C as ClassicTheme, L as Locale, R as RenderCVModel, Y as YamlDocumentBundle, O as OverlayDocuments, a as YamlSource, b as RenderCVValidationError } from './typst_setup-WebjDI32.cjs';
+export { c as Cv, d as LocaleName, e as RenderCVInternalError, f as RenderCVUserError, g as RenderCVUserValidationError, h as RenderCvModelSchema, i as buildRendercvModel, j as clearFontCache, k as configureBrowserWasm, l as cvSchema, p as preloadTypst } from './typst_setup-WebjDI32.cjs';
+import { z, ZodIssue } from 'zod';
+import 'yaml';
+
+/**
+ * Variant generator — TS replacement for Python's `variant_pydantic_model_generator.py`.
+ *
+ * The Python version dynamically builds new Pydantic classes with overridden
+ * defaults at import time. In Zod we don't need new classes — every theme has
+ * the *same shape* (it's all ClassicTheme), they differ only in default values.
+ *
+ * Our approach keeps everything as RAW INPUT data (strings, plain objects) and
+ * lets ClassicThemeSchema do the parsing:
+ *   1. Define `RAW_CLASSIC_DEFAULTS` — plain JSON of classic's default values
+ *      (color values are strings like "rgb(0, 79, 144)", NOT Color instances).
+ *   2. Each theme is described by a plain JSON config object (`ThemeConfig`) —
+ *      a deep-merge overlay over classic defaults.
+ *   3. `buildThemeSchema(themeConfig)` produces a Zod schema whose input is
+ *      deep-merged (rawDefaults over user input) and then parsed by
+ *      ClassicThemeSchema. The `theme` field is pinned via the overlay.
+ *
+ * This sidesteps the type-mismatch that arises when pre-parsed Color objects
+ * are fed back into a `z.string().transform(Color)` schema.
+ */
+
+/** All theme names rendercv ships with (classic + 8 variants). */
+declare const THEME_NAMES: readonly ["classic", "ember", "engineeringclassic", "engineeringresumes", "harvard", "ink", "moderncv", "opal", "sb2nov"];
+type ThemeName = (typeof THEME_NAMES)[number];
+
+/**
+ * Design — ported from `design/design.py` + `design/built_in_design.py`.
+ */
+
+declare const DesignSchema: z.ZodType<ClassicTheme>;
+declare const availableThemes: readonly string[];
+
+/**
+ * Locales registry + LocaleSchema dispatcher.
+ *
+ * The 21 locale YAMLs (copied verbatim from the Python source) are imported
+ * as raw strings via Vite/Node's `?raw` suffix and parsed at module load by
+ * the `yaml` package. Each becomes a deep-merge overlay over English defaults.
+ *
+ * LocaleSchema dispatches to the matching variant based on the `language`
+ * field — same pattern as DesignSchema.
+ */
+
+/**
+ * LocaleSchema — dispatches to the right locale based on the `language` field.
+ */
+declare const LocaleSchema: z.ZodType<Locale>;
+/** All locale names exported for callers (UI dropdowns, schema gen). */
+declare const availableLocales: readonly string[];
+
+/** Options accepted by buildRendercvModelFromYaml(). */
+interface BuildOptions {
+    /** Relative-path assets (path → URL or data URL) for photo/overlay files. */
+    assets?: Record<string, string>;
+    designYaml?: string;
+    localeYaml?: string;
+    settingsYaml?: string;
+    outputFolder?: string;
+    typstPath?: string;
+    pdfPath?: string;
+    markdownPath?: string;
+    htmlPath?: string;
+    pngPath?: string;
+    dontGenerateTypst?: boolean;
+    dontGenerateHtml?: boolean;
+    dontGenerateMarkdown?: boolean;
+    dontGeneratePdf?: boolean;
+    dontGeneratePng?: boolean;
+    overrides?: Record<string, unknown>;
+}
+interface BuildResult {
+    model: RenderCVModel;
+    dictionary: Record<string, unknown>;
+    documents: {
+        main: YamlDocumentBundle;
+        overlays: OverlayDocuments;
+    };
+}
+declare function readYaml(content: string, source: YamlSource): unknown;
+declare function buildRendercvModelFromYaml(mainYaml: string, opts?: BuildOptions): BuildResult;
+declare function setByDottedPath(target: Record<string, unknown> | unknown[], fullPath: string, value: unknown): void;
+
+interface ParseValidationErrorsOptions {
+    mainDocument: YamlDocumentBundle;
+    overlayDocuments?: OverlayDocuments;
+}
+declare function parseValidationErrors(issues: readonly ZodIssue[], options: ParseValidationErrorsOptions): RenderCVValidationError[];
+
+/**
+ * Render options for browser-oriented rendering.
+ */
+interface RenderOptions {
+    /** Map of asset paths/keys to bundled content (e.g. photo data URLs, lib.typ text). */
+    assets?: Record<string, string>;
+    /** Optional user template overrides keyed by relative template path. */
+    customTemplates?: Record<string, string>;
+}
+
+/**
+ * Typst generation — browser port of `typst.py` (returns string, no filesystem).
+ */
+
+declare function generateTypst(rendercvModel: RenderCVModel, options?: RenderOptions): string | null;
+
+/**
+ * Markdown generation — browser port of `markdown.py` (returns string, no filesystem).
+ */
+
+declare function generateMarkdown(rendercvModel: RenderCVModel, options?: RenderOptions): string | null;
+
+/**
+ * HTML generation — browser port of `html.py` (returns string, no filesystem).
+ */
+
+declare function generateHtml(rendercvModel: RenderCVModel, options?: RenderOptions): string | null;
+
+declare global {
+    var __rendercvRasterizeSvgToPng: ((svg: string, widthPx: number, heightPx: number, backgroundColor: string) => Promise<Uint8Array>) | undefined;
+}
+declare function generatePdf(rendercvModel: RenderCVModel, options?: RenderOptions): Promise<Uint8Array | null>;
+declare function generatePng(rendercvModel: RenderCVModel, options?: RenderOptions): Promise<Uint8Array[] | null>;
+
+/** Discriminator-free registry: entry-type name → schema factory. */
+declare const ENTRY_TYPE_NAMES: readonly ["OneLineEntry", "NormalEntry", "ExperienceEntry", "EducationEntry", "PublicationEntry", "BulletEntry", "NumberedEntry", "ReversedNumberedEntry", "TextEntry"];
+type EntryTypeName = (typeof ENTRY_TYPE_NAMES)[number];
+
+/**
+ * Section validation + entry-type inference — ported from `cv/section.py`.
+ */
+
+/** A validated section: title (post-formatting), entry type, entries. */
+interface RenderCVSection {
+    title: string;
+    entryType: EntryTypeName;
+    entries: unknown[];
+}
+
+interface ProcessedCvFields {
+    _plainName?: string | null;
+    _plain_name?: string | null;
+    _connections?: string[];
+    _topNote?: string;
+    _top_note?: string;
+    _footer?: string;
+    photo?: string;
+    photo_name?: string;
+    _rendercvSections?: RenderCVSection[];
+    [key: string]: unknown;
+}
+type ProcessedRenderCVModel = RenderCVModel & {
+    cv: RenderCVModel['cv'] & ProcessedCvFields;
+};
+declare function processModel(rendercvModel: RenderCVModel, fileType: 'typst' | 'markdown', options?: RenderOptions): ProcessedRenderCVModel;
+
+/**
+ * Path placeholder expansion — browser port of `path_resolver.py` (no filesystem).
+ */
+
+declare function buildNameVariants(name: string | null | undefined): Record<string, string>;
+declare function resolveRendercvFilePath(rendercvModel: RenderCVModel, filePath: string): string;
+
+declare function configureBrowserFonts(baseUrl?: string): void;
+
+interface RendercvAssetPaths {
+    wasmBaseUrl: string;
+    fontsBaseUrl: string;
+}
+/** Default browser URLs when assets are served from the app origin (e.g. /wasm, /fonts). */
+declare function resolveBundledAssetPaths(origin?: string): RendercvAssetPaths;
+/**
+ * Configure font/WASM loading. In the browser, defaults to `{origin}/wasm` and `{origin}/fonts`.
+ * In Node (tests), loads WASM bytes from the bundled assets/ directory on disk.
+ */
+declare function configureDefaultAssets(options?: {
+    origin?: string;
+}): Promise<RendercvAssetPaths>;
+
+/** Auto-generated by scripts/generate-connection-icons.mjs — do not edit. */
+declare const PRESET_ICON_IDS: readonly ["envelope", "phone", "link", "location-dot", "linkedin", "github", "gitlab", "imdb", "instagram", "mastodon", "orcid", "stack-overflow", "researchgate", "youtube", "graduation-cap", "telegram", "whatsapp", "code", "x-twitter", "bluesky", "reddit", "external-link"];
+
+/** Map YAML custom_connections.fontawesome_icon values to bundled SVG preset ids. */
+declare function resolveIconId(iconName: string): string;
+
+/**
+ * rendercv-ts — TypeScript port (browser programmatic API).
+ */
+
+declare const VERSION = "0.1.0";
+
+export { type BuildOptions, type BuildResult, ClassicTheme, DesignSchema, Locale, LocaleSchema, PRESET_ICON_IDS, type ProcessedRenderCVModel, RenderCVModel, RenderCVValidationError, type RenderOptions, type RendercvAssetPaths, THEME_NAMES, type ThemeName, VERSION, availableLocales, availableThemes, buildNameVariants, buildRendercvModelFromYaml, configureBrowserFonts, configureDefaultAssets, generateHtml, generateMarkdown, generatePdf, generatePng, generateTypst, parseValidationErrors, processModel, readYaml, resolveBundledAssetPaths, resolveIconId, resolveRendercvFilePath, setByDottedPath };

package/dist/index.d.ts

@@ -0,0 +1,195 @@
+import { C as ClassicTheme, L as Locale, R as RenderCVModel, Y as YamlDocumentBundle, O as OverlayDocuments, a as YamlSource, b as RenderCVValidationError } from './typst_setup-WebjDI32.js';
+export { c as Cv, d as LocaleName, e as RenderCVInternalError, f as RenderCVUserError, g as RenderCVUserValidationError, h as RenderCvModelSchema, i as buildRendercvModel, j as clearFontCache, k as configureBrowserWasm, l as cvSchema, p as preloadTypst } from './typst_setup-WebjDI32.js';
+import { z, ZodIssue } from 'zod';
+import 'yaml';
+
+/**
+ * Variant generator — TS replacement for Python's `variant_pydantic_model_generator.py`.
+ *
+ * The Python version dynamically builds new Pydantic classes with overridden
+ * defaults at import time. In Zod we don't need new classes — every theme has
+ * the *same shape* (it's all ClassicTheme), they differ only in default values.
+ *
+ * Our approach keeps everything as RAW INPUT data (strings, plain objects) and
+ * lets ClassicThemeSchema do the parsing:
+ *   1. Define `RAW_CLASSIC_DEFAULTS` — plain JSON of classic's default values
+ *      (color values are strings like "rgb(0, 79, 144)", NOT Color instances).
+ *   2. Each theme is described by a plain JSON config object (`ThemeConfig`) —
+ *      a deep-merge overlay over classic defaults.
+ *   3. `buildThemeSchema(themeConfig)` produces a Zod schema whose input is
+ *      deep-merged (rawDefaults over user input) and then parsed by
+ *      ClassicThemeSchema. The `theme` field is pinned via the overlay.
+ *
+ * This sidesteps the type-mismatch that arises when pre-parsed Color objects
+ * are fed back into a `z.string().transform(Color)` schema.
+ */
+
+/** All theme names rendercv ships with (classic + 8 variants). */
+declare const THEME_NAMES: readonly ["classic", "ember", "engineeringclassic", "engineeringresumes", "harvard", "ink", "moderncv", "opal", "sb2nov"];
+type ThemeName = (typeof THEME_NAMES)[number];
+
+/**
+ * Design — ported from `design/design.py` + `design/built_in_design.py`.
+ */
+
+declare const DesignSchema: z.ZodType<ClassicTheme>;
+declare const availableThemes: readonly string[];
+
+/**
+ * Locales registry + LocaleSchema dispatcher.
+ *
+ * The 21 locale YAMLs (copied verbatim from the Python source) are imported
+ * as raw strings via Vite/Node's `?raw` suffix and parsed at module load by
+ * the `yaml` package. Each becomes a deep-merge overlay over English defaults.
+ *
+ * LocaleSchema dispatches to the matching variant based on the `language`
+ * field — same pattern as DesignSchema.
+ */
+
+/**
+ * LocaleSchema — dispatches to the right locale based on the `language` field.
+ */
+declare const LocaleSchema: z.ZodType<Locale>;
+/** All locale names exported for callers (UI dropdowns, schema gen). */
+declare const availableLocales: readonly string[];
+
+/** Options accepted by buildRendercvModelFromYaml(). */
+interface BuildOptions {
+    /** Relative-path assets (path → URL or data URL) for photo/overlay files. */
+    assets?: Record<string, string>;
+    designYaml?: string;
+    localeYaml?: string;
+    settingsYaml?: string;
+    outputFolder?: string;
+    typstPath?: string;
+    pdfPath?: string;
+    markdownPath?: string;
+    htmlPath?: string;
+    pngPath?: string;
+    dontGenerateTypst?: boolean;
+    dontGenerateHtml?: boolean;
+    dontGenerateMarkdown?: boolean;
+    dontGeneratePdf?: boolean;
+    dontGeneratePng?: boolean;
+    overrides?: Record<string, unknown>;
+}
+interface BuildResult {
+    model: RenderCVModel;
+    dictionary: Record<string, unknown>;
+    documents: {
+        main: YamlDocumentBundle;
+        overlays: OverlayDocuments;
+    };
+}
+declare function readYaml(content: string, source: YamlSource): unknown;
+declare function buildRendercvModelFromYaml(mainYaml: string, opts?: BuildOptions): BuildResult;
+declare function setByDottedPath(target: Record<string, unknown> | unknown[], fullPath: string, value: unknown): void;
+
+interface ParseValidationErrorsOptions {
+    mainDocument: YamlDocumentBundle;
+    overlayDocuments?: OverlayDocuments;
+}
+declare function parseValidationErrors(issues: readonly ZodIssue[], options: ParseValidationErrorsOptions): RenderCVValidationError[];
+
+/**
+ * Render options for browser-oriented rendering.
+ */
+interface RenderOptions {
+    /** Map of asset paths/keys to bundled content (e.g. photo data URLs, lib.typ text). */
+    assets?: Record<string, string>;
+    /** Optional user template overrides keyed by relative template path. */
+    customTemplates?: Record<string, string>;
+}
+
+/**
+ * Typst generation — browser port of `typst.py` (returns string, no filesystem).
+ */
+
+declare function generateTypst(rendercvModel: RenderCVModel, options?: RenderOptions): string | null;
+
+/**
+ * Markdown generation — browser port of `markdown.py` (returns string, no filesystem).
+ */
+
+declare function generateMarkdown(rendercvModel: RenderCVModel, options?: RenderOptions): string | null;
+
+/**
+ * HTML generation — browser port of `html.py` (returns string, no filesystem).
+ */
+
+declare function generateHtml(rendercvModel: RenderCVModel, options?: RenderOptions): string | null;
+
+declare global {
+    var __rendercvRasterizeSvgToPng: ((svg: string, widthPx: number, heightPx: number, backgroundColor: string) => Promise<Uint8Array>) | undefined;
+}
+declare function generatePdf(rendercvModel: RenderCVModel, options?: RenderOptions): Promise<Uint8Array | null>;
+declare function generatePng(rendercvModel: RenderCVModel, options?: RenderOptions): Promise<Uint8Array[] | null>;
+
+/** Discriminator-free registry: entry-type name → schema factory. */
+declare const ENTRY_TYPE_NAMES: readonly ["OneLineEntry", "NormalEntry", "ExperienceEntry", "EducationEntry", "PublicationEntry", "BulletEntry", "NumberedEntry", "ReversedNumberedEntry", "TextEntry"];
+type EntryTypeName = (typeof ENTRY_TYPE_NAMES)[number];
+
+/**
+ * Section validation + entry-type inference — ported from `cv/section.py`.
+ */
+
+/** A validated section: title (post-formatting), entry type, entries. */
+interface RenderCVSection {
+    title: string;
+    entryType: EntryTypeName;
+    entries: unknown[];
+}
+
+interface ProcessedCvFields {
+    _plainName?: string | null;
+    _plain_name?: string | null;
+    _connections?: string[];
+    _topNote?: string;
+    _top_note?: string;
+    _footer?: string;
+    photo?: string;
+    photo_name?: string;
+    _rendercvSections?: RenderCVSection[];
+    [key: string]: unknown;
+}
+type ProcessedRenderCVModel = RenderCVModel & {
+    cv: RenderCVModel['cv'] & ProcessedCvFields;
+};
+declare function processModel(rendercvModel: RenderCVModel, fileType: 'typst' | 'markdown', options?: RenderOptions): ProcessedRenderCVModel;
+
+/**
+ * Path placeholder expansion — browser port of `path_resolver.py` (no filesystem).
+ */
+
+declare function buildNameVariants(name: string | null | undefined): Record<string, string>;
+declare function resolveRendercvFilePath(rendercvModel: RenderCVModel, filePath: string): string;
+
+declare function configureBrowserFonts(baseUrl?: string): void;
+
+interface RendercvAssetPaths {
+    wasmBaseUrl: string;
+    fontsBaseUrl: string;
+}
+/** Default browser URLs when assets are served from the app origin (e.g. /wasm, /fonts). */
+declare function resolveBundledAssetPaths(origin?: string): RendercvAssetPaths;
+/**
+ * Configure font/WASM loading. In the browser, defaults to `{origin}/wasm` and `{origin}/fonts`.
+ * In Node (tests), loads WASM bytes from the bundled assets/ directory on disk.
+ */
+declare function configureDefaultAssets(options?: {
+    origin?: string;
+}): Promise<RendercvAssetPaths>;
+
+/** Auto-generated by scripts/generate-connection-icons.mjs — do not edit. */
+declare const PRESET_ICON_IDS: readonly ["envelope", "phone", "link", "location-dot", "linkedin", "github", "gitlab", "imdb", "instagram", "mastodon", "orcid", "stack-overflow", "researchgate", "youtube", "graduation-cap", "telegram", "whatsapp", "code", "x-twitter", "bluesky", "reddit", "external-link"];
+
+/** Map YAML custom_connections.fontawesome_icon values to bundled SVG preset ids. */
+declare function resolveIconId(iconName: string): string;
+
+/**
+ * rendercv-ts — TypeScript port (browser programmatic API).
+ */
+
+declare const VERSION = "0.1.0";
+
+export { type BuildOptions, type BuildResult, ClassicTheme, DesignSchema, Locale, LocaleSchema, PRESET_ICON_IDS, type ProcessedRenderCVModel, RenderCVModel, RenderCVValidationError, type RenderOptions, type RendercvAssetPaths, THEME_NAMES, type ThemeName, VERSION, availableLocales, availableThemes, buildNameVariants, buildRendercvModelFromYaml, configureBrowserFonts, configureDefaultAssets, generateHtml, generateMarkdown, generatePdf, generatePng, generateTypst, parseValidationErrors, processModel, readYaml, resolveBundledAssetPaths, resolveIconId, resolveRendercvFilePath, setByDottedPath };