lokicms-plugin-stripe 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 MauricioPerera
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,209 @@
+# Stripe Plugin for LokiCMS
+
+Accept payments and manage subscriptions with Stripe.
+
+## Features
+
+- **Checkout Sessions**: Create payment and subscription checkout flows
+- **Customer Portal**: Allow customers to manage their subscriptions
+- **Subscription Management**: Create, update, cancel subscriptions
+- **Product & Price Sync**: Sync Stripe products/prices to LokiCMS entries
+- **Webhook Handling**: Automatic sync on Stripe events
+- **MCP Tools**: AI-accessible tools for payment operations
+
+## Installation
+
+The plugin is included in LokiCMS. Enable it in `plugins.json`:
+
+```json
+{
+  "plugins": [
+    {
+      "name": "stripe",
+      "enabled": true,
+      "source": "local",
+      "path": "./plugins/stripe",
+      "settings": {
+        "secretKey": "${STRIPE_SECRET_KEY}",
+        "webhookSecret": "${STRIPE_WEBHOOK_SECRET}",
+        "successUrl": "https://yoursite.com/checkout/success",
+        "cancelUrl": "https://yoursite.com/checkout/cancel",
+        "portalReturnUrl": "https://yoursite.com/account",
+        "currency": "usd"
+      }
+    }
+  ]
+}
+```
+
+## Environment Variables
+
+```bash
+STRIPE_SECRET_KEY=sk_live_... # or sk_test_... for testing
+STRIPE_WEBHOOK_SECRET=whsec_...
+```
+
+## Content Types
+
+The plugin creates these content types to sync Stripe data:
+
+| Content Type | Description |
+|--------------|-------------|
+| `stripe-product` | Products from Stripe catalog |
+| `stripe-price` | Prices (one-time or recurring) |
+| `stripe-subscription` | Customer subscriptions |
+| `stripe-invoice` | Invoices and payment records |
+| `stripe-customer` | Customer records linked to users |
+
+## API Endpoints
+
+Base path: `/api/plugins/stripe`
+
+### Checkout
+
+```bash
+# Create checkout session
+POST /checkout
+{
+  "priceId": "price_xxx",
+  "customerEmail": "user@example.com",
+  "mode": "subscription"
+}
+
+# Response
+{
+  "id": "cs_xxx",
+  "url": "https://checkout.stripe.com/..."
+}
+```
+
+### Customer Portal
+
+```bash
+# Create portal session
+POST /portal
+{
+  "customerId": "cus_xxx"
+}
+```
+
+### Products & Prices
+
+```bash
+GET /products
+GET /products?active=true
+GET /prices
+GET /prices?productId=prod_xxx&type=recurring
+```
+
+### Subscriptions
+
+```bash
+GET /subscriptions
+GET /subscriptions/:id
+POST /subscriptions/:id/cancel
+POST /subscriptions/:id/resume
+```
+
+### Invoices
+
+```bash
+GET /invoices
+GET /invoices?customerId=cus_xxx
+```
+
+### Sync
+
+```bash
+# Sync products from Stripe
+POST /sync/products
+
+# Sync prices from Stripe
+POST /sync/prices
+```
+
+### Webhooks
+
+```bash
+POST /webhook  # Stripe webhook endpoint
+```
+
+Configure in Stripe Dashboard:
+- Endpoint: `https://yoursite.com/api/plugins/stripe/webhook`
+- Events to send:
+  - `customer.subscription.created`
+  - `customer.subscription.updated`
+  - `customer.subscription.deleted`
+  - `invoice.paid`
+  - `invoice.payment_failed`
+  - `checkout.session.completed`
+  - `product.created`
+  - `product.updated`
+  - `price.created`
+  - `price.updated`
+
+## MCP Tools
+
+Available tools for AI agents:
+
+| Tool | Description |
+|------|-------------|
+| `stripe_create_checkout` | Create checkout session |
+| `stripe_create_portal` | Create customer portal session |
+| `stripe_get_subscription` | Get subscription details |
+| `stripe_cancel_subscription` | Cancel subscription |
+| `stripe_list_products` | List products |
+| `stripe_list_prices` | List prices |
+| `stripe_list_subscriptions` | List subscriptions |
+| `stripe_list_invoices` | List invoices |
+| `stripe_sync_products` | Sync products to LokiCMS |
+
+## Usage Examples
+
+### Create a Subscription Checkout
+
+```typescript
+const response = await fetch('/api/plugins/stripe/checkout', {
+  method: 'POST',
+  headers: { 'Content-Type': 'application/json' },
+  body: JSON.stringify({
+    priceId: 'price_monthly_pro',
+    customerEmail: 'user@example.com',
+    mode: 'subscription',
+    trialDays: 14
+  })
+});
+
+const { url } = await response.json();
+window.location.href = url;
+```
+
+### Check User Subscription
+
+```typescript
+// Get subscriptions for a customer
+const subs = await fetch('/api/plugins/stripe/subscriptions?customerId=cus_xxx');
+const { subscriptions } = await subs.json();
+
+const activeSub = subscriptions.find(s => s.status === 'active');
+```
+
+### Allow Customer to Manage Subscription
+
+```typescript
+const response = await fetch('/api/plugins/stripe/portal', {
+  method: 'POST',
+  headers: { 'Content-Type': 'application/json' },
+  body: JSON.stringify({
+    customerId: 'cus_xxx',
+    returnUrl: window.location.href
+  })
+});
+
+const { url } = await response.json();
+window.location.href = url;
+```
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "lokicms-plugin-stripe",
+  "version": "1.0.0",
+  "description": "Stripe payments and subscriptions plugin for LokiCMS",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch"
+  },
+  "keywords": [
+    "lokicms",
+    "plugin",
+    "stripe",
+    "payments",
+    "subscriptions",
+    "checkout",
+    "billing",
+    "saas"
+  ],
+  "author": "MauricioPerera",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MauricioPerera/lokicms-plugin-stripe.git"
+  },
+  "bugs": {
+    "url": "https://github.com/MauricioPerera/lokicms-plugin-stripe/issues"
+  },
+  "homepage": "https://github.com/MauricioPerera/lokicms-plugin-stripe#readme",
+  "dependencies": {
+    "stripe": "^17.7.0"
+  },
+  "peerDependencies": {
+    "hono": "^4.0.0",
+    "zod": "^3.0.0"
+  },
+  "lokicms": {
+    "displayName": "Stripe Payments",
+    "description": "Accept payments and manage subscriptions with Stripe",
+    "icon": "💳",
+    "minVersion": "1.0.0"
+  }
+}