@aws-amplify/ui-react-liveness 3.0.23 → 3.1.0

package/dist/esm/components/FaceLivenessDetector/service/machine/machine.mjs

@@ -884,14 +884,15 @@ const livenessMachine = createMachine({
         // eslint-disable-next-line @typescript-eslint/require-await
         async openLivenessStreamConnection(context) {
             const { config } = context.componentProps;
-            const { credentialProvider, endpointOverride } = config;
+            const { credentialProvider, endpointOverride, systemClockOffset } = config;
             const livenessStreamProvider = new LivenessStreamProvider({
                 sessionId: context.componentProps.sessionId,
                 region: context.componentProps.region,
+                systemClockOffset,
                 stream: context.videoAssociatedParams.videoMediaStream,
                 videoEl: context.videoAssociatedParams.videoEl,
-                credentialProvider: credentialProvider,
-                endpointOverride: endpointOverride,
+                credentialProvider,
+                endpointOverride,
             });
             responseStream = livenessStreamProvider.getResponseStream();
             return { livenessStreamProvider };

package/dist/esm/components/FaceLivenessDetector/service/utils/createStreamingClient/CustomWebSocketFetchHandler.mjs

@@ -56,10 +56,12 @@ class CustomWebSocketFetchHandler {
         this.utf8decoder = new TextDecoder(); // default 'utf-8' or 'utf8'
         this.httpHandler = httpHandler;
         if (typeof options === 'function') {
-            this.configPromise = options().then((opts) => opts ?? {});
+            this.config = {};
+            this.configPromise = options().then((opts) => (this.config = opts ?? {}));
         }
         else {
-            this.configPromise = Promise.resolve(options ?? {});
+            this.config = options ?? {};
+            this.configPromise = Promise.resolve(this.config);
         }
     }
     /**
@@ -99,11 +101,23 @@ class CustomWebSocketFetchHandler {
             }),
         };
     }
+    updateHttpClientConfig(key, value) {
+        this.configPromise = this.configPromise.then((config) => {
+            return {
+                ...config,
+                [key]: value,
+            };
+        });
+    }
+    httpHandlerConfigs() {
+        return this.config ?? {};
+    }
     /**
      * Removes all closing/closed sockets from the socket pool for URL.
      */
     removeNotUsableSockets(url) {
-        this.sockets[url] = (this.sockets[url] ?? []).filter((socket) => ![WebSocket.CLOSING, WebSocket.CLOSED].includes(socket.readyState));
+        this.sockets[url] = (this.sockets[url] ?? []).filter((socket) => !(socket.readyState === WebSocket.CLOSING ||
+            socket.readyState === WebSocket.CLOSED));
     }
     waitForReady(socket, connectionTimeout) {
         return new Promise((resolve, reject) => {
@@ -147,7 +161,7 @@ class CustomWebSocketFetchHandler {
             else {
                 resolve({
                     done: true,
-                    value: undefined, // unchecked because done=true.
+                    value: undefined,
                 });
             }
         };
@@ -181,7 +195,9 @@ class CustomWebSocketFetchHandler {
                 // would already be settled by the time sending chunk throws error.
                 // Instead, the notify the output stream to throw if there's
                 // exceptions
-                streamError = err;
+                if (err instanceof Error) {
+                    streamError = err;
+                }
             }
             finally {
                 // WS status code: https://tools.ietf.org/html/rfc6455#section-7.4

package/dist/esm/components/FaceLivenessDetector/service/utils/createStreamingClient/createStreamingClient.mjs

@@ -7,7 +7,7 @@ import { Signer } from './Signer.mjs';
 
 const CONNECTION_TIMEOUT = 10000;
 const CUSTOM_USER_AGENT = `${getAmplifyUserAgent()} ${getLivenessUserAgent()}`;
-async function createStreamingClient({ credentialsProvider, endpointOverride, region, }) {
+async function createStreamingClient({ credentialsProvider, endpointOverride, region, systemClockOffset, }) {
     const credentials = await resolveCredentials(credentialsProvider);
     const clientconfig = {
         credentials,
@@ -17,6 +17,7 @@ async function createStreamingClient({ credentialsProvider, endpointOverride, re
             connectionTimeout: CONNECTION_TIMEOUT,
         }),
         signerConstructor: Signer,
+        systemClockOffset,
     };
     if (endpointOverride) {
         clientconfig.endpointProvider = () => ({ url: new URL(endpointOverride) });

package/dist/esm/components/FaceLivenessDetector/service/utils/streamProvider.mjs

@@ -13,7 +13,7 @@ function isEndStreamWithCodeEvent(obj) {
     return obj.code !== undefined;
 }
 class LivenessStreamProvider {
-    constructor({ sessionId, region, stream, videoEl, credentialProvider, endpointOverride, }) {
+    constructor({ sessionId, region, stream, videoEl, credentialProvider, endpointOverride, systemClockOffset, }) {
         this.sessionId = sessionId;
         this.region = region;
         this._stream = stream;
@@ -21,6 +21,7 @@ class LivenessStreamProvider {
         this.videoRecorder = new VideoRecorder(stream);
         this.credentialProvider = credentialProvider;
         this.endpointOverride = endpointOverride;
+        this.systemClockOffset = systemClockOffset;
         this.initPromise = this.init();
     }
     async getResponseStream() {
@@ -51,6 +52,7 @@ class LivenessStreamProvider {
             credentialsProvider: this.credentialProvider,
             endpointOverride: this.endpointOverride,
             region: this.region,
+            systemClockOffset: this.systemClockOffset,
         });
         this.responseStream = await this.startLivenessVideoConnection();
     }

package/dist/esm/components/FaceLivenessDetector/utils/getDisplayText.mjs

@@ -1,5 +1,27 @@
 import { defaultLivenessDisplayText } from '../displayText.mjs';
 
+function getMergedDisplayText(overrideDisplayText) {
+    const mergeField = (correctKey, deprecatedKey) => {
+        if (overrideDisplayText[correctKey] &&
+            overrideDisplayText[correctKey] !== defaultLivenessDisplayText[correctKey]) {
+            return overrideDisplayText[correctKey];
+        }
+        else if (overrideDisplayText[deprecatedKey] &&
+            overrideDisplayText[deprecatedKey] !==
+                defaultLivenessDisplayText[correctKey]) {
+            return overrideDisplayText[deprecatedKey];
+        }
+        else {
+            return defaultLivenessDisplayText[correctKey];
+        }
+    };
+    return {
+        photosensitivityWarningBodyText: mergeField('photosensitivityWarningBodyText', 'photosensitivyWarningBodyText'),
+        photosensitivityWarningHeadingText: mergeField('photosensitivityWarningHeadingText', 'photosensitivyWarningHeadingText'),
+        photosensitivityWarningInfoText: mergeField('photosensitivityWarningInfoText', 'photosensitivyWarningInfoText'),
+        photosensitivityWarningLabelText: mergeField('photosensitivityWarningLabelText', 'photosensitivyWarningLabelText'),
+    };
+}
 /**
  * Merges optional displayText prop with
  * defaultLivenessDisplayText and returns more bite size portions to pass
@@ -8,9 +30,11 @@ import { defaultLivenessDisplayText } from '../displayText.mjs';
  * @returns hintDisplayText, cameraDisplayText, instructionDisplayText, cancelLivenessCheckText
  */
 function getDisplayText(overrideDisplayText) {
+    const mergedDisplayText = getMergedDisplayText(overrideDisplayText ?? {});
     const displayText = {
         ...defaultLivenessDisplayText,
         ...overrideDisplayText,
+        ...mergedDisplayText,
     };
     const { a11yVideoLabelText, cameraMinSpecificationsHeadingText, cameraMinSpecificationsMessageText, cameraNotFoundHeadingText, cameraNotFoundMessageText, cancelLivenessCheckText, connectionTimeoutHeaderText, connectionTimeoutMessageText, clientHeaderText, clientMessageText, errorLabelText, hintCanNotIdentifyText, hintCenterFaceText, hintCenterFaceInstructionText, hintFaceOffCenterText, hintConnectingText, hintFaceDetectedText, hintHoldFaceForFreshnessText, hintIlluminationNormalText, hintIlluminationTooBrightText, hintIlluminationTooDarkText, hintMoveFaceFrontOfCameraText, hintTooManyFacesText, hintTooCloseText, hintTooFarText, hintVerifyingText, hintCheckCompleteText, hintMatchIndicatorText, faceDistanceHeaderText, faceDistanceMessageText, goodFitCaptionText, goodFitAltText, landscapeHeaderText, landscapeMessageText, multipleFacesHeaderText, multipleFacesMessageText, photosensitivityWarningBodyText, photosensitivityWarningHeadingText, photosensitivityWarningInfoText, photosensitivityWarningLabelText, photosensitivyWarningBodyText, photosensitivyWarningHeadingText, photosensitivyWarningInfoText, photosensitivyWarningLabelText, portraitMessageText, retryCameraPermissionsText, recordingIndicatorText, serverHeaderText, serverMessageText, startScreenBeginCheckText, timeoutHeaderText, timeoutMessageText, tooFarCaptionText, tooFarAltText, tryAgainText, waitingCameraPermissionText, } = displayText;
     const hintDisplayText = {

package/dist/esm/version.mjs

@@ -1,3 +1,3 @@
-const VERSION = '3.0.23';
+const VERSION = '3.1.0';
 
 export { VERSION };

package/dist/index.js

@@ -833,7 +833,7 @@ function getFaceMatchStateInLivenessOval({ face, ovalDetails, initialFaceInterse
     return { faceMatchState, faceMatchPercentage };
 }
 
-const VERSION = '3.0.23';
+const VERSION = '3.1.0';
 
 const BASE_USER_AGENT = `ui-react-liveness/${VERSION}`;
 const getLivenessUserAgent = () => {
@@ -892,10 +892,12 @@ class CustomWebSocketFetchHandler {
         this.utf8decoder = new TextDecoder(); // default 'utf-8' or 'utf8'
         this.httpHandler = httpHandler;
         if (typeof options === 'function') {
-            this.configPromise = options().then((opts) => opts ?? {});
+            this.config = {};
+            this.configPromise = options().then((opts) => (this.config = opts ?? {}));
         }
         else {
-            this.configPromise = Promise.resolve(options ?? {});
+            this.config = options ?? {};
+            this.configPromise = Promise.resolve(this.config);
         }
     }
     /**
@@ -935,11 +937,23 @@ class CustomWebSocketFetchHandler {
             }),
         };
     }
+    updateHttpClientConfig(key, value) {
+        this.configPromise = this.configPromise.then((config) => {
+            return {
+                ...config,
+                [key]: value,
+            };
+        });
+    }
+    httpHandlerConfigs() {
+        return this.config ?? {};
+    }
     /**
      * Removes all closing/closed sockets from the socket pool for URL.
      */
     removeNotUsableSockets(url) {
-        this.sockets[url] = (this.sockets[url] ?? []).filter((socket) => ![WebSocket.CLOSING, WebSocket.CLOSED].includes(socket.readyState));
+        this.sockets[url] = (this.sockets[url] ?? []).filter((socket) => !(socket.readyState === WebSocket.CLOSING ||
+            socket.readyState === WebSocket.CLOSED));
     }
     waitForReady(socket, connectionTimeout) {
         return new Promise((resolve, reject) => {
@@ -983,7 +997,7 @@ class CustomWebSocketFetchHandler {
             else {
                 resolve({
                     done: true,
-                    value: undefined, // unchecked because done=true.
+                    value: undefined,
                 });
             }
         };
@@ -1017,7 +1031,9 @@ class CustomWebSocketFetchHandler {
                 // would already be settled by the time sending chunk throws error.
                 // Instead, the notify the output stream to throw if there's
                 // exceptions
-                streamError = err;
+                if (err instanceof Error) {
+                    streamError = err;
+                }
             }
             finally {
                 // WS status code: https://tools.ietf.org/html/rfc6455#section-7.4
@@ -1081,7 +1097,7 @@ class Signer extends signatureV4.SignatureV4 {
 
 const CONNECTION_TIMEOUT = 10000;
 const CUSTOM_USER_AGENT = `${utils.getAmplifyUserAgent()} ${getLivenessUserAgent()}`;
-async function createStreamingClient({ credentialsProvider, endpointOverride, region, }) {
+async function createStreamingClient({ credentialsProvider, endpointOverride, region, systemClockOffset, }) {
     const credentials = await resolveCredentials(credentialsProvider);
     const clientconfig = {
         credentials,
@@ -1091,6 +1107,7 @@ async function createStreamingClient({ credentialsProvider, endpointOverride, re
             connectionTimeout: CONNECTION_TIMEOUT,
         }),
         signerConstructor: Signer,
+        systemClockOffset,
     };
     if (endpointOverride) {
         clientconfig.endpointProvider = () => ({ url: new URL(endpointOverride) });
@@ -1109,7 +1126,7 @@ function isEndStreamWithCodeEvent(obj) {
     return obj.code !== undefined;
 }
 class LivenessStreamProvider {
-    constructor({ sessionId, region, stream, videoEl, credentialProvider, endpointOverride, }) {
+    constructor({ sessionId, region, stream, videoEl, credentialProvider, endpointOverride, systemClockOffset, }) {
         this.sessionId = sessionId;
         this.region = region;
         this._stream = stream;
@@ -1117,6 +1134,7 @@ class LivenessStreamProvider {
         this.videoRecorder = new VideoRecorder(stream);
         this.credentialProvider = credentialProvider;
         this.endpointOverride = endpointOverride;
+        this.systemClockOffset = systemClockOffset;
         this.initPromise = this.init();
     }
     async getResponseStream() {
@@ -1147,6 +1165,7 @@ class LivenessStreamProvider {
             credentialsProvider: this.credentialProvider,
             endpointOverride: this.endpointOverride,
             region: this.region,
+            systemClockOffset: this.systemClockOffset,
         });
         this.responseStream = await this.startLivenessVideoConnection();
     }
@@ -2263,14 +2282,15 @@ const livenessMachine = xstate.createMachine({
         // eslint-disable-next-line @typescript-eslint/require-await
         async openLivenessStreamConnection(context) {
             const { config } = context.componentProps;
-            const { credentialProvider, endpointOverride } = config;
+            const { credentialProvider, endpointOverride, systemClockOffset } = config;
             const livenessStreamProvider = new LivenessStreamProvider({
                 sessionId: context.componentProps.sessionId,
                 region: context.componentProps.region,
+                systemClockOffset,
                 stream: context.videoAssociatedParams.videoMediaStream,
                 videoEl: context.videoAssociatedParams.videoEl,
-                credentialProvider: credentialProvider,
-                endpointOverride: endpointOverride,
+                credentialProvider,
+                endpointOverride,
             });
             responseStream = livenessStreamProvider.getResponseStream();
             return { livenessStreamProvider };
@@ -3238,6 +3258,28 @@ const LivenessCheck = ({ instructionDisplayText, hintDisplayText, cameraDisplayT
     return (React__namespace.createElement(uiReact.Flex, { direction: "column", position: "relative", testId: CHECK_CLASS_NAME, className: CHECK_CLASS_NAME, gap: "xl" }, renderCheck()));
 };
 
+function getMergedDisplayText(overrideDisplayText) {
+    const mergeField = (correctKey, deprecatedKey) => {
+        if (overrideDisplayText[correctKey] &&
+            overrideDisplayText[correctKey] !== defaultLivenessDisplayText[correctKey]) {
+            return overrideDisplayText[correctKey];
+        }
+        else if (overrideDisplayText[deprecatedKey] &&
+            overrideDisplayText[deprecatedKey] !==
+                defaultLivenessDisplayText[correctKey]) {
+            return overrideDisplayText[deprecatedKey];
+        }
+        else {
+            return defaultLivenessDisplayText[correctKey];
+        }
+    };
+    return {
+        photosensitivityWarningBodyText: mergeField('photosensitivityWarningBodyText', 'photosensitivyWarningBodyText'),
+        photosensitivityWarningHeadingText: mergeField('photosensitivityWarningHeadingText', 'photosensitivyWarningHeadingText'),
+        photosensitivityWarningInfoText: mergeField('photosensitivityWarningInfoText', 'photosensitivyWarningInfoText'),
+        photosensitivityWarningLabelText: mergeField('photosensitivityWarningLabelText', 'photosensitivyWarningLabelText'),
+    };
+}
 /**
  * Merges optional displayText prop with
  * defaultLivenessDisplayText and returns more bite size portions to pass
@@ -3246,9 +3288,11 @@ const LivenessCheck = ({ instructionDisplayText, hintDisplayText, cameraDisplayT
  * @returns hintDisplayText, cameraDisplayText, instructionDisplayText, cancelLivenessCheckText
  */
 function getDisplayText(overrideDisplayText) {
+    const mergedDisplayText = getMergedDisplayText(overrideDisplayText ?? {});
     const displayText = {
         ...defaultLivenessDisplayText,
         ...overrideDisplayText,
+        ...mergedDisplayText,
     };
     const { a11yVideoLabelText, cameraMinSpecificationsHeadingText, cameraMinSpecificationsMessageText, cameraNotFoundHeadingText, cameraNotFoundMessageText, cancelLivenessCheckText, connectionTimeoutHeaderText, connectionTimeoutMessageText, clientHeaderText, clientMessageText, errorLabelText, hintCanNotIdentifyText, hintCenterFaceText, hintCenterFaceInstructionText, hintFaceOffCenterText, hintConnectingText, hintFaceDetectedText, hintHoldFaceForFreshnessText, hintIlluminationNormalText, hintIlluminationTooBrightText, hintIlluminationTooDarkText, hintMoveFaceFrontOfCameraText, hintTooManyFacesText, hintTooCloseText, hintTooFarText, hintVerifyingText, hintCheckCompleteText, hintMatchIndicatorText, faceDistanceHeaderText, faceDistanceMessageText, goodFitCaptionText, goodFitAltText, landscapeHeaderText, landscapeMessageText, multipleFacesHeaderText, multipleFacesMessageText, photosensitivityWarningBodyText, photosensitivityWarningHeadingText, photosensitivityWarningInfoText, photosensitivityWarningLabelText, photosensitivyWarningBodyText, photosensitivyWarningHeadingText, photosensitivyWarningInfoText, photosensitivyWarningLabelText, portraitMessageText, retryCameraPermissionsText, recordingIndicatorText, serverHeaderText, serverMessageText, startScreenBeginCheckText, timeoutHeaderText, timeoutMessageText, tooFarCaptionText, tooFarAltText, tryAgainText, waitingCameraPermissionText, } = displayText;
     const hintDisplayText = {

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

@@ -63,8 +63,13 @@ export interface FaceLivenessDetectorCoreConfig {
      * Internal use only - parameter for overriding the liveness endpoint
      */
     endpointOverride?: string;
+    /**
+     * Optional parameter for overriding the systemClockOffset for the streaming client
+     * Represents the difference between the system clock and the AWS server clock in milliseconds
+     */
+    systemClockOffset?: number;
 }
-export type FaceLivenessDetectorConfig = Omit<FaceLivenessDetectorCoreConfig, 'credentialProvider' | 'endpointOverride'>;
+export type FaceLivenessDetectorConfig = Omit<FaceLivenessDetectorCoreConfig, 'credentialProvider' | 'endpointOverride' | 'systemClockOffset'>;
 /**
  * The coordiates of any bounding box
  */

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

@@ -16,7 +16,8 @@ export interface WebSocketFetchHandlerOptions {
  */
 export declare class CustomWebSocketFetchHandler {
     readonly metadata: RequestHandlerMetadata;
-    private readonly configPromise;
+    private config;
+    private configPromise;
     private readonly httpHandler;
     private readonly sockets;
     private readonly utf8decoder;
@@ -29,6 +30,8 @@ export declare class CustomWebSocketFetchHandler {
     handle(request: HttpRequest): Promise<{
         response: HttpResponse;
     }>;
+    updateHttpClientConfig(key: keyof WebSocketFetchHandlerOptions, value: WebSocketFetchHandlerOptions[typeof key]): void;
+    httpHandlerConfigs(): WebSocketFetchHandlerOptions;
     /**
      * Removes all closing/closed sockets from the socket pool for URL.
      */

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

@@ -4,6 +4,7 @@ interface CreateClientConfig {
     credentialsProvider?: AwsCredentialProvider;
     endpointOverride?: string;
     region: string;
+    systemClockOffset?: number;
 }
-export declare function createStreamingClient({ credentialsProvider, endpointOverride, region, }: CreateClientConfig): Promise<RekognitionStreamingClient>;
+export declare function createStreamingClient({ credentialsProvider, endpointOverride, region, systemClockOffset, }: CreateClientConfig): Promise<RekognitionStreamingClient>;
 export {};

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

@@ -13,6 +13,7 @@ interface StreamProviderArgs extends StartLivenessStreamInput {
     videoEl: HTMLVideoElement;
     credentialProvider?: AwsCredentialProvider;
     endpointOverride?: string;
+    systemClockOffset?: number;
 }
 export declare class LivenessStreamProvider {
     sessionId: string;
@@ -21,12 +22,13 @@ export declare class LivenessStreamProvider {
     responseStream: AsyncIterable<LivenessResponseStream>;
     credentialProvider?: AwsCredentialProvider;
     endpointOverride?: string;
+    systemClockOffset?: number;
     private _reader;
     private videoEl;
     private _client;
     private _stream;
     private initPromise;
-    constructor({ sessionId, region, stream, videoEl, credentialProvider, endpointOverride, }: StreamProviderArgs);
+    constructor({ sessionId, region, stream, videoEl, credentialProvider, endpointOverride, systemClockOffset, }: StreamProviderArgs);
     getResponseStream(): Promise<AsyncIterable<LivenessResponseStream>>;
     startRecordingLivenessVideo(): void;
     sendClientInfo(clientInfo: ClientSessionInformationEvent): void;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "3.0.23";
+export declare const VERSION = "3.1.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/ui-react-liveness",
-  "version": "3.0.23",
+  "version": "3.1.0",
   "main": "dist/index.js",
   "module": "dist/esm/index.mjs",
   "exports": {
@@ -49,7 +49,7 @@
   "dependencies": {
     "@aws-amplify/ui": "6.0.16",
     "@aws-amplify/ui-react": "6.1.12",
-    "@aws-sdk/client-rekognitionstreaming": "3.398.0",
+    "@aws-sdk/client-rekognitionstreaming": "3.605.0",
     "@aws-sdk/util-format-url": "^3.410.0",
     "@smithy/eventstream-serde-browser": "^2.0.4",
     "@smithy/fetch-http-handler": "^2.1.3",
@@ -81,7 +81,7 @@
       "name": "FaceLivenessDetector",
       "path": "dist/esm/index.mjs",
       "import": "{ FaceLivenessDetector }",
-      "limit": "280 kB"
+      "limit": "287 kB"
     }
   ]
 }