@zerohash-sdk/onboarding-react 1.1.0

package/README.md

@@ -0,0 +1,144 @@
+# @zerohash-sdk/onboarding-react
+
+A React SDK that enables frontend React applications to seamlessly integrate with the Connect Onboarding product.
+
+Connect Onboarding provides a secure, customizable KYC/onboarding flow for new users directly within your application.
+
+## Requirements
+
+- React 18.0.0 or higher
+- React DOM 18.0.0 or higher
+
+## Installation
+
+```bash
+npm install @zerohash-sdk/onboarding-react
+```
+
+## Getting Started
+
+Follow these simple steps to integrate Connect Onboarding into your React application:
+
+### 1. Import the Onboarding Component
+
+```tsx
+import { Onboarding } from '@zerohash-sdk/onboarding-react';
+```
+
+### 2. Add the Onboarding Component to Your App
+
+```tsx
+function App() {
+  const jwt = 'your-jwt-token'; // Obtain this from your backend
+
+  return (
+    <Onboarding
+      jwt={jwt}
+      env="prod" // or "cert" for testing
+      theme="auto" // 'auto' (default), 'light', or 'dark'
+    />
+  );
+}
+```
+
+### 3. Configure Event Callbacks (Optional)
+
+Listen to events from the Onboarding SDK to handle user interactions:
+
+```tsx
+function App() {
+  const jwt = 'your-jwt-token';
+
+  const handleCompleted = ({ participantCode, kycStatus }) => {
+    console.log('Onboarding completed:', participantCode, kycStatus);
+  };
+
+  const handleError = ({ errorCode, reason }) => {
+    console.log('Onboarding error:', errorCode, 'Reason:', reason);
+  };
+
+  const handleClose = () => {
+    console.log('Onboarding widget closed');
+  };
+
+  const handleEvent = ({ type, data }) => {
+    console.log('Onboarding event:', type, 'Data:', data);
+  };
+
+  const handleLoaded = () => {
+    console.log('Onboarding widget loaded and ready');
+  };
+
+  return (
+    <Onboarding
+      jwt={jwt}
+      env="prod"
+      theme="auto"
+      onCompleted={handleCompleted}
+      onError={handleError}
+      onClose={handleClose}
+      onEvent={handleEvent}
+      onLoaded={handleLoaded}
+    />
+  );
+}
+```
+
+## Complete Example
+
+```tsx
+import React from 'react';
+import { Onboarding } from '@zerohash-sdk/onboarding-react';
+
+function App() {
+  const jwt = 'your-jwt-token';
+
+  return (
+    <div className="App">
+      <h1>My App</h1>
+
+      <Onboarding
+        jwt={jwt}
+        env="prod" // 'prod' (default), 'cert', 'dev', or 'local'
+        theme="auto" // 'auto' (default), 'light', or 'dark'
+        onCompleted={({ participantCode, kycStatus }) => {
+          console.log('Completed:', participantCode, kycStatus);
+        }}
+        onError={({ errorCode, reason }) => {
+          console.log('Error:', errorCode, 'Reason:', reason);
+        }}
+        onClose={() => {
+          console.log('Onboarding widget closed');
+        }}
+        onEvent={({ type, data }) => {
+          console.log('Event type:', type, 'Event data:', data);
+        }}
+        onLoaded={() => {
+          console.log('Onboarding widget loaded and ready');
+        }}
+      />
+    </div>
+  );
+}
+
+export default App;
+```
+
+## API Reference
+
+### Onboarding Component Props
+
+| Prop          | Type                                       | Required | Default  | Description                                     |
+| ------------- | ------------------------------------------ | -------- | -------- | ----------------------------------------------- |
+| `jwt`         | `string`                                   | Yes      | -        | JWT token for authentication with Connect       |
+| `env`         | `"prod" \| "cert" \| "dev" \| "local"`     | No       | `"prod"` | Target environment                              |
+| `theme`       | `"auto" \| "light" \| "dark"`              | No       | `"auto"` | Theme mode for the interface                    |
+| `onCompleted` | `({ participantCode, kycStatus }) => void` | No       | -        | Callback when onboarding completes successfully |
+| `onError`     | `({ errorCode, reason }) => void`          | No       | -        | Callback for error events                       |
+| `onClose`     | `() => void`                               | No       | -        | Callback when the widget is closed              |
+| `onEvent`     | `({ type, data }) => void`                 | No       | -        | Callback for general events                     |
+| `onLoaded`    | `() => void`                               | No       | -        | Callback when the widget is loaded and ready    |
+
+## More Information & Support
+
+For comprehensive documentation or support about Connect, visit our [Documentation Page](https://docs.zerohash.com/).

package/dist/index.d.ts

@@ -0,0 +1,235 @@
+import { default as default_2 } from 'react';
+
+/**
+ * Generic app event structure
+ * @template TType - Event type string
+ * @template TData - Event data payload
+ */
+declare type AppEvent<TType extends string = string, TData = Record<string, unknown>> = {
+    /** The type of event that occurred */
+    type: TType;
+    /** Data associated with the event */
+    data: TData;
+};
+
+/**
+ * Available environments for the Connect Onboarding service.
+ *
+ * - `"local"` - Local development environment (http://localhost:4204)
+ * - `"dev"` - Development environment for early-stage testing
+ * - `"cert"` - Certificate/staging environment for integration testing
+ * - `"prod"` - Live production environment for real applications
+ */
+declare type Environment = 'local' | 'dev' | 'cert' | 'prod';
+
+/**
+ * Generic error codes for all Connect applications
+ */
+declare enum ErrorCode {
+    /** Network connectivity error */
+    NETWORK_ERROR = 'network_error',
+    /** Authentication or session expired error */
+    AUTH_ERROR = 'auth_error',
+    /** Resource not found error */
+    NOT_FOUND_ERROR = 'not_found_error',
+    /** Validation error from user input */
+    VALIDATION_ERROR = 'validation_error',
+    /** Server error (5xx) */
+    SERVER_ERROR = 'server_error',
+    /** Client error (4xx) */
+    CLIENT_ERROR = 'client_error',
+    /** Unknown or unexpected error */
+    UNKNOWN_ERROR = 'unknown_error',
+}
+
+/**
+ * Generic error payload structure for error callbacks
+ */
+declare type ErrorPayload = {
+    /** Error code indicating the type of error */
+    errorCode: ErrorCode;
+    /** Human-readable reason for the error */
+    reason: string;
+};
+
+/**
+ * A React wrapper component for the Connect Onboarding product.
+ *
+ * @param props - Component properties
+ * @param jwt - JWT token for authentication (required)
+ * @param env - Target environment ("local" | "dev" | "cert" | "prod", defaults to "prod")
+ * @param theme - Theme mode ("auto" | "light" | "dark", defaults to "auto")
+ * @param onCompleted - Callback invoked when the sell flow is successfully completed
+ * @param onError - Callback invoked when an error occurs
+ * @param onClose - Callback invoked when the user closes the widget
+ * @param onLoaded - Callback invoked when the widget has finished loading
+ * @param onEvent - Callback invoked for general application events
+ *
+ * @example
+ * ```tsx
+ * // Basic usage with production environment (default)
+ * <Onboarding jwt="your-jwt-token" />
+ *
+ * // Using cert environment for testing
+ * <Onboarding jwt="your-jwt-token" env="cert" />
+ *
+ * // Force dark theme
+ * <Onboarding jwt="your-jwt-token" theme="dark" />
+ *
+ * // With callback functions
+ * <Onboarding
+ *   jwt="your-jwt-token"
+ *   theme="auto"
+ *   onLoaded={() => console.log('Crypto sell loaded and ready')}
+ *   onCompleted={({ amountSold, assetSymbol }) => console.log('Sold', amountSold, assetSymbol)}
+ *   onClose={() => console.log('Crypto sell closed')}
+ *   onError={({ errorCode, reason }) => console.error('Error:', errorCode, reason)}
+ *   onEvent={(event) => console.log('Event:', event)}
+ * />
+ * ```
+ *
+ * @returns React component that renders the Connect Onboarding interface
+ */
+export declare const Onboarding: default_2.FC<OnboardingProps>;
+
+declare type OnboardingCompletedData = {
+    participantCode: string;
+    kycStatus: string;
+};
+
+declare type OnboardingEvent = AppEvent<OnboardingEventType>;
+
+declare type OnboardingEventType = string;
+
+declare interface OnboardingProps {
+    /**
+     * JWT token used for authentication with the Connect Onboarding service.
+     * This token should be obtained from your backend and contain the necessary
+     * claims for user identification and authorization.
+     *
+     * @example "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
+     */
+    jwt: string;
+    /**
+     * Target environment for the Connect Onboarding service.
+     *
+     * @default "prod"
+     *
+     * Available environments:
+     * - `"local"` - Local development environment
+     * - `"dev"` - Development environment
+     * - `"cert"` - Certificate/staging environment for integration testing
+     * - `"prod"` - Live production environment for real applications
+     *
+     * @example
+     * ```tsx
+     * // Use production (default)
+     * <Onboarding jwt={token} />
+     *
+     * // Use cert for testing
+     * <Onboarding jwt={token} env="cert" />
+     * ```
+     */
+    env?: Environment;
+    /**
+     * Theme mode for the Connect Onboarding interface.
+     *
+     * @default "auto"
+     *
+     * Available themes:
+     * - `"auto"` - Automatically detect system preference (light/dark mode)
+     * - `"light"` - Force light theme
+     * - `"dark"` - Force dark theme
+     *
+     * @example
+     * ```tsx
+     * // Auto-detect system preference (default)
+     * <Onboarding jwt={token} />
+     *
+     * // Force dark theme
+     * <Onboarding jwt={token} theme="dark" />
+     * ```
+     */
+    theme?: Theme;
+    /**
+     * Callback invoked when the crypto sell flow is successfully completed.
+     *
+     * @param data - Details about the completed sell, including amount sold and asset symbol
+     *
+     * @example
+     * ```tsx
+     * <Onboarding
+     *   jwt={token}
+     *   onCompleted={({ amountSold, assetSymbol }) =>
+     *     console.log(`Sold ${amountSold} ${assetSymbol}`)
+     *   }
+     * />
+     * ```
+     */
+    onCompleted?: (data: OnboardingCompletedData) => void;
+    /**
+     * Callback invoked when an error occurs during the crypto sell flow.
+     *
+     * @param error - Error details including error code and reason
+     *
+     * @example
+     * ```tsx
+     * <Onboarding
+     *   jwt={token}
+     *   onError={({ errorCode, reason }) =>
+     *     console.error('Crypto sell error:', errorCode, reason)
+     *   }
+     * />
+     * ```
+     */
+    onError?: (error: ErrorPayload) => void;
+    /**
+     * Callback invoked when the user closes the crypto sell widget.
+     *
+     * @example
+     * ```tsx
+     * <Onboarding
+     *   jwt={token}
+     *   onClose={() => setShowOnboarding(false)}
+     * />
+     * ```
+     */
+    onClose?: () => void;
+    /**
+     * Callback invoked when the crypto sell widget has finished loading and is ready.
+     *
+     * @example
+     * ```tsx
+     * <Onboarding
+     *   jwt={token}
+     *   onLoaded={() => setIsLoading(false)}
+     * />
+     * ```
+     */
+    onLoaded?: () => void;
+    /**
+     * Callback invoked for general application events during the crypto sell flow.
+     *
+     * @param event - Event object containing the event type and associated data
+     *
+     * @example
+     * ```tsx
+     * <Onboarding
+     *   jwt={token}
+     *   onEvent={(event) => console.log('Crypto sell event:', event)}
+     * />
+     * ```
+     */
+    onEvent?: (event: OnboardingEvent) => void;
+}
+
+/**
+ * Theme mode for the Connect Onboarding interface.
+ *
+ * - `"auto"` - Automatically detect system preference (light/dark mode)
+ * - `"light"` - Force light theme
+ * - `"dark"` - Force dark theme
+ */
+declare type Theme = 'auto' | 'light' | 'dark';
+
+export { }

package/dist/index.js

@@ -0,0 +1,40 @@
+import b, { useRef as m, useEffect as l } from "react";
+const g = {
+  local: "http://localhost:5173/onboarding-web/index.js",
+  dev: "https://connect-sdk.dev.0hash.com/onboarding-web/index.js",
+  cert: "https://sdk.sandbox.connect.xyz/onboarding-web/index.js",
+  prod: "https://sdk.connect.xyz/onboarding-web/index.js"
+}, x = "zerohash-onboarding-script", f = "zerohash-onboarding", y = (n = "prod") => g[n], R = ({
+  jwt: n,
+  env: r = "prod",
+  theme: h,
+  onCompleted: o,
+  onError: c,
+  onClose: s,
+  onLoaded: i,
+  onEvent: d,
+  ...u
+}) => {
+  const a = m(null);
+  return l(() => {
+    const t = a.current;
+    t && (o && (t.onCompleted = o), c && (t.onError = c), s && (t.onClose = s), i && (t.onLoaded = i), d && (t.onEvent = d));
+  }, [o, c, s, i, d]), l(() => {
+    const t = y(r), p = `${x}-${r}`;
+    if (document.getElementById(p))
+      return;
+    const e = document.createElement("script");
+    e.id = p, e.src = t, e.type = "module", e.async = !0, e.onerror = () => {
+      console.error(`Failed to load the script for ${f} from ${r} environment.`);
+    }, document.head.appendChild(e);
+  }, [r]), b.createElement(f, {
+    ref: a,
+    jwt: n,
+    env: r,
+    theme: h,
+    ...u
+  });
+};
+export {
+  R as Onboarding
+};

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@zerohash-sdk/onboarding-react",
+  "version": "1.1.0",
+  "private": false,
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "license": "MIT",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!**/*.tsbuildinfo"
+  ],
+  "nx": {
+    "name": "onboarding-react"
+  },
+  "peerDependencies": {
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0"
+  }
+}