santoid-sdk 2.0.1 → 3.0.0

package/node/liveness/methods/livenessDetection.js

@@ -1,114 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.livenessDetection = void 0;
-const constants_1 = require("../../../utils/constants");
-const websocket_1 = require("../utils/websocket");
-async function onWebSocketMessage(options, event) {
-    var _a, _b, _c;
-    const message = event.data;
-    let messageObj;
-    try {
-        messageObj = JSON.parse(message);
-    }
-    catch (err) {
-        console.error('Cannot parse API message', err);
-    }
-    if ((messageObj === null || messageObj === void 0 ? void 0 : messageObj.next_step) && !messageObj.error) {
-        await ((_a = options.nextStepCallback) === null || _a === void 0 ? void 0 : _a.call(options, messageObj.next_step));
-        await ((_b = options[`${messageObj.next_step}Callback`]) === null || _b === void 0 ? void 0 : _b.call(options));
-    }
-    if (messageObj === null || messageObj === void 0 ? void 0 : messageObj.error) {
-        await ((_c = options.errorCallback) === null || _c === void 0 ? void 0 : _c.call(options, { code: 'wrong-position' }));
-    }
-    return messageObj;
-}
-async function livenessDetection(options) {
-    var _a, _b, _c;
-    let websocketClosedBySDK = false;
-    let validationSuccess = false;
-    let endCalled = false;
-    let canSendNextBytes = true;
-    const successFrames = {
-        front: undefined,
-        right: undefined,
-        left: undefined,
-        up: undefined,
-        bottom: undefined,
-    };
-    let lastSentBytes;
-    let currentStep = 'front';
-    async function stopLivenessDetection(options, websocket, intervalKey) {
-        var _a;
-        if (intervalKey) {
-            clearInterval(intervalKey);
-        }
-        if (websocket) {
-            (0, websocket_1.disconnectFromWebSocket)(websocket);
-        }
-        !endCalled && await ((_a = options.endCallback) === null || _a === void 0 ? void 0 : _a.call(options));
-        endCalled = true;
-        websocketClosedBySDK = true;
-    }
-    let sendFramesIntervalKey;
-    let websocket;
-    try {
-        websocket = await (0, websocket_1.connectToWebSocket)(options);
-        await ((_a = options.nextStepCallback) === null || _a === void 0 ? void 0 : _a.call(options, 'front'));
-        await ((_b = options.frontCallback) === null || _b === void 0 ? void 0 : _b.call(options));
-        sendFramesIntervalKey = setInterval(async () => {
-            try {
-                if (canSendNextBytes) {
-                    const bytes = await options.getNextFrame();
-                    if (bytes) {
-                        websocket === null || websocket === void 0 ? void 0 : websocket.send(bytes);
-                        lastSentBytes = bytes;
-                        canSendNextBytes = false;
-                    }
-                }
-            }
-            catch (err) {
-                await stopLivenessDetection(options, websocket, sendFramesIntervalKey);
-            }
-        }, constants_1.SEND_FRAMES_INTERVAL_MS);
-        websocket.on('message', async (data) => {
-            var _a;
-            const parsedMessage = await onWebSocketMessage(options, { data: Buffer.from(data).toString() });
-            if (parsedMessage) {
-                canSendNextBytes = !!(parsedMessage === null || parsedMessage === void 0 ? void 0 : parsedMessage.can_send_next_bytes);
-            }
-            if ((parsedMessage === null || parsedMessage === void 0 ? void 0 : parsedMessage.validation) && currentStep) {
-                successFrames[currentStep] = lastSentBytes;
-            }
-            if (parsedMessage === null || parsedMessage === void 0 ? void 0 : parsedMessage.next_step) {
-                currentStep = parsedMessage.next_step;
-            }
-            if (parsedMessage === null || parsedMessage === void 0 ? void 0 : parsedMessage.success) {
-                successFrames.bottom = lastSentBytes;
-                validationSuccess = true;
-                await ((_a = options.successCallback) === null || _a === void 0 ? void 0 : _a.call(options, { livenessId: parsedMessage.livenessId, successFrames }));
-                await stopLivenessDetection(options, websocket, sendFramesIntervalKey);
-            }
-        });
-        websocket.on('error', async (event) => {
-            var _a;
-            !validationSuccess && ((_a = options.errorCallback) === null || _a === void 0 ? void 0 : _a.call(options, { code: 'internal-error' }));
-            await stopLivenessDetection(options, websocket, sendFramesIntervalKey);
-        });
-        websocket.on('close', async () => {
-            var _a;
-            if (!websocketClosedBySDK) {
-                !validationSuccess && ((_a = options.errorCallback) === null || _a === void 0 ? void 0 : _a.call(options, { code: 'internal-error' }));
-                await stopLivenessDetection(options, websocket, sendFramesIntervalKey);
-            }
-        });
-        return {
-            stopLivenessDetection: async () => { await stopLivenessDetection(options, websocket, sendFramesIntervalKey); },
-        };
-    }
-    catch (err) {
-        !validationSuccess && ((_c = options.errorCallback) === null || _c === void 0 ? void 0 : _c.call(options, { code: 'internal-error' }));
-        await stopLivenessDetection(options, websocket, sendFramesIntervalKey);
-        throw err;
-    }
-}
-exports.livenessDetection = livenessDetection;

package/node/liveness/methods/uploadIdentificationDocument.d.ts

@@ -1,91 +0,0 @@
-import { type Data } from 'ws';
-import { type ILivenessResults, type TNodeSDKOptions, type IBaseSDKOptions, type TCallbackFunction, type TErrorCode } from '../utils/types';
-type TResultStatuses = 'success' | 'error' | null;
-type FileType = Data;
-interface ITypificationResult {
-    n_documents: number;
-    predictOCR: Array<{
-        typification: {
-            document_type: string;
-            ocr_success: boolean;
-            typification_score: number;
-        };
-        ocr_error?: boolean | null;
-        ocr_message?: {
-            template: string;
-            labels: any;
-        } | null;
-        ocr_extraction: {
-            template: string;
-            labels: Array<{
-                x: number;
-                y: number;
-                w: number;
-                h: number;
-                bottomRight: number[];
-                topLeft: number[];
-                dataField?: string;
-                dataFieldValue?: boolean;
-                ocr?: string | null;
-                ocr_score?: number;
-                cropBase64?: string | null;
-                serpro_query?: {
-                    serpro_data: any;
-                    search_logs: {
-                        document: string;
-                        type: string;
-                        search_time: string;
-                        status_code: number;
-                        message: string;
-                    };
-                };
-                validation?: Record<string, number | boolean>;
-            }> | null;
-        } | boolean;
-    }>;
-}
-interface IFaceMatchResult {
-    comparison_score: number;
-    similarity_score: number;
-    match: boolean;
-}
-interface IUploadIdentificationDocumentResults {
-    uploadedDocument: FileType | null;
-    typification: {
-        status: TResultStatuses;
-        results: ITypificationResult | null;
-        loading: boolean;
-        error: any;
-    };
-    liveness: {
-        status: TResultStatuses;
-        results: ILivenessResults<FileType | null | undefined> | null;
-        loading: boolean;
-        error: any;
-    };
-    faceMatch: {
-        status: TResultStatuses;
-        results: IFaceMatchResult | null;
-        loading: boolean;
-        error: any;
-    };
-}
-interface IUploadIdentificationDocumentOptions extends IBaseSDKOptions {
-    resultChangeCallback: (results?: IUploadIdentificationDocumentResults) => void | Promise<void>;
-    successCallback: <FrameType, ResultsType = ILivenessResults<FrameType>>(results?: ResultsType) => void | Promise<void>;
-    errorCallback?: (error?: {
-        code: TErrorCode;
-        details?: any;
-    }) => void | Promise<void>;
-    endCallback?: TCallbackFunction;
-}
-export declare function uploadIdentificationDocument(options: IUploadIdentificationDocumentOptions): {
-    getResults: () => IUploadIdentificationDocumentResults;
-    startDocumentUpload: (file: FileType) => Promise<void>;
-    startLivenessDetection: (startLivenessDetectionOptions: TNodeSDKOptions) => Promise<{
-        stopLivenessDetection: () => Promise<void>;
-    } | undefined>;
-    startFaceComparison: () => void;
-    startAll: (file: FileType, startLivenessDetectionOptions: TNodeSDKOptions) => void;
-};
-export {};

package/node/liveness/methods/uploadIdentificationDocument.js

@@ -1,239 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.uploadIdentificationDocument = void 0;
-const form_data_1 = __importDefault(require("form-data"));
-const axios_1 = __importDefault(require("axios"));
-const constants_1 = require("../../../utils/constants");
-const utils_1 = require("../utils");
-const livenessDetection_1 = require("./livenessDetection");
-async function typificationPredict(options, file) {
-    var _a, _b, _c;
-    const formData = new form_data_1.default();
-    formData.append('track', options.track);
-    formData.append('imageFile', file, 'imageFile.jpg');
-    const decodedToken = (0, utils_1.tryDecodeJwt)(options.token);
-    const domain = (_a = options.domain) !== null && _a !== void 0 ? _a : (_b = decodedToken === null || decodedToken === void 0 ? void 0 : decodedToken.claims) === null || _b === void 0 ? void 0 : _b.domain;
-    const axiosConfig = {
-        headers: {
-            'Content-Type': 'multipart/form-data',
-            Authorization: `Bearer ${options.token}`,
-        },
-    };
-    if (axiosConfig.headers && domain) {
-        axiosConfig.headers.Domain = domain;
-    }
-    const response = await axios_1.default.post(`${(_c = options === null || options === void 0 ? void 0 : options.customApiUrl) !== null && _c !== void 0 ? _c : constants_1.API_GATEWAY_URL}/api/v3/typification/predict`, formData, axiosConfig);
-    return response.data;
-}
-async function faceMatch(options, firstImage, secondImage) {
-    var _a, _b, _c;
-    const formData = new form_data_1.default();
-    formData.append('track', options.track);
-    formData.append('firstImage', firstImage, 'firstImage.jpg');
-    formData.append('secondImage', secondImage, 'secondImage.jpg');
-    const decodedToken = (0, utils_1.tryDecodeJwt)(options.token);
-    const domain = (_a = options.domain) !== null && _a !== void 0 ? _a : (_b = decodedToken === null || decodedToken === void 0 ? void 0 : decodedToken.claims) === null || _b === void 0 ? void 0 : _b.domain;
-    const axiosConfig = {
-        params: {
-            sensitive_data_compliance: true,
-        },
-        headers: {
-            'Content-Type': 'multipart/form-data',
-            Authorization: `Bearer ${options.token}`,
-        },
-    };
-    if (axiosConfig.headers && domain) {
-        axiosConfig.headers.Domain = domain;
-    }
-    const response = await axios_1.default.post(`${(_c = options === null || options === void 0 ? void 0 : options.customApiUrl) !== null && _c !== void 0 ? _c : constants_1.API_GATEWAY_URL}/api/v1/facematch/pair`, formData, axiosConfig);
-    return response.data;
-}
-function uploadIdentificationDocument(options) {
-    let results = {
-        uploadedDocument: null,
-        typification: {
-            status: null,
-            results: null,
-            loading: false,
-            error: null,
-        },
-        liveness: {
-            status: null,
-            results: null,
-            loading: false,
-            error: null,
-        },
-        faceMatch: {
-            status: null,
-            results: null,
-            loading: false,
-            error: null,
-        },
-    };
-    async function startFaceMatch(firstImage, secondImage) {
-        var _a, _b, _c;
-        try {
-            updateResults({
-                faceMatch: {
-                    status: null,
-                    results: null,
-                    loading: true,
-                    error: null,
-                },
-            });
-            const faceMatchResults = await faceMatch(options, firstImage, secondImage);
-            updateResults({
-                faceMatch: {
-                    results: faceMatchResults,
-                    status: 'success',
-                    loading: false,
-                    error: null,
-                },
-            });
-        }
-        catch (err) {
-            await ((_a = options.errorCallback) === null || _a === void 0 ? void 0 : _a.call(options, { code: 'face-match-error', details: (_b = err === null || err === void 0 ? void 0 : err.response) === null || _b === void 0 ? void 0 : _b.data }));
-            updateResults({
-                faceMatch: {
-                    results: null,
-                    status: 'error',
-                    loading: false,
-                    error: (_c = err === null || err === void 0 ? void 0 : err.response) === null || _c === void 0 ? void 0 : _c.data,
-                },
-            });
-        }
-    }
-    function tryStartFaceMatch() {
-        var _a;
-        if (results.uploadedDocument &&
-            ((_a = results.liveness.results) === null || _a === void 0 ? void 0 : _a.successFrames.front) &&
-            !results.faceMatch.results &&
-            !results.faceMatch.loading) {
-            void startFaceMatch(results.uploadedDocument, results.liveness.results.successFrames.front);
-        }
-    }
-    function updateUploadedDocument(file) {
-        results.uploadedDocument = file;
-        tryStartFaceMatch();
-    }
-    function updateResults(updatedResults) {
-        var _a, _b, _c;
-        results = Object.assign(Object.assign({}, results), updatedResults);
-        void ((_a = options.resultChangeCallback) === null || _a === void 0 ? void 0 : _a.call(options, results));
-        if (Object.entries(results).every(([key, value]) => key === 'uploadedDocument' || !!value.results)) {
-            void ((_b = options.successCallback) === null || _b === void 0 ? void 0 : _b.call(options, results));
-            void ((_c = options.endCallback) === null || _c === void 0 ? void 0 : _c.call(options));
-            return;
-        }
-        if (results.faceMatch.status !== 'error') {
-            tryStartFaceMatch();
-        }
-    }
-    async function startDocumentUpload(file) {
-        var _a, _b, _c;
-        try {
-            updateResults({
-                typification: {
-                    status: null,
-                    results: null,
-                    loading: true,
-                    error: null,
-                },
-            });
-            updateUploadedDocument(file);
-            const typificationResults = await typificationPredict(options, file);
-            updateResults({
-                typification: {
-                    status: 'success',
-                    results: typificationResults,
-                    loading: false,
-                    error: null,
-                },
-            });
-        }
-        catch (err) {
-            await ((_a = options.errorCallback) === null || _a === void 0 ? void 0 : _a.call(options, { code: 'typification-error', details: (_b = err === null || err === void 0 ? void 0 : err.response) === null || _b === void 0 ? void 0 : _b.data }));
-            updateResults({
-                typification: {
-                    status: 'error',
-                    results: null,
-                    loading: false,
-                    error: (_c = err === null || err === void 0 ? void 0 : err.response) === null || _c === void 0 ? void 0 : _c.data,
-                },
-            });
-        }
-    }
-    async function startLivenessDetection(startLivenessDetectionOptions) {
-        var _a, _b, _c, _d, _e;
-        const adaptedLivenessOptions = Object.assign({}, startLivenessDetectionOptions);
-        delete adaptedLivenessOptions.successCallback;
-        delete adaptedLivenessOptions.errorCallback;
-        updateResults({
-            liveness: {
-                results: null,
-                status: null,
-                loading: true,
-                error: null,
-            },
-        });
-        try {
-            return await (0, livenessDetection_1.livenessDetection)(Object.assign(Object.assign({ domain: options.domain, customId: options.customId, customWebSocketUrl: options.customWebSocketUrl, successCallback: (livenessResults) => {
-                    var _a;
-                    void ((_a = startLivenessDetectionOptions === null || startLivenessDetectionOptions === void 0 ? void 0 : startLivenessDetectionOptions.successCallback) === null || _a === void 0 ? void 0 : _a.call(startLivenessDetectionOptions, livenessResults));
-                    updateResults({
-                        liveness: {
-                            status: 'success',
-                            results: (livenessResults),
-                            loading: false,
-                            error: null,
-                        },
-                    });
-                }, errorCallback: async (livenessErrorDetails) => {
-                    var _a, _b;
-                    if ((livenessErrorDetails === null || livenessErrorDetails === void 0 ? void 0 : livenessErrorDetails.code) === 'wrong-position') {
-                        void ((_a = startLivenessDetectionOptions === null || startLivenessDetectionOptions === void 0 ? void 0 : startLivenessDetectionOptions.errorCallback) === null || _a === void 0 ? void 0 : _a.call(startLivenessDetectionOptions, livenessErrorDetails));
-                    }
-                    else {
-                        void ((_b = options.errorCallback) === null || _b === void 0 ? void 0 : _b.call(options, livenessErrorDetails));
-                    }
-                    updateResults({
-                        liveness: {
-                            status: 'error',
-                            results: null,
-                            loading: (livenessErrorDetails === null || livenessErrorDetails === void 0 ? void 0 : livenessErrorDetails.code) === 'wrong-position',
-                            error: livenessErrorDetails,
-                        },
-                    });
-                } }, adaptedLivenessOptions), { token: (_a = adaptedLivenessOptions.token) !== null && _a !== void 0 ? _a : options.token, track: (_b = adaptedLivenessOptions.track) !== null && _b !== void 0 ? _b : options.track }));
-        }
-        catch (err) {
-            await ((_c = options.errorCallback) === null || _c === void 0 ? void 0 : _c.call(options, { code: 'liveness-error', details: (_d = err === null || err === void 0 ? void 0 : err.response) === null || _d === void 0 ? void 0 : _d.data }));
-            updateResults({
-                liveness: {
-                    status: 'error',
-                    results: null,
-                    loading: false,
-                    error: (_e = err === null || err === void 0 ? void 0 : err.response) === null || _e === void 0 ? void 0 : _e.data,
-                },
-            });
-        }
-    }
-    function startAll(file, startLivenessDetectionOptions) {
-        void startDocumentUpload(file);
-        void startLivenessDetection(startLivenessDetectionOptions);
-    }
-    function getResults() {
-        return results;
-    }
-    return {
-        getResults,
-        startDocumentUpload,
-        startLivenessDetection,
-        startFaceComparison: tryStartFaceMatch,
-        startAll,
-    };
-}
-exports.uploadIdentificationDocument = uploadIdentificationDocument;

package/node/liveness/utils/types.d.ts

@@ -1,6 +0,0 @@
-import { type Data } from 'ws';
-import { type ISDKOptions } from '../../../utils/types';
-export type TNodeSDKOptions = ISDKOptions & {
-    getNextFrame: () => Promise<Data | null>;
-};
-export * from '../../../utils/types';

package/node/liveness/utils/types.js

@@ -1,17 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("../../../utils/types"), exports);

package/node/liveness/utils/websocket.d.ts

@@ -1,5 +0,0 @@
-import WebSocket from 'ws';
-import { type TNodeSDKOptions } from './types';
-export declare function waitForWebSocketConnection(websocket: WebSocket): Promise<void>;
-export declare function connectToWebSocket(options: TNodeSDKOptions): Promise<WebSocket>;
-export declare function disconnectFromWebSocket(websocket: WebSocket): void;

package/node/liveness/utils/websocket.js

@@ -1,39 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.disconnectFromWebSocket = exports.connectToWebSocket = exports.waitForWebSocketConnection = void 0;
-const ws_1 = __importDefault(require("ws"));
-const _1 = require(".");
-const constants_1 = require("../../../utils/constants");
-async function waitForWebSocketConnection(websocket) {
-    await new Promise((resolve) => {
-        const intervalKey = setInterval(() => {
-            if ([3, 1].includes(websocket.readyState)) {
-                clearInterval(intervalKey);
-                resolve();
-            }
-        }, 5);
-    });
-    if (websocket.readyState === 3) {
-        throw new Error('Cannot connect to server');
-    }
-}
-exports.waitForWebSocketConnection = waitForWebSocketConnection;
-async function connectToWebSocket(options) {
-    var _a, _b;
-    const decodedToken = (0, _1.decodeJwt)(options.token);
-    const query = `?x_endpoint_api_userinfo=${options.token}&domain=${(_a = options.domain) !== null && _a !== void 0 ? _a : decodedToken.claims.domain}&track=${options.track}&customerRequestId=${options.customId}`;
-    const websocket = new ws_1.default(`${(_b = options.customWebSocketUrl) !== null && _b !== void 0 ? _b : constants_1.WEBSOCKET_BASE_URL}${query}`);
-    await waitForWebSocketConnection(websocket);
-    return websocket;
-}
-exports.connectToWebSocket = connectToWebSocket;
-function disconnectFromWebSocket(websocket) {
-    var _a;
-    if (![2, 3].includes(websocket.readyState)) {
-        (_a = websocket.close) === null || _a === void 0 ? void 0 : _a.call(websocket);
-    }
-}
-exports.disconnectFromWebSocket = disconnectFromWebSocket;