@yamlresume/core 0.9.1 → 0.10.1

package/dist/index.d.ts

@@ -166,6 +166,10 @@ declare const SpanishCountryNames: Record<Country, string>;
  */
 declare const FrenchCountryNames: Record<Country, string>;
 declare const NorwegianCountryNames: Record<Country, string>;
+/**
+ * Represents all possible countries & regions with their corresponding Dutch names.
+ */
+declare const DutchCountryNames: Record<Country, string>;
 
 /**
  * MIT License
@@ -202,10 +206,12 @@ declare const DEGREE_OPTIONS: readonly ["Middle School", "High School", "Diploma
 declare const FLUENCY_OPTIONS: readonly ["Elementary Proficiency", "Limited Working Proficiency", "Minimum Professional Proficiency", "Full Professional Proficiency", "Native or Bilingual Proficiency"];
 /** The options for the latex layout font size. */
 declare const LATEX_FONT_SIZE_OPTIONS: readonly ["10pt", "11pt", "12pt"];
+/** The options for the paper size. */
+declare const LATEX_PAPER_SIZE_OPTIONS: readonly ["a4", "letter"];
 /** The options for the HTML layout font size. */
 declare const HTML_FONT_SIZE_OPTIONS: readonly ["14px", "15px", "16px", "17px", "18px", "19px", "20px"];
 /** Defines identifiers for the available HTML layout templates. */
-declare const HTML_TEMPLATE_OPTIONS: readonly ["calm"];
+declare const HTML_TEMPLATE_OPTIONS: readonly ["calm", "vscode"];
 /** The options for the latex layout fontspec numbers style. */
 declare const LATEX_FONTSPEC_NUMBERS_OPTIONS: readonly ["Lining", "OldStyle", "Auto"];
 /** Defines identifiers for the available latex layout templates. */
@@ -229,7 +235,7 @@ declare const LEVEL_OPTIONS: readonly ["Novice", "Beginner", "Intermediate", "Ad
  *
  * @see {@link https://en.wikipedia.org/wiki/IETF_language_tag}
  */
-declare const LOCALE_LANGUAGE_OPTIONS: readonly ["en", "zh-hans", "zh-hant-hk", "zh-hant-tw", "es", "fr", "no"];
+declare const LOCALE_LANGUAGE_OPTIONS: readonly ["en", "zh-hans", "zh-hant-hk", "zh-hant-tw", "es", "fr", "no", "nl"];
 /**
  * Defines network options.
  */
@@ -319,6 +325,10 @@ type LatexTemplate = (typeof LATEX_TEMPLATE_OPTIONS)[number];
  * A union type for all possible skill proficiency levels.
  */
 type Level = (typeof LEVEL_OPTIONS)[number];
+/**
+ * A union type for all possible latex paper size options.
+ */
+type LatexPaperSize = (typeof LATEX_PAPER_SIZE_OPTIONS)[number];
 /**
  * A union type for all possible locale languages.
  *
@@ -905,8 +915,6 @@ type Content = {
             volunteer?: string;
             work?: string;
         };
-        /** Combined and formatted string of URLs from basics and profiles. */
-        urls?: string;
     };
 };
 
@@ -1072,6 +1080,21 @@ type HtmlTypography = {
     /** Base font size for the document (e.g., "small", "medium", "large"). */
     fontSize?: HtmlFontSize;
 };
+/**
+ * Defines advanced HTML configuration options.
+ */
+type HtmlAdvanced = {
+    /** Whether to show icons for links and profiles. */
+    showIcons?: boolean;
+    /** Custom title for the HTML document. */
+    title?: string;
+    /** Custom footer for the HTML document. */
+    footer?: string;
+    /** Meta description for the HTML document. */
+    description?: string;
+    /** Meta keywords for the HTML document. */
+    keywords?: string;
+};
 /**
  * HTML layout configuration.
  *
@@ -1086,6 +1109,8 @@ type HtmlLayout = {
     typography?: HtmlTypography;
     /** Defines section customization settings. */
     sections?: Sections;
+    /** Defines advanced configuration options. */
+    advanced?: HtmlAdvanced;
 };
 
 /**
@@ -1137,6 +1162,8 @@ type LatexAdvanced = {
         /** Style for rendering numbers (Lining or OldStyle). */
         numbers?: LatexFontspecNumbers;
     };
+    /** Whether to show icons for links and profiles. */
+    showIcons?: boolean;
 };
 /**
  * Defines latex page-level settings for document presentation.
@@ -1146,6 +1173,7 @@ type LatexPage = {
     showPageNumbers?: boolean;
     /** Defines page margin settings for document layout. */
     margins?: Margins;
+    paperSize?: LatexPaperSize;
 };
 /**
  * LaTeX layout configuration.
@@ -1292,7 +1320,7 @@ declare function getHtmlTemplateDetail(template: HtmlTemplate): {
     engine: LayoutEngine;
     name: string;
     description: string;
-    id: "calm";
+    id: "calm" | "vscode";
 };
 /** Provides default, empty item structures for each resume section type. */
 declare const RESUME_SECTION_ITEMS: ResumeItem;
@@ -1316,7 +1344,7 @@ declare const MARGIN_OPTIONS: string[];
  * @returns The language code and name of the given locale language.
  */
 declare function getLocaleLanguageDetail(localeLanguage: LocaleLanguage): {
-    localeLanguage: "en" | "zh-hans" | "zh-hant-hk" | "zh-hant-tw" | "es" | "fr" | "no";
+    localeLanguage: "en" | "zh-hans" | "zh-hant-hk" | "zh-hant-tw" | "es" | "fr" | "no" | "nl";
     name: string;
 };
 /** Default HTML layout configuration. */
@@ -1895,6 +1923,10 @@ declare class HtmlRenderer extends Renderer {
      * various sections.
      */
     constructor(resume: Resume, layoutIndex: number, summaryParser?: Parser);
+    /**
+     * Get whether to show icons.
+     */
+    private get showIcons();
     /**
      * Get the CSS styles for the HTML document.
      *
@@ -2001,6 +2033,12 @@ declare class HtmlRenderer extends Renderer {
      * @returns {string} The rendered volunteer section
      */
     renderVolunteer(): string;
+    /**
+     * Render the footer section of the resume.
+     *
+     * @returns {string} The rendered footer section
+     */
+    renderFooter(): string;
     /**
      * Render the complete HTML resume.
      *
@@ -2065,6 +2103,10 @@ declare class ModerncvBase extends Renderer {
      * various sections.
      */
     constructor(resume: Resume, style: ModerncvStyle, layoutIndex: number, summaryParser: Parser);
+    /**
+     * Whether to show icons in the rendered LaTeX.
+     */
+    private get showIcons();
     /**
      * Check if the resume is a CJK resume.
      */
@@ -2115,6 +2157,10 @@ declare class ModerncvBase extends Renderer {
      * @returns The LaTeX code for the location section
      */
     renderLocation(): string;
+    /**
+     * Get FontAwesome icon for a network.
+     */
+    private getFaIcon;
     /**
      * Render the profiles section of the resume.
      *
@@ -2482,10 +2528,17 @@ declare const ResumeSchema: z.ZodObject<{
                 projects: z.ZodOptional<z.ZodNullable<z.ZodType<string, unknown, z.core.$ZodTypeInternals<string, unknown>>>>;
             }, z.core.$strip>>>;
         }, z.core.$strip>>>;
+        advanced: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            showIcons: z.ZodDefault<z.ZodBoolean>;
+            title: z.ZodOptional<z.ZodString>;
+            footer: z.ZodDefault<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
+            keywords: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
         typography: z.ZodOptional<z.ZodNullable<z.ZodObject<{
             fontSize: z.ZodOptional<z.ZodNullable<z.ZodType<"14px" | "15px" | "16px" | "17px" | "18px" | "19px" | "20px", unknown, z.core.$ZodTypeInternals<"14px" | "15px" | "16px" | "17px" | "18px" | "19px" | "20px", unknown>>>>;
         }, z.core.$strip>>>;
-        template: z.ZodOptional<z.ZodNullable<z.ZodType<"calm", unknown, z.core.$ZodTypeInternals<"calm", unknown>>>>;
+        template: z.ZodOptional<z.ZodNullable<z.ZodType<"calm" | "vscode", unknown, z.core.$ZodTypeInternals<"calm" | "vscode", unknown>>>>;
         engine: z.ZodLiteral<"html">;
     }, z.core.$strip>, z.ZodObject<{
         sections: z.ZodOptional<z.ZodNullable<z.ZodObject<{
@@ -2522,6 +2575,7 @@ declare const ResumeSchema: z.ZodObject<{
             fontspec: z.ZodOptional<z.ZodNullable<z.ZodObject<{
                 numbers: z.ZodOptional<z.ZodNullable<z.ZodType<"Lining" | "OldStyle" | "Auto", unknown, z.core.$ZodTypeInternals<"Lining" | "OldStyle" | "Auto", unknown>>>>;
             }, z.core.$strip>>>;
+            showIcons: z.ZodDefault<z.ZodBoolean>;
         }, z.core.$strip>>>;
         typography: z.ZodOptional<z.ZodNullable<z.ZodObject<{
             links: z.ZodOptional<z.ZodNullable<z.ZodObject<{
@@ -2538,6 +2592,7 @@ declare const ResumeSchema: z.ZodObject<{
                 right: z.ZodOptional<z.ZodNullable<z.ZodType<string, unknown, z.core.$ZodTypeInternals<string, unknown>>>>;
             }, z.core.$strip>>>;
             showPageNumbers: z.ZodOptional<z.ZodNullable<z.ZodType<boolean, unknown, z.core.$ZodTypeInternals<boolean, unknown>>>>;
+            paperSize: z.ZodOptional<z.ZodNullable<z.ZodType<"a4" | "letter", unknown, z.core.$ZodTypeInternals<"a4" | "letter", unknown>>>>;
         }, z.core.$strip>>>;
         engine: z.ZodLiteral<"latex">;
     }, z.core.$strip>, z.ZodObject<{
@@ -2574,7 +2629,7 @@ declare const ResumeSchema: z.ZodObject<{
         engine: z.ZodLiteral<"markdown">;
     }, z.core.$strip>], "engine">>>>;
     locale: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-        language: z.ZodOptional<z.ZodNullable<z.ZodType<"en" | "zh-hans" | "zh-hant-hk" | "zh-hant-tw" | "es" | "fr" | "no", unknown, z.core.$ZodTypeInternals<"en" | "zh-hans" | "zh-hant-hk" | "zh-hant-tw" | "es" | "fr" | "no", unknown>>>>;
+        language: z.ZodOptional<z.ZodNullable<z.ZodType<"en" | "zh-hans" | "zh-hant-hk" | "zh-hant-tw" | "es" | "fr" | "no" | "nl", unknown, z.core.$ZodTypeInternals<"en" | "zh-hans" | "zh-hant-hk" | "zh-hant-tw" | "es" | "fr" | "no" | "nl", unknown>>>>;
     }, z.core.$strip>>>;
     content: z.ZodObject<{
         work: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
@@ -3157,4 +3212,4 @@ declare function joinNonEmptyString(codes: string[], separator?: string): string
  */
 declare function toCodeBlock(code?: string, lang?: string): string;
 
-export { type Awards, type Basics, type BulletListNode, COUNTRY_OPTIONS, type Certificates, type Content, type Country, DEFAULT_HTML_LAYOUT, DEFAULT_LATEX_LAYOUT, DEFAULT_MARKDOWN_LAYOUT, DEFAULT_RESUME, DEFAULT_RESUME_CONTENT, DEFAULT_RESUME_LAYOUTS, DEFAULT_RESUME_LOCALE, DEFAULT_SECTIONS_ORDER, DEGREE_OPTIONS, type Degree, type DocNode, type Education, EnglishCountryNames, ErrorType, FILLED_RESUME, FILLED_RESUME_CONTENT, FLUENCY_OPTIONS, type Fluency, FrenchCountryNames, HTML_FONT_SIZE_OPTIONS, HTML_TEMPLATE_OPTIONS, HtmlCodeGenerator, type HtmlFontSize, type HtmlLayout, HtmlRenderer, type HtmlTemplate, type Interests, type Keywords, LANGUAGE_OPTIONS, LATEX_FONTSPEC_NUMBERS_OPTIONS, LATEX_FONT_SIZE_OPTIONS, LATEX_TEMPLATE_OPTIONS, LEVEL_OPTIONS, LOCALE_LANGUAGE_OPTIONS, type Language, type Languages, LatexCodeGenerator, type LatexFontSize, type LatexFontspecNumbers, type LatexLayout, type LatexTemplate, type LayoutEngine, type Layouts, type Level, type Locale, type LocaleLanguage, type Location, MARGIN_OPTIONS, type MarkdownLayout, MarkdownParser, MarkdownRenderer, ModerncvBankingRenderer, ModerncvCasualRenderer, ModerncvClassicRenderer, NETWORK_OPTIONS, type Network, type Node, NorwegianCountryNames, ONE_DAY, ORDERABLE_SECTION_IDS, type OrderableSectionID, type OrderedListNode, PUNCTUATIONS, type ParagraphNode, type Parser, type Profiles, type Projects, type Publications, type Punctuation, RESUME_SECTION_ITEMS, type References, type Resume, type ResumeItem, ResumeSchema, SECTION_IDS, type SectionID, SimplifiedChineseCountryNames, type Skills, SpanishCountryNames, TERMS, type Term, type TextNode, TraditionalChineseCountryHKNames, TraditionalChineseCountryTWNames, type Volunteer, type Work, YAMLResumeError, collectAllKeys, epochSecondsToLocaleDateString, escapeHtml, escapeLatex, getDateRange, getHtmlTemplateDetail, getLatexTemplateDetail, getLocaleLanguageDetail, getOptionTranslation, getResumeRenderer, getTemplateTranslations, isEmptyString, isEmptyValue, joinNonEmptyString, localizeDate, mergeArrayWithOrder, milliSecondsToSeconds, nowInUTCSeconds, parseDate, removeKeysFromObject, showIf, showIfNotEmpty, toCodeBlock, transformResume };
+export { type Awards, type Basics, type BulletListNode, COUNTRY_OPTIONS, type Certificates, type Content, type Country, DEFAULT_HTML_LAYOUT, DEFAULT_LATEX_LAYOUT, DEFAULT_MARKDOWN_LAYOUT, DEFAULT_RESUME, DEFAULT_RESUME_CONTENT, DEFAULT_RESUME_LAYOUTS, DEFAULT_RESUME_LOCALE, DEFAULT_SECTIONS_ORDER, DEGREE_OPTIONS, type Degree, type DocNode, DutchCountryNames, type Education, EnglishCountryNames, ErrorType, FILLED_RESUME, FILLED_RESUME_CONTENT, FLUENCY_OPTIONS, type Fluency, FrenchCountryNames, HTML_FONT_SIZE_OPTIONS, HTML_TEMPLATE_OPTIONS, HtmlCodeGenerator, type HtmlFontSize, type HtmlLayout, HtmlRenderer, type HtmlTemplate, type Interests, type Keywords, LANGUAGE_OPTIONS, LATEX_FONTSPEC_NUMBERS_OPTIONS, LATEX_FONT_SIZE_OPTIONS, LATEX_PAPER_SIZE_OPTIONS, LATEX_TEMPLATE_OPTIONS, LEVEL_OPTIONS, LOCALE_LANGUAGE_OPTIONS, type Language, type Languages, LatexCodeGenerator, type LatexFontSize, type LatexFontspecNumbers, type LatexLayout, type LatexPaperSize, type LatexTemplate, type LayoutEngine, type Layouts, type Level, type Locale, type LocaleLanguage, type Location, MARGIN_OPTIONS, type MarkdownLayout, MarkdownParser, MarkdownRenderer, ModerncvBankingRenderer, ModerncvCasualRenderer, ModerncvClassicRenderer, NETWORK_OPTIONS, type Network, type Node, NorwegianCountryNames, ONE_DAY, ORDERABLE_SECTION_IDS, type OrderableSectionID, type OrderedListNode, PUNCTUATIONS, type ParagraphNode, type Parser, type Profiles, type Projects, type Publications, type Punctuation, RESUME_SECTION_ITEMS, type References, type Resume, type ResumeItem, ResumeSchema, SECTION_IDS, type SectionID, SimplifiedChineseCountryNames, type Skills, SpanishCountryNames, TERMS, type Term, type TextNode, TraditionalChineseCountryHKNames, TraditionalChineseCountryTWNames, type Volunteer, type Work, YAMLResumeError, collectAllKeys, epochSecondsToLocaleDateString, escapeHtml, escapeLatex, getDateRange, getHtmlTemplateDetail, getLatexTemplateDetail, getLocaleLanguageDetail, getOptionTranslation, getResumeRenderer, getTemplateTranslations, isEmptyString, isEmptyValue, joinNonEmptyString, localizeDate, mergeArrayWithOrder, milliSecondsToSeconds, nowInUTCSeconds, parseDate, removeKeysFromObject, showIf, showIfNotEmpty, toCodeBlock, transformResume };