@aws-amplify/ui-react-liveness 3.3.8 → 3.3.9

package/README.md

@@ -1,23 +1,23 @@
-# Amplify UI
+# Amplify UI React Liveness
 
-Amplify UI is an open-source UI library with cloud-connected components that are endlessly customizable, accessible, and can integrate into _any_ application. Amplify UI consists of:
+The React Liveness package provides components for face liveness detection in Amplify connected applications.
 
-1. Connected components that simplify complex cloud-connected workflows, like Authenticator.
-2. Primitive components that create consistency across Amplify UI and allow you to build complete applications that fit your brand, like Buttons and Badges.
-3. Data-bound components that make it easy to display dynamic data, like DataStoreCollections.
-4. Theming capabilities that allow you to customize the appearance of Amplify UI to match your brand.
+## Contents
 
-## React Documentation
+### Core Components
 
-- https://ui.docs.amplify.aws/react
+- `FaceLivenessDetector` - Component for face liveness detection
+- `FaceLivenessDetectorCore` - Core component for face liveness detection
 
-## Features 🚀
+### Type Definitions
 
-- **Better developer experience** Connected-components like Authenticator are being written with framework-specific implementations so that they follow framework conventions and are easier to integrate into your application.
-- **Endlessly customizable** Every detail of Amplify UI is customizable to match your brand. Style all of Amplify UI with themes, override components with your own, or build your own UI and use Amplify for complex state management.
-- **Accessible** Amplify UI components follow [WCAG](https://www.w3.org/WAI/standards-guidelines/wcag/) and [WAI-ARIA](https://www.w3.org/TR/wai-aria-1.2/) best practices and guidelines such as color contrast, keyboard navigation, accessible labels, and focus management.
-- **Primitive components (React only right now)** Primitive components are used in the connected components, like Authenticator, you can also customize them and use them to build the rest of your UI.
+- `FaceLivenessDetectorProps` - Props for FaceLivenessDetector component
+- `FaceLivenessDetectorCoreProps` - Props for FaceLivenessDetectorCore component
+- `AwsCredentialProvider` - Type for AWS credential provider
+- `AwsCredentials` - Type for AWS credentials
+- `AwsTemporaryCredentials` - Type for AWS temporary credentials
+- `ErrorState` - Type for error state
 
-## We love contributors!!
+## React Documentation
 
-See our contributing guide [CONTRIBUTING.md](/CONTRIBUTING.md) to help us scale Amplify UI!
+- https://ui.docs.amplify.aws/react

package/dist/esm/version.mjs

@@ -1,3 +1,3 @@
-const VERSION = '3.3.8';
+const VERSION = '3.3.9';
 
 export { VERSION };

package/dist/index.js

@@ -831,7 +831,7 @@ function getFaceMatchStateInLivenessOval({ face, ovalDetails, initialFaceInterse
     return { faceMatchState, faceMatchPercentage };
 }
 
-const VERSION = '3.3.8';
+const VERSION = '3.3.9';
 
 const BASE_USER_AGENT = `ui-react-liveness/${VERSION}`;
 const getLivenessUserAgent = () => {

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

@@ -1,7 +1,7 @@
 import * as React from 'react';
-import { FaceLivenessDetectorProps as FaceLivenessDetectorPropsFromUi } from './service';
-import { LivenessDisplayText } from './displayText';
-import { FaceLivenessDetectorComponents } from './shared/DefaultStartScreenComponents';
+import type { FaceLivenessDetectorProps as FaceLivenessDetectorPropsFromUi } from './service';
+import type { LivenessDisplayText } from './displayText';
+import type { FaceLivenessDetectorComponents } from './shared/DefaultStartScreenComponents';
 export interface FaceLivenessDetectorProps extends FaceLivenessDetectorPropsFromUi {
     components?: FaceLivenessDetectorComponents;
     displayText?: LivenessDisplayText;

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

@@ -1,7 +1,7 @@
 import * as React from 'react';
-import { FaceLivenessDetectorCoreProps as FaceLivenessDetectorPropsFromUi } from './service';
-import { FaceLivenessDetectorComponents } from './shared/DefaultStartScreenComponents';
-import { LivenessDisplayText } from './displayText';
+import type { FaceLivenessDetectorCoreProps as FaceLivenessDetectorPropsFromUi } from './service';
+import type { FaceLivenessDetectorComponents } from './shared/DefaultStartScreenComponents';
+import type { LivenessDisplayText } from './displayText';
 export interface FaceLivenessDetectorCoreProps extends FaceLivenessDetectorPropsFromUi {
     components?: FaceLivenessDetectorComponents;
     displayText?: LivenessDisplayText;

package/dist/types/components/FaceLivenessDetector/LivenessCheck/LivenessCameraModule.d.ts

@@ -1,7 +1,7 @@
 import React from 'react';
 import { FaceMatchState } from '../service';
-import { InstructionDisplayText, ErrorDisplayText, HintDisplayText, StreamDisplayText, CameraDisplayText } from '../displayText';
-import { FaceLivenessDetectorComponents } from '../shared/DefaultStartScreenComponents';
+import type { InstructionDisplayText, ErrorDisplayText, HintDisplayText, StreamDisplayText, CameraDisplayText } from '../displayText';
+import type { FaceLivenessDetectorComponents } from '../shared/DefaultStartScreenComponents';
 export declare const selectVideoConstraints: import("../hooks").LivenessSelectorFn<MediaTrackConstraints | undefined>;
 export declare const selectVideoStream: import("../hooks").LivenessSelectorFn<MediaStream | undefined>;
 export declare const selectFaceMatchPercentage: import("../hooks").LivenessSelectorFn<number | undefined>;

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

@@ -1,6 +1,6 @@
 import * as React from 'react';
-import { InstructionDisplayText, HintDisplayText, CameraDisplayText, StreamDisplayText, ErrorDisplayText } from '../displayText';
-import { FaceLivenessDetectorComponents } from '../shared/DefaultStartScreenComponents';
+import type { InstructionDisplayText, HintDisplayText, CameraDisplayText, StreamDisplayText, ErrorDisplayText } from '../displayText';
+import type { FaceLivenessDetectorComponents } from '../shared/DefaultStartScreenComponents';
 export declare const selectIsRecordingStopped: import("../hooks").LivenessSelectorFn<boolean | undefined>;
 interface LivenessCheckProps {
     instructionDisplayText: Required<InstructionDisplayText>;

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

@@ -1,4 +1,4 @@
-import { DisplayTextTemplate } from '@aws-amplify/ui';
+import type { DisplayTextTemplate } from '@aws-amplify/ui';
 export type HintDisplayText = {
     hintMoveFaceFrontOfCameraText?: string;
     hintTooManyFacesText?: string;

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

@@ -1,4 +1,4 @@
-import { LivenessMachineState } from '../service';
+import type { LivenessMachineState } from '../service';
 export type LivenessSelectorFn<T> = (state: LivenessMachineState) => T;
 export declare function createLivenessSelector<T>(selector: LivenessSelectorFn<T>): LivenessSelectorFn<T>;
 export declare function useLivenessSelector<T>(selector: LivenessSelectorFn<T>): T;

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

@@ -1,3 +1,5 @@
-export { default as FaceLivenessDetector, FaceLivenessDetectorProps, } from './FaceLivenessDetector';
-export { default as FaceLivenessDetectorCore, FaceLivenessDetectorCoreProps, } from './FaceLivenessDetectorCore';
-export { AwsCredentialProvider, AwsTemporaryCredentials, AwsCredentials, ErrorState, } from './service';
+export type { FaceLivenessDetectorProps } from './FaceLivenessDetector';
+export { default as FaceLivenessDetector } from './FaceLivenessDetector';
+export type { FaceLivenessDetectorCoreProps } from './FaceLivenessDetectorCore';
+export { default as FaceLivenessDetectorCore } from './FaceLivenessDetectorCore';
+export type { AwsCredentialProvider, AwsTemporaryCredentials, AwsCredentials, ErrorState, } from './service';

package/dist/types/components/FaceLivenessDetector/providers/FaceLivenessDetectorProvider.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { LivenessInterpreter, FaceLivenessDetectorProps } from '../service';
+import type { LivenessInterpreter, FaceLivenessDetectorProps } from '../service';
 interface FaceLivenessDetectorContextType {
     componentProps: FaceLivenessDetectorProps;
     service: LivenessInterpreter;

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

@@ -1,4 +1,4 @@
-import { LivenessContext, LivenessEvent } from '../types';
+import type { LivenessContext, LivenessEvent } from '../types';
 export declare const livenessMachine: import("xstate").StateMachine<LivenessContext, any, LivenessEvent, {
     value: any;
     context: LivenessContext;

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

@@ -1,4 +1,4 @@
-import { CredentialsAndIdentityId } from 'aws-amplify/auth';
+import type { CredentialsAndIdentityId } from 'aws-amplify/auth';
 export type AwsCredentials = CredentialsAndIdentityId['credentials'];
 export interface IdentityProvider<IdentityT extends AwsCredentials> {
     (identityProperties?: Record<string, any>): Promise<IdentityT>;

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

@@ -1,5 +1,5 @@
-import { AwsCredentialProvider } from './credentials';
-import { ErrorState } from './error';
+import type { AwsCredentialProvider } from './credentials';
+import type { ErrorState } from './error';
 /**
  * The props for the FaceLivenessDetectorCore which allows for full configuration of auth
  */

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

@@ -1,9 +1,9 @@
-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 { ErrorState } from './error';
-import { VideoRecorder, LivenessStreamProvider, FreshnessColorDisplay } from '../utils';
-import { Face, FaceDetection } from './faceDetection';
+import type { ActorRef, Interpreter, State } from 'xstate';
+import type { ValidationException, InternalServerException, ThrottlingException, ServiceQuotaExceededException, SessionInformation } from '@aws-sdk/client-rekognitionstreaming';
+import type { FaceLivenessDetectorCoreProps, FaceMatchState, LivenessOvalDetails, IlluminationState } from './liveness';
+import type { ErrorState } from './error';
+import type { VideoRecorder, LivenessStreamProvider, FreshnessColorDisplay } from '../utils';
+import type { Face, FaceDetection } from './faceDetection';
 export interface FaceMatchAssociatedParams {
     illuminationState?: IlluminationState;
     faceMatchState?: FaceMatchState;

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

@@ -1,5 +1,6 @@
 import '@tensorflow/tfjs-backend-cpu';
-import { FaceDetection, Face } from '../types';
+import type { Face } from '../types';
+import { FaceDetection } from '../types';
 type BlazeFaceModelBackend = 'wasm' | 'cpu';
 export declare const BLAZEFACE_VERSION = "1.0.2";
 /**

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

@@ -1,5 +1,6 @@
-import { HttpRequest, HttpResponse } from '@smithy/protocol-http';
-import { Provider, RequestHandler, RequestHandlerMetadata } from './types';
+import type { HttpRequest } from '@smithy/protocol-http';
+import { HttpResponse } from '@smithy/protocol-http';
+import type { Provider, RequestHandler, RequestHandlerMetadata } from './types';
 export declare const WEBSOCKET_CONNECTION_TIMEOUT_MESSAGE = "Websocket connection timeout";
 export interface WebSocketFetchHandlerOptions {
     /**

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

@@ -1,5 +1,5 @@
 import { SignatureV4 } from '@smithy/signature-v4';
-import { HttpRequest as HttpRequest, RequestPresigningArguments } from './types';
+import type { HttpRequest as HttpRequest, RequestPresigningArguments } from './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

@@ -1,5 +1,5 @@
 import { RekognitionStreamingClient } from '@aws-sdk/client-rekognitionstreaming';
-import { AwsCredentialProvider } from '../../types';
+import type { AwsCredentialProvider } from '../../types';
 interface CreateClientConfig {
     credentialsProvider?: AwsCredentialProvider;
     endpointOverride?: string;

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

@@ -1,4 +1,4 @@
-import { AwsCredentialProvider, AwsCredentials } from '../../types';
+import type { AwsCredentialProvider, AwsCredentials } from '../../types';
 /**
  * Resolves the `credentials` param to be passed to `RekognitionStreamingClient` which accepts either:
  * - a `credentials` object

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

@@ -1 +1 @@
-export { HttpRequest, Provider, RequestHandler, RequestHandlerMetadata, RequestPresigningArguments, } from '@smithy/types';
+export type { HttpRequest, Provider, RequestHandler, RequestHandlerMetadata, RequestPresigningArguments, } from '@smithy/types';

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

@@ -1,4 +1,4 @@
-import { LivenessResponseStream } from '@aws-sdk/client-rekognitionstreaming';
+import type { LivenessResponseStream } from '@aws-sdk/client-rekognitionstreaming';
 export declare const isServerSesssionInformationEvent: (value: unknown) => value is LivenessResponseStream.ServerSessionInformationEventMember;
 export declare const isConnectionTimeoutError: (error: unknown) => error is Error;
 export declare const isDisconnectionEvent: (value: unknown) => value is LivenessResponseStream.DisconnectionEventMember;

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

@@ -1,5 +1,5 @@
-import { LivenessContext } from '../types/machine';
-import { ClientFreshnessColorSequence } from '../types/service';
+import type { LivenessContext } from '../types/machine';
+import type { ClientFreshnessColorSequence } from '../types/service';
 export declare class FreshnessColorDisplay {
     private freshnessColorsSequence;
     private context;

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

@@ -1,5 +1,6 @@
-import { LivenessOvalDetails, Face, FaceMatchState } from '../types';
-import { SessionInformation } from '@aws-sdk/client-rekognitionstreaming';
+import type { LivenessOvalDetails, Face } from '../types';
+import { FaceMatchState } from '../types';
+import type { SessionInformation } from '@aws-sdk/client-rekognitionstreaming';
 interface MatchStateInOvalParams {
     face: Face;
     ovalDetails: LivenessOvalDetails;

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

@@ -1,7 +1,8 @@
-import { LivenessOvalDetails, IlluminationState, Face, FaceMatchState, BoundingBox, ErrorState } from '../types';
-import { FaceDetection } from '../types/faceDetection';
-import { ClientFreshnessColorSequence } from '../types/service';
-import { SessionInformation } from '@aws-sdk/client-rekognitionstreaming';
+import type { LivenessOvalDetails, Face, BoundingBox, ErrorState } from '../types';
+import { IlluminationState, FaceMatchState } from '../types';
+import type { FaceDetection } from '../types/faceDetection';
+import type { ClientFreshnessColorSequence } from '../types/service';
+import type { SessionInformation } from '@aws-sdk/client-rekognitionstreaming';
 interface OvalBoundingBox {
     ovalBoundingBox: BoundingBox;
     minOvalX: number;

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

@@ -1,6 +1,6 @@
-import { ClientSessionInformationEvent, LivenessResponseStream } from '@aws-sdk/client-rekognitionstreaming';
+import type { ClientSessionInformationEvent, LivenessResponseStream } from '@aws-sdk/client-rekognitionstreaming';
 import { VideoRecorder } from './videoRecorder';
-import { AwsCredentialProvider } from '../types';
+import type { AwsCredentialProvider } from '../types';
 export interface StartLivenessStreamInput {
     sessionId: string;
 }

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

@@ -1,5 +1,5 @@
 import React from 'react';
-import { CheckScreenComponents } from './FaceLivenessErrorModal';
+import type { CheckScreenComponents } from './FaceLivenessErrorModal';
 export type FaceLivenessDetectorComponents = StartScreenComponents & CheckScreenComponents;
 export interface StartScreenComponents {
     PhotosensitiveWarning?: React.ComponentType;

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

@@ -1,6 +1,6 @@
 import React from 'react';
-import { ErrorState } from '../service';
-import { ErrorDisplayText } from '../displayText';
+import type { ErrorState } from '../service';
+import type { ErrorDisplayText } from '../displayText';
 export interface CheckScreenComponents {
     ErrorView?: React.ComponentType<FaceLivenessErrorModalProps>;
 }

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

@@ -1,6 +1,6 @@
 import * as React from 'react';
 import { IlluminationState, FaceMatchState } from '../service';
-import { HintDisplayText } from '../displayText';
+import type { HintDisplayText } from '../displayText';
 export declare const selectErrorState: import("../hooks").LivenessSelectorFn<"CONNECTION_TIMEOUT" | "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>;

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

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { FlexProps } from '@aws-amplify/ui-react';
+import type { FlexProps } from '@aws-amplify/ui-react';
 interface OverlayProps extends FlexProps {
     horizontal?: 'start' | 'center' | 'end';
     vertical?: 'start' | 'center' | 'end' | 'space-between';

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

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { ViewProps } from '@aws-amplify/ui-react';
+import type { ViewProps } from '@aws-amplify/ui-react';
 interface ToastProps extends ViewProps {
     variation?: 'default' | 'primary' | 'error';
     size?: 'medium' | 'large';

package/dist/types/components/FaceLivenessDetector/utils/getDisplayText.d.ts

@@ -1,4 +1,4 @@
-import { LivenessDisplayText, HintDisplayText, CameraDisplayText, InstructionDisplayText, StreamDisplayText, ErrorDisplayText } from '../displayText';
+import type { LivenessDisplayText, HintDisplayText, CameraDisplayText, InstructionDisplayText, StreamDisplayText, ErrorDisplayText } from '../displayText';
 interface LivenessDisplayTextInterface {
     hintDisplayText: Required<HintDisplayText>;
     cameraDisplayText: Required<CameraDisplayText>;

package/dist/types/index.d.ts

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

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "3.3.8";
+export declare const VERSION = "3.3.9";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/ui-react-liveness",
-  "version": "3.3.8",
+  "version": "3.3.9",
   "main": "dist/index.js",
   "module": "dist/esm/index.mjs",
   "exports": {
@@ -48,8 +48,8 @@
     "react-dom": "^16.14 || ^17 || ^18 || ^19"
   },
   "dependencies": {
-    "@aws-amplify/ui": "6.10.2",
-    "@aws-amplify/ui-react": "6.11.1",
+    "@aws-amplify/ui": "6.10.3",
+    "@aws-amplify/ui-react": "6.11.2",
     "@aws-sdk/client-rekognitionstreaming": "3.621.0",
     "@aws-sdk/util-format-url": "3.609.0",
     "@smithy/eventstream-serde-browser": "^2.0.4",