@roxyapi/sdk 1.2.29 → 1.2.31
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/AGENTS.md +2 -0
- package/README.md +2 -0
- package/dist/factory.cjs +221 -5
- package/dist/factory.js +219 -5
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/sdk.gen.d.ts +91 -5
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/types.gen.d.ts +4789 -1339
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/docs/llms-full.txt +961 -383
- package/package.json +1 -1
- package/src/index.ts +2 -2
- package/src/sdk.gen.ts +232 -5
- package/src/types.gen.ts +4708 -1193
- package/src/version.ts +1 -1
package/AGENTS.md
CHANGED
|
@@ -45,6 +45,8 @@ Type `roxy.` to see all available namespaces. Type `roxy.{domain}.` to see every
|
|
|
45
45
|
| `roxy.vedicAstrology` | 43 | Production-grade Vedic (Jyotish) and KP astrology API + remote MCP for AI agents and developers |
|
|
46
46
|
| `roxy.numerology` | 16 | Production-ready Pythagorean numerology API + hosted MCP for AI agents and developers |
|
|
47
47
|
| `roxy.tarot` | 10 | Production-ready tarot card reading API + hosted MCP for AI agents and developers |
|
|
48
|
+
| `roxy.humanDesign` | 10 | Generate the full Human Design bodygraph from a birth moment: type, strategy, inner authority, profile, definition, i... |
|
|
49
|
+
| `roxy.forecast` | 3 | Merge upcoming transit aspects, sign ingresses, retrograde stations, Vimshottari dasha changes, and biorhythm critica... |
|
|
48
50
|
| `roxy.biorhythm` | 6 | The most complete biorhythm API + remote MCP for AI agents and developers |
|
|
49
51
|
| `roxy.iching` | 9 | I-Ching oracle API + hosted MCP for AI agents and developers |
|
|
50
52
|
| `roxy.crystals` | 12 | Production-ready crystal healing API + hosted MCP for AI agents and developers |
|
package/README.md
CHANGED
|
@@ -89,6 +89,8 @@ const { latitude, longitude, timezone } = data.cities[0];
|
|
|
89
89
|
| `roxy.vedicAstrology` | 43 | Production-grade Vedic (Jyotish) and KP astrology API + remote MCP for AI agents and developers |
|
|
90
90
|
| `roxy.numerology` | 16 | Production-ready Pythagorean numerology API + hosted MCP for AI agents and developers |
|
|
91
91
|
| `roxy.tarot` | 10 | Production-ready tarot card reading API + hosted MCP for AI agents and developers |
|
|
92
|
+
| `roxy.humanDesign` | 10 | Generate the full Human Design bodygraph from a birth moment: type, strategy, inner authority, profile, definition, i... |
|
|
93
|
+
| `roxy.forecast` | 3 | Merge upcoming transit aspects, sign ingresses, retrograde stations, Vimshottari dasha changes, and biorhythm critica... |
|
|
92
94
|
| `roxy.biorhythm` | 6 | The most complete biorhythm API + remote MCP for AI agents and developers |
|
|
93
95
|
| `roxy.iching` | 9 | I-Ching oracle API + hosted MCP for AI agents and developers |
|
|
94
96
|
| `roxy.crystals` | 12 | Production-ready crystal healing API + hosted MCP for AI agents and developers |
|
package/dist/factory.cjs
CHANGED
|
@@ -25,6 +25,8 @@ __export(factory_exports, {
|
|
|
25
25
|
Biorhythm: () => Biorhythm,
|
|
26
26
|
Crystals: () => Crystals,
|
|
27
27
|
Dreams: () => Dreams,
|
|
28
|
+
Forecast: () => Forecast,
|
|
29
|
+
HumanDesign: () => HumanDesign,
|
|
28
30
|
Iching: () => Iching,
|
|
29
31
|
Languages: () => Languages,
|
|
30
32
|
Location: () => Location,
|
|
@@ -891,7 +893,7 @@ var Astrology = class extends HeyApiClient {
|
|
|
891
893
|
/**
|
|
892
894
|
* Get all planet meanings - Complete astrology planet interpretations list
|
|
893
895
|
*
|
|
894
|
-
* Returns all 14 astrological bodies (the 10 classical planets Sun through Pluto, the lunar nodes, Chiron, and Black Moon Lilith) with essential meanings: name, symbol, tagline, category (personal/social/generational), ruling sign, and short descriptions. Perfect for astrology reference apps, planet meaning widgets, birth chart interpretation tools, astrology learning platforms, planetary keywords reference, and zodiac planet guides. Use GET /planet-meanings/{id} for complete profiles with detailed interpretations, keywords, temperature, and dignities (rulership/detriment/
|
|
896
|
+
* Returns all 14 astrological bodies (the 10 classical planets Sun through Pluto, the lunar nodes, Chiron, and Black Moon Lilith) with essential meanings: name, symbol, tagline, category (personal/social/generational), ruling sign, and short descriptions. Perfect for astrology reference apps, planet meaning widgets, birth chart interpretation tools, astrology learning platforms, planetary keywords reference, and zodiac planet guides. Use GET /planet-meanings/{id} for complete profiles with detailed interpretations, keywords, temperature, and dignities (rulership/detriment/exaltation/fall).
|
|
895
897
|
*/
|
|
896
898
|
listPlanetMeanings(options) {
|
|
897
899
|
return (options?.client ?? this.client).get({
|
|
@@ -903,7 +905,7 @@ var Astrology = class extends HeyApiClient {
|
|
|
903
905
|
/**
|
|
904
906
|
* Get planet meaning details - Complete astrology planet interpretation
|
|
905
907
|
*
|
|
906
|
-
* Retrieve comprehensive planet interpretation for any astrological planet using lowercase ID (e.g., "sun", "moon") or case-insensitive name (e.g., "Sun", "MOON"). Returns complete astrology meaning including: symbol, tagline, category (personal/social/generational), temperature, orbital period, retrograde status, dignities (rulership/detriment/
|
|
908
|
+
* Retrieve comprehensive planet interpretation for any astrological planet using lowercase ID (e.g., "sun", "moon") or case-insensitive name (e.g., "Sun", "MOON"). Returns complete astrology meaning including: symbol, tagline, category (personal/social/generational), temperature, orbital period, retrograde status, dignities (rulership/detriment/exaltation/fall), positive and negative keywords, and short/long descriptions. Perfect for birth chart readings, planet meaning lookups, astrology education, natal chart interpretation, transit meanings, planetary symbolism reference, and keyword-based interpretations.
|
|
907
909
|
*/
|
|
908
910
|
getPlanetMeaning(options) {
|
|
909
911
|
return (options.client ?? this.client).get({
|
|
@@ -1079,7 +1081,7 @@ var Astrology = class extends HeyApiClient {
|
|
|
1079
1081
|
/**
|
|
1080
1082
|
* Solar Return Chart - Annual birthday forecast with relocated chart
|
|
1081
1083
|
*
|
|
1082
|
-
* Generate a solar return chart for any year
|
|
1084
|
+
* Generate a solar return chart for any year, the foundational technique for annual astrological forecasting. The chart is cast for the exact moment the transiting Sun returns to its natal ecliptic longitude (your astrological birthday). Returns full tropical zodiac chart with planetary positions, house cusps, aspects, Ascendant, and Midheaven. Location-sensitive: relocating your solar return chart to a different city changes the houses and Ascendant. Solar return chart API, annual horoscope forecast, birthday chart calculator, yearly astrology prediction, relocated solar return.
|
|
1083
1085
|
*/
|
|
1084
1086
|
generateSolarReturn(options) {
|
|
1085
1087
|
return (options?.client ?? this.client).post({
|
|
@@ -1095,7 +1097,7 @@ var Astrology = class extends HeyApiClient {
|
|
|
1095
1097
|
/**
|
|
1096
1098
|
* Lunar Return Chart - Monthly emotional forecast with Moon cycle chart
|
|
1097
1099
|
*
|
|
1098
|
-
* Generate a lunar return chart for any month
|
|
1100
|
+
* Generate a lunar return chart for any month, cast for the exact moment the transiting Moon returns to its natal ecliptic longitude. The Moon completes one sidereal orbit every ~27.3 days, making this the primary technique for monthly astrological forecasting. Returns full tropical zodiac chart with planetary positions, house cusps, aspects, Ascendant, and Midheaven. Reveals emotional patterns, domestic focus, and intuitive themes for the coming month. Lunar return chart API, monthly horoscope forecast, Moon cycle chart, emotional astrology prediction.
|
|
1099
1101
|
*/
|
|
1100
1102
|
generateLunarReturn(options) {
|
|
1101
1103
|
return (options?.client ?? this.client).post({
|
|
@@ -2263,6 +2265,210 @@ var Tarot = class extends HeyApiClient {
|
|
|
2263
2265
|
});
|
|
2264
2266
|
}
|
|
2265
2267
|
};
|
|
2268
|
+
var HumanDesign = class extends HeyApiClient {
|
|
2269
|
+
/**
|
|
2270
|
+
* Generate full Human Design bodygraph - Type, authority, profile, centers, channels, gates
|
|
2271
|
+
*
|
|
2272
|
+
* Generate a complete Human Design bodygraph from a birth date, time, and timezone. Returns the energy type, strategy, inner authority, signature, not-self theme, profile, definition, incarnation cross, all nine centers with defined state and active gates, the defined channels, and all 26 planetary activations across the Personality and Design sides. The single endpoint for a full chart in one call, built for Human Design apps, readings, and coaching tools.
|
|
2273
|
+
*/
|
|
2274
|
+
generateBodygraph(options) {
|
|
2275
|
+
return (options?.client ?? this.client).post({
|
|
2276
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2277
|
+
url: "/human-design/bodygraph",
|
|
2278
|
+
...options,
|
|
2279
|
+
headers: {
|
|
2280
|
+
"Content-Type": "application/json",
|
|
2281
|
+
...options?.headers
|
|
2282
|
+
}
|
|
2283
|
+
});
|
|
2284
|
+
}
|
|
2285
|
+
/**
|
|
2286
|
+
* Calculate Human Design connection chart - Two-person composite bodygraph compatibility
|
|
2287
|
+
*
|
|
2288
|
+
* Calculate a Human Design connection chart by overlaying two bodygraphs. For each of the 36 channels the dynamic between the two people is classified as electromagnetic, dominance, compromise, or companionship, the four mechanics of how two designs meet. Also returns the nine centers as defined or open in the combined bodygraph with which person defines each, the combined definition, and a count of each dynamic. Built for relationship, dating, and coaching tools.
|
|
2289
|
+
*/
|
|
2290
|
+
calculateConnection(options) {
|
|
2291
|
+
return (options?.client ?? this.client).post({
|
|
2292
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2293
|
+
url: "/human-design/connection",
|
|
2294
|
+
...options,
|
|
2295
|
+
headers: {
|
|
2296
|
+
"Content-Type": "application/json",
|
|
2297
|
+
...options?.headers
|
|
2298
|
+
}
|
|
2299
|
+
});
|
|
2300
|
+
}
|
|
2301
|
+
/**
|
|
2302
|
+
* Generate Human Design transit overlay - Current planetary activations on a natal bodygraph
|
|
2303
|
+
*
|
|
2304
|
+
* Overlay the current or any given planetary positions on a natal Human Design bodygraph to see which channels the transit temporarily completes. Returns the 13 transiting body activations with gate and line, the channels the transit completes beyond the natal definition split into personal channels where the transit supplies the partner gate of a natal gate and educational channels where the transit supplies both gates, the natally open centers those channels temporarily define, and a short factual summary. A transit is a single moment, so there is no Design side. When date and time are omitted the overlay is computed for now in UTC. Built for daily Human Design apps, transit widgets, and notification tools.
|
|
2305
|
+
*/
|
|
2306
|
+
generateTransit(options) {
|
|
2307
|
+
return (options?.client ?? this.client).post({
|
|
2308
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2309
|
+
url: "/human-design/transit",
|
|
2310
|
+
...options,
|
|
2311
|
+
headers: {
|
|
2312
|
+
"Content-Type": "application/json",
|
|
2313
|
+
...options?.headers
|
|
2314
|
+
}
|
|
2315
|
+
});
|
|
2316
|
+
}
|
|
2317
|
+
/**
|
|
2318
|
+
* Calculate Human Design type, authority and profile
|
|
2319
|
+
*
|
|
2320
|
+
* Calculate the core Human Design identity from a birth moment: the energy type, the aura strategy, the inner authority, the signature and not-self themes, and the profile. The fast lookup for type-and-authority features without the full bodygraph payload. Verified against NASA JPL Horizons positions.
|
|
2321
|
+
*/
|
|
2322
|
+
calculateType(options) {
|
|
2323
|
+
return (options?.client ?? this.client).post({
|
|
2324
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2325
|
+
url: "/human-design/type",
|
|
2326
|
+
...options,
|
|
2327
|
+
headers: {
|
|
2328
|
+
"Content-Type": "application/json",
|
|
2329
|
+
...options?.headers
|
|
2330
|
+
}
|
|
2331
|
+
});
|
|
2332
|
+
}
|
|
2333
|
+
/**
|
|
2334
|
+
* Calculate the 26 Human Design gate activations
|
|
2335
|
+
*
|
|
2336
|
+
* Calculate the 26 gate activations for a birth moment, split into the 13 conscious Personality activations at birth and the 13 unconscious Design activations 88 degrees of solar arc earlier. Each activation reports the planet, gate, line, gate keynote, and the matching I-Ching hexagram. Built for activation columns and detailed chart views.
|
|
2337
|
+
*/
|
|
2338
|
+
calculateGates(options) {
|
|
2339
|
+
return (options?.client ?? this.client).post({
|
|
2340
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2341
|
+
url: "/human-design/gates",
|
|
2342
|
+
...options,
|
|
2343
|
+
headers: {
|
|
2344
|
+
"Content-Type": "application/json",
|
|
2345
|
+
...options?.headers
|
|
2346
|
+
}
|
|
2347
|
+
});
|
|
2348
|
+
}
|
|
2349
|
+
/**
|
|
2350
|
+
* Look up a Human Design gate by number
|
|
2351
|
+
*
|
|
2352
|
+
* Look up the static reference data for a Human Design gate by its number from 1 to 64: the gate keynote name, the center it sits in, the matching I-Ching hexagram, and the gates that form a channel with it. A pure reference endpoint with no birth data required.
|
|
2353
|
+
*/
|
|
2354
|
+
getGate(options) {
|
|
2355
|
+
return (options?.client ?? this.client).get({
|
|
2356
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2357
|
+
url: "/human-design/gates/{number}",
|
|
2358
|
+
...options
|
|
2359
|
+
});
|
|
2360
|
+
}
|
|
2361
|
+
/**
|
|
2362
|
+
* Calculate the defined Human Design channels
|
|
2363
|
+
*
|
|
2364
|
+
* Calculate the defined channels for a birth moment. A channel is defined when both of its gates are activated, and it wires together the two centers it connects. Returns each defined channel with its gates, name, circuit family, and connected centers, plus the full set of centers those channels define. Built for bodygraph rendering and definition analysis.
|
|
2365
|
+
*/
|
|
2366
|
+
calculateChannels(options) {
|
|
2367
|
+
return (options?.client ?? this.client).post({
|
|
2368
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2369
|
+
url: "/human-design/channels",
|
|
2370
|
+
...options,
|
|
2371
|
+
headers: {
|
|
2372
|
+
"Content-Type": "application/json",
|
|
2373
|
+
...options?.headers
|
|
2374
|
+
}
|
|
2375
|
+
});
|
|
2376
|
+
}
|
|
2377
|
+
/**
|
|
2378
|
+
* Calculate the nine Human Design centers
|
|
2379
|
+
*
|
|
2380
|
+
* Calculate the state of all nine Human Design centers for a birth moment: whether each is defined or open, whether it is a motor or an awareness center, its theme, and the active gates it holds. The data layer behind a rendered bodygraph where defined centers are colored and open centers are white.
|
|
2381
|
+
*/
|
|
2382
|
+
calculateCenters(options) {
|
|
2383
|
+
return (options?.client ?? this.client).post({
|
|
2384
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2385
|
+
url: "/human-design/centers",
|
|
2386
|
+
...options,
|
|
2387
|
+
headers: {
|
|
2388
|
+
"Content-Type": "application/json",
|
|
2389
|
+
...options?.headers
|
|
2390
|
+
}
|
|
2391
|
+
});
|
|
2392
|
+
}
|
|
2393
|
+
/**
|
|
2394
|
+
* Look up a Human Design center by id
|
|
2395
|
+
*
|
|
2396
|
+
* Look up the static reference data for one of the nine Human Design centers by its id: the display name, whether it is a motor or awareness center, and what it means both defined and undefined. A pure reference endpoint with no birth data required.
|
|
2397
|
+
*/
|
|
2398
|
+
getCenter(options) {
|
|
2399
|
+
return (options.client ?? this.client).get({
|
|
2400
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2401
|
+
url: "/human-design/centers/{id}",
|
|
2402
|
+
...options
|
|
2403
|
+
});
|
|
2404
|
+
}
|
|
2405
|
+
/**
|
|
2406
|
+
* Calculate the Human Design profile and line keynotes
|
|
2407
|
+
*
|
|
2408
|
+
* Calculate the Human Design profile for a birth moment: the conscious Personality Sun line over the unconscious Design Sun line, with the keynote for each. The profile is the geometry of the life role, for example 5/1 the Heretic Investigator. Verified against NASA JPL Horizons positions.
|
|
2409
|
+
*/
|
|
2410
|
+
calculateProfile(options) {
|
|
2411
|
+
return (options?.client ?? this.client).post({
|
|
2412
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2413
|
+
url: "/human-design/profile",
|
|
2414
|
+
...options,
|
|
2415
|
+
headers: {
|
|
2416
|
+
"Content-Type": "application/json",
|
|
2417
|
+
...options?.headers
|
|
2418
|
+
}
|
|
2419
|
+
});
|
|
2420
|
+
}
|
|
2421
|
+
};
|
|
2422
|
+
var Forecast = class extends HeyApiClient {
|
|
2423
|
+
/**
|
|
2424
|
+
* Cross-domain forecast timeline - Transits, ingresses, stations, dasha changes, critical days
|
|
2425
|
+
*
|
|
2426
|
+
* Build one time-ordered forecast for a single birth subject by merging upcoming events across three domains: western transit-to-natal aspects, sign ingresses, and retrograde stations; vedic Vimshottari mahadasha and antardasha boundaries; and biorhythm critical days. The window is clamped to 90 days and events are capped and scored by significance. Built for what-is-coming dashboards, daily and weekly forecast feeds, and timing tools.
|
|
2427
|
+
*/
|
|
2428
|
+
generateTimeline(options) {
|
|
2429
|
+
return (options?.client ?? this.client).post({
|
|
2430
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2431
|
+
url: "/forecast/timeline",
|
|
2432
|
+
...options,
|
|
2433
|
+
headers: {
|
|
2434
|
+
"Content-Type": "application/json",
|
|
2435
|
+
...options?.headers
|
|
2436
|
+
}
|
|
2437
|
+
});
|
|
2438
|
+
}
|
|
2439
|
+
/**
|
|
2440
|
+
* Western transit forecast - Transit aspects, sign ingresses, retrograde stations
|
|
2441
|
+
*
|
|
2442
|
+
* Forecast the western astrology events for a single birth chart over a window up to 90 days: every transit-to-natal major aspect refined to its exact instant, every transiting planet sign ingress, and every retrograde or direct station. Returns a time-ordered, significance-scored timeline. Built for astrology forecast feeds, transit alerts, and timing tools.
|
|
2443
|
+
*/
|
|
2444
|
+
forecastTransits(options) {
|
|
2445
|
+
return (options?.client ?? this.client).post({
|
|
2446
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2447
|
+
url: "/forecast/transits",
|
|
2448
|
+
...options,
|
|
2449
|
+
headers: {
|
|
2450
|
+
"Content-Type": "application/json",
|
|
2451
|
+
...options?.headers
|
|
2452
|
+
}
|
|
2453
|
+
});
|
|
2454
|
+
}
|
|
2455
|
+
/**
|
|
2456
|
+
* Significant dates - High-significance cross-domain forecast highlights
|
|
2457
|
+
*
|
|
2458
|
+
* Return only the high-significance dates from the merged cross-domain forecast for a single birth subject: the rare outer-planet exact transit aspects, slow-planet sign ingresses, retrograde stations, and Vimshottari mahadasha and antardasha changes that mark genuine turning points. Defaults to a significance floor of 70 so the response is a short list of the most meaningful upcoming dates. Built for what-is-coming highlights, timing alerts, and at-a-glance forecast strips.
|
|
2459
|
+
*/
|
|
2460
|
+
findSignificantDates(options) {
|
|
2461
|
+
return (options?.client ?? this.client).post({
|
|
2462
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
2463
|
+
url: "/forecast/significant-dates",
|
|
2464
|
+
...options,
|
|
2465
|
+
headers: {
|
|
2466
|
+
"Content-Type": "application/json",
|
|
2467
|
+
...options?.headers
|
|
2468
|
+
}
|
|
2469
|
+
});
|
|
2470
|
+
}
|
|
2471
|
+
};
|
|
2266
2472
|
var Biorhythm = class extends HeyApiClient {
|
|
2267
2473
|
/**
|
|
2268
2474
|
* Get biorhythm reading - Complete cycle analysis for any date
|
|
@@ -2837,6 +3043,14 @@ var Roxy = class _Roxy extends HeyApiClient {
|
|
|
2837
3043
|
get tarot() {
|
|
2838
3044
|
return this._tarot ??= new Tarot({ client: this.client });
|
|
2839
3045
|
}
|
|
3046
|
+
_humanDesign;
|
|
3047
|
+
get humanDesign() {
|
|
3048
|
+
return this._humanDesign ??= new HumanDesign({ client: this.client });
|
|
3049
|
+
}
|
|
3050
|
+
_forecast;
|
|
3051
|
+
get forecast() {
|
|
3052
|
+
return this._forecast ??= new Forecast({ client: this.client });
|
|
3053
|
+
}
|
|
2840
3054
|
_biorhythm;
|
|
2841
3055
|
get biorhythm() {
|
|
2842
3056
|
return this._biorhythm ??= new Biorhythm({ client: this.client });
|
|
@@ -2872,7 +3086,7 @@ var Roxy = class _Roxy extends HeyApiClient {
|
|
|
2872
3086
|
};
|
|
2873
3087
|
|
|
2874
3088
|
// src/version.ts
|
|
2875
|
-
var VERSION = "1.2.
|
|
3089
|
+
var VERSION = "1.2.31";
|
|
2876
3090
|
|
|
2877
3091
|
// src/factory.ts
|
|
2878
3092
|
function createRoxy(auth) {
|
|
@@ -2894,6 +3108,8 @@ function createRoxy(auth) {
|
|
|
2894
3108
|
Biorhythm,
|
|
2895
3109
|
Crystals,
|
|
2896
3110
|
Dreams,
|
|
3111
|
+
Forecast,
|
|
3112
|
+
HumanDesign,
|
|
2897
3113
|
Iching,
|
|
2898
3114
|
Languages,
|
|
2899
3115
|
Location,
|
package/dist/factory.js
CHANGED
|
@@ -55,7 +55,7 @@ var Astrology = class extends HeyApiClient {
|
|
|
55
55
|
/**
|
|
56
56
|
* Get all planet meanings - Complete astrology planet interpretations list
|
|
57
57
|
*
|
|
58
|
-
* Returns all 14 astrological bodies (the 10 classical planets Sun through Pluto, the lunar nodes, Chiron, and Black Moon Lilith) with essential meanings: name, symbol, tagline, category (personal/social/generational), ruling sign, and short descriptions. Perfect for astrology reference apps, planet meaning widgets, birth chart interpretation tools, astrology learning platforms, planetary keywords reference, and zodiac planet guides. Use GET /planet-meanings/{id} for complete profiles with detailed interpretations, keywords, temperature, and dignities (rulership/detriment/
|
|
58
|
+
* Returns all 14 astrological bodies (the 10 classical planets Sun through Pluto, the lunar nodes, Chiron, and Black Moon Lilith) with essential meanings: name, symbol, tagline, category (personal/social/generational), ruling sign, and short descriptions. Perfect for astrology reference apps, planet meaning widgets, birth chart interpretation tools, astrology learning platforms, planetary keywords reference, and zodiac planet guides. Use GET /planet-meanings/{id} for complete profiles with detailed interpretations, keywords, temperature, and dignities (rulership/detriment/exaltation/fall).
|
|
59
59
|
*/
|
|
60
60
|
listPlanetMeanings(options) {
|
|
61
61
|
return (options?.client ?? this.client).get({
|
|
@@ -67,7 +67,7 @@ var Astrology = class extends HeyApiClient {
|
|
|
67
67
|
/**
|
|
68
68
|
* Get planet meaning details - Complete astrology planet interpretation
|
|
69
69
|
*
|
|
70
|
-
* Retrieve comprehensive planet interpretation for any astrological planet using lowercase ID (e.g., "sun", "moon") or case-insensitive name (e.g., "Sun", "MOON"). Returns complete astrology meaning including: symbol, tagline, category (personal/social/generational), temperature, orbital period, retrograde status, dignities (rulership/detriment/
|
|
70
|
+
* Retrieve comprehensive planet interpretation for any astrological planet using lowercase ID (e.g., "sun", "moon") or case-insensitive name (e.g., "Sun", "MOON"). Returns complete astrology meaning including: symbol, tagline, category (personal/social/generational), temperature, orbital period, retrograde status, dignities (rulership/detriment/exaltation/fall), positive and negative keywords, and short/long descriptions. Perfect for birth chart readings, planet meaning lookups, astrology education, natal chart interpretation, transit meanings, planetary symbolism reference, and keyword-based interpretations.
|
|
71
71
|
*/
|
|
72
72
|
getPlanetMeaning(options) {
|
|
73
73
|
return (options.client ?? this.client).get({
|
|
@@ -243,7 +243,7 @@ var Astrology = class extends HeyApiClient {
|
|
|
243
243
|
/**
|
|
244
244
|
* Solar Return Chart - Annual birthday forecast with relocated chart
|
|
245
245
|
*
|
|
246
|
-
* Generate a solar return chart for any year
|
|
246
|
+
* Generate a solar return chart for any year, the foundational technique for annual astrological forecasting. The chart is cast for the exact moment the transiting Sun returns to its natal ecliptic longitude (your astrological birthday). Returns full tropical zodiac chart with planetary positions, house cusps, aspects, Ascendant, and Midheaven. Location-sensitive: relocating your solar return chart to a different city changes the houses and Ascendant. Solar return chart API, annual horoscope forecast, birthday chart calculator, yearly astrology prediction, relocated solar return.
|
|
247
247
|
*/
|
|
248
248
|
generateSolarReturn(options) {
|
|
249
249
|
return (options?.client ?? this.client).post({
|
|
@@ -259,7 +259,7 @@ var Astrology = class extends HeyApiClient {
|
|
|
259
259
|
/**
|
|
260
260
|
* Lunar Return Chart - Monthly emotional forecast with Moon cycle chart
|
|
261
261
|
*
|
|
262
|
-
* Generate a lunar return chart for any month
|
|
262
|
+
* Generate a lunar return chart for any month, cast for the exact moment the transiting Moon returns to its natal ecliptic longitude. The Moon completes one sidereal orbit every ~27.3 days, making this the primary technique for monthly astrological forecasting. Returns full tropical zodiac chart with planetary positions, house cusps, aspects, Ascendant, and Midheaven. Reveals emotional patterns, domestic focus, and intuitive themes for the coming month. Lunar return chart API, monthly horoscope forecast, Moon cycle chart, emotional astrology prediction.
|
|
263
263
|
*/
|
|
264
264
|
generateLunarReturn(options) {
|
|
265
265
|
return (options?.client ?? this.client).post({
|
|
@@ -1427,6 +1427,210 @@ var Tarot = class extends HeyApiClient {
|
|
|
1427
1427
|
});
|
|
1428
1428
|
}
|
|
1429
1429
|
};
|
|
1430
|
+
var HumanDesign = class extends HeyApiClient {
|
|
1431
|
+
/**
|
|
1432
|
+
* Generate full Human Design bodygraph - Type, authority, profile, centers, channels, gates
|
|
1433
|
+
*
|
|
1434
|
+
* Generate a complete Human Design bodygraph from a birth date, time, and timezone. Returns the energy type, strategy, inner authority, signature, not-self theme, profile, definition, incarnation cross, all nine centers with defined state and active gates, the defined channels, and all 26 planetary activations across the Personality and Design sides. The single endpoint for a full chart in one call, built for Human Design apps, readings, and coaching tools.
|
|
1435
|
+
*/
|
|
1436
|
+
generateBodygraph(options) {
|
|
1437
|
+
return (options?.client ?? this.client).post({
|
|
1438
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
1439
|
+
url: "/human-design/bodygraph",
|
|
1440
|
+
...options,
|
|
1441
|
+
headers: {
|
|
1442
|
+
"Content-Type": "application/json",
|
|
1443
|
+
...options?.headers
|
|
1444
|
+
}
|
|
1445
|
+
});
|
|
1446
|
+
}
|
|
1447
|
+
/**
|
|
1448
|
+
* Calculate Human Design connection chart - Two-person composite bodygraph compatibility
|
|
1449
|
+
*
|
|
1450
|
+
* Calculate a Human Design connection chart by overlaying two bodygraphs. For each of the 36 channels the dynamic between the two people is classified as electromagnetic, dominance, compromise, or companionship, the four mechanics of how two designs meet. Also returns the nine centers as defined or open in the combined bodygraph with which person defines each, the combined definition, and a count of each dynamic. Built for relationship, dating, and coaching tools.
|
|
1451
|
+
*/
|
|
1452
|
+
calculateConnection(options) {
|
|
1453
|
+
return (options?.client ?? this.client).post({
|
|
1454
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
1455
|
+
url: "/human-design/connection",
|
|
1456
|
+
...options,
|
|
1457
|
+
headers: {
|
|
1458
|
+
"Content-Type": "application/json",
|
|
1459
|
+
...options?.headers
|
|
1460
|
+
}
|
|
1461
|
+
});
|
|
1462
|
+
}
|
|
1463
|
+
/**
|
|
1464
|
+
* Generate Human Design transit overlay - Current planetary activations on a natal bodygraph
|
|
1465
|
+
*
|
|
1466
|
+
* Overlay the current or any given planetary positions on a natal Human Design bodygraph to see which channels the transit temporarily completes. Returns the 13 transiting body activations with gate and line, the channels the transit completes beyond the natal definition split into personal channels where the transit supplies the partner gate of a natal gate and educational channels where the transit supplies both gates, the natally open centers those channels temporarily define, and a short factual summary. A transit is a single moment, so there is no Design side. When date and time are omitted the overlay is computed for now in UTC. Built for daily Human Design apps, transit widgets, and notification tools.
|
|
1467
|
+
*/
|
|
1468
|
+
generateTransit(options) {
|
|
1469
|
+
return (options?.client ?? this.client).post({
|
|
1470
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
1471
|
+
url: "/human-design/transit",
|
|
1472
|
+
...options,
|
|
1473
|
+
headers: {
|
|
1474
|
+
"Content-Type": "application/json",
|
|
1475
|
+
...options?.headers
|
|
1476
|
+
}
|
|
1477
|
+
});
|
|
1478
|
+
}
|
|
1479
|
+
/**
|
|
1480
|
+
* Calculate Human Design type, authority and profile
|
|
1481
|
+
*
|
|
1482
|
+
* Calculate the core Human Design identity from a birth moment: the energy type, the aura strategy, the inner authority, the signature and not-self themes, and the profile. The fast lookup for type-and-authority features without the full bodygraph payload. Verified against NASA JPL Horizons positions.
|
|
1483
|
+
*/
|
|
1484
|
+
calculateType(options) {
|
|
1485
|
+
return (options?.client ?? this.client).post({
|
|
1486
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
1487
|
+
url: "/human-design/type",
|
|
1488
|
+
...options,
|
|
1489
|
+
headers: {
|
|
1490
|
+
"Content-Type": "application/json",
|
|
1491
|
+
...options?.headers
|
|
1492
|
+
}
|
|
1493
|
+
});
|
|
1494
|
+
}
|
|
1495
|
+
/**
|
|
1496
|
+
* Calculate the 26 Human Design gate activations
|
|
1497
|
+
*
|
|
1498
|
+
* Calculate the 26 gate activations for a birth moment, split into the 13 conscious Personality activations at birth and the 13 unconscious Design activations 88 degrees of solar arc earlier. Each activation reports the planet, gate, line, gate keynote, and the matching I-Ching hexagram. Built for activation columns and detailed chart views.
|
|
1499
|
+
*/
|
|
1500
|
+
calculateGates(options) {
|
|
1501
|
+
return (options?.client ?? this.client).post({
|
|
1502
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
1503
|
+
url: "/human-design/gates",
|
|
1504
|
+
...options,
|
|
1505
|
+
headers: {
|
|
1506
|
+
"Content-Type": "application/json",
|
|
1507
|
+
...options?.headers
|
|
1508
|
+
}
|
|
1509
|
+
});
|
|
1510
|
+
}
|
|
1511
|
+
/**
|
|
1512
|
+
* Look up a Human Design gate by number
|
|
1513
|
+
*
|
|
1514
|
+
* Look up the static reference data for a Human Design gate by its number from 1 to 64: the gate keynote name, the center it sits in, the matching I-Ching hexagram, and the gates that form a channel with it. A pure reference endpoint with no birth data required.
|
|
1515
|
+
*/
|
|
1516
|
+
getGate(options) {
|
|
1517
|
+
return (options?.client ?? this.client).get({
|
|
1518
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
1519
|
+
url: "/human-design/gates/{number}",
|
|
1520
|
+
...options
|
|
1521
|
+
});
|
|
1522
|
+
}
|
|
1523
|
+
/**
|
|
1524
|
+
* Calculate the defined Human Design channels
|
|
1525
|
+
*
|
|
1526
|
+
* Calculate the defined channels for a birth moment. A channel is defined when both of its gates are activated, and it wires together the two centers it connects. Returns each defined channel with its gates, name, circuit family, and connected centers, plus the full set of centers those channels define. Built for bodygraph rendering and definition analysis.
|
|
1527
|
+
*/
|
|
1528
|
+
calculateChannels(options) {
|
|
1529
|
+
return (options?.client ?? this.client).post({
|
|
1530
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
1531
|
+
url: "/human-design/channels",
|
|
1532
|
+
...options,
|
|
1533
|
+
headers: {
|
|
1534
|
+
"Content-Type": "application/json",
|
|
1535
|
+
...options?.headers
|
|
1536
|
+
}
|
|
1537
|
+
});
|
|
1538
|
+
}
|
|
1539
|
+
/**
|
|
1540
|
+
* Calculate the nine Human Design centers
|
|
1541
|
+
*
|
|
1542
|
+
* Calculate the state of all nine Human Design centers for a birth moment: whether each is defined or open, whether it is a motor or an awareness center, its theme, and the active gates it holds. The data layer behind a rendered bodygraph where defined centers are colored and open centers are white.
|
|
1543
|
+
*/
|
|
1544
|
+
calculateCenters(options) {
|
|
1545
|
+
return (options?.client ?? this.client).post({
|
|
1546
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
1547
|
+
url: "/human-design/centers",
|
|
1548
|
+
...options,
|
|
1549
|
+
headers: {
|
|
1550
|
+
"Content-Type": "application/json",
|
|
1551
|
+
...options?.headers
|
|
1552
|
+
}
|
|
1553
|
+
});
|
|
1554
|
+
}
|
|
1555
|
+
/**
|
|
1556
|
+
* Look up a Human Design center by id
|
|
1557
|
+
*
|
|
1558
|
+
* Look up the static reference data for one of the nine Human Design centers by its id: the display name, whether it is a motor or awareness center, and what it means both defined and undefined. A pure reference endpoint with no birth data required.
|
|
1559
|
+
*/
|
|
1560
|
+
getCenter(options) {
|
|
1561
|
+
return (options.client ?? this.client).get({
|
|
1562
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
1563
|
+
url: "/human-design/centers/{id}",
|
|
1564
|
+
...options
|
|
1565
|
+
});
|
|
1566
|
+
}
|
|
1567
|
+
/**
|
|
1568
|
+
* Calculate the Human Design profile and line keynotes
|
|
1569
|
+
*
|
|
1570
|
+
* Calculate the Human Design profile for a birth moment: the conscious Personality Sun line over the unconscious Design Sun line, with the keynote for each. The profile is the geometry of the life role, for example 5/1 the Heretic Investigator. Verified against NASA JPL Horizons positions.
|
|
1571
|
+
*/
|
|
1572
|
+
calculateProfile(options) {
|
|
1573
|
+
return (options?.client ?? this.client).post({
|
|
1574
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
1575
|
+
url: "/human-design/profile",
|
|
1576
|
+
...options,
|
|
1577
|
+
headers: {
|
|
1578
|
+
"Content-Type": "application/json",
|
|
1579
|
+
...options?.headers
|
|
1580
|
+
}
|
|
1581
|
+
});
|
|
1582
|
+
}
|
|
1583
|
+
};
|
|
1584
|
+
var Forecast = class extends HeyApiClient {
|
|
1585
|
+
/**
|
|
1586
|
+
* Cross-domain forecast timeline - Transits, ingresses, stations, dasha changes, critical days
|
|
1587
|
+
*
|
|
1588
|
+
* Build one time-ordered forecast for a single birth subject by merging upcoming events across three domains: western transit-to-natal aspects, sign ingresses, and retrograde stations; vedic Vimshottari mahadasha and antardasha boundaries; and biorhythm critical days. The window is clamped to 90 days and events are capped and scored by significance. Built for what-is-coming dashboards, daily and weekly forecast feeds, and timing tools.
|
|
1589
|
+
*/
|
|
1590
|
+
generateTimeline(options) {
|
|
1591
|
+
return (options?.client ?? this.client).post({
|
|
1592
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
1593
|
+
url: "/forecast/timeline",
|
|
1594
|
+
...options,
|
|
1595
|
+
headers: {
|
|
1596
|
+
"Content-Type": "application/json",
|
|
1597
|
+
...options?.headers
|
|
1598
|
+
}
|
|
1599
|
+
});
|
|
1600
|
+
}
|
|
1601
|
+
/**
|
|
1602
|
+
* Western transit forecast - Transit aspects, sign ingresses, retrograde stations
|
|
1603
|
+
*
|
|
1604
|
+
* Forecast the western astrology events for a single birth chart over a window up to 90 days: every transit-to-natal major aspect refined to its exact instant, every transiting planet sign ingress, and every retrograde or direct station. Returns a time-ordered, significance-scored timeline. Built for astrology forecast feeds, transit alerts, and timing tools.
|
|
1605
|
+
*/
|
|
1606
|
+
forecastTransits(options) {
|
|
1607
|
+
return (options?.client ?? this.client).post({
|
|
1608
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
1609
|
+
url: "/forecast/transits",
|
|
1610
|
+
...options,
|
|
1611
|
+
headers: {
|
|
1612
|
+
"Content-Type": "application/json",
|
|
1613
|
+
...options?.headers
|
|
1614
|
+
}
|
|
1615
|
+
});
|
|
1616
|
+
}
|
|
1617
|
+
/**
|
|
1618
|
+
* Significant dates - High-significance cross-domain forecast highlights
|
|
1619
|
+
*
|
|
1620
|
+
* Return only the high-significance dates from the merged cross-domain forecast for a single birth subject: the rare outer-planet exact transit aspects, slow-planet sign ingresses, retrograde stations, and Vimshottari mahadasha and antardasha changes that mark genuine turning points. Defaults to a significance floor of 70 so the response is a short list of the most meaningful upcoming dates. Built for what-is-coming highlights, timing alerts, and at-a-glance forecast strips.
|
|
1621
|
+
*/
|
|
1622
|
+
findSignificantDates(options) {
|
|
1623
|
+
return (options?.client ?? this.client).post({
|
|
1624
|
+
security: [{ name: "X-API-Key", type: "apiKey" }],
|
|
1625
|
+
url: "/forecast/significant-dates",
|
|
1626
|
+
...options,
|
|
1627
|
+
headers: {
|
|
1628
|
+
"Content-Type": "application/json",
|
|
1629
|
+
...options?.headers
|
|
1630
|
+
}
|
|
1631
|
+
});
|
|
1632
|
+
}
|
|
1633
|
+
};
|
|
1430
1634
|
var Biorhythm = class extends HeyApiClient {
|
|
1431
1635
|
/**
|
|
1432
1636
|
* Get biorhythm reading - Complete cycle analysis for any date
|
|
@@ -2001,6 +2205,14 @@ var Roxy = class _Roxy extends HeyApiClient {
|
|
|
2001
2205
|
get tarot() {
|
|
2002
2206
|
return this._tarot ??= new Tarot({ client: this.client });
|
|
2003
2207
|
}
|
|
2208
|
+
_humanDesign;
|
|
2209
|
+
get humanDesign() {
|
|
2210
|
+
return this._humanDesign ??= new HumanDesign({ client: this.client });
|
|
2211
|
+
}
|
|
2212
|
+
_forecast;
|
|
2213
|
+
get forecast() {
|
|
2214
|
+
return this._forecast ??= new Forecast({ client: this.client });
|
|
2215
|
+
}
|
|
2004
2216
|
_biorhythm;
|
|
2005
2217
|
get biorhythm() {
|
|
2006
2218
|
return this._biorhythm ??= new Biorhythm({ client: this.client });
|
|
@@ -2036,7 +2248,7 @@ var Roxy = class _Roxy extends HeyApiClient {
|
|
|
2036
2248
|
};
|
|
2037
2249
|
|
|
2038
2250
|
// src/version.ts
|
|
2039
|
-
var VERSION = "1.2.
|
|
2251
|
+
var VERSION = "1.2.31";
|
|
2040
2252
|
|
|
2041
2253
|
// src/factory.ts
|
|
2042
2254
|
function createRoxy(auth) {
|
|
@@ -2057,6 +2269,8 @@ export {
|
|
|
2057
2269
|
Biorhythm,
|
|
2058
2270
|
Crystals,
|
|
2059
2271
|
Dreams,
|
|
2272
|
+
Forecast,
|
|
2273
|
+
HumanDesign,
|
|
2060
2274
|
Iching,
|
|
2061
2275
|
Languages,
|
|
2062
2276
|
Location,
|