heraldex-onramp-sdk 2.0.0 → 4.0.0

package/Readme.md

@@ -1,15 +1,15 @@
 # Herald Exchange Onramp SDK Widget
 
-Herald Exchange Onramp SDK Widget is a simple component for React applications.
+Herald Exchange Onramp SDK is a simple component for React applications.
 
 ## Installation
 
-You can install Herald Exchange Onramp SDK Widget via npm:
+You can install Herald Exchange Onramp SDK via npm:
 
 ```bash
-npm install herald-exchange-onramp-widget
+npm install heraldex-onramp-sdk
 # or
-yarn add herald-exchange-onramp-widget
+yarn add heraldex-onramp-sdk
 ```
 
 ## Usage
@@ -17,20 +17,21 @@ yarn add herald-exchange-onramp-widget
 To use widget in your React application, follow these steps:
 
 ```tsx
-import { BuyCryptoWidget } from "herald-exchange-onramp-widget";
+import { BuyCryptoWidget } from "heraldex-onramp-sdk";
 ```
 
 Initialize the widget:
 
-> To Generate API Key Please Visit : [Herald Exchange](https://app.herald.exchange/login).  
+> To Generate API Key Please Visit : [Herald Exchange](https://app.herald.exchange/signin).  
 > Supported Token Types : ["USDT", "USDC", "ETH", "BNB", "MATIC", "SOL", "TRX"]
 
 ```tsx
 <BuyCryptoWidget
-  clientReferenceID={YOUR_CLIENT_REFERENCE_ID}
+  clientReferenceID={YOUR_SALT_KEY}
   apiKey={YOUR_API_KEY}
   redirectUrl={REDIRECT_URL}
   buyParameters={{ from_amount: "25", token_type: "TRX" }}
+  callback={(data) => alert(JSON.stringify(data))}
 />
 ```
 
@@ -53,23 +54,7 @@ Initialize the widget:
 
 - This key is used to authenticate and authorize the widget.
 
-- Example: `4bb06e2fdbfb8e392a0ab49e4d9819ae072dcef82d79af7893625a5ff1416f`
-
----
-
-### `mode` (optional)
-
-- Type: string
-
-- Allowed Values: "development" | "production"
-
-- Default: "development"
-
-- Description: Specifies the environment in which the widget runs.
-
-  - "development" is used for testing and debugging purposes.
-
-  - "production" should be used in live environments for optimized performance.
+- Example: `4bb06e2fdbfb8e392a0ab49e4d9819.ae072dcef82d79af7893625a5ff1416f`
 
 ---
 
@@ -81,19 +66,7 @@ Initialize the widget:
 
 - Helps track user activity and transaction flow.
 
-- Example: `34edd6d6-eb12-422f-bd0e-63c5733527`
-
----
-
-### `redirectUrl` (optional)
-
-- **Type**: `string`
-
-- **Description**: The URL to which the user will be redirected **after completing the transaction**.
-
-- A **callback** will be made to this URL along with the **transaction result or status** as query parameters or payload (depending on the integration).
-
-- Example: `https://yourapp.com/transaction-complete`
+- Example: `34edd6d6eb12422fbd0e63c5733527`
 
 ---
 
@@ -109,7 +82,6 @@ Initialize the widget:
 ```
 
 - **Description**: Defines the default configuration for the buy flow.
-
   - from_amount: A string representing the default amount to be displayed in the input field (e.g., "25").
 
   - token_type: The token that should be selected by default for purchase (e.g., "USDC").
@@ -118,6 +90,51 @@ Initialize the widget:
 
 ---
 
+### `callback` (required)
+
+- **Type**:
+
+```ts
+(data: {
+  status: string;
+  message?: string;
+  transaction_id?: string;
+  [key: string]: any;
+}) => void
+
+```
+
+- **Description**: A callback function that is triggered whenever the widget returns a response or status update.
+
+  status: Represents the current state of the action (e.g., "success", "failed", "pending").
+  message: Optional message returned from the widget response.
+  transaction_id: Optional unique transaction identifier.
+  Additional response fields may be included depending on the event type.
+
+---
+
+### `redirect` (optinal)
+
+- **Type**: `boolean`
+
+- **Description**: Determines whether redirection should be enabled after the action is completed.
+
+- Example: `false | true`
+
+---
+
+### `redirectUrl` (optional)
+
+- **Type**: `string`
+
+- **Description**: The URL to which the user will be redirected **after completing the transaction**.
+
+- A **callback** will be made to this URL along with the **transaction result or status** as query parameters or payload (depending on the integration).
+
+- Example: `https://yourapp.com/transaction-complete`
+
+---
+
 ## License
 
 This project is licensed under the MIT License - see the LICENSE file for details.

package/dist/index.d.ts

@@ -1,8 +1,9 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
 type BuyParamsType = {
-    from_amount?: string;
-    token_type?: string;
+    from_amount: string;
+    token_type: string;
+    fiat: string;
 };
 type CallBackResponse = {
     status: "success" | "failed";
@@ -23,7 +24,7 @@ type CallBackResponse = {
 
 type WidgetComponentProps = {
     apiKey: string;
-    buyParameters?: BuyParamsType;
+    buyParameters: BuyParamsType;
     clientReferenceID: string;
     mode?: "development" | "production";
     callback: (data: CallBackResponse) => void;