@zerohash-sdk/csp-fiat-withdrawals-react 0.1.0

package/README.md

@@ -0,0 +1,7 @@
+# @zerohash-sdk/csp-fiat-withdrawals-react
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test @zerohash-sdk/csp-fiat-withdrawals-react` to execute the unit tests via [Vitest](https://vitest.dev/).

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 Zerohash CSP Fiat Withdrawals 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 fiat withdrawal 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
+ * <CspFiatWithdrawals jwt="your-jwt-token" />
+ * ```
+ *
+ * @returns React component that renders the Zerohash CSP Fiat Withdrawals interface
+ */
+export declare const CspFiatWithdrawals: default_2.FC<CspFiatWithdrawalsProps>;
+
+declare type CspFiatWithdrawalsCompletedData = {
+    /** Amount withdrawn as a string */
+    amountWithdrawn: string;
+    /** Symbol of the fiat currency that was withdrawn (e.g. 'USD') */
+    assetSymbol: string;
+};
+
+/**
+ * CSP fiat withdrawals event structure
+ */
+declare type CspFiatWithdrawalsEvent = AppEvent<CspFiatWithdrawalsEventType>;
+
+/**
+ * CSP fiat withdrawals event type literals
+ */
+declare type CspFiatWithdrawalsEventType = string;
+
+declare interface CspFiatWithdrawalsProps {
+    /**
+     * JWT token used for authentication with the Zerohash CSP Fiat Withdrawals 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 Zerohash CSP Fiat Withdrawals service.
+     *
+     * @default "prod"
+     */
+    env?: Environment;
+    /**
+     * Theme mode for the Zerohash CSP Fiat Withdrawals interface.
+     *
+     * @default "auto"
+     */
+    theme?: Theme;
+    /**
+     * Callback invoked when the CSP fiat withdrawals flow is successfully completed.
+     *
+     * @param data - Details about the completed withdrawal, including amount withdrawn and asset symbol
+     */
+    onCompleted?: (data: CspFiatWithdrawalsCompletedData) => void;
+    /**
+     * Callback invoked when an error occurs during the CSP fiat withdrawals flow.
+     *
+     * @param error - Error details including error code and reason
+     */
+    onError?: (error: ErrorPayload) => void;
+    /**
+     * Callback invoked when the user closes the CSP fiat withdrawals widget.
+     */
+    onClose?: () => void;
+    /**
+     * Callback invoked when the CSP fiat withdrawals widget has finished loading and is ready.
+     */
+    onLoaded?: () => void;
+    /**
+     * Callback invoked for general application events during the CSP fiat withdrawals flow.
+     *
+     * @param event - Event object containing the event type and associated data
+     */
+    onEvent?: (event: CspFiatWithdrawalsEvent) => void;
+}
+
+/**
+ * Available environments for the Zerohash CSP Fiat 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 Zerohash CSP Fiat 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 x = {
+  local: "http://localhost:5173/csp-fiat-withdrawals-web/index.js",
+  dev: "https://connect-sdk.dev.0hash.com/csp-fiat-withdrawals-web/index.js",
+  cert: "https://sdk.sandbox.connect.xyz/csp-fiat-withdrawals-web/index.js",
+  prod: "https://sdk.connect.xyz/csp-fiat-withdrawals-web/index.js"
+}, b = "zerohash-csp-fiat-withdrawals-script", h = "zerohash-csp-fiat-withdrawals", y = (r = "prod") => x[r], R = ({
+  jwt: r,
+  env: s = "prod",
+  theme: f,
+  onCompleted: c,
+  onError: i,
+  onClose: a,
+  onLoaded: n,
+  onEvent: o,
+  ...w
+}) => {
+  const d = m(null);
+  return l(() => {
+    const t = d.current;
+    t && (c && (t.onCompleted = c), i && (t.onError = i), a && (t.onClose = a), n && (t.onLoaded = n), o && (t.onEvent = o));
+  }, [c, i, a, n, o]), l(() => {
+    const t = y(s), p = `${b}-${s}`;
+    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 ${h} from ${s} environment.`);
+    }, document.head.appendChild(e);
+  }, [s]), u.createElement(h, {
+    ref: d,
+    jwt: r,
+    env: s,
+    theme: f,
+    ...w
+  });
+};
+export {
+  R as CspFiatWithdrawals
+};

package/package.json

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