@astro-api/n8n-nodes-astrology 0.1.1 → 0.1.2

package/README.md

@@ -65,58 +65,51 @@ For Docker deployments, mount the package or use `N8N_CUSTOM_EXTENSIONS`.
 
 ## Usage Examples
 
-### Get Planetary Positions
-
-```json
-{
-  "resource": "data",
-  "operation": "positions",
-  "year": 1990,
-  "month": 6,
-  "day": 15,
-  "hour": 14,
-  "minute": 30,
-  "locationType": "city",
-  "city": "Kyiv",
-  "countryCode": "UA"
-}
-```
+### Quick Start
 
-### Get Daily Horoscope
+1. Install the node via **Settings → Community Nodes** → `@astro-api/n8n-nodes-astrology`
+2. Add **Astrology API** credentials with your API key from [astrology-api.io](https://astrology-api.io)
+3. Add the **Astrology** node to your workflow
+4. Select a resource and operation from the table below
+5. Configure the required parameters and execute
 
-```json
-{
-  "resource": "horoscope",
-  "operation": "signDaily",
-  "sign": "aries",
-  "language": "en",
-  "tradition": "universal"
-}
-```
+### Operations Overview
 
-### Generate Natal Chart
-
-```json
-{
-  "resource": "charts",
-  "operation": "natal",
-  "year": 1990,
-  "month": 6,
-  "day": 15,
-  "hour": 14,
-  "minute": 30,
-  "city": "London",
-  "countryCode": "GB"
-}
-```
+| Use Case | Resource | Operation | What You Get |
+|----------|----------|-----------|--------------|
+| Planet positions | Data | Positions | Zodiac signs, degrees, retrograde status for each planet |
+| House boundaries | Data | House Cusps | Astrological house boundaries (23+ house systems) |
+| Planetary aspects | Data | Aspects | Angular relationships between celestial bodies |
+| Moon data | Data | Lunar Metrics | Moon phase, illumination, void-of-course periods |
+| Current sky | Data | Current Time | Real-time astrological data for the current moment |
+| Daily horoscope | Horoscope | Sign Daily | Daily prediction for any zodiac sign |
+| Weekly horoscope | Horoscope | Sign Weekly | Weekly prediction for any zodiac sign |
+| Monthly horoscope | Horoscope | Sign Monthly | Monthly prediction for any zodiac sign |
+| Yearly horoscope | Horoscope | Sign Yearly | Yearly prediction for any zodiac sign |
+| Personal forecast | Horoscope | Personal Daily/Weekly/Monthly/Yearly | Birth chart-based personalized predictions |
+| Chinese astrology | Horoscope | Chinese Bazi | Four Pillars of Destiny analysis |
+| Birth chart | Charts | Natal | SVG natal chart with configurable house system |
+
+### Common Use Cases
+
+**Planetary Positions & Birth Data**
+Configure **Data → Positions** to calculate planetary positions for any date and location. Returns zodiac signs, degrees, minutes, and retrograde status. Supports both city-based and coordinate-based location input.
+
+**Horoscopes in Multiple Languages**
+Use **Horoscope → Sign Daily/Weekly/Monthly/Yearly** for zodiac sign predictions. Supports multiple languages (EN, RU, UK, ES, DE, FR) and traditions (Western, Vedic, Chinese).
+
+**Personal Horoscopes**
+Use **Horoscope → Personal Daily/Weekly/Monthly/Yearly** for customized predictions based on birth chart data. Combines natal positions with current transits for personalized forecasts.
+
+**Natal Chart Generation**
+Generate SVG birth charts with **Charts → Natal**. Supports 23+ house systems including Placidus, Koch, Equal, and Whole Sign.
+
+### Ready-to-Use Workflows
 
-## Resources & Operations
+Import complete workflow examples from the [`examples/`](examples/) folder:
 
-| Resource | Operations |
-|----------|------------|
-| **Data** | Current Time, Planetary Positions, House Cusps, Aspects, Lunar Metrics |
-| **Horoscope** | Sign Daily/Weekly/Monthly/Yearly, Personal Daily/Weekly/Monthly/Yearly, Chinese Bazi |
-| **Charts** | Natal Chart (more coming soon) |
+- **[Personal Horoscope Workflow](examples/personal-horoscope-workflow.json)** — Generates personalized horoscopes (day/week/month/year) by comparing natal chart with current transits. Includes AI interpretation.
+- **[Tarot Reading Workflow](examples/tarot-reading-workflow.json)** — Performs tarot card readings influenced by current planetary positions and moon phase. Supports multiple spread types.
 
 ## API Documentation
 

package/dist/nodes/Astrology/Astrology.node.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Astrology = void 0;
+const n8n_workflow_1 = require("n8n-workflow");
 const operations_1 = require("./operations");
 const handlers_1 = require("./handlers");
 const DEFAULT_API_BASE_URL = "https://api.astrology-api.io";
@@ -55,22 +56,34 @@ class Astrology {
         const baseUrl = getBaseUrl(credentials);
         const apiKey = credentials.apiKey;
         for (let itemIndex = 0; itemIndex < items.length; itemIndex += 1) {
-            const resource = this.getNodeParameter("resource", itemIndex);
-            const operation = this.getNodeParameter("operation", itemIndex);
-            // Build handler context
-            const context = {
-                executeFunctions: this,
-                itemIndex,
-                baseUrl,
-                apiKey,
-            };
-            // Route to appropriate handler
-            const handler = resourceHandlers[resource];
-            if (!handler) {
-                throw new Error(`Resource "${resource}" is not supported`);
+            try {
+                const resource = this.getNodeParameter("resource", itemIndex);
+                const operation = this.getNodeParameter("operation", itemIndex);
+                // Build handler context
+                const context = {
+                    executeFunctions: this,
+                    itemIndex,
+                    baseUrl,
+                    apiKey,
+                };
+                // Route to appropriate handler
+                const handler = resourceHandlers[resource];
+                if (!handler) {
+                    throw new n8n_workflow_1.NodeOperationError(this.getNode(), `The resource '${resource}' is not supported`, { itemIndex });
+                }
+                const responseData = await handler(context, operation);
+                returnData.push(responseData);
+            }
+            catch (error) {
+                if (this.continueOnFail()) {
+                    returnData.push({
+                        error: error.message,
+                        itemIndex,
+                    });
+                    continue;
+                }
+                throw error;
             }
-            const responseData = await handler(context, operation);
-            returnData.push(responseData);
         }
         return [this.helpers.returnJsonArray(returnData)];
     }

package/dist/nodes/Astrology/handlers/charts.handler.js

@@ -122,7 +122,7 @@ async function handleChartsResource(context, operation) {
     if (op === "natal") {
         return await handleNatalChart(context);
     }
-    throw new Error(`Operation "${operation}" is not supported for charts resource`);
+    throw new Error(`The operation '${operation}' is not supported for the charts resource`);
 }
 /**
  * Handles natal chart generation
@@ -195,5 +195,7 @@ async function handleNatalChart(context) {
         subject,
         options,
     };
-    return await (0, shared_1.makeApiRequest)(executeFunctions, "POST", baseUrl, "/api/v3/charts/natal", apiKey, body);
+    const responseData = await (0, shared_1.makeApiRequest)(executeFunctions, "POST", baseUrl, "/api/v3/charts/natal", apiKey, body);
+    const simplify = executeFunctions.getNodeParameter("simplify", itemIndex, true);
+    return simplify ? (0, shared_1.simplifyResponse)(responseData) : responseData;
 }

package/dist/nodes/Astrology/handlers/data.handler.js

@@ -30,5 +30,7 @@ async function handleDataResource(context, operation) {
     const birthData = (0, shared_1.buildBirthData)(executeFunctions, itemIndex);
     const body = (0, shared_1.createSubjectRequest)(birthData);
     const endpoint = DATA_ENDPOINTS[op] || DATA_ENDPOINTS.positions;
-    return await (0, shared_1.makeApiRequest)(executeFunctions, "POST", baseUrl, endpoint, apiKey, body);
+    const responseData = await (0, shared_1.makeApiRequest)(executeFunctions, "POST", baseUrl, endpoint, apiKey, body);
+    const simplify = executeFunctions.getNodeParameter("simplify", itemIndex, true);
+    return simplify ? (0, shared_1.simplifyResponse)(responseData) : responseData;
 }

package/dist/nodes/Astrology/handlers/horoscope.handler.js

@@ -22,7 +22,7 @@ async function handleHoroscopeResource(context, operation) {
     if (operation === "chineseBazi") {
         return await handleChineseBaziOperation(context);
     }
-    throw new Error(`Operation "${operation}" is not supported for horoscope`);
+    throw new Error(`The operation '${operation}' is not supported for the horoscope resource`);
 }
 /**
  * Handles sign-based horoscope operations

package/dist/nodes/Astrology/operations/charts.operation.js

@@ -435,6 +435,21 @@ const useCacheField = {
     default: true,
     description: "Whether to use cached calculations when available",
 };
+/**
+ * Simplify output toggle for charts resource
+ */
+const simplifyField = {
+    displayName: "Simplify",
+    name: "simplify",
+    type: "boolean",
+    displayOptions: {
+        show: {
+            resource: ["charts"],
+        },
+    },
+    default: true,
+    description: "Whether to return a simplified version of the response instead of the raw data",
+};
 /**
  * Combined charts operations export
  */
@@ -450,6 +465,7 @@ exports.chartsOperations = [
     customActivePointsField,
     perspectiveField,
     precisionField,
+    simplifyField,
     showAdvancedOptionsField,
     enableFixedStarsField,
     fixedStarPresetsField,

package/dist/nodes/Astrology/operations/data.operation.d.ts

@@ -1,6 +1,2 @@
 import type { INodeProperties } from "n8n-workflow";
-/**
- * All properties for the data resource
- * Uses shared field creators to avoid duplication
- */
 export declare const dataOperations: INodeProperties[];

package/dist/nodes/Astrology/operations/data.operation.js

@@ -25,26 +25,26 @@ const dataOperationField = {
         {
             name: "Planetary Positions",
             value: "positions",
-            description: "Get planetary positions with zodiac signs and degrees",
-            action: "Get planetary positions",
+            description: "Calculate planetary positions with zodiac signs and degrees",
+            action: "Get planetary positions data",
         },
         {
             name: "House Cusps",
             value: "houseCusps",
-            description: "Get astrological house boundaries",
-            action: "Get house cusps",
+            description: "Calculate astrological house boundaries",
+            action: "Get house cusps data",
         },
         {
             name: "Aspects",
             value: "aspects",
-            description: "Get angular relationships between celestial bodies",
-            action: "Get aspects",
+            description: "Calculate angular relationships between celestial bodies",
+            action: "Get aspects data",
         },
         {
             name: "Lunar Metrics",
             value: "lunarMetrics",
-            description: "Get moon phase cycles and illumination data",
-            action: "Get lunar metrics",
+            description: "Calculate moon phase cycles and illumination",
+            action: "Get lunar metrics data",
         },
     ],
     default: "positions",
@@ -53,6 +53,24 @@ const dataOperationField = {
  * All properties for the data resource
  * Uses shared field creators to avoid duplication
  */
+/**
+ * Simplify output toggle for data resource
+ */
+const simplifyField = {
+    displayName: "Simplify",
+    name: "simplify",
+    type: "boolean",
+    displayOptions: {
+        show: {
+            resource: ["data"],
+        },
+        hide: {
+            operation: ["now"],
+        },
+    },
+    default: true,
+    description: "Whether to return a simplified version of the response instead of the raw data",
+};
 exports.dataOperations = [
     // Operation selector
     dataOperationField,
@@ -60,4 +78,6 @@ exports.dataOperations = [
     ...(0, shared_1.createBirthDataFields)("data", undefined, ["now"]),
     // Location fields (hidden for 'now' operation)
     ...(0, shared_1.createLocationFields)("data", undefined, ["now"]),
+    // Simplify output (hidden for 'now' operation)
+    simplifyField,
 ];

package/dist/nodes/Astrology/operations/horoscope.operation.js

@@ -196,6 +196,7 @@ exports.horoscopeOperations = [
             },
         },
         default: 1990,
+        placeholder: "e.g. 1990",
         description: "Birth year",
         required: true,
     },
@@ -210,6 +211,7 @@ exports.horoscopeOperations = [
             },
         },
         default: 1,
+        placeholder: "e.g. 6",
         typeOptions: {
             minValue: 1,
             maxValue: 12,
@@ -228,6 +230,7 @@ exports.horoscopeOperations = [
             },
         },
         default: 1,
+        placeholder: "e.g. 15",
         typeOptions: {
             minValue: 1,
             maxValue: 31,
@@ -246,6 +249,7 @@ exports.horoscopeOperations = [
             },
         },
         default: 12,
+        placeholder: "e.g. 14",
         typeOptions: {
             minValue: 0,
             maxValue: 23,
@@ -264,6 +268,7 @@ exports.horoscopeOperations = [
             },
         },
         default: 0,
+        placeholder: "e.g. 30",
         typeOptions: {
             minValue: 0,
             maxValue: 59,
@@ -343,6 +348,7 @@ exports.horoscopeOperations = [
             },
         },
         default: 0,
+        placeholder: "e.g. 50.45",
         typeOptions: {
             minValue: -90,
             maxValue: 90,
@@ -362,6 +368,7 @@ exports.horoscopeOperations = [
             },
         },
         default: 0,
+        placeholder: "e.g. 30.52",
         typeOptions: {
             minValue: -180,
             maxValue: 180,

package/dist/nodes/Astrology/shared/birthData.fields.js

@@ -29,6 +29,7 @@ function createBirthDataFields(resourceName, showForOperations, hideForOperation
             type: "number",
             displayOptions: { ...baseDisplayOptions },
             default: 1990,
+            placeholder: "e.g. 1990",
             description: "Birth year",
             required: true,
         },
@@ -38,6 +39,7 @@ function createBirthDataFields(resourceName, showForOperations, hideForOperation
             type: "number",
             displayOptions: { ...baseDisplayOptions },
             default: 1,
+            placeholder: "e.g. 6",
             typeOptions: {
                 minValue: 1,
                 maxValue: 12,
@@ -51,6 +53,7 @@ function createBirthDataFields(resourceName, showForOperations, hideForOperation
             type: "number",
             displayOptions: { ...baseDisplayOptions },
             default: 1,
+            placeholder: "e.g. 15",
             typeOptions: {
                 minValue: 1,
                 maxValue: 31,
@@ -64,6 +67,7 @@ function createBirthDataFields(resourceName, showForOperations, hideForOperation
             type: "number",
             displayOptions: { ...baseDisplayOptions },
             default: 12,
+            placeholder: "e.g. 14",
             typeOptions: {
                 minValue: 0,
                 maxValue: 23,
@@ -77,6 +81,7 @@ function createBirthDataFields(resourceName, showForOperations, hideForOperation
             type: "number",
             displayOptions: { ...baseDisplayOptions },
             default: 0,
+            placeholder: "e.g. 30",
             typeOptions: {
                 minValue: 0,
                 maxValue: 59,

package/dist/nodes/Astrology/shared/helpers.d.ts

@@ -28,3 +28,14 @@ export declare function makeApiRequest(executeFunctions: IExecuteFunctions, meth
  * @returns Request body with subject wrapper
  */
 export declare function createSubjectRequest(birthData: IBirthData, additionalFields?: IDataObject): IDataObject;
+/**
+ * Simplifies a response object by keeping only top-level keys
+ * up to the specified maximum number of fields.
+ *
+ * Note: Nested objects are returned as-is; no flattening is performed.
+ *
+ * @param data - The full API response
+ * @param maxFields - Maximum number of top-level fields to return (default 10)
+ * @returns Simplified data object
+ */
+export declare function simplifyResponse(data: IDataObject, maxFields?: number): IDataObject;

package/dist/nodes/Astrology/shared/helpers.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildBirthData = buildBirthData;
 exports.makeApiRequest = makeApiRequest;
 exports.createSubjectRequest = createSubjectRequest;
+exports.simplifyResponse = simplifyResponse;
 /**
  * Builds birth data object from node parameters
  *
@@ -76,3 +77,24 @@ function createSubjectRequest(birthData, additionalFields) {
         ...additionalFields,
     };
 }
+/**
+ * Simplifies a response object by keeping only top-level keys
+ * up to the specified maximum number of fields.
+ *
+ * Note: Nested objects are returned as-is; no flattening is performed.
+ *
+ * @param data - The full API response
+ * @param maxFields - Maximum number of top-level fields to return (default 10)
+ * @returns Simplified data object
+ */
+function simplifyResponse(data, maxFields = 10) {
+    const keys = Object.keys(data);
+    if (keys.length <= maxFields) {
+        return data;
+    }
+    const simplified = {};
+    for (let i = 0; i < maxFields; i++) {
+        simplified[keys[i]] = data[keys[i]];
+    }
+    return simplified;
+}

package/dist/nodes/Astrology/shared/index.d.ts

@@ -1,4 +1,4 @@
 export { createBirthDataFields } from "./birthData.fields";
 export { createLocationFields } from "./location.fields";
 export { zodiacSignOptions, createZodiacSignField, traditionOptions, createTraditionField, } from "./zodiac.fields";
-export { buildBirthData, makeApiRequest, createSubjectRequest, } from "./helpers";
+export { buildBirthData, makeApiRequest, createSubjectRequest, simplifyResponse, } from "./helpers";

package/dist/nodes/Astrology/shared/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createSubjectRequest = exports.makeApiRequest = exports.buildBirthData = exports.createTraditionField = exports.traditionOptions = exports.createZodiacSignField = exports.zodiacSignOptions = exports.createLocationFields = exports.createBirthDataFields = void 0;
+exports.simplifyResponse = exports.createSubjectRequest = exports.makeApiRequest = exports.buildBirthData = exports.createTraditionField = exports.traditionOptions = exports.createZodiacSignField = exports.zodiacSignOptions = exports.createLocationFields = exports.createBirthDataFields = void 0;
 // Shared field creators
 var birthData_fields_1 = require("./birthData.fields");
 Object.defineProperty(exports, "createBirthDataFields", { enumerable: true, get: function () { return birthData_fields_1.createBirthDataFields; } });
@@ -16,3 +16,4 @@ var helpers_1 = require("./helpers");
 Object.defineProperty(exports, "buildBirthData", { enumerable: true, get: function () { return helpers_1.buildBirthData; } });
 Object.defineProperty(exports, "makeApiRequest", { enumerable: true, get: function () { return helpers_1.makeApiRequest; } });
 Object.defineProperty(exports, "createSubjectRequest", { enumerable: true, get: function () { return helpers_1.createSubjectRequest; } });
+Object.defineProperty(exports, "simplifyResponse", { enumerable: true, get: function () { return helpers_1.simplifyResponse; } });

package/dist/nodes/Astrology/shared/location.fields.js

@@ -93,6 +93,7 @@ function createLocationFields(resourceName, showForOperations, hideForOperations
             type: "number",
             displayOptions: coordDisplayOptions,
             default: 0,
+            placeholder: "e.g. 50.45",
             typeOptions: {
                 minValue: -90,
                 maxValue: 90,
@@ -106,6 +107,7 @@ function createLocationFields(resourceName, showForOperations, hideForOperations
             type: "number",
             displayOptions: coordDisplayOptions,
             default: 0,
+            placeholder: "e.g. 30.52",
             typeOptions: {
                 minValue: -180,
                 maxValue: 180,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astro-api/n8n-nodes-astrology",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "n8n community node for Astrology API - professional astrological calculations, charts, horoscopes, and interpretations",
   "main": "dist/index.js",
   "scripts": {