@sheerid/jslib 1.130.0 → 1.131.0

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

@@ -31,7 +31,8 @@ export declare enum VerificationStepsEnum {
     cancelEmailLoop = "cancelEmailLoop",
     consolation = "consolation",
     override = "override",
-    cancelDocUpload = "cancelDocUpload"
+    cancelDocUpload = "cancelDocUpload",
+    missingRequiredMetadata = "missingRequiredMetadata"
 }
 export declare const VerificationSteps: any;
 export declare const CollectInfoSteps: string[];

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

@@ -189,6 +189,7 @@ export declare type MarketConsentOptions = {
 export declare type MetadataConfig = {
     enabled: boolean;
     keys: string[];
+    requiredKeys?: string[];
 };
 export declare type RestResources = {
     verification: string;
@@ -373,11 +374,11 @@ export interface InputSelectComponentProps {
     label?: string | JSX.Element;
     intl?: InjectedIntl;
 }
-export declare type ErrorId = "apiRateLimitExceeded" | "dischargeDateBeforeBirthDate" | "docReviewLimitExceeded" | "inactiveProgram" | "expiredProgram" | "expiredEmailLoopToken" | "expiredSMSCode" | "expiredVerification" | "fraudRulesReject" | "futureBirthDate" | "futureDischargeDate" | "incorrectVerificationOverrideCodeAttemptLimitExceeded" | "internalServerError" | "invalidAddress" | "invalidApiToken" | "invalidBirthDate" | "invalidCity" | "invalidCountry" | "invalidDischargeDate" | "invalidDocUploadToken" | "invalidEbtCardNumber" | "invalidEmail" | "invalidFileSizeEmpty" | "invalidFileSizeMax" | "invalidFirstName" | "invalidFirstResponderStatus" | "invalidLastName" | "invalidMemberId" | "invalidMilitaryStatus" | "invalidNumberOfFiles" | "invalidOptIn" | "invalidOrganization" | "invalidOverrideCode" | "invalidPhoneNumber" | "invalidPostalCode" | "invalidProgram" | "invalidRequest" | "invalidSMSCode" | "invalidSocialSecurityNumber" | "invalidState" | "invalidStatus" | "invalidStatuses" | "invalidDriverLicenseNumber" | "invalidStep" | "marketConsentRequired" | "maxMetadataLengthExceeded" | "maxMetadataValuesExceeded" | "maxSMSCodeLimitExceeded" | "incorrectSMSCodeAttemptLimitExceeded" | "noProgram" | "noRemainingRewardCodes" | "notApproved" | "notFound" | "noValidFiles" | "noVerification" | "outsideAgePerson" | "simulatedError" | "unauthorizedAccountStatus" | "unauthorizedDomain" | "underagePerson" | "unknownError" | "unsupportedDocMimeType" | "verificationLimitExceeded" | "invalidEmailLoopToken" | NetworkErrorId;
+export declare type ErrorId = "apiRateLimitExceeded" | "dischargeDateBeforeBirthDate" | "docReviewLimitExceeded" | "inactiveProgram" | "expiredProgram" | "expiredEmailLoopToken" | "expiredSMSCode" | "expiredVerification" | "fraudRulesReject" | "futureBirthDate" | "futureDischargeDate" | "incorrectVerificationOverrideCodeAttemptLimitExceeded" | "internalServerError" | "invalidAddress" | "invalidApiToken" | "invalidBirthDate" | "invalidCity" | "invalidCountry" | "invalidDischargeDate" | "invalidDocUploadToken" | "invalidEbtCardNumber" | "invalidEmail" | "invalidFileSizeEmpty" | "invalidFileSizeMax" | "invalidFirstName" | "invalidFirstResponderStatus" | "invalidLastName" | "invalidMemberId" | "invalidMilitaryStatus" | "invalidNumberOfFiles" | "invalidOptIn" | "invalidOrganization" | "invalidOverrideCode" | "invalidPhoneNumber" | "invalidPostalCode" | "invalidProgram" | "invalidRequest" | "invalidSMSCode" | "invalidSocialSecurityNumber" | "invalidState" | "invalidStatus" | "invalidStatuses" | "invalidDriverLicenseNumber" | "invalidStep" | "marketConsentRequired" | "maxMetadataLengthExceeded" | "maxMetadataValuesExceeded" | "maxSMSCodeLimitExceeded" | "incorrectSMSCodeAttemptLimitExceeded" | "noProgram" | "noRemainingRewardCodes" | "notApproved" | "notFound" | "noValidFiles" | "noVerification" | "outsideAgePerson" | "simulatedError" | "unauthorizedAccountStatus" | "unauthorizedDomain" | "underagePerson" | "unknownError" | "unsupportedDocMimeType" | "verificationLimitExceeded" | "invalidEmailLoopToken" | "missingRequiredMetadata" | 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" | "collectLowIncomePersonalInfo" | "collectMoverPersonalInfo" | "collectSocialSecurityNumber" | "cancelSocialSecurityNumber" | "docUpload" | "pending" | "docReviewLimitExceeded" | "success" | "error" | "sso" | "smsLoop" | "emailLoop" | "cancelEmailLoop" | "consolation" | "override" | "cancelDocUpload";
+export declare type VerificationStep = "collectStudentPersonalInfo" | "collectTeacherPersonalInfo" | "collectMemberPersonalInfo" | "collectMilitaryStatus" | "collectActiveMilitaryPersonalInfo" | "collectInactiveMilitaryPersonalInfo" | "collectSeniorPersonalInfo" | "collectAgePersonalInfo" | "collectFirstResponderPersonalInfo" | "collectMedicalProfessionalPersonalInfo" | "collectEmployeePersonalInfo" | "collectDriverLicensePersonalInfo" | "collectGeneralIdentityPersonalInfo" | "collectHybridIdentityPersonalInfo" | "collectLicensedProfessionalPersonalInfo" | "collectLowIncomePersonalInfo" | "collectMoverPersonalInfo" | "collectSocialSecurityNumber" | "cancelSocialSecurityNumber" | "docUpload" | "pending" | "docReviewLimitExceeded" | "success" | "error" | "sso" | "smsLoop" | "emailLoop" | "cancelEmailLoop" | "consolation" | "override" | "cancelDocUpload" | "missingRequiredMetadata";
 export declare type VerificationStepMap<T> = {
     [P in VerificationStep]: T;
 };
@@ -1059,6 +1060,10 @@ export declare type ProgramThemeMessages = {
                     title?: string;
                     buttonText?: string;
                 };
+                missingRequiredMetadata?: {
+                    title?: string;
+                    buttonText?: string;
+                };
             };
         };
     };
@@ -1563,6 +1568,7 @@ export interface VerificationServiceValues {
     readonly programId: DatabaseId;
     readonly orgList: Organization[];
     readonly formValidationOptions?: FormValidationOptions;
+    readonly overrideStep?: VerificationStep;
 }
 export interface VerificationServiceFunctions {
     readonly fetchNewVerificationRequest: (programId: DatabaseId, segment: Segment, previousViewModel: ViewModel, trackingId?: string, forceNewVerificationRequest?: boolean) => Promise<void>;
@@ -1606,6 +1612,7 @@ export declare type ReduxState = {
     messages: StringMap;
     orgList: Organization[];
     formValidationOptions: FormValidationOptions;
+    overrideStep?: VerificationStep;
 };
 export declare type VerificationStore = Store<ReduxState, VerificationServiceAction>;
 /**
@@ -1641,6 +1648,9 @@ export interface ViewModelAction {
 export interface FormValidationOptionsAction {
     type: "FORM_VALIDATION_OPTIONS";
 }
+export interface RequiredMetadataCheckAction {
+    type: "REQUIRED_METADATA_CHECK";
+}
 export interface PreLoadOrgsAction {
     type: "PRE_LOAD_ORGS";
     orgList: Organization[];
@@ -1668,7 +1678,7 @@ export interface ResetStateAction {
 export interface ForceUpdate {
     type: "FORCE_UPDATE";
 }
-export declare type VerificationServiceAction = SetMessagesAction | ProgramIdAction | VerificationResponseAction | FieldValidationErrorsAction | ViewModelAction | PreLoadOrgsAction | PreviousViewModelAction | ProgramThemeAction | IsLoadingAction | IsErroredAction | ResetStateAction | FormValidationOptionsAction | ForceUpdate;
+export declare type VerificationServiceAction = SetMessagesAction | ProgramIdAction | VerificationResponseAction | FieldValidationErrorsAction | ViewModelAction | PreLoadOrgsAction | PreviousViewModelAction | ProgramThemeAction | IsLoadingAction | IsErroredAction | ResetStateAction | FormValidationOptionsAction | ForceUpdate | RequiredMetadataCheckAction;
 /**
  * @private
  * @deprecated Use a specific action interface (or create one) from below