@zerohash-sdk/fiat-deposits-react 1.1.0

package/README.md

@@ -0,0 +1,116 @@
+# @zerohash-sdk/fiat-deposits-react
+
+A React SDK that enables frontend React applications to seamlessly integrate with the Connect Fiat Deposits product.
+
+Connect Fiat Deposits provides a secure, customizable flow for depositing fiat currency directly within your application.
+
+## Requirements
+
+- React 18.0.0 or higher
+- React DOM 18.0.0 or higher
+
+## Installation
+
+```bash
+npm install @zerohash-sdk/fiat-deposits-react
+```
+
+## Getting Started
+
+### 1. Import the FiatDeposits Component
+
+```tsx
+import { FiatDeposits } from '@zerohash-sdk/fiat-deposits-react';
+```
+
+### 2. Add the FiatDeposits Component to Your App
+
+```tsx
+function App() {
+  const jwt = 'your-jwt-token'; // Obtain this from your backend
+
+  return (
+    <FiatDeposits
+      jwt={jwt}
+      env="prod" // or "cert" for testing
+      theme="auto" // 'auto' (default), 'light', or 'dark'
+    />
+  );
+}
+```
+
+### 3. Configure Event Callbacks (Optional)
+
+```tsx
+function App() {
+  const jwt = 'your-jwt-token';
+
+  return (
+    <FiatDeposits
+      jwt={jwt}
+      env="prod"
+      theme="auto"
+      onCompleted={({ amountDeposited, assetSymbol }) => {
+        console.log('Deposit completed:', amountDeposited, assetSymbol);
+      }}
+      onError={({ errorCode, reason }) => {
+        console.log('Error:', errorCode, 'Reason:', reason);
+      }}
+      onClose={() => console.log('Widget closed')}
+      onEvent={({ type, data }) => console.log('Event:', type, data)}
+      onLoaded={() => console.log('Widget loaded and ready')}
+    />
+  );
+}
+```
+
+## Complete Example
+
+```tsx
+import React from 'react';
+import { FiatDeposits } from '@zerohash-sdk/fiat-deposits-react';
+
+function App() {
+  const jwt = 'your-jwt-token';
+
+  return (
+    <div className="App">
+      <h1>My App</h1>
+
+      <FiatDeposits
+        jwt={jwt}
+        env="prod"
+        theme="auto"
+        onCompleted={({ amountDeposited, assetSymbol }) => {
+          console.log('Deposited:', amountDeposited, assetSymbol);
+        }}
+        onError={({ errorCode, reason }) => console.log('Error:', errorCode, reason)}
+        onClose={() => console.log('Widget closed')}
+        onEvent={({ type, data }) => console.log('Event type:', type, 'Event data:', data)}
+        onLoaded={() => console.log('Widget loaded and ready')}
+      />
+    </div>
+  );
+}
+
+export default App;
+```
+
+## API Reference
+
+### FiatDeposits 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` | `({ amountDeposited, assetSymbol }) => void` | No       | -        | Callback when the deposit flow 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 Fiat Deposits service.
+ *
+ * - `"local"` - Local development environment (http://localhost:4205)
+ * - `"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 Fiat Deposits 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 deposit 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)
+ * <FiatDeposits jwt="your-jwt-token" />
+ *
+ * // Using cert environment for testing
+ * <FiatDeposits jwt="your-jwt-token" env="cert" />
+ *
+ * // Force dark theme
+ * <FiatDeposits jwt="your-jwt-token" theme="dark" />
+ *
+ * // With callback functions
+ * <FiatDeposits
+ *   jwt="your-jwt-token"
+ *   theme="auto"
+ *   onLoaded={() => console.log('Fiat deposits loaded and ready')}
+ *   onCompleted={({ amountDeposited }) => console.log('Deposited', amountDeposited)}
+ *   onClose={() => console.log('Fiat deposits closed')}
+ *   onError={({ errorCode, reason }) => console.error('Error:', errorCode, reason)}
+ *   onEvent={(event) => console.log('Event:', event)}
+ * />
+ * ```
+ *
+ * @returns React component that renders the Connect Fiat Deposits interface
+ */
+export declare const FiatDeposits: default_2.FC<FiatDepositsProps>;
+
+declare type FiatDepositsCompletedData = {
+    amountDeposited: string;
+    assetSymbol: string;
+};
+
+declare type FiatDepositsEvent = AppEvent<FiatDepositsEventType>;
+
+declare type FiatDepositsEventType = string;
+
+declare interface FiatDepositsProps {
+    /**
+     * JWT token used for authentication with the Connect Fiat Deposits 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 Fiat Deposits 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)
+     * <FiatDeposits jwt={token} />
+     *
+     * // Use cert for testing
+     * <FiatDeposits jwt={token} env="cert" />
+     * ```
+     */
+    env?: Environment;
+    /**
+     * Theme mode for the Connect Fiat Deposits 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)
+     * <FiatDeposits jwt={token} />
+     *
+     * // Force dark theme
+     * <FiatDeposits jwt={token} theme="dark" />
+     * ```
+     */
+    theme?: Theme;
+    /**
+     * Callback invoked when the fiat deposit flow is successfully completed.
+     *
+     * @param data - Details about the completed deposit, including amount deposited
+     *
+     * @example
+     * ```tsx
+     * <FiatDeposits
+     *   jwt={token}
+     *   onCompleted={({ amountDeposited }) =>
+     *     console.log(`Deposited ${amountDeposited}`)
+     *   }
+     * />
+     * ```
+     */
+    onCompleted?: (data: FiatDepositsCompletedData) => void;
+    /**
+     * Callback invoked when an error occurs during the fiat deposit flow.
+     *
+     * @param error - Error details including error code and reason
+     *
+     * @example
+     * ```tsx
+     * <FiatDeposits
+     *   jwt={token}
+     *   onError={({ errorCode, reason }) =>
+     *     console.error('Fiat deposit error:', errorCode, reason)
+     *   }
+     * />
+     * ```
+     */
+    onError?: (error: ErrorPayload) => void;
+    /**
+     * Callback invoked when the user closes the fiat deposit widget.
+     *
+     * @example
+     * ```tsx
+     * <FiatDeposits
+     *   jwt={token}
+     *   onClose={() => setShowFiatDeposits(false)}
+     * />
+     * ```
+     */
+    onClose?: () => void;
+    /**
+     * Callback invoked when the fiat deposit widget has finished loading and is ready.
+     *
+     * @example
+     * ```tsx
+     * <FiatDeposits
+     *   jwt={token}
+     *   onLoaded={() => setIsLoading(false)}
+     * />
+     * ```
+     */
+    onLoaded?: () => void;
+    /**
+     * Callback invoked for general application events during the fiat deposit flow.
+     *
+     * @param event - Event object containing the event type and associated data
+     *
+     * @example
+     * ```tsx
+     * <FiatDeposits
+     *   jwt={token}
+     *   onEvent={(event) => console.log('Fiat deposit event:', event)}
+     * />
+     * ```
+     */
+    onEvent?: (event: FiatDepositsEvent) => void;
+}
+
+/**
+ * Theme mode for the Connect Fiat Deposits 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 m, { useRef as x, useEffect as f } from "react";
+const b = {
+  local: "http://localhost:5173/fiat-deposits-web/index.js",
+  dev: "https://connect-sdk.dev.0hash.com/fiat-deposits-web/index.js",
+  cert: "https://sdk.sandbox.connect.xyz/fiat-deposits-web/index.js",
+  prod: "https://sdk.connect.xyz/fiat-deposits-web/index.js"
+}, y = "zerohash-fiat-deposits-script", l = "zerohash-fiat-deposits", I = (r = "prod") => b[r], j = ({
+  jwt: r,
+  env: s = "prod",
+  theme: h,
+  onCompleted: c,
+  onError: o,
+  onClose: i,
+  onLoaded: n,
+  onEvent: d,
+  ...u
+}) => {
+  const p = x(null);
+  return f(() => {
+    const t = p.current;
+    t && (c && (t.onCompleted = c), o && (t.onError = o), i && (t.onClose = i), n && (t.onLoaded = n), d && (t.onEvent = d));
+  }, [c, o, i, n, d]), f(() => {
+    const t = I(s), a = `${y}-${s}`;
+    if (document.getElementById(a))
+      return;
+    const e = document.createElement("script");
+    e.id = a, e.src = t, e.type = "module", e.async = !0, e.onerror = () => {
+      console.error(`Failed to load the script for ${l} from ${s} environment.`);
+    }, document.head.appendChild(e);
+  }, [s]), m.createElement(l, {
+    ref: p,
+    jwt: r,
+    env: s,
+    theme: h,
+    ...u
+  });
+};
+export {
+  j as FiatDeposits
+};

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@zerohash-sdk/fiat-deposits-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": "fiat-deposits-react"
+  },
+  "peerDependencies": {
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0"
+  }
+}