@zerohash-sdk/profile-react 0.1.0

package/README.md

@@ -0,0 +1,82 @@
+# @zerohash-sdk/profile-react
+
+A React SDK that enables frontend React applications to seamlessly integrate with the Connect Profile product.
+
+Connect Profile provides a secure, customizable flow for managing user profile information directly within your application.
+
+## Requirements
+
+- React 18.0.0 or higher
+- React DOM 18.0.0 or higher
+
+## Installation
+
+```bash
+npm install @zerohash-sdk/profile-react
+```
+
+## Getting Started
+
+Follow these simple steps to integrate Connect Profile into your React application:
+
+### 1. Import the Profile Component
+
+```tsx
+import { Profile } from '@zerohash-sdk/profile-react';
+```
+
+### 2. Add the Profile Component to Your App
+
+```tsx
+function App() {
+  const jwt = 'your-jwt-token'; // Obtain this from your backend
+
+  return (
+    <Profile
+      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 Profile SDK to handle user interactions:
+
+```tsx
+function App() {
+  const jwt = 'your-jwt-token';
+
+  return (
+    <Profile
+      jwt={jwt}
+      env="prod"
+      theme="auto"
+      onLoaded={() => console.log('Profile widget loaded and ready')}
+      onClose={() => console.log('Profile widget closed')}
+      onError={({ errorCode, reason }) => console.error('Error:', errorCode, reason)}
+      onEvent={(event) => console.log('Event:', event)}
+    />
+  );
+}
+```
+
+## API Reference
+
+### Profile Component Props
+
+| Prop       | Type                                   | Required | Default  | Description                        |
+| ---------- | -------------------------------------- | -------- | -------- | ---------------------------------- |
+| `jwt`      | `string`                               | Yes      | -        | JWT token for authentication       |
+| `env`      | `"prod" \| "cert" \| "dev" \| "local"` | No       | `"prod"` | Target environment                 |
+| `theme`    | `"auto" \| "light" \| "dark"`          | No       | `"auto"` | Theme mode for the interface       |
+| `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 |
+
+## 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,108 @@
+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 Profile 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;
+};
+
+/**
+ * A React wrapper component for the Connect Profile product.
+ */
+export declare const Profile: default_2.FC<ProfileProps>;
+
+declare type ProfileEvent = AppEvent<ProfileEventType>;
+
+declare type ProfileEventType = string;
+
+declare interface ProfileProps {
+    /**
+     * JWT token used for authentication with the Connect Profile service.
+     */
+    jwt: string;
+    /**
+     * Target environment for the Connect Profile service.
+     *
+     * @default "prod"
+     */
+    env?: Environment;
+    /**
+     * Theme mode for the Connect Profile interface.
+     *
+     * @default "auto"
+     */
+    theme?: Theme;
+    /**
+     * Callback invoked when an error occurs during the profile flow.
+     */
+    onError?: (error: ErrorPayload) => void;
+    /**
+     * Callback invoked when the user closes the profile widget.
+     */
+    onClose?: () => void;
+    /**
+     * Callback invoked when the profile widget has finished loading and is ready.
+     */
+    onLoaded?: () => void;
+    /**
+     * Callback invoked for general application events during the profile flow.
+     */
+    onEvent?: (event: ProfileEvent) => void;
+}
+
+/**
+ * Theme mode for the Connect Profile 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,39 @@
+import m, { useRef as u, useEffect as l } from "react";
+const x = {
+  local: "http://localhost:5173/profile-web/index.js",
+  dev: "https://connect-sdk.dev.0hash.com/profile-web/index.js",
+  cert: "https://sdk.sandbox.connect.xyz/profile-web/index.js",
+  prod: "https://sdk.connect.xyz/profile-web/index.js"
+}, b = "zerohash-profile-script", f = "zerohash-profile", y = (o = "prod") => x[o], R = ({
+  jwt: o,
+  env: r = "prod",
+  theme: h,
+  onError: c,
+  onClose: s,
+  onLoaded: n,
+  onEvent: i,
+  ...a
+}) => {
+  const p = u(null);
+  return l(() => {
+    const e = p.current;
+    e && (c && (e.onError = c), s && (e.onClose = s), n && (e.onLoaded = n), i && (e.onEvent = i));
+  }, [c, s, n, i]), l(() => {
+    const e = y(r), d = `${b}-${r}`;
+    if (document.getElementById(d))
+      return;
+    const t = document.createElement("script");
+    t.id = d, t.src = e, t.type = "module", t.async = !0, t.onerror = () => {
+      console.error(`Failed to load the script for ${f} from ${r} environment.`);
+    }, document.head.appendChild(t);
+  }, [r]), m.createElement(f, {
+    ref: p,
+    jwt: o,
+    env: r,
+    theme: h,
+    ...a
+  });
+};
+export {
+  R as Profile
+};

package/package.json

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