@roxyapi/sdk 1.2.61 → 1.2.62

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/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "1.2.61";
1
+ export declare const VERSION = "1.2.62";
2
2
  //# sourceMappingURL=version.d.ts.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@roxyapi/sdk",
3
- "version": "1.2.61",
3
+ "version": "1.2.62",
4
4
  "description": "TypeScript SDK for Roxy — the multi-domain spiritual intelligence API",
5
5
  "type": "module",
6
6
  "exports": {
package/src/types.gen.ts CHANGED
@@ -74,6 +74,10 @@ export type NatalChartResponse = {
74
74
  * Whether the planet is in retrograde motion.
75
75
  */
76
76
  isRetrograde: boolean;
77
+ /**
78
+ * Essential dignity of this body in the sign it occupies: domicile (the sign it rules, its strongest placement), exaltation (honoured and amplified), detriment (opposite its rulership, where it struggles), fall (opposite its exaltation, where it is weakened), or peregrine (in none of its own dignity signs). Absent for the lunar nodes, Chiron and Black Moon Lilith, which rule no sign and therefore hold no dignity at all, so an absent field and peregrine are different answers. Derived by sign only, so triplicity, bounds and face are not considered. Always English, whatever the lang parameter says, so it stays safe to compare against in code. The four dignity signs behind it are published per body by GET /planet-meanings/{id}.
79
+ */
80
+ dignity?: 'domicile' | 'exaltation' | 'detriment' | 'fall' | 'peregrine';
77
81
  /**
78
82
  * Planet-in-sign-in-house interpretation. Narrative analysis of what this placement means in the natal chart.
79
83
  */
@@ -166,9 +170,22 @@ export type NatalChartResponse = {
166
170
  */
167
171
  strength: number;
168
172
  /**
169
- * Aspect nature: harmonious, challenging, or neutral.
173
+ * Aspect nature: harmonious, challenging, or neutral. Always English, whatever the lang parameter says, because it is an identifier to compare and style on. Read aspectInterpretation for the sentence a reader sees.
170
174
  */
171
175
  interpretation: string;
176
+ /**
177
+ * Narrative interpretation of this aspect for this chart. The reference description of the aspect TYPE is not repeated per row, use GET or POST /astrology/aspects for that card.
178
+ */
179
+ aspectInterpretation: {
180
+ /**
181
+ * One-sentence read of THIS pair: which two bodies, how tight the aspect is, whether it is applying or separating, and how it is classified. Translated in place, so it arrives in the requested language.
182
+ */
183
+ summary: string;
184
+ /**
185
+ * Themes this aspect activates between the two bodies. Translated in place, so they arrive in the requested language.
186
+ */
187
+ keywords: Array<string>;
188
+ };
172
189
  }>;
173
190
  /**
174
191
  * Detected multi-planet aspect configurations (Grand Trine, Kite, T-Square, Grand Cross, Yod, Mystic Rectangle, Stellium). Grand Cross suppresses contained T-Squares, Kite suppresses underlying Grand Trine.
@@ -580,7 +597,7 @@ export type AspectsResponse = {
580
597
  */
581
598
  strength: number;
582
599
  /**
583
- * Aspect nature: harmonious, challenging, or neutral.
600
+ * Aspect nature for this pair: harmonious, challenging, or neutral. Always English, whatever the lang parameter says, because it is an identifier to compare and style on. This is the field to branch on; meaning.nature is the reference card characterisation of the aspect type and is translated for display.
584
601
  */
585
602
  interpretation: string;
586
603
  /**
@@ -609,7 +626,7 @@ export type AspectsResponse = {
609
626
  */
610
627
  keywords: Array<string>;
611
628
  /**
612
- * Aspect nature classification.
629
+ * How this aspect type is characterised in its reference card, in the requested language, exactly like the name, description and keywords beside it. This is a property of the aspect TYPE, so branch on the aspect-level interpretation field instead, which is always English and is the classification applied to this particular pair.
613
630
  */
614
631
  nature: string;
615
632
  };
@@ -9676,7 +9693,7 @@ export type PostAstrologySynastryResponses = {
9676
9693
  */
9677
9694
  keywords: Array<string>;
9678
9695
  /**
9679
- * Aspect nature classification.
9696
+ * How this aspect type is characterised in its reference card, in the requested language, exactly like the name, description and keywords beside it. Branch on the aspect-level interpretation field instead, which is always English.
9680
9697
  */
9681
9698
  nature: string;
9682
9699
  /**
@@ -10619,7 +10636,7 @@ export type PostAstrologyTransitAspectsResponses = {
10619
10636
  */
10620
10637
  strength: number;
10621
10638
  /**
10622
- * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
10639
+ * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies. Always English, whatever the lang parameter says: it is an identifier consumers switch and style on. Use interpretationLocalized for anything a reader sees.
10623
10640
  */
10624
10641
  interpretation: 'harmonious' | 'challenging' | 'neutral';
10625
10642
  /**
@@ -10713,7 +10730,7 @@ export type PostAstrologyTransitAspectsResponses = {
10713
10730
  */
10714
10731
  strength: number;
10715
10732
  /**
10716
- * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
10733
+ * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies. Always English, whatever the lang parameter says: it is an identifier consumers switch and style on. Use interpretationLocalized for anything a reader sees.
10717
10734
  */
10718
10735
  interpretation: 'harmonious' | 'challenging' | 'neutral';
10719
10736
  /**
@@ -11069,7 +11086,7 @@ export type PostAstrologySolarReturnResponses = {
11069
11086
  */
11070
11087
  strength: number;
11071
11088
  /**
11072
- * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
11089
+ * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies. Always English, whatever the lang parameter says: it is an identifier consumers switch and style on. Use interpretationLocalized for anything a reader sees.
11073
11090
  */
11074
11091
  interpretation: 'harmonious' | 'challenging' | 'neutral';
11075
11092
  }>;
@@ -11450,7 +11467,7 @@ export type PostAstrologyLunarReturnResponses = {
11450
11467
  */
11451
11468
  strength: number;
11452
11469
  /**
11453
- * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
11470
+ * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies. Always English, whatever the lang parameter says: it is an identifier consumers switch and style on. Use interpretationLocalized for anything a reader sees.
11454
11471
  */
11455
11472
  interpretation: 'harmonious' | 'challenging' | 'neutral';
11456
11473
  }>;
@@ -11908,7 +11925,7 @@ export type PostAstrologyCompositeChartResponses = {
11908
11925
  */
11909
11926
  strength: number;
11910
11927
  /**
11911
- * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
11928
+ * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies. Always English, whatever the lang parameter says: it is an identifier consumers switch and style on. Use interpretationLocalized for anything a reader sees.
11912
11929
  */
11913
11930
  interpretation: 'harmonious' | 'challenging' | 'neutral';
11914
11931
  }>;
@@ -13380,7 +13397,7 @@ export type PostAstrologyPlanetaryReturnsResponses = {
13380
13397
  */
13381
13398
  strength: number;
13382
13399
  /**
13383
- * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
13400
+ * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies. Always English, whatever the lang parameter says: it is an identifier consumers switch and style on. Use interpretationLocalized for anything a reader sees.
13384
13401
  */
13385
13402
  interpretation: 'harmonious' | 'challenging' | 'neutral';
13386
13403
  }>;
@@ -26908,7 +26925,7 @@ export type PostForecastSolarReturnResponses = {
26908
26925
  */
26909
26926
  strength: number;
26910
26927
  /**
26911
- * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies.
26928
+ * Aspect nature. Harmonious (trine, sextile) flows easily. Challenging (square, opposition) creates tension and growth. Neutral (conjunction) blends energies. Always English, whatever the lang parameter says: it is an identifier consumers switch and style on. Use interpretationLocalized for anything a reader sees.
26912
26929
  */
26913
26930
  interpretation: 'harmonious' | 'challenging' | 'neutral';
26914
26931
  }>;
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '1.2.61';
1
+ export const VERSION = '1.2.62';