@caspay/sdk 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,223 @@
+# CasPay SDK
+
+Official JavaScript/TypeScript SDK for CasPay - Accept crypto payments with Casper blockchain.
+
+[![npm version](https://img.shields.io/npm/v/@caspay/sdk)](https://www.npmjs.com/package/@caspay/sdk)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+## 🚀 Installation
+
+### NPM / Yarn (React, Next.js, Node.js)
+
+```bash
+npm install @caspay/sdk
+# or
+yarn add @caspay/sdk
+```
+
+### CDN (WordPress, HTML)
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@caspay/sdk@1.0.1/dist/caspay.min.js"></script>
+```
+
+## 📖 Quick Start
+
+### React / Next.js
+
+```typescript
+import CasPay from '@caspay/sdk';
+
+const caspay = new CasPay({
+  apiKey: 'cp_live_...',
+  merchantId: 'MERCH_...'
+});
+
+// Create a payment
+const payment = await caspay.payments.create({
+  senderAddress: '0x123...',
+  productId: 'prod_abc123',
+  amount: 100,
+  currency: 'USD'
+});
+
+console.log('Payment successful:', payment);
+```
+
+### WordPress / HTML
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@caspay/sdk@1.0.1/dist/caspay.min.js"></script>
+
+<button id="payBtn">Pay Now</button>
+
+<script>
+  const caspay = new CasPay({
+    apiKey: 'cp_live_...',
+    merchantId: 'MERCH_...'
+  });
+
+  document.getElementById('payBtn').onclick = async () => {
+    const payment = await caspay.payments.create({
+      senderAddress: '0x123...',
+      productId: 'prod_abc',
+      amount: 50
+    });
+    
+    alert('Payment successful!');
+  };
+</script>
+```
+
+## 🔧 Configuration
+
+### Constructor Options
+
+```typescript
+const caspay = new CasPay({
+  apiKey: string;        // Required: Your CasPay API key
+  merchantId: string;    // Required: Your merchant ID
+  baseUrl?: string;      // Optional: API base URL (default: https://api.caspay.link)
+});
+```
+
+### Get API Keys
+
+1. Sign up at [caspay.link](https://caspay.link)
+2. Navigate to Settings → API Keys
+3. Generate a new API key
+
+## 📚 API Reference
+
+### Payments
+
+#### `caspay.payments.create(params)`
+
+Create a new payment record.
+
+**Parameters:**
+
+```typescript
+{
+  senderAddress: string;           // Sender's Casper wallet address
+  productId?: string;              // Product ID (for one-time payments)
+  subscriptionPlanId?: string;     // Subscription plan ID (for recurring)
+  amount: number;                  // Payment amount
+  currency?: string;               // Currency code (default: USD)
+  transactionHash?: string;        // Optional: Casper transaction hash
+}
+```
+
+**Returns:**
+
+```typescript
+{
+  success: boolean;
+  payment: {
+    id: string;
+    transaction_hash: string;
+    amount: number;
+    token: string;
+    status: string;
+    invoice_number: string;
+    created_at: string;
+  };
+  verification?: {
+    verified: boolean;
+    transaction_hash: string;
+    amount: number;
+  };
+}
+```
+
+**Example:**
+
+```typescript
+// One-time payment
+const payment = await caspay.payments.create({
+  senderAddress: '0x123...',
+  productId: 'prod_abc123',
+  amount: 100
+});
+
+// Subscription payment
+const subscription = await caspay.payments.create({
+  senderAddress: '0x123...',
+  subscriptionPlanId: 'plan_xyz789',
+  amount: 29.99
+});
+```
+
+## 🛠️ Error Handling
+
+All SDK methods throw structured errors:
+
+```typescript
+try {
+  const payment = await caspay.payments.create({...});
+} catch (error) {
+  console.error('Error:', error.error);   // Error message
+  console.error('Code:', error.code);     // Error code
+  console.error('Status:', error.status); // HTTP status
+}
+```
+
+### Common Error Codes
+
+- `INVALID_PARAMS` - Missing or invalid parameters
+- `INVALID_API_KEY` - Invalid API key
+- `RATE_LIMIT_EXCEEDED` - Too many requests
+- `VERIFICATION_FAILED` - Transaction verification failed
+- `NETWORK_ERROR` - Network connection error
+
+## 🌐 Environment Support
+
+| Environment | Installation | Import |
+|-------------|--------------|--------|
+| React/Next.js | `npm install @caspay/sdk` | `import CasPay from '@caspay/sdk'` |
+| Node.js | `npm install @caspay/sdk` | `const CasPay = require('@caspay/sdk')` |
+| WordPress | CDN script tag | `window.CasPay` |
+| HTML | CDN script tag | `window.CasPay` |
+
+## 🔒 Security
+
+- **Never expose your API key** in client-side code in production
+- Use environment variables for sensitive data
+- API keys should be stored server-side
+- Use test keys (`cp_test_...`) for development
+
+## 📦 TypeScript Support
+
+Full TypeScript support with type definitions included:
+
+```typescript
+import CasPay, { PaymentCreateParams, PaymentResponse } from '@caspay/sdk';
+
+const params: PaymentCreateParams = {
+  senderAddress: '0x123...',
+  productId: 'prod_abc',
+  amount: 100
+};
+
+const payment: PaymentResponse = await caspay.payments.create(params);
+```
+
+## 🔗 Links
+
+- **Documentation:** [docs.caspay.link](https://docs.caspay.link)
+- **Dashboard:** [caspay.link](https://caspay.link)
+- **NPM:** [@caspay/sdk](https://www.npmjs.com/package/@caspay/sdk)
+- **GitHub:** [dmrdvn/caspay-sdk](https://github.com/dmrdvn/caspay-sdk)
+
+## 📄 License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## 🤝 Support
+
+- Email: support@caspay.link
+- Issues: [GitHub Issues](https://github.com/dmrdvn/caspay-sdk/issues)
+
+---
+
+Made with ❤️ by CasPay Team

package/dist/caspay.min.js

@@ -1 +1 @@
-!function(t,e){"object"==typeof exports&&"undefined"!=typeof module?module.exports=e():"function"==typeof define&&define.amd?define(e):(t="undefined"!=typeof globalThis?globalThis:t||self).CasPay=e()}(this,function(){"use strict";class t{constructor(t){if(this.SDK_VERSION="1.0.0",this.baseUrl=t.baseUrl||"https://api.caspay.link",this.apiKey=t.apiKey,this.merchantId=t.merchantId,!this.apiKey)throw new Error("CasPay SDK: apiKey is required");if(!this.merchantId)throw new Error("CasPay SDK: merchantId is required")}async request(t,e,r){const s=`${this.baseUrl}${e}`;try{const e=await fetch(s,{method:t,headers:{"Content-Type":"application/json","X-CasPay-Key":this.apiKey,"X-CasPay-SDK-Version":this.SDK_VERSION,"User-Agent":`CasPay-SDK-JS/${this.SDK_VERSION}`},body:r?JSON.stringify(r):void 0}),i=await e.json();if(!e.ok){throw{error:i.error||"Request failed",code:i.code||"UNKNOWN_ERROR",status:e.status}}return i}catch(t){if(t.error&&t.code)throw t;throw{error:t.message||"Network error",code:"NETWORK_ERROR",status:0}}}getMerchantId(){return this.merchantId}}class e{constructor(t){this.client=t}async create(t){if(!t.senderAddress)throw{error:"senderAddress is required",code:"INVALID_PARAMS",status:400};if(!t.amount||t.amount<=0)throw{error:"amount must be greater than 0",code:"INVALID_PARAMS",status:400};if(!t.productId&&!t.subscriptionPlanId)throw{error:"Either productId or subscriptionPlanId is required",code:"INVALID_PARAMS",status:400};const e={merchant_id:this.client.getMerchantId(),sender_address:t.senderAddress,transaction_hash:t.transactionHash||`mock_tx_${Date.now()}`,product_id:t.productId,subscription_plan_id:t.subscriptionPlanId,amount:t.amount,currency:t.currency||"USD"};return this.client.request("POST","/api/v1/payments/record",e)}}class r{constructor(r){this.client=new t(r),this.payments=new e(this.client)}static get version(){return"1.0.0"}}return"undefined"!=typeof window&&(window.CasPay=r),r});
+!function(t,e){"object"==typeof exports&&"undefined"!=typeof module?module.exports=e():"function"==typeof define&&define.amd?define(e):(t="undefined"!=typeof globalThis?globalThis:t||self).CasPay=e()}(this,function(){"use strict";class t{constructor(t){if(this.SDK_VERSION="1.0.1",this.baseUrl=t.baseUrl||"https://api.caspay.link",this.apiKey=t.apiKey,this.merchantId=t.merchantId,!this.apiKey)throw new Error("CasPay SDK: apiKey is required");if(!this.merchantId)throw new Error("CasPay SDK: merchantId is required")}async request(t,e,r){const s=`${this.baseUrl}${e}`;try{const e=await fetch(s,{method:t,headers:{"Content-Type":"application/json","X-CasPay-Key":this.apiKey,"X-CasPay-SDK-Version":this.SDK_VERSION,"User-Agent":`CasPay-SDK-JS/${this.SDK_VERSION}`},body:r?JSON.stringify(r):void 0}),i=await e.json();if(!e.ok){throw{error:i.error||"Request failed",code:i.code||"UNKNOWN_ERROR",status:e.status}}return i}catch(t){if(t.error&&t.code)throw t;throw{error:t.message||"Network error",code:"NETWORK_ERROR",status:0}}}getMerchantId(){return this.merchantId}}class e{constructor(t){this.client=t}async create(t){if(!t.senderAddress)throw{error:"senderAddress is required",code:"INVALID_PARAMS",status:400};if(!t.amount||t.amount<=0)throw{error:"amount must be greater than 0",code:"INVALID_PARAMS",status:400};if(!t.productId&&!t.subscriptionPlanId)throw{error:"Either productId or subscriptionPlanId is required",code:"INVALID_PARAMS",status:400};const e={merchant_id:this.client.getMerchantId(),sender_address:t.senderAddress,transaction_hash:t.transactionHash||`mock_tx_${Date.now()}`,product_id:t.productId,subscription_plan_id:t.subscriptionPlanId,amount:t.amount,currency:t.currency||"USD"};return this.client.request("POST","/api/v1/payments/record",e)}}class r{constructor(r){this.client=new t(r),this.payments=new e(this.client)}static get version(){return"1.0.0"}}return"undefined"!=typeof window&&(window.CasPay=r),r});

package/dist/index.esm.js

@@ -4,7 +4,7 @@
  */
 class HttpClient {
     constructor(config) {
-        this.SDK_VERSION = '1.0.0';
+        this.SDK_VERSION = '1.0.1';
         // Use production API by default
         this.baseUrl = config.baseUrl || 'https://api.caspay.link';
         this.apiKey = config.apiKey;

package/dist/index.js

@@ -8,7 +8,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
  */
 class HttpClient {
     constructor(config) {
-        this.SDK_VERSION = '1.0.0';
+        this.SDK_VERSION = '1.0.1';
         // Use production API by default
         this.baseUrl = config.baseUrl || 'https://api.caspay.link';
         this.apiKey = config.apiKey;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caspay/sdk",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Official CasPay JavaScript/TypeScript SDK - Accept crypto payments with Casper blockchain",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",