chart2txt 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,76 @@
+# chart2txt
+
+A TypeScript library that converts astrological chart data to human-readable text.
+
+## Features
+
+- Convert planet positions to text descriptions of their zodiac signs
+- Calculate and describe house placements when an ascendant is provided
+- Calculate and describe aspects between planets
+
+## Installation
+
+```bash
+npm install chart2txt
+```
+
+## Usage
+
+```typescript
+import { chart2txt } from 'chart2txt';
+
+const chartData = {
+  planets: [
+    { name: 'Sun', longitude: 35 },  // 5° Taurus
+    { name: 'Moon', longitude: 120 }, // 0° Leo
+    { name: 'Mercury', longitude: 75 } // 15° Gemini
+  ],
+  ascendant: 0 // 0° Aries
+};
+
+const settings = {
+  // modified settings go here
+};
+
+const textDescription = chart2txt(chartData, settings);
+console.log(textDescription);
+```
+
+### Settings
+
+The conversion to text is configurable through the settings object. Any number of provided settings can be specified, and will overwrite the defaults when provided. Explanations of each setting can be found in the [types.ts](src/types.ts) file, and the default settings can be found in the [constants.ts](src/constants.ts) file. See the [tests file](tests/index.test.ts) for example uses of each setting.
+
+**NOTE**: Overriding aspects must be done by replacing the entire object, i.e. by modifying the following data object to suit your needs:
+
+```javascript
+[
+  { name: 'conjunction', angle: 0, orb: 5 },
+  { name: 'opposition', angle: 180, orb: 5 },
+  { name: 'trine', angle: 120, orb: 5 },
+  { name: 'square', angle: 90, orb: 5 },
+  { name: 'sextile', angle: 60, orb: 3 },
+]
+```
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Run tests
+npm test
+
+# Build the library
+npm run build
+
+# Lint code
+npm run lint
+
+# Format code
+npm run format
+```
+
+## License
+
+MIT

package/dist/constants.d.ts

@@ -0,0 +1,4 @@
+import { Aspect, Settings } from './types';
+export declare const ZODIAC_SIGNS: string[];
+export declare const DEFAULT_ASPECTS: Aspect[];
+export declare const DEFAULT_SETTINGS: Settings;

package/dist/constants.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_SETTINGS = exports.DEFAULT_ASPECTS = exports.ZODIAC_SIGNS = void 0;
+exports.ZODIAC_SIGNS = [
+    'Aries',
+    'Taurus',
+    'Gemini',
+    'Cancer',
+    'Leo',
+    'Virgo',
+    'Libra',
+    'Scorpio',
+    'Sagittarius',
+    'Capricorn',
+    'Aquarius',
+    'Pisces',
+];
+exports.DEFAULT_ASPECTS = [
+    { name: 'conjunction', angle: 0, orb: 5 },
+    { name: 'opposition', angle: 180, orb: 5 },
+    { name: 'trine', angle: 120, orb: 5 },
+    { name: 'square', angle: 90, orb: 5 },
+    { name: 'sextile', angle: 60, orb: 3 },
+];
+exports.DEFAULT_SETTINGS = {
+    // sign settings
+    includeSignDegree: true,
+    omitSigns: false,
+    // house settings
+    houseSystem: 'equal',
+    includeHouseDegree: false,
+    omitHouses: false,
+    // point settings
+    includeAscendant: true,
+    omitPoints: false,
+    // orb + aspect settings
+    aspectDefinitions: exports.DEFAULT_ASPECTS,
+    omitAspects: false,
+};

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * chart2txt
+ * A library to convert astrological chart data to human-readable text
+ */
+import type { Point, ChartData, Settings } from './types';
+/**
+ * Main function to convert chart data to text
+ */
+export declare function chart2txt(data: ChartData, settings?: Partial<Settings>): string;
+export { ChartData, Point, Settings };

package/dist/index.js

@@ -0,0 +1,161 @@
+"use strict";
+/**
+ * chart2txt
+ * A library to convert astrological chart data to human-readable text
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.chart2txt = chart2txt;
+const constants_1 = require("./constants");
+/**
+ * Determines the zodiac sign for a given longitude
+ */
+function getLongitudeSign(longitude) {
+    const signIndex = Math.floor(longitude / 30) % 12;
+    return constants_1.ZODIAC_SIGNS[signIndex];
+}
+/**
+ * Calculates the house for a given longitude, based on the ascendant
+ */
+function getHousePosition(houseSystem, longitude, ascendant) {
+    switch (houseSystem) {
+        case 'equal': {
+            // House 1 starts at the ascendant
+            const housePosition = (longitude - ascendant + 360) % 360;
+            const house = Math.floor(housePosition / 30) + 1;
+            const degree = housePosition % 30;
+            return { house, degree };
+        }
+        case 'whole_sign': {
+            // House 1 starts at beginning of ascendant sign
+            const house1SignCusp = (Math.floor(ascendant / 30) % 12) * 30;
+            // Computation proceeds same as equal, using sign cusp
+            const housePosition = (longitude - house1SignCusp + 360) % 360;
+            const house = Math.floor(housePosition / 30) + 1;
+            const degree = housePosition % 30;
+            return { house, degree };
+        }
+    }
+}
+/**
+ * Identifies aspects between planets
+ */
+function calculateAspects(aspectDefinitions, planets) {
+    const aspects = [];
+    // Compare each planet with every other planet
+    for (let i = 0; i < planets.length; i++) {
+        for (let j = i + 1; j < planets.length; j++) {
+            const planetA = planets[i];
+            const planetB = planets[j];
+            // Calculate the angular difference
+            let diff = Math.abs(planetA.longitude - planetB.longitude);
+            if (diff > 180)
+                diff = 360 - diff;
+            // Check against each aspect type
+            for (const aspectType of aspectDefinitions) {
+                const orb = Math.abs(diff - aspectType.angle);
+                if (orb <= aspectType.orb) {
+                    aspects.push({
+                        planetA: planetA.name,
+                        planetB: planetB.name,
+                        aspectType: aspectType.name,
+                        orb,
+                    });
+                    break; // Only record the strongest aspect between two planets
+                }
+            }
+        }
+    }
+    return aspects;
+}
+/**
+ * Formats planet sign positions as text
+ */
+function formatPlanetSigns(planets, ascendant, points = [], includeDegree = constants_1.DEFAULT_SETTINGS.includeSignDegree) {
+    const ascPoint = ascendant
+        ? [{ name: 'Ascendant', longitude: ascendant }]
+        : [];
+    const output = [...ascPoint, ...planets, ...points]
+        .map((planet) => {
+        const sign = getLongitudeSign(planet.longitude);
+        if (includeDegree) {
+            const degree = Math.floor(planet.longitude % 30);
+            return `${planet.name} is at ${degree}° ${sign}`;
+        }
+        else {
+            return `${planet.name} is in ${sign}`;
+        }
+    })
+        .join('. ');
+    return output ? `${output}.` : '';
+}
+/**
+ * Formats planet house positions as text
+ */
+function formatPlanetHouses(houseSystem, ascendant, planets, points = [], includeDegree = constants_1.DEFAULT_SETTINGS.includeHouseDegree) {
+    // TODO: house systems
+    const output = [...planets, ...points]
+        .map((planet) => {
+        const houseData = getHousePosition(houseSystem, planet.longitude, ascendant);
+        if (includeDegree) {
+            return `${planet.name} is at ${houseData.degree}° in house ${houseData.house}`;
+        }
+        else {
+            return `${planet.name} is in house ${houseData.house}`;
+        }
+    })
+        .join('. ');
+    return output ? `${output}.` : '';
+}
+/**
+ * Formats aspects between planets as text
+ */
+function formatAspects(aspects) {
+    const output = aspects
+        .map((aspect) => {
+        return `${aspect.planetA} is in ${aspect.aspectType} with ${aspect.planetB} (orb: ${aspect.orb.toFixed(1)}°)`;
+    })
+        .join('. ');
+    return output ? `${output}.` : '';
+}
+/**
+ * Formats provided location and time, if present, as text
+ */
+function formatLocationAndDate(location, timestamp) {
+    const locationString = location ? `location: ${location}` : '';
+    const timestampString = timestamp ? `at: ${timestamp.toISOString()}` : '';
+    return [locationString, timestampString].filter((s) => s !== '').join(', ');
+}
+/**
+ * Main function to convert chart data to text
+ */
+function chart2txt(data, settings = {}) {
+    // override default settings with any provided settings data
+    const fullSettings = Object.assign({}, constants_1.DEFAULT_SETTINGS, settings);
+    // format header
+    let result = 'Astrology Chart';
+    const locationAndDate = formatLocationAndDate(data.location, data.timestamp);
+    if (locationAndDate) {
+        result += ` (${locationAndDate})`;
+    }
+    result += ':\n\n';
+    // format planets
+    if (!fullSettings.omitSigns) {
+        result += formatPlanetSigns(data.planets, fullSettings.includeAscendant && data.ascendant
+            ? data.ascendant
+            : undefined, fullSettings.omitPoints ? [] : data.points, fullSettings.includeSignDegree);
+    }
+    // format houses
+    if (!fullSettings.omitHouses && data.ascendant !== undefined) {
+        result +=
+            '\n\n' +
+                formatPlanetHouses(fullSettings.houseSystem, data.ascendant, data.planets, fullSettings.omitPoints ? [] : data.points, fullSettings.includeHouseDegree);
+    }
+    // format aspects
+    if (!fullSettings.omitAspects) {
+        const aspects = calculateAspects(fullSettings.aspectDefinitions, data.planets);
+        if (aspects.length > 0) {
+            result += '\n\n' + formatAspects(aspects);
+        }
+    }
+    return result;
+}

package/dist/types.d.ts

@@ -0,0 +1,34 @@
+export interface Point {
+    name: string;
+    longitude: number;
+}
+export interface ChartData {
+    planets: Point[];
+    ascendant?: number;
+    points?: Point[];
+    timestamp?: Date;
+    location?: string;
+}
+export interface Aspect {
+    name: string;
+    angle: number;
+    orb: number;
+}
+export interface AspectData {
+    planetA: string;
+    planetB: string;
+    aspectType: string;
+    orb: number;
+}
+export type HouseSystem = 'whole_sign' | 'equal';
+export interface Settings {
+    includeSignDegree: boolean;
+    omitSigns: boolean;
+    includeAscendant: boolean;
+    omitPoints: boolean;
+    includeHouseDegree: boolean;
+    houseSystem: HouseSystem;
+    omitHouses: boolean;
+    aspectDefinitions: Aspect[];
+    omitAspects: boolean;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "chart2txt",
+  "version": "0.1.0",
+  "description": "Convert astrological chart data to human-readable text",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "jest",
+    "lint": "eslint src/**/*.ts",
+    "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.ts\""
+  },
+  "keywords": [
+    "astrology",
+    "chart",
+    "text"
+  ],
+  "homepage": "https://github.com/simpolism/chart2txt",
+  "author": "simpolism <simpolism@gmail.com>",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/jest": "^29.5.0",
+    "@types/node": "^18.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/parser": "^5.0.0",
+    "eslint": "^8.0.0",
+    "eslint-config-prettier": "^8.0.0",
+    "jest": "^29.0.0",
+    "prettier": "^2.0.0",
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.0.0"
+  }
+}