santoid-sdk 7.0.0 → 9.0.0

package/browser/liveness-capture.js.LICENSE.txt

@@ -0,0 +1,350 @@
+/*!
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2016 Christian Speckner <cnspeckn@googlemail.com>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+/*! *****************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+/*! crc32.js (C) 2014-present SheetJS -- http://sheetjs.com */
+
+/**
+ * @license
+ * Copyright 2017 Google LLC. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * =============================================================================
+ */
+
+/**
+ * @license
+ * Copyright 2018 Google LLC. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * =============================================================================
+ */
+
+/**
+ * @license
+ * Copyright 2019 Google LLC. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * =============================================================================
+ */
+
+/**
+ * @license
+ * Copyright 2019 Google LLC. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the 'License');
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an 'AS IS' BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * =============================================================================
+ */
+
+/**
+ * @license
+ * Copyright 2020 Google Inc. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * =============================================================================
+ */
+
+/**
+ * @license
+ * Copyright 2020 Google LLC. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * =============================================================================
+ */
+
+/**
+ * @license
+ * Copyright 2020 Google LLC. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an AS IS BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * =============================================================================
+ */
+
+/**
+ * @license
+ * Copyright 2021 Google LLC. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * =============================================================================
+ */
+
+/**
+ * @license
+ * Copyright 2021 Google LLC. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * =============================================================================
+ */
+
+/**
+ * @license
+ * Copyright 2022 Google LLC.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * =============================================================================
+ */
+
+/**
+ * @license
+ * Copyright 2022 Google LLC. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * =============================================================================
+ */
+
+/**
+ * @license
+ * Copyright 2022 Google LLC. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the 'License');
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an 'AS IS' BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * =============================================================================
+ */
+
+/**
+ * @license
+ * Copyright 2023 Google LLC.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * =============================================================================
+ */
+
+/**
+ * @license
+ * Copyright 2023 Google LLC. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * =============================================================================
+ */
+
+/**
+ * @license React
+ * react-dom-client.production.js
+ *
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * @license React
+ * react-dom.production.js
+ *
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * @license React
+ * react-jsx-runtime.production.js
+ *
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * @license React
+ * react.production.js
+ *
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * @license React
+ * scheduler.production.js
+ *
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * @license React
+ * use-sync-external-store-shim.production.js
+ *
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * @license React
+ * use-sync-external-store-shim/with-selector.production.js
+ *
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/** @license See the LICENSE file. */

package/client/age/index.d.ts

@@ -0,0 +1,18 @@
+import { type IBaseSDKOptions } from '../../utils/types';
+export type { IAgeEstimate, IAgeRange } from '../../api/ApiLivenessSessionService';
+export type TEstimateAgeOptions = Omit<IBaseSDKOptions, 'track' | 'token'> & {
+    /** Token do usuario. Opcional quando apiKey for informada. */
+    token?: string;
+    track?: string;
+    customerRequestId?: string;
+    /** Sessao de prova de vida concluida e aprovada. */
+    sessionId: string;
+};
+/**
+ * Estima a idade a partir da foto de uma prova de vida aprovada.
+ *
+ * Nao ha upload: a idade sai da foto capturada na propria sessao, entao quem
+ * responde e' a pessoa que passou pela camera. Sessao nao concluida responde
+ * 409; reprovada ou sem um unico rosto, 422.
+ */
+export declare function estimateAge({ sessionId, customerRequestId, ...options }: TEstimateAgeOptions): Promise<import("../../api/ApiLivenessSessionService").IAgeEstimate>;

package/client/age/index.js

@@ -0,0 +1,40 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.estimateAge = void 0;
+const ApiLivenessSessionService_1 = require("../../api/ApiLivenessSessionService");
+const error_1 = require("../../utils/error");
+const index_1 = require("../liveness/utils/index");
+/**
+ * Estima a idade a partir da foto de uma prova de vida aprovada.
+ *
+ * Nao ha upload: a idade sai da foto capturada na propria sessao, entao quem
+ * responde e' a pessoa que passou pela camera. Sessao nao concluida responde
+ * 409; reprovada ou sem um unico rosto, 422.
+ */
+async function estimateAge(_a) {
+    var { sessionId, customerRequestId } = _a, options = __rest(_a, ["sessionId", "customerRequestId"]);
+    try {
+        const service = new ApiLivenessSessionService_1.ApiLivenessSessionService(options, { FormDataClass: FormData, tryDecodeJwt: index_1.tryDecodeJwt });
+        return await service.estimateAge(sessionId, customerRequestId);
+    }
+    catch (err) {
+        throw new error_1.SDKError({
+            message: 'Error while estimating age',
+            code: error_1.EDefaultErrorCodes.INTERNAL_ERROR,
+            fatal: false,
+            details: err,
+        });
+    }
+}
+exports.estimateAge = estimateAge;

package/client/index.d.ts

@@ -1,13 +1,15 @@
-import { livenessDetection } from './liveness/methods/livenessDetection';
 import { livenessSession } from './liveness/methods/livenessSession';
+import { isLivenessApproved } from './liveness/methods/livenessSession/isLivenessApproved';
+import { estimateAge } from './age';
 import { uploadIdentificationDocument } from './liveness/methods/uploadIdentificationDocument';
 import { insertUploadIdentificationDocument } from './embedded/methods/insertUploadIdentificationDocument';
 import { typification } from './core/methods/typification';
 import { faceMatch } from './core/methods/faceMatch';
 import { ocr } from './core/methods/ocr';
 export default class SantoiDSDK {
-    static readonly livenessDetection: typeof livenessDetection;
     static readonly livenessSession: typeof livenessSession;
+    static readonly isLivenessApproved: typeof isLivenessApproved;
+    static readonly estimateAge: typeof estimateAge;
     static readonly uploadIdentificationDocument: typeof uploadIdentificationDocument;
     static readonly insertUploadIdentificationDocument: typeof insertUploadIdentificationDocument;
     static readonly typification: typeof typification;

package/client/index.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const livenessDetection_1 = require("./liveness/methods/livenessDetection");
 const livenessSession_1 = require("./liveness/methods/livenessSession");
+const isLivenessApproved_1 = require("./liveness/methods/livenessSession/isLivenessApproved");
+const age_1 = require("./age");
 const uploadIdentificationDocument_1 = require("./liveness/methods/uploadIdentificationDocument");
 const insertUploadIdentificationDocument_1 = require("./embedded/methods/insertUploadIdentificationDocument");
 const typification_1 = require("./core/methods/typification");
@@ -9,8 +10,9 @@ const faceMatch_1 = require("./core/methods/faceMatch");
 const ocr_1 = require("./core/methods/ocr");
 class SantoiDSDK {
 }
-SantoiDSDK.livenessDetection = livenessDetection_1.livenessDetection;
 SantoiDSDK.livenessSession = livenessSession_1.livenessSession;
+SantoiDSDK.isLivenessApproved = isLivenessApproved_1.isLivenessApproved;
+SantoiDSDK.estimateAge = age_1.estimateAge;
 SantoiDSDK.uploadIdentificationDocument = uploadIdentificationDocument_1.uploadIdentificationDocument;
 SantoiDSDK.insertUploadIdentificationDocument = insertUploadIdentificationDocument_1.insertUploadIdentificationDocument;
 SantoiDSDK.typification = typification_1.typification;

package/client/liveness/index.d.ts

@@ -1,4 +1,4 @@
-import { livenessDetection } from './methods/livenessDetection';
 import { livenessSession } from './methods/livenessSession';
+import { isLivenessApproved } from './methods/livenessSession/isLivenessApproved';
 import { uploadIdentificationDocument } from './methods/uploadIdentificationDocument';
-export { livenessDetection, livenessSession, uploadIdentificationDocument, };
+export { livenessSession, isLivenessApproved, uploadIdentificationDocument, };

package/client/liveness/index.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.uploadIdentificationDocument = exports.livenessSession = exports.livenessDetection = void 0;
-const livenessDetection_1 = require("./methods/livenessDetection");
-Object.defineProperty(exports, "livenessDetection", { enumerable: true, get: function () { return livenessDetection_1.livenessDetection; } });
+exports.uploadIdentificationDocument = exports.isLivenessApproved = exports.livenessSession = void 0;
 const livenessSession_1 = require("./methods/livenessSession");
 Object.defineProperty(exports, "livenessSession", { enumerable: true, get: function () { return livenessSession_1.livenessSession; } });
+const isLivenessApproved_1 = require("./methods/livenessSession/isLivenessApproved");
+Object.defineProperty(exports, "isLivenessApproved", { enumerable: true, get: function () { return isLivenessApproved_1.isLivenessApproved; } });
 const uploadIdentificationDocument_1 = require("./methods/uploadIdentificationDocument");
 Object.defineProperty(exports, "uploadIdentificationDocument", { enumerable: true, get: function () { return uploadIdentificationDocument_1.uploadIdentificationDocument; } });

package/client/liveness/methods/livenessSession/Service.d.ts

@@ -1,7 +1,9 @@
-import { ApiLivenessSessionService, type ILivenessSessionResult } from '../../../../api/ApiLivenessSessionService';
+import { ApiLivenessSessionService, type ILivenessSession, type ILivenessSessionResult } from '../../../../api/ApiLivenessSessionService';
 import { type IBaseSDKOptions } from '../../../../utils/types';
 import { SDKError } from '../../../../utils/error';
-export type TLivenessSessionOptions = Omit<IBaseSDKOptions, 'track'> & {
+export type TLivenessSessionOptions = Omit<IBaseSDKOptions, 'track' | 'token'> & {
+    /** Token do usuario. Opcional quando apiKey for informada. */
+    token?: string;
     track?: string;
     customerRequestId?: string;
     onSessionCreated?: (sessionId: string) => void | Promise<void>;
@@ -11,9 +13,14 @@ export type TLivenessSessionOptions = Omit<IBaseSDKOptions, 'track'> & {
 export declare class LivenessSessionService {
     options: TLivenessSessionOptions;
     service: ApiLivenessSessionService;
-    sessionId: string | null;
+    session: ILivenessSession | null;
+    get sessionId(): string | null;
     constructor(options: TLivenessSessionOptions);
     createSession(): Promise<string>;
     getResults(sessionId?: string | null): Promise<ILivenessSessionResult>;
+    getSessionConfig(): {
+        region: string;
+        identityPoolId: string;
+    } | null;
     private fail;
 }

package/client/liveness/methods/livenessSession/Service.js

@@ -7,8 +7,12 @@ const utils_1 = require("../../../../utils");
 const constants_1 = require("../../../../utils/constants");
 const index_1 = require("../../utils/index");
 class LivenessSessionService {
+    get sessionId() {
+        var _a, _b;
+        return (_b = (_a = this.session) === null || _a === void 0 ? void 0 : _a.SessionId) !== null && _b !== void 0 ? _b : null;
+    }
     constructor(options) {
-        this.sessionId = null;
+        this.session = null;
         this.options = options;
         this.service = new ApiLivenessSessionService_1.ApiLivenessSessionService(options, { FormDataClass: FormData, tryDecodeJwt: index_1.tryDecodeJwt });
     }
@@ -16,7 +20,7 @@ class LivenessSessionService {
         var _a, _b;
         try {
             const session = await this.service.createSession(this.options.customerRequestId);
-            this.sessionId = session.SessionId;
+            this.session = session;
             await ((_b = (_a = this.options).onSessionCreated) === null || _b === void 0 ? void 0 : _b.call(_a, session.SessionId));
             return session.SessionId;
         }
@@ -24,10 +28,9 @@ class LivenessSessionService {
             throw await this.fail('Error while creating liveness session', err);
         }
     }
-    // A AWS avisa que terminou de transmitir os frames antes do Rekognition
-    // terminar de avaliar, entao o resultado fica CREATED/IN_PROGRESS por alguns
-    // instantes. Sem este polling o chamador recebe um status que ainda nao e'
-    // o final.
+    // A captura termina antes da analise, entao o resultado fica
+    // CREATED/IN_PROGRESS por alguns instantes. Sem este polling o chamador
+    // recebe um status que ainda nao e' o final.
     async getResults(sessionId = this.sessionId) {
         var _a, _b;
         if (!sessionId) {
@@ -48,6 +51,11 @@ class LivenessSessionService {
             throw await this.fail('Error while fetching liveness session results', err);
         }
     }
+    getSessionConfig() {
+        if (!this.session)
+            return null;
+        return { region: this.session.Region, identityPoolId: this.session.IdentityPoolId };
+    }
     async fail(message, cause) {
         var _a, _b;
         const error = new error_1.SDKError({

package/client/liveness/methods/livenessSession/index.d.ts

@@ -1,20 +1,24 @@
 import { type TLivenessSessionOptions } from './Service';
 export type { TLivenessSessionOptions };
 /**
- * Prova de vida v2, sobre o AWS Rekognition Face Liveness.
+ * Prova de vida: ciclo da sessao.
  *
- * Cobre o ciclo de sessao: cria a sessao e busca o resultado, com o polling
- * necessario enquanto o Rekognition ainda avalia. A captura em si - camera,
- * oval e desafio - fica a cargo do <FaceLivenessDetector> da AWS, que e' um
- * componente React e por isso nao mora neste pacote.
+ * Cria a sessao e busca o resultado, com o polling necessario enquanto a
+ * analise termina. Para a captura pela camera, use `mountLiveness`, em
+ * `santoid-sdk/client/liveness-capture`, que ja faz este ciclo por dentro.
  *
- * Fluxo esperado:
- *  1. createSession() -> entrega o sessionId para o detector
- *  2. o detector transmite os frames direto para a AWS
- *  3. getResults() quando o detector sinalizar que terminou
+ * Fluxo:
+ *  1. createSession() -> sessionId
+ *  2. captura pela camera com o sessionId (getSessionConfig() traz o que o
+ *     componente de captura precisa)
+ *  3. getResults() quando a captura terminar
  */
 export declare function livenessSession(options: TLivenessSessionOptions): {
     createSession: () => Promise<string>;
     getResults: (sessionId?: string | null | undefined) => Promise<import("../../../../api/ApiLivenessSessionService").ILivenessSessionResult>;
     getSessionId: () => string | null;
+    getSessionConfig: () => {
+        region: string;
+        identityPoolId: string;
+    } | null;
 };

package/client/liveness/methods/livenessSession/index.js

@@ -4,17 +4,17 @@ exports.livenessSession = void 0;
 const Service_1 = require("./Service");
 const error_1 = require("../../../../utils/error");
 /**
- * Prova de vida v2, sobre o AWS Rekognition Face Liveness.
+ * Prova de vida: ciclo da sessao.
  *
- * Cobre o ciclo de sessao: cria a sessao e busca o resultado, com o polling
- * necessario enquanto o Rekognition ainda avalia. A captura em si - camera,
- * oval e desafio - fica a cargo do <FaceLivenessDetector> da AWS, que e' um
- * componente React e por isso nao mora neste pacote.
+ * Cria a sessao e busca o resultado, com o polling necessario enquanto a
+ * analise termina. Para a captura pela camera, use `mountLiveness`, em
+ * `santoid-sdk/client/liveness-capture`, que ja faz este ciclo por dentro.
  *
- * Fluxo esperado:
- *  1. createSession() -> entrega o sessionId para o detector
- *  2. o detector transmite os frames direto para a AWS
- *  3. getResults() quando o detector sinalizar que terminou
+ * Fluxo:
+ *  1. createSession() -> sessionId
+ *  2. captura pela camera com o sessionId (getSessionConfig() traz o que o
+ *     componente de captura precisa)
+ *  3. getResults() quando a captura terminar
  */
 function livenessSession(options) {
     try {
@@ -30,6 +30,9 @@ function livenessSession(options) {
             getSessionId: () => {
                 return service.sessionId;
             },
+            getSessionConfig: () => {
+                return service.getSessionConfig();
+            },
         };
     }
     catch (err) {

package/client/liveness/methods/livenessSession/isLivenessApproved.d.ts

@@ -0,0 +1,6 @@
+import { type ILivenessSessionResult } from '../../../../api/ApiLivenessSessionService';
+/**
+ * `Status: SUCCEEDED` so diz que a sessao terminou; quem aprova e' a
+ * confianca. Uma sessao concluida com confianca 0 e' uma reprovacao.
+ */
+export declare function isLivenessApproved(result: Pick<ILivenessSessionResult, 'Status' | 'Confidence'> | null | undefined, threshold?: number): boolean;

package/client/liveness/methods/livenessSession/isLivenessApproved.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isLivenessApproved = void 0;
+const constants_1 = require("../../../../utils/constants");
+/**
+ * `Status: SUCCEEDED` so diz que a sessao terminou; quem aprova e' a
+ * confianca. Uma sessao concluida com confianca 0 e' uma reprovacao.
+ */
+function isLivenessApproved(result, threshold = constants_1.LIVENESS_APPROVAL_THRESHOLD) {
+    var _a;
+    return (result === null || result === void 0 ? void 0 : result.Status) === 'SUCCEEDED' && ((_a = result.Confidence) !== null && _a !== void 0 ? _a : 0) >= threshold;
+}
+exports.isLivenessApproved = isLivenessApproved;