@zerohash-sdk/csp-crypto-withdrawals-react 1.1.0

package/README.md

@@ -0,0 +1,116 @@
+# @zerohash-sdk/csp-crypto-withdrawals-react
+
+A React SDK that enables frontend React applications to seamlessly integrate with the Connect CSP Crypto Withdrawals product.
+
+Connect CSP Crypto Withdrawals provides a secure, customizable flow for withdrawing crypto assets directly within your application.
+
+## Requirements
+
+- React 18.0.0 or higher
+- React DOM 18.0.0 or higher
+
+## Installation
+
+```bash
+npm install @zerohash-sdk/csp-crypto-withdrawals-react
+```
+
+## Getting Started
+
+### 1. Import the CspCryptoWithdrawals Component
+
+```tsx
+import { CspCryptoWithdrawals } from '@zerohash-sdk/csp-crypto-withdrawals-react';
+```
+
+### 2. Add the CspCryptoWithdrawals Component to Your App
+
+```tsx
+function App() {
+  const jwt = 'your-jwt-token'; // Obtain this from your backend
+
+  return (
+    <CspCryptoWithdrawals
+      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 (
+    <CspCryptoWithdrawals
+      jwt={jwt}
+      env="prod"
+      theme="auto"
+      onCompleted={({ withdrawalRequestId, assetSymbol, amount, networkFee, withdrawalFee }) => {
+        console.log('Withdrawal completed:', withdrawalRequestId, amount, 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 { CspCryptoWithdrawals } from '@zerohash-sdk/csp-crypto-withdrawals-react';
+
+function App() {
+  const jwt = 'your-jwt-token';
+
+  return (
+    <div className="App">
+      <h1>My App</h1>
+
+      <CspCryptoWithdrawals
+        jwt={jwt}
+        env="prod"
+        theme="auto"
+        onCompleted={({ withdrawalRequestId, assetSymbol, amount, networkFee, withdrawalFee }) => {
+          console.log('Withdrawal:', withdrawalRequestId, amount, assetSymbol, networkFee, withdrawalFee);
+        }}
+        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
+
+### CspCryptoWithdrawals 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` | `({ withdrawalRequestId, assetSymbol, amount, networkFee, withdrawalFee }) => void` | No       | -        | Callback when the withdrawal 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,152 @@
+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;
+};
+
+/**
+ * A React wrapper component for the Connect CSP Crypto Withdrawals product.
+ *
+ * @example
+ * ```tsx
+ * <CspCryptoWithdrawals
+ *   jwt="your-jwt-token"
+ *   theme="auto"
+ *   onLoaded={() => console.log('CSP Crypto Withdrawals loaded and ready')}
+ *   onCompleted={(data) => console.log('Withdrawal complete', data)}
+ *   onClose={() => console.log('CSP Crypto Withdrawals closed')}
+ *   onError={({ errorCode, reason }) => console.error('Error:', errorCode, reason)}
+ *   onEvent={(event) => console.log('Event:', event)}
+ * />
+ * ```
+ */
+export declare const CspCryptoWithdrawals: default_2.FC<CspCryptoWithdrawalsProps>;
+
+declare type CspCryptoWithdrawalsCompletedData = {
+    /** ID of the withdrawal request */
+    withdrawalRequestId: string;
+    /** Symbol of the asset being withdrawn (e.g. 'BTC') */
+    assetSymbol: string;
+    /** Amount being withdrawn as a string */
+    amount: string;
+    /** Network fee as a string */
+    networkFee: string;
+    /** Withdrawal fee as a string */
+    withdrawalFee: string;
+};
+
+/**
+ * CSP Crypto Withdrawals event structure
+ */
+declare type CspCryptoWithdrawalsEvent = AppEvent<CspCryptoWithdrawalsEventType>;
+
+/**
+ * CSP Crypto Withdrawals event type literals
+ */
+declare type CspCryptoWithdrawalsEventType = string;
+
+declare interface CspCryptoWithdrawalsProps {
+    /**
+     * JWT token used for authentication with the Connect CSP Crypto Withdrawals service.
+     *
+     * @example "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
+     */
+    jwt: string;
+    /**
+     * Target environment for the Connect CSP Crypto Withdrawals service.
+     *
+     * @default "prod"
+     */
+    env?: Environment;
+    /**
+     * Theme mode for the Connect CSP Crypto Withdrawals interface.
+     *
+     * @default "auto"
+     */
+    theme?: Theme;
+    /**
+     * Callback invoked when the CSP crypto withdrawal flow is successfully completed.
+     *
+     * @param data - Details about the completed withdrawal
+     */
+    onCompleted?: (data: CspCryptoWithdrawalsCompletedData) => void;
+    /**
+     * Callback invoked when an error occurs during the CSP crypto withdrawal flow.
+     *
+     * @param error - Error details including error code and reason
+     */
+    onError?: (error: ErrorPayload) => void;
+    /**
+     * Callback invoked when the user closes the CSP crypto withdrawals widget.
+     */
+    onClose?: () => void;
+    /**
+     * Callback invoked when the CSP crypto withdrawals widget has finished loading and is ready.
+     */
+    onLoaded?: () => void;
+    /**
+     * Callback invoked for general application events during the CSP crypto withdrawals flow.
+     *
+     * @param event - Event object containing the event type and associated data
+     */
+    onEvent?: (event: CspCryptoWithdrawalsEvent) => void;
+}
+
+/**
+ * Available environments for the Connect CSP Crypto Withdrawals service.
+ *
+ * - `"local"` - Local development environment
+ * - `"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;
+};
+
+/**
+ * Theme mode for the Connect CSP Crypto Withdrawals 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 u, { useRef as m, useEffect as l } from "react";
+const y = {
+  local: "http://localhost:5173/csp-crypto-withdrawals-web/index.js",
+  dev: "https://connect-sdk.dev.0hash.com/csp-crypto-withdrawals-web/index.js",
+  cert: "https://sdk.sandbox.connect.xyz/csp-crypto-withdrawals-web/index.js",
+  prod: "https://sdk.connect.xyz/csp-crypto-withdrawals-web/index.js"
+}, x = "zerohash-csp-crypto-withdrawals-script", h = "zerohash-csp-crypto-withdrawals", b = (e = "prod") => y[e], R = ({
+  jwt: e,
+  env: c = "prod",
+  theme: w,
+  onCompleted: s,
+  onError: o,
+  onClose: p,
+  onLoaded: n,
+  onEvent: i,
+  ...f
+}) => {
+  const d = m(null);
+  return l(() => {
+    const t = d.current;
+    t && (s && (t.onCompleted = s), o && (t.onError = o), p && (t.onClose = p), n && (t.onLoaded = n), i && (t.onEvent = i));
+  }, [s, o, p, n, i]), l(() => {
+    const t = b(c), a = `${x}-${c}`;
+    if (document.getElementById(a))
+      return;
+    const r = document.createElement("script");
+    r.id = a, r.src = t, r.type = "module", r.async = !0, r.onerror = () => {
+      console.error(`Failed to load the script for ${h} from ${c} environment.`);
+    }, document.head.appendChild(r);
+  }, [c]), u.createElement(h, {
+    ref: d,
+    jwt: e,
+    env: c,
+    theme: w,
+    ...f
+  });
+};
+export {
+  R as CspCryptoWithdrawals
+};

package/package.json

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