zodiac-mapper 0.1.0 → 0.2.0

package/README.md

@@ -1,21 +1,38 @@
-# zodiac-mapper
+# ✨ zodiac-mapper
+
+[![npm version](https://img.shields.io/npm/v/zodiac-mapper.svg)](https://www.npmjs.com/package/zodiac-mapper)
+[![License](https://img.shields.io/npm/l/zodiac-mapper.svg)](https://github.com/fixicelo/zodiac-mapper/blob/main/LICENSE)
+
 A lightweight, zero-dependency TypeScript NPM package that maps **zodiac sign names in dozens of languages and regional variants** to a standardized `ZodiacSign` enum.
 
-Perfect for internationalized astrology apps, horoscope tools, multilingual chatbots, or any project needing robust zodiac name recognition.
+🌟 **Perfect for internationalized astrology apps, horoscope tools, multilingual chatbots, or any project needing robust zodiac name recognition.**
+
+Supports **50+ locales** 🌍 including English, Chinese, Japanese, German, French, Spanish, Arabic, Persian, Russian, Greek, Hebrew, and more.
+
+> ℹ️ **Data note:** the built-in locale alias dataset was generated and curated with AI assistance. While we try to keep it accurate and conventional, it may contain mistakes or regional variations—please open an issue/PR if you spot a problem.
 
-Supports **50+ locales** including English, Chinese, Japanese, German, French, Spanish, Arabic, Persian, Russian, Greek, Hebrew, and more.
+## 📦 Installation
 
-Data note: the built-in locale alias dataset was generated and curated with AI assistance. While we try to keep it accurate and conventional, it may contain mistakes or regional variations—please open an issue/PR if you spot a problem.
+```bash
+# npm
+npm install zodiac-mapper
 
-## Features
+# pnpm
+pnpm add zodiac-mapper
 
-- Map any language variant → standard zodiac enum
-- Case-insensitive, accent-insensitive, and whitespace-tolerant matching
-- Find the first or all zodiac mentions in a text string
-- No external dependencies
-- Fully typed with TypeScript
+# yarn
+yarn add zodiac-mapper
+```
+
+## 🚀 Features
 
-## Usage
+- 🗺️ **Universal Mapping**: Map any language variant → standard zodiac enum
+- 🔍 **Smart Matching**: Case-insensitive, accent-insensitive, and whitespace-tolerant matching
+- 📝 **Text Scanning**: Find the first or all zodiac mentions in a text string
+- ⚡ **Zero Dependencies**: Lightweight and fast
+- 🛡️ **TypeScript**: Fully typed for excellent developer experience
+
+## 💻 Usage
 
 ```ts
 import {
@@ -62,7 +79,7 @@ getZodiacSignFromDate("2000-03-21") === ZodiacSign.ARIES;
 getZodiacSignFromDate("03-21") === ZodiacSign.ARIES;
 ```
 
-### Locale Filtering (include / exclude)
+### 🌍 Locale Filtering (include / exclude)
 
 When scanning free text, limiting languages can reduce false positives.
 
@@ -74,7 +91,8 @@ getZodiacSign("Áries", { includeLocales: ["pt"] });
 findFirstZodiacInText("I am Áries", { excludeLocales: ["pt"] });
 ```
 
-Notes:
+### 📝 Notes
+
 - Locales are treated as BCP-47 tags; tags like `zh-Hant` will be treated as `zh` for filtering.
 - `symbols` is a special built-in pseudo-locale key (not a BCP-47 tag).
 - The default is permissive (all locales). This is great for astrology-specific text, but can be noisy in general-purpose text.

package/dist/index.cjs

@@ -2542,6 +2542,19 @@ function findFirstZodiacInText(text, options) {
 function findAllZodiacInText(text, options) {
 	return findZodiacMatchesInText(text, options);
 }
+/**
+* Returns the list of names/aliases for a given zodiac sign in a specific locale.
+* @param sign The zodiac sign.
+* @param locale The locale code (e.g. "en", "zh", "es").
+* @returns An array of names, or empty array if locale/sign not found.
+*/
+function getZodiacNames(sign, locale) {
+	const canonical = canonicalizeLocale(locale);
+	const base = getBaseLanguage(locale);
+	if (ZODIAC_PER_LOCALE[canonical]?.[sign]) return ZODIAC_PER_LOCALE[canonical][sign];
+	if (ZODIAC_PER_LOCALE[base]?.[sign]) return ZODIAC_PER_LOCALE[base][sign];
+	return [];
+}
 function isLatin(str) {
 	return /^[a-zA-Z\u00C0-\u00FF]+$/.test(str);
 }
@@ -2799,6 +2812,7 @@ exports.findAllZodiacInText = findAllZodiacInText;
 exports.findFirstZodiacInText = findFirstZodiacInText;
 exports.getSupportedLocales = getSupportedLocales;
 exports.getZodiacDateRange = getZodiacDateRange;
+exports.getZodiacNames = getZodiacNames;
 exports.getZodiacSign = getZodiacSign;
 exports.getZodiacSignFromDate = getZodiacSignFromDate;
 exports.normalizeName = normalizeName;