app/javascript/packages/document-capture/context/in-person.ts
import { createContext } from 'react';
export interface InPersonContextProps {
/**
* URL to in-person proofing alternative flow, if enabled.
*/
inPersonURL?: string;
/**
* Post Office location search endpoint URL
*/
locationsURL: string;
/**
* Address search endpoint URL
*/
addressSearchURL: string;
/**
* Whether the message indicating an outage should be displayed
*/
inPersonOutageMessageEnabled: boolean;
/**
* Date communicated to users regarding expected update about their enrollment after an outage
*/
inPersonOutageExpectedUpdateDate?: string;
/**
* When true users must enter a full address when searching for a Post Office location
*/
inPersonFullAddressEntryEnabled: boolean;
/**
* When true a user has entered ipp by opting in
*/
optedInToInPersonProofing: boolean;
/**
* Collection of US states and territories
* Each item is [Long name, abbreviation], e.g. ['Ohio', 'OH']
*/
usStatesTerritories: Array<[string, string]>;
/**
* When skipDocAuth is true and in_person_proofing_opt_in_enabled is true,
* users are directed to the beginning of the IPP flow. This is set to true when
* they choose Opt-in IPP on the new How To Verify page
*/
skipDocAuth?: boolean;
/**
* Flag set when user select IPP from handoff page when IPP is available
* and selfie is required
*/
skipDocAuthFromHandoff?: boolean;
/**
* URL for Opt-in IPP, used when in_person_proofing_opt_in_enabled is enabled
*/
howToVerifyURL?: string;
/**
* URL for going back to previous steps in Doc Auth, like handoff and howToVerify
*/
previousStepURL?: string;
}
const InPersonContext = createContext<InPersonContextProps>({
locationsURL: '',
addressSearchURL: '',
inPersonOutageMessageEnabled: false,
inPersonFullAddressEntryEnabled: false,
optedInToInPersonProofing: false,
usStatesTerritories: [],
});
InPersonContext.displayName = 'InPersonContext';
export default InPersonContext;