greek-name-correction 2.0.0 → 2.1.1

package/README.md

@@ -13,7 +13,8 @@ A powerful, zero-dependency Node.js library for correcting, formatting, and vali
 🔄 **Transliteration** - Greeklish ↔ Greek ↔ Latin  
 📝 **Smart Formatting** - Proper capitalization and syntax  
 👔 **Title Support** - Handles Greek honorifics (Δρ., Καθ., etc.)  
-🔀 **Genitive Conversion** - Automatic του/της forms  
+🎩 **Auto Title Addition** - Automatically adds general titles (Κ. for men, Κα for women)  
+🔀 **Case Conversion** - Genitive, vocative, and accusative forms  
 🎯 **Gender Detection** - Identifies gender from name endings  
 📊 **Statistics** - Comprehensive name analysis  
 🔍 **Diminutive Detection** - Recognizes nickname patterns  
@@ -122,10 +123,60 @@ GreekNameCorrection('Γιώργος Παπαδόπουλος', {
 });
 // → { 
 //     corrected: "Γιώργος Παπαδόπουλος",
-//     genitive: "Γιώργος Παπαδόπουλου"
+//     genitive: "Γιώργου Παπαδόπουλου"
 //   }
 ```
 
+### Vocative Case Conversion
+```javascript
+// Convert to vocative case (for addressing someone)
+GreekNameCorrection('Γιώργος Παπαδόπουλος', {
+  convertToCase: 'vocative'
+});
+// → "Γιώργο Παπαδόπουλο"
+
+// With preserveOriginal to get both forms
+GreekNameCorrection('Γιάννης Αλεξίου', {
+  convertToCase: 'vocative',
+  preserveOriginal: true
+});
+// → {
+//     corrected: "Γιάννης Αλεξίου",
+//     vocative: "Γιάννη Αλεξίου"
+//   }
+
+// Feminine names usually remain unchanged
+GreekNameCorrection('Μαρία Κωνσταντίνου', {
+  convertToCase: 'vocative'
+});
+// → "Μαρία Κωνσταντίνου"
+```
+
+### Accusative Case Conversion
+```javascript
+// Convert to accusative case (for direct objects)
+GreekNameCorrection('Γιώργος Παπαδόπουλος', {
+  convertToCase: 'accusative'
+});
+// → "Γιώργο Παπαδόπουλο"
+
+// With preserveOriginal to get both forms
+GreekNameCorrection('Κώστας Παπαδάκης', {
+  convertToCase: 'accusative',
+  preserveOriginal: true
+});
+// → {
+//     corrected: "Κώστας Παπαδάκης",
+//     accusative: "Κώστα Παπαδάκη"
+//   }
+
+// Feminine names usually remain unchanged
+GreekNameCorrection('Μαρία Κωνσταντίνου', {
+  convertToCase: 'accusative'
+});
+// → "Μαρία Κωνσταντίνου"
+```
+
 ### Title Handling
 ```javascript
 GreekNameCorrection('δρ. γιώργος παπαδόπουλος', {
@@ -138,6 +189,39 @@ GreekNameCorrection('δρ. γιώργος παπαδόπουλος', {
 //   }
 ```
 
+### Automatic General Title Addition
+```javascript
+// Add general title (κ. for men, κα for women) if no title exists
+// Titles are always lowercase
+GreekNameCorrection('Γιώργος Παπαδόπουλος', {
+  addGeneralTitle: true
+});
+// → "κ. Γιώργος Παπαδόπουλος"
+
+GreekNameCorrection('Μαρία Κωνσταντίνου', {
+  addGeneralTitle: true
+});
+// → "κα Μαρία Κωνσταντίνου"
+
+// Names with existing titles are not modified
+GreekNameCorrection('Δρ. Γιώργος Παπαδόπουλος', {
+  addGeneralTitle: true
+});
+// → "Δρ. Γιώργος Παπαδόπουλος"
+
+// Works with preserveOriginal option
+GreekNameCorrection('Ελένη Γεωργίου', {
+  addGeneralTitle: true,
+  preserveOriginal: true
+});
+// → {
+//     corrected: "κα Ελένη Γεωργίου",
+//     original: "Ελένη Γεωργίου",
+//     title: "κα",
+//     isValid: true
+//   }
+```
+
 ### Name Corrections
 ```javascript
 GreekNameCorrection('γιοργος παπαδοπουλος', {
@@ -258,9 +342,11 @@ GreekNameCorrection(input, options)
 | `removeExtraSpaces` | `boolean` | `true` | Remove extra whitespace |
 | `handleParticles` | `boolean` | `true` | Handle Greek particles (του/της/των) |
 | `convertToGenitive` | `boolean` | `false` | Convert to genitive case |
+| `convertToCase` | `string\|null` | `null` | Convert to case: `'vocative'` or `'accusative'` |
 | `transliterate` | `string\|null` | `null` | Transliteration mode: `'greeklish-to-greek'`, `'greek-to-latin'`, `'greek-to-greeklish'` |
 | `detectDiminutive` | `boolean` | `false` | Detect diminutive/nickname forms |
 | `handleTitles` | `boolean` | `true` | Extract and format titles |
+| `addGeneralTitle` | `boolean` | `false` | Automatically add general title (κ. for men, κα for women) if no title exists (always lowercase) |
 | `suggestCorrections` | `boolean` | `false` | Suggest corrections for misspellings |
 | `recognizeKatharevousa` | `boolean` | `false` | Convert archaic Greek forms |
 | `databaseSafe` | `boolean` | `false` | Remove problematic characters |
@@ -286,6 +372,8 @@ When `preserveOriginal: true`, returns an object with:
   parts?: Object,           // Name parts (if splitNames)
   diminutive?: Array,       // Diminutive info (if detectDiminutive)
   genitive?: string,        // Genitive form (if convertToGenitive)
+  vocative?: string,        // Vocative form (if convertToCase: 'vocative')
+  accusative?: string,      // Accusative form (if convertToCase: 'accusative')
   sortKey?: string,         // Sort key (if generateSortKey)
   statistics?: Object,      // Name statistics (if statistics)
   wasCorrected?: boolean,   // If corrections were applied
@@ -303,6 +391,14 @@ The library recognizes and properly formats the following Greek titles:
 - **Religious**: Αρχιεπίσκοπος, Μητροπολίτης, Επίσκοπος, Πατήρ
 - **Military**: Στρατηγός, Ταξίαρχος, Συνταγματάρχης, Αντισυνταγματάρχης
 
+### Automatic General Title Addition
+
+When `addGeneralTitle: true` is enabled, the library automatically adds general titles based on detected gender:
+- **κ.** (κύριος) for male names
+- **κα** (κυρία) for female names
+
+**Note:** General titles are always added in lowercase format. This feature only adds titles when no existing title is detected, ensuring that professional or academic titles are preserved.
+
 ## Common Name Corrections
 
 The library automatically corrects common Greek name misspellings:
@@ -347,6 +443,7 @@ const result = GreekNameCorrection('dr giorgos tou papa', {
   transliterate: 'greeklish-to-greek',
   preserveOriginal: true,
   handleTitles: true,
+  addGeneralTitle: true,
   handleParticles: true,
   suggestCorrections: true,
   detectGender: true,
@@ -448,6 +545,20 @@ const recipient = GreekNameCorrection(name, {
 });
 
 console.log(`Προς: ${recipient.genitive}`);
+
+// Use vocative case for addressing someone
+const addressee = GreekNameCorrection('Γιώργος Παπαδόπουλος', {
+  convertToCase: 'vocative'
+});
+
+console.log(`Αγαπητέ ${addressee},`); // "Αγαπητέ Γιώργο Παπαδόπουλο,"
+
+// Use accusative case for direct objects
+const object = GreekNameCorrection('Δημήτρης Νικολάου', {
+  convertToCase: 'accusative'
+});
+
+console.log(`Είδα τον ${object}`); // "Είδα τον Δημήτρη Νικολάου"
 ```
 
 ### 5. Gender-Based Processing
@@ -494,7 +605,7 @@ Contributions are welcome! Please feel free to submit a Pull Request. For major
 ### Development
 ```bash
 # Clone the repository
-git clone https://github.com/yourusername/greek-name-correction.git
+git clone https://github.com/sraftopo/greek-name-correction.git
 
 # Install dependencies (none currently!)
 npm install
@@ -513,8 +624,9 @@ The test suite covers:
 - Array processing
 - Object processing
 - All transliteration modes
-- Genitive conversion
+- Case conversions (genitive, vocative, accusative)
 - Title handling
+- Automatic general title addition
 - Diminutive detection
 - Gender detection
 - Statistics generation
@@ -522,9 +634,18 @@ The test suite covers:
 
 ## Changelog
 
-### Version 2.0.0 (Current)
+### Version 2.1.1 (Current)
+- ✨ **Automatic General Title Addition** - Added `addGeneralTitle` option to automatically add general titles (κ. for men, κα for women) when no title exists
+
+### Version 2.1.0
+- 🏗️ **Modular Architecture** - Complete codebase refactoring into logical modules
+- 📦 **Improved Structure** - Separated into `transliteration.js`, `cases.js`, `validation.js`, `utils.js`, `constants.js`
+- 🔧 **Better Maintainability** - Clean separation of concerns for easier testing and development
+- ✨ **Enhanced Code Organization** - Each module has a single, clear responsibility
+
+### Version 2.0.0
 - ✨ Added transliteration support (Greeklish ↔ Greek ↔ Latin)
-- ✨ Added genitive case conversion
+- ✨ Added case conversion (genitive, vocative, accusative)
 - ✨ Added diminutive detection
 - ✨ Added title/honorific support
 - ✨ Added name correction suggestions
@@ -548,7 +669,7 @@ MIT © Stavros
 
 ## Support
 
-For bugs, questions, and discussions please use the [GitHub Issues](https://github.com/yourusername/greek-name-correction/issues).
+For bugs, questions, and discussions please use the [GitHub Issues](https://github.com/sraftopo/greek-name-correction/issues).
 
 ## Acknowledgments
 
@@ -565,4 +686,4 @@ Special thanks to all contributors and users who help improve this library.
 
 **Made in Greece 🇬🇷**
 
-If you find this library helpful, please consider giving it a ⭐️ on GitHub!
+If you find this library helpful, please consider giving it a ⭐️ on GitHub!