@facesignai/api 1.0.9 → 1.0.28

package/build/src/types/deviceDetails.d.ts

@@ -1,11 +1,15 @@
-export interface Device {
+export interface Device extends Record<string, unknown> {
+    isYaBrowser: boolean;
+    isAuthoritative: boolean;
     isMobile: boolean;
     isMobileNative: boolean;
     isTablet: boolean;
     isiPad: boolean;
     isiPod: boolean;
     isiPhone: boolean;
+    isiPhoneNative: boolean;
     isAndroid: boolean;
+    isAndroidNative: boolean;
     isBlackberry: boolean;
     isOpera: boolean;
     isIE: boolean;
@@ -20,10 +24,10 @@ export interface Device {
     isSeaMonkey: boolean;
     isFlock: boolean;
     isAmaya: boolean;
+    isPhantomJS: boolean;
     isEpiphany: boolean;
     isDesktop: boolean;
     isWindows: boolean;
-    isWindowsPhone: boolean;
     isLinux: boolean;
     isLinux64: boolean;
     isMac: boolean;
@@ -31,7 +35,7 @@ export interface Device {
     isBada: boolean;
     isSamsung: boolean;
     isRaspberry: boolean;
-    isBot: boolean;
+    isBot: boolean | string;
     isCurl: boolean;
     isAndroidTablet: boolean;
     isWinJs: boolean;
@@ -39,14 +43,20 @@ export interface Device {
     isSilk: boolean;
     isCaptive: boolean;
     isSmartTV: boolean;
+    isUC: boolean;
+    isFacebook: boolean;
+    isAlamoFire: boolean;
+    isElectron: boolean;
     silkAccelerated: boolean;
     browser: string;
-    version: string;
+    version: string | number;
     os: string;
     platform: string;
-    geoIp: {
-        [key: string]: unknown;
-    };
+    geoIp: Record<string, string | string[]>;
     source: string;
+    isWechat: boolean;
+    isWindowsPhone: boolean;
+    electronVersion: string;
+    SilkAccelerated?: boolean;
 }
 //# sourceMappingURL=deviceDetails.d.ts.map

package/build/src/types/deviceDetails.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deviceDetails.d.ts","sourceRoot":"","sources":["../../../src/types/deviceDetails.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAM;IACrB,QAAQ,EAAE,OAAO,CAAA;IACjB,cAAc,EAAE,OAAO,CAAA;IACvB,QAAQ,EAAE,OAAO,CAAA;IACjB,MAAM,EAAE,OAAO,CAAA;IACf,MAAM,EAAE,OAAO,CAAA;IACf,QAAQ,EAAE,OAAO,CAAA;IACjB,SAAS,EAAE,OAAO,CAAA;IAClB,YAAY,EAAE,OAAO,CAAA;IACrB,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,OAAO,CAAA;IACb,MAAM,EAAE,OAAO,CAAA;IACf,qBAAqB,EAAE,OAAO,CAAA;IAC9B,QAAQ,EAAE,OAAO,CAAA;IACjB,SAAS,EAAE,OAAO,CAAA;IAClB,QAAQ,EAAE,OAAO,CAAA;IACjB,QAAQ,EAAE,OAAO,CAAA;IACjB,WAAW,EAAE,OAAO,CAAA;IACpB,SAAS,EAAE,OAAO,CAAA;IAClB,WAAW,EAAE,OAAO,CAAA;IACpB,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,OAAO,CAAA;IACnB,SAAS,EAAE,OAAO,CAAA;IAClB,SAAS,EAAE,OAAO,CAAA;IAClB,cAAc,EAAE,OAAO,CAAA;IACvB,OAAO,EAAE,OAAO,CAAA;IAChB,SAAS,EAAE,OAAO,CAAA;IAClB,KAAK,EAAE,OAAO,CAAA;IACd,UAAU,EAAE,OAAO,CAAA;IACnB,MAAM,EAAE,OAAO,CAAA;IACf,SAAS,EAAE,OAAO,CAAA;IAClB,WAAW,EAAE,OAAO,CAAA;IACpB,KAAK,EAAE,OAAO,CAAA;IACd,MAAM,EAAE,OAAO,CAAA;IACf,eAAe,EAAE,OAAO,CAAA;IACxB,OAAO,EAAE,OAAO,CAAA;IAChB,YAAY,EAAE,OAAO,CAAA;IACrB,MAAM,EAAE,OAAO,CAAA;IACf,SAAS,EAAE,OAAO,CAAA;IAClB,SAAS,EAAE,OAAO,CAAA;IAClB,eAAe,EAAE,OAAO,CAAA;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAA;IACjC,MAAM,EAAE,MAAM,CAAA;CACf"}
+{"version":3,"file":"deviceDetails.d.ts","sourceRoot":"","sources":["../../../src/types/deviceDetails.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAO,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACrD,WAAW,EAAE,OAAO,CAAA;IACpB,eAAe,EAAE,OAAO,CAAA;IACxB,QAAQ,EAAE,OAAO,CAAA;IACjB,cAAc,EAAE,OAAO,CAAA;IACvB,QAAQ,EAAE,OAAO,CAAA;IACjB,MAAM,EAAE,OAAO,CAAA;IACf,MAAM,EAAE,OAAO,CAAA;IACf,QAAQ,EAAE,OAAO,CAAA;IACjB,cAAc,EAAE,OAAO,CAAA;IACvB,SAAS,EAAE,OAAO,CAAA;IAClB,eAAe,EAAE,OAAO,CAAA;IACxB,YAAY,EAAE,OAAO,CAAA;IACrB,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,OAAO,CAAA;IACb,MAAM,EAAE,OAAO,CAAA;IACf,qBAAqB,EAAE,OAAO,CAAA;IAC9B,QAAQ,EAAE,OAAO,CAAA;IACjB,SAAS,EAAE,OAAO,CAAA;IAClB,QAAQ,EAAE,OAAO,CAAA;IACjB,QAAQ,EAAE,OAAO,CAAA;IACjB,WAAW,EAAE,OAAO,CAAA;IACpB,SAAS,EAAE,OAAO,CAAA;IAClB,WAAW,EAAE,OAAO,CAAA;IACpB,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,WAAW,EAAE,OAAO,CAAA;IACpB,UAAU,EAAE,OAAO,CAAA;IACnB,SAAS,EAAE,OAAO,CAAA;IAClB,SAAS,EAAE,OAAO,CAAA;IAClB,OAAO,EAAE,OAAO,CAAA;IAChB,SAAS,EAAE,OAAO,CAAA;IAClB,KAAK,EAAE,OAAO,CAAA;IACd,UAAU,EAAE,OAAO,CAAA;IACnB,MAAM,EAAE,OAAO,CAAA;IACf,SAAS,EAAE,OAAO,CAAA;IAClB,WAAW,EAAE,OAAO,CAAA;IACpB,KAAK,EAAE,OAAO,GAAG,MAAM,CAAA;IACvB,MAAM,EAAE,OAAO,CAAA;IACf,eAAe,EAAE,OAAO,CAAA;IACxB,OAAO,EAAE,OAAO,CAAA;IAChB,YAAY,EAAE,OAAO,CAAA;IACrB,MAAM,EAAE,OAAO,CAAA;IACf,SAAS,EAAE,OAAO,CAAA;IAClB,SAAS,EAAE,OAAO,CAAA;IAClB,IAAI,EAAE,OAAO,CAAA;IACb,UAAU,EAAE,OAAO,CAAA;IACnB,WAAW,EAAE,OAAO,CAAA;IACpB,UAAU,EAAE,OAAO,CAAA;IACnB,eAAe,EAAE,OAAO,CAAA;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,GAAG,MAAM,CAAA;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACxC,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,OAAO,CAAA;IACjB,cAAc,EAAE,OAAO,CAAA;IACvB,eAAe,EAAE,MAAM,CAAA;IACvB,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B"}

package/build/src/types/docScanning.d.ts

@@ -0,0 +1,265 @@
+export type AddressDetailedInfo = {
+    street: string;
+    postalCode: string;
+    city: string;
+    jurisdiction: string;
+};
+export type AlphabetStringResult = {
+    value: string;
+    location?: Rectangle;
+    side?: ScanningSide;
+};
+export type AlphabetType = "latin" | "arabic" | "cyrillic" | "greek";
+export type BarcodeData = {
+    barcodeType: BarcodeType;
+    uncertain: boolean;
+    stringData: string;
+    rawData: Uint8Array;
+};
+export type BarcodeElement = {
+    key: BarcodeElementKey;
+    value: string;
+};
+export type BarcodeElementKey = "document-type" | "standard-version-number" | "customer-family-name" | "customer-first-name" | "customer-full-name" | "date-of-birth" | "sex" | "eye-color" | "address-street" | "address-city" | "address-jurisdiction-code" | "address-postal-code" | "full-address" | "height" | "height-in" | "height-cm" | "customer-middle-name" | "hair-color" | "name-suffix" | "aka-full-name" | "aka-family-name" | "aka-given-name" | "aka-suffix-name" | "weight-range" | "weight-pounds" | "weight-kilograms" | "customer-id-number" | "family-name-truncation" | "first-name-truncation" | "middle-name-truncation" | "place-of-birth" | "address-street-2" | "race-ethnicity" | "name-prefix" | "country-identification" | "residence-street-address" | "residence-street-address-2" | "residence-city" | "residence-jurisdiction-code" | "residence-postal-code" | "residence-full-address" | "under-18" | "under-19" | "under-21" | "social-security-number" | "aka-social-security-number" | "aka-middle-name" | "aka-prefix-name" | "organ-donor" | "veteran" | "aka-date-of-birth" | "issuer-identification-number" | "document-expiration-date" | "jurisdiction-version-number" | "jurisdiction-vehicle-class" | "jurisdiction-restriction-codes" | "jurisdiction-endorsement-codes" | "document-issue-date" | "federal-commercial-vehicle-codes" | "issuing-jurisdiction" | "standard-vehicle-classification" | "issuing-jurisdiction-name" | "standard-endorsement-code" | "standard-restriction-code" | "jurisdiction-vehicle-classification-description" | "jurisdiction-endorsement-code-description" | "jurisdiction-restriction-code-description" | "inventory-control-number" | "card-revision-date" | "document-discriminator" | "limited-duration-document" | "audit-information" | "compliance-type" | "issue-timestamp" | "permit-expiration-date" | "permit-identifier" | "permit-issue-date" | "number-of-duplicates" | "hazmat-expiration-date" | "medical-indicator" | "non-resident" | "unique-customer-id" | "data-discriminator" | "document-expiration-month" | "document-nonexpiring" | "security-version";
+export type BarcodeResult = {
+    barcodeData: BarcodeData;
+    firstName: string;
+    middleName: string;
+    lastName: string;
+    fullName: string;
+    additionalNameInformation: string;
+    address: string;
+    placeOfBirth: string;
+    nationality: string;
+    race: string;
+    religion: string;
+    profession: string;
+    maritalStatus: string;
+    residentialStatus: string;
+    employer: string;
+    sex: string;
+    dateOfBirth: DateResult<string>;
+    dateOfIssue: DateResult<string>;
+    dateOfExpiry: DateResult<string>;
+    documentNumber: string;
+    personalIdNumber: string;
+    documentAdditionalNumber: string;
+    issuingAuthority: string;
+    addressDetailedInfo: AddressDetailedInfo;
+    driverLicenseDetailedInfo: DriverLicenceDetailedInfo<string>;
+    extendedElements: Array<BarcodeElement>;
+};
+export type BarcodeType = "qr-code" | "data-matrix" | "upc-e" | "upc-a" | "ean-8" | "ean-13" | "code-128" | "code-39" | "itf" | "aztec-barcode" | "pdf417-barcode";
+export type DocumentScanReport = {
+    mode?: RecognitionMode;
+    documentClassInfo: DocumentClassInfo;
+    dataMatchResult?: DataMatchResult;
+    firstName?: StringResult;
+    lastName?: StringResult;
+    fullName?: StringResult;
+    additionalNameInformation?: StringResult;
+    localizedName?: StringResult;
+    fathersName?: StringResult;
+    mothersName?: StringResult;
+    address?: StringResult;
+    additionalAddressInformation?: StringResult;
+    additionalOptionalAddressInformation?: StringResult;
+    placeOfBirth?: StringResult;
+    nationality?: StringResult;
+    race?: StringResult;
+    religion?: StringResult;
+    profession?: StringResult;
+    maritalStatus?: StringResult;
+    residentialStatus?: StringResult;
+    employer?: StringResult;
+    sex?: StringResult;
+    sponsor?: StringResult;
+    bloodType?: StringResult;
+    documentNumber?: StringResult;
+    personalIdNumber?: StringResult;
+    documentAdditionalNumber?: StringResult;
+    documentOptionalAdditionalNumber?: StringResult;
+    additionalPersonalIdNumber?: StringResult;
+    issuingAuthority?: StringResult;
+    documentSubtype?: StringResult;
+    remarks?: StringResult;
+    residencePermitType?: StringResult;
+    manufacturingYear?: StringResult;
+    vehicleType?: StringResult;
+    eligibilityCategory?: StringResult;
+    specificDocumentValidity?: StringResult;
+    visaType?: StringResult;
+    vehicleOwner?: StringResult;
+    certificateNumber?: StringResult;
+    countryCode?: StringResult;
+    nationalInsuranceNumber?: StringResult;
+    dateOfBirth?: DateResult<StringResult>;
+    dateOfIssue?: DateResult<StringResult>;
+    dateOfExpiry?: DateResult<StringResult>;
+    dateOfExpiryPermanent?: boolean;
+    driverLicenseDetailedInfo?: DriverLicenceDetailedInfo<StringResult>;
+    dependentsInfo?: DependentInfo[];
+    inputImagesScanningSide?: ScanningSide[];
+    barcodeInputImageScanningSide?: ScanningSide;
+    documentImagesScanningSide?: ScanningSide[];
+    faceImageScanningSide?: ScanningSide;
+    signatureImageScanningSide?: ScanningSide;
+    subResults: SingleSideScanningResult[];
+};
+export type Country = "albania" | "algeria" | "argentina" | "australia" | "austria" | "azerbaijan" | "bahrain" | "bangladesh" | "belgium" | "bosnia-and-herzegovina" | "brunei" | "bulgaria" | "cambodia" | "canada" | "chile" | "colombia" | "costa-rica" | "croatia" | "cyprus" | "czechia" | "denmark" | "dominican-republic" | "egypt" | "estonia" | "finland" | "france" | "georgia" | "germany" | "ghana" | "greece" | "guatemala" | "hong-kong" | "hungary" | "india" | "indonesia" | "ireland" | "israel" | "italy" | "jordan" | "kazakhstan" | "kenya" | "kosovo" | "kuwait" | "latvia" | "lithuania" | "malaysia" | "maldives" | "malta" | "mauritius" | "mexico" | "morocco" | "netherlands" | "new-zealand" | "nigeria" | "pakistan" | "panama" | "paraguay" | "philippines" | "poland" | "portugal" | "puerto-rico" | "qatar" | "romania" | "russia" | "saudi-arabia" | "serbia" | "singapore" | "slovakia" | "slovenia" | "south-africa" | "spain" | "sweden" | "switzerland" | "taiwan" | "thailand" | "tunisia" | "turkey" | "uae" | "uganda" | "uk" | "ukraine" | "usa" | "vietnam" | "brazil" | "norway" | "oman" | "ecuador" | "el-salvador" | "sri-lanka" | "peru" | "uruguay" | "bahamas" | "bermuda" | "bolivia" | "china" | "european-union" | "haiti" | "honduras" | "iceland" | "japan" | "luxembourg" | "montenegro" | "nicaragua" | "south-korea" | "venezuela" | "afghanistan" | "aland-islands" | "american-samoa" | "andorra" | "angola" | "anguilla" | "antarctica" | "antigua-and-barbuda" | "armenia" | "aruba" | "bailiwick-of-guernsey" | "bailiwick-of-jersey" | "barbados" | "belarus" | "belize" | "benin" | "bhutan" | "bonaire-saint-eustatius-and-saba" | "botswana" | "bouvet-island" | "british-indian-ocean-territory" | "burkina-faso" | "burundi" | "cameroon" | "cape-verde" | "caribbean-netherlands" | "cayman-islands" | "central-african-republic" | "chad" | "christmas-island" | "cocos-islands" | "comoros" | "congo" | "cook-islands" | "cuba" | "curacao" | "democratic-republic-of-the-congo" | "djibouti" | "dominica" | "east-timor" | "equatorial-guinea" | "eritrea" | "ethiopia" | "falkland-islands" | "faroe-islands" | "federated-states-of-micronesia" | "fiji" | "french-guiana" | "french-polynesia" | "french-southern-territories" | "gabon" | "gambia" | "gibraltar" | "greenland" | "grenada" | "guadeloupe" | "guam" | "guinea" | "guinea-bissau" | "guyana" | "heard-island-and-mcdonald-islands" | "iran" | "iraq" | "isle-of-man" | "ivory-coast" | "jamaica" | "kiribati" | "kyrgyzstan" | "laos" | "lebanon" | "lesotho" | "liberia" | "libya" | "liechtenstein" | "macau" | "madagascar" | "malawi" | "mali" | "marshall-islands" | "martinique" | "mauritania" | "mayotte" | "moldova" | "monaco" | "mongolia" | "montserrat" | "mozambique" | "myanmar" | "namibia" | "nauru" | "nepal" | "new-caledonia" | "niger" | "niue" | "norfolk-island" | "northern-cyprus" | "northern-mariana-islands" | "north-korea" | "north-macedonia" | "palau" | "palestine" | "papua-new-guinea" | "pitcairn" | "reunion" | "rwanda" | "saint-barthelemy" | "saint-helena-ascension-and-tristian-da-cunha" | "saint-kitts-and-nevis" | "saint-lucia" | "saint-martin" | "saint-pierre-and-miquelon" | "saint-vincent-and-the-grenadines" | "samoa" | "san-marino" | "sao-tome-and-principe" | "senegal" | "seychelles" | "sierra-leone" | "sint-maarten" | "solomon-islands" | "somalia" | "south-georgia-and-the-south-sandwich-islands" | "south-sudan" | "sudan" | "suriname" | "svalbard-and-jan-mayen" | "eswatini" | "syria" | "tajikistan" | "tanzania" | "togo" | "tokelau" | "tonga" | "trinidad-and-tobago" | "turkmenistan" | "turks-and-caicos-islands" | "tuvalu" | "united-states-minor-outlying-islands" | "uzbekistan" | "vanuatu" | "vatican-city" | "virgin-islands-british" | "virgin-islands-us" | "wallis-and-futuna" | "western-sahara" | "yemen" | "yugoslavia" | "zambia" | "zimbabwe" | "schengen-area";
+export type DataMatchFieldState = {
+    fieldType: DataMatchFieldType;
+    state: DataMatchState;
+};
+export type DataMatchFieldType = "date-of-birth" | "date-of-expiry" | "document-number" | "document-additional-number" | "document-optional-additional-number" | "personal-id-number";
+export type DataMatchResult = {
+    statePerField?: DataMatchFieldState[];
+    overallState: DataMatchState;
+};
+export type DataMatchState = "not-performed" | "failed" | "success";
+export type DateResult<S extends string | StringResult> = {
+    day?: number;
+    month?: number;
+    year?: number;
+    originalString?: S;
+    filledByDomainKnowledge: boolean;
+    successfullyParsed?: boolean;
+};
+export type DependentInfo = {
+    dateOfBirth?: DateResult<StringResult>;
+    sex?: StringResult;
+    documentNumber?: StringResult;
+    fullName?: StringResult;
+};
+export type DetailedCroppedImageResult = {
+    image: ImageData;
+    location?: Rectangle;
+    side?: ScanningSide;
+};
+export type DocumentClassInfo = {
+    country?: Country;
+    region?: Region;
+    type?: DocumentType;
+    countryName?: string;
+    isoNumericCountryCode?: string;
+    isoAlpha2CountryCode?: string;
+    isoAlpha3CountryCode?: string;
+};
+export type DocumentType = "consular-id" | "dl" | "dl-public-services-card" | "employment-pass" | "fin-card" | "id" | "multipurpose-id" | "mykad" | "mykid" | "mypr" | "mytentera" | "pan-card" | "professional-id" | "public-services-card" | "residence-permit" | "resident-id" | "temporary-residence-permit" | "voter-id" | "work-permit" | "ikad" | "military-id" | "mykas" | "social-security-card" | "health-insurance-card" | "passport" | "s-pass" | "address-card" | "alien-id" | "alien-passport" | "green-card" | "minors-id" | "postal-id" | "professional-dl" | "tax-id" | "weapon-permit" | "visa" | "border-crossing-card" | "driver-card" | "global-entry-card" | "mypolis" | "nexus-card" | "passport-card" | "proof-of-age-card" | "refugee-id" | "tribal-id" | "veteran-id" | "citizenship-certificate" | "my-number-card" | "consular-passport" | "minors-passport" | "minors-public-services-card" | "driving-privilege-card" | "asylum-request" | "driver-qualification-card" | "provisional-dl" | "refugee-passport" | "special-id" | "uniformed-services-id" | "immigrant-visa" | "consular-voter-id" | "twic-card" | "exit-entry-permit" | "mainland-travel-permit-taiwan" | "nbi-clearance" | "proof-of-registration" | "temporary-protection-permit" | "afghan-citizen-card" | "eid" | "pass" | "sis-id" | "asic-card" | "bidoon-card" | "interim-health-insurance-card" | "non-voter-id" | "reciprocal-health-insurance-card" | "vehicle-registration" | "esaad-card" | "registration-certificate" | "medical-marijuana-id" | "non-card-tribal-id" | "diplomatic-id";
+export type DriverLicenceDetailedInfo<S extends string | StringResult> = {
+    restrictions?: S;
+    endorsements?: S;
+    vehicleClass?: S;
+    conditions?: S;
+    vehicleClassesInfo?: VehicleClassInfo<S>[];
+};
+export type MrzDocumentType = "unknown" | "identity-card" | "passport" | "visa" | "green-card" | "mys-pass-imm13p" | "driver-license" | "internal-travel-document" | "border-crossing-card";
+export type MrzResult = {
+    rawMrzString: string;
+    documentCode: string;
+    issuer: string;
+    documentNumber: string;
+    opt1: string;
+    opt2: string;
+    gender: string;
+    nationality: string;
+    primaryId: string;
+    secondaryId: string;
+    issuerName: string;
+    nationalityName: string;
+    verified: boolean;
+    dateOfBirth: Date;
+    dateOfExpiry: Date;
+    documentType: MrzDocumentType;
+    sanitizedOpt1: string;
+    sanitizedOpt2: string;
+    sanitizedNationality: string;
+    sanitizedIssuer: string;
+    sanitizedDocumentCode: string;
+    sanitizedDocumentNumber: string;
+};
+export type RecognitionMode = "mrz-id" | "mrz-visa" | "mrz-passport" | "photo-id" | "full-recognition" | "barcode-id";
+export type RecognitionModeFilter = {
+    enableMrzId: boolean;
+    enableMrzVisa: boolean;
+    enableMrzPassport: boolean;
+    enablePhotoId: boolean;
+    enableBarcodeId: boolean;
+    enableFullDocumentRecognition: boolean;
+};
+export type Rectangle = {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};
+export type Region = "alabama" | "alaska" | "alberta" | "arizona" | "arkansas" | "australian-capital-territory" | "british-columbia" | "california" | "colorado" | "connecticut" | "delaware" | "district-of-columbia" | "florida" | "georgia" | "hawaii" | "idaho" | "illinois" | "indiana" | "iowa" | "kansas" | "kentucky" | "louisiana" | "maine" | "manitoba" | "maryland" | "massachusetts" | "michigan" | "minnesota" | "mississippi" | "missouri" | "montana" | "nebraska" | "nevada" | "new-brunswick" | "new-hampshire" | "new-jersey" | "new-mexico" | "new-south-wales" | "new-york" | "northern-territory" | "north-carolina" | "north-dakota" | "nova-scotia" | "ohio" | "oklahoma" | "ontario" | "oregon" | "pennsylvania" | "quebec" | "queensland" | "rhode-island" | "saskatchewan" | "south-australia" | "south-carolina" | "south-dakota" | "tasmania" | "tennessee" | "texas" | "utah" | "vermont" | "victoria" | "virginia" | "washington" | "western-australia" | "west-virginia" | "wisconsin" | "wyoming" | "yukon" | "ciudad-de-mexico" | "jalisco" | "newfoundland-and-labrador" | "nuevo-leon" | "baja-california" | "chihuahua" | "guanajuato" | "guerrero" | "mexico" | "michoacan" | "new-york-city" | "tamaulipas" | "veracruz" | "chiapas" | "coahuila" | "durango" | "guerrero-cocula" | "guerrero-juchitan" | "guerrero-tepecoacuilco" | "guerrero-tlacoapa" | "gujarat" | "hidalgo" | "karnataka" | "kerala" | "khyber-pakhtunkhwa" | "madhya-pradesh" | "maharashtra" | "morelos" | "nayarit" | "oaxaca" | "puebla" | "punjab" | "queretaro" | "san-luis-potosi" | "sinaloa" | "sonora" | "tabasco" | "tamil-nadu" | "yucatan" | "zacatecas" | "aguascalientes" | "baja-california-sur" | "campeche" | "colima" | "quintana-roo-benito-juarez" | "quintana-roo" | "quintana-roo-solidaridad" | "tlaxcala" | "quintana-roo-cozumel" | "sao-paolo" | "rio-de-janeiro" | "rio-grande-do-sul" | "northwest-territories" | "nunavut" | "prince-edward-island" | "distrito-federal" | "maranhao" | "mato-grosso" | "minas-gerais" | "para" | "parana" | "pernambuco" | "santa-catarina" | "andhra-pradesh" | "ceara" | "goias" | "guerrero-acapulco-de-juarez" | "haryana" | "sergipe" | "alagoas" | "bangsamoro";
+export type ScanningSide = "first" | "second";
+export type SingleSideScanningResult = {
+    viz?: VizResult;
+    mrz?: MrzResult;
+    barcode?: BarcodeResult;
+    inputImage?: ImageData;
+    barcodeInputImage?: ImageData;
+    documentImage?: ImageData;
+    faceImage?: DetailedCroppedImageResult;
+    signatureImage?: DetailedCroppedImageResult;
+};
+export type StringResult = {
+    [key in AlphabetType]: AlphabetStringResult;
+};
+export type VehicleClassInfo<S extends string | StringResult> = {
+    vehicleClass?: S;
+    licenceType?: S;
+    effectiveDate?: DateResult<S>;
+    expiryDate?: DateResult<S>;
+};
+export type VizResult = {
+    firstName?: StringResult;
+    lastName?: StringResult;
+    fullName?: StringResult;
+    additionalNameInformation?: StringResult;
+    localizedName?: StringResult;
+    fathersName?: StringResult;
+    mothersName?: StringResult;
+    address?: StringResult;
+    additionalAddressInformation?: StringResult;
+    additionalOptionalAddressInformation?: StringResult;
+    placeOfBirth?: StringResult;
+    nationality?: StringResult;
+    race?: StringResult;
+    religion?: StringResult;
+    profession?: StringResult;
+    maritalStatus?: StringResult;
+    residentialStatus?: StringResult;
+    employer?: StringResult;
+    sex?: StringResult;
+    sponsor?: StringResult;
+    bloodType?: StringResult;
+    dateOfBirth?: DateResult<StringResult>;
+    dateOfIssue?: DateResult<StringResult>;
+    dateOfExpiry?: DateResult<StringResult>;
+    dateOfExpiryPermanent?: boolean;
+    documentNumber?: StringResult;
+    personalIdNumber?: StringResult;
+    documentAdditionalNumber?: StringResult;
+    documentOptionalAdditionalNumber?: StringResult;
+    additionalPersonalIdNumber?: StringResult;
+    issuingAuthority?: StringResult;
+    visaType?: StringResult;
+    driverLicenseDetailedInfo?: DriverLicenceDetailedInfo<StringResult>;
+    documentSubtype?: StringResult;
+    remarks?: StringResult;
+    residencePermitType?: StringResult;
+    manufacturingYear?: StringResult;
+    vehicleType?: StringResult;
+    eligibilityCategory?: StringResult;
+    specificDocumentValidity?: StringResult;
+    dependentsInfo?: DependentInfo[];
+    vehicleOwner?: StringResult;
+    certificateNumber?: StringResult;
+    countryCode?: StringResult;
+    nationalInsuranceNumber?: StringResult;
+};
+export type ScanningMode = "single" | "automatic";
+//# sourceMappingURL=docScanning.d.ts.map

package/build/src/types/docScanning.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docScanning.d.ts","sourceRoot":"","sources":["../../../src/types/docScanning.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,YAAY,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,SAAS,CAAA;IACpB,IAAI,CAAC,EAAE,YAAY,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,QAAQ,GAAG,UAAU,GAAG,OAAO,CAAA;AAEpE,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,EAAE,WAAW,CAAA;IACxB,SAAS,EAAE,OAAO,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,UAAU,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,GAAG,EAAE,iBAAiB,CAAA;IACtB,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,iBAAiB,GACzB,eAAe,GACf,yBAAyB,GACzB,sBAAsB,GACtB,qBAAqB,GACrB,oBAAoB,GACpB,eAAe,GACf,KAAK,GACL,WAAW,GACX,gBAAgB,GAChB,cAAc,GACd,2BAA2B,GAC3B,qBAAqB,GACrB,cAAc,GACd,QAAQ,GACR,WAAW,GACX,WAAW,GACX,sBAAsB,GACtB,YAAY,GACZ,aAAa,GACb,eAAe,GACf,iBAAiB,GACjB,gBAAgB,GAChB,iBAAiB,GACjB,cAAc,GACd,eAAe,GACf,kBAAkB,GAClB,oBAAoB,GACpB,wBAAwB,GACxB,uBAAuB,GACvB,wBAAwB,GACxB,gBAAgB,GAChB,kBAAkB,GAClB,gBAAgB,GAChB,aAAa,GACb,wBAAwB,GACxB,0BAA0B,GAC1B,4BAA4B,GAC5B,gBAAgB,GAChB,6BAA6B,GAC7B,uBAAuB,GACvB,wBAAwB,GACxB,UAAU,GACV,UAAU,GACV,UAAU,GACV,wBAAwB,GACxB,4BAA4B,GAC5B,iBAAiB,GACjB,iBAAiB,GACjB,aAAa,GACb,SAAS,GACT,mBAAmB,GACnB,8BAA8B,GAC9B,0BAA0B,GAC1B,6BAA6B,GAC7B,4BAA4B,GAC5B,gCAAgC,GAChC,gCAAgC,GAChC,qBAAqB,GACrB,kCAAkC,GAClC,sBAAsB,GACtB,iCAAiC,GACjC,2BAA2B,GAC3B,2BAA2B,GAC3B,2BAA2B,GAC3B,iDAAiD,GACjD,2CAA2C,GAC3C,2CAA2C,GAC3C,0BAA0B,GAC1B,oBAAoB,GACpB,wBAAwB,GACxB,2BAA2B,GAC3B,mBAAmB,GACnB,iBAAiB,GACjB,iBAAiB,GACjB,wBAAwB,GACxB,mBAAmB,GACnB,mBAAmB,GACnB,sBAAsB,GACtB,wBAAwB,GACxB,mBAAmB,GACnB,cAAc,GACd,oBAAoB,GACpB,oBAAoB,GACpB,2BAA2B,GAC3B,sBAAsB,GACtB,kBAAkB,CAAA;AAEtB,MAAM,MAAM,aAAa,GAAG;IAC1B,WAAW,EAAE,WAAW,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,yBAAyB,EAAE,MAAM,CAAA;IACjC,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,MAAM,CAAA;IACrB,iBAAiB,EAAE,MAAM,CAAA;IACzB,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,EAAE,UAAU,CAAC,MAAM,CAAC,CAAA;IAC/B,WAAW,EAAE,UAAU,CAAC,MAAM,CAAC,CAAA;IAC/B,YAAY,EAAE,UAAU,CAAC,MAAM,CAAC,CAAA;IAChC,cAAc,EAAE,MAAM,CAAA;IACtB,gBAAgB,EAAE,MAAM,CAAA;IACxB,wBAAwB,EAAE,MAAM,CAAA;IAChC,gBAAgB,EAAE,MAAM,CAAA;IACxB,mBAAmB,EAAE,mBAAmB,CAAA;IACxC,yBAAyB,EAAE,yBAAyB,CAAC,MAAM,CAAC,CAAA;IAC5D,gBAAgB,EAAE,KAAK,CAAC,cAAc,CAAC,CAAA;CACxC,CAAA;AAED,MAAM,MAAM,WAAW,GACnB,SAAS,GACT,aAAa,GACb,OAAO,GACP,OAAO,GACP,OAAO,GACP,QAAQ,GACR,UAAU,GACV,SAAS,GACT,KAAK,GACL,eAAe,GACf,gBAAgB,CAAA;AAEpB,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,CAAC,EAAE,eAAe,CAAA;IACtB,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,eAAe,CAAC,EAAE,eAAe,CAAA;IACjC,SAAS,CAAC,EAAE,YAAY,CAAA;IACxB,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB,yBAAyB,CAAC,EAAE,YAAY,CAAA;IACxC,aAAa,CAAC,EAAE,YAAY,CAAA;IAC5B,WAAW,CAAC,EAAE,YAAY,CAAA;IAC1B,WAAW,CAAC,EAAE,YAAY,CAAA;IAC1B,OAAO,CAAC,EAAE,YAAY,CAAA;IACtB,4BAA4B,CAAC,EAAE,YAAY,CAAA;IAC3C,oCAAoC,CAAC,EAAE,YAAY,CAAA;IACnD,YAAY,CAAC,EAAE,YAAY,CAAA;IAC3B,WAAW,CAAC,EAAE,YAAY,CAAA;IAC1B,IAAI,CAAC,EAAE,YAAY,CAAA;IACnB,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB,UAAU,CAAC,EAAE,YAAY,CAAA;IACzB,aAAa,CAAC,EAAE,YAAY,CAAA;IAC5B,iBAAiB,CAAC,EAAE,YAAY,CAAA;IAChC,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB,GAAG,CAAC,EAAE,YAAY,CAAA;IAClB,OAAO,CAAC,EAAE,YAAY,CAAA;IACtB,SAAS,CAAC,EAAE,YAAY,CAAA;IACxB,cAAc,CAAC,EAAE,YAAY,CAAA;IAC7B,gBAAgB,CAAC,EAAE,YAAY,CAAA;IAC/B,wBAAwB,CAAC,EAAE,YAAY,CAAA;IACvC,gCAAgC,CAAC,EAAE,YAAY,CAAA;IAC/C,0BAA0B,CAAC,EAAE,YAAY,CAAA;IACzC,gBAAgB,CAAC,EAAE,YAAY,CAAA;IAC/B,eAAe,CAAC,EAAE,YAAY,CAAA;IAC9B,OAAO,CAAC,EAAE,YAAY,CAAA;IACtB,mBAAmB,CAAC,EAAE,YAAY,CAAA;IAClC,iBAAiB,CAAC,EAAE,YAAY,CAAA;IAChC,WAAW,CAAC,EAAE,YAAY,CAAA;IAC1B,mBAAmB,CAAC,EAAE,YAAY,CAAA;IAClC,wBAAwB,CAAC,EAAE,YAAY,CAAA;IACvC,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB,YAAY,CAAC,EAAE,YAAY,CAAA;IAC3B,iBAAiB,CAAC,EAAE,YAAY,CAAA;IAChC,WAAW,CAAC,EAAE,YAAY,CAAA;IAC1B,uBAAuB,CAAC,EAAE,YAAY,CAAA;IACtC,WAAW,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,CAAA;IACtC,WAAW,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,CAAA;IACtC,YAAY,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,CAAA;IACvC,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,yBAAyB,CAAC,EAAE,yBAAyB,CAAC,YAAY,CAAC,CAAA;IACnE,cAAc,CAAC,EAAE,aAAa,EAAE,CAAA;IAChC,uBAAuB,CAAC,EAAE,YAAY,EAAE,CAAA;IACxC,6BAA6B,CAAC,EAAE,YAAY,CAAA;IAC5C,0BAA0B,CAAC,EAAE,YAAY,EAAE,CAAA;IAC3C,qBAAqB,CAAC,EAAE,YAAY,CAAA;IACpC,0BAA0B,CAAC,EAAE,YAAY,CAAA;IACzC,UAAU,EAAE,wBAAwB,EAAE,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,OAAO,GACf,SAAS,GACT,SAAS,GACT,WAAW,GACX,WAAW,GACX,SAAS,GACT,YAAY,GACZ,SAAS,GACT,YAAY,GACZ,SAAS,GACT,wBAAwB,GACxB,QAAQ,GACR,UAAU,GACV,UAAU,GACV,QAAQ,GACR,OAAO,GACP,UAAU,GACV,YAAY,GACZ,SAAS,GACT,QAAQ,GACR,SAAS,GACT,SAAS,GACT,oBAAoB,GACpB,OAAO,GACP,SAAS,GACT,SAAS,GACT,QAAQ,GACR,SAAS,GACT,SAAS,GACT,OAAO,GACP,QAAQ,GACR,WAAW,GACX,WAAW,GACX,SAAS,GACT,OAAO,GACP,WAAW,GACX,SAAS,GACT,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,YAAY,GACZ,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,WAAW,GACX,UAAU,GACV,UAAU,GACV,OAAO,GACP,WAAW,GACX,QAAQ,GACR,SAAS,GACT,aAAa,GACb,aAAa,GACb,SAAS,GACT,UAAU,GACV,QAAQ,GACR,UAAU,GACV,aAAa,GACb,QAAQ,GACR,UAAU,GACV,aAAa,GACb,OAAO,GACP,SAAS,GACT,QAAQ,GACR,cAAc,GACd,QAAQ,GACR,WAAW,GACX,UAAU,GACV,UAAU,GACV,cAAc,GACd,OAAO,GACP,QAAQ,GACR,aAAa,GACb,QAAQ,GACR,UAAU,GACV,SAAS,GACT,QAAQ,GACR,KAAK,GACL,QAAQ,GACR,IAAI,GACJ,SAAS,GACT,KAAK,GACL,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,SAAS,GACT,aAAa,GACb,WAAW,GACX,MAAM,GACN,SAAS,GACT,SAAS,GACT,SAAS,GACT,SAAS,GACT,OAAO,GACP,gBAAgB,GAChB,OAAO,GACP,UAAU,GACV,SAAS,GACT,OAAO,GACP,YAAY,GACZ,YAAY,GACZ,WAAW,GACX,aAAa,GACb,WAAW,GACX,aAAa,GACb,eAAe,GACf,gBAAgB,GAChB,SAAS,GACT,QAAQ,GACR,UAAU,GACV,YAAY,GACZ,qBAAqB,GACrB,SAAS,GACT,OAAO,GACP,uBAAuB,GACvB,qBAAqB,GACrB,UAAU,GACV,SAAS,GACT,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,kCAAkC,GAClC,UAAU,GACV,eAAe,GACf,gCAAgC,GAChC,cAAc,GACd,SAAS,GACT,UAAU,GACV,YAAY,GACZ,uBAAuB,GACvB,gBAAgB,GAChB,0BAA0B,GAC1B,MAAM,GACN,kBAAkB,GAClB,eAAe,GACf,SAAS,GACT,OAAO,GACP,cAAc,GACd,MAAM,GACN,SAAS,GACT,kCAAkC,GAClC,UAAU,GACV,UAAU,GACV,YAAY,GACZ,mBAAmB,GACnB,SAAS,GACT,UAAU,GACV,kBAAkB,GAClB,eAAe,GACf,gCAAgC,GAChC,MAAM,GACN,eAAe,GACf,kBAAkB,GAClB,6BAA6B,GAC7B,OAAO,GACP,QAAQ,GACR,WAAW,GACX,WAAW,GACX,SAAS,GACT,YAAY,GACZ,MAAM,GACN,QAAQ,GACR,eAAe,GACf,QAAQ,GACR,mCAAmC,GACnC,MAAM,GACN,MAAM,GACN,aAAa,GACb,aAAa,GACb,SAAS,GACT,UAAU,GACV,YAAY,GACZ,MAAM,GACN,SAAS,GACT,SAAS,GACT,SAAS,GACT,OAAO,GACP,eAAe,GACf,OAAO,GACP,YAAY,GACZ,QAAQ,GACR,MAAM,GACN,kBAAkB,GAClB,YAAY,GACZ,YAAY,GACZ,SAAS,GACT,SAAS,GACT,QAAQ,GACR,UAAU,GACV,YAAY,GACZ,YAAY,GACZ,SAAS,GACT,SAAS,GACT,OAAO,GACP,OAAO,GACP,eAAe,GACf,OAAO,GACP,MAAM,GACN,gBAAgB,GAChB,iBAAiB,GACjB,0BAA0B,GAC1B,aAAa,GACb,iBAAiB,GACjB,OAAO,GACP,WAAW,GACX,kBAAkB,GAClB,UAAU,GACV,SAAS,GACT,QAAQ,GACR,kBAAkB,GAClB,8CAA8C,GAC9C,uBAAuB,GACvB,aAAa,GACb,cAAc,GACd,2BAA2B,GAC3B,kCAAkC,GAClC,OAAO,GACP,YAAY,GACZ,uBAAuB,GACvB,SAAS,GACT,YAAY,GACZ,cAAc,GACd,cAAc,GACd,iBAAiB,GACjB,SAAS,GACT,8CAA8C,GAC9C,aAAa,GACb,OAAO,GACP,UAAU,GACV,wBAAwB,GACxB,UAAU,GACV,OAAO,GACP,YAAY,GACZ,UAAU,GACV,MAAM,GACN,SAAS,GACT,OAAO,GACP,qBAAqB,GACrB,cAAc,GACd,0BAA0B,GAC1B,QAAQ,GACR,sCAAsC,GACtC,YAAY,GACZ,SAAS,GACT,cAAc,GACd,wBAAwB,GACxB,mBAAmB,GACnB,mBAAmB,GACnB,gBAAgB,GAChB,OAAO,GACP,YAAY,GACZ,QAAQ,GACR,UAAU,GACV,eAAe,CAAA;AAEnB,MAAM,MAAM,mBAAmB,GAAG;IAChC,SAAS,EAAE,kBAAkB,CAAA;IAC7B,KAAK,EAAE,cAAc,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAC1B,eAAe,GACf,gBAAgB,GAChB,iBAAiB,GACjB,4BAA4B,GAC5B,qCAAqC,GACrC,oBAAoB,CAAA;AAExB,MAAM,MAAM,eAAe,GAAG;IAC5B,aAAa,CAAC,EAAE,mBAAmB,EAAE,CAAA;IACrC,YAAY,EAAE,cAAc,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,cAAc,GAAG,eAAe,GAAG,QAAQ,GAAG,SAAS,CAAA;AAEnE,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,MAAM,GAAG,YAAY,IAAI;IACxD,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,cAAc,CAAC,EAAE,CAAC,CAAA;IAClB,uBAAuB,EAAE,OAAO,CAAA;IAChC,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,WAAW,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,CAAA;IACtC,GAAG,CAAC,EAAE,YAAY,CAAA;IAClB,cAAc,CAAC,EAAE,YAAY,CAAA;IAC7B,QAAQ,CAAC,EAAE,YAAY,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC,KAAK,EAAE,SAAS,CAAA;IAChB,QAAQ,CAAC,EAAE,SAAS,CAAA;IACpB,IAAI,CAAC,EAAE,YAAY,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,YAAY,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAC7B,oBAAoB,CAAC,EAAE,MAAM,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,YAAY,GACpB,aAAa,GACb,IAAI,GACJ,yBAAyB,GACzB,iBAAiB,GACjB,UAAU,GACV,IAAI,GACJ,iBAAiB,GACjB,OAAO,GACP,OAAO,GACP,MAAM,GACN,WAAW,GACX,UAAU,GACV,iBAAiB,GACjB,sBAAsB,GACtB,kBAAkB,GAClB,aAAa,GACb,4BAA4B,GAC5B,UAAU,GACV,aAAa,GACb,MAAM,GACN,aAAa,GACb,OAAO,GACP,sBAAsB,GACtB,uBAAuB,GACvB,UAAU,GACV,QAAQ,GACR,cAAc,GACd,UAAU,GACV,gBAAgB,GAChB,YAAY,GACZ,WAAW,GACX,WAAW,GACX,iBAAiB,GACjB,QAAQ,GACR,eAAe,GACf,MAAM,GACN,sBAAsB,GACtB,aAAa,GACb,mBAAmB,GACnB,SAAS,GACT,YAAY,GACZ,eAAe,GACf,mBAAmB,GACnB,YAAY,GACZ,WAAW,GACX,YAAY,GACZ,yBAAyB,GACzB,gBAAgB,GAChB,mBAAmB,GACnB,iBAAiB,GACjB,6BAA6B,GAC7B,wBAAwB,GACxB,gBAAgB,GAChB,2BAA2B,GAC3B,gBAAgB,GAChB,kBAAkB,GAClB,YAAY,GACZ,uBAAuB,GACvB,gBAAgB,GAChB,mBAAmB,GACnB,WAAW,GACX,mBAAmB,GACnB,+BAA+B,GAC/B,eAAe,GACf,uBAAuB,GACvB,6BAA6B,GAC7B,qBAAqB,GACrB,KAAK,GACL,MAAM,GACN,QAAQ,GACR,WAAW,GACX,aAAa,GACb,+BAA+B,GAC/B,cAAc,GACd,kCAAkC,GAClC,sBAAsB,GACtB,YAAY,GACZ,0BAA0B,GAC1B,sBAAsB,GACtB,oBAAoB,GACpB,eAAe,CAAA;AAEnB,MAAM,MAAM,yBAAyB,CAAC,CAAC,SAAS,MAAM,GAAG,YAAY,IAAI;IACvE,YAAY,CAAC,EAAE,CAAC,CAAA;IAChB,YAAY,CAAC,EAAE,CAAC,CAAA;IAChB,YAAY,CAAC,EAAE,CAAC,CAAA;IAChB,UAAU,CAAC,EAAE,CAAC,CAAA;IACd,kBAAkB,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAA;CAC3C,CAAA;AAED,MAAM,MAAM,eAAe,GACvB,SAAS,GACT,eAAe,GACf,UAAU,GACV,MAAM,GACN,YAAY,GACZ,iBAAiB,GACjB,gBAAgB,GAChB,0BAA0B,GAC1B,sBAAsB,CAAA;AAE1B,MAAM,MAAM,SAAS,GAAG;IACtB,YAAY,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,EAAE,MAAM,CAAA;IACd,cAAc,EAAE,MAAM,CAAA;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,eAAe,EAAE,MAAM,CAAA;IACvB,QAAQ,EAAE,OAAO,CAAA;IACjB,WAAW,EAAE,IAAI,CAAA;IACjB,YAAY,EAAE,IAAI,CAAA;IAClB,YAAY,EAAE,eAAe,CAAA;IAC7B,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,MAAM,CAAA;IACrB,oBAAoB,EAAE,MAAM,CAAA;IAC5B,eAAe,EAAE,MAAM,CAAA;IACvB,qBAAqB,EAAE,MAAM,CAAA;IAC7B,uBAAuB,EAAE,MAAM,CAAA;CAChC,CAAA;AAED,MAAM,MAAM,eAAe,GACvB,QAAQ,GACR,UAAU,GACV,cAAc,GACd,UAAU,GACV,kBAAkB,GAClB,YAAY,CAAA;AAEhB,MAAM,MAAM,qBAAqB,GAAG;IAClC,WAAW,EAAE,OAAO,CAAA;IACpB,aAAa,EAAE,OAAO,CAAA;IACtB,iBAAiB,EAAE,OAAO,CAAA;IAC1B,aAAa,EAAE,OAAO,CAAA;IACtB,eAAe,EAAE,OAAO,CAAA;IACxB,6BAA6B,EAAE,OAAO,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,MAAM,GACd,SAAS,GACT,QAAQ,GACR,SAAS,GACT,SAAS,GACT,UAAU,GACV,8BAA8B,GAC9B,kBAAkB,GAClB,YAAY,GACZ,UAAU,GACV,aAAa,GACb,UAAU,GACV,sBAAsB,GACtB,SAAS,GACT,SAAS,GACT,QAAQ,GACR,OAAO,GACP,UAAU,GACV,SAAS,GACT,MAAM,GACN,QAAQ,GACR,UAAU,GACV,WAAW,GACX,OAAO,GACP,UAAU,GACV,UAAU,GACV,eAAe,GACf,UAAU,GACV,WAAW,GACX,aAAa,GACb,UAAU,GACV,SAAS,GACT,UAAU,GACV,QAAQ,GACR,eAAe,GACf,eAAe,GACf,YAAY,GACZ,YAAY,GACZ,iBAAiB,GACjB,UAAU,GACV,oBAAoB,GACpB,gBAAgB,GAChB,cAAc,GACd,aAAa,GACb,MAAM,GACN,UAAU,GACV,SAAS,GACT,QAAQ,GACR,cAAc,GACd,QAAQ,GACR,YAAY,GACZ,cAAc,GACd,cAAc,GACd,iBAAiB,GACjB,gBAAgB,GAChB,cAAc,GACd,UAAU,GACV,WAAW,GACX,OAAO,GACP,MAAM,GACN,SAAS,GACT,UAAU,GACV,UAAU,GACV,YAAY,GACZ,mBAAmB,GACnB,eAAe,GACf,WAAW,GACX,SAAS,GACT,OAAO,GACP,kBAAkB,GAClB,SAAS,GACT,2BAA2B,GAC3B,YAAY,GACZ,iBAAiB,GACjB,WAAW,GACX,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,WAAW,GACX,eAAe,GACf,YAAY,GACZ,UAAU,GACV,SAAS,GACT,UAAU,GACV,SAAS,GACT,iBAAiB,GACjB,mBAAmB,GACnB,wBAAwB,GACxB,mBAAmB,GACnB,SAAS,GACT,SAAS,GACT,WAAW,GACX,QAAQ,GACR,oBAAoB,GACpB,gBAAgB,GAChB,aAAa,GACb,SAAS,GACT,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,WAAW,GACX,iBAAiB,GACjB,SAAS,GACT,QAAQ,GACR,SAAS,GACT,YAAY,GACZ,SAAS,GACT,WAAW,GACX,gBAAgB,GAChB,qBAAqB,GACrB,UAAU,GACV,QAAQ,GACR,4BAA4B,GAC5B,cAAc,GACd,0BAA0B,GAC1B,UAAU,GACV,sBAAsB,GACtB,WAAW,GACX,gBAAgB,GAChB,mBAAmB,GACnB,uBAAuB,GACvB,SAAS,GACT,sBAAsB,GACtB,kBAAkB,GAClB,UAAU,GACV,aAAa,GACb,cAAc,GACd,MAAM,GACN,QAAQ,GACR,YAAY,GACZ,gBAAgB,GAChB,gBAAgB,GAChB,OAAO,GACP,OAAO,GACP,6BAA6B,GAC7B,SAAS,GACT,SAAS,GACT,SAAS,GACT,YAAY,CAAA;AAEhB,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,QAAQ,CAAA;AAE7C,MAAM,MAAM,wBAAwB,GAAG;IACrC,GAAG,CAAC,EAAE,SAAS,CAAA;IACf,GAAG,CAAC,EAAE,SAAS,CAAA;IACf,OAAO,CAAC,EAAE,aAAa,CAAA;IACvB,UAAU,CAAC,EAAE,SAAS,CAAA;IACtB,iBAAiB,CAAC,EAAE,SAAS,CAAA;IAC7B,aAAa,CAAC,EAAE,SAAS,CAAA;IACzB,SAAS,CAAC,EAAE,0BAA0B,CAAA;IACtC,cAAc,CAAC,EAAE,0BAA0B,CAAA;CAC5C,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;KACxB,GAAG,IAAI,YAAY,GAAG,oBAAoB;CAC5C,CAAA;AAED,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,MAAM,GAAG,YAAY,IAAI;IAC9D,YAAY,CAAC,EAAE,CAAC,CAAA;IAChB,WAAW,CAAC,EAAE,CAAC,CAAA;IACf,aAAa,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAA;IAC7B,UAAU,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,SAAS,CAAC,EAAE,YAAY,CAAA;IACxB,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB,yBAAyB,CAAC,EAAE,YAAY,CAAA;IACxC,aAAa,CAAC,EAAE,YAAY,CAAA;IAC5B,WAAW,CAAC,EAAE,YAAY,CAAA;IAC1B,WAAW,CAAC,EAAE,YAAY,CAAA;IAC1B,OAAO,CAAC,EAAE,YAAY,CAAA;IACtB,4BAA4B,CAAC,EAAE,YAAY,CAAA;IAC3C,oCAAoC,CAAC,EAAE,YAAY,CAAA;IACnD,YAAY,CAAC,EAAE,YAAY,CAAA;IAC3B,WAAW,CAAC,EAAE,YAAY,CAAA;IAC1B,IAAI,CAAC,EAAE,YAAY,CAAA;IACnB,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB,UAAU,CAAC,EAAE,YAAY,CAAA;IACzB,aAAa,CAAC,EAAE,YAAY,CAAA;IAC5B,iBAAiB,CAAC,EAAE,YAAY,CAAA;IAChC,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB,GAAG,CAAC,EAAE,YAAY,CAAA;IAClB,OAAO,CAAC,EAAE,YAAY,CAAA;IACtB,SAAS,CAAC,EAAE,YAAY,CAAA;IACxB,WAAW,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,CAAA;IACtC,WAAW,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,CAAA;IACtC,YAAY,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,CAAA;IACvC,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,cAAc,CAAC,EAAE,YAAY,CAAA;IAC7B,gBAAgB,CAAC,EAAE,YAAY,CAAA;IAC/B,wBAAwB,CAAC,EAAE,YAAY,CAAA;IACvC,gCAAgC,CAAC,EAAE,YAAY,CAAA;IAC/C,0BAA0B,CAAC,EAAE,YAAY,CAAA;IACzC,gBAAgB,CAAC,EAAE,YAAY,CAAA;IAC/B,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB,yBAAyB,CAAC,EAAE,yBAAyB,CAAC,YAAY,CAAC,CAAA;IACnE,eAAe,CAAC,EAAE,YAAY,CAAA;IAC9B,OAAO,CAAC,EAAE,YAAY,CAAA;IACtB,mBAAmB,CAAC,EAAE,YAAY,CAAA;IAClC,iBAAiB,CAAC,EAAE,YAAY,CAAA;IAChC,WAAW,CAAC,EAAE,YAAY,CAAA;IAC1B,mBAAmB,CAAC,EAAE,YAAY,CAAA;IAClC,wBAAwB,CAAC,EAAE,YAAY,CAAA;IACvC,cAAc,CAAC,EAAE,aAAa,EAAE,CAAA;IAChC,YAAY,CAAC,EAAE,YAAY,CAAA;IAC3B,iBAAiB,CAAC,EAAE,YAAY,CAAA;IAChC,WAAW,CAAC,EAAE,YAAY,CAAA;IAC1B,uBAAuB,CAAC,EAAE,YAAY,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,WAAW,CAAA"}

package/build/src/types/docScanning.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/src/types/nodeReports.d.ts

@@ -0,0 +1,80 @@
+import { FSNodeType, FSNodeId, FSLivenessDetectionOutcome, FSEnterEmailOutcome, FSDocumentScanOutcome, FSRecognitionOutcome, FSFaceScanOutcome, FSTwoFactorOutcome } from "./nodes";
+import { DocumentScanReport } from "./docScanning";
+export type NodeReportBase = {
+    type: FSNodeType;
+    nodeId: string;
+    createdAt: number;
+};
+export type TwoFactorReport = {
+    email: string;
+    phoneNumber?: never;
+} | {
+    phoneNumber: string;
+    email?: never;
+} | {
+    email: string;
+    phoneNumber: string;
+};
+export type TwoFactorEmailNodeReport = NodeReportBase & {
+    type: FSNodeType.TWO_FACTOR_EMAIL;
+    outcome: FSTwoFactorOutcome;
+    report?: TwoFactorReport;
+};
+export type TwoFactorSMSNodeReport = NodeReportBase & {
+    type: FSNodeType.TWO_FACTOR_SMS;
+    outcome: FSTwoFactorOutcome;
+    report?: TwoFactorReport;
+};
+export type CompareFacesReport = {
+    isMatch: boolean;
+    similarity?: number;
+    sourceImageFaceFound: boolean;
+    targetImageFaceFound: boolean;
+    error?: string;
+};
+export type FaceScanReport = {
+    livenessChallengePassed?: boolean;
+    aiLivenessCheckPassed?: boolean;
+    compareFacesReport?: CompareFacesReport;
+};
+export type FaceScanNodeReport = NodeReportBase & {
+    type: FSNodeType.FACE_SCAN;
+    outcome: FSFaceScanOutcome;
+    report?: FaceScanReport;
+};
+export type RecognitionReport = Record<string, string> & {
+    name?: string;
+    email?: string;
+    phone?: string;
+    company?: string;
+    jobTitle?: string;
+};
+export type RecognitionNodeReport = NodeReportBase & {
+    type: FSNodeType.RECOGNITION;
+    outcome: FSRecognitionOutcome;
+    report?: RecognitionReport;
+};
+export type DocumentScanNodeReport = NodeReportBase & {
+    type: FSNodeType.DOCUMENT_SCAN;
+    outcome: FSDocumentScanOutcome;
+    report?: DocumentScanReport;
+};
+export type DataValidationNodeReport = NodeReportBase & {
+    type: FSNodeType.DATA_VALIDATION;
+    outcome: FSNodeId;
+};
+export type EnterEmailNodeReport = NodeReportBase & {
+    type: FSNodeType.ENTER_EMAIL;
+    outcome: FSEnterEmailOutcome;
+    email?: string;
+};
+export type LivenessDetectionNodeReport = NodeReportBase & {
+    type: FSNodeType.LIVENESS_DETECTION;
+    outcome: FSLivenessDetectionOutcome;
+};
+export type ConversationNodeReport = NodeReportBase & {
+    type: FSNodeType.CONVERSATION;
+    outcome: FSNodeId;
+};
+export type NodeReport = ConversationNodeReport | LivenessDetectionNodeReport | EnterEmailNodeReport | DataValidationNodeReport | DocumentScanNodeReport | RecognitionNodeReport | TwoFactorEmailNodeReport | TwoFactorSMSNodeReport | FaceScanNodeReport;
+//# sourceMappingURL=nodeReports.d.ts.map

package/build/src/types/nodeReports.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nodeReports.d.ts","sourceRoot":"","sources":["../../../src/types/nodeReports.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,QAAQ,EACR,0BAA0B,EAC1B,mBAAmB,EACnB,qBAAqB,EACrB,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EACnB,MAAM,SAAS,CAAA;AAEhB,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAElD,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,UAAU,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,eAAe,GACvB;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,KAAK,CAAA;CAAE,GACtC;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,GACtC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,CAAA;AAE1C,MAAM,MAAM,wBAAwB,GAAG,cAAc,GAAG;IACtD,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAA;IACjC,OAAO,EAAE,kBAAkB,CAAA;IAC3B,MAAM,CAAC,EAAE,eAAe,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,cAAc,GAAG;IACpD,IAAI,EAAE,UAAU,CAAC,cAAc,CAAA;IAC/B,OAAO,EAAE,kBAAkB,CAAA;IAC3B,MAAM,CAAC,EAAE,eAAe,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,oBAAoB,EAAE,OAAO,CAAA;IAC7B,oBAAoB,EAAE,OAAO,CAAA;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,uBAAuB,CAAC,EAAE,OAAO,CAAA;IACjC,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,kBAAkB,CAAC,EAAE,kBAAkB,CAAA;CACxC,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG;IAChD,IAAI,EAAE,UAAU,CAAC,SAAS,CAAA;IAC1B,OAAO,EAAE,iBAAiB,CAAA;IAC1B,MAAM,CAAC,EAAE,cAAc,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG;IACvD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,cAAc,GAAG;IACnD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,OAAO,EAAE,oBAAoB,CAAA;IAC7B,MAAM,CAAC,EAAE,iBAAiB,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,cAAc,GAAG;IACpD,IAAI,EAAE,UAAU,CAAC,aAAa,CAAA;IAC9B,OAAO,EAAE,qBAAqB,CAAA;IAC9B,MAAM,CAAC,EAAE,kBAAkB,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG,cAAc,GAAG;IACtD,IAAI,EAAE,UAAU,CAAC,eAAe,CAAA;IAChC,OAAO,EAAE,QAAQ,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG;IAClD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,OAAO,EAAE,mBAAmB,CAAA;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG,cAAc,GAAG;IACzD,IAAI,EAAE,UAAU,CAAC,kBAAkB,CAAA;IACnC,OAAO,EAAE,0BAA0B,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,cAAc,GAAG;IACpD,IAAI,EAAE,UAAU,CAAC,YAAY,CAAA;IAC7B,OAAO,EAAE,QAAQ,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,UAAU,GAClB,sBAAsB,GACtB,2BAA2B,GAC3B,oBAAoB,GACpB,wBAAwB,GACxB,sBAAsB,GACtB,qBAAqB,GACrB,wBAAwB,GACxB,sBAAsB,GACtB,kBAAkB,CAAA"}

package/build/src/types/nodeReports.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/src/types/nodes.d.ts

@@ -0,0 +1,135 @@
+import { DocumentType, ScanningMode } from "./docScanning";
+export type NonEmptyArray<T> = [T, ...Array<T>];
+export declare enum FSNodeType {
+    START = "start",
+    END = "end",
+    CONVERSATION = "conversation",
+    LIVENESS_DETECTION = "liveness_detection",
+    ENTER_EMAIL = "enter_email",
+    DATA_VALIDATION = "data_validation",
+    DOCUMENT_SCAN = "document_scan",
+    RECOGNITION = "recognition",
+    FACE_SCAN = "face_scan",
+    TWO_FACTOR_EMAIL = "two_factor_email",
+    TWO_FACTOR_SMS = "two_factor_sms"
+}
+export interface FSNodeBase {
+    id: string;
+    type: FSNodeType;
+}
+export type FSNodeId = string;
+export interface FSStartNode extends FSNodeBase {
+    type: FSNodeType.START;
+    outcome: FSNodeId;
+}
+export interface FSConditionalOutcome {
+    id: string;
+    targetNodeId: string;
+    condition: string;
+}
+export interface FSConversationNode extends FSNodeBase {
+    type: FSNodeType.CONVERSATION;
+    prompt: string;
+    outcomes: NonEmptyArray<FSConditionalOutcome>;
+    doesNotRequireReply?: boolean;
+}
+export declare enum FSLivenessDetectionOutcome {
+    LIVENESS_DETECTED = "livenessDetected",
+    DEEPFAKE_DETECTED = "deepfakeDetected",
+    NO_FACE = "noFace"
+}
+export interface FSLivenessDetectionNode extends FSNodeBase {
+    type: FSNodeType.LIVENESS_DETECTION;
+    outcomes: Record<FSLivenessDetectionOutcome, FSNodeId>;
+}
+export declare enum FSEnterEmailOutcome {
+    EMAIL_ENTERED = "emailEntered",
+    CANCELED = "canceled"
+}
+export interface FSEnterEmailNode extends FSNodeBase {
+    type: FSNodeType.ENTER_EMAIL;
+    outcomes: Record<FSEnterEmailOutcome, FSNodeId>;
+}
+export interface FSDataValidationNode extends FSNodeBase {
+    type: FSNodeType.DATA_VALIDATION;
+    outcomes: NonEmptyArray<FSConditionalOutcome>;
+    validation: {
+        field: string;
+        action: string;
+        value?: string;
+    };
+}
+export declare enum FSRecognitionOutcome {
+    RECOGNIZED = "recognized",
+    NEW_USER = "newUser",
+    NO_FACE = "noFace"
+}
+export interface FSRecognitionNode extends FSNodeBase {
+    type: FSNodeType.RECOGNITION;
+    outcomes: Record<FSRecognitionOutcome, FSNodeId>;
+}
+export type FSDocumentType = DocumentType;
+export declare enum FSDocumentScanOutcome {
+    SCAN_SUCCESS = "scanSuccess",
+    USER_CANCELLED = "userCancelled",
+    TIMEOUT = "scanTimeout"
+}
+export type FSDocumentScanMode = ScanningMode;
+export interface FSDocumentScanNode extends FSNodeBase {
+    type: FSNodeType.DOCUMENT_SCAN;
+    scanningMode: FSDocumentScanMode;
+    allowedDocumentTypes: FSDocumentType[];
+    outcomes: Record<FSDocumentScanOutcome, FSNodeId>;
+    showTorchButton?: boolean;
+    showCameraSwitch?: boolean;
+    showMirrorCameraButton?: boolean;
+}
+export interface FSEndNode extends FSNodeBase {
+    type: FSNodeType.END;
+}
+export declare enum FSFaceScanOutcome {
+    PASSED = "passed",
+    NOT_PASSED = "notPassed",
+    CANCELLED = "cancelled",
+    ERROR = "error"
+}
+export interface FSFaceScanNode extends FSNodeBase {
+    type: FSNodeType.FACE_SCAN;
+    outcomes: Record<FSFaceScanOutcome, FSNodeId>;
+    captureInstructions?: string;
+    requireLivenessChallenge?: boolean;
+    requireAILivenessCheck?: boolean;
+    referenceImageKey?: string;
+    similarityThreshold?: number;
+    enableSound?: boolean;
+    enableHaptics?: boolean;
+}
+export declare enum FSTwoFactorChannel {
+    EMAIL = "email",
+    SMS = "sms"
+}
+export declare enum FSTwoFactorOutcome {
+    VERIFIED = "verified",
+    DELIVERY_FAILED = "delivery_failed",
+    FAILED_UNVERIFIED = "failed_unverified",
+    CANCELLED = "cancelled",
+    ERROR = "error"
+}
+export interface FSTwoFactorNode extends FSNodeBase {
+    outcomes: Record<FSTwoFactorOutcome, FSNodeId>;
+    otpLength?: number;
+    expirySeconds?: number;
+    maxAttempts?: number;
+    resendAfterSeconds?: number;
+    showUI?: boolean;
+}
+export interface FSTwoFactorNodeEmail extends FSTwoFactorNode {
+    type: FSNodeType.TWO_FACTOR_EMAIL;
+    emailTemplate?: string;
+}
+export interface FSTwoFactorNodeSMS extends FSTwoFactorNode {
+    type: FSNodeType.TWO_FACTOR_SMS;
+    smsTemplate?: string;
+}
+export type FSNode = FSStartNode | FSConversationNode | FSEndNode | FSEnterEmailNode | FSLivenessDetectionNode | FSDataValidationNode | FSDocumentScanNode | FSRecognitionNode | FSFaceScanNode | FSTwoFactorNodeEmail | FSTwoFactorNodeSMS;
+//# sourceMappingURL=nodes.d.ts.map

package/build/src/types/nodes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nodes.d.ts","sourceRoot":"","sources":["../../../src/types/nodes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAE1D,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;AAE/C,oBAAY,UAAU;IACpB,KAAK,UAAU;IACf,GAAG,QAAQ;IACX,YAAY,iBAAiB;IAC7B,kBAAkB,uBAAuB;IACzC,WAAW,gBAAgB;IAC3B,eAAe,oBAAoB;IACnC,aAAa,kBAAkB;IAC/B,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IACvB,gBAAgB,qBAAqB;IACrC,cAAc,mBAAmB;CAClC;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,UAAU,CAAA;CACjB;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAA;AAC7B,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,IAAI,EAAE,UAAU,CAAC,KAAK,CAAA;IACtB,OAAO,EAAE,QAAQ,CAAA;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAA;IACV,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,IAAI,EAAE,UAAU,CAAC,YAAY,CAAA;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAA;IAC7C,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC9B;AAED,oBAAY,0BAA0B;IACpC,iBAAiB,qBAAqB;IACtC,iBAAiB,qBAAqB;IACtC,OAAO,WAAW;CACnB;AAED,MAAM,WAAW,uBAAwB,SAAQ,UAAU;IACzD,IAAI,EAAE,UAAU,CAAC,kBAAkB,CAAA;IACnC,QAAQ,EAAE,MAAM,CAAC,0BAA0B,EAAE,QAAQ,CAAC,CAAA;CACvD;AAED,oBAAY,mBAAmB;IAC7B,aAAa,iBAAiB;IAC9B,QAAQ,aAAa;CACtB;AACD,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,QAAQ,EAAE,MAAM,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAA;CAChD;AAED,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACtD,IAAI,EAAE,UAAU,CAAC,eAAe,CAAA;IAChC,QAAQ,EAAE,aAAa,CAAC,oBAAoB,CAAC,CAAA;IAC7C,UAAU,EAAE;QACV,KAAK,EAAE,MAAM,CAAA;QACb,MAAM,EAAE,MAAM,CAAA;QACd,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,CAAA;CACF;AAED,oBAAY,oBAAoB;IAC9B,UAAU,eAAe;IACzB,QAAQ,YAAY;IACpB,OAAO,WAAW;CACnB;AAED,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAA;IAC5B,QAAQ,EAAE,MAAM,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAA;CACjD;AAED,MAAM,MAAM,cAAc,GAAG,YAAY,CAAA;AAEzC,oBAAY,qBAAqB;IAC/B,YAAY,gBAAgB;IAE5B,cAAc,kBAAkB;IAChC,OAAO,gBAAgB;CAGxB;AAED,MAAM,MAAM,kBAAkB,GAAG,YAAY,CAAA;AAE7C,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,IAAI,EAAE,UAAU,CAAC,aAAa,CAAA;IAC9B,YAAY,EAAE,kBAAkB,CAAA;IAChC,oBAAoB,EAAE,cAAc,EAAE,CAAA;IAEtC,QAAQ,EAAE,MAAM,CAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAA;IACjD,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,sBAAsB,CAAC,EAAE,OAAO,CAAA;CACjC;AAED,MAAM,WAAW,SAAU,SAAQ,UAAU;IAC3C,IAAI,EAAE,UAAU,CAAC,GAAG,CAAA;CACrB;AAED,oBAAY,iBAAiB;IAC3B,MAAM,WAAW;IACjB,UAAU,cAAc;IACxB,SAAS,cAAc;IACvB,KAAK,UAAU;CAChB;AAED,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,IAAI,EAAE,UAAU,CAAC,SAAS,CAAA;IAC1B,QAAQ,EAAE,MAAM,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAA;IAG7C,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAClC,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAChC,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAG5B,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB;AAED,oBAAY,kBAAkB;IAC5B,KAAK,UAAU;IACf,GAAG,QAAQ;CACZ;AAED,oBAAY,kBAAkB;IAC5B,QAAQ,aAAa;IACrB,eAAe,oBAAoB;IACnC,iBAAiB,sBAAsB;IACvC,SAAS,cAAc;IACvB,KAAK,UAAU;CAChB;AAED,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,QAAQ,EAAE,MAAM,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAA;IAG9C,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAG3B,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,oBAAqB,SAAQ,eAAe;IAC3D,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAA;IACjC,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,kBAAmB,SAAQ,eAAe;IACzD,IAAI,EAAE,UAAU,CAAC,cAAc,CAAA;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,MAAM,MAAM,GACd,WAAW,GACX,kBAAkB,GAClB,SAAS,GACT,gBAAgB,GAChB,uBAAuB,GACvB,oBAAoB,GACpB,kBAAkB,GAClB,iBAAiB,GACjB,cAAc,GACd,oBAAoB,GACpB,kBAAkB,CAAA"}