🏛️ Federal Module - TypeScript Functions Documentation

/**
 * Component initialization with user context, form setup, and federal question loading
 * Initializes the federal compliance component with user session data
 * Creates reactive form for federal questions
 * Sets up user access controls based on verification status
 * Loads federal questions from the API
 * @returns {void}
 */
ngOnInit(): void

/**
 * Retrieves user details and determines KYC verification status for federal access
 * Fetches user details to check KYC verification status
 * Sets appropriate status colors and labels
 * Redirects to KYC if unverified, or loads federal PDF data if verified
 * @returns {void}
 */
getUserDetail(): void

/**
 * Handles federal questionnaire response changes and conditional question display
 * Updates form control values based on user responses
 * Manages conditional display of sub-questions
 * Handles validation state for nested federal questions
 * @param {string} check - Response value ('Yes' or 'No')
 * @param {string} Id - Form control identifier
 * @param {string} Qus - Question type ('QusOut' or 'QusIn')
 * @returns {void}
 */
changeStatus(check: string, Id: string, Qus: string): void

/**
 * Validates and submits federal compliance form data
 * Validates federal form including conditional questions
 * Submits federal compliance data to server
 * Handles success/error responses with appropriate user feedback and navigation
 * @returns {void}
 */
saveFederal(): void

/**
 * Initializes HTML5 canvas for digital signature capture
 * Sets up canvas element with device pixel ratio support
 * Configures drawing context and styles
 * Attaches mouse and touch event listeners for signature drawing functionality
 * @returns {Promise<void>}
 */
init(): Promise<void>

/**
 * Draws signature lines on the canvas between coordinates
 * Creates continuous drawing lines on the signature canvas
 * Connects previous position to current position using canvas drawing context
 * @param {number} x - Current X coordinate
 * @param {number} y - Current Y coordinate
 * @returns {void}
 */
draw(x: number, y: number): void

/**
 * Converts canvas signature to data URL and updates form
 * Validates that signature canvas is not empty
 * Converts canvas drawing to base64 data URL
 * Updates form control with signature data, closes signature modal
 * @returns {Promise<void>}
 */
saveSignature(): Promise<void>

/**
 * Checks if the signature canvas has any drawing content
 * Validates signature canvas to ensure user has provided a signature before allowing form submission
 * @returns {boolean} True if canvas is empty, false if has content
 */
isCanvasEmpty(): boolean

/**
 * Displays signature modal and initializes canvas
 * Opens signature capture modal
 * Initializes canvas after DOM rendering delay
 * Resets error display state for signature validation
 * @returns {void}
 */
showModel(): void

/**
 * Loads existing federal PDF data and populates form
 * Retrieves federal compliance data for current user
 * Populates form fields with existing responses
 * Handles conditional question display based on saved answers
 * Manages navigation to federal details if already submitted
 * @returns {void}
 */
getFederalPdf(): void

/**
 * Component initialization with route parameter handling and data loading
 * Initializes PDF component with user session data
 * Processes route parameters for admin user viewing
 * Determines appropriate user context (admin or self)
 * Loads all federal data for display
 * @returns {void}
 */
ngOnInit(): void

/**
 * Retrieves user details for PDF display and admin verification
 * Fetches user information for PDF context
 * Determines user access levels and permissions
 * Sets up appropriate display data for federal compliance viewing
 * @returns {void}
 */
getUserDetail(): void

/**
 * Retrieves comprehensive federal compliance data for display
 * Loads all federal questions and responses
 * Fetches submission status and timestamps
 * Organizes data for PDF rendering and admin review
 * @returns {void}
 */
getAllFederalData(): void

/**
 * Admin function to verify federal compliance submission
 * Updates federal status to verified state
 * Triggers notification to user about verification
 * Handles success/error responses and navigation
 * @returns {void}
 */
verifyFederal(): void

/**
 * Admin function to reject federal compliance submission
 * Updates federal status to rejected state
 * Sends rejection notification to user
 * Manages workflow state and provides admin feedback
 * @returns {void}
 */
rejectFederal(): void

/**
 * Admin function to cancel federal compliance submission
 * Updates federal status to cancelled state
 * Handles administrative cancellation workflow
 * Provides appropriate feedback and navigation
 * @returns {void}
 */
cancelFederal(): void

/**
 * Generates PDF document from federal compliance data
 * Formats federal questions and responses for PDF output
 * Includes digital signature and compliance status
 * Handles PDF creation and download functionality
 * @returns {void}
 */
generatePdf(): void

/**
 * Handles PDF download with proper file naming and format
 * Creates download link with user-specific filename
 * Manages browser download functionality
 * Provides download confirmation and error handling
 * @returns {void}
 */
downloadPdf(): void

/**
 * Retrieves federal compliance questions from API
 * Fetches Do Not Call registry questionnaire
 * Handles question ordering and conditional logic setup
 * Returns Observable with federal questions data
 * @returns {Observable<any>} Federal questions response
 */
getFederalQuestions(): Observable<any>

/**
 * Submits federal compliance form data to API
 * Sends questionnaire responses and digital signature
 * Handles form validation and data formatting
 * Returns submission status and confirmation
 * @param {any} federalData - Complete federal compliance data
 * @returns {Observable<any>} Submission response
 */
submitFederalCompliance(federalData: any): Observable<any>

/**
 * Retrieves current federal compliance status for user
 * Checks submission state and verification status
 * Returns detailed status information for UI display
 * Handles admin and user permission contexts
 * @param {string} userId - User identifier for status check
 * @returns {Observable<any>} Federal status data
 */
getFederalStatus(userId: string): Observable<any>

/**
 * Updates federal compliance status (verify/reject/cancel)
 * Handles administrative status changes
 * Manages workflow state transitions
 * Triggers appropriate notifications and logging
 * @param {string} userId - Target user identifier
 * @param {string} status - New status value
 * @param {string} notes - Administrative notes
 * @returns {Observable<any>} Status update response
 */
updateFederalStatus(userId: string, status: string, notes: string): Observable<any>

/**
 * Generates federal compliance PDF document via API
 * Processes federal data into formatted document
 * Handles PDF template rendering and styling
 * Returns PDF blob or download link
 * @param {any} federalData - Federal compliance data for PDF
 * @returns {Observable<Blob>} PDF document blob
 */
generateCompliancePdf(federalData: any): Observable<Blob>

/**
 * Uploads digital signature data to secure storage
 * Handles base64 signature data processing
 * Manages secure file storage and retrieval
 * Returns signature storage confirmation
 * @param {string} signatureData - Base64 encoded signature
 * @param {string} userId - User identifier for signature association
 * @returns {Observable<any>} Upload confirmation response
 */
uploadSignature(signatureData: string, userId: string): Observable<any>