uqudosdk-web 3.1.2

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+## 3.1.2
+
+- Changed API base server URL
+
+## 3.1.1
+
+- Fixed bug where facial recognition was trigger for document that don't support facial recognition
+
+## 3.1.0
+
+- Added support for multiple documents in the same Enrollment session.
+- Added lookup feature to the Enrollment process.
+- Allow scan rejection based on the age.
+- Added an option that returns the data for an incomplete session for Account Recovery and Face Session
+- Configuration option the set the max number of attempts before dropping the session.

package/COPYRIGHT.md

@@ -0,0 +1 @@
+Copyright (c) uqudo 2022

package/README.md

@@ -0,0 +1,12 @@
+# Uqudo Web SDK
+
+The official uqudo SDK for web.\
+Onboard new users faster, easier, and cheaper with an experience that seamlessly fits into your onboarding journey. Fully supported across the Middle East & Africa.
+
+#### Web documentation
+
+https://docs.uqudo.com
+
+## Licensing
+
+- In order to use the SDK you require a valid license. Contact us at https://uqudo.com/contact-us/

package/index.d.ts

@@ -0,0 +1,264 @@
+// ---------- errors --------- //
+
+export declare const isErrorCode: (code: unknown) => code is ErrorCode;
+
+export declare class OperationError extends Error {
+  public code: ErrorCode;
+  public data: IResultInfo | undefined;
+}
+
+export declare const isOperationError: (
+  error: unknown
+) => error is OperationError;
+
+// ---------- uqudo sdk --------- //
+
+export declare class UqudoSdk {
+  enrollment(configProcess: IEnrollmentConfig): Promise<ReturnEnrollmentType>;
+  accountRecovery(
+    configProcess: IAccountRecoveryConfig
+  ): Promise<ReturnAccountRecoveryType>;
+  faceSession(
+    configProcess: IFaceSessionConfig
+  ): Promise<ReturnFaceSessionType>;
+}
+
+declare class UqudoSdkFactory {
+  static create(config: IUqudoSdkConfig): UqudoSdk;
+}
+
+export default UqudoSdkFactory;
+
+export enum ErrorCode {
+  UNEXPECTED_ERROR = "UNEXPECTED_ERROR",
+  UNAUTHORIZED = "UNAUTHORIZED",
+  FORBIDDEN = "FORBIDDEN",
+  SESSION_EXPIRED_OR_NOT_FOUND = "SESSION_EXPIRED_OR_NOT_FOUND",
+  MEDIA_NOT_ALLOWED_ERROR = "MEDIA_NOT_ALLOWED_ERROR",
+  MEDIA_NOT_FOUND_ERROR = "MEDIA_NOT_FOUND_ERROR",
+  MEDIA_SECURITY_ERROR = "MEDIA_SECURITY_ERROR",
+  MEDIA_UNKNOWN_ERROR = "MEDIA_UNKNOWN_ERROR",
+  USER_CANCEL = "USER_CANCEL",
+  INVALID_CONFIG = "INVALID_CONFIG",
+  SESSION_INVALIDATED_TOO_MANY_ATTEMPTS = "SESSION_INVALIDATED_TOO_MANY_ATTEMPTS",
+}
+
+// ---------- enum --------- //
+// error code display
+export enum ErrorDisplayCode {
+  SCAN_DOCUMENT_NOT_RECOGNIZED = "SCAN_DOCUMENT_NOT_RECOGNIZED",
+  SCAN_DOCUMENT_EXPIRED = "SCAN_DOCUMENT_EXPIRED",
+  SCAN_DOCUMENT_FRONT_BACK_MISMATCH = "SCAN_DOCUMENT_FRONT_BACK_MISMATCH",
+  FACE_LIVENESS_FAILED = "FACE_LIVENESS_FAILED",
+  FACE_NO_MATCH = "FACE_NO_MATCH",
+  PAYLOAD_TOO_LARGE = "PAYLOAD_TOO_LARGE",
+  SCAN_DOCUMENT_AGE_VERIFICATION_FAILED = "SCAN_DOCUMENT_AGE_VERIFICATION_FAILED",
+  UNEXPECTED_ERROR = "UNEXPECTED_ERROR",
+}
+
+// document type
+export enum DocumentType {
+  BHR_ID = "BHR_ID",
+  GENERIC_ID = "GENERIC_ID",
+  KWT_ID = "KWT_ID",
+  OMN_ID = "OMN_ID",
+  PAK_ID = "PAK_ID",
+  PASSPORT = "PASSPORT",
+  SAU_ID = "SAU_ID",
+  UAE_ID = "UAE_ID",
+  UAE_DL = "UAE_DL",
+  NLD_DL = "NLD_DL",
+  UAE_VISA = "UAE_VISA",
+  UAE_VL = "UAE_VL",
+  QAT_ID = "QAT_ID",
+  DEU_ID = "DEU_ID",
+  SDN_ID = "SDN_ID",
+  SDN_DL = "SDN_DL",
+  SDN_VL = "SDN_VL",
+  GHA_ID = "GHA_ID",
+  NGA_DL = "NGA_DL",
+  NGA_VOTER_ID = "NGA_VOTER_ID",
+  NGA_NIN = "NGA_NIN",
+  UAE_VL_PDF = "UAE_VL_PDF",
+  GBR_DL = "GBR_DL",
+  SAU_DL = "SAU_DL",
+  ZAF_ID = "ZAF_ID",
+  ZAF_DL = "ZAF_DL",
+  EGY_ID = "EGY_ID",
+  RWA_ID = "RWA_ID",
+  KEN_ID = "KEN_ID",
+  GHA_DL = "GHA_DL",
+  GHA_VOTER_ID = "GHA_VOTER_ID",
+  GHA_SSNIT = "GHA_SSNIT",
+  UGA_ID = "UGA_ID",
+  UGA_VOTER_ID = "UGA_VOTER_ID",
+  IND_ID = "IND_ID",
+  SEN_ID = "SEN_ID",
+}
+
+export enum BackgroundCheckType {
+  RDC = "RDC",
+}
+
+// ---------- texts type --------- //
+
+export type ITextErrorDisplay = {
+  title?: string;
+  description?: string;
+  button?: string;
+};
+
+export interface ITextsArg {
+  startingCamera?: string;
+  validating?: string;
+  processing?: string;
+  closingSession?: string;
+  exit?: {
+    title?: string;
+    description?: string;
+    yesButtonText?: string;
+    noButtonText?: string;
+  };
+  upload?: {
+    title?: string;
+    front?: {
+      description?: string;
+      buttonText?: string;
+    };
+    back?: {
+      description?: string;
+      buttonText?: string;
+    };
+    acceptedFilesDescription?: string;
+    buttonText?: string;
+    tipDescription?: string;
+  };
+  backgroundCheck?: {
+    title?: string;
+    description?: string;
+    declineButtonText?: string;
+    consentButtonText?: string;
+    continueButtonText?: string;
+    declineConfirmation?: {
+      title?: string;
+      description?: string;
+      noButtonText?: string;
+      yesButtonText?: string;
+    };
+  };
+  facialRecognition?: {
+    title?: string;
+    description?: string;
+    headText?: string;
+  };
+  scan?: {
+    titleFrontSide?: string;
+    titleBackSide?: string;
+    rescanButtonText?: string;
+    continueButtonText?: string;
+    turnDocumentDescription?: string;
+    tipDescription?: string;
+    tipDescription2?: string;
+    description?: string;
+  };
+  documentTypes?: Record<string | DocumentType, string>;
+  errors?: Record<ErrorDisplayCode, ITextErrorDisplay>;
+}
+
+// ---------- texts type --------- //
+
+export interface IAssetsArg {
+  logo?: string;
+  logoWhite?: string;
+  turnOverImage?: string;
+  headObj?: string;
+  closeSessionIcon?: string;
+  addFileIcon?: string;
+  hintIcon?: string;
+  recordIcon?: string;
+  takePictureIcon?: string;
+  spinnerIcon?: string;
+  removeIcon?: string;
+  updateIcon?: string;
+}
+
+// ---------- common type --------- //
+
+export type IResultInfo = string;
+
+export type IObservableFunctionsType<R = IResultInfo, E = OperationError> = {
+  onSuccess?: (result: R) => void;
+  onError?: (error: E) => void;
+  onFinally?: () => void;
+};
+
+export type IResource = {
+  assets?: IAssetsArg;
+  texts?: ITextsArg;
+};
+
+export type IConfigProcess = IResource & {
+  returnDataForIncompleteSession?: boolean;
+};
+
+// ---------- uqudo sdk type --------- //
+
+export type IUqudoSdkConfig = IResource & {
+  baseURL?: string;
+  accessToken: string;
+  nonce?: string;
+  userId?: string;
+};
+
+// ---------- Enrollment type --------- //
+
+export type ReturnEnrollmentType = IResultInfo;
+
+export type IScanConfig = {
+  documentType: string | DocumentType;
+  disableExpiryValidation?: boolean;
+  forceUpload?: boolean;
+  enableAgeVerification?: number;
+};
+
+export type IEnrollmentConfig = IConfigProcess &
+  IObservableFunctionsType<ReturnEnrollmentType> & {
+    sessionId?: string;
+    scan: IScanConfig | IScanConfig[];
+    face?: {
+      enableFacialRecognition?: boolean;
+      enrollFace?: boolean;
+      maxAttempts?: number;
+    };
+    lookup?: {
+      enableLookup: boolean;
+      documentTypes: (string | DocumentType)[];
+    };
+    backgroundCheck?: {
+      enableBackgroundCheck?: boolean;
+      checkType?: string | BackgroundCheckType;
+      disableConsent?: boolean;
+      skipView?: boolean;
+      enableMonitoring?: boolean;
+    };
+  };
+
+// ---------- Face Session type --------- //
+
+export type ReturnFaceSessionType = IResultInfo;
+
+export type IFaceSessionConfig = IConfigProcess &
+  IObservableFunctionsType<ReturnFaceSessionType> & {
+    sessionId: string;
+    maxAttempts?: number;
+  };
+
+// ---------- Account Recovery type --------- //
+
+export type ReturnAccountRecoveryType = IResultInfo;
+
+export type IAccountRecoveryConfig = IConfigProcess &
+  IObservableFunctionsType<ReturnAccountRecoveryType> & {
+    enrollmentIdentifier: string;
+    maxAttempts?: number;
+  };