biometry-sdk 1.2.7 → 1.3.1

package/dist/biometry-sdk.esm.js

@@ -24,17 +24,41 @@ class BiometrySDK {
             const errorMessage = (errorData === null || errorData === undefined ? undefined : errorData.error) || (errorData === null || errorData === undefined ? undefined : errorData.message) || 'Unknown error occurred';
             throw new Error(`Error ${response.status}: ${errorMessage}`);
         }
-        return await response.json();
+        // Extract response headers
+        const responseHeaders = {};
+        const requestId = response.headers.get("X-Request-Id");
+        if (requestId) {
+            responseHeaders["X-Request-Id"] = requestId;
+        }
+        const responseBody = await response.json();
+        return {
+            body: responseBody,
+            headers: responseHeaders
+        };
+    }
+    /**
+     * Starts a new Session for a user.
+     *
+     * @returns {Promise<ApiResponse<SessionResponse>>} A promise resolving to the session ID.
+     * @throws {Error} - If the request fails.
+     */
+    async startSession() {
+        return await this.request('/api-gateway/sessions/start', 'POST');
     }
     /**
-     * Submits consent for a user.
+     * Submits Authorization consent for a user.
+     * Authorization Consent is required to use the services like Face and Voice recognition.
      *
      * @param {boolean} isConsentGiven - Indicates whether the user has given consent.
      * @param {string} userFullName - The full name of the user giving consent.
-     * @returns {Promise<ConsentResponse>} A promise resolving to the consent response.
+     * @param {Object} [props] - Optional properties for the consent request.
+     * @param {string} [props.sessionId] - Session ID to link this consent with a specific session group.
+     * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.
+     *                                      This can include properties like operating system, browser, etc.
+     * @returns {Promise<ApiResponse<ConsentResponse>>} A promise resolving to the consent response.
      * @throws {Error} - If the user's full name is not provided or if the request fails.
      */
-    async giveConsent(isConsentGiven, userFullName) {
+    async giveAuthorizationConsent(isConsentGiven, userFullName, props) {
         if (!userFullName) {
             throw new Error('User Full Name is required to give consent.');
         }
@@ -42,24 +66,60 @@ class BiometrySDK {
             is_consent_given: isConsentGiven,
             user_fullname: userFullName,
         };
-        const response = await this.request('/consent', 'POST', body);
-        return {
-            is_consent_given: response.is_consent_given,
-            user_fullname: response.user_fullname,
+        const headers = {};
+        if (props === null || props === undefined ? undefined : props.sessionId) {
+            headers['X-Session-ID'] = props.sessionId;
+        }
+        if (props === null || props === undefined ? undefined : props.deviceInfo) {
+            headers['X-Device-Info'] = JSON.stringify(props.deviceInfo);
+        }
+        return await this.request('/api-consent/consent', 'POST', body, headers);
+    }
+    /**
+     * Submits Storage consent for a user.
+     * Storage consent is granted by users, allowing us to store their biometric data for future verification.
+     *
+     * @param {boolean} isStorageConsentGiven - Indicates whether the user has given storage consent.
+     * @param {string} userFullName - The full name of the user giving storage consent.
+     * @param {Object} [props] - Optional properties for the consent request.
+     * @param {string} [props.sessionId] - Session ID to link this consent with a specific session group.
+     * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.
+     *                                      This can include properties like operating system, browser, etc.
+     * @returns {Promise<ApiResponse<ConsentResponse>>} A promise resolving to the consent response.
+     * @throws {Error} - If the user's full name is not provided or if the request fails.
+     */
+    async giveStorageConsent(isStorageConsentGiven, userFullName, props) {
+        if (!userFullName) {
+            throw new Error('User Full Name is required to give storage consent.');
+        }
+        const body = {
+            is_consent_given: isStorageConsentGiven,
+            user_fullname: userFullName,
         };
+        const headers = {};
+        if (props === null || props === undefined ? undefined : props.sessionId) {
+            headers['X-Session-ID'] = props.sessionId;
+        }
+        if (props === null || props === undefined ? undefined : props.deviceInfo) {
+            headers['X-Device-Info'] = JSON.stringify(props.deviceInfo);
+        }
+        return await this.request('/api-consent/strg-consent', 'POST', body, headers);
     }
     /**
-     * Onboards a user's voice for biometric authentication.
+     * Enrolls a user's voice for biometric authentication.
      *
      * @param {File} audio - The audio file containing the user's voice.
-     * @param {string} userFullName - The full name of the user being onboarded.
-     * @param {string} uniqueId - A unique identifier for the onboarding process.
+     * @param {string} userFullName - The full name of the user being enrolled.
+     * @param {string} uniqueId - A unique identifier for the enrolling process.
      * @param {string} phrase - The phrase spoken in the audio file.
-     * @param {string} [requestUserProvidedId] - An optional user-provided ID to link transactions within a unified group.
-     * @returns {Promise<VoiceOnboardingResponse>} - A promise resolving to the voice onboarding response.
+     * @param {Object} [props] - Optional properties for the enrollment request.
+     * @param {string} [props.sessionId] - Session ID to link this enrollment with a specific session group.
+     * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.
+     *                                      This can include properties like operating system, browser, etc.
+     * @returns {Promise<ApiResponse<VoiceEnrollmentResponse>>} - A promise resolving to the voice enrolling response.
      * @throws {Error} - If required parameters are missing or the request fails.
      */
-    async onboardVoice(audio, userFullName, uniqueId, phrase, requestUserProvidedId) {
+    async enrollVoice(audio, userFullName, uniqueId, phrase, props) {
         if (!userFullName)
             throw new Error('User fullname is required.');
         if (!uniqueId)
@@ -75,22 +135,28 @@ class BiometrySDK {
         const headers = {
             'X-User-Fullname': userFullName,
         };
-        if (requestUserProvidedId) {
-            headers['X-Request-User-Provided-ID'] = requestUserProvidedId;
+        if (props === null || props === undefined ? undefined : props.sessionId) {
+            headers['X-Session-ID'] = props.sessionId;
         }
-        return this.request('/api-gateway/onboard/voice', 'POST', formData, headers);
+        if (props === null || props === undefined ? undefined : props.deviceInfo) {
+            headers['X-Device-Info'] = JSON.stringify(props.deviceInfo);
+        }
+        return await this.request('/api-gateway/enroll/voice', 'POST', formData, headers);
     }
     /**
-     * Onboards a user's face for biometric authentication.
+     * Enrolls a user's face for biometric authentication.
      *
      * @param {File} face - Image file that contains user's face.
-     * @param {string} userFullName - The full name of the user being onboarded.
+     * @param {string} userFullName - The full name of the user being enrolled.
      * @param {string} isDocument - Indicates whether the image is a document.
-     * @param {string} [requestUserProvidedId] - An optional user-provided ID to link transactions within a unified group.
-     * @returns {Promise<FaceOnboardingResponse>} - A promise resolving to the voice onboarding response.
+     * @param {Object} [props] - Optional properties for the enrollment request.
+     * @param {string} [props.sessionId] - Session ID to link this enrollment with a specific session group.
+     * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.
+     *                                      This can include properties like operating system, browser, etc.
+     * @returns {Promise<ApiResponse<FaceEnrollmentResponse>>} - A promise resolving to the voice enrolling response.
      * @throws {Error} - If required parameters are missing or the request fails.
      */
-    async onboardFace(face, userFullName, isDocument, requestUserProvidedId) {
+    async enrollFace(face, userFullName, isDocument, props) {
         if (!userFullName)
             throw new Error('User fullname is required.');
         if (!face)
@@ -103,10 +169,42 @@ class BiometrySDK {
         const headers = {
             'X-User-Fullname': userFullName,
         };
-        if (requestUserProvidedId) {
-            headers['X-Request-User-Provided-ID'] = requestUserProvidedId;
+        if (props === null || props === undefined ? undefined : props.sessionId) {
+            headers['X-Session-ID'] = props.sessionId;
+        }
+        if (props === null || props === undefined ? undefined : props.deviceInfo) {
+            headers['X-Device-Info'] = JSON.stringify(props.deviceInfo);
         }
-        return this.request('/api-gateway/onboard/face', 'POST', formData, headers);
+        return await this.request('/api-gateway/enroll/face', 'POST', formData, headers);
+    }
+    /**
+     * Check the validity of a documents.
+     *
+     * @param {File} document - Document image file.
+     * @param {string} userFullName - The full name of the user being checked.
+     * @param {Object} [props] - Optional properties for the enrollment request.
+     * @param {string} [props.sessionId] - Session ID to link this enrollment with a specific session group.
+     * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.
+     *                                      This can include properties like operating system, browser, etc.
+     * @returns {Promise<ApiResponse<DocAuthInfo>>} - A promise resolving to the document authentication information.
+     */
+    async checkDocAuth(document, userFullName, props) {
+        if (!document)
+            throw new Error('Document image is required.');
+        if (!userFullName)
+            throw new Error('User fullname is required.');
+        const formData = new FormData();
+        formData.append('document', document);
+        const headers = {
+            'X-User-Fullname': userFullName,
+        };
+        if (props === null || props === undefined ? undefined : props.sessionId) {
+            headers['X-Session-ID'] = props.sessionId;
+        }
+        if (props === null || props === undefined ? undefined : props.deviceInfo) {
+            headers['X-Device-Info'] = JSON.stringify(props.deviceInfo);
+        }
+        return await this.request('/api-gateway/check-doc-auth', 'POST', formData, headers);
     }
     /**
      * Matches a user's face from video against a reference image.
@@ -116,11 +214,14 @@ class BiometrySDK {
      * @param {string} userFullName - Pass the full name of end-user to process Voice and Face recognition services.
      * @param {string} processVideoRequestId - ID from the response header of /process-video endpoint.
      * @param {boolean} usePrefilledVideo - Pass true to use the video from the process-video endpoint.
-     * @param {string} [requestUserProvidedId] - An optional user-provided ID to link transactions within a unified group.
-     * @returns {Promise<FaceMatchResponse>} - A promise resolving to the voice onboarding response.
+     * @param {Object} [props] - Optional properties for the enrollment request.
+     * @param {string} [props.sessionId] - Session ID to link this enrollment with a specific session group.
+     * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.
+     *                                      This can include properties like operating system, browser, etc.
+     * @returns {Promise<FaceMatchResponse>} - A promise resolving to the voice enrolling response.
      * @throws {Error} - If required parameters are missing or the request fails.
      */
-    async matchFaces(image, video, userFullName, processVideoRequestId, usePrefilledVideo, requestUserProvidedId) {
+    async matchFaces(image, video, userFullName, processVideoRequestId, usePrefilledVideo, props) {
         if (!image)
             throw new Error('Face image is required.');
         if ((!processVideoRequestId && !usePrefilledVideo) && !video)
@@ -140,10 +241,16 @@ class BiometrySDK {
         if (processVideoRequestId && usePrefilledVideo) {
             headers['X-Use-Prefilled-Video'] = 'true';
         }
-        if (requestUserProvidedId) {
-            headers['X-Request-User-Provided-ID'] = requestUserProvidedId;
+        if (props === null || props === undefined ? undefined : props.sessionId) {
+            headers['X-Session-ID'] = props.sessionId;
+        }
+        if (props === null || props === undefined ? undefined : props.deviceInfo) {
+            headers['X-Device-Info'] = JSON.stringify(props.deviceInfo);
+        }
+        if (props === null || props === undefined ? undefined : props.deviceInfo) {
+            headers['X-Device-Info'] = JSON.stringify(props.deviceInfo);
         }
-        return this.request('/api-gateway/match-faces', 'POST', formData, headers);
+        return await this.request('/api-gateway/match-faces', 'POST', formData, headers);
     }
     /**
      * Process the video through Biometry services to check liveness and authorize user
@@ -151,11 +258,13 @@ class BiometrySDK {
      * @param {File} video - Video file that you want to process.
      * @param {string} phrase - Set of numbers that user needs to say out loud in the video.
      * @param {string} userFullName - Pass the full name of end-user to process Voice and Face recognition services.
-     * @param {string} requestUserProvidedId - An optional user-provided ID to link transactions within a unified group.
-     * @param {object} deviceInfo - Pass the device information in JSON format to include in transaction.
-     * @returns
+     * @param {Object} [props] - Optional properties for the enrollment request.
+     * @param {string} [props.sessionId] - Session ID to link this enrollment with a specific session group.
+     * @param {object} [props.deviceInfo] - Device information object containing details about the user's device.
+     *                                      This can include properties like operating system, browser, etc.
+     * @returns {Promise<ApiResponse<ProcessVideoResponse>>} - A promise resolving to the process video response.
      */
-    async processVideo(video, phrase, userFullName, requestUserProvidedId, deviceInfo) {
+    async processVideo(video, phrase, userFullName, props) {
         if (!video)
             throw new Error('Video is required.');
         if (!phrase)
@@ -167,33 +276,33 @@ class BiometrySDK {
         if (userFullName) {
             headers['X-User-Fullname'] = userFullName;
         }
-        if (requestUserProvidedId) {
-            headers['X-Request-User-Provided-ID'] = requestUserProvidedId;
+        if (props === null || props === undefined ? undefined : props.sessionId) {
+            headers['X-Session-ID'] = props.sessionId;
         }
-        if (deviceInfo) {
-            headers['X-Device-Info'] = JSON.stringify(deviceInfo);
+        if (props === null || props === undefined ? undefined : props.deviceInfo) {
+            headers['X-Device-Info'] = JSON.stringify(props.deviceInfo);
         }
-        return this.request('/api-gateway/process-video', 'POST', formData, headers);
+        return await this.request('/api-gateway/process-video', 'POST', formData, headers);
     }
 }
-BiometrySDK.BASE_URL = 'https://api.biometrysolutions.com';
+BiometrySDK.BASE_URL = 'https://api.biometrysolutions.com'; //'https://dev-console.biometrysolutions.com';
 
 var BiometryAttributes;
 (function (BiometryAttributes) {
     BiometryAttributes["ApiKey"] = "api-key";
     BiometryAttributes["UserFullname"] = "user-fullname";
 })(BiometryAttributes || (BiometryAttributes = {}));
-var BiometryOnboardingState;
-(function (BiometryOnboardingState) {
-    BiometryOnboardingState["Loading"] = "loading";
-    BiometryOnboardingState["Success"] = "success";
-    BiometryOnboardingState["ErrorNoFace"] = "error-no-face";
-    BiometryOnboardingState["ErrorMultipleFaces"] = "error-multiple-faces";
-    BiometryOnboardingState["ErrorNotCentered"] = "error-not-centered";
-    BiometryOnboardingState["ErrorOther"] = "error-other";
-})(BiometryOnboardingState || (BiometryOnboardingState = {}));
+var BiometryEnrollmentState;
+(function (BiometryEnrollmentState) {
+    BiometryEnrollmentState["Loading"] = "loading";
+    BiometryEnrollmentState["Success"] = "success";
+    BiometryEnrollmentState["ErrorNoFace"] = "error-no-face";
+    BiometryEnrollmentState["ErrorMultipleFaces"] = "error-multiple-faces";
+    BiometryEnrollmentState["ErrorNotCentered"] = "error-not-centered";
+    BiometryEnrollmentState["ErrorOther"] = "error-other";
+})(BiometryEnrollmentState || (BiometryEnrollmentState = {}));
 
-class BiometryOnboarding extends HTMLElement {
+class BiometryEnrollment extends HTMLElement {
     constructor() {
         super();
         this.videoElement = null;
@@ -244,12 +353,12 @@ class BiometryOnboarding extends HTMLElement {
     validateAttributes() {
         if (!this.apiKey) {
             console.error("API key is required.");
-            this.toggleState(BiometryOnboardingState.ErrorOther);
+            this.toggleState(BiometryEnrollmentState.ErrorOther);
             return;
         }
         if (!this.userFullname) {
             console.error("User fullname is required.");
-            this.toggleState(BiometryOnboardingState.ErrorOther);
+            this.toggleState(BiometryEnrollmentState.ErrorOther);
             return;
         }
     }
@@ -308,18 +417,18 @@ class BiometryOnboarding extends HTMLElement {
             this.sdk = new BiometrySDK(this.apiKey);
         }
         else {
-            this.toggleState(BiometryOnboardingState.ErrorOther);
+            this.toggleState(BiometryEnrollmentState.ErrorOther);
             console.error("API key is required to initialize the SDK.");
         }
     }
     toggleState(state) {
         const slots = [
-            BiometryOnboardingState.Loading,
-            BiometryOnboardingState.Success,
-            BiometryOnboardingState.ErrorNoFace,
-            BiometryOnboardingState.ErrorMultipleFaces,
-            BiometryOnboardingState.ErrorNotCentered,
-            BiometryOnboardingState.ErrorOther,
+            BiometryEnrollmentState.Loading,
+            BiometryEnrollmentState.Success,
+            BiometryEnrollmentState.ErrorNoFace,
+            BiometryEnrollmentState.ErrorMultipleFaces,
+            BiometryEnrollmentState.ErrorNotCentered,
+            BiometryEnrollmentState.ErrorOther,
         ];
         slots.forEach((slotName) => {
             const slot = this.shadow.querySelector(`slot[name="${slotName}"]`);
@@ -379,51 +488,51 @@ class BiometryOnboarding extends HTMLElement {
                 try {
                     if (!blob) {
                         console.error("Failed to capture photo.");
-                        this.toggleState(BiometryOnboardingState.ErrorOther);
+                        this.toggleState(BiometryEnrollmentState.ErrorOther);
                         return;
                     }
                     const file = new File([blob], "onboard-face.jpg", { type: "image/jpeg" });
                     try {
-                        const response = await this.sdk.onboardFace(file, this.userFullname);
-                        const result = response.data.onboard_result;
+                        const response = await this.sdk.enrollFace(file, this.userFullname);
+                        const result = response.body.data.enroll_result;
                         this.resultCode = result === null || result === void 0 ? void 0 : result.code;
                         this.description = (result === null || result === void 0 ? void 0 : result.description) || "Unknown error occurred.";
                         switch (this.resultCode) {
                             case 0:
-                                this.toggleState(BiometryOnboardingState.Success);
+                                this.toggleState(BiometryEnrollmentState.Success);
                                 break;
                             case 1:
-                                this.toggleState(BiometryOnboardingState.ErrorNoFace);
+                                this.toggleState(BiometryEnrollmentState.ErrorNoFace);
                                 break;
                             case 2:
-                                this.toggleState(BiometryOnboardingState.ErrorMultipleFaces);
+                                this.toggleState(BiometryEnrollmentState.ErrorMultipleFaces);
                                 break;
                             case 3:
-                                this.toggleState(BiometryOnboardingState.ErrorNotCentered);
+                                this.toggleState(BiometryEnrollmentState.ErrorNotCentered);
                                 break;
                             default:
-                                this.toggleState(BiometryOnboardingState.ErrorOther);
+                                this.toggleState(BiometryEnrollmentState.ErrorOther);
                         }
-                        console.log("Onboarding result:", result);
+                        console.log("Enrollment result:", result);
                     }
                     catch (error) {
-                        console.error("Error onboarding face:", error);
-                        this.toggleState(BiometryOnboardingState.ErrorOther);
+                        console.error("Error enrolling face:", error);
+                        this.toggleState(BiometryEnrollmentState.ErrorOther);
                     }
                 }
                 catch (error) {
                     console.error("Error in toBlob callback:", error);
-                    this.toggleState(BiometryOnboardingState.ErrorOther);
+                    this.toggleState(BiometryEnrollmentState.ErrorOther);
                 }
             }, "image/jpeg");
         }
         catch (error) {
             console.error("Error capturing photo:", error);
-            this.toggleState(BiometryOnboardingState.ErrorOther);
+            this.toggleState(BiometryEnrollmentState.ErrorOther);
         }
     }
 }
-customElements.define("biometry-onboarding", BiometryOnboarding);
+customElements.define("biometry-enrollment", BiometryEnrollment);
 
 function getDefaultExportFromCjs (x) {
 	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
@@ -1420,4 +1529,4 @@ class ProcessVideoComponent extends HTMLElement {
 }
 customElements.define('process-video', ProcessVideoComponent);
 
-export { BiometryAttributes, BiometryOnboarding, BiometryOnboardingState, BiometrySDK, ProcessVideoComponent };
+export { BiometryEnrollment, BiometrySDK, ProcessVideoComponent };

package/dist/components/biometry-enrollment.d.ts

@@ -0,0 +1,26 @@
+export declare class BiometryEnrollment extends HTMLElement {
+    private readonly shadow;
+    private sdk;
+    private videoElement;
+    private canvasElement;
+    private captureButton;
+    private resultCode?;
+    private description?;
+    constructor();
+    static get observedAttributes(): string[];
+    get apiKey(): string | null;
+    set apiKey(value: string | null);
+    get userFullname(): string | null;
+    set userFullname(value: string | null);
+    attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): void;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    validateAttributes(): void;
+    init(): void;
+    private cleanup;
+    private initializeSDK;
+    private toggleState;
+    private attachSlotListeners;
+    private setupCamera;
+    private capturePhoto;
+}

package/dist/components/biometry-onboarding.d.ts

@@ -1,26 +1 @@
-export declare class BiometryOnboarding extends HTMLElement {
-    private readonly shadow;
-    private sdk;
-    private videoElement;
-    private canvasElement;
-    private captureButton;
-    private resultCode?;
-    private description?;
-    constructor();
-    static get observedAttributes(): string[];
-    get apiKey(): string | null;
-    set apiKey(value: string | null);
-    get userFullname(): string | null;
-    set userFullname(value: string | null);
-    attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): void;
-    connectedCallback(): void;
-    disconnectedCallback(): void;
-    validateAttributes(): void;
-    init(): void;
-    private cleanup;
-    private initializeSDK;
-    private toggleState;
-    private attachSlotListeners;
-    private setupCamera;
-    private capturePhoto;
-}
+export {};