@vindhq/sloud-payment-sdk 1.0.2 → 1.0.3

package/README.md

@@ -1,6 +1,6 @@
 # Sloud Payment SDK
 
-A secure, embeddable payment widget built in React, usable in **any JavaScript application** (React, Angular, Vue, or vanilla JS). Ships with **ESM, CJS, and UMD builds** for easy integration in any environment.
+A secure, embeddable payment widget for straightforward customer payments, built in React and usable in **any JavaScript application** (React, Angular, Vue, or vanilla JS). Ships with **ESM, CJS, and UMD builds** for easy integration in any environment.
 
 ---
 
@@ -72,16 +72,12 @@ For direct browser usage without a bundler, use the UMD build which includes Rea
 
 ## Usage
 
-The payment widget supports three payment types: **external**, **storefront**, and **sloudfront**. Each type has its own set of required fields.
+The payment widget is designed for straightforward payments with customer details.
 
 > **Note**: When using the UMD build in the browser (via script tag), access the widget via `PaymentWidget.default`. For npm/ES module imports, use the standard `import PaymentWidget from "sloud-payment-sdk"`.
 
-### External Payment (Simple Payments)
-
-For straightforward payments with customer details:
-
 ```tsx
-import PaymentWidget from "sloud-payment-sdk";
+import PaymentWidget from "@vindhq/sloud-payment-sdk";
 
 const widget = new PaymentWidget({
   type: "external",
@@ -99,91 +95,6 @@ const widget = new PaymentWidget({
 widget.showPopup();
 ```
 
-### Storefront Payment (E-commerce Orders)
-
-For e-commerce orders with products and delivery:
-
-```tsx
-import PaymentWidget from "sloud-payment-sdk";
-
-const widget = new PaymentWidget({
-  type: "storefront",
-  public_key: "your-public-api-key",
-  slug: "my-store",
-  amount: 5000, // Additional amount (e.g., shipping fees)
-  discount: 1000, // Optional discount
-  channel: "delivery", // "pickup" or "delivery"
-  customer: {
-    first_name: "Jane",
-    last_name: "Smith",
-    phone_number: "+2348098765432",
-    email: "jane.smith@example.com",
-  },
-  delivery_details: {
-    street: "123 Main Street",
-    city: "Lagos",
-    state: "Lagos",
-    country: "Nigeria",
-    note: "Please call on arrival", // Optional
-  },
-  products: [
-    {
-      product_id: "prod_123",
-      quantity: 2,
-      variation: ["Large", "Blue"], // Optional
-    },
-    {
-      product_id: "prod_456",
-      quantity: 1,
-    },
-  ],
-});
-
-// Payment method will be selected by the user in the widget UI
-
-widget.showPopup();
-```
-
-### Sloudfront Payment (Manual Orders)
-
-For manual orders with existing transaction/customer/business IDs:
-
-```tsx
-import PaymentWidget from "sloud-payment-sdk";
-
-const widget = new PaymentWidget({
-  type: "sloudfront",
-  public_key: "your-public-api-key",
-  transaction_id: "txn_abc123",
-  customer_id: "cust_xyz789",
-  business_id: "biz_def456",
-  amount: 5000,
-  discount: 500,
-  channel: "pickup", // "pickup" or "delivery"
-  customer: {
-    first_name: "Alice",
-    last_name: "Johnson",
-    phone_number: "+2348011223344",
-    email: "alice.johnson@example.com",
-  },
-  delivery_details: {
-    street: "456 Oak Avenue",
-    city: "Abuja",
-    state: "FCT",
-    country: "Nigeria",
-  },
-  products: [
-    {
-      product_id: "prod_789",
-      quantity: 1,
-    },
-  ],
-});
-
-// Payment method will be selected by the user in the widget UI
-
-widget.showPopup();
-```
 
 ---
 
@@ -193,50 +104,17 @@ widget.showPopup();
 
 Creates a new payment widget instance.
 
-#### Common Options (All Payment Types)
+#### Payment Widget Options
 
 | Parameter | Type | Required | Description |
 | --------------- | --------- | -------- | -------------------------------------------------- |
-| `type` | `PaymentType` | Yes | Payment type: `"external"`, `"storefront"`, or `"sloudfront"` |
+| `type` | `"external"` | Yes | Payment type (must be `"external"`) |
 | `public_key` | `string` | Yes | Your public API key for secure payments |
-| `isLocalEnv` | `boolean` | No | Set to `true` for local development environment |
-
-#### External Payment Options
-
-| Parameter | Type | Required | Description |
-| ---------- | --------- | -------- | ------------------------------------------ |
 | `amount` | `number` | Yes | Payment amount in smallest currency unit |
 | `customer` | `Customer` | Yes | Customer information object |
+| `isLocalEnv` | `boolean` | No | Set to `true` for local development environment |
 
-#### Storefront Payment Options
-
-| Parameter | Type | Required | Description |
-| -------------------- | ------------------ | -------- | ------------------------------------------ |
-| `slug` | `string` | Yes | Store identifier |
-| `amount` | `number` | Yes | Additional amount (e.g., shipping fees) |
-| `discount` | `number` | No | Discount amount |
-| `channel` | `ChannelType` | Yes | Delivery channel: `"pickup"` or `"delivery"` |
-| `customer` | `Customer` | Yes | Customer information object |
-| `delivery_details` | `DeliveryDetails` | Yes | Delivery address and notes |
-| `products` | `Product[]` | Yes | Array of products in the order |
-
-**Note:** Payment method is selected by the user within the widget UI based on available payment options.
-
-#### Sloudfront Payment Options
 
-| Parameter | Type | Required | Description |
-| -------------------- | ------------------ | -------- | ------------------------------------------ |
-| `transaction_id` | `string` | Yes | Existing transaction ID |
-| `customer_id` | `string` | Yes | Existing customer ID |
-| `business_id` | `string` | Yes | Existing business ID |
-| `amount` | `number` | Yes | Additional amount |
-| `discount` | `number` | No | Discount amount |
-| `channel` | `ChannelType` | Yes | Delivery channel: `"pickup"` or `"delivery"` |
-| `customer` | `Customer` | Yes | Customer information object |
-| `delivery_details` | `DeliveryDetails` | Yes | Delivery address and notes |
-| `products` | `Product[]` | Yes | Array of products in the order |
-
-**Note:** Payment method is selected by the user within the widget UI based on available payment options.
 
 #### Type Definitions
 
@@ -250,35 +128,6 @@ interface Customer {
 }
 ```
 
-**DeliveryDetails**
-```ts
-interface DeliveryDetails {
-  street: string;
-  city: string;
-  state: string;
-  country: string;
-  note?: string;
-}
-```
-
-**Product**
-```ts
-interface Product {
-  product_id: string;
-  quantity: number;
-  variation?: string[];
-}
-```
-
-**PaymentType**
-```ts
-type PaymentType = "external" | "storefront" | "sloudfront";
-```
-
-**ChannelType**
-```ts
-type ChannelType = "pickup" | "delivery";
-```
 
 #### Methods
 
@@ -302,14 +151,14 @@ widget.hidePopup();
 
 ## Validation and Error Handling
 
-The SDK includes built-in validation for all payment types:
+The SDK includes built-in validation:
 
 ```ts
 import {
   PaymentWidget,
   validatePaymentWidgetOptions,
   PaymentWidgetValidationError,
-} from "sloud-payment-sdk";
+} from "@vindhq/sloud-payment-sdk";
 
 try {
   const options = {
@@ -338,25 +187,26 @@ try {
 
 ## Advanced Usage
 
-### Extensible Payload Builders
+### Payload Builders
 
-The SDK uses a builder pattern for payment payloads and can be extended with custom payment types:
+The SDK uses a builder pattern for payment payloads:
 
 ```ts
 import {
   buildPaymentInstrumentPayload,
-  registerPayloadBuilder,
-  getRegisteredPaymentTypes,
-} from "sloud-payment-sdk";
-
-// Get all registered payment types
-const types = getRegisteredPaymentTypes();
-console.log(types); // ["external", "storefront", "sloudfront"]
+} from "@vindhq/sloud-payment-sdk";
 
 // Build payload from options
 const payload = buildPaymentInstrumentPayload({
   type: "external",
-  // ... other options
+  public_key: "pk_test_123",
+  amount: 10000,
+  customer: {
+    first_name: "John",
+    last_name: "Doe",
+    phone_number: "+2348012345678",
+    email: "john.doe@example.com",
+  },
 });
 ```
 
@@ -367,22 +217,20 @@ The SDK is written in TypeScript and provides full type definitions:
 ```ts
 import type {
   PaymentWidgetOptions,
-  ExternalPaymentWidgetOptions,
-  StorefrontPaymentWidgetOptions,
-  SloudfrontPaymentWidgetOptions,
-  PaymentType,
-  ChannelType,
   Customer,
-  DeliveryDetails,
-  Product,
-} from "sloud-payment-sdk";
+} from "@vindhq/sloud-payment-sdk";
 
-// TypeScript will enforce correct fields based on payment type
-const options: StorefrontPaymentWidgetOptions = {
-  type: "storefront",
+// TypeScript will enforce correct fields
+const options: PaymentWidgetOptions = {
+  type: "external",
   public_key: "pk_test_123",
-  slug: "my-store",
-  // ... TypeScript ensures all required fields are present
+  amount: 10000,
+  customer: {
+    first_name: "John",
+    last_name: "Doe",
+    phone_number: "+2348012345678",
+    email: "john.doe@example.com",
+  },
 };
 ```