lifeastroapi 0.7.0 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -32,10 +32,10 @@ type HouseSystem = "whole-sign" | "equal" | "placidus" | "koch" | "porphyry" | "
32
32
  * numerology, dasha, varshaphal, ashtakavarga, Lal Kitab, horoscope, reports,
33
33
  * narrative, remedies).
34
34
  *
35
- * - Complete: `en`, `hi`, `mr`, `te`, `ta`, `kn`, `ml`, `gu`. Names, terms and
36
- * prose all come back in the language.
37
- * - Partial: `bn`, `pa`. Names and terms come back in the language; longer
38
- * prose is still English.
35
+ * - Complete: `en`, `hi`, `mr`, `te`, `ta`, `kn`, `ml`, `gu`, `bn`. Names, terms
36
+ * and prose all come back in the language.
37
+ * - Partial: `pa`. Names and terms come back in the language; longer prose is
38
+ * still English.
39
39
  *
40
40
  * Ids, dates, numbers and explicit `*_en` / `*_hi` fields stay as they are in
41
41
  * every language. Western, Tarot, geo and meta methods answer in English
@@ -227,24 +227,28 @@ declare class Calendar {
227
227
  adhikMaas<T = unknown>(input: {
228
228
  year: number;
229
229
  tz?: string;
230
+ ayanamsa?: string;
230
231
  lang?: Locale;
231
232
  }, opts?: RequestOptions): Promise<T>;
232
233
  /** Get the Hindu calendar details for a Gregorian month — maps each day to its Hindu month (Chaitra/Vaishakha/…), paksha (Shukla/Krishna), tithi, and Vikram Samvat year. */
233
234
  month<T = unknown>(input: {
234
235
  date: string;
235
236
  tz: string;
237
+ ayanamsa?: string;
236
238
  lang?: Locale;
237
239
  }, opts?: RequestOptions): Promise<T>;
238
240
  /** Get the current Hindu Ritu (season) for a date — one of 6 seasons: Vasanta (spring), Grishma (summer), Varsha (monsoon), Sharad (autumn), Hemanta (pre-winter), Shishira (winter). */
239
241
  ritu<T = unknown>(input: {
240
242
  date: string;
241
243
  tz: string;
244
+ ayanamsa?: string;
242
245
  lang?: Locale;
243
246
  }, opts?: RequestOptions): Promise<T>;
244
247
  /** Get the Samvatsara (Jupiter year) name for a given year — the 60-year Jupiter cycle used in Hindu astrology (Prabhava, Vibhava, Shukla, … Akshaya). */
245
248
  samvatsara<T = unknown>(input: {
246
249
  date: string;
247
250
  tz: string;
251
+ ayanamsa?: string;
248
252
  lang?: Locale;
249
253
  }, opts?: RequestOptions): Promise<T>;
250
254
  /** Equinoxes and solstices of a year — exact moment (UTC + local), the ayana that begins (tropical Dakshinayana at the June solstice, tropical Uttarayana at the December solstice; the panchang's Uttarayana is Makara Sankranti), and with lat/lon the sunrise, sunset and day length at that place. */
@@ -391,8 +395,9 @@ declare class Dasha {
391
395
  ad: string;
392
396
  lang?: Locale;
393
397
  }, opts?: RequestOptions): Promise<T>;
394
- /** Currently running Char Dasha (Jaimini) period stack — active mahadasha and antardasha signs with date windows. */
398
+ /** Currently running Char Dasha (Jaimini) period stack — active mahadasha and antardasha signs with date windows (optionally at a custom moment `at`, UTC). */
395
399
  charCurrent<T = unknown>(input: BirthInput & VedicBirthSettings & {
400
+ at?: string;
396
401
  lang?: Locale;
397
402
  }, opts?: RequestOptions): Promise<T>;
398
403
  /** Antardashas inside one Char Dasha mahadasha sign (md = sign name, e.g. 'leo'). */
@@ -578,8 +583,9 @@ declare class Lalkitab {
578
583
  dasha<T = unknown>(input: BirthInput & VedicBirthSettings & {
579
584
  lang?: Locale;
580
585
  }, opts?: RequestOptions): Promise<T>;
581
- /** Currently active Lal Kitab dasha planet and period window. */
586
+ /** Currently active Lal Kitab dasha planet and period window (optionally at a custom moment `at`, UTC). */
582
587
  dashaCurrent<T = unknown>(input: BirthInput & VedicBirthSettings & {
588
+ at?: string;
583
589
  lang?: Locale;
584
590
  }, opts?: RequestOptions): Promise<T>;
585
591
  }
@@ -682,8 +688,12 @@ declare class Milan {
682
688
  declare class Muhurta {
683
689
  private readonly _c;
684
690
  constructor(_c: ClientCore);
685
- /** Best-scoring general muhurta window in a date range. Each `factors[]` item has a stable English `id` (e.g. `Tithi`, `RahuKaal`); `name` and `value` follow `lang`. */
691
+ /** Best-scoring muhurta windows in a date range. `purpose` is `general` (default), `vivah`, `graha_pravesh` or `naamkaran`; `topN` (1-20, default 5) sets how many windows come back; `birthDate` (YYYY-MM-DD) weights the windows by the person's tara bala and chandra bala. Each `factors[]` item has a stable English `id` (e.g. `Tithi`, `RahuKaal`); `name` and `value` follow `lang`. */
686
692
  bestTime<T = unknown>(input: MuhurtaInput & {
693
+ purpose?: string;
694
+ topN?: number;
695
+ birthDate?: string;
696
+ ayanamsa?: string;
687
697
  lang?: Locale;
688
698
  }, opts?: RequestOptions): Promise<T>;
689
699
  /** Compute Chandra Bala — the Moon's strength relative to a person's natal Moon sign on a given date. */
@@ -1105,6 +1115,7 @@ declare class PlanetMoments {
1105
1115
  time?: string;
1106
1116
  tz: string;
1107
1117
  maxDays?: number;
1118
+ ayanamsa?: string;
1108
1119
  lang?: Locale;
1109
1120
  }, opts?: RequestOptions): Promise<T>;
1110
1121
  /** A planet's sign ingresses (sankranti) in a date range. */
@@ -1114,6 +1125,7 @@ declare class PlanetMoments {
1114
1125
  time?: string;
1115
1126
  tz: string;
1116
1127
  maxDays?: number;
1128
+ ayanamsa?: string;
1117
1129
  lang?: Locale;
1118
1130
  }, opts?: RequestOptions): Promise<T>;
1119
1131
  /** A planet's retrograde windows (station retro -> station direct) in a date range. */
@@ -1249,8 +1261,9 @@ declare class Reports {
1249
1261
  month: string;
1250
1262
  lang?: string;
1251
1263
  }, opts?: RequestOptions): Promise<T>;
1252
- /** Generate a detailed weekly horoscope report for a Moon sign — structured report covering the week's planetary movement, day-by-day highlights, and focus areas. */
1264
+ /** Generate a detailed weekly horoscope report for a Moon sign — structured report covering the week's planetary movement, day-by-day highlights, and focus areas. `week` is an ISO week such as `2026-W47` (default: the current week). */
1253
1265
  horoscopeWeekly<T = unknown>(input: RashiInput & {
1266
+ week?: string;
1254
1267
  lang?: string;
1255
1268
  }, opts?: RequestOptions): Promise<T>;
1256
1269
  /** Generate the Brihad (comprehensive) Kundli report — the most detailed birth chart report covering chart analysis, all divisional charts (D1–D60), planetary strengths (Shadbala), ashtakavarga, all dashas, yogas, doshas, remedies, and lifetime predictions. */
@@ -1440,25 +1453,69 @@ declare class WesternComposite {
1440
1453
  private readonly _c;
1441
1454
  constructor(_c: ClientCore);
1442
1455
  /** Get aspects in the composite (midpoint) chart for two people — shows how the relationship's combined energy is configured. */
1443
- aspects<T = unknown>(input: TwoPersonInput, opts?: RequestOptions): Promise<T>;
1456
+ aspects<T = unknown>(input: TwoPersonInput & {
1457
+ orbConjunction?: number;
1458
+ orbOpposition?: number;
1459
+ orbTrine?: number;
1460
+ orbSquare?: number;
1461
+ orbSextile?: number;
1462
+ compositeMethod?: string;
1463
+ houseSystem?: string;
1464
+ }, opts?: RequestOptions): Promise<T>;
1444
1465
  /** Composite (midpoint) relationship chart. */
1445
- chart<T = unknown>(input: TwoPersonInput, opts?: RequestOptions): Promise<T>;
1466
+ chart<T = unknown>(input: TwoPersonInput & {
1467
+ orbConjunction?: number;
1468
+ orbOpposition?: number;
1469
+ orbTrine?: number;
1470
+ orbSquare?: number;
1471
+ orbSextile?: number;
1472
+ rulership?: string;
1473
+ compositeMethod?: string;
1474
+ houseSystem?: string;
1475
+ }, opts?: RequestOptions): Promise<T>;
1446
1476
  /** Compute the house cusps of the Composite chart for two people — the midpoint chart combining both natal charts to represent the relationship itself. */
1447
- houses<T = unknown>(input: TwoPersonInput, opts?: RequestOptions): Promise<T>;
1477
+ houses<T = unknown>(input: TwoPersonInput & {
1478
+ rulership?: string;
1479
+ compositeMethod?: string;
1480
+ houseSystem?: string;
1481
+ }, opts?: RequestOptions): Promise<T>;
1448
1482
  /** Compute the planet placements in the Composite chart for two people — midpoint positions for all planets in the relationship chart. */
1449
- planets<T = unknown>(input: TwoPersonInput, opts?: RequestOptions): Promise<T>;
1483
+ planets<T = unknown>(input: TwoPersonInput & {
1484
+ compositeMethod?: string;
1485
+ houseSystem?: string;
1486
+ }, opts?: RequestOptions): Promise<T>;
1450
1487
  }
1451
1488
  declare class WesternDavison {
1452
1489
  private readonly _c;
1453
1490
  constructor(_c: ClientCore);
1454
1491
  /** Get aspects in the Davison relationship chart. */
1455
- aspects<T = unknown>(input: TwoPersonInput, opts?: RequestOptions): Promise<T>;
1492
+ aspects<T = unknown>(input: TwoPersonInput & {
1493
+ orbConjunction?: number;
1494
+ orbOpposition?: number;
1495
+ orbTrine?: number;
1496
+ orbSquare?: number;
1497
+ orbSextile?: number;
1498
+ houseSystem?: string;
1499
+ }, opts?: RequestOptions): Promise<T>;
1456
1500
  /** Compute the Davison relationship chart — an alternative to the composite chart that uses the midpoint of the two birth times rather than midpoint longitudes. */
1457
- chart<T = unknown>(input: TwoPersonInput, opts?: RequestOptions): Promise<T>;
1501
+ chart<T = unknown>(input: TwoPersonInput & {
1502
+ orbConjunction?: number;
1503
+ orbOpposition?: number;
1504
+ orbTrine?: number;
1505
+ orbSquare?: number;
1506
+ orbSextile?: number;
1507
+ rulership?: string;
1508
+ houseSystem?: string;
1509
+ }, opts?: RequestOptions): Promise<T>;
1458
1510
  /** Compute the house cusps of the Davison Relationship chart — the chart for the midpoint in time and space between two people's births (an actual chart for a real moment, unlike the composite). */
1459
- houses<T = unknown>(input: TwoPersonInput, opts?: RequestOptions): Promise<T>;
1511
+ houses<T = unknown>(input: TwoPersonInput & {
1512
+ rulership?: string;
1513
+ houseSystem?: string;
1514
+ }, opts?: RequestOptions): Promise<T>;
1460
1515
  /** Compute the planet placements in the Davison Relationship chart — all planet positions in the Davison chart's tropical zodiac. */
1461
- planets<T = unknown>(input: TwoPersonInput, opts?: RequestOptions): Promise<T>;
1516
+ planets<T = unknown>(input: TwoPersonInput & {
1517
+ houseSystem?: string;
1518
+ }, opts?: RequestOptions): Promise<T>;
1462
1519
  }
1463
1520
  declare class WesternDignities {
1464
1521
  private readonly _c;
@@ -1625,11 +1682,19 @@ declare class WesternNatal {
1625
1682
  /** Antiscia (solstice points) and contra-antiscia. */
1626
1683
  antiscia<T = unknown>(input: WesternNatalInput, opts?: RequestOptions): Promise<T>;
1627
1684
  /** Compute the Western (tropical) natal Ascendant — rising sign, degree, and Midheaven in the tropical zodiac. */
1628
- ascendant<T = unknown>(input: WesternNatalInput, opts?: RequestOptions): Promise<T>;
1685
+ ascendant<T = unknown>(input: WesternNatalInput & {
1686
+ rulership?: string;
1687
+ }, opts?: RequestOptions): Promise<T>;
1629
1688
  /** Detect classical multi-planet aspect patterns in a natal chart — Grand Trine, T-Square, Grand Cross, Yod (Finger of God), Kite, Mystic Rectangle, Stellium, Grand Sextile. */
1630
1689
  aspectPatterns<T = unknown>(input: WesternNatalInput, opts?: RequestOptions): Promise<T>;
1631
1690
  /** All natal aspects with orbs and partile flags. */
1632
- aspects<T = unknown>(input: WesternNatalInput, opts?: RequestOptions): Promise<T>;
1691
+ aspects<T = unknown>(input: WesternNatalInput & {
1692
+ orbConjunction?: number;
1693
+ orbOpposition?: number;
1694
+ orbTrine?: number;
1695
+ orbSquare?: number;
1696
+ orbSextile?: number;
1697
+ }, opts?: RequestOptions): Promise<T>;
1633
1698
  /** A single asteroid by MPC number. */
1634
1699
  asteroid<T = unknown>(input: WesternNatalInput & {
1635
1700
  number: number | string;
@@ -1639,7 +1704,14 @@ declare class WesternNatal {
1639
1704
  /** Get natal positions for the centaur bodies: Pholus, Nessus, Asbolus, and Chariklo. */
1640
1705
  centaurs<T = unknown>(input: WesternNatalInput, opts?: RequestOptions): Promise<T>;
1641
1706
  /** Western (tropical) natal chart: planets, ascendant, MC, houses and aspects. */
1642
- chart<T = unknown>(input: WesternNatalInput, opts?: RequestOptions): Promise<T>;
1707
+ chart<T = unknown>(input: WesternNatalInput & {
1708
+ orbConjunction?: number;
1709
+ orbOpposition?: number;
1710
+ orbTrine?: number;
1711
+ orbSquare?: number;
1712
+ orbSextile?: number;
1713
+ rulership?: string;
1714
+ }, opts?: RequestOptions): Promise<T>;
1643
1715
  /** Classify the natal chart into one of the seven Jones planetary distribution patterns: Splash, Bundle, Locomotive, Bowl, Bucket, See-Saw, or Splay. */
1644
1716
  chartShape<T = unknown>(input: WesternNatalInput, opts?: RequestOptions): Promise<T>;
1645
1717
  /** Planetary declinations, parallels and out-of-bounds. */
@@ -1661,7 +1733,9 @@ declare class WesternNatal {
1661
1733
  harmonics?: string;
1662
1734
  }, opts?: RequestOptions): Promise<T>;
1663
1735
  /** Western tropical house cusps + Ascendant and MC. */
1664
- houses<T = unknown>(input: WesternNatalInput, opts?: RequestOptions): Promise<T>;
1736
+ houses<T = unknown>(input: WesternNatalInput & {
1737
+ rulership?: string;
1738
+ }, opts?: RequestOptions): Promise<T>;
1665
1739
  /** Get all Lilith positions: Mean Black Moon Lilith, True Black Moon Lilith, Osculating (Interpolated) Lilith, and asteroid 1181 Lilith. */
1666
1740
  lilithSet<T = unknown>(input: WesternNatalInput, opts?: RequestOptions): Promise<T>;
1667
1741
  /** A single Arabic Lot (fortune|spirit|eros|...). */
@@ -1671,7 +1745,9 @@ declare class WesternNatal {
1671
1745
  /** All Hellenistic Arabic Parts (Lots). */
1672
1746
  lots<T = unknown>(input: WesternNatalInput, opts?: RequestOptions): Promise<T>;
1673
1747
  /** Compute the Midheaven (Medium Coeli, MC) and its tropical sign for a Western birth chart — the career and public reputation point, along with its aspects to natal planets. */
1674
- mc<T = unknown>(input: WesternNatalInput, opts?: RequestOptions): Promise<T>;
1748
+ mc<T = unknown>(input: WesternNatalInput & {
1749
+ rulership?: string;
1750
+ }, opts?: RequestOptions): Promise<T>;
1675
1751
  /** All planet-pair midpoints and activations. */
1676
1752
  midpoints<T = unknown>(input: WesternNatalInput, opts?: RequestOptions): Promise<T>;
1677
1753
  /** Ebertin 90-degree dial midpoint tree. */
@@ -1743,6 +1819,11 @@ declare class WesternProgressions {
1743
1819
  /** Get secondary progressed planet aspects to natal planets — the slow symbolic evolution of the birth chart over time. */
1744
1820
  aspectsToNatal<T = unknown>(input: WesternNatalInput & {
1745
1821
  ageInYears: number;
1822
+ orbConjunction?: number;
1823
+ orbOpposition?: number;
1824
+ orbTrine?: number;
1825
+ orbSquare?: number;
1826
+ orbSextile?: number;
1746
1827
  }, opts?: RequestOptions): Promise<T>;
1747
1828
  /** Get the progressed Moon phase — shows what stage of the 29-year progressed lunation cycle you are in (new moon, crescent, first quarter, gibbous, full moon, disseminating, last quarter, balsamic). */
1748
1829
  lunation<T = unknown>(input: WesternNatalInput & {
@@ -1759,6 +1840,9 @@ declare class WesternReturns {
1759
1840
  /** Compute the Lunar Return chart — the chart for the exact moment the transiting Moon returns to its natal degree (~every 27.3 days). */
1760
1841
  lunar<T = unknown>(input: WesternNatalInput & {
1761
1842
  from: string;
1843
+ rulership?: string;
1844
+ relocateLat?: number;
1845
+ relocateLon?: number;
1762
1846
  }, opts?: RequestOptions): Promise<T>;
1763
1847
  /** Get the aspects formed between planets in the lunar return chart. */
1764
1848
  lunarAspects<T = unknown>(input: WesternNatalInput & {
@@ -1767,6 +1851,9 @@ declare class WesternReturns {
1767
1851
  /** Solar Return chart for a year. */
1768
1852
  solar<T = unknown>(input: WesternNatalInput & {
1769
1853
  returnYear: number;
1854
+ rulership?: string;
1855
+ relocateLat?: number;
1856
+ relocateLon?: number;
1770
1857
  }, opts?: RequestOptions): Promise<T>;
1771
1858
  /** Get the aspects formed between planets in the solar return chart — shows which planets are strongly configured in the return year. */
1772
1859
  solarAspects<T = unknown>(input: WesternNatalInput & {
@@ -1783,6 +1870,11 @@ declare class WesternSolarArc {
1783
1870
  /** Get solar arc directed planet aspects to natal planets — a predictive technique where all planets advance at the rate of the Sun (~1°/year). */
1784
1871
  aspectsToNatal<T = unknown>(input: WesternNatalInput & {
1785
1872
  ageInYears: number;
1873
+ orbConjunction?: number;
1874
+ orbOpposition?: number;
1875
+ orbTrine?: number;
1876
+ orbSquare?: number;
1877
+ orbSextile?: number;
1786
1878
  }, opts?: RequestOptions): Promise<T>;
1787
1879
  /** Solar Arc directed planetary positions at an age. */
1788
1880
  planets<T = unknown>(input: WesternNatalInput & {
@@ -1793,11 +1885,32 @@ declare class WesternSynastry {
1793
1885
  private readonly _c;
1794
1886
  constructor(_c: ClientCore);
1795
1887
  /** Cross-chart synastry aspects between two charts. */
1796
- aspects<T = unknown>(input: TwoPersonInput, opts?: RequestOptions): Promise<T>;
1888
+ aspects<T = unknown>(input: TwoPersonInput & {
1889
+ orbConjunction?: number;
1890
+ orbOpposition?: number;
1891
+ orbTrine?: number;
1892
+ orbSquare?: number;
1893
+ orbSextile?: number;
1894
+ houseSystem?: string;
1895
+ }, opts?: RequestOptions): Promise<T>;
1797
1896
  /** Get the full N×M synastry aspect grid between two natal charts — every planet in chart A aspecting every planet in chart B. */
1798
- grid<T = unknown>(input: TwoPersonInput, opts?: RequestOptions): Promise<T>;
1897
+ grid<T = unknown>(input: TwoPersonInput & {
1898
+ orbConjunction?: number;
1899
+ orbOpposition?: number;
1900
+ orbTrine?: number;
1901
+ orbSquare?: number;
1902
+ orbSextile?: number;
1903
+ houseSystem?: string;
1904
+ }, opts?: RequestOptions): Promise<T>;
1799
1905
  /** Synastry compatibility score and breakdown. */
1800
- score<T = unknown>(input: TwoPersonInput, opts?: RequestOptions): Promise<T>;
1906
+ score<T = unknown>(input: TwoPersonInput & {
1907
+ orbConjunction?: number;
1908
+ orbOpposition?: number;
1909
+ orbTrine?: number;
1910
+ orbSquare?: number;
1911
+ orbSextile?: number;
1912
+ houseSystem?: string;
1913
+ }, opts?: RequestOptions): Promise<T>;
1801
1914
  }
1802
1915
  declare class WesternTransits {
1803
1916
  private readonly _c;
@@ -1818,7 +1931,13 @@ declare class WesternTransits {
1818
1931
  /** Current tropical planetary positions for transit analysis. */
1819
1932
  positions<T = unknown>(input: WesternMomentInput, opts?: RequestOptions): Promise<T>;
1820
1933
  /** All current transiting aspects to natal planets. */
1821
- toNatal<T = unknown>(input: NatalTransitInput & VedicMomentSettings, opts?: RequestOptions): Promise<T>;
1934
+ toNatal<T = unknown>(input: NatalTransitInput & VedicMomentSettings & {
1935
+ orbConjunction?: number;
1936
+ orbOpposition?: number;
1937
+ orbTrine?: number;
1938
+ orbSquare?: number;
1939
+ orbSextile?: number;
1940
+ }, opts?: RequestOptions): Promise<T>;
1822
1941
  }
1823
1942
  declare class WesternZodiacalReleasing {
1824
1943
  private readonly _c;
@@ -1912,7 +2031,7 @@ declare class Resources {
1912
2031
  */
1913
2032
 
1914
2033
  /** SDK version, surfaced in the User-Agent header. */
1915
- declare const VERSION = "0.2.0";
2034
+ declare const VERSION = "0.9.0";
1916
2035
  interface LifeAstroOptions {
1917
2036
  /**
1918
2037
  * API key (`dv_live_...`). Falls back to the `LIFEASTRO_API_KEY` environment