@henrylabs-interview/payment-processor 0.1.11 → 0.1.12

package/README.md

@@ -1,8 +1,15 @@
-# Henry Labs - Interview: Payment Processor
+# Henry Labs – Interview: Payment Processor
 
-A lightweight payments SDK for creating and confirming checkouts, with built-in webhook support.
+A lightweight payments SDK for creating and confirming checkouts, with built-in webhook support and an embeddable checkout UI.
 
-This SDK simulates a real-world payment processing system, including fraud detection, transient errors, retries, and asynchronous authorization flows.
+This SDK simulates a real-world payment processing system, including:
+
+- Fraud detection
+- Transient system errors
+- Retry scenarios
+- Asynchronous authorization flows
+
+It is designed to test robustness, error handling, and webhook integration.
 
 ---
 
@@ -20,35 +27,48 @@ bun run build
 
 ---
 
-## Overview
+# Overview
 
-The SDK provides three primary capabilities:
+The SDK provides:
 
-- Create a checkout
-- Confirm a checkout
-- Register webhook endpoints
+- Checkout creation
+- Checkout confirmation
+- Webhook endpoint registration
+- Embeddable checkout UI (frontend)
+- API key validation
 
-The system performs internal validation, fraud screening, and risk checks.
-Depending on system conditions, operations may:
+The system performs internal validation, fraud screening, and simulated load conditions.
+
+Operations may:
 
 - Succeed immediately
-- Succeed asynchronously
-- Require a retry
-- Fail due to risk controls
+- Resolve asynchronously
+- Require retries
+- Fail due to fraud controls
 - Fail due to temporary system overload
 
-Consumers should always handle both synchronous responses and webhook events.
-
 ---
 
-## Usage
+# Usage
 
-### Initialize
+---
+
+## Initialize (Backend)
 
 ```ts
-import { PaymentSDK } from 'henry-labs/take-home';
+import { PaymentProcessor } from 'henry-labs/take-home';
 
-const sdk = new PaymentSDK();
+const processor = new PaymentProcessor({
+	apiKey: ...,
+});
+```
+
+# Checkout API
+
+Available under:
+
+```ts
+processor.checkout;
 ```
 
 ---
@@ -56,96 +76,130 @@ const sdk = new PaymentSDK();
 ## Create a Checkout
 
 ```ts
-const response = await sdk.create({
+const response = await processor.checkout.create({
 	amount: 1000,
 	currency: 'USD',
 	customerId: 'cust_123',
 });
 ```
 
-### Behavior
+---
 
-Creating a checkout may:
+## Confirm a Checkout (Backend)
+
+```ts
+const response = await processor.checkout.confirm({
+	checkoutId: ...,
+	type: 'raw-card',
+	data: {
+		number: ...,
+		expMonth: XX,
+		expYear: XXXX,
+		cvc: XXX,
+	},
+});
+```
 
-- Return immediate approval
-- Return a pending authorization state
-- Return a retryable error
-- Return a fraud-related failure
-- Fail due to temporary internal errors
+# Embedded Checkout (Frontend)
 
-If the checkout is authorized asynchronously, the final outcome will be delivered via webhook.
+The SDK provides an optional embeddable checkout UI for collecting card details in the browser.
 
 ---
 
-## Confirm a Checkout
+## Initialize Embedded Checkout
 
 ```ts
-const response = await sdk.confirm({
-	checkoutId: '...',
-	type: 'raw-card',
-	data: {
-		number: '4242424242424242',
-		expMonth: 12,
-		expYear: 2030,
-		cvc: '123',
-	},
+import { EmbeddedCheckout } from 'henry-labs/take-home';
+
+const embedded = new EmbeddedCheckout({
+	checkoutId: 'chk_123',
 });
 ```
 
-### Behavior
+---
+
+## Render Embedded Checkout
+
+```ts
+embedded.render('checkout-container', (paymentToken) => {
+	console.log('Received payment token:', paymentToken);
 
-Confirmation requests are subject to:
+	// Send token to backend for confirmation
+});
+```
+
+### Parameters
+
+| Parameter            | Description                           |
+| -------------------- | ------------------------------------- |
+| `containerElementId` | ID of DOM element to render into      |
+| `callbackFn`         | Called with a generated payment token |
+
+### Behavior
 
-- Card validation
-- Fraud screening
-- Retry conditions
-- System load conditions
+- Renders a secure card collection UI
+- Collects card number, expiry, and CVC
+- Generates a payment token
+- Returns the token via callback
+- Token should be sent to your backend for confirmation
 
-Confirmations may resolve immediately or asynchronously.
-Webhook handling is required to receive final outcomes in deferred cases.
+The embedded checkout is intended for **browser environments only**.
 
 ---
 
-## Webhooks
+# Webhooks
 
-You can register webhook endpoints to receive event notifications.
+Available under:
 
 ```ts
-sdk.webhooks.createEndpoint({
+processor.webhooks;
+```
+
+---
+
+## Register Webhook Endpoint
+
+```ts
+processor.webhooks.createEndpoint({
 	url: 'https://example.com/webhooks',
 	event: 'checkout.confirm',
 	secret: 'whsec_...',
 });
 ```
 
-### Webhook Events
+---
 
-Events are emitted for:
+## Webhook Events
 
-- Checkout creation
-- Checkout confirmation
-- Success outcomes
-- Failure outcomes
+Events may be emitted for:
 
-Webhooks may be triggered for both synchronous and asynchronous results.
+- `checkout.create`
+- `checkout.confirm`
+- `checkout.success`
+- `checkout.failure`
 
-All webhook deliveries are signed if a secret is provided.
+Events are triggered for:
 
-Consumers are responsible for verifying signatures and handling retries idempotently.
+- Immediate outcomes
+- Asynchronous resolutions
+- Retry scenarios
 
 ---
 
-## Important Notes
+## Webhook Security
 
-- Not all operations resolve immediately.
-- Some failures are retryable.
-- The system may simulate temporary overload conditions.
-- Fraud checks may result in blocked transactions.
-- Consumers should implement robust retry and webhook handling logic.
+If a secret is provided:
+
+- Deliveries are signed
+- Consumers must verify signatures
+- Handlers must be idempotent
+
+Retries may occur if delivery fails.
 
 ---
 
-## Disclaimer
+# Disclaimer
 
 This SDK is intended for evaluation and sandbox purposes only.
-It does not process real payments.
+
+It does **not** process real payments and should not be used in production.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@henrylabs-interview/payment-processor",
-	"version": "0.1.11",
+	"version": "0.1.12",
 	"type": "module",
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",