@smartcomply/web-sdk 1.0.0 → 1.0.2

package/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2026 Smartcomply. All rights reserved.
+
+This software and its source code are the proprietary information of Smartcomply.
+Unauthorized copying, modification, distribution, or any other use of this software without the express written consent of Smartcomply is strictly prohibited.
+
+The use of this SDK is governed by the Smartcomply Terms of Service provided
+at https://adhere.smartcomply.com.

package/README.md

@@ -1,73 +1,80 @@
-# React + TypeScript + Vite
+## @smartcomply/web-sdk
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+The lightweight, secure, and performance-optimized Identity Verification SDK for Smartcomply.
 
-Currently, two official plugins are available:
+### Overview
+The Smartcomply Web SDK provides a seamless identity verification experience. Built with performance in mind, it features:
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+- **Ultra-Lightweight:** Only ~80kB gzipped.
 
-## React Compiler
+- **Encapsulated Styles:** Powered by Shadow DOM to prevent style clashing with your website.
 
-The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
+- **Privacy-First:** Automatic hardware cleanup ensures the camera turns off immediately after use.
 
-## Expanding the ESLint configuration
+- **Framework Agnostic:** Works with React, Vue, Angular, or Vanilla JavaScript.
 
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
-
-```js
-export default defineConfig([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
+### Installation
+```bash
+npm install @smartcomply/web-sdk
+```
 
-      // Remove tseslint.configs.recommended and replace with this
-      tseslint.configs.recommendedTypeChecked,
-      // Alternatively, use this for stricter rules
-      tseslint.configs.strictTypeChecked,
-      // Optionally, add this for stylistic rules
-      tseslint.configs.stylisticTypeChecked,
+**or**
 
-      // Other configs...
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
+```bash
+yarn add @smartcomply/web-sdk
 ```
 
-You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
-
-```js
-// eslint.config.js
-import reactX from 'eslint-plugin-react-x'
-import reactDom from 'eslint-plugin-react-dom'
-
-export default defineConfig([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-      // Enable lint rules for React
-      reactX.configs['recommended-typescript'],
-      // Enable lint rules for React DOM
-      reactDom.configs.recommended,
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
+### Usage
+Integrating the SDK is straightforward. Initialize it with your configuration and launch it.
+
+#### Basic Integration
+```JavaScript
+import AdhereSDK from '@smartcomply/web-sdk';
+
+const sdk = new AdhereSDK({
+  session: 'sessionId',
+  onSuccess: (data) => {
+    console.log('Verification successful:', data);
   },
-])
+  onExpire: () => {
+    console.log('User cancelled verification');
+  },
+  onError: (error) => {
+    console.error('Verification error:', error);
+  }
+});
+
+// To open the SDK
+sdk.launch();
 ```
+
+### Styling & Customization
+The SDK uses a custom prefix (sc:) for its Tailwind-powered UI. Because it resides in a Shadow DOM, your global CSS will not affect the SDK, and the SDK's styles will not leak into your application.
+
+### Security & Privacy
+- **Camera Permissions:** The SDK only requests camera access during the liveness detection phase.
+
+- **Resource Management:** Hardware streams are automatically released upon session expiry or user exit.
+
+- **Data Encryption:** All verification data is encrypted in transit.
+
+
+### License
+Copyright © 2026 Smartcomply. All rights reserved.
+This software and its source code are the proprietary information of Smartcomply.
+Unauthorized copying, modification, distribution, or any other use of this software without the express written consent of Smartcomply is strictly prohibited.
+
+The use of this SDK is governed by the Smartcomply Terms of Service provided at https://adhere.smartcomply.com.
+
+### Contributors
+
+##### This SDK is developed and maintained by the Smartcomply Engineering Team.
+
+<a href="https://github.com/titoadeoye">
+  <img src="https://avatars.githubusercontent.com/titoadeoye?s=80" 
+       alt="Tito Adeoye" 
+       width="100" 
+       style="border-radius:50%;" />
+</a>
+
+---

package/dist/client/Config.d.ts

@@ -0,0 +1,8 @@
+export declare const BASE_URL: string;
+export interface SDKConfig {
+    timeout?: number;
+    session: string;
+    onSuccess?: (data: any) => void;
+    onError?: (error: any) => void;
+    onExpire?: () => void;
+}

package/dist/client/HttpClient.d.ts

@@ -0,0 +1,13 @@
+import { SDKConfig } from './Config';
+export declare class HttpClient {
+    private baseUrl;
+    private timeout;
+    private session;
+    private onError;
+    private destroy;
+    constructor(config: SDKConfig, destroy?: Function);
+    request<T>(method: string, path: string, body?: unknown, headers?: Record<string, string>): Promise<T>;
+    post<T>(path: string, data: any, headers?: Record<string, string>): Promise<T>;
+    patch<T>(path: string, data: any, headers?: Record<string, string>): Promise<T>;
+    get<T>(path: string): Promise<T>;
+}

package/dist/components/MainSDKFlow.d.ts

@@ -0,0 +1,6 @@
+import { default as SmartComply } from '../main';
+type Props = {
+    sdkInstance: SmartComply;
+};
+declare const MainSDKFlow: ({ sdkInstance }: Props) => import("react/jsx-runtime").JSX.Element;
+export default MainSDKFlow;

package/dist/components/steps/IdentityForm.d.ts

@@ -0,0 +1,10 @@
+import { SDK, TSDKTheme } from '../../utils/types';
+type Props = {
+    config: SDK;
+    onSubmit: (identifier: string, identifier_type: string, country: string) => void;
+    selectedTheme: TSDKTheme;
+    handleIdUpdate: (file: File | undefined, cropped: File | undefined) => void;
+    idFile: File | undefined;
+};
+export default function IdentityForm({ config, selectedTheme, onSubmit, handleIdUpdate, idFile, }: Props): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/steps/LivenessFlow.d.ts

@@ -0,0 +1,13 @@
+import { SDKConfig } from '../../client/Config';
+import { IDConfirmationFormPayload, SDK } from '../../utils/types';
+interface Props {
+    sdkInstance: SDKConfig;
+    updateStep: (step: string) => void;
+    config: SDK;
+    idFile: File | undefined;
+    snapshotFile: File | undefined;
+    identityFormData: IDConfirmationFormPayload | undefined;
+    handleDetectionPass: () => void;
+}
+declare const LivenessFlow: ({ sdkInstance, updateStep, config, idFile, snapshotFile, identityFormData, handleDetectionPass }: Props) => import("react/jsx-runtime").JSX.Element;
+export default LivenessFlow;

package/dist/components/steps/LivenessPreCheck.d.ts

@@ -0,0 +1,8 @@
+import { SDK, TSDKTheme } from '../../utils/types';
+type Props = {
+    config: SDK;
+    onStart: () => void;
+    selectedTheme: TSDKTheme;
+};
+export default function LivenessPreCheck({ selectedTheme, onStart }: Props): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/steps/LoadingScreen.d.ts

@@ -0,0 +1,6 @@
+import { TSDKTheme } from '../../utils/types';
+type Props = {
+    selectedTheme: TSDKTheme;
+};
+export default function LoadingScreen({ selectedTheme }: Props): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/steps/SuccessConfirmation.d.ts

@@ -0,0 +1,6 @@
+type Props = {
+    redirect_url?: string;
+    destroy: () => void;
+};
+export default function SuccessConfirmation({ redirect_url, destroy }: Props): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/steps/UploadingScreen.d.ts

@@ -0,0 +1,6 @@
+type Props = {
+    onComplete: () => void;
+    canClose: boolean;
+};
+export default function UploadingScreen({ onComplete, canClose }: Props): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/steps/WelcomeScreen.d.ts

@@ -0,0 +1,8 @@
+import { SDK, TSDKTheme } from '../../utils/types';
+type Props = {
+    config: SDK;
+    onNext: () => void;
+    selectedTheme: TSDKTheme;
+};
+export default function WelcomeScreen({ config, selectedTheme, onNext, }: Props): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/ui/Dropdown.d.ts

@@ -0,0 +1,14 @@
+import { TSDKTheme } from '../../utils/types';
+export interface DropdownOption {
+    label: string;
+    value: string;
+}
+interface DropdownProps {
+    options: DropdownOption[];
+    value: string;
+    onChange: (value: string) => void;
+    selectedTheme: TSDKTheme;
+    placeholder?: string;
+}
+export default function Dropdown({ options, value, onChange, selectedTheme, placeholder, }: DropdownProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/ui/SessionTimeout.d.ts

@@ -0,0 +1,4 @@
+export default function SessionTimeout({ destroy, onExpire }: {
+    destroy: Function;
+    onExpire?: Function;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/components/ui/toast/ToastContainer.d.ts

@@ -0,0 +1 @@
+export default function ToastContainer(): import("react/jsx-runtime").JSX.Element;

package/dist/components/ui/toast/index.d.ts

@@ -0,0 +1,15 @@
+type ToastType = "success" | "error" | "loading";
+export interface ToastItem {
+    id: string;
+    message: string;
+    type: ToastType;
+}
+type Listener = (toasts: ToastItem[]) => void;
+export declare const toast: {
+    subscribe(listener: Listener): () => void;
+    success(message: string): void;
+    error(message: string): void;
+    loading(message: string): `${string}-${string}-${string}-${string}-${string}`;
+    dismiss(id?: string): void;
+};
+export {};

package/dist/index.d.ts

@@ -1,34 +1,4 @@
-interface SDKConfig {
-    timeout?: number;
-    session: string;
-    onSuccess?: (data: any) => void;
-    onError?: (error: any) => void;
-    onExpire?: () => void;
-}
-
-declare class HttpClient {
-    private baseUrl;
-    private timeout;
-    private session;
-    private onError;
-    private destroy;
-    constructor(config: SDKConfig, destroy?: Function);
-    request<T>(method: string, path: string, body?: unknown, headers?: Record<string, string>): Promise<T>;
-    post<T>(path: string, data: any, headers?: Record<string, string>): Promise<T>;
-    patch<T>(path: string, data: any, headers?: Record<string, string>): Promise<T>;
-    get<T>(path: string): Promise<T>;
-}
-
-declare class SmartComply {
-    private http;
-    private config;
-    private root;
-    private containerId;
-    constructor(config: SDKConfig);
-    getConfig(): SDKConfig;
-    getHttp(): HttpClient;
-    launch(): void;
-    destroy: () => void;
-}
-
-export { type SDKConfig, SmartComply, SmartComply as default };
+import { default as SmartComply } from './main';
+export default SmartComply;
+export { SmartComply };
+export type { SDKConfig } from './client/Config';