vedic-calc 1.0.3

package/docs/api-reference.md

@@ -0,0 +1,411 @@
+---
+title: API Reference - Vedic Calc
+description: Complete API documentation for Kundali Charts SDK - generateRasiChart, generateNavamsaChart, SVG chart generation functions.
+keywords:
+  - kundali charts api
+  - generateRasiChart
+  - generateNavamsaChart
+  - svg renderer
+  - vedic astrology api
+  - typescript astrology
+---
+
+# API Reference
+
+## Chart Generation
+
+### generateRasiChart
+
+Generates a complete Rasi (D-1) birth chart with planetary positions.
+
+```typescript
+function generateRasiChart(
+  date: Date,
+  latitude: number,
+  longitude: number,
+  timezone?: string,
+  nodeType?: NodeType
+): BirthChart
+```
+
+**Parameters:**
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `date` | `Date` | Yes | Date and time of birth |
+| `latitude` | `number` | Yes | Birth place latitude (-90 to 90) |
+| `longitude` | `number` | Yes | Birth place longitude (-180 to 180) |
+| `timezone` | `string` | No | IANA timezone (default: "UTC") |
+| `nodeType` | `NodeType` | No | Rahu/Ketu node type (default: Mean) |
+
+**Returns:** `BirthChart`
+
+**Example:**
+
+```typescript
+const chart = generateRasiChart(
+  new Date('1990-04-29T21:15:00+05:30'),
+  16.544893,  // Latitude
+  81.521240,  // Longitude
+  'Asia/Kolkata'
+);
+```
+
+---
+
+### generateNavamsaChart
+
+Generates Navamsa (D-9) divisional chart from Rasi chart.
+
+```typescript
+function generateNavamsaChart(rasiChart: BirthChart): BirthChart
+```
+
+**Parameters:**
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `rasiChart` | `BirthChart` | Yes | Rasi chart from `generateRasiChart` |
+
+**Returns:** `BirthChart`
+
+**Example:**
+
+```typescript
+const rasi = generateRasiChart(date, lat, lon, tz);
+const navamsa = generateNavamsaChart(rasi);
+```
+
+---
+
+### generateKundali
+
+Generates both Rasi (D-1) and Navamsa (D-9) charts in one call.
+
+```typescript
+function generateKundali(
+  date: Date,
+  latitude: number,
+  longitude: number,
+  timezone?: string,
+  options?: { nodeType?: NodeType }
+): { rasi: RasiChart; navamsa: NavamsaChart }
+```
+
+**Parameters:**
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `date` | `Date` | Yes | Date and time of birth |
+| `latitude` | `number` | Yes | Birth place latitude (-90 to 90) |
+| `longitude` | `number` | Yes | Birth place longitude (-180 to 180) |
+| `timezone` | `string` | No | IANA timezone (default: "UTC") |
+| `options.nodeType` | `NodeType` | No | Rahu/Ketu node type |
+
+**Returns:** `{ rasi: RasiChart; navamsa: NavamsaChart }`
+
+**Example:**
+
+```typescript
+const { rasi, navamsa } = generateKundali(
+  new Date('1990-04-29T21:15:00+05:30'),
+  16.544893,
+  81.521240,
+  'Asia/Kolkata'
+);
+```
+
+---
+
+### calculateNavamsaSign
+
+Calculates the Navamsa sign for a given longitude.
+
+```typescript
+function calculateNavamsaSign(longitude: number): Sign
+```
+
+**Parameters:**
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `longitude` | `number` | Yes | Planetary longitude (0-360) |
+
+**Returns:** `Sign` (0-11)
+
+**Example:**
+
+```typescript
+const navamsaSign = calculateNavamsaSign(125.5); // Returns Sign
+```
+
+---
+
+## SVG Chart Rendering
+
+### generateNorthIndianChartSVG
+
+Generates North Indian style chart (diamond grid layout).
+
+```typescript
+function generateNorthIndianChartSVG(
+  chart: BirthChart,
+  options?: NorthIndianOptions
+): string
+```
+
+**Options:**
+
+```typescript
+interface NorthIndianOptions {
+  showTable?: boolean;        // Show planet details table
+  layout?: 'row' | 'column';  // Table layout
+  title?: string;            // Chart title
+  width?: number;            // Chart width in pixels
+  height?: number;           // Chart height in pixels
+  showSignGlyphs?: boolean;  // Show zodiac symbols (♈♉♊)
+  showSignNumbers?: boolean; // Show sign numbers (1-12)
+  showDegrees?: boolean;     // Show planet degrees
+  customConfig?: ChartConfig; // Custom styling
+}
+```
+
+**Example:**
+
+```typescript
+const svg = generateNorthIndianChartSVG(chart, {
+  showTable: true,
+  layout: 'row',
+  title: 'My Kundali',
+  width: 400,
+  height: 300,
+  showSignGlyphs: true,
+  showSignNumbers: true,
+  showDegrees: true,
+  customConfig: {
+    colors: {
+      background: '#FFFFFF',
+      border: '#422762',
+      innerLines: '#422762',
+      signNumber: '#422762',
+      text: '#1A1A2E',
+      retrograde: '#D63031',
+    }
+  }
+});
+```
+
+---
+
+### generateSouthIndianChartSVG
+
+Generates South Indian style chart (3x4 grid layout).
+
+```typescript
+function generateSouthIndianChartSVG(
+  chart: BirthChart,
+  options?: SouthIndianOptions
+): string
+```
+
+**Options:**
+
+```typescript
+interface SouthIndianOptions {
+  showTable?: boolean;        // Show planet details table
+  showSignGlyphs?: boolean;  // Show zodiac symbols
+  showSignNumbers?: boolean; // Show sign numbers
+  showDegrees?: boolean;     // Show planet degrees
+  cellWidth?: number;        // Cell width
+  cellHeight?: number;       // Cell height
+  title?: string;            // Chart title
+  customConfig?: ChartConfig; // Custom styling
+}
+```
+
+**Example:**
+
+```typescript
+const svg = generateSouthIndianChartSVG(chart, {
+  showTable: true,
+  showSignGlyphs: true,
+  cellWidth: 150,
+  cellHeight: 100,
+  title: 'My Kundali'
+});
+```
+
+---
+
+### PREBUILT_THEMES
+
+Pre-defined color themes for charts.
+
+```typescript
+const PREBUILT_THEMES: {
+  light: ChartTheme;
+  dark: ChartTheme;
+  ocean: ChartTheme;
+  forest: ChartTheme;
+  golden: ChartTheme;
+}
+```
+
+**Example:**
+
+```typescript
+import { generateNorthIndianChartSVG, PREBUILT_THEMES } from 'vedic-calc';
+
+const svg = generateNorthIndianChartSVG(chart, {
+  customConfig: {
+    colors: PREBUILT_THEMES.dark.colors
+  }
+});
+```
+
+---
+
+## Core Functions
+
+### getAyanamsa
+
+Calculates the ayanamsa (sidereal correction) value.
+
+```typescript
+function getAyanamsa(jd: number, system?: AyanamsaSystem): number
+```
+
+### tropicalToSidereal
+
+Converts tropical longitude to sidereal longitude.
+
+```typescript
+function tropicalToSidereal(tropicalLongitude: number, ayanamsa: number): number
+```
+
+### calculateHouseCusps
+
+Calculates house cusps for a given time and location.
+
+```typescript
+function calculateHouseCusps(
+  jd: number,
+  latitude: number,
+  longitude: number,
+  system?: HouseSystem
+): number[]
+```
+
+---
+
+## Types & Enums
+
+### Planet
+
+```typescript
+enum Planet {
+  SUN = 0,
+  MOON = 1,
+  MARS = 2,
+  MERCURY = 3,
+  JUPITER = 4,
+  VENUS = 5,
+  SATURN = 6,
+  RAHU = 7,
+  KETU = 8
+}
+```
+
+### Sign
+
+```typescript
+enum Sign {
+  ARIES = 0,
+  TAURUS = 1,
+  GEMINI = 2,
+  CANCER = 3,
+  LEO = 4,
+  VIRGO = 5,
+  LIBRA = 6,
+  SCORPIO = 7,
+  SAGITTARIUS = 8,
+  CAPRICORN = 9,
+  AQUARIUS = 10,
+  PISCES = 11
+}
+```
+
+### Nakshatras
+
+```typescript
+const Nakshatras: string[] = [
+  "Ashwini", "Bharani", "Kritika", "Rohini", "Mrigashira",
+  "Ardra", "Punarvasu", "Pushya", "Ashlesha", "Magha",
+  "Purva Phalguni", "Uttara Phalguni", "Hasta", "Chitra",
+  "Swati", "Vishakha", "Anuradha", "Jyeshtha", "Mula",
+  "Purva Ashadha", "Uttara Ashadha", "Shravana", "Dhanishtha",
+  "Shatabhisha", "Purva Bhadrapada", "Uttara Bhadrapada", "Revati"
+]
+```
+
+---
+
+## Return Types
+
+### BirthChart
+
+```typescript
+interface BirthChart {
+  birthData: {
+    date: Date;
+    latitude: number;
+    longitude: number;
+    timezone: string;
+  };
+  
+  ascendant: {
+    degree: number;
+    sign: Sign;
+    signName: string;
+    nakshatra: string;
+    nakshatraPada: number;
+  };
+  
+  planets: PlanetPosition[];
+  
+  houses: House[];
+  
+  ayanamsa: number;
+}
+```
+
+### PlanetPosition
+
+```typescript
+interface PlanetPosition {
+  planet: Planet;
+  longitude: number;
+  sign: Sign;
+  signName: string;
+  degreeInSign: number;
+  nakshatra: string;
+  nakshatraPada: number;
+  nakshatraLord: string;
+  house: number;
+  isRetrograde: boolean;
+}
+```
+
+### House
+
+```typescript
+interface House {
+  number: number;
+  sign: Sign;
+  signName: string;
+  lord: string;
+  planets: Planet[];
+  cuspStart: number;
+  cuspEnd: number;
+}
+```

package/docs/charts.md

@@ -0,0 +1,237 @@
+---
+title: Chart Rendering - Vedic Astro
+description: Learn how to customize SVG charts with themes, colors, layouts, and styling options in Kundali Charts SDK.
+keywords:
+  - svg chart rendering
+  - north indian chart
+  - south indian chart
+  - chart customization
+  - chart themes
+  - kundali visualization
+---
+
+# Chart Rendering
+
+Kundali Charts provides two SVG chart styles: North Indian and South Indian. Both can be extensively customized.
+
+## Chart Styles
+
+### North Indian Chart
+
+The North Indian chart uses a diamond grid layout, common in North India.
+
+```typescript
+import { generateRasiChart, generateNorthIndianChartSVG } from 'vedic-calc';
+
+const chart = generateRasiChart(date, lat, lon, tz);
+
+const svg = generateNorthIndianChartSVG(chart, {
+  showTable: true,
+  title: 'My Birth Chart'
+});
+```
+
+### South Indian Chart
+
+The South Indian chart uses a 3x4 grid layout, common in South India.
+
+```typescript
+import { generateSouthIndianChartSVG } from 'vedic-calc';
+
+const svg = generateSouthIndianChartSVG(chart, {
+  showTable: true,
+  title: 'My Birth Chart'
+});
+```
+
+## Customization Options
+
+### Basic Options
+
+```typescript
+const options = {
+  // Display options
+  showTable: true,        // Show/hide planet table
+  showSignGlyphs: true,   // Show ♈♉♊ symbols
+  showSignNumbers: true,  // Show 1-12 numbers
+  showDegrees: true,      // Show planet degrees
+  
+  // Layout
+  title: 'My Kundali',    // Chart title
+  width: 400,            // Chart width
+  height: 300,          // Chart height
+  
+  // South Indian only
+  cellWidth: 150,        // Cell width
+  cellHeight: 100       // Cell height
+};
+```
+
+### Color Customization
+
+```typescript
+const customConfig = {
+  colors: {
+    background: '#FFFFFF',    // Chart background
+    border: '#422762',        // Outer border
+    innerLines: '#422762',    // Grid lines
+    signNumber: '#422762',    // Sign numbers
+    text: '#1A1A2E',          // Main text
+    retrograde: '#D63031',   // Retrograde planets
+  }
+};
+
+const svg = generateNorthIndianChartSVG(chart, {
+  customConfig
+});
+```
+
+## Pre-built Themes
+
+### Dark Theme
+
+```typescript
+import { PREBUILT_THEMES } from 'vedic-calc';
+
+const svg = generateNorthIndianChartSVG(chart, {
+  customConfig: {
+    colors: PREBUILT_THEMES.dark.colors
+  }
+});
+```
+
+### Ocean Theme
+
+```typescript
+const svg = generateNorthIndianChartSVG(chart, {
+  customConfig: {
+    colors: PREBUILT_THEMES.ocean.colors
+  }
+});
+```
+
+### Forest Theme
+
+```typescript
+const svg = generateNorthIndianChartSVG(chart, {
+  customConfig: {
+    colors: PREBUILT_THEMES.forest.colors
+  }
+});
+```
+
+### Golden Theme
+
+```typescript
+const svg = generateNorthIndianChartSVG(chart, {
+  customConfig: {
+    colors: PREBUILT_THEMES.golden.colors
+  }
+});
+```
+
+## Complete Example
+
+```typescript
+import { 
+  generateRasiChart, 
+  generateNorthIndianChartSVG
+} from 'vedic-calc';
+
+const chart = generateRasiChart(
+  new Date('1990-04-29T21:15:00+05:30'),
+  16.544893,
+  81.521240,
+  'Asia/Kolkata'
+);
+
+// Generate SVG chart
+const svg = generateNorthIndianChartSVG(chart, {
+  showTable: true,
+  width: 500,
+  height: 400,
+});
+
+// Embed in HTML
+const container = document.getElementById('kundali');
+container.innerHTML = svg;
+```
+    colors: {
+      background: '#1a1a2e',
+      border: '#e94560',
+      innerLines: '#e94560',
+      signNumber: '#e94560',
+      text: '#ffffff',
+      retrograde: '#ff6b6b',
+    }
+  }
+});
+
+// Embed in HTML
+const container = document.getElementById('kundali');
+container.innerHTML = svg;
+```
+
+## HTML Integration
+
+```html
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Kundali Chart</title>
+  <style>
+    body {
+      display: flex;
+      justify-content: center;
+      align-items: center;
+      min-height: 100vh;
+      margin: 0;
+      background: #f5f5f5;
+    }
+    .chart-container {
+      background: white;
+      padding: 20px;
+      border-radius: 12px;
+      box-shadow: 0 4px 20px rgba(0,0,0,0.15);
+    }
+  </style>
+</head>
+<body>
+  <div class="chart-container" id="kundali"></div>
+  
+  <script type="module">
+    import { generateRasiChart, generateNorthIndianChartSVG } from 'vedic-calc';
+    
+    const chart = generateRasiChart(
+      new Date('1990-04-29T21:15:00+05:30'),
+      16.544893,
+      81.521240,
+      'Asia/Kolkata'
+    );
+    
+    const svg = generateNorthIndianChartSVG(chart, {
+      showTable: true,
+      title: 'My Birth Chart'
+    });
+    
+    document.getElementById('kundali').innerHTML = svg;
+  </script>
+</body>
+</html>
+```
+
+## Chart Comparison
+
+| Feature | North Indian | South Indian |
+|---------|--------------|--------------|
+| Layout | Diamond grid | 3x4 grid |
+| Best for | Quick overview | Detailed view |
+| Table position | Side | Bottom |
+| Default orientation | - | Signs 1-12 left to right |
+
+## Tips
+
+1. **Use appropriate size** - Set width/height based on where you'll display
+2. **Choose right style** - North Indian for overview, South Indian for details
+3. **Theme matching** - Match chart theme to your app's design
+4. **Show/hide elements** - Customize what information to display