@aws-amplify/ui-react-liveness 1.0.6 → 2.0.1

package/dist/types/components/FaceLivenessDetector/service/types/error.d.ts

@@ -9,5 +9,6 @@ export declare enum LivenessErrorState {
     CAMERA_FRAMERATE_ERROR = "CAMERA_FRAMERATE_ERROR",
     CAMERA_ACCESS_ERROR = "CAMERA_ACCESS_ERROR",
     FACE_DISTANCE_ERROR = "FACE_DISTANCE_ERROR",
-    MOBILE_LANDSCAPE_ERROR = "MOBILE_LANDSCAPE_ERROR"
+    MOBILE_LANDSCAPE_ERROR = "MOBILE_LANDSCAPE_ERROR",
+    MULTIPLE_FACES_ERROR = "MULTIPLE_FACES_ERROR"
 }

package/dist/types/components/FaceLivenessDetector/service/types/index.d.ts

@@ -2,3 +2,4 @@ export * from './faceDetection';
 export * from './liveness';
 export * from './machine';
 export * from './error';
+export * from './credentials';

package/dist/types/components/FaceLivenessDetector/service/types/liveness.d.ts

@@ -1,7 +1,9 @@
+import { AwsCredentialProvider } from './credentials';
+import { LivenessErrorState } from './error';
 /**
- * The props for the FaceLivenessDetector
+ * The props for the FaceLivenessDetectorCore which allows for full configuration of auth
  */
-export interface FaceLivenessDetectorProps {
+export interface FaceLivenessDetectorCoreProps {
     /**
      * The sessionId as returned by CreateStreamingLivenessSession API
      */
@@ -22,7 +24,7 @@ export interface FaceLivenessDetectorProps {
     /**
      * Callback called when there is error occured on any step
      */
-    onError?: (error: Error) => void;
+    onError?: (livenessError: LivenessError) => void;
     /**
      * Optional parameter for the disabling the Start/Get Ready Screen, default: false
      */
@@ -30,9 +32,18 @@ export interface FaceLivenessDetectorProps {
     /**
      * Optional parameter for advanced options for the component
      */
-    config?: FaceLivenessDetectorConfig;
+    config?: FaceLivenessDetectorCoreConfig;
 }
-export interface FaceLivenessDetectorConfig {
+/**
+ * The props for the FaceLivenessDetector extends FaceLivenessDetectorCore with defaults for Amplify Auth configuration
+ */
+export type FaceLivenessDetectorProps = Omit<FaceLivenessDetectorCoreProps, 'config'> & {
+    /**
+     * Optional parameter for advanced options for the component
+     */
+    config?: FaceLivenessDetectorConfig;
+};
+export interface FaceLivenessDetectorCoreConfig {
     /**
      * overrides the Wasm backend binary CDN path
      * default is https://cdn.jsdelivr.net/npm/@tensorflow/tfjs-backend-wasm@3.11.0/dist/.
@@ -44,7 +55,12 @@ export interface FaceLivenessDetectorConfig {
      * default is https://tfhub.dev/tensorflow/tfjs-model/blazeface/1/default/1/model.json?tfjs-format=file
      */
     faceModelUrl?: string;
+    /**
+     * Optional parameter allowing usage of custom credential providers when calling the Rekognition stream endpoint
+     */
+    credentialProvider?: AwsCredentialProvider;
 }
+export type FaceLivenessDetectorConfig = Omit<FaceLivenessDetectorCoreConfig, 'credentialProvider'>;
 /**
  * The coordiates of any bounding box
  */
@@ -83,3 +99,7 @@ export declare enum FaceMatchState {
     FACE_IDENTIFIED = "ONE FACE IDENTIFIED",
     TOO_MANY = "TOO MANY FACES"
 }
+export interface LivenessError {
+    state: LivenessErrorState;
+    error: Error;
+}

package/dist/types/components/FaceLivenessDetector/service/types/machine.d.ts

@@ -1,6 +1,6 @@
 import { ActorRef, Interpreter, State } from 'xstate';
 import { ValidationException, InternalServerException, ThrottlingException, ServiceQuotaExceededException, SessionInformation } from '@aws-sdk/client-rekognitionstreaming';
-import { FaceLivenessDetectorProps, FaceMatchState, LivenessOvalDetails, IlluminationState } from './liveness';
+import { FaceLivenessDetectorCoreProps, FaceMatchState, LivenessOvalDetails, IlluminationState } from './liveness';
 import { LivenessErrorState } from './error';
 import { VideoRecorder, LivenessStreamProvider, FreshnessColorDisplay } from '../utils';
 import { Face, FaceDetection } from './faceDetection';
@@ -38,7 +38,7 @@ export type LivenessContext = Partial<HydratedLivenessContext>;
 export interface HydratedLivenessContext {
     maxFailedAttempts: number;
     failedAttempts: number;
-    componentProps: FaceLivenessDetectorProps;
+    componentProps: FaceLivenessDetectorCoreProps;
     serverSessionInformation: SessionInformation;
     challengeId: string;
     videoAssociatedParams: VideoAssociatedParams;
@@ -53,7 +53,7 @@ export interface HydratedLivenessContext {
     isFaceFarEnoughBeforeRecording: boolean;
     isRecordingStopped: boolean;
 }
-export type LivenessEventTypes = 'BEGIN' | 'START_RECORDING' | 'TIMEOUT' | 'ERROR' | 'CANCEL' | 'SET_SESSION_INFO' | 'DISCONNECT_EVENT' | 'SET_DOM_AND_CAMERA_DETAILS' | 'SERVER_ERROR' | 'RETRY_CAMERA_CHECK' | 'MOBILE_LANDSCAPE_WARNING';
+export type LivenessEventTypes = 'BEGIN' | 'START_RECORDING' | 'TIMEOUT' | 'ERROR' | 'CANCEL' | 'SET_SESSION_INFO' | 'DISCONNECT_EVENT' | 'SET_DOM_AND_CAMERA_DETAILS' | 'SERVER_ERROR' | 'RUNTIME_ERROR' | 'RETRY_CAMERA_CHECK' | 'MOBILE_LANDSCAPE_WARNING';
 export type LivenessEventData = Record<PropertyKey, any>;
 export interface LivenessEvent {
     type: LivenessEventTypes;

package/dist/types/components/FaceLivenessDetector/service/utils/blazefaceFaceDetection.d.ts

@@ -1,6 +1,13 @@
 import '@tensorflow/tfjs-backend-cpu';
 import { FaceDetection, Face } from '../types';
 type BlazeFaceModelBackend = 'wasm' | 'cpu';
+export declare const BLAZEFACE_VERSION = "0.0.7";
+/**
+ *   WARNING: When updating these links,
+ *   also make sure to update documentation and the link in the canary/e2e test "canary/e2e/features/liveness/face-detect.feature"
+ */
+export declare const DEFAULT_BLAZEFACE_URL: string;
+export declare const DEFAULT_TFJS_WASM_URL: string;
 /**
  * The BlazeFace implementation of the FaceDetection interface.
  */

package/dist/types/components/FaceLivenessDetector/service/utils/liveness.d.ts

@@ -84,7 +84,10 @@ export declare function isFaceDistanceBelowThreshold({ faceDetector, videoEl, ov
     ovalDetails: LivenessOvalDetails;
     reduceThreshold?: boolean;
     isMobile?: boolean;
-}): Promise<boolean>;
+}): Promise<{
+    isDistanceBelowThreshold: boolean;
+    error?: LivenessErrorState.FACE_DISTANCE_ERROR | LivenessErrorState.MULTIPLE_FACES_ERROR;
+}>;
 export declare function getBoundingBox({ deviceHeight, deviceWidth, height, width, top, left, }: {
     deviceHeight: number;
     deviceWidth: number;

package/dist/types/components/FaceLivenessDetector/service/utils/streamProvider.d.ts

@@ -1,6 +1,7 @@
 import { AmazonAIInterpretPredictionsProvider } from '@aws-amplify/predictions';
 import { ClientSessionInformationEvent, LivenessResponseStream } from '@aws-sdk/client-rekognitionstreaming';
 import { VideoRecorder } from './videoRecorder';
+import { AwsCredentialProvider } from '../types';
 export interface StartLivenessStreamInput {
     sessionId: string;
 }
@@ -13,18 +14,26 @@ export interface Credentials {
     secretAccessKey: string;
     sessionToken: string;
 }
+export interface StreamProviderArgs {
+    sessionId: string;
+    region: string;
+    stream: MediaStream;
+    videoEl: HTMLVideoElement;
+    credentialProvider?: AwsCredentialProvider;
+}
 export declare const TIME_SLICE = 1000;
 export declare class LivenessStreamProvider extends AmazonAIInterpretPredictionsProvider {
     sessionId: string;
     region: string;
     videoRecorder: VideoRecorder;
     responseStream: AsyncIterable<LivenessResponseStream>;
+    credentialProvider?: AwsCredentialProvider;
     private _reader;
     private videoEl;
     private _client;
     private _stream;
     private initPromise;
-    constructor(sessionId: string, region: string, stream: MediaStream, videoEl: HTMLVideoElement);
+    constructor({ sessionId, region, stream, videoEl, credentialProvider, }: StreamProviderArgs);
     getResponseStream(): Promise<AsyncIterable<LivenessResponseStream>>;
     startRecordingLivenessVideo(): void;
     sendClientInfo(clientInfo: ClientSessionInformationEvent): void;

package/dist/types/components/FaceLivenessDetector/shared/FaceLivenessErrorModal.d.ts

@@ -16,6 +16,8 @@ export declare const renderErrorModal: ({ errorState, overrideErrorDisplayText,
         timeoutMessageText: string;
         faceDistanceHeaderText: string;
         faceDistanceMessageText: string;
+        multipleFacesHeaderText: string;
+        multipleFacesMessageText: string;
         clientHeaderText: string;
         clientMessageText: string;
         serverHeaderText: string;

package/dist/types/components/FaceLivenessDetector/types/classNames.d.ts

@@ -7,6 +7,8 @@ export declare enum LivenessClassNames {
     DescriptionBulletIndex = "amplify-liveness-description-bullet__index",
     DescriptionBulletIndexText = "amplify-liveness-description-bullet__index__text",
     DescriptionBulletMessage = "amplify-liveness-description-bullet__message",
+    ErrorModal = "amplify-liveness-error-modal",
+    ErrorModalHeading = "amplify-liveness-error-modal__heading",
     FadeOut = "amplify-liveness-fade-out",
     FreshnessCanvas = "amplify-liveness-freshness-canvas",
     InstructionList = "amplify-liveness-instruction-list",
@@ -16,12 +18,31 @@ export declare enum LivenessClassNames {
     FigureIcon = "amplify-liveness-figure__icon",
     FigureImage = "amplify-liveness-figure__image",
     Figures = "amplify-liveness-figures",
+    Hint = "amplify-liveness-hint",
+    HintText = "amplify-liveness-hint__text",
+    LandscapeErrorModal = "amplify-liveness-landscape-error-modal",
+    LandscapeErrorModalButton = "amplify-liveness-landscape-error-modal__button",
+    LandscapeErrorModalHeader = "amplify-liveness-landscape-error-modal__header",
     Loader = "amplify-liveness-loader",
     MatchIndicator = "amplify-liveness-match-indicator",
     OvalCanvas = "amplify-liveness-oval-canvas",
+    OpaqueOverlay = "amplify-liveness-overlay-opaque",
+    Overlay = "amplify-liveness-overlay",
+    Popover = "amplify-liveness-popover",
+    PopoverContainer = "amplify-liveness-popover__container",
+    PopoverAnchor = "amplify-liveness-popover__anchor",
+    PopoverAnchorSecondary = "amplify-liveness-popover__anchor-secondary",
     RecordingIconContainer = "amplify-liveness-recording-icon-container",
     RecordingIcon = "amplify-liveness-recording-icon",
+    StartScreenHeader = "amplify-liveness-start-screen-header",
+    StartScreenHeaderBody = "amplify-liveness-start-screen-header__body",
+    StartScreenHeaderHeading = "amplify-liveness-start-screen-header__heading",
+    StartScreenWarning = "amplify-liveness-start-screen-warning",
+    StartScreenInstructions = "amplify-liveness-start-screen-instructions",
+    StartScreenInstructionsHeading = "amplify-liveness-start-screen-instructions__heading",
     Toast = "amplify-liveness-toast",
+    ToastContainer = "amplify-liveness-toast__container",
+    ToastMessage = "amplify-liveness-toast__message",
     Video = "amplify-liveness-video",
     VideoAnchor = "amplify-liveness-video-anchor"
 }

package/dist/types/index.d.ts

@@ -1 +1 @@
-export { FaceLivenessDetector, FaceLivenessDetectorProps } from './components';
+export { FaceLivenessDetector, FaceLivenessDetectorProps, FaceLivenessDetectorCore, FaceLivenessDetectorCoreProps, AwsCredentialProvider, AwsCredentials, AwsTemporaryCredentials, } from './components';

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "1.0.6";
+export declare const VERSION = "2.0.1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/ui-react-liveness",
-  "version": "1.0.6",
+  "version": "2.0.1",
   "main": "dist/index.js",
   "module": "dist/esm/index.mjs",
   "exports": {
@@ -48,8 +48,8 @@
     "react-dom": ">= 16.14.0"
   },
   "dependencies": {
-    "@aws-amplify/ui": "5.6.6",
-    "@aws-amplify/ui-react": "5.0.4",
+    "@aws-amplify/ui": "5.6.8",
+    "@aws-amplify/ui-react": "5.0.6",
     "@aws-sdk/client-rekognitionstreaming": "3.360.0",
     "@tensorflow-models/blazeface": "0.0.7",
     "@tensorflow/tfjs-backend-cpu": "3.11.0",
@@ -59,7 +59,6 @@
     "@xstate/react": "3.0.0",
     "classnames": "2.3.1",
     "nanoid": "3.1.31",
-    "react-countdown-circle-timer": "^2.5.4",
     "tslib": "2.4.1",
     "xstate": "^4.33.6"
   },
@@ -67,7 +66,7 @@
     "@aws-amplify/eslint-config-amplify-ui": "0.0.0",
     "@rollup/plugin-commonjs": "^22.0.1",
     "@rollup/plugin-typescript": "^8.3.1",
-    "@size-limit/preset-big-lib": "^7.0.8",
+    "@size-limit/preset-big-lib": "^8.2.6",
     "@testing-library/jest-dom": "^5.14.1",
     "@testing-library/react": "^12.0.0",
     "@testing-library/react-hooks": "^7.0.1",
@@ -87,7 +86,7 @@
     "rollup-plugin-node-externals": "^4.1.1",
     "rollup-plugin-styles": "^4.0.0",
     "rollup-plugin-terser": "^7.0.2",
-    "size-limit": "^7.0.8",
+    "size-limit": "^8.2.6",
     "ts-jest": "^27.0.3",
     "web-streams-polyfill": "^3.2.1"
   },