biometry-sdk 1.2.2 → 1.2.3

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

@@ -1 +1,26 @@
-export {};
+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;
+}

package/dist/components/process-video.d.ts

@@ -0,0 +1,53 @@
+export declare class ProcessVideoComponent extends HTMLElement {
+    private sdk;
+    private apiKey;
+    private phrase;
+    private previewStream;
+    private recordedChunks;
+    private mediaRecorder;
+    private videoFile;
+    private startTime;
+    private timerInterval;
+    private recordingTimeout;
+    private videoElement;
+    private fileInput;
+    private recordButton;
+    private stopButton;
+    private submitButton;
+    private errorState;
+    private timeLimit;
+    constructor();
+    private initializeSDK;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): void;
+    private generateDefaultPhrase;
+    initializeUI(): void;
+    private attachSlotListeners;
+    private getSlotElement;
+    replaceSlotContent(slotName: string, content: string | HTMLElement): void;
+    removeSlotListener(slotName: string, event: string, callback: EventListener): void;
+    private toggleState;
+    private convertPhraseToWords;
+    private setupPreview;
+    private startTimer;
+    private stopTimer;
+    startRecording(): Promise<void>;
+    stopRecording(): void;
+    private onStopMediaRecorder;
+    private handleFileUpload;
+    handleSubmit(): Promise<void>;
+    static get observedAttributes(): string[];
+    get userFullname(): string | null;
+    set userFullname(value: string | null);
+    get isRecording(): boolean;
+    get currentPhrase(): string;
+    get videoDuration(): number | null;
+    get currentFile(): File | null;
+    get currentStream(): MediaStream | null;
+    set sdkInstance(newSdk: any);
+    get videoElementRef(): HTMLVideoElement;
+    get fileInputRef(): HTMLInputElement;
+    get recordingTimeLimit(): number;
+    set recordingTimeLimit(value: number);
+}

package/dist/index.d.ts

@@ -1,2 +1,4 @@
 export * from './sdk';
 export * from './types';
+export { BiometryOnboarding } from './components/biometry-onboarding';
+export { ProcessVideoComponent } from './components/process-video';

package/package.json

@@ -1,21 +1,31 @@
 {
   "name": "biometry-sdk",
-  "version": "1.2.2",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "version": "1.2.3",
+  "type": "module",
+  "main": "dist/biometry-sdk.cjs.js",
+  "module": "dist/biometry-sdk.esm.js",
+  "browser": "dist/biometry-sdk.umd.js",
   "files": [
     "dist/**/*",
     "README.md"
   ],
   "scripts": {
-    "build": "tsc",
+    "build": "rollup -c",
     "test": "jest"
   },
   "devDependencies": {
+    "@rollup/plugin-commonjs": "^28.0.2",
+    "@rollup/plugin-node-resolve": "^16.0.0",
+    "@rollup/plugin-typescript": "^12.1.2",
     "@types/jest": "^29.5.14",
     "jest": "^29.7.0",
+    "rollup": "^4.34.0",
     "ts-jest": "^29.2.5",
-    "typescript": "^5.0.0"
+    "tslib": "^2.8.1",
+    "typescript": "^5.7.3"
   },
-  "license": "MIT"
+  "license": "MIT",
+  "dependencies": {
+    "fix-webm-duration": "^1.0.6"
+  }
 }

package/dist/components/biometry-onboarding.js

@@ -1,233 +0,0 @@
-import { BiometrySDK } from "../sdk.js";
-import { BiometryAttributes, BiometryOnboardingState } from "../types.js";
-class BiometryOnboarding extends HTMLElement {
-    constructor() {
-        super();
-        this.videoElement = null;
-        this.canvasElement = null;
-        this.captureButton = null;
-        this.shadow = this.attachShadow({ mode: "open" });
-        this.sdk = null;
-        this.toggleState = this.toggleState.bind(this);
-        this.capturePhoto = this.capturePhoto.bind(this);
-    }
-    static get observedAttributes() {
-        return Object.values(BiometryAttributes);
-    }
-    get apiKey() {
-        return this.getAttribute("api-key");
-    }
-    set apiKey(value) {
-        if (value) {
-            this.setAttribute("api-key", value);
-        }
-        else {
-            this.removeAttribute("api-key");
-        }
-    }
-    get userFullname() {
-        return this.getAttribute("user-fullname");
-    }
-    set userFullname(value) {
-        if (value) {
-            this.setAttribute("user-fullname", value);
-        }
-        else {
-            this.removeAttribute("user-fullname");
-        }
-    }
-    attributeChangedCallback(name, oldValue, newValue) {
-        if (name === "api-key" || name === "user-fullname") {
-            this.validateAttributes();
-        }
-    }
-    connectedCallback() {
-        this.validateAttributes();
-        this.init();
-    }
-    disconnectedCallback() {
-        this.cleanup();
-    }
-    validateAttributes() {
-        if (!this.apiKey) {
-            console.error("API key is required.");
-            this.toggleState(BiometryOnboardingState.ErrorOther);
-            return;
-        }
-        if (!this.userFullname) {
-            console.error("User fullname is required.");
-            this.toggleState(BiometryOnboardingState.ErrorOther);
-            return;
-        }
-    }
-    init() {
-        this.shadow.innerHTML = `
-    <style>
-      .wrapper {
-        position: relative;
-      }
-      video {
-        transform: scaleX(-1); /* Flip video for preview */
-        max-width: 100%;
-        border-radius: var(--border-radius, 8px);
-      }
-      canvas {
-        display: none;
-      }
-    </style>
-    <div class="wrapper">
-      <slot name="video">
-        <video id="video" autoplay playsinline></video>
-      </slot>
-      <slot name="canvas">
-        <canvas id="canvas" style="display: none;"></canvas>
-      </slot>
-      <slot name="button">
-        <button id="button">Capture Photo</button>
-      </slot>
-      <div class="status">
-        <slot name="loading" class="loading"></slot>
-        <slot name="success" class="success"></slot>
-        <slot name="error-no-face" class="error-no-face"></slot>
-        <slot name="error-multiple-faces" class="error-multiple-faces"></slot>
-        <slot name="error-not-centered" class="error-not-centered"></slot>
-        <slot name="error-other" class="error-other"></slot>
-      </div>
-    </div>
-  `;
-        this.initializeSDK();
-        this.attachSlotListeners();
-        this.setupCamera();
-        this.toggleState("");
-    }
-    cleanup() {
-        var _a;
-        if ((_a = this.videoElement) === null || _a === void 0 ? void 0 : _a.srcObject) {
-            const tracks = this.videoElement.srcObject.getTracks();
-            tracks.forEach((track) => track.stop());
-        }
-        if (this.videoElement) {
-            this.videoElement.srcObject = null;
-        }
-    }
-    initializeSDK() {
-        if (this.apiKey) {
-            this.sdk = new BiometrySDK(this.apiKey);
-        }
-        else {
-            this.toggleState(BiometryOnboardingState.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,
-        ];
-        slots.forEach((slotName) => {
-            const slot = this.shadow.querySelector(`slot[name="${slotName}"]`);
-            if (slot) {
-                slot.style.display = slotName === state ? "block" : "none";
-            }
-        });
-    }
-    attachSlotListeners() {
-        const videoSlot = this.shadow.querySelector('slot[name="video"]');
-        const canvasSlot = this.shadow.querySelector('slot[name="canvas"]');
-        const buttonSlot = this.shadow.querySelector('slot[name="button"]');
-        const assignedVideoElements = videoSlot.assignedElements();
-        this.videoElement = (assignedVideoElements.length > 0 ? assignedVideoElements[0] : null) || this.shadow.querySelector("#video");
-        const assignedCanvasElements = canvasSlot.assignedElements();
-        this.canvasElement = (assignedCanvasElements.length > 0 ? assignedCanvasElements[0] : null) || this.shadow.querySelector("#canvas");
-        const assignedButtonElements = buttonSlot.assignedElements();
-        this.captureButton = (assignedButtonElements.length > 0 ? assignedButtonElements[0] : null) || this.shadow.querySelector("#button");
-        if (!this.videoElement) {
-            console.error("Video element is missing.");
-            return;
-        }
-        if (!this.captureButton) {
-            console.error("Capture button is missing.");
-            return;
-        }
-        else {
-            this.captureButton.addEventListener("click", this.capturePhoto);
-        }
-    }
-    setupCamera() {
-        if (!this.videoElement) {
-            console.error("Video element is missing.");
-            return;
-        }
-        navigator.mediaDevices
-            .getUserMedia({ video: true })
-            .then((stream) => {
-            this.videoElement.srcObject = stream;
-        })
-            .catch((error) => {
-            console.error("Error accessing camera:", error);
-        });
-    }
-    async capturePhoto() {
-        try {
-            if (!this.videoElement || !this.canvasElement || !this.sdk) {
-                console.error("Essential elements or SDK are not initialized.");
-                return;
-            }
-            const context = this.canvasElement.getContext("2d");
-            this.canvasElement.width = this.videoElement.videoWidth;
-            this.canvasElement.height = this.videoElement.videoHeight;
-            context.drawImage(this.videoElement, 0, 0, this.canvasElement.width, this.canvasElement.height);
-            this.toggleState("loading");
-            this.canvasElement.toBlob(async (blob) => {
-                try {
-                    if (!blob) {
-                        console.error("Failed to capture photo.");
-                        this.toggleState(BiometryOnboardingState.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;
-                        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);
-                                break;
-                            case 1:
-                                this.toggleState(BiometryOnboardingState.ErrorNoFace);
-                                break;
-                            case 2:
-                                this.toggleState(BiometryOnboardingState.ErrorMultipleFaces);
-                                break;
-                            case 3:
-                                this.toggleState(BiometryOnboardingState.ErrorNotCentered);
-                                break;
-                            default:
-                                this.toggleState(BiometryOnboardingState.ErrorOther);
-                        }
-                        console.log("Onboarding result:", result);
-                    }
-                    catch (error) {
-                        console.error("Error onboarding face:", error);
-                        this.toggleState(BiometryOnboardingState.ErrorOther);
-                    }
-                }
-                catch (error) {
-                    console.error("Error in toBlob callback:", error);
-                    this.toggleState(BiometryOnboardingState.ErrorOther);
-                }
-            }, "image/jpeg");
-        }
-        catch (error) {
-            console.error("Error capturing photo:", error);
-            this.toggleState(BiometryOnboardingState.ErrorOther);
-        }
-    }
-}
-customElements.define("biometry-onboarding", BiometryOnboarding);

package/dist/index.js

@@ -1,2 +0,0 @@
-export * from './sdk';
-export * from './types';

package/dist/sdk.js

@@ -1,179 +0,0 @@
-export class BiometrySDK {
-    constructor(apiKey) {
-        if (!apiKey) {
-            throw new Error('API Key is required to initialize the SDK.');
-        }
-        this.apiKey = apiKey;
-    }
-    async request(path, method, body, headers) {
-        const defaultHeaders = {
-            Authorization: `Bearer ${this.apiKey}`,
-        };
-        const requestHeaders = Object.assign(Object.assign({}, defaultHeaders), headers);
-        if (body && !(body instanceof FormData)) {
-            requestHeaders['Content-Type'] = 'application/json';
-            body = JSON.stringify(body);
-        }
-        const response = await fetch(`${BiometrySDK.BASE_URL}${path}`, {
-            method,
-            headers: requestHeaders,
-            body,
-        });
-        if (!response.ok) {
-            const errorData = await response.json().catch(() => ({}));
-            const errorMessage = (errorData === null || errorData === void 0 ? void 0 : errorData.error) || (errorData === null || errorData === void 0 ? void 0 : errorData.message) || 'Unknown error occurred';
-            throw new Error(`Error ${response.status}: ${errorMessage}`);
-        }
-        return await response.json();
-    }
-    /**
-     * Submits consent for a user.
-     *
-     * @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.
-     * @throws {Error} - If the user's full name is not provided or if the request fails.
-     */
-    async giveConsent(isConsentGiven, userFullName) {
-        if (!userFullName) {
-            throw new Error('User Full Name is required to give consent.');
-        }
-        const body = {
-            is_consent_given: isConsentGiven,
-            user_fullname: userFullName,
-        };
-        const response = await this.request('/api-consent/consent', 'POST', body);
-        return {
-            is_consent_given: response.is_consent_given,
-            user_fullname: response.user_fullname,
-        };
-    }
-    /**
-     * Onboards 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} 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.
-     * @throws {Error} - If required parameters are missing or the request fails.
-     */
-    async onboardVoice(audio, userFullName, uniqueId, phrase, requestUserProvidedId) {
-        if (!userFullName)
-            throw new Error('User fullname is required.');
-        if (!uniqueId)
-            throw new Error('Unique ID is required.');
-        if (!phrase)
-            throw new Error('Phrase is required.');
-        if (!audio)
-            throw new Error('Audio file is required.');
-        const formData = new FormData();
-        formData.append('unique_id', uniqueId);
-        formData.append('phrase', phrase);
-        formData.append('voice', audio);
-        const headers = {
-            'X-User-Fullname': userFullName,
-        };
-        if (requestUserProvidedId) {
-            headers['X-Request-User-Provided-ID'] = requestUserProvidedId;
-        }
-        return this.request('/api-gateway/onboard/voice', 'POST', formData, headers);
-    }
-    /**
-     * Onboards 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} 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.
-     * @throws {Error} - If required parameters are missing or the request fails.
-     */
-    async onboardFace(face, userFullName, isDocument, requestUserProvidedId) {
-        if (!userFullName)
-            throw new Error('User fullname is required.');
-        if (!face)
-            throw new Error('Face image is required.');
-        const formData = new FormData();
-        formData.append('face', face);
-        if (isDocument) {
-            formData.append('is_document', 'true');
-        }
-        const headers = {
-            'X-User-Fullname': userFullName,
-        };
-        if (requestUserProvidedId) {
-            headers['X-Request-User-Provided-ID'] = requestUserProvidedId;
-        }
-        return this.request('/api-gateway/onboard/face', 'POST', formData, headers);
-    }
-    /**
-     * Matches a user's face from video against a reference image.
-     *
-     * @param {File} image - Reference image file that contains user's face.
-     * @param {string} video - Video file that contains user's face.
-     * @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.
-     * @throws {Error} - If required parameters are missing or the request fails.
-     */
-    async matchFaces(image, video, userFullName, processVideoRequestId, usePrefilledVideo, requestUserProvidedId) {
-        if (!image)
-            throw new Error('Face image is required.');
-        if ((!processVideoRequestId && !usePrefilledVideo) && !video)
-            throw new Error('Video is required.');
-        const formData = new FormData();
-        if (video) {
-            formData.append('video', video);
-        }
-        formData.append('image', image);
-        const headers = {};
-        if (userFullName) {
-            headers['X-User-Fullname'] = userFullName;
-        }
-        if (processVideoRequestId) {
-            headers['X-Request-Id'] = processVideoRequestId;
-        }
-        if (processVideoRequestId && usePrefilledVideo) {
-            headers['X-Use-Prefilled-Video'] = 'true';
-        }
-        if (requestUserProvidedId) {
-            headers['X-Request-User-Provided-ID'] = requestUserProvidedId;
-        }
-        return this.request('/api-gateway/match-faces', 'POST', formData, headers);
-    }
-    /**
-     * Process the video through Biometry services to check liveness and authorize user
-     *
-     * @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
-     */
-    async processVideo(video, phrase, userFullName, requestUserProvidedId, deviceInfo) {
-        if (!video)
-            throw new Error('Video is required.');
-        if (!phrase)
-            throw new Error('Phrase is required.');
-        const formData = new FormData();
-        formData.append('phrase', phrase);
-        formData.append('video', video);
-        const headers = {};
-        if (userFullName) {
-            headers['X-User-Fullname'] = userFullName;
-        }
-        if (requestUserProvidedId) {
-            headers['X-Request-User-Provided-ID'] = requestUserProvidedId;
-        }
-        if (deviceInfo) {
-            headers['X-Device-Info'] = JSON.stringify(deviceInfo);
-        }
-        return this.request('/api-gateway/process-video', 'POST', formData, headers);
-    }
-}
-BiometrySDK.BASE_URL = 'https://api.biometrysolutions.com';