@aws-amplify/ui-react-liveness 2.0.6 → 2.0.8

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

@@ -1,7 +1,7 @@
 import { ActorRef, Interpreter, State } from 'xstate';
 import { ValidationException, InternalServerException, ThrottlingException, ServiceQuotaExceededException, SessionInformation } from '@aws-sdk/client-rekognitionstreaming';
 import { FaceLivenessDetectorCoreProps, FaceMatchState, LivenessOvalDetails, IlluminationState } from './liveness';
-import { LivenessErrorState } from './error';
+import { ErrorState } from './error';
 import { VideoRecorder, LivenessStreamProvider, FreshnessColorDisplay } from '../utils';
 import { Face, FaceDetection } from './faceDetection';
 export interface FaceMatchAssociatedParams {
@@ -45,7 +45,7 @@ export interface HydratedLivenessContext {
     ovalAssociatedParams: OvalAssociatedParams;
     faceMatchAssociatedParams: FaceMatchAssociatedParams;
     freshnessColorAssociatedParams: FreshnessColorAssociatedParams;
-    errorState: LivenessErrorState;
+    errorState: ErrorState;
     livenessStreamProvider: LivenessStreamProvider;
     responseStreamActorRef: ActorRef<any>;
     shouldDisconnect: boolean;

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

@@ -0,0 +1,37 @@
+import { HttpRequest, HttpResponse } from '@smithy/protocol-http';
+import { Provider, RequestHandler, RequestHandlerMetadata } from '@smithy/types';
+export interface WebSocketFetchHandlerOptions {
+    /**
+     * The maximum time in milliseconds that the connection phase of a request
+     * may take before the connection attempt is abandoned.
+     */
+    connectionTimeout?: number;
+}
+/**
+ * Base handler for websocket requests and HTTP request. By default, the request input and output
+ * body will be in a ReadableStream, because of interface consistency among middleware.
+ * If ReadableStream is not available, like in React-Native, the response body
+ * will be an async iterable.
+ */
+export declare class CustomWebSocketFetchHandler {
+    readonly metadata: RequestHandlerMetadata;
+    private readonly configPromise;
+    private readonly httpHandler;
+    private readonly sockets;
+    private readonly utf8decoder;
+    constructor(options?: WebSocketFetchHandlerOptions | Provider<WebSocketFetchHandlerOptions>, httpHandler?: RequestHandler<any, any>);
+    /**
+     * Destroys the WebSocketHandler.
+     * Closes all sockets from the socket pool.
+     */
+    destroy(): void;
+    handle(request: HttpRequest): Promise<{
+        response: HttpResponse;
+    }>;
+    /**
+     * Removes all closing/closed sockets from the socket pool for URL.
+     */
+    private removeNotUsableSockets;
+    private waitForReady;
+    private connect;
+}

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

@@ -1,3 +1,11 @@
 export declare const FACE_DISTANCE_THRESHOLD = 0.32;
 export declare const REDUCED_THRESHOLD = 0.4;
 export declare const REDUCED_THRESHOLD_MOBILE = 0.37;
+export declare const WS_CLOSURE_CODE: {
+    SUCCESS_CODE: number;
+    DEFAULT_ERROR_CODE: number;
+    FACE_FIT_TIMEOUT: number;
+    USER_CANCEL: number;
+    RUNTIME_ERROR: number;
+    USER_ERROR_DURING_CONNECTION: number;
+};

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

@@ -1,4 +1,4 @@
-import { LivenessOvalDetails, IlluminationState, Face, FaceMatchState, BoundingBox, LivenessErrorState } from '../types';
+import { LivenessOvalDetails, IlluminationState, Face, FaceMatchState, BoundingBox, ErrorState } from '../types';
 import { FaceDetection } from '../types/faceDetection';
 import { ClientFreshnessColorSequence } from '../types/service';
 import { ColorSequence, SessionInformation } from '@aws-sdk/client-rekognitionstreaming';
@@ -62,7 +62,17 @@ export declare function estimateIllumination(videoEl: HTMLVideoElement): Illumin
  * @param device
  */
 export declare function isCameraDeviceVirtual(device: MediaDeviceInfo): boolean;
-export declare const LivenessErrorStateStringMap: Record<LivenessErrorState, string>;
+export declare const LivenessErrorStateStringMap: {
+    RUNTIME_ERROR: string;
+    SERVER_ERROR: string;
+    TIMEOUT: string;
+    FACE_DISTANCE_ERROR: string;
+    MULTIPLE_FACES_ERROR: string;
+    CAMERA_FRAMERATE_ERROR: string;
+    CAMERA_ACCESS_ERROR: string;
+    MOBILE_LANDSCAPE_ERROR: string;
+    FRESHNESS_TIMEOUT: string;
+};
 export declare const MOCK_COLOR_SEQUENCES: ColorSequence[];
 interface FillOverlayCanvasFractionalInput {
     overlayCanvas: HTMLCanvasElement;
@@ -86,7 +96,7 @@ export declare function isFaceDistanceBelowThreshold({ faceDetector, videoEl, ov
     isMobile?: boolean;
 }): Promise<{
     isDistanceBelowThreshold: boolean;
-    error?: LivenessErrorState.FACE_DISTANCE_ERROR | LivenessErrorState.MULTIPLE_FACES_ERROR;
+    error?: ErrorState;
 }>;
 export declare function getBoundingBox({ deviceHeight, deviceWidth, height, width, top, left, }: {
     deviceHeight: number;

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

@@ -1,4 +1,3 @@
-import { AmazonAIInterpretPredictionsProvider } from '@aws-amplify/predictions';
 import { ClientSessionInformationEvent, LivenessResponseStream } from '@aws-sdk/client-rekognitionstreaming';
 import { VideoRecorder } from './videoRecorder';
 import { AwsCredentialProvider } from '../types';
@@ -22,7 +21,7 @@ export interface StreamProviderArgs {
     credentialProvider?: AwsCredentialProvider;
 }
 export declare const TIME_SLICE = 1000;
-export declare class LivenessStreamProvider extends AmazonAIInterpretPredictionsProvider {
+export declare class LivenessStreamProvider {
     sessionId: string;
     region: string;
     videoRecorder: VideoRecorder;
@@ -39,7 +38,7 @@ export declare class LivenessStreamProvider extends AmazonAIInterpretPredictions
     sendClientInfo(clientInfo: ClientSessionInformationEvent): void;
     stopVideo(): Promise<void>;
     dispatchStopVideoEvent(): void;
-    endStream(): Promise<undefined>;
+    endStreamWithCode(code?: number): Promise<undefined>;
     private init;
     private getAsyncGeneratorFromReadableStream;
     private startLivenessVideoConnection;

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

@@ -7,7 +7,10 @@ export interface VideoRecorderOptions {
  * Helper wrapper class over the native MediaRecorder.
  */
 export declare class VideoRecorder {
-    videoStream: ReadableStream<Blob | string>;
+    videoStream: ReadableStream<Blob | string | {
+        type: string;
+        code: number;
+    }>;
     recordingStartApiTimestamp: number | undefined;
     recorderStartTimestamp: number | undefined;
     recorderEndTimestamp: number | undefined;

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

@@ -1,5 +1,5 @@
 import React from 'react';
-import { LivenessErrorState } from '../service';
+import { ErrorState } from '../service';
 import { ErrorDisplayText } from '../displayText';
 export interface CheckScreenComponents {
     ErrorView?: React.ComponentType<FaceLivenessErrorModalProps>;
@@ -10,7 +10,7 @@ export interface FaceLivenessErrorModalProps {
     onRetry: () => void;
 }
 export declare const renderErrorModal: ({ errorState, overrideErrorDisplayText, }: {
-    errorState: LivenessErrorState;
+    errorState: ErrorState;
     overrideErrorDisplayText?: Partial<{
         timeoutHeaderText: string;
         timeoutMessageText: string;

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

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import { IlluminationState, FaceMatchState } from '../service';
 import { HintDisplayText } from '../displayText';
-export declare const selectErrorState: import("../hooks").LivenessSelectorFn<import("../service").LivenessErrorState | undefined>;
+export declare const selectErrorState: import("../hooks").LivenessSelectorFn<"TIMEOUT" | "RUNTIME_ERROR" | "FRESHNESS_TIMEOUT" | "SERVER_ERROR" | "CAMERA_FRAMERATE_ERROR" | "CAMERA_ACCESS_ERROR" | "FACE_DISTANCE_ERROR" | "MOBILE_LANDSCAPE_ERROR" | "MULTIPLE_FACES_ERROR" | undefined>;
 export declare const selectFaceMatchState: import("../hooks").LivenessSelectorFn<FaceMatchState | undefined>;
 export declare const selectIlluminationState: import("../hooks").LivenessSelectorFn<IlluminationState | undefined>;
 export declare const selectIsFaceFarEnoughBeforeRecording: import("../hooks").LivenessSelectorFn<boolean | undefined>;

package/dist/types/index.d.ts

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

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "2.0.6";
+export declare const VERSION = "2.0.8";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/ui-react-liveness",
-  "version": "2.0.6",
+  "version": "2.0.8",
   "main": "dist/index.js",
   "module": "dist/esm/index.mjs",
   "exports": {
@@ -48,9 +48,13 @@
     "react-dom": ">= 16.14.0"
   },
   "dependencies": {
-    "@aws-amplify/ui": "5.8.0",
-    "@aws-amplify/ui-react": "5.3.0",
-    "@aws-sdk/client-rekognitionstreaming": "3.360.0",
+    "@aws-amplify/ui": "5.8.1",
+    "@aws-amplify/ui-react": "5.3.1",
+    "@aws-sdk/client-rekognitionstreaming": "3.398.0",
+    "@aws-sdk/util-format-url": "^3.410.0",
+    "@smithy/eventstream-serde-browser": "^2.0.4",
+    "@smithy/fetch-http-handler": "^2.1.3",
+    "@smithy/protocol-http": "^3.0.3",
     "@tensorflow-models/blazeface": "0.0.7",
     "@tensorflow/tfjs-backend-cpu": "3.11.0",
     "@tensorflow/tfjs-backend-wasm": "3.11.0",
@@ -78,7 +82,9 @@
     "eslint": "^8.44.0",
     "jest": "^27.0.4",
     "jest-canvas-mock": "^2.4.0",
+    "jest-websocket-mock": "^2.4.1",
     "jest-when": "^3.5.1",
+    "mock-socket": "^9.2.1",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "rimraf": "^3.0.2",