@sheerid/jslib 1.85.0 → 1.88.0

package/src/lib/types/types.d.ts

@@ -1,5 +1,5 @@
-import { Dispatch, Store } from 'redux';
-import { InjectedIntl } from 'react-intl';
+import { Dispatch, Store } from "redux";
+import { InjectedIntl } from "react-intl";
 declare global {
     interface String {
         insertAt: any;
@@ -34,6 +34,7 @@ export interface SheerIdJsApi {
     postVerificationSizeUpdates(options: PostMessagesOptions): void;
     getMessages(locale: Locale, programThemeMessages?: ProgramThemeMessages, segment?: Segment): Promise<StringMap>;
     collectDeviceProfile(verificationId: string, programId: string): void;
+    isInLightbox: () => boolean;
 }
 export interface RequestOrganizationApi {
     RequestOrganizationForm: new (element: HTMLElement, programId: DatabaseId) => void;
@@ -138,9 +139,9 @@ export declare type Options = {
     urlLicensedProfessionalFaq?: string;
     urlAddSchoolFaq?: string;
     urlAddSchoolForm?: string;
-    customCss?: ProgramTheme['customCss'];
-    logoUrl?: ProgramTheme['logoUrl'];
-    privacyPolicyUrl?: ProgramTheme['privacyPolicyUrl'];
+    customCss?: ProgramTheme["customCss"];
+    logoUrl?: ProgramTheme["logoUrl"];
+    privacyPolicyUrl?: ProgramTheme["privacyPolicyUrl"];
     cookies?: CookieOptions;
     useFingerprinting?: boolean;
     marketConsent?: MarketConsentOptions;
@@ -164,7 +165,7 @@ export declare type CookieOptions = {
     enabled: boolean;
     path?: string;
     domain?: string;
-    sameSite?: 'lax' | 'strict' | 'none';
+    sameSite?: "lax" | "strict" | "none";
 };
 export declare type MarketConsentOptions = {
     enabled: boolean;
@@ -212,7 +213,7 @@ export declare type PostMessagesOptions = {
 export declare type ConversionResources = {
     base: string;
 };
-export declare type LogLevel = 'info' | 'log' | 'warn' | 'error';
+export declare type LogLevel = "info" | "log" | "warn" | "error";
 /**
  * @description Interface for individual field instances, such as BirthdateField
  * @example new sheerid.BirthdateField().setValue('2000-01-01');
@@ -249,14 +250,14 @@ export declare type DischargeDate = string;
 /**
  * @description TODO
  */
-export declare type MilitaryStatus = 'ACTIVE_DUTY' | 'VETERAN' | 'RESERVIST' | 'MILITARY_RETIREE' | 'MILITARY_FAMILY';
+export declare type MilitaryStatus = "ACTIVE_DUTY" | "VETERAN" | "RESERVIST" | "MILITARY_RETIREE" | "MILITARY_FAMILY";
 /**
  * @description TODO
  */
-export declare type FirstResponderStatus = 'FIREFIGHTER' | 'EMT' | 'POLICE';
-export declare type MedicalProfessionalStatus = 'NURSE' | 'DOCTOR' | 'DENTIST' | 'PHARMACIST' | 'OTHER_HEALTH_WORKER';
-export declare type LicensedProfessionalStatus = 'LICENSED_COSMETOLOGIST' | 'LICENSED_REAL_ESTATE_AGENT' | 'VETERINARIAN';
-export declare type RecentMoverStatus = 'HOME_BUYER' | 'OTHER_MOVER';
+export declare type FirstResponderStatus = "FIREFIGHTER" | "EMT" | "POLICE";
+export declare type MedicalProfessionalStatus = "NURSE" | "DOCTOR" | "DENTIST" | "PHARMACIST" | "OTHER_HEALTH_WORKER";
+export declare type LicensedProfessionalStatus = "LICENSED_COSMETOLOGIST" | "LICENSED_REAL_ESTATE_AGENT" | "VETERINARIAN";
+export declare type RecentMoverStatus = "HOME_BUYER" | "OTHER_MOVER";
 /**
  * @description TODO
  */
@@ -268,7 +269,7 @@ export declare type OrganizationName = string;
 /**
  * @description All possible fields
  */
-export declare type FieldId = 'firstName' | 'lastName' | 'memberId' | 'organization' | 'birthDate' | 'email' | 'phoneNumber' | 'postalCode' | 'address1' | 'city' | 'state' | 'dischargeDate' | 'status' | 'statuses' | 'docUpload' | 'country' | 'smsCode' | 'socialSecurityNumber' | 'marketConsentValue' | 'carrierConsentValue' | 'driverLicenseNumber';
+export declare type FieldId = "firstName" | "lastName" | "memberId" | "organization" | "birthDate" | "email" | "phoneNumber" | "postalCode" | "address1" | "city" | "state" | "dischargeDate" | "status" | "statuses" | "docUpload" | "country" | "smsCode" | "socialSecurityNumber" | "marketConsentValue" | "carrierConsentValue" | "driverLicenseNumber";
 export declare type FormValidationOptions = {
     minAge?: number;
     maxAge?: number;
@@ -308,7 +309,7 @@ export declare type Organization = {
 /**
  * @private
  */
-export declare type OrganizationRemoteSource = 'EMPLOYER';
+export declare type OrganizationRemoteSource = "EMPLOYER";
 /**
  * @private
  */
@@ -356,23 +357,23 @@ export interface InputSelectComponentProps {
     label?: string | JSX.Element;
     intl: InjectedIntl;
 }
-export declare type ErrorId = 'apiRateLimitExceeded' | 'dischargeDateBeforeBirthDate' | 'docReviewLimitExceeded' | 'inactiveProgram' | 'expiredProgram' | 'expiredEmailLoopToken' | 'expiredSMSCode' | 'expiredVerification' | 'fraudRulesReject' | 'futureBirthDate' | 'futureDischargeDate' | 'internalServerError' | 'invalidAddress' | 'invalidApiToken' | 'invalidBirthDate' | 'invalidCity' | 'invalidCountry' | 'invalidDischargeDate' | 'invalidDocUploadToken' | 'invalidEmail' | 'invalidFileSizeEmpty' | 'invalidFileSizeMax' | 'invalidFirstName' | 'invalidFirstResponderStatus' | 'invalidLastName' | 'invalidMemberId' | 'invalidMilitaryStatus' | 'invalidNumberOfFiles' | 'invalidOptIn' | 'invalidOrganization' | 'invalidPhoneNumber' | 'invalidPostalCode' | 'invalidProgram' | 'invalidRequest' | 'invalidSMSCode' | 'invalidSocialSecurityNumber' | 'invalidState' | 'invalidStatus' | 'invalidStatuses' | 'invalidDriverLicenseNumber' | 'invalidStep' | 'marketConsentRequired' | 'maxMetadataLengthExceeded' | 'maxMetadataValuesExceeded' | 'maxSMSCodeLimitExceeded' | 'incorrectSMSCodeAttemptLimitExceeded' | 'noProgram' | 'noRemainingRewardCodes' | 'notApproved' | 'notFound' | 'noValidFiles' | 'noVerification' | 'outsideAgePerson' | 'simulatedError' | 'unauthorizedDomain' | 'underagePerson' | 'unknownError' | 'unsupportedDocMimeType' | 'verificationLimitExceeded' | 'invalidEmailLoopToken' | NetworkErrorId;
-export declare type NetworkErrorId = 'failedToFetch' | 'requestTimeout';
+export declare type ErrorId = "apiRateLimitExceeded" | "dischargeDateBeforeBirthDate" | "docReviewLimitExceeded" | "inactiveProgram" | "expiredProgram" | "expiredEmailLoopToken" | "expiredSMSCode" | "expiredVerification" | "fraudRulesReject" | "futureBirthDate" | "futureDischargeDate" | "internalServerError" | "invalidAddress" | "invalidApiToken" | "invalidBirthDate" | "invalidCity" | "invalidCountry" | "invalidDischargeDate" | "invalidDocUploadToken" | "invalidEmail" | "invalidFileSizeEmpty" | "invalidFileSizeMax" | "invalidFirstName" | "invalidFirstResponderStatus" | "invalidLastName" | "invalidMemberId" | "invalidMilitaryStatus" | "invalidNumberOfFiles" | "invalidOptIn" | "invalidOrganization" | "invalidPhoneNumber" | "invalidPostalCode" | "invalidProgram" | "invalidRequest" | "invalidSMSCode" | "invalidSocialSecurityNumber" | "invalidState" | "invalidStatus" | "invalidStatuses" | "invalidDriverLicenseNumber" | "invalidStep" | "marketConsentRequired" | "maxMetadataLengthExceeded" | "maxMetadataValuesExceeded" | "maxSMSCodeLimitExceeded" | "incorrectSMSCodeAttemptLimitExceeded" | "noProgram" | "noRemainingRewardCodes" | "notApproved" | "notFound" | "noValidFiles" | "noVerification" | "outsideAgePerson" | "simulatedError" | "unauthorizedDomain" | "underagePerson" | "unknownError" | "unsupportedDocMimeType" | "verificationLimitExceeded" | "invalidEmailLoopToken" | NetworkErrorId;
+export declare type NetworkErrorId = "failedToFetch" | "requestTimeout";
 export declare type ExtendedErrorId = string | undefined;
-export declare type RejectionReasons = 'DOCUMENT_UNREADABLE' | 'DOCUMENT_PASSWORD_PROTECTED' | 'DOCUMENT_LIKELY_FRAUD' | 'DOCUMENT_UNSUPPORTED' | 'DOCUMENT_HANDWRITTEN' | 'MISSING_INFORMATION' | 'MISSING_INFORMATION_PERSON_NAME' | 'MISSING_INFORMATION_ORGANIZATION_NAME' | 'DOCUMENT_EXPIRED' | 'DOCUMENT_OUTDATED' | 'MISMATCH_PERSON_NAME' | 'MISMATCH_ORGANIZATION' | 'MISMATCH_STATUS' | 'INELIGIBLE_ORGANIZATION' | 'MISSING_INFORMATION_UNIVERSITY_ENROLLMENT' | 'INELIGIBLE_PERSON_HIGH_SCHOOL_STUDENT' | 'MISSING_INFORMATION_AFFILIATION_US_ARMED_FORCES' | 'MISMATCH_COMPANY_NAME_OR_ADDRESS' | 'PAYSTUB_OUTDATED_LAST_30_DAYS' | 'MISSING_INFORMATION_BIRTHDATE' | 'MISMATCH_BIRTHDATE' | 'DOCUMENT_OUTDATED_FACULTY' | 'MISSING_OR_MISMATCH_JOB_TITLE' | 'OTHER_CONTACT_US';
-export declare type VerificationStep = 'collectStudentPersonalInfo' | 'collectTeacherPersonalInfo' | 'collectMemberPersonalInfo' | 'collectMilitaryStatus' | 'collectActiveMilitaryPersonalInfo' | 'collectInactiveMilitaryPersonalInfo' | 'collectSeniorPersonalInfo' | 'collectAgePersonalInfo' | 'collectFirstResponderPersonalInfo' | 'collectMedicalProfessionalPersonalInfo' | 'collectEmployeePersonalInfo' | 'collectDriverLicensePersonalInfo' | 'collectGeneralIdentityPersonalInfo' | 'collectHybridIdentityPersonalInfo' | 'collectLicensedProfessionalPersonalInfo' | 'collectMoverPersonalInfo' | 'collectSocialSecurityNumber' | 'cancelSocialSecurityNumber' | 'docUpload' | 'pending' | 'docReviewLimitExceeded' | 'success' | 'error' | 'sso' | 'smsLoop' | 'emailLoop' | 'cancelEmailLoop';
+export declare type RejectionReasons = "DOCUMENT_UNREADABLE" | "DOCUMENT_PASSWORD_PROTECTED" | "DOCUMENT_LIKELY_FRAUD" | "DOCUMENT_UNSUPPORTED" | "DOCUMENT_HANDWRITTEN" | "MISSING_INFORMATION" | "MISSING_INFORMATION_PERSON_NAME" | "MISSING_INFORMATION_ORGANIZATION_NAME" | "DOCUMENT_EXPIRED" | "DOCUMENT_OUTDATED" | "MISMATCH_PERSON_NAME" | "MISMATCH_ORGANIZATION" | "MISMATCH_STATUS" | "INELIGIBLE_ORGANIZATION" | "MISSING_INFORMATION_UNIVERSITY_ENROLLMENT" | "INELIGIBLE_PERSON_HIGH_SCHOOL_STUDENT" | "MISSING_INFORMATION_AFFILIATION_US_ARMED_FORCES" | "MISMATCH_COMPANY_NAME_OR_ADDRESS" | "PAYSTUB_OUTDATED_LAST_30_DAYS" | "MISSING_INFORMATION_BIRTHDATE" | "MISMATCH_BIRTHDATE" | "DOCUMENT_OUTDATED_FACULTY" | "MISSING_OR_MISMATCH_JOB_TITLE" | "OTHER_CONTACT_US";
+export declare type VerificationStep = "collectStudentPersonalInfo" | "collectTeacherPersonalInfo" | "collectMemberPersonalInfo" | "collectMilitaryStatus" | "collectActiveMilitaryPersonalInfo" | "collectInactiveMilitaryPersonalInfo" | "collectSeniorPersonalInfo" | "collectAgePersonalInfo" | "collectFirstResponderPersonalInfo" | "collectMedicalProfessionalPersonalInfo" | "collectEmployeePersonalInfo" | "collectDriverLicensePersonalInfo" | "collectGeneralIdentityPersonalInfo" | "collectHybridIdentityPersonalInfo" | "collectLicensedProfessionalPersonalInfo" | "collectMoverPersonalInfo" | "collectSocialSecurityNumber" | "cancelSocialSecurityNumber" | "docUpload" | "pending" | "docReviewLimitExceeded" | "success" | "error" | "sso" | "smsLoop" | "emailLoop" | "cancelEmailLoop";
 export declare type VerificationStepMap<T> = {
     [P in VerificationStep]: T;
 };
-export declare type MockStep = VerificationStep | 'loading';
-export declare type OverrideableComponentName = 'StepStudentPersonalInfoComponent' | 'StepSeniorPersonalInfoComponent' | 'StepAgePersonalInfoComponent' | 'StepTeacherPersonalInfoComponent' | 'StepMemberPersonalInfoComponent' | 'StepCollectMilitaryStatusComponent' | 'StepActiveMilitaryPersonalInfoComponent' | 'StepInactiveMilitaryPersonalInfoComponent' | 'StepFirstResponderPersonalInfoComponent' | 'StepMedicalProfessionalPersonalInfoComponent' | 'StepEmploymentPersonalInfoComponent' | 'StepDriverLicensePersonalInfoComponent' | 'StepGeneralIdentityPersonalInfoComponent' | 'StepHybridIdentityPersonalInfoComponent' | 'StepLicensedProfessionalPersonalInfoComponent' | 'StepMoverPersonalInfoComponent' | 'StepSuccessComponent' | 'StepDocUploadComponent' | 'StepPendingComponent' | 'StepPendingEmailLoopComponent' | 'StepErrorComponent' | 'StepSSOComponent' | 'StepSMSLoopComponent' | 'StepEmailLoopComponent' | 'StepSocialSecurity' | 'RequestOrganizationSuccessComponent' | 'RequestOrganizationErrorComponent' | 'RequestOrganizationSearchComponent';
+export declare type MockStep = VerificationStep | "loading";
+export declare type OverrideableComponentName = "StepStudentPersonalInfoComponent" | "StepSeniorPersonalInfoComponent" | "StepAgePersonalInfoComponent" | "StepTeacherPersonalInfoComponent" | "StepMemberPersonalInfoComponent" | "StepCollectMilitaryStatusComponent" | "StepActiveMilitaryPersonalInfoComponent" | "StepInactiveMilitaryPersonalInfoComponent" | "StepFirstResponderPersonalInfoComponent" | "StepMedicalProfessionalPersonalInfoComponent" | "StepEmploymentPersonalInfoComponent" | "StepDriverLicensePersonalInfoComponent" | "StepGeneralIdentityPersonalInfoComponent" | "StepHybridIdentityPersonalInfoComponent" | "StepLicensedProfessionalPersonalInfoComponent" | "StepMoverPersonalInfoComponent" | "StepSuccessComponent" | "StepDocUploadComponent" | "StepPendingComponent" | "StepPendingEmailLoopComponent" | "StepErrorComponent" | "StepSSOComponent" | "StepSMSLoopComponent" | "StepEmailLoopComponent" | "StepSocialSecurity" | "RequestOrganizationSuccessComponent" | "RequestOrganizationErrorComponent" | "RequestOrganizationSearchComponent";
 export declare type StepComponent = React.FunctionComponent<{
     verificationService: VerificationService;
 }>;
-export declare type Segment = 'student' | 'military' | 'teacher' | 'member' | 'senior' | 'age' | 'firstResponder' | 'medical' | 'employment' | 'identity' | 'licensedProfessional' | 'recentMover';
-export declare type SubSegment = 'college' | 'highSchool' | 'police' | 'emt' | 'fireFighter' | 'nurse' | 'doctor' | 'driverLicense' | 'generalIdentity' | 'hybridIdentity' | 'licensedCosmetologists' | 'licensedRealState' | 'homeBuyer' | 'otherMover' | SubSegmentMilitary;
-export declare type SubSegmentMilitary = 'activeDuty' | 'reservist' | 'veteran' | 'retiree' | 'militaryFamily';
-export declare type OrganizationType = 'UNIVERSITY' | 'POST_SECONDARY' | 'MEMBERSHIP' | 'MILITARY' | 'FIRST_RESPONDER' | 'MEDICAL' | 'NON_PROFIT' | 'CORPORATE' | 'K12' | 'AGE_ID' | 'HIGH_SCHOOL' | 'NONE';
+export declare type Segment = "student" | "military" | "teacher" | "member" | "senior" | "age" | "firstResponder" | "medical" | "employment" | "identity" | "licensedProfessional" | "recentMover";
+export declare type SubSegment = "college" | "highSchool" | "police" | "emt" | "fireFighter" | "nurse" | "doctor" | "driverLicense" | "generalIdentity" | "hybridIdentity" | "licensedCosmetologists" | "licensedRealState" | "homeBuyer" | "otherMover" | SubSegmentMilitary;
+export declare type SubSegmentMilitary = "activeDuty" | "reservist" | "veteran" | "retiree" | "militaryFamily";
+export declare type OrganizationType = "UNIVERSITY" | "POST_SECONDARY" | "MEMBERSHIP" | "MILITARY" | "FIRST_RESPONDER" | "MEDICAL" | "NON_PROFIT" | "CORPORATE" | "K12" | "AGE_ID" | "HIGH_SCHOOL" | "NONE";
 export declare type NewVerificationRequest = {
     programId: DatabaseId;
     trackingId?: string;
@@ -540,7 +541,7 @@ export declare type SocialSecurityResponse = {
     verificationId: DatabaseId;
     submissionUrl: string;
     cancelUrl: string;
-    currentStep: 'collectSocialSecurityNumber';
+    currentStep: "collectSocialSecurityNumber";
     errorIds?: [ErrorId];
 } & WithLocaleAndCountryChoiceAndSegment;
 export declare type SocialSecurityViewModel = {
@@ -659,8 +660,8 @@ export declare type AllResponseTypes = PersonalInfoResponse | SSOResponse | DocU
  */
 export declare type StudentPersonalInfoResponse = {
     submissionUrl: string;
-    currentStep: 'collectStudentPersonalInfo';
-    segment: 'student';
+    currentStep: "collectStudentPersonalInfo";
+    segment: "student";
     subSegment: null;
     errorIds?: [ErrorId];
     instantMatchAttempts?: number;
@@ -670,8 +671,8 @@ export declare type StudentPersonalInfoResponse = {
  */
 export declare type SeniorPersonalInfoResponse = {
     submissionUrl: string;
-    currentStep: 'collectSeniorPersonalInfo';
-    segment: 'senior';
+    currentStep: "collectSeniorPersonalInfo";
+    segment: "senior";
     subSegment: null;
     errorIds?: [ErrorId];
     instantMatchAttempts?: number;
@@ -681,8 +682,8 @@ export declare type SeniorPersonalInfoResponse = {
  */
 export declare type AgePersonalInfoResponse = {
     submissionUrl: string;
-    currentStep: 'collectAgePersonalInfo';
-    segment: 'age';
+    currentStep: "collectAgePersonalInfo";
+    segment: "age";
     subSegment: null;
     errorIds?: [ErrorId];
     instantMatchAttempts?: number;
@@ -694,16 +695,16 @@ export declare type AgePersonalInfoResponse = {
  */
 export declare type TeacherPersonalInfoResponse = {
     submissionUrl: string;
-    currentStep: 'collectTeacherPersonalInfo';
-    segment: 'teacher';
+    currentStep: "collectTeacherPersonalInfo";
+    segment: "teacher";
     subSegment: null;
     errorIds?: [ErrorId];
     instantMatchAttempts?: number;
 } & VerificationResponse;
 export declare type MemberPersonalInfoResponse = {
     submissionUrl: string;
-    currentStep: 'collectMemberPersonalInfo';
-    segment: 'member';
+    currentStep: "collectMemberPersonalInfo";
+    segment: "member";
     subSegment: null;
     errorIds?: [ErrorId];
     instantMatchAttempts?: number;
@@ -713,8 +714,8 @@ export declare type MemberPersonalInfoResponse = {
  */
 export declare type MilitaryStatusResponse = {
     submissionUrl: string;
-    currentStep: 'collectMilitaryStatus';
-    segment: 'military';
+    currentStep: "collectMilitaryStatus";
+    segment: "military";
     errorIds?: [ErrorId];
     availableStatuses?: [MilitaryStatus];
 } & VerificationResponse;
@@ -723,8 +724,8 @@ export declare type MilitaryStatusResponse = {
  */
 export declare type ActiveMilitaryPersonalInfoResponse = {
     submissionUrl: string;
-    currentStep: 'collectActiveMilitaryPersonalInfo';
-    segment: 'military';
+    currentStep: "collectActiveMilitaryPersonalInfo";
+    segment: "military";
     errorIds?: [ErrorId];
     instantMatchAttempts?: number;
 } & VerificationResponse;
@@ -733,31 +734,31 @@ export declare type ActiveMilitaryPersonalInfoResponse = {
  */
 export declare type InactiveMilitaryPersonalInfoResponse = {
     submissionUrl: string;
-    currentStep: 'collectInactiveMilitaryPersonalInfo';
-    segment: 'military';
+    currentStep: "collectInactiveMilitaryPersonalInfo";
+    segment: "military";
     errorIds?: [ErrorId];
     instantMatchAttempts?: number;
 } & VerificationResponse;
 export declare type FirstResponderPersonalInfoResponse = {
     submissionUrl: string;
-    currentStep: 'collectFirstResponderPersonalInfo';
-    segment: 'firstResponder';
+    currentStep: "collectFirstResponderPersonalInfo";
+    segment: "firstResponder";
     errorIds?: [ErrorId];
     availableStatuses?: [FirstResponderStatus];
     instantMatchAttempts?: number;
 } & VerificationResponse;
 export declare type MedicalProfessionalPersonalInfoResponse = {
     submissionUrl: string;
-    currentStep: 'collectMedicalProfessionalPersonalInfo';
-    segment: 'medical';
+    currentStep: "collectMedicalProfessionalPersonalInfo";
+    segment: "medical";
     errorIds?: [ErrorId];
     availableStatuses?: [MedicalProfessionalStatus];
     instantMatchAttempts?: number;
 } & VerificationResponse;
 export declare type EmploymentPersonalInfoResponse = {
     submissionUrl: string;
-    currentStep: 'collectEmployeePersonalInfo';
-    segment: 'employment';
+    currentStep: "collectEmployeePersonalInfo";
+    segment: "employment";
     subSegment: null;
     errorIds?: [ErrorId];
     instantMatchAttempts?: number;
@@ -767,37 +768,37 @@ export declare type EmploymentPersonalInfoResponse = {
  */
 export declare type DriverLicensePersonalInfoResponse = {
     submissionUrl: string;
-    currentStep: 'collectDriverLicensePersonalInfo';
-    segment: 'identity';
+    currentStep: "collectDriverLicensePersonalInfo";
+    segment: "identity";
     errorIds?: [ErrorId];
     instantMatchAttempts?: number;
 } & VerificationResponse;
 export declare type GeneralIdentityPersonalInfoResponse = {
     submissionUrl: string;
-    currentStep: 'collectGeneralIdentityPersonalInfo';
-    segment: 'identity';
+    currentStep: "collectGeneralIdentityPersonalInfo";
+    segment: "identity";
     errorIds?: [ErrorId];
     instantMatchAttempts?: number;
 } & VerificationResponse;
 export declare type HybridIdentityPersonalInfoResponse = {
     submissionUrl: string;
-    currentStep: 'collectHybridIdentityPersonalInfo';
-    segment: 'identity';
+    currentStep: "collectHybridIdentityPersonalInfo";
+    segment: "identity";
     errorIds?: [ErrorId];
     instantMatchAttempts?: number;
 } & VerificationResponse;
 export declare type LicensedProfessionalPersonalInfoResponse = {
     submissionUrl: string;
-    currentStep: 'collectLicensedProfessionalPersonalInfo';
-    segment: 'licensedProfessional';
+    currentStep: "collectLicensedProfessionalPersonalInfo";
+    segment: "licensedProfessional";
     availableStatuses?: LicensedProfessionalStatus[];
     errorIds?: [ErrorId];
     instantMatchAttempts?: number;
 } & VerificationResponse;
 export declare type MoverPersonalInfoResponse = {
     submissionUrl: string;
-    currentStep: 'collectMoverPersonalInfo';
-    segment: 'recentMover';
+    currentStep: "collectMoverPersonalInfo";
+    segment: "recentMover";
     availableStatuses?: RecentMoverStatus[];
     errorIds?: [ErrorId];
     instantMatchAttempts?: number;
@@ -808,7 +809,7 @@ export declare type MoverPersonalInfoResponse = {
 export declare type DocUploadResponse = {
     verificationId: DatabaseId;
     submissionUrl: string;
-    currentStep: 'docUpload';
+    currentStep: "docUpload";
     errorIds?: [ErrorId];
     rejectionReasons?: RejectionReasons[];
     maxReviewTime?: MaxReviewTime;
@@ -821,20 +822,20 @@ export declare type SSOResponse = {
     verificationId: DatabaseId;
     loginUrl: string;
     cancelUrl: string;
-    currentStep: 'sso';
+    currentStep: "sso";
     errorIds?: [ErrorId];
 } & WithLocaleAndCountryChoiceAndSegment;
 export declare type SMSLoopResponse = {
     verificationId: DatabaseId;
     submissionUrl: string;
     errorIds?: [ErrorId];
-    currentStep: 'smsLoop';
+    currentStep: "smsLoop";
 } & WithLocaleAndCountryChoiceAndSegment;
 export declare type EmailLoopResponse = {
     verificationId: DatabaseId;
     submissionUrl: string;
     errorIds?: [ErrorId];
-    currentStep: 'emailLoop';
+    currentStep: "emailLoop";
     canResendEmailLoop: boolean;
     cancelUrl: string;
 } & WithLocaleAndCountryChoiceAndSegment;
@@ -843,7 +844,7 @@ export declare type EmailLoopResponse = {
  */
 export declare type SuccessResponse = {
     verificationId: DatabaseId;
-    currentStep: 'success';
+    currentStep: "success";
     rewardCode: string;
     redirectUrl?: string;
     rewardData?: string[];
@@ -853,7 +854,7 @@ export declare type SuccessResponse = {
  */
 export declare type ErrorResponse = {
     verificationId: DatabaseId;
-    currentStep: 'error';
+    currentStep: "error";
     subSegment: SubSegment | null;
     errorIds: [ErrorId];
     redirectUrl: string | null;
@@ -863,7 +864,7 @@ export declare type ErrorResponse = {
  */
 export declare type PendingResponse = {
     verificationId: DatabaseId;
-    currentStep: 'pending';
+    currentStep: "pending";
     statusUrl: string;
     maxReviewTime?: MaxReviewTime;
     estimatedReviewTime?: EstimatedReviewTime;
@@ -915,11 +916,11 @@ export declare type ProgramTheme = {
         orgSearchCountryTags?: {
             [country in Country]?: string[];
         };
-        offerType: 'noCode' | 'staticCode' | 'rewardPool' | undefined;
+        offerType: "noCode" | "staticCode" | "rewardPool" | undefined;
     };
 };
-export declare type EstimatedReviewTime = 'A_FEW_MINUTES' | 'A_HALF_HOUR' | 'A_FEW_HOURS' | 'A_FEW_DAYS';
-export declare type MaxReviewTime = '2_MIN' | '20_MIN' | '2_HRS' | '24_HRS' | '2_DAY' | '3_DAY';
+export declare type EstimatedReviewTime = "A_FEW_MINUTES" | "A_HALF_HOUR" | "A_FEW_HOURS" | "A_FEW_DAYS";
+export declare type MaxReviewTime = "2_MIN" | "20_MIN" | "2_HRS" | "24_HRS" | "2_DAY" | "3_DAY";
 export declare type FaqUrl = string;
 /**
  * @description List of countries supported by SheerID
@@ -1289,7 +1290,7 @@ export declare type DefaultMessages = {
             skipEmail2: string;
             skipEmailCTA: string;
         };
-        error: ProgramThemeMessages['step']['error'];
+        error: ProgramThemeMessages["step"]["error"];
     };
     ssn: string;
     ssnPlaceholder: string;
@@ -1325,6 +1326,7 @@ export declare type DefaultMessages = {
     LICENSED_REAL_ESTATE_AGENT: string;
     VETERINARIAN: string;
     tryAgain: string;
+    footerText: string;
     infoShared1: string;
     infoShared2: string;
     studentInfoShared: string;
@@ -1349,16 +1351,16 @@ declare type DateTimeMessages = {
     month: string;
     day: string;
     year: string;
-    '2_MIN': string;
-    '20_MIN': string;
-    '2_HRS': string;
-    '24_HRS': string;
-    '2_DAY': string;
-    '3_DAY': string;
-    'A_FEW_MINUTES': string;
-    'A_HALF_HOUR': string;
-    'A_FEW_HOURS': string;
-    'A_FEW_DAYS': string;
+    "2_MIN": string;
+    "20_MIN": string;
+    "2_HRS": string;
+    "24_HRS": string;
+    "2_DAY": string;
+    "3_DAY": string;
+    A_FEW_MINUTES: string;
+    A_HALF_HOUR: string;
+    A_FEW_HOURS: string;
+    A_FEW_DAYS: string;
 };
 /**
  * @description These strings are provided for the Request Organization Form
@@ -1373,11 +1375,11 @@ export declare type RequestOrganizationMessages = {
     eligibleOrgs: string;
     ineligibleOrgs: string;
     none: string;
-    changeLanguage?: DefaultMessages['changeLanguage'];
-    poweredBy?: DefaultMessages['poweredBy'];
-    country?: DefaultMessages['country'];
-    countries?: DefaultMessages['countries'];
-    locales?: DefaultMessages['locales'];
+    changeLanguage?: DefaultMessages["changeLanguage"];
+    poweredBy?: DefaultMessages["poweredBy"];
+    country?: DefaultMessages["country"];
+    countries?: DefaultMessages["countries"];
+    locales?: DefaultMessages["locales"];
     copied: string;
     fields: {
         countryPlaceholder: string;
@@ -1399,10 +1401,10 @@ export declare type RequestOrganizationMessages = {
         };
     };
     errorId: {
-        invalidCountry: DefaultMessages['errorId']['invalidCountry'];
-        invalidEmail: DefaultMessages['errorId']['invalidEmail'];
-        invalidFirstName: DefaultMessages['errorId']['invalidFirstName'];
-        invalidLastName: DefaultMessages['errorId']['invalidLastName'];
+        invalidCountry: DefaultMessages["errorId"]["invalidCountry"];
+        invalidEmail: DefaultMessages["errorId"]["invalidEmail"];
+        invalidFirstName: DefaultMessages["errorId"]["invalidFirstName"];
+        invalidLastName: DefaultMessages["errorId"]["invalidLastName"];
         requiredField: string;
         invalidField: string;
         invalidUrl: string;
@@ -1484,54 +1486,54 @@ export interface GenericAction {
     payload: any;
 }
 export interface SetMessagesAction {
-    type: 'SET_MESSAGES';
+    type: "SET_MESSAGES";
     messages: StringMap;
 }
 export interface ProgramIdAction {
-    type: 'PROGRAM_ID';
+    type: "PROGRAM_ID";
     programId: DatabaseId;
 }
 export interface VerificationResponseAction {
-    type: 'VERIFICATION_RESPONSE';
+    type: "VERIFICATION_RESPONSE";
     verificationResponse: VerificationResponse;
 }
 export interface FieldValidationErrorsAction {
-    type: 'FIELD_VALIDATION_ERRORS';
+    type: "FIELD_VALIDATION_ERRORS";
     fieldValidationErrors: FieldValidationErrors;
 }
 export interface ViewModelAction {
-    type: 'VIEW_MODEL';
+    type: "VIEW_MODEL";
     viewModel: ViewModel;
 }
 export interface FormValidationOptionsAction {
-    type: 'FORM_VALIDATION_OPTIONS';
+    type: "FORM_VALIDATION_OPTIONS";
 }
 export interface PreLoadOrgsAction {
-    type: 'PRE_LOAD_ORGS';
+    type: "PRE_LOAD_ORGS";
     orgList: Organization[];
 }
 export interface PreviousViewModelAction {
-    type: 'PREVIOUS_VIEW_MODEL';
+    type: "PREVIOUS_VIEW_MODEL";
     previousViewModel: ViewModel;
 }
 export interface ProgramThemeAction {
-    type: 'PROGRAM_THEME';
+    type: "PROGRAM_THEME";
     programTheme: ProgramTheme;
 }
 export interface IsLoadingAction {
-    type: 'IS_LOADING';
+    type: "IS_LOADING";
     isLoading: boolean;
     loadingStep?: VerificationStep;
 }
 export interface IsErroredAction {
-    type: 'IS_ERRORED';
+    type: "IS_ERRORED";
     isErrored: boolean;
 }
 export interface ResetStateAction {
-    type: 'RESET_STATE';
+    type: "RESET_STATE";
 }
 export interface ForceUpdate {
-    type: 'FORCE_UPDATE';
+    type: "FORCE_UPDATE";
 }
 export declare type VerificationServiceAction = SetMessagesAction | ProgramIdAction | VerificationResponseAction | FieldValidationErrorsAction | ViewModelAction | PreLoadOrgsAction | PreviousViewModelAction | ProgramThemeAction | IsLoadingAction | IsErroredAction | ResetStateAction | FormValidationOptionsAction | ForceUpdate;
 /**
@@ -1552,16 +1554,16 @@ export declare type RegisteredHooks = {
  *      These names are meant to be descriptive, to indicate when the callback (hook) will be called.
  */
 export declare type Hook = {
-    name: 'ON_VERIFICATION_READY';
+    name: "ON_VERIFICATION_READY";
     callback: (verificationResponse: VerificationResponse) => void;
 } | {
-    name: 'ON_VERIFICATION_SUCCESS';
+    name: "ON_VERIFICATION_SUCCESS";
     callback: (verificationResponse: SuccessResponse) => void;
 } | {
-    name: 'ON_VERIFICATION_STEP_CHANGE';
+    name: "ON_VERIFICATION_STEP_CHANGE";
     callback: (verificationResponse: SuccessResponse) => void;
 };
-export declare type HookName = 'ON_VERIFICATION_READY' | 'ON_VERIFICATION_SUCCESS' | 'ON_VERIFICATION_STEP_CHANGE';
+export declare type HookName = "ON_VERIFICATION_READY" | "ON_VERIFICATION_SUCCESS" | "ON_VERIFICATION_STEP_CHANGE";
 /**
  * @description The shape of the request payload to send when calling a conversion endpoint.
  */
@@ -1900,5 +1902,5 @@ export declare type States = {
 /**
  * @description List of locales supported by SheerID
  */
-export declare type Locale = 'ar' | 'bg' | 'cs' | 'da' | 'de' | 'el' | 'en-GB' | 'en-US' | 'es-ES' | 'es' | 'fi' | 'fr-CA' | 'fr' | 'ga' | 'hr' | 'hu' | 'id' | 'it' | 'iw' | 'ja' | 'ko' | 'lo' | 'lt' | 'ms' | 'nl' | 'no' | 'pl' | 'pt-BR' | 'pt' | 'ru' | 'sk' | 'sl' | 'sr' | 'sv' | 'th' | 'tr' | 'zh-HK' | 'zh';
+export declare type Locale = "ar" | "bg" | "cs" | "da" | "de" | "el" | "en-GB" | "en-US" | "es-ES" | "es" | "fi" | "fr-CA" | "fr" | "ga" | "hr" | "hu" | "id" | "it" | "iw" | "ja" | "ko" | "lo" | "lt" | "ms" | "nl" | "no" | "pl" | "pt-BR" | "pt" | "ru" | "sk" | "sl" | "sr" | "sv" | "th" | "tr" | "zh-HK" | "zh";
 export {};

package/src/lib/utils/browser/inputHelpers.d.ts

@@ -1,4 +1,4 @@
-import { ExtendedFieldId, FieldId } from '../../types/types';
+import { ExtendedFieldId, FieldId } from "../../types/types";
 /**
  * @private
  */

package/src/lib/utils/customTagReplacer/index.d.ts

@@ -0,0 +1,11 @@
+import { ReactNode } from "react-redux";
+interface TagMap {
+    [key: string]: string | ((content: string) => string | ReactNode);
+}
+/**
+ * Given a tagmap will return a function that can be passed directly as the
+ * children of an FormattedHTMLMessage. See the Readme
+ *
+ */
+export declare const makeFormattedHTMLTagReplacer: (tagmap: TagMap) => (text: string | JSX.Element) => ReactNode;
+export {};

package/src/lib/utils/customTagReplacer/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/src/lib/utils/logger/logger.d.ts

@@ -1,4 +1,4 @@
-import { LogLevel, VerificationStore } from '../../types/types';
+import { LogLevel, VerificationStore } from "../../types/types";
 export declare const logger: {
     error: (err: Error | string, errorMessageGroup?: string) => void;
     warn: (...args: any[]) => void;

package/src/lib/utils/routing/Url.d.ts

@@ -1,4 +1,4 @@
-import { DatabaseId } from '../../types/types';
+import { DatabaseId } from "../../types/types";
 export declare const ensureTrailingSlash: (url: string) => string;
 export declare const getQueryParamsFromUrl: (url?: string) => URLSearchParams;
 export declare const getVerificationIdFromQueryString: (queryString: string) => DatabaseId;

package/src/lib/utils/stepComponentHelpers/stepComponentHelpers.d.ts

@@ -1,6 +1,6 @@
-import { InjectedIntl } from 'react-intl';
-import { FieldId, FieldValidationErrors, Organization, VerificationService, FieldContent, ExtendedFieldId, InputSelectOnKeyDown, FormSelectChoice, Country, ProgramTheme, Locale, ViewModel, State, PendingResponse, DocUploadResponse, FieldDescription, FirstResponderStatus, MilitaryStatus, MedicalProfessionalStatus } from '../../types/types';
-import { VerificationStepsEnum, MilitaryStatusDefaultMessagesEnum, FirstResponderStatusDefaultMessagesEnum, MedicalProfessionalStatusDefaultMessagesEnum } from '../../types/runtimeTypes';
+import { InjectedIntl } from "react-intl";
+import { FieldId, FieldValidationErrors, Organization, VerificationService, FieldContent, ExtendedFieldId, InputSelectOnKeyDown, FormSelectChoice, Country, ProgramTheme, Locale, ViewModel, State, PendingResponse, DocUploadResponse, FieldDescription, FirstResponderStatus, MilitaryStatus, MedicalProfessionalStatus } from "../../types/types";
+import { VerificationStepsEnum, MilitaryStatusDefaultMessagesEnum, FirstResponderStatusDefaultMessagesEnum, MedicalProfessionalStatusDefaultMessagesEnum } from "../../types/runtimeTypes";
 export declare const updateViewModelOrganization: (organization: Organization, verificationService: VerificationService) => void;
 export declare const populateViewModelFromQueryParams: (verificationService: VerificationService) => void;
 export declare const updateFieldValidationErrors: (fieldValidationErrors: FieldValidationErrors, verificationService: VerificationService) => void;

package/src/lib/utils/structures/FormSelectChoice.d.ts

@@ -1,4 +1,4 @@
-import { FormSelectChoice } from '../../types/types';
+import { FormSelectChoice } from "../../types/types";
 declare type compareLabelReturn = 1 | -1;
 export declare const compareLabel: (a: FormSelectChoice<any>, b: FormSelectChoice<any>) => compareLabelReturn;
 export declare const SortByLabel: (choices: FormSelectChoice<any, string>[]) => FormSelectChoice<any, string>[];

package/src/lib/validators/customValidators.d.ts

@@ -1,4 +1,4 @@
-import { Validator, ExtendedFieldId } from '../types/types';
+import { Validator, ExtendedFieldId } from "../types/types";
 export declare const setCustomValidator: (validatorField: ExtendedFieldId, newValidator: Validator) => void;
 export declare const getCustomValidator: (validatorField: ExtendedFieldId) => Validator;
 export declare const customValidatorExists: (validatorField: ExtendedFieldId) => boolean;