western-signs 1.12.2 → 1.13.0

package/README.md

@@ -27,16 +27,16 @@ npm install western-signs
 
 ## Usage
 
-To use the `getSignByName` function, import it along with the `SIGNS` constant from the `western-signs` package:
+To use the `getSign` function, import it along with the `SIGNS` constant from the `western-signs` package:
 
 ```js
-import { getSignByName, SIGNS } from 'western-signs'
+import { getSign, SIGNS } from "western-signs";
 ```
 
 Call the function with the desired astrological sign and optionally specify a language code. If no language code is provided, it defaults to English.
 
 ```js
-const data = getSignByName(SIGNS.TAURUS)
+const data = getSign(SIGNS.TAURUS);
 ```
 
 It should returns an object with the following properties:
@@ -58,64 +58,97 @@ It should returns an object with the following properties:
 }
 ```
 
+#### Translations
+
+By default, only English is included. Other languages must be explicitly imported to be available.
+
+To enable a language, import its side-effect module:
+
+```js
+import "western-signs/locale/es";
+```
+
+After importing, the language becomes available immediately:
+
+```js
+const sign = getSign(SIGNS.TAURUS, "es");
+```
+
 ### Symbols
 
 The `getSymbol` function allows you to retrieve SVG representations of astrological symbols, with options to customize their appearance.
 
+| parameter        | type                            | default          | description                                                    |
+| ---------------- | ------------------------------- | ---------------- | -------------------------------------------------------------- |
+| name             | `string`                        | —                | Symbol identifier. See constants `PLANETS`, `SIGNS`, `ASPECTS` |
+| width            | `number`                        | `24`             | Width in pixels of the generated SVG                           |
+| height           | `number`                        | `24`             | Height in pixels                                               |
+| stroke           | `string`                        | `'currentColor'` | Stroke color as hex, rgb, or CSS variable                      |
+| stroke-width     | `number`                        | `1`              | Stroke thickness in logical pixels                             |
+| stroke-linecap   | `'butt' \| 'round' \| 'square'` | `'round'`        | Shape of stroke endpoints                                      |
+| stroke-linejoin  | `'miter' \| 'round' \| 'bevel'` | `'round'`        | Shape of stroke corners and joins                              |
+| nonScalingStroke | `boolean`                       | `true`           | Prevents stroke from scaling when the SVG is resized           |
+
 ```js
-import { getSymbol, SIGNS } from 'western-signs'
+import { getSymbol, SIGNS } from "western-signs";
 
 const symbol = getSymbol(SIGNS.TAURUS, {
-  width: 16,
-  height: 16,
-  stroke: 'currentColor',
-  strokeWidth: 1,
-})
+  width: 24,
+  height: 24,
+  stroke: "currentColor",
+  "stroke-width": 1,
+});
 
-console.log(symbol.toString())
+console.log(symbol.toString());
 // Outputs: An SVG string with customized attributes
 
-console.log(symbol.toDataURL())
+console.log(symbol.toDataURL());
 // Outputs: A Data URL representation of the SVG
 ```
 
-Use method chaining to modify the attributes of the symbol for a more fluent coding style.
+#### Available symbols
 
-```js
-const chainedSymbol = getSymbol('taurus')
-  .setWidth(16)
-  .setHeight(16)
-  .setStroke('currentColor')
-  .setStrokeWidth(1)
-
-console.log(chainedSymbol.toString())
-// Outputs: The SVG string with updated stroke attributes
-```
+Three groups of exported constants. Use the identifier with getSymbol().
 
+| group   | symbols                                                                                                          |
+| ------- | ---------------------------------------------------------------------------------------------------------------- |
+| PLANETS | `SUN` `MOON` `MERCURY` `VENUS` `MARS` `JUPITER` `SATURN` `URANUS` `NEPTUNE` `PLUTO`                              |
+| SIGNS   | `ARIES` `TAURUS` `GEMINI` `CANCER` `LEO` `VIRGO` `LIBRA` `SCORPIO` `SAGITTARIUS` `CAPRICORN` `AQUARIUS` `PISCES` |
+| ASPECTS | `CONJUNCTION` `SEXTILE` `SQUARE` `TRINE` `OPPOSITION`                                                            |
 
-### Translations
+### Internationalization
 
 You can easily translate aspects and other astrology-related terms using the `t` function provided by the library. The `t` function takes template strings and values to be translated based on the current language setting.
 
 To translate an aspect into the current language:
 
 ```js
-import { ASPECTS, i18n } from 'western-signs'
+import { ASPECTS, i18n } from "western-signs";
+
+// Importing a locale registers it globally
+import "western-signs/locale/es";
 
-const aspect = i18n.t`${ASPECTS.CONJUNCTION}`
-console.log(aspect)
+const aspect = i18n.t`${ASPECTS.CONJUNCTION}`;
+console.log(aspect);
 // Output: Conjunction
 ```
 
 To change the language, use the `setLanguage` function:
 
 ```js
-i18n.setLanguage('es')
-const aspectInSpanish = i18n.t`${ASPECTS.CONJUNCTION}`
-console.log(aspectInSpanish)
+i18n.setLanguage("es");
+const aspectInSpanish = i18n.t`${ASPECTS.CONJUNCTION}`;
+console.log(aspectInSpanish);
 // Output: Conjunción
 ```
 
+#### Available languages
+
+Languages are opt-in and must be imported explicitly:
+
+- `western-signs/locale/en` — English (default)
+- `western-signs/locale/es` — Spanish
+- `western-signs/locale/ca` — Catalan
 
 ## API Reference
 
@@ -131,6 +164,7 @@ console.log(aspectInSpanish)
 
 ### Interfaces
 
+- [Aspect](https://marcmarine.github.io/western-signs/interfaces/Aspect)
 - [House](https://marcmarine.github.io/western-signs/interfaces/House)
 - [Planet](https://marcmarine.github.io/western-signs/interfaces/Planet)
 - [Sign](https://marcmarine.github.io/western-signs/interfaces/Sign)

package/dist/chunk-c664qf1s.js

@@ -0,0 +1,2 @@
+import{e,f as a,g as t,h as n,i as r,j as E,k as l,l as I}from"./chunk-g3z9cpkw.js";var o={aries:{bodyPart:E.HEAD,character:l.RAM,element:n.FIRE,endDate:new Date(2020,3,20),glyph:"♈",modality:t.CARDINAL,name:e.ARIES,number:1,pole:r.POSITIVE,rulingPlanet:a.MARS,season:I.SPRING,startDate:new Date(2020,2,20)},taurus:{bodyPart:E.THROAT,character:l.BULL,element:n.EARTH,endDate:new Date(2020,4,21),glyph:"♉",modality:t.FIXED,name:e.TAURUS,number:2,pole:r.NEGATIVE,rulingPlanet:a.VENUS,season:I.SPRING,startDate:new Date(2020,3,21)},gemini:{bodyPart:E.LUNGS,character:l.TWINS,element:n.AIR,endDate:new Date(2020,5,22),glyph:"♊",modality:t.MUTABLE,name:e.GEMINI,number:3,pole:r.POSITIVE,rulingPlanet:a.MERCURY,season:I.SPRING,startDate:new Date(2020,4,22)},cancer:{bodyPart:E.STOMACH,character:l.CRAB,element:n.WATER,endDate:new Date(2020,6,22),glyph:"♋",modality:t.CARDINAL,name:e.CANCER,number:4,pole:r.NEGATIVE,rulingPlanet:a.MOON,season:I.SUMMER,startDate:new Date(2020,5,23)},leo:{bodyPart:E.HEART,character:l.LION,element:n.FIRE,endDate:new Date(2020,7,22),glyph:"♌",modality:t.FIXED,name:e.LEO,number:5,pole:r.POSITIVE,rulingPlanet:a.SUN,season:I.SUMMER,startDate:new Date(2020,6,23)},virgo:{bodyPart:E.BOWELS,character:l.VIRGIN,element:n.EARTH,endDate:new Date(2020,8,22),glyph:"♍",modality:t.MUTABLE,name:e.VIRGO,number:6,pole:r.NEGATIVE,rulingPlanet:a.MERCURY,season:I.SUMMER,startDate:new Date(2020,7,23)},libra:{bodyPart:E.REINS,character:l.BALANCE,element:n.AIR,endDate:new Date(2020,9,22),glyph:"♎",modality:t.CARDINAL,name:e.LIBRA,number:7,pole:r.POSITIVE,rulingPlanet:a.VENUS,season:I.AUTUMN,startDate:new Date(2020,8,23)},scorpio:{bodyPart:E.SECRETS,character:l.SCORPION,element:n.WATER,endDate:new Date(2020,10,22),glyph:"♏",modality:t.FIXED,name:e.SCORPIO,number:8,pole:r.NEGATIVE,rulingPlanet:a.PLUTO,season:I.AUTUMN,startDate:new Date(2020,9,23)},sagittarius:{bodyPart:E.THIGHS,character:l.ARCHER,element:n.FIRE,endDate:new Date(2020,11,22),glyph:"♐",modality:t.MUTABLE,name:e.SAGITTARIUS,number:9,pole:r.POSITIVE,rulingPlanet:a.JUPITER,season:I.AUTUMN,startDate:new Date(2020,10,23)},capricorn:{bodyPart:E.KNEES,character:l.GOAT,element:n.EARTH,endDate:new Date(2021,0,21),glyph:"♑",modality:t.CARDINAL,name:e.CAPRICORN,number:10,pole:r.NEGATIVE,rulingPlanet:a.SATURN,season:I.WINTER,startDate:new Date(2020,11,23)},aquarius:{bodyPart:E.ANKLES,character:l.THE_MAN,element:n.AIR,endDate:new Date(2020,1,20),glyph:"♒",modality:t.FIXED,name:e.AQUARIUS,number:11,pole:r.POSITIVE,rulingPlanet:a.URANUS,season:I.WINTER,startDate:new Date(2020,0,22)},pisces:{bodyPart:E.FEET,character:l.THE_FISHES,element:n.WATER,endDate:new Date(2020,2,19),glyph:"♓",modality:t.MUTABLE,name:e.PISCES,number:12,pole:r.NEGATIVE,rulingPlanet:a.NEPTUNE,season:I.WINTER,startDate:new Date(2020,1,21)}},R=o;
+export{R as a};

package/dist/chunk-g3z9cpkw.js

@@ -0,0 +1,2 @@
+var s={ARIES:"aries",TAURUS:"taurus",GEMINI:"gemini",CANCER:"cancer",LEO:"leo",VIRGO:"virgo",LIBRA:"libra",SCORPIO:"scorpio",SAGITTARIUS:"sagittarius",CAPRICORN:"capricorn",AQUARIUS:"aquarius",PISCES:"pisces"},o={SUN:"sun",MOON:"moon",MERCURY:"mercury",VENUS:"venus",MARS:"mars",JUPITER:"jupiter",SATURN:"saturn",URANUS:"uranus",NEPTUNE:"neptune",PLUTO:"pluto"},e={CARDINAL:"cardinal",FIXED:"fixed",MUTABLE:"mutable"},t={FIRE:"fire",EARTH:"earth",AIR:"air",WATER:"water"},r={POSITIVE:"positive",NEGATIVE:"negative"},n={HEAD:"head",THROAT:"throat",LUNGS:"lungs",STOMACH:"stomach",HEART:"heart",BOWELS:"bowels",REINS:"reins",SECRETS:"secrets",THIGHS:"thighs",KNEES:"knees",ANKLES:"ankles",FEET:"feet"},E={RAM:"ram",BULL:"bull",TWINS:"twins",CRAB:"crab",LION:"lion",VIRGIN:"virgin",BALANCE:"balance",SCORPION:"scorpion",ARCHER:"archer",GOAT:"goat",THE_MAN:"the-man",THE_FISHES:"the-fishes"},u={SPRING:"spring",SUMMER:"summer",AUTUMN:"autumn",WINTER:"winter"},S=["house1","house2","house3","house4","house5","house6","house7","house8","house9","house10","house11","house12"],T=["houseTitle1","houseTitle2","houseTitle3","houseTitle4","houseTitle5","houseTitle6","houseTitle7","houseTitle8","houseTitle9","houseTitle10","houseTitle11","houseTitle12"],a=["houseKeywords1","houseKeywords2","houseKeywords3","houseKeywords4","houseKeywords5","houseKeywords6","houseKeywords7","houseKeywords8","houseKeywords9","houseKeywords10","houseKeywords11","houseKeywords12"],A={LOWER:"lower",UPPER:"upper"},R={ANGULAR:"angular",SUCCEDENT:"succedent",CADENT:"cadent"},c={LUMINARY:"luminary",PERSONAL:"personal",SOCIAL:"social",TRANSPERSONAL:"transpersonal",OTHER:"other"},i={CONJUNCTION:"conjunction",SEMISEXTILE:"semisextile",SEXTILE:"sextile",QUADRATURE:"quadrature",TRIGONE:"trigone",QUINCUNX:"quincunx",OPPOSITION:"opposition"},I={MAJOR:"major",MINOR:"minor"},h={HARMONIOUS:"harmonious",DISHARMONIOUS:"disharmonious",NEUTRAL:"neutral"};
+export{s as e,o as f,e as g,t as h,r as i,n as j,E as k,u as l,S as m,T as n,a as o,A as p,R as q,c as r,i as s,I as t,h as u};

package/dist/chunk-h886xste.js

@@ -0,0 +1,2 @@
+import{f as e,r as p}from"./chunk-g3z9cpkw.js";var t={sun:{name:e.SUN,glyph:"☉",type:p.LUMINARY},moon:{name:e.MOON,glyph:"☽",type:p.LUMINARY},mercury:{name:e.MERCURY,glyph:"☿",type:p.PERSONAL},venus:{name:e.VENUS,glyph:"♀",type:p.PERSONAL},mars:{name:e.MARS,glyph:"♂",type:p.PERSONAL},jupiter:{name:e.JUPITER,glyph:"♃",type:p.SOCIAL},saturn:{name:e.SATURN,glyph:"♄",type:p.SOCIAL},uranus:{name:e.URANUS,glyph:"♅",type:p.TRANSPERSONAL},neptune:{name:e.NEPTUNE,glyph:"♆",type:p.TRANSPERSONAL},pluto:{name:e.PLUTO,glyph:"♇",type:p.TRANSPERSONAL}},N=t;
+export{N as b};

package/dist/chunk-seazbc67.js

@@ -0,0 +1,2 @@
+var n={aries:"Aries",taurus:"Taurus",gemini:"Gemini",cancer:"Cancer",leo:"Leo",virgo:"Virgo",libra:"Libra",scorpio:"Scorpio",sagittarius:"Sagittarius",capricorn:"Capricorn",aquarius:"Aquarius",pisces:"Pisces",fire:"Fire",earth:"Earth",air:"Air",water:"Water",cardinal:"Cardinal",fixed:"Fixed",mutable:"Mutable",mars:"Mars",venus:"Venus",mercury:"Mercury",moon:"Moon",sun:"Sun",pluto:"Pluto",jupiter:"Jupiter",saturn:"Saturn",uranus:"Uranus",neptune:"Neptune",positive:"Positive",negative:"Negative",head:"Head",throat:"Throat",lungs:"Lungs",stomach:"Stomach",heart:"Heart",bowels:"Bowels",reins:"Reins",secrets:"Secrets",thighs:"Thighs",knees:"Knees",ankles:"Ankles",feet:"Feet",ram:"Ram",bull:"Bull",twins:"Twins",crab:"Crab",lion:"Lion",virgin:"Virgin",balance:"Balance",scorpion:"Scorpion",archer:"Archer",goat:"Goat","the-man":"The Man","the-fishes":"The Fishes",spring:"Spring",summer:"Summer",autumn:"Autumn",winter:"Winter",house1:"First House",house2:"Second House",house3:"Third House",house4:"Fourth House",house5:"Fifth House",house6:"Sixth House",house7:"Seventh House",house8:"Eighth House",house9:"Ninth House",house10:"Tenth House",house11:"Eleventh House",house12:"Twelfth House",houseTitle1:"The individual personality",houseTitle2:"Values and Possessions",houseTitle3:"Communication",houseTitle4:"Roots and Origins",houseTitle5:"Pleasure and Creativity",houseTitle6:"Work and Routine",houseTitle7:"Relating",houseTitle8:"Loss and Common Property",houseTitle9:"Philosophies and Far Countries",houseTitle10:"Occupation and Calling",houseTitle11:"Friends and Acquaintances",houseTitle12:"Beyond the Personal",houseKeywords1:"Self-image,Identity,Impressions on others,Personality",houseKeywords2:"Personal resources,Values,Security,Possessions",houseKeywords3:"Surroundings,Siblings,Communication,Knowledge",houseKeywords4:"Home,Family,The Past,Roots",houseKeywords5:"Children,Creativity,Expression,Pleasure",houseKeywords6:"Routines,Service,Health,Productivity",houseKeywords7:"Partnerships,Relationships,Balance,Collaboration",houseKeywords8:"Transformations,Crises,Beginnings,Rebirth",houseKeywords9:"Philosophy,Travel,Openness,Wisdom",houseKeywords10:"Public,Legacy,Career,Ambition",houseKeywords11:"Friends,Community,Dreams,Aspirations",houseKeywords12:"Unconscious,Fantasies,Connections,Healing",lower:"Lower",upper:"Upper",angular:"Angular",succedent:"Succedent",cadent:"Cadent",luminary:"Luminary",personal:"Personal",social:"Social",transpersonal:"Transpersonal",other:"Other",conjunction:"Conjunction",semisextile:"Semisextile",sextile:"Sextile",quadrature:"Quadrature",trigone:"Trigone",quincunx:"Quincunx",opposition:"Opposition",major:"Major",minor:"Minor",harmonious:"Harmonious",disharmonious:"Disharmonious",neutral:"Neutral",ascendant:"Ascendant"},e=n;var s=new Map;s.set("en",e);function a(o,i){s.set(o,i)}
+export{s as c,a as d};

package/dist/data/aspects.d.ts

@@ -0,0 +1,2 @@
+import type { Aspect } from "../definitions";
+export declare const aspects: Aspect[];

package/dist/data/constants.d.ts

@@ -0,0 +1,112 @@
+export declare const SIGNS: {
+    readonly ARIES: "aries";
+    readonly TAURUS: "taurus";
+    readonly GEMINI: "gemini";
+    readonly CANCER: "cancer";
+    readonly LEO: "leo";
+    readonly VIRGO: "virgo";
+    readonly LIBRA: "libra";
+    readonly SCORPIO: "scorpio";
+    readonly SAGITTARIUS: "sagittarius";
+    readonly CAPRICORN: "capricorn";
+    readonly AQUARIUS: "aquarius";
+    readonly PISCES: "pisces";
+};
+export declare const PLANETS: {
+    readonly SUN: "sun";
+    readonly MOON: "moon";
+    readonly MERCURY: "mercury";
+    readonly VENUS: "venus";
+    readonly MARS: "mars";
+    readonly JUPITER: "jupiter";
+    readonly SATURN: "saturn";
+    readonly URANUS: "uranus";
+    readonly NEPTUNE: "neptune";
+    readonly PLUTO: "pluto";
+};
+export declare const MODALITIES: {
+    readonly CARDINAL: "cardinal";
+    readonly FIXED: "fixed";
+    readonly MUTABLE: "mutable";
+};
+export declare const ELEMENTS: {
+    readonly FIRE: "fire";
+    readonly EARTH: "earth";
+    readonly AIR: "air";
+    readonly WATER: "water";
+};
+export declare const POLARITIES: {
+    readonly POSITIVE: "positive";
+    readonly NEGATIVE: "negative";
+};
+export declare const BODY_PARTS: {
+    readonly HEAD: "head";
+    readonly THROAT: "throat";
+    readonly LUNGS: "lungs";
+    readonly STOMACH: "stomach";
+    readonly HEART: "heart";
+    readonly BOWELS: "bowels";
+    readonly REINS: "reins";
+    readonly SECRETS: "secrets";
+    readonly THIGHS: "thighs";
+    readonly KNEES: "knees";
+    readonly ANKLES: "ankles";
+    readonly FEET: "feet";
+};
+export declare const CHARACTERS: {
+    readonly RAM: "ram";
+    readonly BULL: "bull";
+    readonly TWINS: "twins";
+    readonly CRAB: "crab";
+    readonly LION: "lion";
+    readonly VIRGIN: "virgin";
+    readonly BALANCE: "balance";
+    readonly SCORPION: "scorpion";
+    readonly ARCHER: "archer";
+    readonly GOAT: "goat";
+    readonly THE_MAN: "the-man";
+    readonly THE_FISHES: "the-fishes";
+};
+export declare const SEASONS: {
+    readonly SPRING: "spring";
+    readonly SUMMER: "summer";
+    readonly AUTUMN: "autumn";
+    readonly WINTER: "winter";
+};
+export declare const HOUSES: readonly ["house1", "house2", "house3", "house4", "house5", "house6", "house7", "house8", "house9", "house10", "house11", "house12"];
+export declare const HOUSE_TITLES: readonly ["houseTitle1", "houseTitle2", "houseTitle3", "houseTitle4", "houseTitle5", "houseTitle6", "houseTitle7", "houseTitle8", "houseTitle9", "houseTitle10", "houseTitle11", "houseTitle12"];
+export declare const HOUSE_KEYWORDS: readonly ["houseKeywords1", "houseKeywords2", "houseKeywords3", "houseKeywords4", "houseKeywords5", "houseKeywords6", "houseKeywords7", "houseKeywords8", "houseKeywords9", "houseKeywords10", "houseKeywords11", "houseKeywords12"];
+export declare const HEMISPHERES: {
+    readonly LOWER: "lower";
+    readonly UPPER: "upper";
+};
+export declare const HOUSE_MODALITIES: {
+    readonly ANGULAR: "angular";
+    readonly SUCCEDENT: "succedent";
+    readonly CADENT: "cadent";
+};
+export declare const PLANET_TYPE: {
+    readonly LUMINARY: "luminary";
+    readonly PERSONAL: "personal";
+    readonly SOCIAL: "social";
+    readonly TRANSPERSONAL: "transpersonal";
+    readonly OTHER: "other";
+};
+export declare const ASPECTS: {
+    readonly CONJUNCTION: "conjunction";
+    readonly SEMISEXTILE: "semisextile";
+    readonly SEXTILE: "sextile";
+    readonly QUADRATURE: "quadrature";
+    readonly TRIGONE: "trigone";
+    readonly QUINCUNX: "quincunx";
+    readonly OPPOSITION: "opposition";
+};
+export declare const ASPECT_TYPE: {
+    readonly MAJOR: "major";
+    readonly MINOR: "minor";
+};
+export declare const ASPECT_QUALITY: {
+    readonly HARMONIOUS: "harmonious";
+    readonly DISHARMONIOUS: "disharmonious";
+    readonly NEUTRAL: "neutral";
+};

package/dist/data/constants.js

@@ -0,0 +1 @@
+import{e as a,f as b,g as c,h as d,i as e,j as f,k as g,l as h,m as i,n as j,o as k,p as l,q as m,r as n,s as o,t as p,u as q}from"../chunk-g3z9cpkw.js";export{a as SIGNS,h as SEASONS,e as POLARITIES,n as PLANET_TYPE,b as PLANETS,c as MODALITIES,j as HOUSE_TITLES,m as HOUSE_MODALITIES,k as HOUSE_KEYWORDS,i as HOUSES,l as HEMISPHERES,d as ELEMENTS,g as CHARACTERS,f as BODY_PARTS,p as ASPECT_TYPE,q as ASPECT_QUALITY,o as ASPECTS};

package/dist/data/dictionaries/ca.d.ts

@@ -0,0 +1,3 @@
+import type { Dictionary } from '../../definitions';
+declare const ca: Dictionary;
+export default ca;

package/dist/data/dictionaries/en.d.ts

@@ -0,0 +1,3 @@
+import type { Dictionary } from '../../definitions';
+declare const en: Dictionary;
+export default en;

package/dist/data/dictionaries/es.d.ts

@@ -0,0 +1,3 @@
+import type { Dictionary } from '../../definitions';
+declare const es: Dictionary;
+export default es;

package/dist/data/dictionaries/index.d.ts

@@ -0,0 +1,3 @@
+import type { Dictionary } from '../../definitions';
+export declare const dictionaries: Map<string, Dictionary>;
+export declare function registerDictionary(lang: string, dictionary: Dictionary): void;

package/dist/data/houses.d.ts

@@ -0,0 +1,3 @@
+import type { House } from '../definitions';
+declare const houses: House[];
+export default houses;

package/dist/data/planets.d.ts

@@ -0,0 +1,3 @@
+import type { Planets, Planet } from '../definitions';
+declare const planets: Record<Planets, Planet>;
+export default planets;

package/dist/data/signs.d.ts

@@ -0,0 +1,3 @@
+import type { Sign, Signs } from '../definitions';
+declare const signs: Record<Signs, Sign>;
+export default signs;

package/dist/data/symbols.d.ts

@@ -0,0 +1,32 @@
+export declare const SYMBOLS: {
+    readonly scorpio: "M19.5 16.8v-3.3h3.3,M2.732 8.768A2.5 2.5 0 1 1 7 7m0 0v10M7 7a2.5 2.5 0 1 1 5 0m0 0v10m0-10a2.5 2.5 0 1 1 5 0v10a2.5 2.5 0 1 0 4.268-1.768L20 14";
+    readonly gemini: "M7 4.044v15.912M17 4.044v15.912,M22 2A19.99 19.99 0 0 1 2 2M22 22a20 20 0 0 0-20 0";
+    readonly opposition: "m7.696 16.304 8.608-8.608m-.976-2.36a3.336 3.336 0 0 0 3.337 3.453A3.34 3.34 0 0 0 22 5.334a3.339 3.339 0 0 0-6.67 0zM2 18.664a3.337 3.337 0 1 0 6.669.281A3.337 3.337 0 0 0 2 18.664Z";
+    readonly moon: "M7 2a10 10 0 0 1 0 20 11.55 11.55 0 0 0 5.774-10c0-4.124-2.204-7.938-5.774-10Z";
+    readonly taurus: "M11.921 8.321a7.6 7.6 0 0 1 7.599 7.601v-.002a7.6 7.6 0 1 1-7.599-7.599Zm0 0A7.604 7.604 0 0 1 4.32.72m7.601 7.601A7.6 7.6 0 0 0 19.52.72";
+    readonly leo: "M9.5 14.5C9.5 12 7 9.5 7 7a5 5 0 0 1 10 0c0 5-2.5 7.5-2.5 12.5a2.5 2.5 0 1 0 5 0m-10-5a2.5 2.5 0 1 0-5 0 2.5 2.5 0 0 0 5 0Z";
+    readonly libra: "M.45 12h5.775a5.775 5.775 0 0 1 11.55 0h5.775M.45 17.775h23.1";
+    readonly trigone: "M2 21.994 12 4.672l10 17.32z";
+    readonly semisextile: "M22 16.33H12m-10 0h10M7 7.67l5 8.66m0 0 5-8.66";
+    readonly cancer: "M22 12a3.335 3.335 0 1 0-6.67 0A3.335 3.335 0 0 0 22 12Zm0 0A10 10 0 0 0 4.93 4.93M2 12a3.334 3.334 0 1 0 6.668 0A3.334 3.334 0 0 0 2 12Zm0 0a10 10 0 0 0 17.07 7.07";
+    readonly neptune: "M12 22V2M7 14.5h10M4.5 2a7.502 7.502 0 0 0 15 0";
+    readonly quadrature: "M22 22H2V1.996h20v20";
+    readonly uranus: "M12 17V4.5M7 2v10M17 2v10M7 7h10m-2.5 12.5a2.498 2.498 0 1 0-4.997.004A2.498 2.498 0 0 0 14.5 19.5Z";
+    readonly pluto: "M17 20H7V4h5c2.758 0 5 1.24 5 4s-2.242 4-5 4H7";
+    readonly pisces: "M18.25 3.34a10 10 0 0 0 0 17.32m-12.5 0a10 10 0 0 0 0-17.32M2 11.996h20.006";
+    readonly capricorn: "M1.7 8.666h3.334L8.366 22 11.7 8.666h6.666A3.332 3.332 0 1 0 15.48 7l5.774 10a3.334 3.334 0 1 1-6.22 1.666";
+    readonly sextile: "M22 12H2m5-8.66 10 17.32m0-17.32L7 20.66";
+    readonly jupiter: "M4.5 2a8.66 8.66 0 0 1 0 15h15m-5-5v10";
+    readonly mercury: "M12 6a4 4 0 1 1 0 8m0-8a4 4 0 1 0 0 8m0-8a4 4 0 0 1-4-4m4 4a4 4 0 0 0 4-4m-4 12v8m-4-4h8";
+    readonly aries: "M3.464 10.836A5 5 0 1 1 12 7.3m0 0a5 5 0 1 1 8.536 3.536M12 7.3v15";
+    readonly venus: "M12 22v-8m0 0a6 6 0 1 0 0-12 6 6 0 0 0 0 12Zm-4 4h8";
+    readonly conjunction: "M7.696 16.304 18.664 5.336M2 18.664a3.337 3.337 0 1 0 6.67.281A3.337 3.337 0 0 0 2 18.664Z";
+    readonly mars: "M14.163 9.681 20.344 3.5M16 14c0-3.31-2.69-6-6-6s-6 2.69-6 6 2.69 6 6 6 6-2.69 6-6Z,M16.804 3.5h3.54v3.54";
+    readonly aquarius: "M2 15.5a3.54 3.54 0 0 1 5 0 3.536 3.536 0 0 0 5 0 3.54 3.54 0 0 1 5 0 3.537 3.537 0 0 0 5 0m-20-7a3.54 3.54 0 0 1 5 0 3.534 3.534 0 0 0 5 0 3.54 3.54 0 0 1 5 0 3.534 3.534 0 0 0 5 0";
+    readonly virgo: "M2.269 8.768a2.5 2.5 0 0 1-.656-1.042 2.4 2.4 0 0 1-.063-1.213 2.45 2.45 0 0 1 .546-1.099 2.6 2.6 0 0 1 1.024-.723 2.74 2.74 0 0 1 2.463.23c.36.229.653.538.857.9.203.363.31.768.31 1.179m0 0v10m0-10c0-.663.277-1.299.769-1.768A2.7 2.7 0 0 1 9.375 4.5c.696 0 1.364.263 1.856.732.492.47.769 1.105.769 1.768m0 0c0-.663.277-1.299.769-1.768a2.7 2.7 0 0 1 1.856-.732c.696 0 1.364.263 1.856.732.492.47.769 1.105.769 1.768v10c0 1.38 1.176 2.5 2.625 2.5M12 7v10m5.25-7.5c0-.663.277-1.299.769-1.768A2.7 2.7 0 0 1 19.875 7c.696 0 1.364.263 1.856.732.492.47.769 1.105.769 1.768 0 1.99-.83 3.897-2.306 5.303C18.717 16.21 16.714 17 14.625 17";
+    readonly saturn: "M6 6h8m-4-4v10a3.998 3.998 0 1 1 6.828 2.828C15.016 16.64 14 19.44 14 22";
+    readonly ascendant: "M9.55 5.25 12 2.8m0 0 2.45 2.45M12 2.8v19.5";
+    readonly quincunx: "M22 7.67H12m-10 0h10m-5 8.66 5-8.66m0 0 5 8.66";
+    readonly sun: "M11.983 10.704a1.3 1.3 0 0 1 1.255 1.297 1.298 1.298 0 1 1-1.255-1.297Z,M22 12c0-5.524-4.477-10-10-10S2 6.476 2 12c0 5.523 4.477 10 10 10s10-4.477 10-10Z";
+    readonly sagittarius: "m6.912 7.088 10 10m-15 5 20-20,M16.912 2.088h5v5";
+};

package/dist/definitions.d.ts

@@ -0,0 +1,237 @@
+import type { ASPECT_QUALITY, ASPECT_TYPE, ASPECTS, BODY_PARTS, CHARACTERS, ELEMENTS, HEMISPHERES, HOUSE_KEYWORDS, HOUSE_MODALITIES, HOUSE_TITLES, HOUSES, MODALITIES, PLANET_TYPE, PLANETS, POLARITIES, SEASONS, SIGNS } from './data/constants';
+export type Language = 'en' | 'es' | 'ca';
+type ObjectValues<T> = T[keyof T];
+export type Signs = ObjectValues<typeof SIGNS>;
+export type Elements = ObjectValues<typeof ELEMENTS>;
+export type Modalities = ObjectValues<typeof MODALITIES>;
+export type Planets = ObjectValues<typeof PLANETS>;
+export type Polarities = ObjectValues<typeof POLARITIES>;
+export type BodyParts = ObjectValues<typeof BODY_PARTS>;
+export type Characters = ObjectValues<typeof CHARACTERS>;
+export type Seasons = ObjectValues<typeof SEASONS>;
+export type Hemispheres = ObjectValues<typeof HEMISPHERES>;
+export type HouseModalities = ObjectValues<typeof HOUSE_MODALITIES>;
+export type PlanetType = ObjectValues<typeof PLANET_TYPE>;
+export type Aspects = ObjectValues<typeof ASPECTS>;
+export type HouseTitles = (typeof HOUSE_TITLES)[number];
+export type HouseKeywords = (typeof HOUSE_KEYWORDS)[number];
+export type Houses = (typeof HOUSES)[number];
+export type Symbols = Signs | Planets | Aspects | 'ascendant';
+export type AspectType = ObjectValues<typeof ASPECT_TYPE>;
+export type AspectQuality = ObjectValues<typeof ASPECT_QUALITY>;
+export interface Sign {
+    /**
+     * The body part associated with the zodiac sign.
+     * Indicates the areas of the body influenced by the sign.
+     * Examples: "Head" for Aries, "Throat" for Taurus.
+     */
+    bodyPart: string;
+    /**
+     * The character associated with the zodiac sign.
+     * A visual representation or icon associated with the sign.
+     * Examples: "The Ram" for Aries, "The Bull" for Taurus.
+     */
+    character: string;
+    /**
+     * The element associated with the zodiac sign.
+     * Represents one of the four classical elements: Fire, Earth, Air, Water.
+     * Also known as triplicities in astrology.
+     * Examples: "Fire" for Aries, "Earth" for Taurus.
+     */
+    element: Elements;
+    /**
+     * The end date of the zodiac sign period.
+     * This date marks the end of the zodiac sign's influence for the given year.
+     * Examples: new Date(2020, 3, 20) for Aries (April 20, 2020), new Date(2020, 4, 21) for Taurus (May 21, 2020).
+     */
+    endDate: Date;
+    /**
+     * The glyph representing the zodiac sign.
+     * A symbolic character or drawing associated with the sign.
+     * Examples: "♈" for Aries, "♉" for Taurus.
+     */
+    glyph: string;
+    /**
+     * The modality of the sign.
+     * Indicates its mode of operation: Cardinal, Fixed, or Mutable.
+     * Examples: "Cardinal" for Aries, "Fixed" for Taurus.
+     */
+    modality: string;
+    /**
+     * The name of the zodiac sign.
+     * Examples: "Aries", "Taurus".
+     */
+    name: string;
+    /**
+     * The number associated with the zodiac sign.
+     * Reflects its order in the zodiac cycle.
+     * Examples: 1 for Aries (the first sign), 2 for Taurus (the second sign).
+     */
+    number: number;
+    /**
+     * The polarity of the sign.
+     * Indicates its active (Positive) or passive (Negative) nature.
+     * Examples: "Positive" for Aries, "Negative" for Taurus.
+     */
+    pole: string;
+    /**
+     * The ruling planet of the zodiac sign.
+     * Represents the guiding celestial body influencing the sign.
+     * Examples: "Mars" for Aries, "Venus" for Taurus.
+     */
+    rulingPlanet: string;
+    /**
+     * The season in which the zodiac sign occurs.
+     * Indicates the time of year the sign predominates.
+     * Examples: "Spring" for Aries, "Spring" for Taurus.
+     */
+    season: string;
+    /**
+     * The start date of the zodiac sign period.
+     * This date marks the beginning of the zodiac sign's influence for the given year.
+     * Examples: new Date(2020, 2, 20) for Aries (March 20, 2020), new Date(2020, 3, 21) for Taurus (April 21, 2020).
+     */
+    startDate: Date;
+}
+export interface House {
+    /**
+     * Element associated with the house’s natural zodiac sign.
+     *
+     * Represents one of the four classical elements — Fire, Earth, Air, or Water — reflecting the essential nature and mode of expression of the house.
+     *
+     * Example: "Fire" for House 1 (Aries), "Earth" for House 2 (Taurus)
+     */
+    element: Elements;
+    /**
+     * Hemisphere division based on the horizon line.
+     *
+     * - **Lower/Northern Hemisphere (Houses 1–6):** Known as the *Personal Houses*, these focus on individual development, personal identity, and foundational life needs.
+     * - **Upper/Southern Hemisphere (Houses 7–12):** Known as the *Collective Houses*, these reflect relationships with others, society, and broader humanity.
+     */
+    hemisphere: Hemispheres;
+    /**
+     * Key themes and associated concepts.
+     *
+     * Represents the core ideas or psychological themes governed by the house.
+     * Example: ['Self-image', 'Identity', 'Impressions on others', 'Personality']
+     */
+    keywords: string[] | string;
+    /**
+     * Number of the astrological house (1–12).
+     *
+     * Each house corresponds to a specific domain of life experience.
+     * Example: 1 = Self and identity, 7 = Partnerships and relating.
+     */
+    number: number;
+    /**
+     * Developmental phase grouping.
+     *
+     * - **Phase I (Houses 1–4):** Focus on self-awareness and personal foundation — the “me-in-here”.
+     * - **Phase II (Houses 5–8):** Development of the autonomous self in relationship — the “me” meets the “you”.
+     * - **Phase III (Houses 9–12):** Expansion of self toward collective consciousness and universal understanding.
+     */
+    phase: 1 | 2 | 3;
+    /**
+     * Quadrant of the chart based on the intersection of horizon and meridian axes.
+     *
+     * - **Quadrant I (Houses 1–3):** Formation of personal identity through the body, possessions, and environment.
+     * - **Quadrant II (Houses 4–6):** Further development of self via family, creativity, and refinement of skills.
+     * - **Quadrant III (Houses 7–9):** Expansion through relationships, transformation, and new vision of self.
+     * - **Quadrant IV (Houses 10–12):** Integration into society and pursuit of collective and spiritual purpose.
+     */
+    quadrant: 1 | 2 | 3 | 4;
+    /**
+     * Ruling planet of the house.
+     *
+     * Indicates the primary planetary influence over the house’s themes.
+     * Example: "Mars", "Venus"
+     */
+    rulingPlanet: string;
+    /**
+     * Zodiac sign associated with the house.
+     *
+     * Reflects the natural energy or archetype that aligns with the house.
+     * Example: "Aries", "Taurus"
+     */
+    sign: string;
+    /**
+     * Title or name of the house.
+     *
+     * A formal or descriptive label that captures the house’s core function or domain.
+     * Example: "The Individual Personality", "Values and Possessions"
+     */
+    title: string;
+    /**
+     * Modalities of the houses (Angular, Succedent, Cadent).
+     *
+     * Traditional classification describing the house’s dynamic strength and function:
+     * - **Angular (Houses 1, 4, 7, 10):** Active, initiating, most powerful.
+     * - **Succedent (Houses 2, 5, 8, 11):** Stabilizing, sustaining what was initiated.
+     * - **Cadent (Houses 3, 6, 9, 12):** Transitional, preparatory, often more internal or mental.
+     */
+    modality: HouseModalities;
+    /**
+     * The name of the astrological house.
+     * Refers to its designated number in the zodiac cycle, such as "First House", "Second House", etc.
+     * Examples: "First House", "Second House", "Third House", ... "Twelfth House".
+     */
+    name: Houses;
+}
+export interface Planet {
+    /**
+     * The name of the celestial body.
+     * Examples: "Sun", "Moon".
+     */
+    name: string;
+    /**
+     * The glyph or symbol associated with the celestial body.
+     * Examples: "☉" for the Sun, "☽" for the Moon, "♂" for Mars.
+     */
+    glyph: string;
+    /**
+     * The type or category of the celestial body.
+     * Examples: "Personal", "Luminary".
+     */
+    type: PlanetType;
+}
+export type Translations = Record<Language, Sign>;
+export type Dictionary = {
+    [key in Signs | Elements | Modalities | Planets | Polarities | BodyParts | Characters | Seasons | Hemispheres | HouseModalities | PlanetType | Houses | HouseTitles | HouseKeywords | Aspects | AspectType | AspectQuality]: string;
+};
+export type Dictionaries = Record<Language, Dictionary>;
+export type SymbolOptions = {
+    width?: number | string;
+    height?: number | string;
+    fill?: string;
+    stroke?: string;
+    'stroke-width'?: number | string;
+    class?: string;
+    style?: string;
+    nonScalingStroke?: boolean;
+};
+export interface Aspect {
+    /**
+     * The name of the aspect.
+     * Examples: "Conjunction", "Opposition", "Square", "Trine", "Sextile".
+     */
+    name: string;
+    /**
+     * The type of the aspect.
+     * Indicates the nature of the aspect's influence.
+     * Examples: "Major", "Minor".
+     */
+    type: AspectType;
+    /**
+     * The quality of the aspect.
+     * Reflects the emotional or psychological impact of the aspect.
+     * Examples: "Harmonious", "Disharmonious", "Neutral".
+     */
+    quality: AspectQuality;
+    /**
+     * The angle of the aspect in degrees.
+     * Represents the geometric relationship between the two celestial bodies.
+     * Examples: 0 for Conjunction, 180 for Opposition, 90 for Square, 120 for Trine, 60 for Sextile...
+     */
+    angle: number;
+}
+export {};

package/dist/getHouses.d.ts

@@ -0,0 +1,31 @@
+import type { House, Language } from './definitions';
+/**
+ * Get all astrological houses with their translations for a specified language.
+ *
+ * @param {Language} [language='en'] - The language code for which translations are needed. Defaults to 'en'.
+ * @returns {House[]} An array of House objects with translated values based on the specified language.
+ *
+ * @example
+ * import { getHouses } from 'western-houses';
+ *
+ * // Retrieve information about all houses in English
+ * const data = getHouses();
+ * console.log(data);
+ * // Output:
+ * // [
+ * //  {
+ * //     number: 1,
+ * //     title: 'The individual personality',
+ * //     sign: 'Aries',
+ * //     rulingPlanet: 'Mars',
+ * //     keywords: [
+ * //       'Self-image',
+ * //       'Identity',
+ * //       'Impressions on others',
+ * //       'Personality'
+ * //     ]
+ * //   },
+ * //  ...
+ * // ]
+ */
+export declare function getHouses(language?: Language): House[];

package/dist/getHouses.js

@@ -0,0 +1 @@
+import{c as i}from"./chunk-seazbc67.js";import{e,f as E,h as m,m as n,n as R,o as t,p as r,q as U}from"./chunk-g3z9cpkw.js";var T=[{element:m.FIRE,hemisphere:r.LOWER,keywords:t[0],modality:U.ANGULAR,number:1,phase:1,quadrant:1,rulingPlanet:E.MARS,sign:e.ARIES,title:R[0],name:n[0]},{element:m.EARTH,hemisphere:r.LOWER,keywords:t[1],modality:U.SUCCEDENT,number:2,phase:1,quadrant:1,rulingPlanet:E.VENUS,sign:e.TAURUS,title:R[1],name:n[1]},{element:m.AIR,hemisphere:r.LOWER,keywords:t[2],modality:U.CADENT,number:3,phase:1,quadrant:1,rulingPlanet:E.MERCURY,sign:e.GEMINI,title:R[2],name:n[2]},{element:m.WATER,hemisphere:r.LOWER,keywords:t[3],modality:U.ANGULAR,number:4,phase:1,quadrant:2,rulingPlanet:E.MOON,sign:e.CANCER,title:R[3],name:n[3]},{element:m.FIRE,hemisphere:r.LOWER,keywords:t[4],modality:U.SUCCEDENT,number:5,phase:2,quadrant:2,rulingPlanet:E.SUN,sign:e.LEO,title:R[4],name:n[4]},{element:m.EARTH,hemisphere:r.LOWER,keywords:t[5],modality:U.CADENT,number:6,phase:2,quadrant:2,rulingPlanet:E.MERCURY,sign:e.VIRGO,title:R[5],name:n[5]},{element:m.AIR,hemisphere:r.UPPER,keywords:t[6],modality:U.ANGULAR,number:7,phase:2,quadrant:3,rulingPlanet:E.VENUS,sign:e.LIBRA,title:R[6],name:n[6]},{element:m.WATER,hemisphere:r.UPPER,keywords:t[7],modality:U.SUCCEDENT,number:8,phase:2,quadrant:3,rulingPlanet:E.PLUTO,sign:e.SCORPIO,title:R[7],name:n[7]},{element:m.FIRE,hemisphere:r.UPPER,keywords:t[8],modality:U.CADENT,number:9,phase:3,quadrant:3,rulingPlanet:E.JUPITER,sign:e.SAGITTARIUS,title:R[8],name:n[8]},{element:m.EARTH,hemisphere:r.UPPER,keywords:t[9],modality:U.ANGULAR,number:10,phase:3,quadrant:4,rulingPlanet:E.SATURN,sign:e.CAPRICORN,title:R[9],name:n[9]},{element:m.AIR,hemisphere:r.UPPER,keywords:t[10],modality:U.SUCCEDENT,number:11,phase:3,quadrant:4,rulingPlanet:E.URANUS,sign:e.AQUARIUS,title:R[10],name:n[10]},{element:m.WATER,hemisphere:r.UPPER,keywords:t[11],modality:U.CADENT,number:12,phase:3,quadrant:4,rulingPlanet:E.NEPTUNE,sign:e.PISCES,title:R[11],name:n[11]}],S=T;function y(P="en"){return S.map((l)=>{return Object.fromEntries(Object.entries(l).map(([N,A])=>[N,i.get(P)?.[A]||A]))})}export{y as getHouses};