@tagadapay/plugin-sdk 1.0.30 → 2.0.2

package/README.md

@@ -1,414 +1,504 @@
-# TagadaPay Plugin SDK
-
-A comprehensive SDK for building checkout plugins on the TagadaPay platform. Create custom checkout experiences with React components, payment processing, and advanced features.
-
-## 📚 Documentation
-
-### Core APIs
-
-- **[useCheckout](./README-useCheckout.md)** - Checkout state management and flow control
-- **[setCheckoutInfo](./README-setCheckoutInfo.md)** - Customer information and validation
-- **[useOffers](./README-useOffers.md)** - Dynamic pricing and promotional offers
-- **[Money utilities](./README-money.md)** - Currency formatting and calculations
-- **[URL utilities](./README-urlUtils.md)** - Navigation and routing helpers
-
-### Examples
-
-- **[Vite Checkout Demo](../checkout-vite)** - Complete checkout implementation
-
-## 🚀 Quick Start
-
-### Installation
-
-```bash
-npm install @tagadapay/plugin-sdk
-```
-
-### Basic Usage
-
-```typescript
-import { useCheckout, setCheckoutInfo } from '@tagadapay/plugin-sdk';
-
-function CheckoutPage() {
-  const { customer, cart, payment } = useCheckout();
-
-  const handleSubmit = async (data) => {
-    await setCheckoutInfo({
-      customer: data.customer,
-      payment: data.payment
-    });
-  };
-
-  return (
-    <div>
-      {/* Your checkout UI */}
-    </div>
-  );
-}
-```
-
-## 🎯 Key Features
-
-### Payment Processing
-
-- Secure tokenized payments
-- Multiple payment method support
-- Real-time validation
-- PCI compliance
-
-### Customer Management
-
-- Profile management
-- Address validation
-- Order history
-- Preferences
-
-### Cart & Pricing
-
-- Dynamic pricing
-- Promotional offers
-- Tax calculations
-- Currency conversion
-
-### UI Components
-
-- Pre-built checkout components
-- Customizable themes
-- Mobile-optimized
-- Accessibility features
-
-## 📖 API Reference
-
-### Core Hooks
-
-#### useCheckout()
-
-Primary hook for checkout state management.
-
-```typescript
-const {
-  customer, // Customer information
-  cart, // Shopping cart state
-  payment, // Payment details
-  shipping, // Shipping information
-  loading, // Loading states
-  errors, // Error handling
-} = useCheckout();
-```
-
-#### useOffers()
-
-Hook for managing dynamic offers and pricing.
-
-```typescript
-const {
-  offers, // Available offers
-  applyOffer, // Apply offer function
-  removeOffer, // Remove offer function
-  total, // Calculated total
-} = useOffers();
-```
-
-### Utility Functions
-
-#### setCheckoutInfo()
-
-Update checkout information with validation.
-
-```typescript
-await setCheckoutInfo({
-  customer: {
-    email: 'user@example.com',
-    firstName: 'John',
-    lastName: 'Doe',
-  },
-  payment: {
-    method: 'card',
-    token: 'pm_token_123',
-  },
-});
-```
-
-#### Money utilities
-
-Format and calculate monetary values.
-
-```typescript
-import { formatMoney, convertCurrency } from '@tagadapay/plugin-sdk';
-
-const formatted = formatMoney(2999, 'USD'); // "$29.99"
-const converted = convertCurrency(2999, 'USD', 'EUR'); // 2699
-```
-
-## 🛠️ Development
-
-### Local Development
-
-```bash
-# Install dependencies
-npm install
-
-# Start development server
-npm run dev
-
-# Build for production
-npm run build
-```
-
-### Testing
-
-```bash
-# Run tests
-npm test
-
-# Run tests with coverage
-npm run test:coverage
-```
-
-### Linting
-
-```bash
-# Check code style
-npm run lint
-
-# Fix linting issues
-npm run lint:fix
-```
-
-## 📦 Build & Deploy
-
-### Building Your Plugin
-
-```bash
-# Build optimized bundle
-npm run build
-
-# Analyze bundle size
-npm run analyze
-```
-
-### Deployment
-
-```bash
-# Deploy using TagadaPay CLI
-npx @tagadapay/plugin-cli deploy
-
-# Deploy specific environment
-npx @tagadapay/plugin-cli deploy --env production
-```
-
-## 🔧 Configuration
-
-### Plugin Configuration
-
-```json
-{
-  "name": "My Checkout Plugin",
-  "version": "1.0.0",
-  "description": "Custom checkout experience",
-  "main": "dist/index.js",
-  "tagadapay": {
-    "type": "checkout",
-    "mode": "direct",
-    "framework": "react"
-  }
-}
-```
-
-### Environment Variables
-
-```env
-TAGADAPAY_API_KEY=your_api_key
-TAGADAPAY_ENVIRONMENT=sandbox
-TAGADAPAY_STORE_ID=your_store_id
-```
-
-## 🎨 Styling & Themes
-
-### CSS Custom Properties
-
-```css
-:root {
-  --tagada-primary: #007bff;
-  --tagada-secondary: #6c757d;
-  --tagada-success: #28a745;
-  --tagada-danger: #dc3545;
-  --tagada-border-radius: 4px;
-  --tagada-font-family: -apple-system, BlinkMacSystemFont, sans-serif;
-}
-```
-
-### Component Styling
-
-```typescript
-import { styled } from '@tagadapay/plugin-sdk';
-
-const StyledButton = styled.button`
-  background: var(--tagada-primary);
-  color: white;
-  border-radius: var(--tagada-border-radius);
-  padding: 12px 24px;
-  border: none;
-  cursor: pointer;
-
-  &:hover {
-    opacity: 0.9;
-  }
-`;
-```
-
-## 🔐 Security
-
-### Best Practices
-
-- Never store sensitive payment data
-- Always validate user inputs
-- Use HTTPS in production
-- Implement proper error handling
-- Follow PCI DSS guidelines
-
-### Token Management
-
-```typescript
-// ✅ Good: Use tokenized payments
-const paymentToken = await tokenizePayment(cardData);
-await processPayment({ token: paymentToken });
-
-// ❌ Bad: Never store raw card data
-// const cardNumber = '4111111111111111'; // Don't do this
-```
-
-## 📱 Mobile Optimization
-
-### Responsive Design
-
-```css
-.checkout-container {
-  max-width: 600px;
-  margin: 0 auto;
-  padding: 16px;
-}
-
-@media (max-width: 768px) {
-  .checkout-container {
-    padding: 8px;
-  }
-
-  .checkout-form {
-    font-size: 16px; /* Prevent zoom on iOS */
-  }
-}
-```
-
-### Touch Interactions
-
-```typescript
-const handleTouchStart = (e) => {
-  // Optimize for touch devices
-  e.preventDefault();
-  // Handle touch interaction
-};
-```
-
-## 🌐 Internationalization
-
-### Multi-language Support
-
-```typescript
-import { useTranslation } from '@tagadapay/plugin-sdk';
-
-function CheckoutForm() {
-  const { t } = useTranslation();
-
-  return (
-    <form>
-      <label>{t('checkout.email')}</label>
-      <input type="email" placeholder={t('checkout.email_placeholder')} />
-    </form>
-  );
-}
-```
-
-### Currency Support
-
-```typescript
-import { useCurrency } from '@tagadapay/plugin-sdk';
-
-function PriceDisplay({ amount }) {
-  const { formatPrice, currency } = useCurrency();
-
-  return <span>{formatPrice(amount, currency)}</span>;
-}
-```
-
-## 📊 Analytics & Monitoring
-
-### Event Tracking
-
-```typescript
-import { trackEvent } from '@tagadapay/plugin-sdk';
-
-// Track user interactions
-trackEvent('checkout_started', {
-  product_id: 'prod_123',
-  value: 2999,
-  currency: 'USD',
-});
-
-// Track conversions
-trackEvent('purchase_completed', {
-  transaction_id: 'txn_456',
-  value: 2999,
-  currency: 'USD',
-});
-```
-
-### Performance Monitoring
-
-```typescript
-import { performance } from '@tagadapay/plugin-sdk';
-
-// Measure load times
-performance.mark('checkout-start');
-// ... checkout logic
-performance.mark('checkout-end');
-performance.measure('checkout-duration', 'checkout-start', 'checkout-end');
-```
-
-## 🤝 Contributing
-
-### Development Setup
-
-```bash
-# Clone the repository
-git clone https://github.com/tagadapay/plugin-sdk.git
-
-# Install dependencies
-npm install
-
-# Start development
-npm run dev
-```
-
-### Submitting Changes
-
-1. Fork the repository
-2. Create a feature branch
-3. Make your changes
-4. Add tests
-5. Submit a pull request
-
-## 📄 License
-
-MIT License - see [LICENSE](./LICENSE) for details.
-
-## 🆘 Support
-
-- **Documentation**: [docs.tagadapay.com](https://docs.tagadapay.com)
-- **Discord**: [discord.gg/tagadapay](https://discord.gg/tagadapay)
-- **Email**: support@tagadapay.com
-- **GitHub Issues**: [github.com/tagadapay/plugin-sdk/issues](https://github.com/tagadapay/plugin-sdk/issues)
-
----
-
-Built with ❤️ by the TagadaPay team
+# TagadaPay Plugin SDK
+
+A comprehensive SDK for building checkout plugins on the TagadaPay platform. Create custom checkout experiences with React components, payment processing, and advanced features.
+
+## 📚 Documentation
+
+### Core APIs
+
+- **[useCheckout](./docs/README-useCheckout.md)** - Checkout state management and flow control
+- **[setCheckoutInfo](./docs/README-setCheckoutInfo.md)** - Customer information and validation
+- **[useOffers](./docs/README-useOffers.md)** - Dynamic pricing and promotional offers
+- **[Money utilities](./docs/README-money.md)** - Currency formatting and calculations
+- **[URL utilities](./docs/README-urlUtils.md)** - Navigation and routing helpers
+
+### Plugin Development
+
+- **[Plugin Configuration](./docs/PLUGIN_CONFIG.md)** - How to access store context, config, and branding
+- **[Google Autocomplete](./docs/README-google-autocomplete.md)** - Address autocomplete with Google Places API
+- **[ISO Data](./docs/README-iso-data.md)** - Country and region data with Google integration
+
+### Examples
+
+- **[Vite Checkout Demo](../checkout-vite)** - Complete checkout implementation
+
+## 🏗️ Building a Plugin
+
+### Plugin Structure
+
+Every TagadaPay plugin follows this simple structure:
+
+```
+my-plugin/
+├── plugin.manifest.json    # Plugin metadata & routing
+├── .local.json            # Local dev config (auto-injected in production)
+├── config/                # Optional deployment configs
+│   ├── theme-green.json   # Config variant A
+│   └── theme-blue.json    # Config variant B
+├── src/
+│   └── App.tsx           # Your plugin code
+└── dist/                 # Built plugin files
+```
+
+### Configuration Flow
+
+```mermaid
+graph TD
+    A[🛠️ Local Development] --> B[.local.json]
+    A --> C[config/*.json]
+    B --> D[usePluginConfig()]
+    C --> D
+
+    E[🚀 Production] --> F[Platform Injection]
+    F --> G[HTTP Headers & Meta Tags]
+    G --> D
+
+    D --> H[Your Plugin Component]
+
+    style A fill:#e1f5fe
+    style E fill:#f3e5f5
+    style D fill:#fff3e0
+    style H fill:#e8f5e8
+```
+
+### Essential Files
+
+#### 1. **`plugin.manifest.json`** - Plugin Metadata
+
+```json
+{
+  "pluginId": "my-awesome-plugin",
+  "name": "My Awesome Plugin",
+  "version": "1.0.0",
+  "mode": "direct-mode",
+  "router": {
+    "basePath": "/",
+    "matcher": ".*",
+    "excluder": "/checkout"
+  }
+}
+```
+
+#### 2. **`.local.json`** - Local Development Context
+
+```json
+{
+  "storeId": "store_abc123",
+  "accountId": "acc_xyz789",
+  "basePath": "/"
+}
+```
+
+> ⚠️ **Auto-managed**: This file is only for local dev. In production, the platform injects this data automatically.
+
+#### 3. **`config/my-theme.json`** - Optional Deployment Config
+
+```json
+{
+  "configName": "green-theme",
+  "branding": {
+    "primaryColor": "#059669",
+    "companyName": "My Store",
+    "logoUrl": "https://example.com/logo.png"
+  },
+  "features": {
+    "enableChat": true,
+    "maxItems": 10
+  }
+}
+```
+
+> 📝 **Note**: Config can contain any keys you need - the SDK doesn't enforce a specific structure.
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+npm install @tagadapay/plugin-sdk
+```
+
+### Basic Plugin Setup
+
+```tsx
+import React from 'react';
+import {
+  TagadaProvider,
+  usePluginConfig,
+  useGoogleAutocomplete,
+  useISOData,
+} from '@tagadapay/plugin-sdk/react';
+
+function MyPlugin() {
+  const { storeId, accountId, basePath, config, loading } = usePluginConfig();
+
+  // Optional: Add address autocomplete
+  const { searchPlaces, predictions } = useGoogleAutocomplete({
+    apiKey: config?.googleMapsApiKey || 'YOUR_API_KEY',
+  });
+
+  // Optional: Add country/region data
+  const { countries } = useISOData('en');
+
+  if (loading) return <div>Loading...</div>;
+
+  return (
+    <div style={{ '--primary': config?.branding?.primaryColor }}>
+      <h1>Welcome to {config?.branding?.companyName}</h1>
+      <p>Store: {storeId}</p>
+      <p>Base Path: {basePath}</p>
+      <p>Available Countries: {Object.keys(countries).length}</p>
+    </div>
+  );
+}
+
+// Wrap your plugin with TagadaProvider
+function App() {
+  return (
+    <TagadaProvider>
+      <MyPlugin />
+    </TagadaProvider>
+  );
+}
+
+export default App;
+```
+
+### Development vs Production
+
+| Environment    | Store/Account ID | Deployment Config | How it Works       |
+| -------------- | ---------------- | ----------------- | ------------------ |
+| **Local Dev**  | `.local.json`    | `config/*.json`   | Files on disk      |
+| **Production** | HTTP Headers     | Meta Tags         | Platform injection |
+
+```tsx
+// ✅ ALWAYS use hooks - works in both environments
+const { storeId, accountId, basePath, config } = usePluginConfig();
+
+// ❌ NEVER access directly
+// const config = window.__PLUGIN_CONFIG__; // Doesn't exist!
+```
+
+## 🎯 Key Features
+
+### Payment Processing
+
+- Secure tokenized payments
+- Multiple payment method support
+- Real-time validation
+- PCI compliance
+
+### Customer Management
+
+- Profile management
+- Address validation
+- Order history
+- Preferences
+
+### Cart & Pricing
+
+- Dynamic pricing
+- Promotional offers
+- Tax calculations
+- Currency conversion
+
+### UI Components
+
+- Pre-built checkout components
+- Customizable themes
+- Mobile-optimized
+- Accessibility features
+
+## 📖 API Reference
+
+### Core Hooks
+
+#### useCheckout()
+
+Primary hook for checkout state management.
+
+```typescript
+const {
+  customer, // Customer information
+  cart, // Shopping cart state
+  payment, // Payment details
+  shipping, // Shipping information
+  loading, // Loading states
+  errors, // Error handling
+} = useCheckout();
+```
+
+#### useOffers()
+
+Hook for managing dynamic offers and pricing.
+
+```typescript
+const {
+  offers, // Available offers
+  applyOffer, // Apply offer function
+  removeOffer, // Remove offer function
+  total, // Calculated total
+} = useOffers();
+```
+
+### Utility Functions
+
+#### setCheckoutInfo()
+
+Update checkout information with validation.
+
+```typescript
+await setCheckoutInfo({
+  customer: {
+    email: 'user@example.com',
+    firstName: 'John',
+    lastName: 'Doe',
+  },
+  payment: {
+    method: 'card',
+    token: 'pm_token_123',
+  },
+});
+```
+
+#### Money utilities
+
+Format and calculate monetary values.
+
+```typescript
+import { formatMoney, convertCurrency } from '@tagadapay/plugin-sdk';
+
+const formatted = formatMoney(2999, 'USD'); // "$29.99"
+const converted = convertCurrency(2999, 'USD', 'EUR'); // 2699
+```
+
+## 🛠️ Development
+
+### Local Development
+
+```bash
+# Install dependencies
+npm install
+
+# Start development server
+npm run dev
+
+# Build for production
+npm run build
+```
+
+### Testing
+
+```bash
+# Run tests
+npm test
+
+# Run tests with coverage
+npm run test:coverage
+```
+
+### Linting
+
+```bash
+# Check code style
+npm run lint
+
+# Fix linting issues
+npm run lint:fix
+```
+
+## 📦 Build & Deploy
+
+### Building Your Plugin
+
+```bash
+# Build optimized bundle
+npm run build
+
+# Analyze bundle size
+npm run analyze
+```
+
+### Deployment
+
+```bash
+# Deploy using TagadaPay CLI
+npx @tagadapay/plugin-cli deploy
+
+# Deploy specific environment
+npx @tagadapay/plugin-cli deploy --env production
+```
+
+## 🔧 Configuration
+
+### Plugin Configuration
+
+```json
+{
+  "name": "My Checkout Plugin",
+  "version": "1.0.0",
+  "description": "Custom checkout experience",
+  "main": "dist/index.js",
+  "tagadapay": {
+    "type": "checkout",
+    "mode": "direct",
+    "framework": "react"
+  }
+}
+```
+
+## 🔐 Security
+
+### Best Practices
+
+- Never store sensitive payment data
+- Always validate user inputs
+- Use HTTPS in production
+- Implement proper error handling
+- Follow PCI DSS guidelines
+
+### Token Management
+
+```typescript
+// ✅ Good: Use tokenized payments
+const paymentToken = await tokenizePayment(cardData);
+await processPayment({ token: paymentToken });
+
+// ❌ Bad: Never store raw card data
+// const cardNumber = '4111111111111111'; // Don't do this
+```
+
+## 📱 Mobile Optimization
+
+### Responsive Design
+
+```css
+.checkout-container {
+  max-width: 600px;
+  margin: 0 auto;
+  padding: 16px;
+}
+
+@media (max-width: 768px) {
+  .checkout-container {
+    padding: 8px;
+  }
+
+  .checkout-form {
+    font-size: 16px; /* Prevent zoom on iOS */
+  }
+}
+```
+
+### Touch Interactions
+
+```typescript
+const handleTouchStart = (e) => {
+  // Optimize for touch devices
+  e.preventDefault();
+  // Handle touch interaction
+};
+```
+
+## 🌐 Internationalization
+
+### Multi-language Support
+
+```typescript
+import { useTranslation } from '@tagadapay/plugin-sdk';
+
+function CheckoutForm() {
+  const { t } = useTranslation();
+
+  return (
+    <form>
+      <label>{t('checkout.email')}</label>
+      <input type="email" placeholder={t('checkout.email_placeholder')} />
+    </form>
+  );
+}
+```
+
+### Currency Support
+
+```typescript
+import { useCurrency } from '@tagadapay/plugin-sdk';
+
+function PriceDisplay({ amount }) {
+  const { formatPrice, currency } = useCurrency();
+
+  return <span>{formatPrice(amount, currency)}</span>;
+}
+```
+
+## 📊 Analytics & Monitoring
+
+### Event Tracking
+
+```typescript
+import { trackEvent } from '@tagadapay/plugin-sdk';
+
+// Track user interactions
+trackEvent('checkout_started', {
+  product_id: 'prod_123',
+  value: 2999,
+  currency: 'USD',
+});
+
+// Track conversions
+trackEvent('purchase_completed', {
+  transaction_id: 'txn_456',
+  value: 2999,
+  currency: 'USD',
+});
+```
+
+### Performance Monitoring
+
+```typescript
+import { performance } from '@tagadapay/plugin-sdk';
+
+// Measure load times
+performance.mark('checkout-start');
+// ... checkout logic
+performance.mark('checkout-end');
+performance.measure('checkout-duration', 'checkout-start', 'checkout-end');
+```
+
+## 🤝 Contributing
+
+### Development Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/tagadapay/plugin-sdk.git
+
+# Install dependencies
+npm install
+
+# Start development
+npm run dev
+```
+
+### Submitting Changes
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests
+5. Submit a pull request
+
+## 📄 License
+
+MIT License - see [LICENSE](./LICENSE) for details.
+
+## 🆘 Support
+
+- **Documentation**: [docs.tagadapay.com](https://docs.tagadapay.com)
+- **Discord**: [discord.gg/tagadapay](https://discord.gg/tagadapay)
+- **Email**: support@tagadapay.com
+- **GitHub Issues**: [github.com/tagadapay/plugin-sdk/issues](https://github.com/tagadapay/plugin-sdk/issues)
+
+---
+
+Built with ❤️ by the TagadaPay team