@jammysunshine/astrology-shared 1.0.1

package/examples/index.js

@@ -0,0 +1,455 @@
+/**
+ * Example input structures for astrology services
+ * Standardized JSON schemas with real-world usage examples
+ */
+
+const { generateRequestId } = require('../schemas');
+
+/**
+ * WhatsApp Client Input Example
+ * For astrology queries via WhatsApp bot
+ */
+const WHATSAPP_INPUT_EXAMPLE = {
+  requestId: generateRequestId(),
+  timestamp: new Date().toISOString(),
+
+  client: {
+    type: 'whatsapp',
+    version: '2.21.22.16',
+    sessionId: 'wa_123456789',
+    deviceId: 'iPhone12,2',
+    userAgent: 'WhatsApp/2.21.22.16 i'
+  },
+
+  birthData: {
+    date: '15/01/1990',  // STRICT DD/MM/YYYY format only
+    time: '14:30',       // STRICT HH:MM format only (24-hour)
+    place: 'Mumbai, India',
+    coordinates: {
+      latitude: 19.0760,
+      longitude: 72.8777
+    },
+    timezone: 'Asia/Kolkata'
+  },
+
+  parameters: {
+    ayanamsa: 'lahiri',
+    houseSystem: 'placidus',
+    zodiac: 'sidereal',
+    includeAspects: true,
+    includeHouses: true,
+    detailLevel: 'detailed',
+    language: 'hi'
+  },
+
+  context: {
+    preferences: {
+      units: 'metric',
+      dateFormat: 'dd/mm/yyyy',
+      timeFormat: '24h'
+    },
+    correlationId: 'wa_conv_123456',
+    location: {
+      ip: '192.168.1.100',
+      country: 'IN',
+      timezone: 'Asia/Kolkata'
+    }
+  }
+};
+
+/**
+ * iOS App Input Example
+ * For astrology queries via iOS mobile app
+ */
+const IOS_INPUT_EXAMPLE = {
+  requestId: generateRequestId(),
+  timestamp: new Date().toISOString(),
+
+  client: {
+    type: 'ios',
+    version: '1.2.3',
+    sessionId: 'ios_app_987654321',
+    deviceId: 'iPhone13,4',
+    userAgent: 'AstroApp/1.2.3 (iPhone; iOS 15.4; Scale/3.00)'
+  },
+
+  birthData: {
+    date: '22/06/1985',
+    time: '09:15',
+    place: 'New Delhi, India',
+    coordinates: {
+      latitude: 28.6139,
+      longitude: 77.2090
+    },
+    timezone: 'Asia/Kolkata',
+    daylightSaving: false
+  },
+
+  parameters: {
+    ayanamsa: 'raman',
+    houseSystem: 'whole_sign',
+    zodiac: 'sidereal',
+    includeAspects: true,
+    includeHouses: true,
+    detailLevel: 'comprehensive',
+    language: 'en'
+  },
+
+  context: {
+    preferences: {
+      units: 'metric',
+      dateFormat: 'dd/mm/yyyy',
+      timeFormat: '24h'
+    },
+    correlationId: 'ios_session_abc123',
+    location: {
+      ip: '10.0.0.50',
+      country: 'IN',
+      timezone: 'Asia/Kolkata'
+    }
+  }
+};
+
+/**
+ * Android App Input Example
+ * For astrology queries via Android mobile app
+ */
+const ANDROID_INPUT_EXAMPLE = {
+  requestId: generateRequestId(),
+  timestamp: new Date().toISOString(),
+
+  client: {
+    type: 'android',
+    version: '2.1.0',
+    sessionId: 'android_app_xyz789',
+    deviceId: 'SM-G998B',
+    userAgent: 'AstroApp/2.1.0 (Android 12; SM-G998B)'
+  },
+
+  birthData: {
+    date: '08/03/1992',
+    time: '16:45',
+    place: 'Bangalore, India',
+    coordinates: {
+      latitude: 12.9716,
+      longitude: 77.5946
+    },
+    timezone: 'Asia/Kolkata'
+  },
+
+  parameters: {
+    ayanamsa: 'krishnamurti',
+    houseSystem: 'equal',
+    zodiac: 'tropical',
+    includeAspects: true,
+    includeHouses: true,
+    detailLevel: 'basic',
+    language: 'en'
+  },
+
+  context: {
+    preferences: {
+      units: 'metric',
+      dateFormat: 'dd/mm/yyyy',
+      timeFormat: '12h'
+    },
+    correlationId: 'android_session_def456',
+    location: {
+      ip: '172.16.0.25',
+      country: 'IN',
+      timezone: 'Asia/Kolkata'
+    }
+  }
+};
+
+/**
+ * PWA Input Example
+ * For astrology queries via Progressive Web App
+ */
+const PWA_INPUT_EXAMPLE = {
+  requestId: generateRequestId(),
+  timestamp: new Date().toISOString(),
+
+  client: {
+    type: 'pwa',
+    version: '1.0.5',
+    sessionId: 'pwa_session_ghi789',
+    deviceId: 'chrome_desktop_91.0.4472.124',
+    userAgent: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36'
+  },
+
+  birthData: {
+    date: '30/11/1978',
+    time: '23:10',
+    place: 'Chennai, India',
+    coordinates: {
+      latitude: 13.0827,
+      longitude: 80.2707
+    },
+    timezone: 'Asia/Kolkata'
+  },
+
+  parameters: {
+    ayanamsa: 'fagan_bradley',
+    houseSystem: 'koch',
+    zodiac: 'sidereal',
+    includeAspects: false,
+    includeHouses: true,
+    detailLevel: 'detailed',
+    language: 'ta'
+  },
+
+  context: {
+    preferences: {
+      units: 'metric',
+      dateFormat: 'dd/mm/yyyy',
+      timeFormat: '24h'
+    },
+    correlationId: 'pwa_session_jkl012',
+    location: {
+      ip: '203.0.113.1',
+      country: 'IN',
+      timezone: 'Asia/Kolkata'
+    }
+  }
+};
+
+/**
+ * Web App Input Example
+ * For astrology queries via web application
+ */
+const WEB_INPUT_EXAMPLE = {
+  requestId: generateRequestId(),
+  timestamp: new Date().toISOString(),
+
+  client: {
+    type: 'web',
+    version: '3.0.1',
+    sessionId: 'web_session_mno345',
+    deviceId: 'firefox_desktop_89.0',
+    userAgent: 'Mozilla/5.0 (X11; Linux x86_64; rv:89.0) Gecko/20100101 Firefox/89.0'
+  },
+
+  birthData: {
+    date: '12/07/1989',
+    time: '07:20',
+    place: 'Hyderabad, India',
+    coordinates: {
+      latitude: 17.3850,
+      longitude: 78.4867
+    },
+    timezone: 'Asia/Kolkata'
+  },
+
+  parameters: {
+    ayanamsa: 'lahiri',
+    houseSystem: 'placidus',
+    zodiac: 'sidereal',
+    includeAspects: true,
+    includeHouses: true,
+    detailLevel: 'comprehensive',
+    language: 'te'
+  },
+
+  context: {
+    preferences: {
+      units: 'metric',
+      dateFormat: 'dd/mm/yyyy',
+      timeFormat: '24h'
+    },
+    correlationId: 'web_session_pqr678',
+    location: {
+      ip: '198.51.100.1',
+      country: 'IN',
+      timezone: 'Asia/Kolkata'
+    }
+  }
+};
+
+/**
+ * API Client Input Example
+ * For direct API integrations
+ */
+const API_INPUT_EXAMPLE = {
+  requestId: generateRequestId(),
+  timestamp: new Date().toISOString(),
+
+  client: {
+    type: 'api',
+    version: '1.0.0',
+    sessionId: 'api_key_stu901',
+    deviceId: 'server_node_v16',
+    userAgent: 'AstrologyAPI/1.0.0 (Node.js 16.14.0)'
+  },
+
+  birthData: {
+    date: '05/09/1983',
+    time: '12:00',
+    place: 'Kolkata, India',
+    coordinates: {
+      latitude: 22.5726,
+      longitude: 88.3639
+    },
+    timezone: 'Asia/Kolkata'
+  },
+
+  parameters: {
+    ayanamsa: 'lahiri',
+    houseSystem: 'placidus',
+    zodiac: 'sidereal',
+    includeAspects: true,
+    includeHouses: true,
+    detailLevel: 'detailed',
+    language: 'en'
+  },
+
+  context: {
+    preferences: {
+      units: 'metric',
+      dateFormat: 'dd/mm/yyyy',
+      timeFormat: '24h'
+    },
+    correlationId: 'api_request_vwx234',
+    location: {
+      ip: '104.28.1.1',
+      country: 'IN',
+      timezone: 'Asia/Kolkata'
+    }
+  }
+};
+
+/**
+ * Legacy Compatibility Input Example
+ * Shows how old format inputs are automatically normalized
+ */
+const LEGACY_COMPATIBILITY_EXAMPLE = {
+  // Old direct format (still supported)
+  birthDate: '15/01/1990',
+  birthTime: '14:30',
+  birthPlace: 'Mumbai, India',
+
+  // Optional legacy fields
+  clientType: 'whatsapp',
+  sessionId: 'wa_123456789',
+  language: 'hi',
+
+  // Gets automatically normalized to:
+  // {
+  //   requestId: "auto-generated-uuid",
+  //   timestamp: "current-iso-time",
+  //   client: { type: "whatsapp", version: "1.0.0", sessionId: "wa_123456789" },
+  //   birthData: { date: "15/01/1990", time: "14:30", place: "Mumbai, India" },
+  //   parameters: { language: "hi", ...defaults },
+  //   context: { correlationId: "wa_123456789" }
+  // }
+};
+
+/**
+ * Minimal Input Example
+ * Shows the absolute minimum required fields
+ */
+const MINIMAL_INPUT_EXAMPLE = {
+  requestId: generateRequestId(),
+  timestamp: new Date().toISOString(),
+
+  client: {
+    type: 'api',
+    version: '1.0.0'
+  },
+
+  birthData: {
+    date: '15/01/1990',
+    time: '14:30',
+    place: 'Mumbai, India'
+  }
+
+  // Everything else uses sensible defaults
+};
+
+/**
+ * Advanced Input Example
+ * Shows all possible customization options
+ */
+const ADVANCED_INPUT_EXAMPLE = {
+  requestId: generateRequestId(),
+  timestamp: new Date().toISOString(),
+
+  client: {
+    type: 'ios',
+    version: '2.0.0',
+    sessionId: 'ios_advanced_123',
+    deviceId: 'iPhone14,2',
+    userAgent: 'AdvancedAstroApp/2.0.0'
+  },
+
+  birthData: {
+    date: '15/01/1990',
+    time: '14:30',
+    place: 'Mumbai, India',
+    coordinates: {
+      latitude: 19.0760,
+      longitude: 72.8777
+    },
+    timezone: 'Asia/Kolkata',
+    daylightSaving: false
+  },
+
+  parameters: {
+    ayanamsa: 'lahiri',
+    houseSystem: 'placidus',
+    zodiac: 'sidereal',
+    includeAspects: true,
+    includeHouses: true,
+    detailLevel: 'comprehensive',
+    language: 'hi'
+  },
+
+  context: {
+    preferences: {
+      units: 'metric',
+      dateFormat: 'dd/mm/yyyy',
+      timeFormat: '24h'
+    },
+    correlationId: 'advanced_request_456',
+    location: {
+      ip: '192.168.1.1',
+      country: 'IN',
+      timezone: 'Asia/Kolkata'
+    }
+  },
+
+  // Future extensibility
+  extensions: {
+    customCalculation: 'vedic_progression',
+    experimentalFeatures: ['advanced_aspects', 'harmonic_analysis'],
+    userProfile: {
+      experience: 'advanced',
+      interests: ['spirituality', 'career']
+    }
+  }
+};
+
+module.exports = {
+  WHATSAPP_INPUT_EXAMPLE,
+  IOS_INPUT_EXAMPLE,
+  ANDROID_INPUT_EXAMPLE,
+  PWA_INPUT_EXAMPLE,
+  WEB_INPUT_EXAMPLE,
+  API_INPUT_EXAMPLE,
+  LEGACY_COMPATIBILITY_EXAMPLE,
+  MINIMAL_INPUT_EXAMPLE,
+  ADVANCED_INPUT_EXAMPLE,
+
+  // Helper to get example by client type
+  getExampleByClientType: (clientType) => {
+    const examples = {
+      whatsapp: WHATSAPP_INPUT_EXAMPLE,
+      ios: IOS_INPUT_EXAMPLE,
+      android: ANDROID_INPUT_EXAMPLE,
+      pwa: PWA_INPUT_EXAMPLE,
+      web: WEB_INPUT_EXAMPLE,
+      api: API_INPUT_EXAMPLE
+    };
+    return examples[clientType] || API_INPUT_EXAMPLE;
+  }
+};