@aws-amplify/ui-react-liveness 3.0.13 → 3.0.15

package/dist/styles.css

@@ -4205,7 +4205,7 @@ html[dir=rtl] .amplify-field-group__inner-start {
 
 .amplify-liveness-landscape-error-modal {
   background-color: var(--amplify-colors-background-primary);
-  direction: column;
+  flex-direction: column;
   text-align: center;
   align-items: center;
   justify-content: center;

package/dist/types/components/FaceLivenessDetector/hooks/useLivenessActor.d.ts

@@ -1 +1 @@
-export declare function useLivenessActor(): [import("xstate").State<Partial<import("../service").HydratedLivenessContext>, import("../service").LivenessEvent, any, any, any>, (event: import("xstate").SingleOrArray<import("xstate").Event<import("../service").LivenessEvent>> | import("xstate").SCXML.Event<import("../service").LivenessEvent>, payload?: import("xstate").EventData | undefined) => import("xstate").State<Partial<import("../service").HydratedLivenessContext>, import("../service").LivenessEvent, any, any, any>];
+export declare function useLivenessActor(): [import("xstate").State<import("../service").LivenessContext, import("../service").LivenessEvent, any, any, any>, (event: import("xstate").SingleOrArray<import("xstate").Event<import("../service").LivenessEvent>> | import("xstate").SCXML.Event<import("../service").LivenessEvent>, payload?: import("xstate").EventData | undefined) => import("xstate").State<import("../service").LivenessContext, import("../service").LivenessEvent, any, any, any>];

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

@@ -1,6 +1,5 @@
-import { LivenessEvent } from '../types';
-export declare const MIN_FACE_MATCH_TIME = 1000;
-export declare const livenessMachine: import("xstate").StateMachine<Partial<import("../types").HydratedLivenessContext>, any, LivenessEvent, {
+import { LivenessContext, LivenessEvent } from '../types';
+export declare const livenessMachine: import("xstate").StateMachine<LivenessContext, any, LivenessEvent, {
     value: any;
-    context: Partial<import("../types").HydratedLivenessContext>;
+    context: LivenessContext;
 }, import("xstate").BaseActionObject, import("xstate").ServiceMap, import("xstate").ResolveTypegenMeta<import("xstate").TypegenDisabled, LivenessEvent, import("xstate").BaseActionObject, import("xstate").ServiceMap>>;

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

@@ -1,16 +1,15 @@
+import { CredentialsAndIdentityId } from 'aws-amplify/auth';
+export type AwsCredentials = CredentialsAndIdentityId['credentials'];
+export interface IdentityProvider<IdentityT extends AwsCredentials> {
+    (identityProperties?: Record<string, any>): Promise<IdentityT>;
+}
 /**
- * These types are copied over / adapted from the aws-sdk/types package as they do not semantic versioning and we do not want these changing unexpectedly.
- * When Amplify Auth exports these types this file should be removed and the type definitions should come from the Amplify auth package
+ * @deprecated `AwsTemporaryCredentials` has been replaced with `AwsCredentials`.
+ *
+ * The `AwsTemporaryCredentials` type may be removed in a future major version of _@aws-amplify/ui-react-liveness_.
  */
-export interface AwsCredentials {
-    readonly accessKeyId: string;
-    readonly secretAccessKey: string;
-}
 export interface AwsTemporaryCredentials extends AwsCredentials {
     readonly sessionToken?: string;
     readonly expiration?: Date;
 }
-export interface IdentityProvider<IdentityT extends AwsTemporaryCredentials> {
-    (identityProperties?: Record<string, any>): Promise<IdentityT>;
-}
-export type AwsCredentialProvider = IdentityProvider<AwsTemporaryCredentials>;
+export type AwsCredentialProvider = IdentityProvider<AwsCredentials>;

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

@@ -36,24 +36,23 @@ export interface VideoAssociatedParams {
     selectedDeviceId?: string;
     selectableDevices?: MediaDeviceInfo[];
 }
-export type LivenessContext = Partial<HydratedLivenessContext>;
-export interface HydratedLivenessContext {
-    maxFailedAttempts: number;
-    failedAttempts: number;
-    componentProps: FaceLivenessDetectorCoreProps;
-    serverSessionInformation: SessionInformation;
-    challengeId: string;
-    videoAssociatedParams: VideoAssociatedParams;
-    ovalAssociatedParams: OvalAssociatedParams;
-    faceMatchAssociatedParams: FaceMatchAssociatedParams;
-    freshnessColorAssociatedParams: FreshnessColorAssociatedParams;
-    errorState: ErrorState;
-    livenessStreamProvider: LivenessStreamProvider;
-    responseStreamActorRef: ActorRef<any>;
-    shouldDisconnect: boolean;
-    faceMatchStateBeforeStart: FaceMatchState;
-    isFaceFarEnoughBeforeRecording: boolean;
-    isRecordingStopped: boolean;
+export interface LivenessContext {
+    challengeId?: string;
+    componentProps?: FaceLivenessDetectorCoreProps;
+    errorState?: ErrorState;
+    faceMatchAssociatedParams?: FaceMatchAssociatedParams;
+    faceMatchStateBeforeStart?: FaceMatchState;
+    failedAttempts?: number;
+    freshnessColorAssociatedParams?: FreshnessColorAssociatedParams;
+    isFaceFarEnoughBeforeRecording?: boolean;
+    isRecordingStopped?: boolean;
+    livenessStreamProvider?: LivenessStreamProvider;
+    maxFailedAttempts?: number;
+    ovalAssociatedParams?: OvalAssociatedParams;
+    responseStreamActorRef?: ActorRef<any>;
+    serverSessionInformation?: SessionInformation;
+    shouldDisconnect?: boolean;
+    videoAssociatedParams?: VideoAssociatedParams;
 }
 export type LivenessEventTypes = 'BEGIN' | 'START_RECORDING' | 'TIMEOUT' | 'ERROR' | 'CANCEL' | 'SET_SESSION_INFO' | 'DISCONNECT_EVENT' | 'SET_DOM_AND_CAMERA_DETAILS' | 'UPDATE_DEVICE_AND_STREAM' | 'SERVER_ERROR' | 'RUNTIME_ERROR' | 'RETRY_CAMERA_CHECK' | 'MOBILE_LANDSCAPE_WARNING';
 export type LivenessEventData = Record<PropertyKey, any>;

package/dist/types/components/FaceLivenessDetector/service/utils/createStreamingClient/Signer.d.ts

@@ -0,0 +1,6 @@
+import { SignatureV4 } from '@smithy/signature-v4';
+import { HttpRequest as HttpRequest, RequestPresigningArguments } from '@smithy/types';
+export declare const REQUEST_EXPIRY = 299;
+export declare class Signer extends SignatureV4 {
+    presign(request: HttpRequest, options?: Omit<RequestPresigningArguments, 'expiresIn'>): Promise<HttpRequest>;
+}

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

@@ -0,0 +1,9 @@
+import { RekognitionStreamingClient } from '@aws-sdk/client-rekognitionstreaming';
+import { AwsCredentialProvider } from '../../types';
+interface CreateClientConfig {
+    credentialsProvider?: AwsCredentialProvider;
+    endpointOverride?: string;
+    region: string;
+}
+export declare function createStreamingClient({ credentialsProvider, endpointOverride, region, }: CreateClientConfig): Promise<RekognitionStreamingClient>;
+export {};

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

@@ -0,0 +1 @@
+export { createStreamingClient } from './createStreamingClient';

package/dist/types/components/FaceLivenessDetector/service/utils/createStreamingClient/resolveCredentials.d.ts

@@ -0,0 +1,10 @@
+import { AwsCredentialProvider, AwsCredentials } from '../../types';
+/**
+ * Resolves the `credentials` param to be passed to `RekognitionStreamingClient` which accepts either:
+ * - a `credentials` object
+ * - a `credentialsProvider` callback
+ *
+ * @param credentialsProvider optional `credentialsProvider` callback
+ * @returns {Promise<AwsCredentials | AwsCredentialProvider>} `credentials` object or valid `credentialsProvider` callback
+ */
+export declare function resolveCredentials(credentialsProvider?: AwsCredentialProvider): Promise<AwsCredentials | AwsCredentialProvider>;

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

@@ -1,7 +1,7 @@
 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';
+import { SessionInformation } from '@aws-sdk/client-rekognitionstreaming';
 interface OvalBoundingBox {
     ovalBoundingBox: BoundingBox;
     minOvalX: number;
@@ -36,7 +36,6 @@ export declare function getStaticLivenessOvalDetails({ width, height, widthSeed,
     centerYSeed?: number;
     ratioMultiplier?: number;
 }): LivenessOvalDetails;
-export declare function drawStaticOval(canvasEl: HTMLCanvasElement, videoEl: HTMLVideoElement, videoMediaStream: MediaStream): void;
 /**
  * Draws the provided liveness oval on the canvas.
  */
@@ -47,18 +46,18 @@ export declare function drawLivenessOvalInCanvas({ canvas, oval, scaleFactor, vi
     videoEl: HTMLVideoElement;
     isStartScreen?: boolean;
 }): void;
+export declare function drawStaticOval(canvasEl: HTMLCanvasElement, videoEl: HTMLVideoElement, videoMediaStream: MediaStream): void;
 export declare function clearOvalCanvas({ canvas, }: {
     canvas: HTMLCanvasElement;
 }): void;
-interface FaceMatchStateInLivenessOval {
-    faceMatchState: FaceMatchState;
-    faceMatchPercentage: number;
-}
+export declare function generateBboxFromLandmarks(face: Face, oval: LivenessOvalDetails): BoundingBox;
 /**
  * Returns the state of the provided face with respect to the provided liveness oval.
  */
-export declare function getFaceMatchStateInLivenessOval(face: Face, ovalDetails: LivenessOvalDetails, initialFaceIntersection: number, sessionInformation: SessionInformation): FaceMatchStateInLivenessOval;
-export declare function generateBboxFromLandmarks(face: Face, oval: LivenessOvalDetails): BoundingBox;
+export declare function getFaceMatchStateInLivenessOval(face: Face, ovalDetails: LivenessOvalDetails, initialFaceIntersection: number, sessionInformation: SessionInformation): {
+    faceMatchState: FaceMatchState;
+    faceMatchPercentage: number;
+};
 /**
  * Returns the illumination state in the provided video frame.
  */
@@ -79,7 +78,6 @@ export declare const LivenessErrorStateStringMap: {
     MOBILE_LANDSCAPE_ERROR: string;
     FRESHNESS_TIMEOUT: string;
 };
-export declare const MOCK_COLOR_SEQUENCES: ColorSequence[];
 interface FillOverlayCanvasFractionalInput {
     overlayCanvas: HTMLCanvasElement;
     prevColor: string;

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

@@ -4,24 +4,16 @@ import { AwsCredentialProvider } from '../types';
 export interface StartLivenessStreamInput {
     sessionId: string;
 }
-export interface StartLivenessStreamOutput {
-    sessionId: string;
+export interface StartLivenessStreamOutput extends StartLivenessStreamInput {
     stream: WebSocket;
 }
-export interface Credentials {
-    accessKeyId: string;
-    secretAccessKey: string;
-    sessionToken: string;
-}
-export interface StreamProviderArgs {
-    sessionId: string;
+interface StreamProviderArgs extends StartLivenessStreamInput {
     region: string;
     stream: MediaStream;
     videoEl: HTMLVideoElement;
     credentialProvider?: AwsCredentialProvider;
     endpointOverride?: string;
 }
-export declare const TIME_SLICE = 1000;
 export declare class LivenessStreamProvider {
     sessionId: string;
     region: string;
@@ -45,3 +37,4 @@ export declare class LivenessStreamProvider {
     private getAsyncGeneratorFromReadableStream;
     private startLivenessVideoConnection;
 }
+export {};

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

@@ -1,8 +1,3 @@
-/**
- * The options for the video recorder.
- */
-export interface VideoRecorderOptions {
-}
 /**
  * Helper wrapper class over the native MediaRecorder.
  */
@@ -18,10 +13,9 @@ export declare class VideoRecorder {
     recorderStarted: Promise<void>;
     private _recorder;
     private _stream;
-    private _options;
     private _chunks;
     private _recorderStopped;
-    constructor(stream: MediaStream, options?: VideoRecorderOptions);
+    constructor(stream: MediaStream);
     getState(): string | undefined;
     start(timeSlice?: number): void;
     stop(): Promise<void>;

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

@@ -3,6 +3,3 @@ export * from './Hint';
 export * from './MatchIndicator';
 export * from './Overlay';
 export * from './RecordingIcon';
-export * from './StartScreenFigure';
-export * from './GoodFitIllustration';
-export * from './TooFarIllustration';

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

@@ -13,11 +13,6 @@ export declare enum LivenessClassNames {
     FreshnessCanvas = "amplify-liveness-freshness-canvas",
     InstructionList = "amplify-liveness-instruction-list",
     InstructionOverlay = "amplify-liveness-instruction-overlay",
-    Figure = "amplify-liveness-figure",
-    FigureCaption = "amplify-liveness-figure__caption",
-    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",

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "3.0.13";
+export declare const VERSION = "3.0.15";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/ui-react-liveness",
-  "version": "3.0.13",
+  "version": "3.0.15",
   "main": "dist/index.js",
   "module": "dist/esm/index.mjs",
   "exports": {
@@ -47,13 +47,14 @@
     "react-dom": "^16.14.0 || ^17.0 || ^18.0"
   },
   "dependencies": {
-    "@aws-amplify/ui": "6.0.11",
-    "@aws-amplify/ui-react": "6.1.5",
+    "@aws-amplify/ui": "6.0.12",
+    "@aws-amplify/ui-react": "6.1.6",
     "@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",
+    "@smithy/signature-v4": "2.1.4",
     "@mediapipe/face_detection": "~0.4.0",
     "@tensorflow-models/face-detection": "1.0.2",
     "@tensorflow/tfjs-backend-cpu": "4.11.0",
@@ -80,7 +81,7 @@
       "name": "FaceLivenessDetector",
       "path": "dist/esm/index.mjs",
       "import": "{ FaceLivenessDetector }",
-      "limit": "275 kB"
+      "limit": "280 kB"
     }
   ]
 }

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

@@ -1,7 +0,0 @@
-import React from 'react';
-interface GoodFitIllustrationProps {
-    title: string;
-    testId?: string;
-}
-export declare const GoodFitIllustration: React.FC<GoodFitIllustrationProps>;
-export {};

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

@@ -1,8 +0,0 @@
-import React from 'react';
-import { FlexProps } from '@aws-amplify/ui-react';
-interface StartScreenFigureProps extends FlexProps {
-    caption: string;
-    variation?: 'defaut' | 'error' | 'success';
-}
-export declare const StartScreenFigure: React.FC<StartScreenFigureProps>;
-export {};

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

@@ -1,7 +0,0 @@
-import React from 'react';
-interface TooFarIllustrationProps {
-    title: string;
-    testId?: string;
-}
-export declare const TooFarIllustration: React.FC<TooFarIllustrationProps>;
-export {};