@yamlresume/core 0.2.4 → 0.3.1

package/dist/index.d.ts

@@ -668,12 +668,11 @@ declare const spanishCountryNames: Record<Country, string>;
  * IN THE SOFTWARE.
  */
 
-/** Represents the valid identifiers for top-level sections within the resume
- * content.
- *
- * TODO: should we move this to TypeScript enum?
+/**
+ * All valid top-level sections in the resume.
  * */
-type SectionID = 'basics' | 'location' | 'profiles' | 'work' | 'education' | 'volunteer' | 'awards' | 'certificates' | 'publications' | 'skills' | 'languages' | 'interests' | 'references' | 'projects';
+declare const SECTION_IDS: readonly ["basics", "location", "profiles", "work", "education", "volunteer", "awards", "certificates", "publications", "skills", "languages", "interests", "references", "projects"];
+type SectionID = (typeof SECTION_IDS)[number];
 /** Categorizes social networks for potential grouping or display purposes. */
 type SocialNetworkGroup = 'Chat' | 'Design' | 'Media' | 'Social' | 'Technical' | 'WWW';
 /** Defines supported social media and professional network identifiers.
@@ -710,7 +709,7 @@ type BasicsItem = {
     /** Email address. */
     email?: string;
     /** A brief professional headline or title (e.g., "Software Engineer"). */
-    headline: string;
+    headline?: string;
     /** Full name. */
     name?: string;
     /** Phone number. */
@@ -1366,6 +1365,94 @@ declare const defaultResume: Resume;
  */
 declare const filledResume: Resume;
 
+/**
+ * Enum of error codes for YAMLResumeError.
+ *
+ * Error codes are used to identify specific errors and can be used to
+ * internationalize error messages.
+ */
+declare const ErrorType: {
+    readonly FILE_NOT_FOUND: {
+        readonly code: "FILE_NOT_FOUND";
+        readonly errno: number;
+        readonly message: "Resume not found: {path}";
+        readonly path: "";
+    };
+    readonly FILE_READ_ERROR: {
+        readonly code: "FILE_READ_ERROR";
+        readonly errno: number;
+        readonly message: "Failed to read resume file: {path}";
+        readonly path: "";
+    };
+    readonly FILE_WRITE_ERROR: {
+        readonly code: "FILE_WRITE_ERROR";
+        readonly errno: number;
+        readonly message: "Failed to write file: {path}";
+        readonly path: "";
+    };
+    readonly FILE_CONFLICT: {
+        readonly code: "FILE_CONFLICT";
+        readonly errno: number;
+        readonly message: string;
+        readonly path: "";
+    };
+    readonly INVALID_EXTNAME: {
+        readonly code: "INVALID_EXTNAME";
+        readonly errno: number;
+        readonly message: string;
+        readonly extname: "";
+    };
+    readonly INVALID_YAML: {
+        readonly code: "INVALID_YAML";
+        readonly errno: number;
+        readonly message: "Invalid YAML format: {error}";
+        readonly error: "";
+    };
+    readonly INVALID_JSON: {
+        readonly code: "INVALID_JSON";
+        readonly errno: number;
+        readonly message: "Invalid JSON format: {error}";
+        readonly error: "";
+    };
+    readonly LATEX_NOT_FOUND: {
+        readonly code: "LATEX_NOT_FOUND";
+        readonly errno: number;
+        readonly message: "LaTeX compiler not found. Please install either xelatex or tectonic";
+    };
+    readonly LATEX_COMPILE_ERROR: {
+        readonly code: "LATEX_COMPILE_ERROR";
+        readonly errno: number;
+        readonly message: "LaTeX compilation failed: {error}";
+        readonly error: "";
+    };
+};
+/**
+ * Type for the error code.
+ */
+type ErrorCodeType = keyof typeof ErrorType;
+/**
+ * Type for the error message parameters.
+ */
+type ErrorMessageParams = {
+    [K in ErrorCodeType]: {
+        [P in keyof (typeof ErrorType)[K] as P extends 'message' | 'code' | 'errno' ? never : P]: string;
+    };
+};
+/**
+ * Custom error class for YAMLResume errors.
+ */
+declare class YAMLResumeError<T extends ErrorCodeType> extends Error {
+    code: T;
+    errno: number;
+    /**
+     * Constructor for YAMLResumeError.
+     *
+     * @param code - The error code.
+     * @param params - The error message parameters.
+     */
+    constructor(code: T, params: ErrorMessageParams[T]);
+}
+
 /**
  * MIT License
  *
@@ -1848,6 +1935,14 @@ declare function escapeLatex(value: string | null | undefined): any;
  * @see {@link https://stackoverflow.com/a/43233163}
  */
 declare function isEmptyValue(value: undefined | null | object | string): boolean;
+/**
+ * Remove keys from an object by their names
+ *
+ * @param obj - The object to remove keys from
+ * @param keysToRemove - The keys to remove
+ * @returns The object with the specified keys removed
+ */
+declare function removeKeysFromObject<T extends object>(obj: T, keysToRemove: (string | number | symbol)[]): T;
 
 /**
  * MIT License
@@ -1895,5 +1990,13 @@ declare function showIf(predicate: boolean, content: string): string;
  * @returns The joined string
  */
 declare function joinNonEmptyString(codes: string[], separator?: string): string;
+/**
+ * Convert a string to a code block in markdown format
+ *
+ * @param code - The string to convert
+ * @param lang - The language of the code block
+ * @returns The code block
+ */
+declare function toCodeBlock(code?: string, lang?: string): string;
 
-export { type Awards, type Basics, type BulletListNode, type Certificates, Country, Degree, type DocNode, type Education, FontSpecNumbersStyle, type Interests, Language, LanguageFluency, type LanguageItem, type Languages, LatexCodeGenerator, LocaleLanguageOption, type Location, MarkdownParser, type Node, type OrderedListNode, type ParagraphNode, type Parser, type ProfileItem, type Profiles, type Projects, type Publications, Punctuation, type References, type Resume, type ResumeContent, type ResumeItem, type ResumeLayout, ResumeTerms, type SectionDefaultValues, type SectionID, SkillLevel, type Skills, type SocialNetwork, type SocialNetworkGroup, TemplateOption, TemplateTerms, type TextNode, TiptapParser, type Volunteer, type Work, defaultResume, defaultResumeContent, defaultResumeLayout, degreeOptions, emptyParagraph, englishCountryNames, epochSecondsToLocaleDateString, escapeLatex, filledResume, filledResumeContent, fontSizeOptions, getDateRange, getLocaleLanguageOptionDetail, getResumeRenderer, getTemplateOptionDetail, getTemplateTranslations, getTermsTranslations, isEmptyString, isEmptyValue, joinNonEmptyString, languageFluenciesOptions, languagesOptions, localizeDate, marginOptions, milliSecondsToSeconds, nowInUTCSeconds, oneDay, parseDate, resumeItems, showIf, simplifiedChineseCountryNames, skillLevelOptions, spanishCountryNames, traditionalChineseCountryHKNames, traditionalChineseCountryTWNames, transformResume };
+export { type Awards, type Basics, type BulletListNode, type Certificates, Country, Degree, type DocNode, type Education, ErrorType, FontSpecNumbersStyle, type Interests, Language, LanguageFluency, type LanguageItem, type Languages, LatexCodeGenerator, LocaleLanguageOption, type Location, MarkdownParser, type Node, type OrderedListNode, type ParagraphNode, type Parser, type ProfileItem, type Profiles, type Projects, type Publications, Punctuation, type References, type Resume, type ResumeContent, type ResumeItem, type ResumeLayout, ResumeTerms, SECTION_IDS, type SectionDefaultValues, type SectionID, SkillLevel, type Skills, type SocialNetwork, type SocialNetworkGroup, TemplateOption, TemplateTerms, type TextNode, TiptapParser, type Volunteer, type Work, YAMLResumeError, defaultResume, defaultResumeContent, defaultResumeLayout, degreeOptions, emptyParagraph, englishCountryNames, epochSecondsToLocaleDateString, escapeLatex, filledResume, filledResumeContent, fontSizeOptions, getDateRange, getLocaleLanguageOptionDetail, getResumeRenderer, getTemplateOptionDetail, getTemplateTranslations, getTermsTranslations, isEmptyString, isEmptyValue, joinNonEmptyString, languageFluenciesOptions, languagesOptions, localizeDate, marginOptions, milliSecondsToSeconds, nowInUTCSeconds, oneDay, parseDate, removeKeysFromObject, resumeItems, showIf, simplifiedChineseCountryNames, skillLevelOptions, spanishCountryNames, toCodeBlock, traditionalChineseCountryHKNames, traditionalChineseCountryTWNames, transformResume };