import type { Modules } from '../config/index.js'; import type { Applicant } from '../common/shared/models/Applicant'; import type { Document } from '../common/shared/models/Document'; import { React_Form_IDS } from './vendors/react/types/pages.type'; import type { FormModule, FormRecipeOptions } from './definition'; import type { LegacyUIResultPayload, LegacyUIScreenPayload } from './vendors/legacy/legacyUIEvents.types'; import type { PartialDeep } from 'type-fest'; type Vendor = FormModule['vendorName']; export type EventPayload = { componentName?: Modules['moduleName']; provider?: Vendor; inputInfo: TInputInfo; }; /** * Event mapping for each screen, * ready: when the screen is ready to be displayed * loaded: when the screen is loaded * failed: when the screen failed to load */ export type ScreenEventType = { ready: keyof FormEvents; loaded: keyof FormEvents; failed: keyof FormEvents; success?: keyof FormEvents; partial?: keyof FormEvents; pending?: keyof FormEvents; timeout?: keyof FormEvents; back?: keyof FormEvents; navigate?: keyof FormEvents; info?: keyof FormEvents; }; type FormEventKeyType = `form:${React_Form_IDS}:${keyof ScreenEventType}`; export declare const FORM_WELCOME_READY: FormEventKeyType; export declare const FORM_WELCOME_LOADED: FormEventKeyType; export declare const FORM_WELCOME_FAILED: FormEventKeyType; export declare const FORM_CONSENT_READY: FormEventKeyType; export declare const FORM_CONSENT_LOADED: FormEventKeyType; export declare const FORM_CONSENT_FAILED: FormEventKeyType; export declare const FORM_DOCUMENT_READY: FormEventKeyType; export declare const FORM_DOCUMENT_LOADED: FormEventKeyType; export declare const FORM_DOCUMENT_FAILED: FormEventKeyType; export declare const FORM_DOCUMENT_BACK: FormEventKeyType; export declare const FORM_DOCUMENT_NAVIGATE: FormEventKeyType; export declare const FORM_REVIEW_READY: FormEventKeyType; export declare const FORM_REVIEW_LOADED: FormEventKeyType; export declare const FORM_REVIEW_FAILED: FormEventKeyType; export declare const FORM_REVIEW_SUCCESS: FormEventKeyType; export declare const FORM_REVIEW_PARTIAL: FormEventKeyType; export declare const FORM_REVIEW_PENDING: FormEventKeyType; export declare const FORM_REVIEW_ADDRESS_SELECTED: "form:review:address_selected"; export declare const FORM_REVIEW_ADDRESS_MANUAL: "form:review:address_manual"; export declare const FORM_REVIEW_ADDRESS_NO_RESULTS: "form:review:address_no_results"; export type AddressTelemetryPayload = { country: string | null; }; export declare const FORM_PERSONAL_DETAILS_READY: FormEventKeyType; export declare const FORM_PERSONAL_DETAILS_LOADED: FormEventKeyType; export declare const FORM_PERSONAL_DETAILS_FAILED: FormEventKeyType; export declare const FORM_RESULT_READY: FormEventKeyType; export declare const FORM_RESULT_LOADED: FormEventKeyType; export declare const FORM_RESULT_FAILED: FormEventKeyType; export declare const FORM_RESULT_SUCCESS: FormEventKeyType; export declare const FORM_RESULT_PARTIAL: FormEventKeyType; export declare const FORM_RESULT_PENDING: FormEventKeyType; export declare const FORM_RESULT_INFO: FormEventKeyType; export declare const FORM_RESULT_TIMEOUT: FormEventKeyType; export declare const FORM_RETRY_READY: FormEventKeyType; export declare const FORM_RETRY_LOADED: FormEventKeyType; export declare const FORM_RETRY_FAILED: FormEventKeyType; export declare const FORM_DOC_UPLOAD_READY: FormEventKeyType; export declare const FORM_DOC_UPLOAD_LOADED: FormEventKeyType; export declare const FORM_DOC_UPLOAD_SUCCESS: FormEventKeyType; export declare const FORM_DOC_UPLOAD_FAILED: FormEventKeyType; export declare const FORM_DOC_UPLOAD_NAVIGATE: FormEventKeyType; export declare const FORM_START_READY: FormEventKeyType; export declare const FORM_START_LOADED: FormEventKeyType; export declare const FORM_START_FAILED: FormEventKeyType; export declare const FORM_REQUIRED_DOCUMENTS_READY: FormEventKeyType; export declare const FORM_REQUIRED_DOCUMENTS_LOADED: FormEventKeyType; export declare const FORM_REQUIRED_DOCUMENTS_FAILED: FormEventKeyType; export declare const FORM_PARTIAL_DOCUMENTS_READY: FormEventKeyType; export declare const FORM_PARTIAL_DOCUMENTS_LOADED: FormEventKeyType; export declare const FORM_PARTIAL_DOCUMENTS_FAILED: FormEventKeyType; export declare const FORM_OPTIONAL_DOCUMENTS_READY: FormEventKeyType; export declare const FORM_OPTIONAL_DOCUMENTS_LOADED: FormEventKeyType; export declare const FORM_OPTIONAL_DOCUMENTS_FAILED: FormEventKeyType; export declare const FORM_VERIFICATION_METHOD_SELECTION_READY: FormEventKeyType; export declare const FORM_VERIFICATION_METHOD_SELECTION_LOADED: FormEventKeyType; export declare const FORM_VERIFICATION_METHOD_SELECTION_FAILED: FormEventKeyType; export type FormEvents = { loaded: [{ domElement: HTMLElement; provider: string; }]; ready: [ { domElement: HTMLElement; config: PartialDeep; } ]; [FORM_WELCOME_READY]: [EventPayload]; [FORM_WELCOME_LOADED]: [EventPayload]; [FORM_WELCOME_FAILED]: [EventPayload]; [FORM_CONSENT_READY]: [EventPayload]; [FORM_CONSENT_LOADED]: [EventPayload]; [FORM_CONSENT_FAILED]: [EventPayload]; [FORM_DOCUMENT_READY]: [EventPayload]; [FORM_DOCUMENT_LOADED]: [EventPayload]; [FORM_DOCUMENT_FAILED]: [EventPayload]; [FORM_DOCUMENT_BACK]: [EventPayload]; [FORM_DOCUMENT_NAVIGATE]: [EventPayload]; [FORM_REVIEW_READY]: [EventPayload]; [FORM_REVIEW_LOADED]: [EventPayload]; [FORM_REVIEW_FAILED]: [EventPayload]; [FORM_REVIEW_SUCCESS]: [EventPayload]; [FORM_REVIEW_PARTIAL]: [EventPayload]; [FORM_REVIEW_PENDING]: [EventPayload]; [FORM_REVIEW_ADDRESS_SELECTED]: [AddressTelemetryPayload]; [FORM_REVIEW_ADDRESS_MANUAL]: [AddressTelemetryPayload]; [FORM_REVIEW_ADDRESS_NO_RESULTS]: [AddressTelemetryPayload]; [FORM_PERSONAL_DETAILS_READY]: [EventPayload]; [FORM_PERSONAL_DETAILS_LOADED]: [EventPayload]; [FORM_PERSONAL_DETAILS_FAILED]: [EventPayload]; [FORM_RESULT_READY]: [EventPayload]; [FORM_RESULT_LOADED]: [EventPayload]; [FORM_RESULT_FAILED]: [EventPayload]; [FORM_RESULT_SUCCESS]: [EventPayload]; [FORM_RESULT_PARTIAL]: [EventPayload]; [FORM_RESULT_PENDING]: [EventPayload]; [FORM_RESULT_INFO]: [EventPayload]; [FORM_RESULT_TIMEOUT]: [EventPayload]; [FORM_RETRY_READY]: [EventPayload]; [FORM_RETRY_LOADED]: [EventPayload]; [FORM_RETRY_FAILED]: [EventPayload]; [FORM_DOC_UPLOAD_READY]: [EventPayload]; [FORM_DOC_UPLOAD_LOADED]: [EventPayload]; [FORM_DOC_UPLOAD_SUCCESS]: [EventPayload]; [FORM_DOC_UPLOAD_FAILED]: [EventPayload]; [FORM_DOC_UPLOAD_NAVIGATE]: [EventPayload]; [FORM_START_READY]: [EventPayload]; [FORM_START_LOADED]: [EventPayload]; [FORM_START_FAILED]: [EventPayload]; [FORM_REQUIRED_DOCUMENTS_READY]: [EventPayload]; [FORM_REQUIRED_DOCUMENTS_LOADED]: [EventPayload]; [FORM_REQUIRED_DOCUMENTS_FAILED]: [EventPayload]; [FORM_PARTIAL_DOCUMENTS_READY]: [EventPayload]; [FORM_PARTIAL_DOCUMENTS_LOADED]: [EventPayload]; [FORM_PARTIAL_DOCUMENTS_FAILED]: [EventPayload]; [FORM_OPTIONAL_DOCUMENTS_READY]: [EventPayload]; [FORM_OPTIONAL_DOCUMENTS_LOADED]: [EventPayload]; [FORM_OPTIONAL_DOCUMENTS_FAILED]: [EventPayload]; [FORM_VERIFICATION_METHOD_SELECTION_FAILED]: [EventPayload]; [FORM_VERIFICATION_METHOD_SELECTION_LOADED]: [EventPayload]; [FORM_VERIFICATION_METHOD_SELECTION_READY]: [ EventPayload<{ vendor: string; product: string; }> ]; 'form:document_type_select:ready': [LegacyUIScreenPayload]; 'form:drivers_license_input:ready': [LegacyUIScreenPayload]; 'form:national_id:ready': [LegacyUIScreenPayload]; 'form:medicare_input:ready': [LegacyUIScreenPayload]; 'form:passport_input:ready': [LegacyUIScreenPayload]; 'form:name_input:ready': [LegacyUIScreenPayload]; 'form:dob_input:ready': [LegacyUIScreenPayload]; 'form:address_input:ready': [LegacyUIScreenPayload]; 'form:details_summary:ready': [LegacyUIScreenPayload]; 'form:failure:ready': [LegacyUIScreenPayload]; 'form:success:ready': [LegacyUIScreenPayload]; 'form:no_match:ready': [LegacyUIScreenPayload]; 'form:pending_verification:ready': [LegacyUIScreenPayload]; 'form:error:ready': [LegacyUIScreenPayload]; 'form:name_input_check:ready': [LegacyUIScreenPayload]; 'form:dob_input_check:ready': [LegacyUIScreenPayload]; 'form:manual_address_input:ready': [LegacyUIScreenPayload]; 'form:additional_address_input:ready': [LegacyUIScreenPayload]; 'form:address_input_check:ready': [LegacyUIScreenPayload]; results: [ LegacyUIResultPayload | { documents: Document[]; applicant: Applicant; entityId: string | null; } ]; destroy: []; navigation: [{ page: string; }]; builtin_loaded: EventPayload[]; builtin_ready: EventPayload[]; builtin_failed_loading: { message?: string; }[]; }; export declare const FormTelemetryDict: Record; /** * Events whose payload is forwarded as telemetry `data`. Every other form * event is forwarded name-only, as before, so existing telemetry is unchanged. */ export declare const FORM_TELEMETRY_PAYLOAD_EVENTS: ReadonlySet; export declare const screenEventMaps: Partial>; export {}; //# sourceMappingURL=events.d.ts.map