santoid-sdk 5.3.0 → 7.0.0

package/client/index.js

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

package/client/liveness/index.d.ts

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

package/client/liveness/index.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.uploadIdentificationDocument = exports.livenessDetection = void 0;
+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; } });
+const livenessSession_1 = require("./methods/livenessSession");
+Object.defineProperty(exports, "livenessSession", { enumerable: true, get: function () { return livenessSession_1.livenessSession; } });
 const uploadIdentificationDocument_1 = require("./methods/uploadIdentificationDocument");
 Object.defineProperty(exports, "uploadIdentificationDocument", { enumerable: true, get: function () { return uploadIdentificationDocument_1.uploadIdentificationDocument; } });

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

@@ -6,6 +6,14 @@ type ILivenessDetectionParams = Omit<ISDKOptions<TFrameType, TMediaType>, 'onSta
         videoStream: TMediaType;
     }) => void | Promise<void>;
 };
+/**
+ * @deprecated Prova de vida v1, sobre o detector in-house (WebSocket com o
+ * desafio de cinco posicoes). Substituida por {@link livenessSession}, que usa
+ * o AWS Rekognition Face Liveness.
+ *
+ * Continua funcionando e sera mantida ate a migracao dos clientes, mas nao
+ * recebe mais evolucao. Codigo novo deve usar livenessSession.
+ */
 export declare function livenessDetection(options: ILivenessDetectionParams): {
     getVideoStream: () => TMediaType;
     stopLivenessDetection: () => Promise<void>;

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

@@ -5,6 +5,14 @@ const Service_1 = require("./Service");
 const error_1 = require("../../../../utils/error");
 const websocket_1 = require("../../../../utils/websocket");
 const index_1 = require("../../utils/index");
+/**
+ * @deprecated Prova de vida v1, sobre o detector in-house (WebSocket com o
+ * desafio de cinco posicoes). Substituida por {@link livenessSession}, que usa
+ * o AWS Rekognition Face Liveness.
+ *
+ * Continua funcionando e sera mantida ate a migracao dos clientes, mas nao
+ * recebe mais evolucao. Codigo novo deve usar livenessSession.
+ */
 function livenessDetection(options) {
     var _a;
     try {

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

@@ -0,0 +1,19 @@
+import { ApiLivenessSessionService, type ILivenessSessionResult } from '../../../../api/ApiLivenessSessionService';
+import { type IBaseSDKOptions } from '../../../../utils/types';
+import { SDKError } from '../../../../utils/error';
+export type TLivenessSessionOptions = Omit<IBaseSDKOptions, 'track'> & {
+    track?: string;
+    customerRequestId?: string;
+    onSessionCreated?: (sessionId: string) => void | Promise<void>;
+    onResults?: (results: ILivenessSessionResult) => void | Promise<void>;
+    onError?: (error: SDKError) => void | Promise<void>;
+};
+export declare class LivenessSessionService {
+    options: TLivenessSessionOptions;
+    service: ApiLivenessSessionService;
+    sessionId: string | null;
+    constructor(options: TLivenessSessionOptions);
+    createSession(): Promise<string>;
+    getResults(sessionId?: string | null): Promise<ILivenessSessionResult>;
+    private fail;
+}

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

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LivenessSessionService = void 0;
+const ApiLivenessSessionService_1 = require("../../../../api/ApiLivenessSessionService");
+const error_1 = require("../../../../utils/error");
+const utils_1 = require("../../../../utils");
+const constants_1 = require("../../../../utils/constants");
+const index_1 = require("../../utils/index");
+class LivenessSessionService {
+    constructor(options) {
+        this.sessionId = null;
+        this.options = options;
+        this.service = new ApiLivenessSessionService_1.ApiLivenessSessionService(options, { FormDataClass: FormData, tryDecodeJwt: index_1.tryDecodeJwt });
+    }
+    async createSession() {
+        var _a, _b;
+        try {
+            const session = await this.service.createSession(this.options.customerRequestId);
+            this.sessionId = session.SessionId;
+            await ((_b = (_a = this.options).onSessionCreated) === null || _b === void 0 ? void 0 : _b.call(_a, session.SessionId));
+            return session.SessionId;
+        }
+        catch (err) {
+            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.
+    async getResults(sessionId = this.sessionId) {
+        var _a, _b;
+        if (!sessionId) {
+            throw await this.fail('There is no liveness session to fetch results from');
+        }
+        try {
+            let lastResult = null;
+            for (let attempt = 0; attempt < constants_1.LIVENESS_RESULT_MAX_ATTEMPTS; attempt++) {
+                lastResult = await this.service.getSessionResults(sessionId);
+                if (!constants_1.LIVENESS_PENDING_STATUSES.includes(lastResult.Status))
+                    break;
+                await (0, utils_1.wait)(constants_1.LIVENESS_RESULT_RETRY_DELAY_MS);
+            }
+            await ((_b = (_a = this.options).onResults) === null || _b === void 0 ? void 0 : _b.call(_a, lastResult));
+            return lastResult;
+        }
+        catch (err) {
+            throw await this.fail('Error while fetching liveness session results', err);
+        }
+    }
+    async fail(message, cause) {
+        var _a, _b;
+        const error = new error_1.SDKError({
+            message,
+            code: error_1.EDefaultErrorCodes.INITIALIZATION_ERROR,
+            fatal: true,
+            details: cause,
+        });
+        await ((_b = (_a = this.options).onError) === null || _b === void 0 ? void 0 : _b.call(_a, error));
+        return error;
+    }
+}
+exports.LivenessSessionService = LivenessSessionService;

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

@@ -0,0 +1,20 @@
+import { type TLivenessSessionOptions } from './Service';
+export type { TLivenessSessionOptions };
+/**
+ * Prova de vida v2, sobre o AWS Rekognition Face Liveness.
+ *
+ * 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.
+ *
+ * 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
+ */
+export declare function livenessSession(options: TLivenessSessionOptions): {
+    createSession: () => Promise<string>;
+    getResults: (sessionId?: string | null | undefined) => Promise<import("../../../../api/ApiLivenessSessionService").ILivenessSessionResult>;
+    getSessionId: () => string | null;
+};

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

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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.
+ *
+ * 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.
+ *
+ * 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
+ */
+function livenessSession(options) {
+    try {
+        const service = new Service_1.LivenessSessionService(options);
+        // Arrow functions sao obrigatorias aqui para o "this" nao se perder
+        return {
+            createSession: async () => {
+                return await service.createSession();
+            },
+            getResults: async (...rest) => {
+                return await service.getResults(...rest);
+            },
+            getSessionId: () => {
+                return service.sessionId;
+            },
+        };
+    }
+    catch (err) {
+        throw new error_1.SDKError({
+            message: 'Error while starting SDK',
+            code: error_1.EDefaultErrorCodes.INITIALIZATION_ERROR,
+            fatal: true,
+            details: err,
+        });
+    }
+}
+exports.livenessSession = livenessSession;

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

@@ -2,7 +2,7 @@ import { type IServiceOptions } from './Service';
 import { type TFrameType, type TMediaType } from '../livenessDetection';
 export declare function uploadIdentificationDocument(options: IServiceOptions<TFrameType, TMediaType>): {
     startDocumentUpload: (file: TFrameType) => Promise<void>;
-    startLivenessDetection: (startLivenessDetectionOptions?: (Omit<import("../../../../utils/types").ISDKOptions<TFrameType, TMediaType>, "token" | "track"> & {
+    startLivenessDetection: (startLivenessDetectionOptions?: (Omit<import("../../../../utils/types").ISDKOptions<TFrameType, TMediaType>, "track" | "token"> & {
         track?: string | undefined;
         token?: string | undefined;
     }) | undefined) => (Omit<{
@@ -14,7 +14,7 @@ export declare function uploadIdentificationDocument(options: IServiceOptions<TF
         getVideoStream?: (() => TMediaType) | undefined;
     }) | undefined;
     startFaceComparison: () => Promise<void>;
-    startAll: (file: TFrameType, startLivenessDetectionOptions?: (Omit<import("../../../../utils/types").ISDKOptions<TFrameType, TMediaType>, "token" | "track"> & {
+    startAll: (file: TFrameType, startLivenessDetectionOptions?: (Omit<import("../../../../utils/types").ISDKOptions<TFrameType, TMediaType>, "track" | "token"> & {
         track?: string | undefined;
         token?: string | undefined;
     }) | undefined) => void;

package/client/liveness/utils/getNextFrame.d.ts

@@ -1,5 +1,8 @@
+export interface IStartGettingFramesOptions {
+    facingMode?: 'user' | 'environment';
+}
 export interface IFrameControls<TFrameType, TMediaType> {
-    startGettingFrames?: () => TMediaType | Promise<TMediaType>;
+    startGettingFrames?: (cameraOptions?: IStartGettingFramesOptions) => TMediaType | Promise<TMediaType>;
     getNextFrame?: () => TFrameType | Promise<TFrameType>;
     stopGettingFrames?: () => void | Promise<void>;
     videoStream?: TMediaType;

package/client/liveness/utils/getNextFrame.js

@@ -41,12 +41,13 @@ async function getDefaultFrameControls() {
             videoStream = undefined;
         }
     }
-    async function startGettingFrames() {
+    async function startGettingFrames(cameraOptions) {
+        var _a;
         if (!videoStream || !videoElement || !canvasElement) {
             videoStream = await navigator.mediaDevices.getUserMedia({
                 audio: false,
                 video: {
-                    facingMode: 'environment',
+                    facingMode: (_a = cameraOptions === null || cameraOptions === void 0 ? void 0 : cameraOptions.facingMode) !== null && _a !== void 0 ? _a : 'user',
                 },
             });
             videoElement = document.createElement('video');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "santoid-sdk",
-  "version": "5.3.0",
+  "version": "7.0.0",
   "description": "",
   "main": "client/index.js",
   "types": "client/index.d.ts",

package/server/core/methods/faceMatch/Service.d.ts

@@ -1,5 +1,5 @@
 import { FaceMatchService, type TFaceMatchServiceOptions } from '../../../../client/core/methods/faceMatch/Service';
-export type TNodeFaceMatchServiceOptions<TMediaType> = Omit<TFaceMatchServiceOptions<TMediaType>, 'onStart'> & {
+export type TNodeFaceMatchServiceOptions<TMediaType> = Omit<TFaceMatchServiceOptions<TMediaType>, 'onStart' | 'onCameraStart' | 'onCameraStop'> & {
     onStart?: () => void | Promise<void>;
 };
 export declare class NodeFaceMatchService<TFrameType, TMediaType> extends FaceMatchService<TFrameType, TMediaType> {

package/server/core/methods/ocr/Service.d.ts

@@ -1,5 +1,5 @@
 import { OcrService, type TOcrServiceOptions } from '../../../../client/core/methods/ocr/Service';
-export type TNodeOcrServiceOptions<TMediaType> = Omit<TOcrServiceOptions<TMediaType>, 'onStart'> & {
+export type TNodeOcrServiceOptions<TMediaType> = Omit<TOcrServiceOptions<TMediaType>, 'onStart' | 'onCameraStart' | 'onCameraStop'> & {
     onStart?: () => void | Promise<void>;
 };
 export declare class NodeOcrService<TFrameType, TMediaType> extends OcrService<TFrameType, TMediaType> {

package/server/core/methods/typification/Service.d.ts

@@ -1,5 +1,5 @@
 import { TypificationService, type TTypificationServiceOptions } from '../../../../client/core/methods/typification/Service';
-export type TNodeTypificationServiceOptions<TMediaType> = Omit<TTypificationServiceOptions<TMediaType>, 'onStart'> & {
+export type TNodeTypificationServiceOptions<TMediaType> = Omit<TTypificationServiceOptions<TMediaType>, 'onStart' | 'onCameraStart' | 'onCameraStop'> & {
     onStart?: () => void | Promise<void>;
 };
 export declare class NodeTypificationService<TFrameType, TMediaType> extends TypificationService<TFrameType, TMediaType> {

package/server/liveness/methods/uploadIdentificationDocument/index.d.ts

@@ -3,7 +3,7 @@ import { type IServiceOptions } from '../../../../client/liveness/methods/upload
 import { type TFrameType, type TMediaType } from '../livenessDetection';
 export declare function uploadIdentificationDocument(options: IServiceOptions<TFrameType, TMediaType>): {
     startDocumentUpload: (file: import("ws").Data) => Promise<void>;
-    startLivenessDetection: (startLivenessDetectionOptions?: (Omit<import("../../../../utils/types").ISDKOptions<import("ws").Data, undefined>, "token" | "track"> & {
+    startLivenessDetection: (startLivenessDetectionOptions?: (Omit<import("../../../../utils/types").ISDKOptions<import("ws").Data, undefined>, "track" | "token"> & {
         track?: string | undefined;
         token?: string | undefined;
     }) | undefined) => (Omit<{
@@ -15,7 +15,7 @@ export declare function uploadIdentificationDocument(options: IServiceOptions<TF
         getVideoStream?: (() => undefined) | undefined;
     }) | undefined;
     startFaceComparison: () => Promise<void>;
-    startAll: (file: import("ws").Data, startLivenessDetectionOptions?: (Omit<import("../../../../utils/types").ISDKOptions<import("ws").Data, undefined>, "token" | "track"> & {
+    startAll: (file: import("ws").Data, startLivenessDetectionOptions?: (Omit<import("../../../../utils/types").ISDKOptions<import("ws").Data, undefined>, "track" | "token"> & {
         track?: string | undefined;
         token?: string | undefined;
     }) | undefined) => void;

package/utils/constants.d.ts

@@ -1,6 +1,10 @@
-export declare const WEBSOCKET_BASE_URL = "wss://santoid-liveness-w4ynos5dlq-ue.a.run.app/api/v1/liveness/ws";
+export declare const LIVENESS_API_URL = "https://liveness.santoid.com.br";
+export declare const WEBSOCKET_BASE_URL: string;
 export declare const API_GATEWAY_URL = "https://api.santoid.com.br";
 export declare const APPLICATION_URL = "https://app.santoid.com.br";
 export declare const SEND_FRAMES_INTERVAL_MS = 100;
 export declare const DEFAULT_NUMBER_OF_RETRIES = 5;
 export declare const DEFAULT_RETRY_TIME_STEP = 1000;
+export declare const LIVENESS_PENDING_STATUSES: string[];
+export declare const LIVENESS_RESULT_MAX_ATTEMPTS = 8;
+export declare const LIVENESS_RESULT_RETRY_DELAY_MS = 1500;

package/utils/constants.js

@@ -1,9 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_RETRY_TIME_STEP = exports.DEFAULT_NUMBER_OF_RETRIES = exports.SEND_FRAMES_INTERVAL_MS = exports.APPLICATION_URL = exports.API_GATEWAY_URL = exports.WEBSOCKET_BASE_URL = void 0;
-exports.WEBSOCKET_BASE_URL = 'wss://santoid-liveness-w4ynos5dlq-ue.a.run.app/api/v1/liveness/ws';
+exports.LIVENESS_RESULT_RETRY_DELAY_MS = exports.LIVENESS_RESULT_MAX_ATTEMPTS = exports.LIVENESS_PENDING_STATUSES = exports.DEFAULT_RETRY_TIME_STEP = exports.DEFAULT_NUMBER_OF_RETRIES = exports.SEND_FRAMES_INTERVAL_MS = exports.APPLICATION_URL = exports.API_GATEWAY_URL = exports.WEBSOCKET_BASE_URL = exports.LIVENESS_API_URL = void 0;
+exports.LIVENESS_API_URL = 'https://liveness.santoid.com.br';
+exports.WEBSOCKET_BASE_URL = `${exports.LIVENESS_API_URL.replace('https://', 'wss://')}/api/v1/liveness/ws`;
 exports.API_GATEWAY_URL = 'https://api.santoid.com.br';
 exports.APPLICATION_URL = 'https://app.santoid.com.br';
 exports.SEND_FRAMES_INTERVAL_MS = 100;
 exports.DEFAULT_NUMBER_OF_RETRIES = 5;
 exports.DEFAULT_RETRY_TIME_STEP = 1000;
+exports.LIVENESS_PENDING_STATUSES = ['CREATED', 'IN_PROGRESS'];
+exports.LIVENESS_RESULT_MAX_ATTEMPTS = 8;
+exports.LIVENESS_RESULT_RETRY_DELAY_MS = 1500;