@yamlresume/core 0.3.0 → 0.3.2

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. */
@@ -1936,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
@@ -1992,4 +1999,4 @@ declare function joinNonEmptyString(codes: string[], separator?: string): string
  */
 declare function toCodeBlock(code?: string, lang?: string): string;
 
-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, 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, resumeItems, showIf, simplifiedChineseCountryNames, skillLevelOptions, spanishCountryNames, toCodeBlock, 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 };