smartcomply-web-sdk 1.0.3

package/dist/utils/constants.js

@@ -0,0 +1,70 @@
+"use strict";
+/**
+ * SDK-wide constants — single source of truth for limits, defaults and
+ * backend-defined magic values.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OVERLAY_Z_INDEX = exports.FINGERPRINT_STORAGE_KEY = exports.RESULT_OVERLAY_DURATION_MS = exports.FACE_DETECT_POLL_MS = exports.FACE_DETECT_TIMEOUT_MS = exports.RECORDING_BITS_PER_SECOND = exports.DOC_CAMERA_IDEAL_HEIGHT = exports.DOC_CAMERA_IDEAL_WIDTH = exports.CAMERA_IDEAL_HEIGHT = exports.CAMERA_IDEAL_WIDTH = exports.POST_ACTION_SETTLE_MS = exports.LIVENESS_TIME_LIMIT_SECONDS = exports.DEFAULT_CHALLENGE_ACTIONS = exports.CHALLENGE_ACTIONS = exports.CAPTURE_JPEG_QUALITY = exports.ACCEPTED_IMAGE_TYPES = exports.MAX_SNAPSHOT_BYTES = exports.MAX_VIDEO_BYTES = exports.MAX_DOCUMENT_BYTES = exports.RETRY_DELAY_MS = exports.MAX_RETRIES = exports.DEFAULT_TIMEOUT_MS = exports.SESSION_WARN_BEFORE_MS = exports.SESSION_TTL_MS = exports.ENDPOINTS = void 0;
+// ── API endpoints ────────────────────────────────────────────────────────────
+exports.ENDPOINTS = {
+    SESSION_CREATE: "/v1/sdk/session/create/",
+    SDK_INITIALIZE: "/v1/sdk/initialize/",
+    ONBOARDING_VERIFY: "/v1/sdk/onboarding/verify/",
+    LIVENESS_CREATE: "/v1/sdk/liveness/create/",
+    LIVENESS_SUBMIT: "/v1/sdk/liveness/submit/",
+    AVAILABLE_CHANNELS: "/v1/sdk/available-channels/",
+};
+// ── Session ──────────────────────────────────────────────────────────────────
+/** Backend session TTL in milliseconds (30 minutes). */
+exports.SESSION_TTL_MS = 30 * 60 * 1000;
+/** Warn the user this many ms before session expires. */
+exports.SESSION_WARN_BEFORE_MS = 2 * 60 * 1000;
+// ── Network ──────────────────────────────────────────────────────────────────
+/** Default request timeout in milliseconds. */
+exports.DEFAULT_TIMEOUT_MS = 30000;
+/** Number of automatic retries on transient network errors. */
+exports.MAX_RETRIES = 2;
+/** Delay between retries in milliseconds. */
+exports.RETRY_DELAY_MS = 1000;
+// ── File uploads ─────────────────────────────────────────────────────────────
+/** Maximum document image size the backend accepts (5 MB). */
+exports.MAX_DOCUMENT_BYTES = 5 * 1024 * 1024;
+/** Maximum video size the backend accepts (50 MB). */
+exports.MAX_VIDEO_BYTES = 50 * 1024 * 1024;
+/** Maximum snapshot / autoshot size (2 MB). */
+exports.MAX_SNAPSHOT_BYTES = 2 * 1024 * 1024;
+/** Accepted MIME types for document images. */
+exports.ACCEPTED_IMAGE_TYPES = ["image/jpeg", "image/png", "image/webp"];
+/** JPEG quality used when encoding captured frames (0–1). */
+exports.CAPTURE_JPEG_QUALITY = 0.92;
+// ── Liveness challenge ───────────────────────────────────────────────────────
+/** Backend-accepted challenge actions (UPPERCASE). */
+exports.CHALLENGE_ACTIONS = ["BLINK", "TURN_LEFT", "TURN_RIGHT", "TURN_HEAD", "OPEN_MOUTH"];
+/** Default set sent when the caller does not specify actions. */
+exports.DEFAULT_CHALLENGE_ACTIONS = ["BLINK", "TURN_LEFT", "OPEN_MOUTH"];
+/** Time limit per liveness attempt in seconds. */
+exports.LIVENESS_TIME_LIMIT_SECONDS = 45;
+/** Milliseconds to pause after all actions before capturing the final snapshot. */
+exports.POST_ACTION_SETTLE_MS = 800;
+// ── Camera ───────────────────────────────────────────────────────────────────
+/** Ideal resolution for the front-facing liveness camera. */
+exports.CAMERA_IDEAL_WIDTH = 640;
+exports.CAMERA_IDEAL_HEIGHT = 480;
+/** Ideal resolution for rear-facing document capture camera. */
+exports.DOC_CAMERA_IDEAL_WIDTH = 1280;
+exports.DOC_CAMERA_IDEAL_HEIGHT = 960;
+/** Video bitrate used by MediaRecorder for liveness recordings (~1.4 MB / 45 s). */
+exports.RECORDING_BITS_PER_SECOND = 250000;
+// ── Face detection ───────────────────────────────────────────────────────────
+/** Max milliseconds to wait for an initial face detection before proceeding. */
+exports.FACE_DETECT_TIMEOUT_MS = 10000;
+/** Polling interval for the face-present check (ms). */
+exports.FACE_DETECT_POLL_MS = 100;
+// ── UI / UX ──────────────────────────────────────────────────────────────────
+/** How long (ms) the success overlay is shown before the flow advances. */
+exports.RESULT_OVERLAY_DURATION_MS = 2800;
+/** localStorage key used to persist the browser fingerprint ID. */
+exports.FINGERPRINT_STORAGE_KEY = "_adhere_fid";
+/** z-index for the SDK overlay — high enough to sit above any app content. */
+exports.OVERLAY_Z_INDEX = 99999;
+//# sourceMappingURL=constants.js.map

package/dist/utils/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/utils/constants.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,gFAAgF;AAEnE,QAAA,SAAS,GAAG;IACvB,cAAc,EAAO,yBAAyB;IAC9C,cAAc,EAAO,qBAAqB;IAC1C,iBAAiB,EAAI,4BAA4B;IACjD,eAAe,EAAM,0BAA0B;IAC/C,eAAe,EAAM,0BAA0B;IAC/C,kBAAkB,EAAG,6BAA6B;CAC1C,CAAC;AAEX,gFAAgF;AAEhF,wDAAwD;AAC3C,QAAA,cAAc,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAE7C,yDAAyD;AAC5C,QAAA,sBAAsB,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;AAEpD,gFAAgF;AAEhF,+CAA+C;AAClC,QAAA,kBAAkB,GAAG,KAAM,CAAC;AAEzC,+DAA+D;AAClD,QAAA,WAAW,GAAG,CAAC,CAAC;AAE7B,6CAA6C;AAChC,QAAA,cAAc,GAAG,IAAK,CAAC;AAEpC,gFAAgF;AAEhF,8DAA8D;AACjD,QAAA,kBAAkB,GAAG,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;AAElD,sDAAsD;AACzC,QAAA,eAAe,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC;AAEhD,+CAA+C;AAClC,QAAA,kBAAkB,GAAG,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;AAElD,+CAA+C;AAClC,QAAA,oBAAoB,GAAG,CAAC,YAAY,EAAE,WAAW,EAAE,YAAY,CAAU,CAAC;AAEvF,6DAA6D;AAChD,QAAA,oBAAoB,GAAG,IAAI,CAAC;AAEzC,gFAAgF;AAEhF,sDAAsD;AACzC,QAAA,iBAAiB,GAAG,CAAC,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,YAAY,CAAU,CAAC;AAE1G,iEAAiE;AACpD,QAAA,yBAAyB,GAAG,CAAC,OAAO,EAAE,WAAW,EAAE,YAAY,CAAU,CAAC;AAEvF,kDAAkD;AACrC,QAAA,2BAA2B,GAAG,EAAE,CAAC;AAE9C,mFAAmF;AACtE,QAAA,qBAAqB,GAAG,GAAG,CAAC;AAEzC,gFAAgF;AAEhF,6DAA6D;AAChD,QAAA,kBAAkB,GAAI,GAAG,CAAC;AAC1B,QAAA,mBAAmB,GAAG,GAAG,CAAC;AAEvC,gEAAgE;AACnD,QAAA,sBAAsB,GAAI,IAAI,CAAC;AAC/B,QAAA,uBAAuB,GAAG,GAAG,CAAC;AAE3C,oFAAoF;AACvE,QAAA,yBAAyB,GAAG,MAAO,CAAC;AAEjD,gFAAgF;AAEhF,gFAAgF;AACnE,QAAA,sBAAsB,GAAG,KAAM,CAAC;AAE7C,wDAAwD;AAC3C,QAAA,mBAAmB,GAAG,GAAG,CAAC;AAEvC,gFAAgF;AAEhF,2EAA2E;AAC9D,QAAA,0BAA0B,GAAG,IAAK,CAAC;AAEhD,mEAAmE;AACtD,QAAA,uBAAuB,GAAG,aAAa,CAAC;AAErD,8EAA8E;AACjE,QAAA,eAAe,GAAG,KAAM,CAAC"}

package/dist/utils/device.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Collects device / browser context metadata.
+ * All values are derived from standard browser APIs — no external library needed.
+ * Sent to the backend at liveness/create so they appear in the webhook
+ * request_context block.
+ */
+export interface DeviceMetadata {
+    device_type: "mobile" | "desktop" | "tablet";
+    os_name: string;
+    browser_timezone: string;
+    fingerprint_id: string;
+}
+export declare function collectDeviceMetadata(): DeviceMetadata;
+//# sourceMappingURL=device.d.ts.map

package/dist/utils/device.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"device.d.ts","sourceRoot":"","sources":["../../src/utils/device.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IAC7C,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;CACxB;AA8BD,wBAAgB,qBAAqB,IAAI,cAAc,CAuBtD"}

package/dist/utils/device.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.collectDeviceMetadata = collectDeviceMetadata;
+function detectOs(ua) {
+    if (/Windows NT/i.test(ua))
+        return "Windows";
+    if (/Mac OS X|Macintosh/i.test(ua))
+        return "macOS";
+    if (/Android/i.test(ua))
+        return "Android";
+    if (/iPhone|iPad|iPod/i.test(ua))
+        return "iOS";
+    if (/Linux/i.test(ua))
+        return "Linux";
+    if (/CrOS/i.test(ua))
+        return "ChromeOS";
+    return "Unknown";
+}
+function getOrCreateFingerprintId() {
+    const KEY = "_adhere_fid";
+    try {
+        let fid = localStorage.getItem(KEY);
+        if (!fid) {
+            fid =
+                typeof crypto !== "undefined" && typeof crypto.randomUUID === "function"
+                    ? crypto.randomUUID()
+                    : Math.random().toString(36).slice(2) + Date.now().toString(36);
+            localStorage.setItem(KEY, fid);
+        }
+        return fid;
+    }
+    catch {
+        // localStorage unavailable (e.g. private browsing with strict settings)
+        return Math.random().toString(36).slice(2) + Date.now().toString(36);
+    }
+}
+function collectDeviceMetadata() {
+    const ua = navigator.userAgent;
+    const isTablet = /iPad/i.test(ua) ||
+        (/Android/i.test(ua) && !/Mobile/i.test(ua));
+    const isMobile = !isTablet &&
+        /Mobi|Android|iPhone|iPod|BlackBerry|IEMobile|Opera Mini/i.test(ua);
+    const device_type = isTablet
+        ? "tablet"
+        : isMobile
+            ? "mobile"
+            : "desktop";
+    return {
+        device_type,
+        os_name: detectOs(ua),
+        browser_timezone: Intl.DateTimeFormat().resolvedOptions().timeZone,
+        fingerprint_id: getOrCreateFingerprintId(),
+    };
+}
+//# sourceMappingURL=device.js.map

package/dist/utils/device.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"device.js","sourceRoot":"","sources":["../../src/utils/device.ts"],"names":[],"mappings":";;AAyCA,sDAuBC;AAnDD,SAAS,QAAQ,CAAC,EAAU;IAC1B,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QAAE,OAAO,SAAS,CAAC;IAC7C,IAAI,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC;QAAE,OAAO,OAAO,CAAC;IACnD,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QAAE,OAAO,SAAS,CAAC;IAC1C,IAAI,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;QAAE,OAAO,KAAK,CAAC;IAC/C,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAAE,OAAO,OAAO,CAAC;IACtC,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAAE,OAAO,UAAU,CAAC;IACxC,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,wBAAwB;IAC/B,MAAM,GAAG,GAAG,aAAa,CAAC;IAC1B,IAAI,CAAC;QACH,IAAI,GAAG,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,GAAG;gBACD,OAAO,MAAM,KAAK,WAAW,IAAI,OAAO,MAAM,CAAC,UAAU,KAAK,UAAU;oBACtE,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE;oBACrB,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACpE,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACjC,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAAC,MAAM,CAAC;QACP,wEAAwE;QACxE,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACvE,CAAC;AACH,CAAC;AAED,SAAgB,qBAAqB;IACnC,MAAM,EAAE,GAAG,SAAS,CAAC,SAAS,CAAC;IAE/B,MAAM,QAAQ,GACZ,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAChB,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAE/C,MAAM,QAAQ,GACZ,CAAC,QAAQ;QACT,0DAA0D,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEtE,MAAM,WAAW,GAAkC,QAAQ;QACzD,CAAC,CAAC,QAAQ;QACV,CAAC,CAAC,QAAQ;YACV,CAAC,CAAC,QAAQ;YACV,CAAC,CAAC,SAAS,CAAC;IAEd,OAAO;QACL,WAAW;QACX,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC;QACrB,gBAAgB,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,eAAe,EAAE,CAAC,QAAQ;QAClE,cAAc,EAAE,wBAAwB,EAAE;KAC3C,CAAC;AACJ,CAAC"}

package/dist/utils/logger.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Lightweight SDK logger.
+ *
+ * Debug output is suppressed in production. Enable verbose logging by calling
+ * SDKLogger.setDebug(true) before initialising the SDK, or by setting the
+ * global flag: window.__SC_DEBUG__ = true
+ */
+export declare const SDKLogger: {
+    /** Emit an informational message (debug mode only). */
+    info(message: string, ...args: unknown[]): void;
+    /** Emit a warning (always visible). */
+    warn(message: string, ...args: unknown[]): void;
+    /** Emit an error (always visible). */
+    error(message: string, ...args: unknown[]): void;
+    /** Emit a debug trace (debug mode only — lowest priority). */
+    debug(message: string, ...args: unknown[]): void;
+    /** Log a timed group of related messages (debug mode only). */
+    group(label: string, fn: () => void): void;
+    /**
+     * Enable or disable verbose debug output at runtime.
+     *
+     * Example:
+     *   import { SDKLogger } from "smartcomply-web-sdk";
+     *   SDKLogger.setDebug(true);
+     */
+    setDebug(enabled: boolean): void;
+};
+//# sourceMappingURL=logger.d.ts.map

package/dist/utils/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/utils/logger.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAYH,eAAO,MAAM,SAAS;IACpB,uDAAuD;kBACzC,MAAM,WAAW,OAAO,EAAE,GAAG,IAAI;IAK/C,uCAAuC;kBACzB,MAAM,WAAW,OAAO,EAAE,GAAG,IAAI;IAI/C,sCAAsC;mBACvB,MAAM,WAAW,OAAO,EAAE,GAAG,IAAI;IAIhD,8DAA8D;mBAC/C,MAAM,WAAW,OAAO,EAAE,GAAG,IAAI;IAKhD,+DAA+D;iBAClD,MAAM,MAAM,MAAM,IAAI,GAAG,IAAI;IAO1C;;;;;;OAMG;sBACe,OAAO,GAAG,IAAI;CAOjC,CAAC"}

package/dist/utils/logger.js

@@ -0,0 +1,67 @@
+"use strict";
+/**
+ * Lightweight SDK logger.
+ *
+ * Debug output is suppressed in production. Enable verbose logging by calling
+ * SDKLogger.setDebug(true) before initialising the SDK, or by setting the
+ * global flag: window.__SC_DEBUG__ = true
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SDKLogger = void 0;
+const PREFIX = "[SmartComply SDK]";
+function isDebugEnabled() {
+    try {
+        return !!window.__SC_DEBUG__;
+    }
+    catch {
+        return false;
+    }
+}
+exports.SDKLogger = {
+    /** Emit an informational message (debug mode only). */
+    info(message, ...args) {
+        if (!isDebugEnabled())
+            return;
+        console.info(`${PREFIX} ℹ ${message}`, ...args);
+    },
+    /** Emit a warning (always visible). */
+    warn(message, ...args) {
+        console.warn(`${PREFIX} ⚠ ${message}`, ...args);
+    },
+    /** Emit an error (always visible). */
+    error(message, ...args) {
+        console.error(`${PREFIX} ✖ ${message}`, ...args);
+    },
+    /** Emit a debug trace (debug mode only — lowest priority). */
+    debug(message, ...args) {
+        if (!isDebugEnabled())
+            return;
+        console.debug(`${PREFIX} ⬡ ${message}`, ...args);
+    },
+    /** Log a timed group of related messages (debug mode only). */
+    group(label, fn) {
+        if (!isDebugEnabled()) {
+            fn();
+            return;
+        }
+        console.group(`${PREFIX} ${label}`);
+        fn();
+        console.groupEnd();
+    },
+    /**
+     * Enable or disable verbose debug output at runtime.
+     *
+     * Example:
+     *   import { SDKLogger } from "smartcomply-web-sdk";
+     *   SDKLogger.setDebug(true);
+     */
+    setDebug(enabled) {
+        try {
+            window.__SC_DEBUG__ = enabled;
+        }
+        catch {
+            /* no-op in non-browser environments */
+        }
+    },
+};
+//# sourceMappingURL=logger.js.map

package/dist/utils/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/utils/logger.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAEH,MAAM,MAAM,GAAG,mBAAmB,CAAC;AAEnC,SAAS,cAAc;IACrB,IAAI,CAAC;QACH,OAAO,CAAC,CAAE,MAAc,CAAC,YAAY,CAAC;IACxC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAEY,QAAA,SAAS,GAAG;IACvB,uDAAuD;IACvD,IAAI,CAAC,OAAe,EAAE,GAAG,IAAe;QACtC,IAAI,CAAC,cAAc,EAAE;YAAE,OAAO;QAC9B,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,MAAM,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IAClD,CAAC;IAED,uCAAuC;IACvC,IAAI,CAAC,OAAe,EAAE,GAAG,IAAe;QACtC,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,MAAM,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IAClD,CAAC;IAED,sCAAsC;IACtC,KAAK,CAAC,OAAe,EAAE,GAAG,IAAe;QACvC,OAAO,CAAC,KAAK,CAAC,GAAG,MAAM,MAAM,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IACnD,CAAC;IAED,8DAA8D;IAC9D,KAAK,CAAC,OAAe,EAAE,GAAG,IAAe;QACvC,IAAI,CAAC,cAAc,EAAE;YAAE,OAAO;QAC9B,OAAO,CAAC,KAAK,CAAC,GAAG,MAAM,MAAM,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IACnD,CAAC;IAED,+DAA+D;IAC/D,KAAK,CAAC,KAAa,EAAE,EAAc;QACjC,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;YAAC,EAAE,EAAE,CAAC;YAAC,OAAO;QAAC,CAAC;QACxC,OAAO,CAAC,KAAK,CAAC,GAAG,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC;QACpC,EAAE,EAAE,CAAC;QACL,OAAO,CAAC,QAAQ,EAAE,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,OAAgB;QACvB,IAAI,CAAC;YACF,MAAc,CAAC,YAAY,GAAG,OAAO,CAAC;QACzC,CAAC;QAAC,MAAM,CAAC;YACP,uCAAuC;QACzC,CAAC;IACH,CAAC;CACF,CAAC"}

package/dist/utils/validator.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Input validation helpers.
+ *
+ * All functions throw a descriptive Error on invalid input so callers can
+ * surface actionable messages without catching generic exceptions.
+ */
+import type { ChallengeAction } from "../types/liveness";
+/** Returns true when s is a non-empty string after trimming. */
+export declare function isNonEmpty(s: unknown): s is string;
+/**
+ * Validates that apiKey looks like a SmartComply public key.
+ * Format: pk_live_<...> or pk_test_<...>
+ */
+export declare function validateApiKey(apiKey: unknown): void;
+/** Throws if clientId is not a valid UUID v4. */
+export declare function validateClientId(clientId: unknown): void;
+/** Throws if countryCode is not a 2-letter ISO 3166-1 alpha-2 code. */
+export declare function validateCountryCode(countryCode: unknown): void;
+/** Throws if the blob is empty or exceeds the given byte limit. */
+export declare function validateFileSize(blob: Blob | File, maxBytes: number, label: string): void;
+/** Throws if the blob's MIME type is not in the accepted image types list. */
+export declare function validateImageType(blob: Blob | File, label: string): void;
+/** Combined validation for a document image blob. */
+export declare function validateDocumentBlob(blob: Blob | File): void;
+/** Combined validation for a liveness video blob. */
+export declare function validateVideoBlob(blob: Blob): void;
+/** Combined validation for a snapshot / autoshot blob. */
+export declare function validateSnapshotBlob(blob: Blob): void;
+/** Throws if any entry in actions is not a backend-accepted challenge action. */
+export declare function validateChallengeActions(actions: unknown[]): void;
+/** Type-guard that narrows a string[] to ChallengeAction[]. */
+export declare function toChallengeActions(actions: string[]): ChallengeAction[];
+/** Throws if identifier is missing or too short to be plausible. */
+export declare function validateIdentifier(identifier: unknown, minLength?: number): void;
+//# sourceMappingURL=validator.d.ts.map

package/dist/utils/validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../../src/utils/validator.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AASH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAIzD,gEAAgE;AAChE,wBAAgB,UAAU,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,MAAM,CAElD;AAID;;;GAGG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CASpD;AAOD,iDAAiD;AACjD,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,OAAO,GAAG,IAAI,CASxD;AAMD,uEAAuE;AACvE,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,OAAO,GAAG,IAAI,CAM9D;AAID,mEAAmE;AACnE,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,IAAI,GAAG,IAAI,EACjB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,GACZ,IAAI,CAUN;AAED,8EAA8E;AAC9E,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAMxE;AAED,qDAAqD;AACrD,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,CAG5D;AAED,qDAAqD;AACrD,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAElD;AAED,0DAA0D;AAC1D,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAErD;AAID,iFAAiF;AACjF,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI,CAWjE;AAED,+DAA+D;AAC/D,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,eAAe,EAAE,CAGvE;AAID,oEAAoE;AACpE,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,OAAO,EAAE,SAAS,SAAI,GAAG,IAAI,CAS3E"}

package/dist/utils/validator.js

@@ -0,0 +1,116 @@
+"use strict";
+/**
+ * Input validation helpers.
+ *
+ * All functions throw a descriptive Error on invalid input so callers can
+ * surface actionable messages without catching generic exceptions.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNonEmpty = isNonEmpty;
+exports.validateApiKey = validateApiKey;
+exports.validateClientId = validateClientId;
+exports.validateCountryCode = validateCountryCode;
+exports.validateFileSize = validateFileSize;
+exports.validateImageType = validateImageType;
+exports.validateDocumentBlob = validateDocumentBlob;
+exports.validateVideoBlob = validateVideoBlob;
+exports.validateSnapshotBlob = validateSnapshotBlob;
+exports.validateChallengeActions = validateChallengeActions;
+exports.toChallengeActions = toChallengeActions;
+exports.validateIdentifier = validateIdentifier;
+const constants_1 = require("./constants");
+// ── String helpers ───────────────────────────────────────────────────────────
+/** Returns true when s is a non-empty string after trimming. */
+function isNonEmpty(s) {
+    return typeof s === "string" && s.trim().length > 0;
+}
+// ── API key ──────────────────────────────────────────────────────────────────
+/**
+ * Validates that apiKey looks like a SmartComply public key.
+ * Format: pk_live_<...> or pk_test_<...>
+ */
+function validateApiKey(apiKey) {
+    if (!isNonEmpty(apiKey)) {
+        throw new Error("SDK: apiKey is required.");
+    }
+    if (!/^pk_(live|test|sandbox)_/.test(apiKey)) {
+        throw new Error('SDK: apiKey must start with "pk_live_", "pk_test_" or "pk_sandbox_".');
+    }
+}
+// ── Client ID (UUID) ─────────────────────────────────────────────────────────
+const UUID_RE = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
+/** Throws if clientId is not a valid UUID v4. */
+function validateClientId(clientId) {
+    if (!isNonEmpty(clientId)) {
+        throw new Error("SDK: clientId is required.");
+    }
+    if (!UUID_RE.test(clientId.trim())) {
+        throw new Error("SDK: clientId must be a valid UUID (e.g. a1b2c3d4-e5f6-7890-abcd-ef1234567890).");
+    }
+}
+// ── Country code ─────────────────────────────────────────────────────────────
+const COUNTRY_CODE_RE = /^[A-Z]{2}$/;
+/** Throws if countryCode is not a 2-letter ISO 3166-1 alpha-2 code. */
+function validateCountryCode(countryCode) {
+    if (!isNonEmpty(countryCode) || !COUNTRY_CODE_RE.test(countryCode.trim())) {
+        throw new Error(`SDK: Invalid country code "${countryCode}". Expected a 2-letter ISO code (e.g. "NG", "GH").`);
+    }
+}
+// ── File / Blob ──────────────────────────────────────────────────────────────
+/** Throws if the blob is empty or exceeds the given byte limit. */
+function validateFileSize(blob, maxBytes, label) {
+    if (!blob || blob.size === 0) {
+        throw new Error(`SDK: ${label} is empty. Please capture or upload a valid file.`);
+    }
+    if (blob.size > maxBytes) {
+        const limitMB = (maxBytes / (1024 * 1024)).toFixed(0);
+        throw new Error(`SDK: ${label} exceeds the ${limitMB} MB limit (file is ${(blob.size / (1024 * 1024)).toFixed(1)} MB).`);
+    }
+}
+/** Throws if the blob's MIME type is not in the accepted image types list. */
+function validateImageType(blob, label) {
+    if (blob.type && !constants_1.ACCEPTED_IMAGE_TYPES.includes(blob.type)) {
+        throw new Error(`SDK: ${label} must be a JPEG, PNG or WebP image (received "${blob.type}").`);
+    }
+}
+/** Combined validation for a document image blob. */
+function validateDocumentBlob(blob) {
+    validateFileSize(blob, constants_1.MAX_DOCUMENT_BYTES, "Document image");
+    validateImageType(blob, "Document image");
+}
+/** Combined validation for a liveness video blob. */
+function validateVideoBlob(blob) {
+    validateFileSize(blob, constants_1.MAX_VIDEO_BYTES, "Liveness video");
+}
+/** Combined validation for a snapshot / autoshot blob. */
+function validateSnapshotBlob(blob) {
+    validateFileSize(blob, constants_1.MAX_SNAPSHOT_BYTES, "Snapshot");
+}
+// ── Challenge actions ─────────────────────────────────────────────────────────
+/** Throws if any entry in actions is not a backend-accepted challenge action. */
+function validateChallengeActions(actions) {
+    if (!Array.isArray(actions) || actions.length === 0) {
+        throw new Error("SDK: At least one challenge action is required.");
+    }
+    for (const a of actions) {
+        if (!constants_1.CHALLENGE_ACTIONS.includes(a)) {
+            throw new Error(`SDK: "${a}" is not a valid challenge action. Accepted: ${constants_1.CHALLENGE_ACTIONS.join(", ")}.`);
+        }
+    }
+}
+/** Type-guard that narrows a string[] to ChallengeAction[]. */
+function toChallengeActions(actions) {
+    validateChallengeActions(actions);
+    return actions;
+}
+// ── Identifier / ID number ────────────────────────────────────────────────────
+/** Throws if identifier is missing or too short to be plausible. */
+function validateIdentifier(identifier, minLength = 3) {
+    if (!isNonEmpty(identifier)) {
+        throw new Error("SDK: identifier is required.");
+    }
+    if (identifier.trim().length < minLength) {
+        throw new Error(`SDK: identifier must be at least ${minLength} characters long.`);
+    }
+}
+//# sourceMappingURL=validator.js.map

package/dist/utils/validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator.js","sourceRoot":"","sources":["../../src/utils/validator.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAcH,gCAEC;AAQD,wCASC;AAQD,4CASC;AAOD,kDAMC;AAKD,4CAcC;AAGD,8CAMC;AAGD,oDAGC;AAGD,8CAEC;AAGD,oDAEC;AAKD,4DAWC;AAGD,gDAGC;AAKD,gDASC;AA7ID,2CAMqB;AAGrB,gFAAgF;AAEhF,gEAAgE;AAChE,SAAgB,UAAU,CAAC,CAAU;IACnC,OAAO,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC;AACtD,CAAC;AAED,gFAAgF;AAEhF;;;GAGG;AACH,SAAgB,cAAc,CAAC,MAAe;IAC5C,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC9C,CAAC;IACD,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,MAAgB,CAAC,EAAE,CAAC;QACvD,MAAM,IAAI,KAAK,CACb,sEAAsE,CACvE,CAAC;IACJ,CAAC;AACH,CAAC;AAED,gFAAgF;AAEhF,MAAM,OAAO,GACX,iEAAiE,CAAC;AAEpE,iDAAiD;AACjD,SAAgB,gBAAgB,CAAC,QAAiB;IAChD,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAChD,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAE,QAAmB,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QAC/C,MAAM,IAAI,KAAK,CACb,iFAAiF,CAClF,CAAC;IACJ,CAAC;AACH,CAAC;AAED,gFAAgF;AAEhF,MAAM,eAAe,GAAG,YAAY,CAAC;AAErC,uEAAuE;AACvE,SAAgB,mBAAmB,CAAC,WAAoB;IACtD,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAE,WAAsB,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QACtF,MAAM,IAAI,KAAK,CACb,8BAA8B,WAAW,oDAAoD,CAC9F,CAAC;IACJ,CAAC;AACH,CAAC;AAED,gFAAgF;AAEhF,mEAAmE;AACnE,SAAgB,gBAAgB,CAC9B,IAAiB,EACjB,QAAgB,EAChB,KAAa;IAEb,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,QAAQ,KAAK,mDAAmD,CAAC,CAAC;IACpF,CAAC;IACD,IAAI,IAAI,CAAC,IAAI,GAAG,QAAQ,EAAE,CAAC;QACzB,MAAM,OAAO,GAAG,CAAC,QAAQ,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACtD,MAAM,IAAI,KAAK,CACb,QAAQ,KAAK,gBAAgB,OAAO,sBAAsB,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CACxG,CAAC;IACJ,CAAC;AACH,CAAC;AAED,8EAA8E;AAC9E,SAAgB,iBAAiB,CAAC,IAAiB,EAAE,KAAa;IAChE,IAAI,IAAI,CAAC,IAAI,IAAI,CAAE,gCAA0C,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAClF,MAAM,IAAI,KAAK,CACb,QAAQ,KAAK,iDAAiD,IAAI,CAAC,IAAI,KAAK,CAC7E,CAAC;IACJ,CAAC;AACH,CAAC;AAED,qDAAqD;AACrD,SAAgB,oBAAoB,CAAC,IAAiB;IACpD,gBAAgB,CAAC,IAAI,EAAE,8BAAkB,EAAE,gBAAgB,CAAC,CAAC;IAC7D,iBAAiB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;AAC5C,CAAC;AAED,qDAAqD;AACrD,SAAgB,iBAAiB,CAAC,IAAU;IAC1C,gBAAgB,CAAC,IAAI,EAAE,2BAAe,EAAE,gBAAgB,CAAC,CAAC;AAC5D,CAAC;AAED,0DAA0D;AAC1D,SAAgB,oBAAoB,CAAC,IAAU;IAC7C,gBAAgB,CAAC,IAAI,EAAE,8BAAkB,EAAE,UAAU,CAAC,CAAC;AACzD,CAAC;AAED,iFAAiF;AAEjF,iFAAiF;AACjF,SAAgB,wBAAwB,CAAC,OAAkB;IACzD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpD,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;IACD,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;QACxB,IAAI,CAAE,6BAAuC,CAAC,QAAQ,CAAC,CAAW,CAAC,EAAE,CAAC;YACpE,MAAM,IAAI,KAAK,CACb,SAAS,CAAC,gDAAgD,6BAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAC1F,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,+DAA+D;AAC/D,SAAgB,kBAAkB,CAAC,OAAiB;IAClD,wBAAwB,CAAC,OAAO,CAAC,CAAC;IAClC,OAAO,OAA4B,CAAC;AACtC,CAAC;AAED,iFAAiF;AAEjF,oEAAoE;AACpE,SAAgB,kBAAkB,CAAC,UAAmB,EAAE,SAAS,GAAG,CAAC;IACnE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAClD,CAAC;IACD,IAAK,UAAqB,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,SAAS,EAAE,CAAC;QACrD,MAAM,IAAI,KAAK,CACb,oCAAoC,SAAS,mBAAmB,CACjE,CAAC;IACJ,CAAC;AACH,CAAC"}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "smartcomply-web-sdk",
+  "version": "1.0.3",
+  "description": "Drop-in identity verification (KYC) widget for web apps — face liveness, NIN/BVN, document verification",
+  "main": "dist/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/index.d.ts",
+  "browser": "dist/smartcomply.browser.js",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "build:browser": "npx esbuild src/index.ts --bundle --format=iife --global-name=SmartComplySDK --outfile=dist/smartcomply.browser.js --target=es2020 --sourcemap",
+    "build:all": "npm run build && npm run build:browser",
+    "demo": "npm run build:all && node mock-api/index.js",
+    "prepublishOnly": "npm run build:all",
+    "typecheck": "tsc --noEmit"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Anitajallas/smartcomply-web-sdk.git"
+  },
+  "keywords": [
+    "smartcomply",
+    "kyc",
+    "identity-verification",
+    "liveness",
+    "face-detection",
+    "onboarding",
+    "sdk",
+    "adhere",
+    "nin",
+    "bvn"
+  ],
+  "author": "SmartComply",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/Anitajallas/smartcomply-web-sdk/issues"
+  },
+  "homepage": "https://github.com/Anitajallas/smartcomply-web-sdk#readme",
+  "devDependencies": {
+    "esbuild": "^0.28.0",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "@mediapipe/tasks-vision": "^0.10.32"
+  }
+}