@pranavraut033/ats-checker 0.1.0

package/README.md

@@ -0,0 +1,47 @@
+# ats-checker
+
+Deterministic, configurable ATS (Applicant Tracking System) compatibility checker with no external dependencies. Provides a single entry point `analyzeResume()` and extensible configuration for weights, skills, rules, and profiles.
+
+## Installation
+
+```bash
+npm install ats-checker
+```
+
+## Quick start
+
+```ts
+import { analyzeResume } from "ats-checker";
+
+const { score, breakdown, suggestions } = analyzeResume({
+  resumeText: "...",
+  jobDescription: "..."
+});
+```
+
+## Configuration
+
+- **weights**: adjust scoring weight for skills, experience, keywords, and education.
+- **skillAliases**: normalize synonyms to canonical skills.
+- **profile**: specify mandatory/optional skills and minimum years of experience.
+- **rules**: add custom penalties via functions that inspect parsed resume/job data.
+
+See `src/types` for full type definitions.
+
+## Development
+
+```bash
+npm install
+npm run build
+npm test
+```
+
+## Features
+
+- Zero runtime dependencies
+- Deterministic, explainable scoring (0-100)
+- Customizable weights, rules, and industry profiles
+- Parses resumes and job descriptions
+- Detects ATS-unfriendly patterns (tables, keyword stuffing)
+- Generates actionable suggestions
+

package/dist/index.d.mts

@@ -0,0 +1,135 @@
+type ResumeSection = "summary" | "experience" | "skills" | "education" | "projects" | "certifications";
+interface ParsedDateRange {
+    raw?: string;
+    start?: string;
+    end?: string;
+    durationInMonths?: number;
+}
+interface ParsedExperienceEntry {
+    title?: string;
+    company?: string;
+    location?: string;
+    dates?: ParsedDateRange;
+    description?: string;
+}
+interface ParsedResume {
+    raw: string;
+    normalizedText: string;
+    detectedSections: ResumeSection[];
+    sectionContent: Partial<Record<ResumeSection, string>>;
+    skills: string[];
+    jobTitles: string[];
+    actionVerbs: string[];
+    educationEntries: string[];
+    experience: ParsedExperienceEntry[];
+    totalExperienceYears: number;
+    keywords: string[];
+    warnings: string[];
+}
+interface ParsedJobDescription {
+    raw: string;
+    normalizedText: string;
+    requiredSkills: string[];
+    preferredSkills: string[];
+    roleKeywords: string[];
+    keywords: string[];
+    minExperienceYears?: number;
+    educationRequirements: string[];
+}
+
+interface ATSWeights {
+    skills: number;
+    experience: number;
+    keywords: number;
+    education: number;
+}
+type SkillAliases = Record<string, string[]>;
+interface ATSProfile {
+    name: string;
+    mandatorySkills: string[];
+    optionalSkills: string[];
+    minExperience?: number;
+}
+interface KeywordDensityConfig {
+    /** Minimum density before a keyword is considered underused (informational only). */
+    min: number;
+    /** Maximum density before a keyword is considered stuffed. */
+    max: number;
+    /** Penalty applied when density exceeds max. */
+    overusePenalty: number;
+}
+interface SectionPenaltyConfig {
+    missingSummary?: number;
+    missingExperience?: number;
+    missingSkills?: number;
+    missingEducation?: number;
+}
+interface ATSRule {
+    id: string;
+    description?: string;
+    penalty: number;
+    warning?: string;
+    condition: (context: RuleContext) => boolean;
+}
+interface ATSConfig {
+    weights?: Partial<ATSWeights>;
+    skillAliases?: SkillAliases;
+    profile?: ATSProfile;
+    rules?: ATSRule[];
+    keywordDensity?: KeywordDensityConfig;
+    sectionPenalties?: SectionPenaltyConfig;
+    allowPartialMatches?: boolean;
+}
+interface NormalizedWeights extends ATSWeights {
+    /** Weights normalized so they sum to 1. */
+    normalizedTotal: number;
+}
+interface ResolvedATSConfig {
+    weights: NormalizedWeights;
+    skillAliases: SkillAliases;
+    profile?: ATSProfile;
+    rules: ATSRule[];
+    keywordDensity: KeywordDensityConfig;
+    sectionPenalties: Required<SectionPenaltyConfig>;
+    allowPartialMatches: boolean;
+}
+interface RuleContext {
+    resume: ParsedResume;
+    job: ParsedJobDescription;
+    weights: NormalizedWeights;
+    keywordDensity: KeywordDensityConfig;
+    breakdown?: ATSBreakdown;
+    matchedKeywords?: string[];
+    overusedKeywords?: string[];
+}
+
+interface ATSBreakdown {
+    skills: number;
+    experience: number;
+    keywords: number;
+    education: number;
+}
+interface AnalyzeResumeInput {
+    resumeText: string;
+    jobDescription: string;
+    config?: ATSConfig;
+}
+interface ATSAnalysisResult {
+    score: number;
+    breakdown: ATSBreakdown;
+    matchedKeywords: string[];
+    missingKeywords: string[];
+    overusedKeywords: string[];
+    suggestions: string[];
+    warnings: string[];
+}
+
+declare const defaultSkillAliases: SkillAliases;
+declare const defaultProfiles: ATSProfile[];
+
+/**
+ * Analyze a resume against a job description using deterministic, explainable rules.
+ */
+declare function analyzeResume(input: AnalyzeResumeInput): ATSAnalysisResult;
+
+export { type ATSAnalysisResult, type ATSBreakdown, type ATSConfig, type ATSProfile, type ATSRule, type ATSWeights, type AnalyzeResumeInput, type KeywordDensityConfig, type NormalizedWeights, type ParsedDateRange, type ParsedExperienceEntry, type ParsedJobDescription, type ParsedResume, type ResolvedATSConfig, type ResumeSection, type RuleContext, type SectionPenaltyConfig, type SkillAliases, analyzeResume, defaultProfiles, defaultSkillAliases };

package/dist/index.d.ts

@@ -0,0 +1,135 @@
+type ResumeSection = "summary" | "experience" | "skills" | "education" | "projects" | "certifications";
+interface ParsedDateRange {
+    raw?: string;
+    start?: string;
+    end?: string;
+    durationInMonths?: number;
+}
+interface ParsedExperienceEntry {
+    title?: string;
+    company?: string;
+    location?: string;
+    dates?: ParsedDateRange;
+    description?: string;
+}
+interface ParsedResume {
+    raw: string;
+    normalizedText: string;
+    detectedSections: ResumeSection[];
+    sectionContent: Partial<Record<ResumeSection, string>>;
+    skills: string[];
+    jobTitles: string[];
+    actionVerbs: string[];
+    educationEntries: string[];
+    experience: ParsedExperienceEntry[];
+    totalExperienceYears: number;
+    keywords: string[];
+    warnings: string[];
+}
+interface ParsedJobDescription {
+    raw: string;
+    normalizedText: string;
+    requiredSkills: string[];
+    preferredSkills: string[];
+    roleKeywords: string[];
+    keywords: string[];
+    minExperienceYears?: number;
+    educationRequirements: string[];
+}
+
+interface ATSWeights {
+    skills: number;
+    experience: number;
+    keywords: number;
+    education: number;
+}
+type SkillAliases = Record<string, string[]>;
+interface ATSProfile {
+    name: string;
+    mandatorySkills: string[];
+    optionalSkills: string[];
+    minExperience?: number;
+}
+interface KeywordDensityConfig {
+    /** Minimum density before a keyword is considered underused (informational only). */
+    min: number;
+    /** Maximum density before a keyword is considered stuffed. */
+    max: number;
+    /** Penalty applied when density exceeds max. */
+    overusePenalty: number;
+}
+interface SectionPenaltyConfig {
+    missingSummary?: number;
+    missingExperience?: number;
+    missingSkills?: number;
+    missingEducation?: number;
+}
+interface ATSRule {
+    id: string;
+    description?: string;
+    penalty: number;
+    warning?: string;
+    condition: (context: RuleContext) => boolean;
+}
+interface ATSConfig {
+    weights?: Partial<ATSWeights>;
+    skillAliases?: SkillAliases;
+    profile?: ATSProfile;
+    rules?: ATSRule[];
+    keywordDensity?: KeywordDensityConfig;
+    sectionPenalties?: SectionPenaltyConfig;
+    allowPartialMatches?: boolean;
+}
+interface NormalizedWeights extends ATSWeights {
+    /** Weights normalized so they sum to 1. */
+    normalizedTotal: number;
+}
+interface ResolvedATSConfig {
+    weights: NormalizedWeights;
+    skillAliases: SkillAliases;
+    profile?: ATSProfile;
+    rules: ATSRule[];
+    keywordDensity: KeywordDensityConfig;
+    sectionPenalties: Required<SectionPenaltyConfig>;
+    allowPartialMatches: boolean;
+}
+interface RuleContext {
+    resume: ParsedResume;
+    job: ParsedJobDescription;
+    weights: NormalizedWeights;
+    keywordDensity: KeywordDensityConfig;
+    breakdown?: ATSBreakdown;
+    matchedKeywords?: string[];
+    overusedKeywords?: string[];
+}
+
+interface ATSBreakdown {
+    skills: number;
+    experience: number;
+    keywords: number;
+    education: number;
+}
+interface AnalyzeResumeInput {
+    resumeText: string;
+    jobDescription: string;
+    config?: ATSConfig;
+}
+interface ATSAnalysisResult {
+    score: number;
+    breakdown: ATSBreakdown;
+    matchedKeywords: string[];
+    missingKeywords: string[];
+    overusedKeywords: string[];
+    suggestions: string[];
+    warnings: string[];
+}
+
+declare const defaultSkillAliases: SkillAliases;
+declare const defaultProfiles: ATSProfile[];
+
+/**
+ * Analyze a resume against a job description using deterministic, explainable rules.
+ */
+declare function analyzeResume(input: AnalyzeResumeInput): ATSAnalysisResult;
+
+export { type ATSAnalysisResult, type ATSBreakdown, type ATSConfig, type ATSProfile, type ATSRule, type ATSWeights, type AnalyzeResumeInput, type KeywordDensityConfig, type NormalizedWeights, type ParsedDateRange, type ParsedExperienceEntry, type ParsedJobDescription, type ParsedResume, type ResolvedATSConfig, type ResumeSection, type RuleContext, type SectionPenaltyConfig, type SkillAliases, analyzeResume, defaultProfiles, defaultSkillAliases };