onfido-sdk-ui 14.34.0 → 14.35.1

package/LICENSE

@@ -0,0 +1,268 @@
+Please see the terms of your Onfido Services Agreement which you are bound by with respect to your use of the Onfido
+SDK. To the extent the Onfido SDK includes copies or substantial portions of software licensed under third party terms
+and conditions this will be set out at https://documentation.onfido.com/sdk/sdk-licenses/
+
+In the event of any inconsistency between the Onfido Services Agreement and any third party terms and conditions, the
+third party terms and conditions shall take precedence over the rights and
+restrictions granted in the Onfido Services Agreement solely in respect of such third party dependencies set out
+at https://documentation.onfido.com/sdk/sdk-licenses/.
+
+------------------
+
+Name: @onfido/capture-shared
+Version: 2.4.6
+License: null
+Private: false
+Description: A shared library to use in various capture packages
+
+---
+
+Name: @sentry/utils
+Version: 7.64.0
+License: MIT
+Private: false
+Description: Utilities for all Sentry JavaScript SDKs
+Repository: undefined
+Homepage: https://github.com/getsentry/sentry-javascript/tree/master/packages/utils
+Author: Sentry
+License Copyright:
+===
+
+Copyright (c) 2019 Sentry (https://sentry.io) and individual contributors. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---
+
+Name: uuid-random
+Version: 1.3.2
+License: MIT
+Private: false
+Description: Fastest UUIDv4 with good RNG
+Repository: git+https://github.com/jchook/uuid-random.git
+Homepage: https://github.com/jchook/uuid-random#readme
+Author: Wes Roberts
+License Copyright:
+===
+
+Copyright (c) 2016-2019 Wes Roberts
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---
+
+Name: ua-parser-js
+Version: 1.0.36
+License: MIT
+Private: false
+Description: Detect Browser, Engine, OS, CPU, and Device type/model from User-Agent data. Supports browser & node.js environment
+Repository: https://github.com/faisalman/ua-parser-js.git
+Homepage: https://github.com/faisalman/ua-parser-js
+Author: Faisal Salman <f@faisalman.com> (http://faisalman.com)
+Contributors:
+  Aamir Poonawalla <aamir@urx.com>
+  Admas <mollases@users.noreply.github.com>
+  algenon <m@antonz.ru>
+  Alvin Portillo <alvin@8thwall.com>
+  Amumu <yoyo837@hotmail.com>
+  Andrea Vaghi <andrea.vaghi@jobrapido.com>
+  Anton Zhiyanov <m@antonz.ru>
+  Arturo Mejia <amejia@blim.com>
+  Arun Rama Reddy <arunramareddy@gmail.com>
+  Austin Pray <austin@austinpray.com>
+  Bendeguz <symunona@gmail.com>
+  Benjamin Bertrand <bertrand.design@gmail.com>
+  Benjamin Urban <benjamin.urban@sueddeutsche.de>
+  boneyao <admin@boneyao.com>
+  Carl C Von Lewin <carlchristianlewin@gmail.com>
+  CESAR RAMOS <c@imagenproactiva.com>
+  Chad Killingsworth <ckillingsworth@jackhenry.com>
+  Christopher De Cairos <chris.decairos@gmail.com>
+  Cyrille David <cyrille@qonto.eu>
+  Dario Vladovic <d.vladimyr@gmail.com>
+  David Annez <david.annez@gmail.com>
+  Davit Barbakadze <jayarjo@gmail.com>
+  ddivernois <david-emmanuel.divernois@amadeus.com>
+  Deliaz <D3liaz@gmail.com>
+  Demis Palma <demis.palma@gmail.com>
+  dhoko <aurelien@protonmail.com>
+  dianhe <dianhe@webank.com>
+  dineshks1 <dineshks1@d.kumar44@outlook.com>
+  Dmitry Tyschenko <dtyschenko@gmail.com>
+  Douglas Li <doug@knotch.it>
+  Dumitru Uzun <contact@duzun.me>
+  Dustin <duburns@fanatics.com>
+  Elchin Valiyev <elchin.valiyev@autodesk.com>
+  Emil Hesslow <hesslow@gmail.com>
+  Eric Redon <eric.redon@coox.org>
+  Eric Schrenker <eric.schrenker@gmail.com>
+  Erik Hesselink <hesselink@gmail.com>
+  Fabian Becker <halfdan@xnorfz.de>
+  Faisal Salman <f@faisalman.com>
+  Frédéric Camblor <fcamblor@gmail.com>
+  Frederik Ring <frederik.ring@gmail.com>
+  Gerald Host <me@jacobford.co.uk>
+  Germán M. Bravo <german.mb@gmail.com>
+  Grigory Dmitrenko <grigory@snsk.ru>
+  gulpin <gulping.gulpin@gmail.com>
+  Hendrik Helwich <h.helwich@iplabs.de>
+  Hermann Ebert <ebbmo@HE.local>
+  hr6r <hedian@gmail.com>
+  Igor Topal <i.topal@smartweb.com.ua>
+  Ildar Kamalov <i.kamalov@adguard.com>
+  insanehong <insane.hong@navercorp.com>
+  jackpoll <jackpoll123456@gmail.com>
+  Jake Mc <startswithaj@users.noreply.github.com>
+  JBYoshi <12983479+JBYoshi@users.noreply.github.com>
+  Joey Parrish <joeyparrish@google.com>
+  John Tantalo <john.tantalo@gmail.com>
+  John Yanarella <jmy@codecatalyst.com>
+  Jon Buckley <jon@jbuckley.ca>
+  Josh Goldberg <joshuakgoldberg@outlook.com>
+  Junki-Ishida <junki_ishida@dwango.co.jp>
+  Kendall Buchanan <kendall@kendagriff.com>
+  Lee Treveil <leetreveil@gmail.com>
+  leonardo <leofiore@libero.it>
+  Levente Balogh <balogh.levente.hu@gmail.com>
+  Liam Quinn <lquinn@blackberry.com>
+  Lithin <lithin@webklipper.com>
+  ll-syber <670159357@qq.com>
+  Loris Guignard <loris.guignard@gmail.com>
+  Lukas Drgon <lukas.drgon@gmail.com>
+  Lukas Eipert <leipert@users.noreply.github.com>
+  Malash <i@malash.me>
+  Martynas <martynas@firmfirm.co>
+  Masahiko Sato <masasato@yahoo-corp.jp>
+  Matt Brophy <matt@brophy.org>
+  Matthew Origer <karatecowboy@gmail.com>
+  Maximilian Haupt <mail@maximilianhaupt.com>
+  Max Maurer <maxemanuel.maurer@gmail.com>
+  Max Nordlund <max.nordlund@gmail.com>
+  Michael Hess <mhess@connectify.me>
+  MimyyK <michele.marais@hakisa.com>
+  naoh <naoh.cs03g@nctu.edu.tw>
+  Nicholas Ionata <nionata@ufl.edu>
+  Nikhil Motiani <nikhil.motiani@outlook.com>
+  Nik Rolls <nik@rolls.cc>
+  nionata <n.ionata129@gmail.com>
+  niris <nirisix@gmail.com>
+  Nobuo Okada <nookada@yahoo-corp.jp>
+  o.drapeza <o.drapeza@tinkoff.ru>
+  otakuSiD <otakusid@gmail.com>
+  patrick-nurt <github@pereira.dk>
+  Pavel Studeny <studeny@avast.com>
+  Peter Dave Hello <PeterDaveHello@users.noreply.github.com>
+  philippsimon <github@philippsimon.de>
+  Pieter Hendrickx <pieter.hendrickx@belfius.be>
+  Piper Chester <piperchester@gmail.com>
+  Queen Vinyl Darkscratch <vinyldarkscratch@gmail.com>
+  Raine Makelainen <raine.makelainen@jolla.com>
+  Raman Savaryn <homeneartheocean@gmail.com>
+  Robert Tod <robert@qubit.com>
+  roman.savarin <roman.savarin@skywindgroup.com>
+  Ron Korland <ron@testim.io>
+  Ross Noble <rosshnoble@gmail.com>
+  ruicong <466403866@qq.com>
+  Sandro Sonntag <sandro.sonntag@adorsys.de>
+  sgautrea <shanegautreau@gmail.com>
+  Shane Gautreau <sgautrea@opentext.com>
+  Shane Thacker <shane@steadymade.com>
+  Shreedhar <shreedhar@uber.com>
+  Simon Eisenmann <simon@longsleep.org>
+  Simon Lang <me@simonlang.org>
+  Stiekel <histkc@gmail.com>
+  sUP <dani3l@gmail.com>
+  Sylvain Gizard <sylvain.gizard@gmail.com>
+  szchenghuang <szchenghuang@gmail.com>
+  Tanguy Krotoff <tkrotoff@gmail.com>
+  Tony Tomarchio <tony@tomarchio.cc>
+  Ulrich Schmidt <u.schmidt@velian.de>
+  Vadim Kurachevsky <vadim@hmvs.org>
+  Yılmaz <yilmazdemir36@gmail.com>
+  yuanyang <work_yuanyang@163.com>
+  Yun Young-jin <yupmin@yupmin-office-macmini.local>
+  Zach Bjornson <zbbjornson@gmail.com>
+License Copyright:
+===
+
+MIT License
+
+Copyright (c) 2012-2023 Faisal Salman <<f@faisalman.com>>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+Name: js-cookie
+Version: 3.0.5
+License: MIT
+Private: false
+Description: A simple, lightweight JavaScript API for handling cookies
+Repository: git://github.com/js-cookie/js-cookie.git
+Author: Klaus Hartl
+License Copyright:
+===
+
+MIT License
+
+Copyright (c) 2018 Copyright 2018 Klaus Hartl, Fagner Brack, GitHub Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "onfido-sdk-ui",
-  "version": "14.34.0",
+  "version": "14.35.1",
   "description": "JavaScript SDK view layer for Onfido identity verification",
   "author": "Onfido Customer Support <support@onfido.com> (https://documentation.onfido.com/sdk/web/)",
   "repository": {

package/types/Events.d.ts

@@ -1,7 +1,7 @@
-import type { CaptureModule } from '@onfido/capture-shared/Types';
-import type { SdkError } from '@onfido/capture-shared/Error';
-import type { Event } from '@onfido/capture-shared/EventEmitter';
-import type { CompleteData } from '@onfido/capture-shared/SdkParameters';
+import type { CaptureModule } from './shared/Types';
+import type { SdkError } from './shared/Error';
+import type { Event } from './shared/EventEmitter';
+import type { CompleteData } from './shared/SdkParameters';
 export type ModuleEvent<T extends string> = {
     module: CaptureModule;
     id: string;

package/types/Onfido.d.ts

@@ -1,14 +1,293 @@
-import type { Listener } from '@onfido/capture-shared/EventEmitter';
-import type { SdkParameters } from '@onfido/capture-shared/SdkParameters';
-import type { CaptureRunEvents } from './Events';
-export type Handle = {
-    addEventListener: <EventName extends keyof CaptureRunEvents>(eventName: EventName, listener: Listener<CaptureRunEvents[EventName]>) => void;
-    removeEventListener: <EventName extends keyof CaptureRunEvents>(eventName: EventName, listener: Listener<CaptureRunEvents[EventName]>) => void;
-    tearDown: () => Promise<void>;
-    version?: string;
-};
-export declare const backwardCompatibility: (parameter: SdkParameters) => void;
-export type OnfidoApi = {
-    init: (parameter: SdkParameters) => Handle;
-};
-export declare const Onfido: OnfidoApi;
+import type { CaptureRunEvents } from './Events';
+
+export declare const backwardCompatibility: (parameter: SdkParameters) => void;
+
+declare type CaptureModule = HostedModule | ExternalModule;
+
+declare enum CaptureModuleType {
+    HOSTED = "hosted",
+    EXTERNAL = "external"
+}
+
+declare type ChallengePayload = {
+    type: 'recite';
+    query: number[];
+} | {
+    type: 'movement';
+    query: string;
+};
+
+export declare type ClassicSdkParameters = {
+    steps: LegacyStepDefinition[];
+} & TokenParameters;
+
+declare type Common = {
+    sdk_metadata: string;
+    sdk_source: string;
+    sdk_version: string;
+};
+
+declare type CommonSdkParameters = {
+    containerEl?: HTMLElement;
+    containerId?: string;
+    onError?: ErrorCallback_2;
+    onComplete?: (data: CompleteData) => void;
+    enterpriseFeatures?: EnterpriseFeatureParameter;
+    theme?: Theme;
+    customUI?: ThemeConfig;
+    language?: string | LegacyLanguageParameter;
+    translations?: Translations;
+};
+
+declare type CompleteData = Record<string, unknown>;
+
+declare type CrossDeviceMethod = 'copy_link' | 'qr_code' | 'sms';
+
+declare type CrossDevicePolicy = 'enable' | 'force' | 'disable';
+
+declare type CrossDeviceSdkParameters = CommonSdkParameters & {
+    roomId?: string;
+};
+
+declare type CustomCallbackFormatterType = 'raw' | 'formData';
+
+declare type DocumentImageResponse = {
+    applicant_id: string;
+    type: DocumentType_2;
+    side: DocumentSides;
+    issuing_country: string;
+    sdk_warnings: ImageQualityWarnings & {
+        image_quality: {
+            quality: string;
+            breakdown: {
+                document: {
+                    has_document: boolean;
+                    detection_score: number;
+                } & Score;
+                has_document: boolean;
+                cutoff: {
+                    has_cutoff: boolean;
+                    score: number;
+                } & Score;
+                blur: {
+                    has_blur: boolean;
+                    score: number;
+                    blur_model: string;
+                } & Score;
+                glare: {
+                    score: number;
+                    bbox: [number, number, number, number];
+                    has_glare: boolean;
+                    threshold: number;
+                    glare_model: string;
+                };
+                barcode: {
+                    result: string;
+                    properties: Record<string, string>;
+                };
+            };
+            image_quality_uuid: string;
+        };
+    };
+    classification: {
+        issuing_country: null;
+        document_version: null;
+        side?: DocumentSides;
+        document_type?: DocumentType_2;
+    };
+    document_features: {
+        has_nfc: boolean;
+    };
+} & UploadFileResponse;
+
+declare type DocumentSides = 'front' | 'back';
+
+declare type DocumentType_2 = 'driving_licence' | 'national_identity_card' | 'residence_permit' | 'passport';
+
+declare type EnterpriseCallbackResponse<T> = {
+    continueWithOnfidoSubmission?: boolean;
+    onfidoSuccessResponse?: T;
+};
+
+declare type EnterpriseFeatureCallback = {
+    useCustomizedApiRequests?: boolean;
+    formatter?: CustomCallbackFormatterType;
+    onSubmitDocument?: (data: FormData | SubmitDocument) => Promise<EnterpriseCallbackResponse<DocumentImageResponse>>;
+    onSubmitSelfie?: (data: FormData | SubmitSelfie) => Promise<EnterpriseCallbackResponse<UploadFileResponse>>;
+    onSubmitVideo?: (data: FormData | SubmitVideo) => Promise<EnterpriseCallbackResponse<FaceVideoResponse>>;
+};
+
+declare type EnterpriseFeatureParameter = EnterpriseFeatures & EnterpriseFeatureCallback;
+
+declare type EnterpriseFeatures = {
+    hideOnfidoLogo?: boolean;
+    cobrand?: {
+        text?: string;
+    };
+    logoCobrand?: {
+        lightLogoSrc?: string;
+        darkLogoSrc?: string;
+    };
+};
+
+declare type ErrorCallback_2 = (error: {
+    type: SdkErrorTypes;
+    message: string;
+    exception?: Error | unknown;
+}) => void;
+
+declare type Event_2<T extends string> = {
+    type: T;
+};
+
+declare type ExternalModule = {
+    url: string;
+} & ModuleType<CaptureModuleType.EXTERNAL>;
+
+declare type FaceVideoResponse = {
+    challenge: ChallengePayload[];
+    languages: VideoChallengeLanguage[];
+} & UploadFileResponse;
+
+export declare type Handle = {
+    addEventListener: <EventName extends keyof CaptureRunEvents>(eventName: EventName, listener: Listener<CaptureRunEvents[EventName]>) => void;
+    removeEventListener: <EventName extends keyof CaptureRunEvents>(eventName: EventName, listener: Listener<CaptureRunEvents[EventName]>) => void;
+    tearDown: () => Promise<void>;
+    version?: string;
+};
+
+declare type HostedModule = {
+    version?: string;
+    module: string;
+} & ModuleType<CaptureModuleType.HOSTED>;
+
+declare type ImageQualityValidationTypes = 'detect_barcode' | 'detect_document' | 'detect_cutoff' | 'detect_glare' | 'detect_blur';
+
+declare type ImageQualityWarnings = Partial<Record<ImageQualityValidationTypes, {
+    valid: boolean;
+}>>;
+
+declare type LegacyLanguageParameter = {
+    locale?: string;
+    phrases?: Record<string, string>;
+    mobilePhrases?: Record<string, string>;
+    direction?: LocaleDirection;
+};
+
+declare type LegacyStepDefinition = LegacyStepType | StepDefinition;
+
+declare type LegacyStepType = 'welcome' | 'complete' | 'face' | 'consent' | 'document' | 'poa';
+
+declare type Listener<E extends Event_2<any>> = (e: E) => void;
+
+declare type LocaleDirection = 'ltr' | 'rtl';
+
+declare type ModuleType<T extends CaptureModuleType> = {
+    type: T;
+};
+
+export declare const Onfido: OnfidoApi;
+
+export declare type OnfidoApi = {
+    init: (parameter: SdkParameters) => Handle;
+};
+
+declare type Score = {
+    min: number;
+    max: number;
+    threshold: number;
+};
+
+declare type SdkErrorTypes = 'invalid_token' | 'expired_token' | 'expired_trial' | 'geoblocked_request' | 'permissions_unavailable' | 'exception' | 'unsupported' | 'unsupported_feature' | 'invalid_sdk_parameter' | 'restart' | 'desktop' | 'unsupported_sdk_version' | 'no_camera' | 'user_consent_denied' | 'uncaught_fetch_error' | 'api_error' | 'cross_device_verification_invalid' | 'cross_device_verification_abort' | 'workflow_abandoned' | 'workflow_error';
+
+export declare type SdkParameters = StudioSdkParameters | ClassicSdkParameters | CrossDeviceSdkParameters;
+
+declare type StepDefinition = {
+    type: LegacyStepType | string;
+    options?: Record<string, unknown>;
+    module?: CaptureModule;
+    /**
+     * the key used to serialize the output for onComplete
+     */
+    key?: string;
+};
+
+export declare type StudioSdkParameters = {
+    workflowRunId: string;
+    disableWelcomeScreen?: boolean;
+} & TokenParameters;
+
+declare type SubmitDocument = {
+    file: Blob;
+    side: DocumentSides;
+    type: string;
+    sdk_validations: string;
+} & Common;
+
+declare type SubmitSelfie = {
+    file: Blob;
+    snapshot: {
+        blob: Blob;
+        filename: string;
+    };
+};
+
+declare type SubmitVideo = {
+    file: Blob;
+    challenge: string;
+    challenge_id: string;
+    challenge_switch_at: number | undefined;
+    languages: string;
+};
+
+declare type Theme = {
+    name: 'light' | 'dark';
+    config?: ThemeConfig;
+};
+
+declare type ThemeConfig = Record<string, any>;
+
+declare type TokenParameters = {
+    token: string;
+    language?: string | LegacyLanguageParameter;
+    translations?: Translations;
+    theme?: Theme;
+    /***
+     * You can change the default country for the SMS number input by passing the
+     * smsNumberCountryCode option when the SDK is initialized. The value should
+     * be a string containing a 2-character ISO Country code. If empty, the SMS
+     * number country code will default to GB.
+     */
+    smsNumberCountryCode?: string;
+    userDetails?: UserDetails;
+    _crossDeviceLinkMethods?: CrossDeviceMethod[];
+    crossDeviceClientIntroProductLogoSrc?: string;
+    crossDevicePolicy?: CrossDevicePolicy;
+    disableAnalytics?: boolean;
+    disableAnalyticsCookies?: boolean;
+} & CommonSdkParameters;
+
+declare type TranslationItem<T> = T | (() => Promise<T>);
+
+declare type Translations<T = unknown> = Record<string, TranslationItem<T>>;
+
+declare type UploadFileResponse = {
+    id: string;
+    created_at: string;
+    file_name: string;
+    file_type: string;
+    file_size: number;
+    href: string;
+    download_href: string;
+};
+
+declare type UserDetails = {
+    smsNumber?: string;
+};
+
+declare type VideoChallengeLanguage = {
+    source: string;
+    language_code: string;
+};
+
+export { }

package/types/contract/module/DocumentModule.d.ts

@@ -0,0 +1,80 @@
+export type DocumentType =
+  | 'driving_licence'
+  | 'national_identity_card'
+  | 'residence_permit'
+  | 'passport'
+  | 'passport_card'
+
+export type DocumentTypeGeneric = 'generic_document'
+
+export type DocumentCountrySelection = {
+  documentType: DocumentType
+  issuingCountry: string
+}
+
+export type DocumentAllSelection = {
+  documentType: DocumentType
+  allCountries: true
+}
+
+export type DocumentGenericSelection = {
+  documentType: DocumentTypeGeneric
+  id: string
+}
+
+export type DocumentSelection =
+  | DocumentCountrySelection
+  | DocumentAllSelection
+  | DocumentGenericSelection
+
+export type DocumentSelectionFilter = {
+  include?: DocumentSelection[]
+  exclude?: DocumentSelection[]
+}
+
+export type GenericDocumentType = {
+  id: string
+  title: string
+  subTitle: string
+  country: string
+  pages: number
+}
+
+export type DocumentModuleConfiguration = {
+  filter?: DocumentSelectionFilter
+  extend?: GenericDocumentType[]
+  hideCountrySelection?: boolean
+  uploadFallback?: boolean
+}
+
+export type DocumentModuleInput = Record<string, unknown>
+
+export type DocumentSideOutput = {
+  id: string
+  type?: string
+}
+
+export type Side = 'front' | 'back'
+
+export type DocumentIds = Partial<
+  Record<`${Side}` | `${Side}_video`, DocumentSideOutput>
+>
+
+export type DocumentModuleOutput = {
+  type: string
+  sides: DocumentIds
+}
+
+export type EnabledDocumentType = {
+  country: string
+  document_type: string
+}
+
+export type DocumentFeatureFlags = {
+  auto_capture_enabled_documents: EnabledDocumentType[]
+  auto_capture_timeout_ms?: number
+  enable_auto_capture_doc_capture?: boolean
+  enable_js_camera_doc_capture?: boolean
+  max_total_retries?: number
+  enable_native_camera_fallback?: boolean
+}

package/types/contract/module/FaceModule.d.ts

@@ -0,0 +1,14 @@
+export type FaceModuleConfiguration = {
+  showIntro?: boolean
+  useMultipleSelfieCapture?: boolean
+}
+
+export type FaceModuleOutput = {
+  id: string
+  variant: 'standard'
+}
+
+export type FaceFeatureFlags = {
+  sign_upload?: boolean
+  enable_native_camera_fallback?: boolean
+}

package/types/shared/CrossDeviceConnect.types.d.ts

@@ -0,0 +1,9 @@
+export type CrossDeviceMethod = 'copy_link' | 'qr_code' | 'sms';
+export type CrossDeviceConnectModuleConfiguration = {
+    smsNumberCountryCode?: string;
+    smsNumber?: string;
+    methods?: CrossDeviceMethod[];
+};
+export type CrossDeviceConnectModuleInput = {
+    allowBack?: boolean;
+};

package/types/shared/Enterprise.d.ts

@@ -0,0 +1,121 @@
+export declare type EnterpriseCallbackResponse<T> = {
+    continueWithOnfidoSubmission?: boolean;
+    onfidoSuccessResponse?: T;
+};
+export type Common = {
+    sdk_metadata: string;
+    sdk_source: string;
+    sdk_version: string;
+};
+export type SubmitDocument = {
+    file: Blob;
+    side: DocumentSides;
+    type: string;
+    sdk_validations: string;
+} & Common;
+export type SubmitSelfie = {
+    file: Blob;
+    snapshot: {
+        blob: Blob;
+        filename: string;
+    };
+};
+export type SubmitVideo = {
+    file: Blob;
+    challenge: string;
+    challenge_id: string;
+    challenge_switch_at: number | undefined;
+    languages: string;
+};
+export declare type ImageQualityValidationTypes = 'detect_barcode' | 'detect_document' | 'detect_cutoff' | 'detect_glare' | 'detect_blur';
+export declare type ImageQualityWarnings = Partial<Record<ImageQualityValidationTypes, {
+    valid: boolean;
+}>>;
+export declare type UploadFileResponse = {
+    id: string;
+    created_at: string;
+    file_name: string;
+    file_type: string;
+    file_size: number;
+    href: string;
+    download_href: string;
+};
+type Score = {
+    min: number;
+    max: number;
+    threshold: number;
+};
+export declare type DocumentSides = 'front' | 'back';
+export declare type DocumentType = 'driving_licence' | 'national_identity_card' | 'residence_permit' | 'passport';
+export declare type DocumentImageResponse = {
+    applicant_id: string;
+    type: DocumentType;
+    side: DocumentSides;
+    issuing_country: string;
+    sdk_warnings: ImageQualityWarnings & {
+        image_quality: {
+            quality: string;
+            breakdown: {
+                document: {
+                    has_document: boolean;
+                    detection_score: number;
+                } & Score;
+                has_document: boolean;
+                cutoff: {
+                    has_cutoff: boolean;
+                    score: number;
+                } & Score;
+                blur: {
+                    has_blur: boolean;
+                    score: number;
+                    blur_model: string;
+                } & Score;
+                glare: {
+                    score: number;
+                    bbox: [number, number, number, number];
+                    has_glare: boolean;
+                    threshold: number;
+                    glare_model: string;
+                };
+                barcode: {
+                    result: string;
+                    properties: Record<string, string>;
+                };
+            };
+            image_quality_uuid: string;
+        };
+    };
+    classification: {
+        issuing_country: null;
+        document_version: null;
+        side?: DocumentSides;
+        document_type?: DocumentType;
+    };
+    document_features: {
+        has_nfc: boolean;
+    };
+} & UploadFileResponse;
+export declare type VideoChallengeLanguage = {
+    source: string;
+    language_code: string;
+};
+export declare type ChallengePayload = {
+    type: 'recite';
+    query: number[];
+} | {
+    type: 'movement';
+    query: string;
+};
+export declare type FaceVideoResponse = {
+    challenge: ChallengePayload[];
+    languages: VideoChallengeLanguage[];
+} & UploadFileResponse;
+export type CustomCallbackFormatterType = 'raw' | 'formData';
+export type EnterpriseFeatureCallback = {
+    useCustomizedApiRequests?: boolean;
+    formatter?: CustomCallbackFormatterType;
+    onSubmitDocument?: (data: FormData | SubmitDocument) => Promise<EnterpriseCallbackResponse<DocumentImageResponse>>;
+    onSubmitSelfie?: (data: FormData | SubmitSelfie) => Promise<EnterpriseCallbackResponse<UploadFileResponse>>;
+    onSubmitVideo?: (data: FormData | SubmitVideo) => Promise<EnterpriseCallbackResponse<FaceVideoResponse>>;
+};
+export {};

package/types/shared/Error.d.ts

@@ -0,0 +1,80 @@
+import type { Configuration } from './Types';
+export declare enum SdkErrorLevel {
+    EXTERNAL = "external",
+    INTERNAL = "internal"
+}
+export type SdkErrorTypes = 'invalid_token' | 'expired_token' | 'expired_trial' | 'geoblocked_request' | 'permissions_unavailable' | 'exception' | 'unsupported' | 'unsupported_feature' | 'invalid_sdk_parameter' | 'restart' | 'desktop' | 'unsupported_sdk_version' | 'no_camera' | 'user_consent_denied' | 'uncaught_fetch_error' | 'api_error' | 'cross_device_verification_invalid' | 'cross_device_verification_abort' | 'workflow_abandoned' | 'workflow_error';
+export declare const isSdkError: (error: unknown) => boolean;
+export type SdkErrors = {
+    type: SdkErrorTypes;
+    message: string;
+    level: SdkErrorLevel;
+};
+export declare const CrossDeviceRestartError: SdkErrors;
+export declare const CrossDeviceDesktopError: SdkErrors;
+export declare const CrossDeviceVerificationInvalidError: SdkErrors;
+export declare const CrossDeviceVerificationAbortError: SdkErrors;
+export declare const InvalidTokenError: SdkErrors;
+export declare const WorkflowAbondonedError: SdkErrors;
+export declare const WorkflowError: SdkErrors;
+export declare const ExpiredTokenError: SdkErrors;
+export declare const ExpiredTrialError: SdkErrors;
+export declare const GeoblockedRequestError: SdkErrors;
+export declare const PermissionsUnavailableError: SdkErrors;
+export declare const ExceptionError: SdkErrors;
+export declare const UnsupportedError: SdkErrors;
+export declare const UnsupportedFeatureError: SdkErrors;
+export declare const InvalidSdkParameter: SdkErrors;
+export declare const UnsupportedSdkVersionError: SdkErrors;
+export declare const NoCameraError: SdkErrors;
+export declare const UserConsentDeniedError: SdkErrors;
+export declare const ApiError: SdkErrors;
+export declare const UncaughtFetchError: SdkErrors;
+export type ErrorModuleConfiguration = Configuration & {
+    type: SdkErrorTypes;
+};
+export declare const SdkWarningType = "SdkWarning";
+export declare class SdkError extends Error {
+    readonly name = "SdkError";
+    type: SdkErrorTypes;
+    exception?: Error | unknown;
+    level: SdkErrorLevel;
+    body?: unknown;
+    httpCode?: number;
+    stack?: string;
+    constructor({ type, message, level, exception, stack, body, httpCode, }: {
+        type: SdkErrorTypes;
+        message: string;
+        level: SdkErrorLevel;
+        exception?: Error | unknown;
+        stack?: string;
+        body?: unknown;
+        httpCode?: number;
+    });
+    encode(): {
+        name: string;
+        type: SdkErrorTypes;
+        message: string;
+        level: SdkErrorLevel;
+        stack: string | undefined;
+        exception: unknown;
+        body: unknown;
+        httpCode: number | undefined;
+    };
+    static decode(error: SdkError): SdkError;
+}
+export type ErrorCallback = (error: {
+    type: SdkErrorTypes;
+    message: string;
+    exception?: Error | unknown;
+}) => void;
+export declare const formatError: (error: SdkError | Error | unknown) => {
+    name: string;
+    type: SdkErrorTypes;
+    message: string;
+    level: SdkErrorLevel;
+    stack: string | undefined;
+    exception: unknown;
+    body: unknown;
+    httpCode: number | undefined;
+};

package/types/shared/EventEmitter.d.ts

@@ -0,0 +1,16 @@
+export type EventMap = {
+    [eventName: string]: Event<string>;
+};
+export type Event<T extends string> = {
+    type: T;
+};
+export type Listener<E extends Event<any>> = (e: E) => void;
+export declare class EventEmitter<Events extends EventMap> {
+    private readonly eventListener;
+    constructor();
+    addEventListener<EventName extends keyof Events>(eventName: EventName, listener: Listener<Events[EventName]>): this;
+    removeEventListener<EventName extends keyof Events>(eventName: EventName, listener: Listener<Events[EventName]>): void;
+    trigger<EventName extends keyof Events>(eventName: EventName, e: Omit<Events[EventName], 'type'> & {
+        type?: EventName;
+    }): void;
+}

package/types/shared/FeatureFlags.d.ts

@@ -1,5 +1,5 @@
-import type { DocumentFeatureFlags } from '@onfido/capture-contract/module/DocumentModule';
-import type { FaceFeatureFlags } from '@onfido/capture-contract/module/FaceModule';
+import type { DocumentFeatureFlags } from '../contract/module/DocumentModule';
+import type { FaceFeatureFlags } from '../contract/module/FaceModule';
 export type LogLevels = 'debug' | 'info' | 'warning' | 'error' | 'fatal';
 export type SdkFeatures = {
     enable_require_applicant_consents?: boolean;

package/types/shared/SdkParameters.d.ts

@@ -0,0 +1,55 @@
+import type { LegacyStepDefinition, LegacyStepType, CrossDevicePolicy, EnterpriseFeatures, LocaleDirection, Theme, ThemeConfig, Translations, UserDetails } from './Types';
+import type { ErrorCallback } from './Error';
+import type { CrossDeviceMethod } from './CrossDeviceConnect.types';
+import type { EnterpriseFeatureCallback } from './Enterprise';
+export declare const legacySteps: LegacyStepType[];
+export declare const isLegacyStepType: (step: LegacyStepDefinition) => step is LegacyStepType;
+export type CompleteData = Record<string, unknown>;
+export type EnterpriseFeatureParameter = EnterpriseFeatures & EnterpriseFeatureCallback;
+export type CommonSdkParameters = {
+    containerEl?: HTMLElement;
+    containerId?: string;
+    onError?: ErrorCallback;
+    onComplete?: (data: CompleteData) => void;
+    enterpriseFeatures?: EnterpriseFeatureParameter;
+    theme?: Theme;
+    customUI?: ThemeConfig;
+    language?: string | LegacyLanguageParameter;
+    translations?: Translations;
+};
+export type LegacyLanguageParameter = {
+    locale?: string;
+    phrases?: Record<string, string>;
+    mobilePhrases?: Record<string, string>;
+    direction?: LocaleDirection;
+};
+export type TokenParameters = {
+    token: string;
+    language?: string | LegacyLanguageParameter;
+    translations?: Translations;
+    theme?: Theme;
+    /***
+     * You can change the default country for the SMS number input by passing the
+     * smsNumberCountryCode option when the SDK is initialized. The value should
+     * be a string containing a 2-character ISO Country code. If empty, the SMS
+     * number country code will default to GB.
+     */
+    smsNumberCountryCode?: string;
+    userDetails?: UserDetails;
+    _crossDeviceLinkMethods?: CrossDeviceMethod[];
+    crossDeviceClientIntroProductLogoSrc?: string;
+    crossDevicePolicy?: CrossDevicePolicy;
+    disableAnalytics?: boolean;
+    disableAnalyticsCookies?: boolean;
+} & CommonSdkParameters;
+export type StudioSdkParameters = {
+    workflowRunId: string;
+    disableWelcomeScreen?: boolean;
+} & TokenParameters;
+export type ClassicSdkParameters = {
+    steps: LegacyStepDefinition[];
+} & TokenParameters;
+export type CrossDeviceSdkParameters = CommonSdkParameters & {
+    roomId?: string;
+};
+export type SdkParameters = StudioSdkParameters | ClassicSdkParameters | CrossDeviceSdkParameters;

package/types/shared/Types.d.ts

@@ -0,0 +1,243 @@
+import type { FeatureFlags } from './FeatureFlags';
+export type ModuleError = {
+    type: 'no_camera';
+    message?: string;
+};
+export type ModuleFinish = {
+    type: 'finish';
+    output: Output;
+    options?: ModuleFinishOptions;
+};
+export type ModuleUnsupported = {
+    type: 'unsupported';
+    data?: unknown;
+};
+export type Outputs = ModuleFinish | ModuleUnsupported;
+export type Output = unknown | ModuleError;
+export type ModuleFinishOptions = {
+    complete?: boolean;
+};
+export type ExecutorMethod = 'bootstrap' | 'ping' | 'start';
+export type CrossDeviceExecutorMethod = 'crossDevice.update';
+export type RunnerMethod = 'captureModule.finish' | 'captureModule.error' | 'captureModule.unsupported' | 'crossDevice.start' | 'crossDevice.preload' | 'crossDevice.verify' | 'crossDevice.abort' | 'analytics.send' | 'analytics.userAnalytics' | 'navigation.back' | 'navigation.exit' | 'navigation.externalLink' | 'customCallback.invoke' | 'passkey.create' | 'passkey.get';
+export type Configuration<T = unknown> = {
+    translations: T;
+    theme?: Theme;
+    language?: string;
+    workflowRunId?: string;
+};
+export type Input = Record<string, unknown>;
+export type LocaleDirection = 'ltr' | 'rtl';
+export type TranslationData<T> = T & {
+    meta?: {
+        legacy: Record<string, unknown>;
+        fallback?: Record<string, unknown>;
+        direction?: LocaleDirection;
+        convertLegacyTranslations?: boolean;
+    };
+};
+export type TranslationItem<T> = T | (() => Promise<T>);
+export type Translations<T = unknown> = Record<string, TranslationItem<T>>;
+export type ThemeConfig = Record<string, any>;
+export type Theme = {
+    name: 'light' | 'dark';
+    config?: ThemeConfig;
+};
+export type Optional<T> = undefined | T;
+export declare enum Platform {
+    WEB = "web",
+    IOS = "ios",
+    ANDROID = "android"
+}
+type ExecutionContextConfiguration = {
+    crossDevicePolicy?: CrossDevicePolicy;
+    supportsCrossDevice?: boolean;
+    supportsBack?: boolean;
+    supportsExit?: boolean;
+    supportsExternalLink?: boolean;
+    globalKit?: boolean;
+};
+export type CustomCallbacks = {
+    names: string[];
+};
+export type ExecutionContext = {
+    platform: Platform;
+    version: string;
+    module?: CaptureModule;
+    os?: {
+        name?: string;
+        version?: string;
+    };
+    configuration?: ExecutionContextConfiguration;
+    customCallbacks?: CustomCallbacks;
+    currentScriptHostname?: string;
+};
+export type UserDetails = {
+    smsNumber?: string;
+};
+export type ClientConfiguration = {
+    token: string;
+    sdkToken: SdkToken;
+    featureFlags: FeatureFlags;
+    theme?: Theme;
+    language?: string;
+    translations?: Translations;
+    analytics: {
+        enabled: boolean;
+        anonymousUuid: string;
+        sessionUuid: string;
+        workflowRunId: string | undefined;
+        steps: LegacyStepDefinition[];
+        source: {
+            platform: string;
+            version: string;
+            sdk_environment: string;
+            distribution_source: string;
+            pinned_version?: string;
+        };
+    };
+    logger: {
+        enabled: boolean;
+        levels: string[];
+    };
+    crossDevice: {
+        verification?: boolean;
+    };
+    enterpriseFeatures?: EnterpriseFeatures;
+    crossDeviceClientIntroProductName?: string;
+    crossDeviceClientIntroProductLogoSrc?: string;
+    smsNumberCountryCode?: string;
+    userDetails?: UserDetails;
+};
+export type SdkToken = {
+    exp: number;
+    payload: Payload;
+    enterpriseFeatures?: TokenEnterpriseFeatures;
+    urls: {
+        detectDocumentUrl: URL;
+        /**
+         * @deprecated
+         */
+        syncUrl: URL;
+        hostedSdkUrl: URL;
+        authUrl: URL;
+        onfidoApiUrl: URL;
+        telephonyUrl: URL;
+    };
+    type: 'studio' | 'sdk';
+};
+export type UUID = string;
+export type URL = string;
+export type Payload = {
+    applicantUuid: UUID;
+    applicationId?: string;
+    clientUuid: UUID;
+    isSandbox: boolean;
+    isTrial: boolean;
+};
+export type EnterpriseFeatures = {
+    hideOnfidoLogo?: boolean;
+    cobrand?: {
+        text?: string;
+    };
+    logoCobrand?: {
+        lightLogoSrc?: string;
+        darkLogoSrc?: string;
+    };
+};
+type TokenEnterpriseFeatures = {
+    cobrand: boolean;
+    logoCobrand: boolean;
+    hideOnfidoLogo: boolean;
+    useCustomizedApiRequests: boolean;
+};
+export type JWT = {
+    iss?: string;
+    exp: number;
+    payload: {
+        app: UUID;
+        application_id?: string;
+        client_uuid: UUID;
+        is_sandbox: boolean;
+        is_trial: boolean;
+        ref: string;
+        sardine_session: UUID;
+    };
+    enterprise_features: TokenEnterpriseFeatures;
+    urls: {
+        detect_document_url: URL;
+        sync_url: URL;
+        hosted_sdk_url: URL;
+        auth_url: URL;
+        onfido_api_url: URL;
+        telephony_url: URL;
+    };
+};
+export type TrackedEventTypes = 'screen' | 'action' | 'flow' | 'view';
+export type AnalyticsEvent = {
+    eventName: string;
+    eventType: TrackedEventTypes;
+};
+export type UserAnalyticsEvent<N extends string = string, P extends Record<string, unknown> = Record<string, unknown>> = {
+    eventName: N;
+    properties: P;
+};
+export type DeviceTypes = 'desktop' | 'mobile';
+export type TrackedEnvironmentData = {
+    device?: DeviceTypes;
+    os?: string;
+    os_version?: string;
+    browser?: string;
+    browser_version?: string;
+    brand?: string;
+    model?: string;
+};
+export declare enum CrossDeviceVerificationStatus {
+    VALID = "VALID",
+    INVALID = "INVALID",
+    PENDING = "PENDING",
+    ABORT = "ABORT"
+}
+export type CrossDeviceInitialState = unknown;
+export type ConnectResult = {
+    roomId: string;
+};
+export type CrossDeviceDetails = ConnectResult & {
+    connected: boolean;
+    link: string;
+    code?: string;
+    verificationStatus?: CrossDeviceVerificationStatus;
+};
+export type CrossDeviceInput = {
+    backActionType?: 'module' | 'cross-module';
+    details: CrossDeviceDetails;
+};
+export declare enum CaptureModuleType {
+    HOSTED = "hosted",
+    EXTERNAL = "external"
+}
+export type ModuleType<T extends CaptureModuleType> = {
+    type: T;
+};
+export type HostedModule = {
+    version?: string;
+    module: string;
+} & ModuleType<CaptureModuleType.HOSTED>;
+export type ExternalModule = {
+    url: string;
+} & ModuleType<CaptureModuleType.EXTERNAL>;
+export type CaptureModule = HostedModule | ExternalModule;
+export type CrossDevicePolicy = 'enable' | 'force' | 'disable';
+export type LegacyStepType = 'welcome' | 'complete' | 'face' | 'consent' | 'document' | 'poa';
+export type LegacyStepDefinition = LegacyStepType | StepDefinition;
+export type StepDefinition = {
+    type: LegacyStepType | string;
+    options?: Record<string, unknown>;
+    module?: CaptureModule;
+    /**
+     * the key used to serialize the output for onComplete
+     */
+    key?: string;
+};
+export type ExternalLinkTarget = 'overlay' | 'browser';
+export {};