chore(liveness): export error types (#4450)

* chore(liveness): export error types * Create thin-experts-destroy.md * fix unti tests * update error types * chore: switch to union type only * Update packages/react-liveness/src/components/FaceLivenessDetector/service/utils/liveness.ts Co-authored-by: Caleb Pollman <[email protected]> --------- Co-authored-by: Ioana Brooks <[email protected]> Co-authored-by: Caleb Pollman <[email protected]>
aws-amplify · Sep 19, 2023 · 8ca0450 · 8ca0450
1 parent 6a5a4d7
commit 8ca0450
Show file tree

Hide file tree

Showing 13 changed files with 40 additions and 33 deletions.
diff --git a/.changeset/thin-experts-destroy.md b/.changeset/thin-experts-destroy.md
@@ -0,0 +1,5 @@
+---
+"@aws-amplify/ui-react-liveness": patch
+---
+
+chore(liveness): export error types
diff --git a/packages/react-liveness/jest.config.js b/packages/react-liveness/jest.config.js
@@ -10,7 +10,7 @@ module.exports = {
   coverageThreshold: {
     global: {
       branches: 80,
-      functions: 83,
+      functions: 82,
       lines: 89,
       statements: 89,
     },

diff --git a/packages/react-liveness/src/components/FaceLivenessDetector/index.ts b/packages/react-liveness/src/components/FaceLivenessDetector/index.ts
@@ -10,4 +10,5 @@ export {
   AwsCredentialProvider,
   AwsTemporaryCredentials,
   AwsCredentials,
+  ErrorState,
 } from './service';
diff --git a/packages/react-liveness/src/components/FaceLivenessDetector/service/machine/index.ts b/packages/react-liveness/src/components/FaceLivenessDetector/service/machine/index.ts
@@ -19,6 +19,7 @@ import {
   IlluminationState,
   StreamActorCallback,
   LivenessError,
+  ErrorState,
 } from '../types';
 import {
   BlazeFaceFaceDetection,
@@ -717,7 +718,7 @@ export const livenessMachine = createMachine<LivenessContext, LivenessEvent>(
       // callbacks
       callUserPermissionDeniedCallback: assign({
         errorState: (context, event) => {
-          let errorState: LivenessErrorState;
+          let errorState: ErrorState;
 
           if ((event.data!.message as string).includes('15 fps')) {
             errorState = LivenessErrorState.CAMERA_FRAMERATE_ERROR;

diff --git a/packages/react-liveness/src/components/FaceLivenessDetector/service/types/error.ts b/packages/react-liveness/src/components/FaceLivenessDetector/service/types/error.ts
@@ -2,14 +2,16 @@
  * The liveness error states
  */
 
-export enum LivenessErrorState {
-  TIMEOUT = 'TIMEOUT',
-  RUNTIME_ERROR = 'RUNTIME_ERROR',
-  FRESHNESS_TIMEOUT = 'FRESHNESS_TIMEOUT',
-  SERVER_ERROR = 'SERVER_ERROR',
-  CAMERA_FRAMERATE_ERROR = 'CAMERA_FRAMERATE_ERROR',
-  CAMERA_ACCESS_ERROR = 'CAMERA_ACCESS_ERROR',
-  FACE_DISTANCE_ERROR = 'FACE_DISTANCE_ERROR',
-  MOBILE_LANDSCAPE_ERROR = 'MOBILE_LANDSCAPE_ERROR',
-  MULTIPLE_FACES_ERROR = 'MULTIPLE_FACES_ERROR',
-}
+export const LivenessErrorState = {
+  TIMEOUT: 'TIMEOUT',
+  RUNTIME_ERROR: 'RUNTIME_ERROR',
+  FRESHNESS_TIMEOUT: 'FRESHNESS_TIMEOUT',
+  SERVER_ERROR: 'SERVER_ERROR',
+  CAMERA_FRAMERATE_ERROR: 'CAMERA_FRAMERATE_ERROR',
+  CAMERA_ACCESS_ERROR: 'CAMERA_ACCESS_ERROR',
+  FACE_DISTANCE_ERROR: 'FACE_DISTANCE_ERROR',
+  MOBILE_LANDSCAPE_ERROR: 'MOBILE_LANDSCAPE_ERROR',
+  MULTIPLE_FACES_ERROR: 'MULTIPLE_FACES_ERROR',
+} as const;
+
+export type ErrorState = keyof typeof LivenessErrorState;
diff --git a/packages/react-liveness/src/components/FaceLivenessDetector/service/types/liveness.ts b/packages/react-liveness/src/components/FaceLivenessDetector/service/types/liveness.ts
@@ -1,5 +1,5 @@
 import { AwsCredentialProvider } from './credentials';
-import { LivenessErrorState } from './error';
+import { ErrorState } from './error';
 
 /**
  * The props for the FaceLivenessDetectorCore which allows for full configuration of auth
@@ -124,6 +124,6 @@ export enum FaceMatchState {
 }
 
 export interface LivenessError {
-  state: LivenessErrorState;
+  state: ErrorState;
   error: Error;
 }
diff --git a/packages/react-liveness/src/components/FaceLivenessDetector/service/types/machine.ts b/packages/react-liveness/src/components/FaceLivenessDetector/service/types/machine.ts
@@ -13,7 +13,7 @@ import {
   LivenessOvalDetails,
   IlluminationState,
 } from './liveness';
-import { LivenessErrorState } from './error';
+import { ErrorState } from './error';
 import {
   VideoRecorder,
   LivenessStreamProvider,
@@ -67,7 +67,7 @@ export interface HydratedLivenessContext {
   ovalAssociatedParams: OvalAssociatedParams;
   faceMatchAssociatedParams: FaceMatchAssociatedParams;
   freshnessColorAssociatedParams: FreshnessColorAssociatedParams;
-  errorState: LivenessErrorState;
+  errorState: ErrorState;
   livenessStreamProvider: LivenessStreamProvider;
   responseStreamActorRef: ActorRef<any>;
   shouldDisconnect: boolean;

diff --git a/packages/react-liveness/src/components/FaceLivenessDetector/service/utils/liveness.ts b/packages/react-liveness/src/components/FaceLivenessDetector/service/utils/liveness.ts
@@ -6,6 +6,7 @@ import {
   FaceMatchState,
   BoundingBox,
   LivenessErrorState,
+  ErrorState,
 } from '../types';
 import { FaceDetection } from '../types/faceDetection';
 import { ClientFreshnessColorSequence } from '../types/service';
@@ -459,7 +460,7 @@ export function isCameraDeviceVirtual(device: MediaDeviceInfo): boolean {
   return device.label.toLowerCase().includes('virtual');
 }
 
-export const LivenessErrorStateStringMap: Record<LivenessErrorState, string> = {
+export const LivenessErrorStateStringMap = {
   [LivenessErrorState.RUNTIME_ERROR]: 'RUNTIME_ERROR',
   [LivenessErrorState.SERVER_ERROR]: 'SERVER_ERROR',
   [LivenessErrorState.TIMEOUT]: 'TIMEOUT',
@@ -741,18 +742,13 @@ export async function isFaceDistanceBelowThreshold({
   isMobile?: boolean;
 }): Promise<{
   isDistanceBelowThreshold: boolean;
-  error?:
-    | LivenessErrorState.FACE_DISTANCE_ERROR
-    | LivenessErrorState.MULTIPLE_FACES_ERROR;
+  error?: ErrorState;
 }> {
   const detectedFaces = await faceDetector.detectFaces(videoEl);
   let detectedFace: Face;
 
   let isDistanceBelowThreshold = false;
-  let error:
-    | LivenessErrorState.FACE_DISTANCE_ERROR
-    | LivenessErrorState.MULTIPLE_FACES_ERROR
-    | undefined;
+  let error: ErrorState | undefined;
 
   switch (detectedFaces.length) {
     case 0: {

diff --git a/...ages/react-liveness/src/components/FaceLivenessDetector/shared/FaceLivenessErrorModal.tsx b/...ages/react-liveness/src/components/FaceLivenessDetector/shared/FaceLivenessErrorModal.tsx
@@ -3,7 +3,7 @@ import React from 'react';
 import { Flex, Button, Text } from '@aws-amplify/ui-react';
 import { AlertIcon } from '@aws-amplify/ui-react/internal';
 
-import { LivenessErrorState } from '../service';
+import { LivenessErrorState, ErrorState } from '../service';
 
 import { Toast } from './Toast';
 import { Overlay } from './Overlay';
@@ -21,7 +21,7 @@ export interface FaceLivenessErrorModalProps {
 }
 
 const renderToastErrorModal = (props: {
-  error: LivenessErrorState;
+  error: ErrorState;
   displayText: Required<ErrorDisplayText>;
 }) => {
   const { error: errorState, displayText } = props;
@@ -80,7 +80,7 @@ export const renderErrorModal = ({
   errorState,
   overrideErrorDisplayText,
 }: {
-  errorState: LivenessErrorState;
+  errorState: ErrorState;
   overrideErrorDisplayText?: ErrorDisplayText;
 }): JSX.Element | null => {
   const displayText: Required<ErrorDisplayText> = {

diff --git a/...ness/src/components/FaceLivenessDetector/shared/__tests__/FaceLivenessErrorModal.test.tsx b/...ness/src/components/FaceLivenessDetector/shared/__tests__/FaceLivenessErrorModal.test.tsx
@@ -1,7 +1,7 @@
 import * as React from 'react';
 import { render, screen } from '@testing-library/react';
 
-import { LivenessErrorState } from '../../service';
+import { LivenessErrorState, ErrorState } from '../../service';
 import {
   FaceLivenessErrorModal,
   renderErrorModal,
@@ -60,7 +60,7 @@ describe('FaceLivenessErrorModal', () => {
     render(
       <FaceLivenessErrorModal onRetry={() => {}}>
         {renderErrorModal({
-          errorState: errorState as unknown as LivenessErrorState,
+          errorState: errorState as unknown as ErrorState,
         })}
       </FaceLivenessErrorModal>
     );

diff --git a/packages/react-liveness/src/components/FaceLivenessDetector/shared/__tests__/Hint.test.tsx b/packages/react-liveness/src/components/FaceLivenessDetector/shared/__tests__/Hint.test.tsx
@@ -6,6 +6,7 @@ import {
   IlluminationState,
   FaceMatchState,
   LivenessErrorState,
+  ErrorState,
 } from '../../service';
 
 import {
@@ -33,7 +34,7 @@ describe('Hint', () => {
   };
   const mockActorSend = jest.fn();
 
-  let errorState: LivenessErrorState | null = null;
+  let errorState: ErrorState | null = null;
   let faceMatchState: FaceMatchState | null = null;
   let illuminationState: IlluminationState | null = null;
   let faceMatchStateBeforeStart: FaceMatchState | null = null;

diff --git a/...iveness/src/components/FaceLivenessDetector/shared/__tests__/LandscapeErrorModal.test.tsx b/...iveness/src/components/FaceLivenessDetector/shared/__tests__/LandscapeErrorModal.test.tsx
@@ -1,7 +1,7 @@
 import * as React from 'react';
 import { render, screen } from '@testing-library/react';
 
-import { LivenessErrorState } from '../../service';
+import { ErrorState, LivenessErrorState } from '../../service';
 import {
   FaceLivenessErrorModal,
   renderErrorModal,
@@ -60,7 +60,7 @@ describe('FaceLivenessErrorModal', () => {
     render(
       <FaceLivenessErrorModal onRetry={() => {}}>
         {renderErrorModal({
-          errorState: errorState as unknown as LivenessErrorState,
+          errorState: errorState as unknown as ErrorState,
         })}
       </FaceLivenessErrorModal>
     );

diff --git a/packages/react-liveness/src/index.ts b/packages/react-liveness/src/index.ts
@@ -6,4 +6,5 @@ export {
   AwsCredentialProvider,
   AwsCredentials,
   AwsTemporaryCredentials,
+  ErrorState,
 } from './components';