@finspringinnovations/fixeddepositsdk 1.0.0

package/src/config/appDataConfig.ts

@@ -0,0 +1,358 @@
+// AppData Configuration - Data received from main app when SDK starts
+
+export interface EnvironmentData {
+    environment: string;
+    apiBaseUrl?: string;
+    apiKey?: string;
+    encryptionKey?: string;
+    enableLogging?: boolean;
+}
+
+export interface AppData {
+    // Required user identification fields
+    id: string; // Required: User ID from main app
+    name: string; // Required: User full name
+    dob: string; // Required: Date of birth in YYYY-MM-DD format
+    gender?: string | null; // Optional: Male, Female (initial state may be null)
+    mobNo: string; // Required: Mobile number (10 digits)
+    email: string; // Required: Email address
+    panNumber?: string; // Optional: PAN can be collected later in provider SDK flow
+
+    // Optional fields - can be collected in SDK if not provided
+    address?: string;
+    area?: string;
+    city?: string;
+    state?: string;
+    country?: string;
+    pinCode?: string;
+    accountNo?: string;
+    nameOfBank?: string;
+    ifsc?: string;
+    typeOfAccount?: string; // Optional: Savings, Current, Fixed Deposit, Recurring Deposit
+    maritalStatus?: string; // Optional: Single, Married, Divorced, Widowed
+    userReferenceId?: string; // Optional: User reference ID from main app
+    eventNotifyUrl?: string; 
+    kycRelation?: string;
+    kycRelationName?: string;
+    // Optional powered-by logo URI/base64 for FDList header branding
+    poweredByLogo?: string;
+}
+
+// Global app data storage
+let globalAppData: AppData | null = null;
+
+// Global environment data storage
+let globalEnvironmentData: EnvironmentData | null = null;
+
+// Global custom color overrides for theming
+export interface CustomColors {
+    primary?: string;
+    tabSelected?: string;
+    headerBg?: string;
+    headerText?: string;
+    success?: string;
+    textSecondary?: string;
+    border?: string;
+    shadow?: string;
+    background?: string;
+    surface?: string;
+    text?: string;
+    textLight?: string;
+    error?: string;
+    warning?: string;
+    info?: string;
+    muted?: string;
+    inputBackground?: string;
+    inputBorder?: string;
+    placeholderColor?: string;
+    labelColor?: string;
+    buttonBackground?: string;
+    buttonTextColor?: string;
+    cancelButtonBg?: string;
+}
+
+let globalCustomColors: CustomColors | null = null;
+
+/**
+ * Initialize the SDK with app data from the main application
+ * This should be called when the SDK starts
+ */
+export const initializeSDK = (appData: AppData, onValidationError?: (errors: string[]) => void): void => {
+    // Validate required user identification fields
+    const requiredFields = [
+        { field: 'id', label: 'User ID' },
+        { field: 'name', label: 'User Name' },
+        { field: 'dob', label: 'Date of Birth' },
+        { field: 'gender', label: 'Gender' },
+        { field: 'mobNo', label: 'Mobile Number' },
+        { field: 'email', label: 'Email' },
+    ];
+
+    const missingFields: string[] = [];
+
+    requiredFields.forEach(({ field, label }) => {
+        const value = (appData as any)[field];
+        if (!value || (typeof value === 'string' && !value.trim())) {
+            missingFields.push(label);
+        }
+    });
+
+    // If required fields are missing, call error handler
+    if (missingFields.length > 0) {
+        const errorMessage = `Missing required user information from main app:\n${missingFields.join(', ')}`;
+
+        if (onValidationError) {
+            onValidationError(missingFields);
+        }
+
+        throw new Error(errorMessage);
+    }
+
+    // Validate all fields
+    const validation = validateAppData(appData);
+    if (!validation.isValid) {
+        if (onValidationError) {
+            onValidationError(validation.errors);
+        }
+
+        throw new Error(`App data validation failed: ${validation.errors.join(', ')}`);
+    }
+
+    globalAppData = appData;
+
+    // SDK initialization started
+    try {
+        // logging removed
+    } catch { }
+
+    // Import and call environment logging
+    import('./apiConfig').then(({ logEnvironmentInfo }) => {
+        logEnvironmentInfo();
+    });
+};
+
+/**
+ * Initialize the SDK with environment configuration from the main application
+ * This should be called to configure SDK environment settings
+ */
+export const initializeEnvironment = (environmentData: EnvironmentData): void => {
+    globalEnvironmentData = environmentData;
+
+    // Environment initialization started
+    try {
+        // logging removed
+    } catch { }
+
+    // Environment initialized
+};
+
+/**
+ * Get the current app data
+ */
+export const getAppData = (): AppData | null => {
+    return globalAppData;
+};
+
+/**
+ * Get the current environment data
+ */
+export const getEnvironmentData = (): EnvironmentData | null => {
+    return globalEnvironmentData;
+};
+
+/**
+ * Check if SDK is initialized with app data
+ */
+export const isSDKInitialized = (): boolean => {
+    return globalAppData !== null;
+};
+
+/**
+ * Check if environment is initialized
+ */
+export const isEnvironmentInitialized = (): boolean => {
+    return globalEnvironmentData !== null;
+};
+
+/**
+ * Get specific user information for API requests
+ */
+export const getUserInfoForAPI = () => {
+    if (!globalAppData) {
+        throw new Error('SDK not initialized. Call initializeSDK() first.');
+    }
+
+    return {
+        id: globalAppData.id,
+        name: globalAppData.name,
+        dob: globalAppData.dob,
+        gender: globalAppData.gender,
+        panNumber: globalAppData.panNumber,
+        mobileNumber: globalAppData.mobNo,
+        email: globalAppData.email,
+        eventNotifyUrl: globalAppData.eventNotifyUrl,
+        userReferenceId: globalAppData.id, // Use userReferenceId or fallback to id
+        address: {
+            line1: globalAppData.address,
+            area: globalAppData.area,
+            city: globalAppData.city,
+            state: globalAppData.state,
+            country: globalAppData.country,
+            pinCode: globalAppData.pinCode,
+        },
+        bankDetails: {
+            accountNumber: globalAppData.accountNo,
+            bankName: globalAppData.nameOfBank,
+            ifsc: globalAppData.ifsc,
+            accountType: globalAppData.typeOfAccount,
+        },
+        maritalStatus: globalAppData.maritalStatus,
+    };
+};
+
+/**
+ * Get user demographics for interest rate calculations
+ */
+export const getUserDemographics = () => {
+    if (!globalAppData) {
+        throw new Error('SDK not initialized. Call initializeSDK() first.');
+    }
+
+    // Calculate age from DOB
+    const calculateAge = (dob: string): number => {
+        const today = new Date();
+        const birthDate = new Date(dob);
+        let age = today.getFullYear() - birthDate.getFullYear();
+        const monthDiff = today.getMonth() - birthDate.getMonth();
+
+        if (monthDiff < 0 || (monthDiff === 0 && today.getDate() < birthDate.getDate())) {
+            age--;
+        }
+
+        return age;
+    };
+
+    const age = calculateAge(globalAppData.dob);
+    const isSeniorCitizen = age >= 60;
+    const isWomenDepositor = globalAppData.gender === 'Female' || globalAppData.gender === 'female';
+
+    return {
+        age,
+        isSeniorCitizen,
+        isWomenDepositor,
+        gender: globalAppData.gender,
+        maritalStatus: globalAppData.maritalStatus,
+        dob: globalAppData.dob,
+    };
+};
+
+/**
+ * Validate app data
+ */
+export const validateAppData = (appData: AppData): { isValid: boolean; errors: string[] } => {
+    const errors: string[] = [];
+
+    // Required fields validation
+    if (!appData.id?.trim()) errors.push('ID is required');
+    if (!appData.name?.trim()) errors.push('Name is required');
+    if (!appData.dob?.trim()) errors.push('Date of birth is required');
+    if (!appData.gender) errors.push('Gender is required');
+    if (!appData.mobNo?.trim()) errors.push('Mobile number is required');
+    if (!appData.email?.trim()) errors.push('Email is required');
+
+    // Format validation (only if fields are provided)
+    if (appData.dob && !/^\d{4}-\d{2}-\d{2}$/.test(appData.dob)) {
+        errors.push('Date of birth must be in YYYY-MM-DD format');
+    }
+
+    if (appData.panNumber && appData.panNumber.trim() && !/^[A-Z]{5}[0-9]{4}[A-Z]{1}$/.test(appData.panNumber)) {
+        errors.push('PAN number must be in valid format (e.g., ABCDE1234F)');
+    }
+
+    if (appData.mobNo && !/^[6-9]\d{9}$/.test(appData.mobNo)) {
+        errors.push('Mobile number must be 10 digits starting with 6-9');
+    }
+
+    if (appData.email && !/^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(appData.email)) {
+        errors.push('Email must be in valid format');
+    }
+
+    if (appData.ifsc && appData.ifsc.trim() && !/^[A-Z]{4}0[A-Z0-9]{6}$/.test(appData.ifsc)) {
+        errors.push('IFSC code must be in valid format (e.g., SBIN0001234)');
+    }
+
+    return {
+        isValid: errors.length === 0,
+        errors,
+    };
+};
+
+/**
+ * Clear app data (for testing or logout scenarios)
+ */
+export const clearAppData = (): void => {
+    globalAppData = null;
+};
+
+/**
+ * Clear environment data (for testing or logout scenarios)
+ */
+export const clearEnvironmentData = (): void => {
+    globalEnvironmentData = null;
+};
+
+/**
+ * Clear all data (app data and environment data)
+ */
+export const clearAllData = (): void => {
+    globalAppData = null;
+    globalEnvironmentData = null;
+    globalCustomColors = null;
+};
+
+/**
+ * Set custom color overrides for the SDK theme.
+ * Colors defined here will override the corresponding color from the selected theme (primary/dark/etc).
+ * Call this before rendering the FDSDK navigator.
+ *
+ * This also forwards the same colors to Shriram and Mahindra SDKs when they are installed,
+ * so a single call centralizes theming across all SDKs.
+ */
+export const setSDKColors = (customColors: CustomColors): void => {
+    globalCustomColors = customColors;
+
+    // Best-effort: propagate to external SDKs when they are available
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        const shriram = require('@finspringinnovations/shriramsdk');
+        if (shriram && typeof shriram.setSDKColors === 'function') {
+            shriram.setSDKColors(customColors);
+        }
+    } catch {
+        // Ignore if Shriram SDK is not installed
+    }
+
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        const mahindra = require('@finspringinnovations/mahindrasdk');
+        if (mahindra && typeof mahindra.setSDKColors === 'function') {
+            mahindra.setSDKColors(customColors);
+        }
+    } catch {
+        // Ignore if Mahindra SDK is not installed
+    }
+};
+
+/**
+ * Get the current custom color overrides
+ */
+export const getSDKColors = (): CustomColors | null => {
+    return globalCustomColors;
+};
+
+/**
+ * Clear custom color overrides
+ */
+export const clearSDKColors = (): void => {
+    globalCustomColors = null;
+};

package/src/config/encryptionConfig.ts

@@ -0,0 +1,65 @@
+import { EncryptionConfig } from '../utils/encryption';
+import { getEnvironmentData } from './appDataConfig';
+
+//Encryption configuration from environment data
+export const getEncryptionConfig = (): EncryptionConfig => {
+    const environmentData = getEnvironmentData();
+
+    // Use environment data if available
+    if (environmentData?.encryptionKey) {
+        return {
+            secretKey: environmentData.encryptionKey,
+            algorithm: 'AES',
+            ivLength: 16,
+        };
+    }
+
+    // If no environment data, throw error to ensure proper initialization
+    throw new Error('Environment data not initialized. Call initializeEnvironment() first.');
+};
+
+// Configuration for different environments - using environment data
+export const getEncryptionConfigs = () => {
+    const environmentData = getEnvironmentData();
+
+    if (!environmentData?.encryptionKey) {
+        throw new Error('Environment data not initialized. Call initializeEnvironment() first.');
+    }
+
+    return {
+        development: {
+            secretKey: environmentData.encryptionKey,
+            algorithm: 'AES' as const,
+            ivLength: 16,
+        },
+        staging: {
+            secretKey: environmentData.encryptionKey,
+            algorithm: 'AES' as const,
+            ivLength: 16,
+        },
+        production: {
+            secretKey: environmentData.encryptionKey,
+            algorithm: 'AES' as const,
+            ivLength: 16,
+        },
+    };
+};
+
+// Get configuration based on environment
+export const getEnvironmentConfig = (env: 'development' | 'staging' | 'production' = 'development'): EncryptionConfig => {
+    const configs = getEncryptionConfigs();
+    return configs[env];
+};
+
+// Validate encryption configuration
+export const validateEncryptionConfig = (config: EncryptionConfig): boolean => {
+    if (!config.secretKey || config.secretKey.length < 16) {
+        return false;
+    }
+
+    if (config.ivLength && (config.ivLength < 8 || config.ivLength > 32)) {
+        return false;
+    }
+
+    return true;
+};

package/src/config/workflowConstants.ts

@@ -0,0 +1,70 @@
+// Workflow State Constants
+export const WORKFLOW_STATES = {
+    INITIATION: 404,
+    START: 405,
+    KYC: 406,
+    OCCUPATION: 409,
+    NOMINEE: 407,
+    BANK_DETAILS: 408,
+    CREATE_FD: 411,
+    PAYMENT: 410,
+    END: 403,
+} as const;
+
+export const SHRIRAM_WORKFLOW_STATES = {
+    INITIATION: 404,
+    START: 405,
+    KYC: 406,
+    OCCUPATION: 409,
+    NOMINEE: 407,
+    BANK_DETAILS: 408,
+    CREATE_FD: 411,
+    PAYMENT: 410,
+    END: 403,
+} as const;
+
+export const MAHINDRA_WORKFLOW_STATES = {
+    INITIATION: 404,
+    START: 405,
+    KYC: 444,
+    OCCUPATION: 447,
+    NOMINEE: 448,
+    BANK_DETAILS: 449,
+    CREATE_FD: 411,
+    PAYMENT: 450,
+    END: 403,
+    AADHAAR_VERIFICATION: 451,
+    /** KYC completed / post-KYC success – open KYCSuccess (Pay Now) */
+    KYC_SUCCESS: 446,
+} as const;
+
+// Workflow Task Constants
+export const WORKFLOW_TASKS = {
+    RESEND_OTP: 11045,
+    VALIDATE_OTP: 11047,
+} as const;
+
+// Type definitions for TypeScript
+export type WorkflowState = typeof WORKFLOW_STATES[keyof typeof WORKFLOW_STATES];
+export type WorkflowTask = typeof WORKFLOW_TASKS[keyof typeof WORKFLOW_TASKS];
+
+// Helper function to get workflow state name
+export const getWorkflowStateName = (stateId: number): string | undefined => {
+    const entry = Object.entries(WORKFLOW_STATES).find(([_, value]) => value === stateId);
+    return entry ? entry[0] : undefined;
+};
+
+// Helper function to get workflow task name
+export const getWorkflowTaskName = (taskId: number): string | undefined => {
+    const entry = Object.entries(WORKFLOW_TASKS).find(([_, value]) => value === taskId);
+    return entry ? entry[0] : undefined;
+};
+
+// Export all as a single object for convenience
+export const WORKFLOW_CONSTANTS = {
+    STATES: WORKFLOW_STATES,
+    TASKS: WORKFLOW_TASKS,
+} as const;
+
+export default WORKFLOW_CONSTANTS;
+

package/src/constants/strings/README.md

@@ -0,0 +1,146 @@
+# String Constants
+
+This folder contains all string literals and text constants used throughout the FD SDK application. This approach provides better maintainability, consistency, and makes it easier to update text across the application.
+
+## Folder Structure
+
+```
+src/constants/strings/
+├── common.ts          # Common strings used across the app
+├── login.ts           # Login and authentication strings
+├── home.ts            # Home screen and navigation strings
+├── kyc.ts             # KYC and verification strings
+├── employee.ts        # Employee and occupation strings
+├── bank.ts            # Bank and payment strings
+├── nominee.ts         # Nominee related strings
+├── fd.ts              # Fixed Deposit related strings
+├── index.ts           # Central export file
+└── README.md          # This documentation
+```
+
+## Usage
+
+### Import Individual String Groups
+
+```typescript
+import { COMMON_STRINGS, KYC_STRINGS } from '../constants/strings';
+
+// Use in components
+<Text>{COMMON_STRINGS.CONTINUE}</Text>
+<Text>{KYC_STRINGS.PAN_CARD_LABEL}</Text>
+```
+
+### Import All Strings
+
+```typescript
+import { COMMON_STRINGS, KYC_STRINGS, EMPLOYEE_STRINGS } from '../constants/strings';
+```
+
+### Import from Index
+
+```typescript
+import { COMMON_STRINGS, KYC_STRINGS } from '../constants/strings/index';
+```
+
+## String Categories
+
+### Common Strings (`common.ts`)
+- Button labels (Continue, Save, Cancel, etc.)
+- Status messages (Success, Error, Failed, etc.)
+- Validation messages
+- General UI text
+
+### Login Strings (`login.ts`)
+- Login form labels and placeholders
+- Authentication messages
+- Password reset flow
+- OTP verification
+
+### Home Strings (`home.ts`)
+- Navigation items
+- Welcome messages
+- Quick actions
+- Status indicators
+
+### KYC Strings (`kyc.ts`)
+- KYC form labels and placeholders
+- Verification messages
+- Marital status options
+- Validation messages
+
+### Employee Strings (`employee.ts`)
+- Occupation form labels
+- Income options
+- Source of fund options
+- Politically exposed person options
+
+### Bank Strings (`bank.ts`)
+- Bank account form labels
+- Account types
+- Payment status messages
+- IFSC verification
+
+### Nominee Strings (`nominee.ts`)
+- Nominee form labels
+- Relationship options
+- Title options
+- Nomination instructions
+
+### FD Strings (`fd.ts`)
+- FD calculator labels
+- Deposit schemes
+- Tenure options
+- Maturity instructions
+
+## Benefits
+
+1. **Consistency**: All text is centralized and consistent across the app
+2. **Maintainability**: Easy to update text without searching through multiple files
+3. **Type Safety**: TypeScript provides autocomplete and type checking
+4. **Reusability**: Strings can be reused across different components
+5. **Organization**: Related strings are grouped logically
+6. **Future Localization**: Easy to add localization support later
+
+## Best Practices
+
+1. **Use Descriptive Names**: String keys should clearly indicate their purpose
+2. **Group Related Strings**: Keep related strings in the same file
+3. **Use Constants**: All strings are exported as const for immutability
+4. **Consistent Naming**: Use UPPER_SNAKE_CASE for string keys
+5. **Add New Strings**: When adding new strings, place them in the appropriate category file
+
+## Adding New Strings
+
+1. Identify the appropriate category file
+2. Add the new string with a descriptive key
+3. Export it in the index.ts file if needed
+4. Use the string in your components
+
+Example:
+```typescript
+// In kyc.ts
+export const KYC_STRINGS = {
+  // ... existing strings
+  NEW_FIELD_LABEL: 'New Field Label',
+} as const;
+```
+
+## Migration Guide
+
+To migrate existing hardcoded strings:
+
+1. Find hardcoded strings in your components
+2. Add them to the appropriate string file
+3. Import the string constant
+4. Replace the hardcoded string with the constant
+
+Before:
+```typescript
+<Text>Continue</Text>
+```
+
+After:
+```typescript
+import { COMMON_STRINGS } from '../constants/strings';
+<Text>{COMMON_STRINGS.CONTINUE}</Text>
+```