opencloud-platform-sdk 1.3.0 → 3.0.0

package/README.md

@@ -1,210 +1,266 @@
-# @opencloud/sdk
+# opencloud-platform-sdk
 
-Official SDK for **OpenCloud** - The AI App Marketplace with pay-per-use model.
+Official SDK for **OpenCloud** - Monetize your AI apps with ease.
 
-Build AI-powered apps that automatically handle payments and AI API calls through OpenCloud's platform.
+**You control the AI, we handle the payments.**
 
-## Features
+## What's New in v3.0
 
-- ✅ Call 100+ AI models (GPT-4, Claude, Gemini, Llama, etc.) via OpenRouter
-- ✅ Automatic payment processing (70% to creators, 30% to platform)
-- ✅ No API keys needed - OpenCloud handles everything
-- ✅ TypeScript support with full type definitions
-- ✅ Works in browsers and Node.js
-- ✅ Zero dependencies
+- **Standalone Mode** - Works on any domain, no iframe required
+- **Popup Authentication** - Secure OAuth-style login via popup
+- **Automatic Login** - SDK prompts for login when charging
+- **Cross-Domain Support** - Full CORS support for external apps
 
 ## Installation
 
 ```bash
-npm install @opencloud/sdk
-# or
-pnpm add @opencloud/sdk
-# or
-yarn add @opencloud/sdk
+npm install opencloud-platform-sdk
 ```
 
 ## Quick Start
 
-### For React/Next.js Apps
-
 ```typescript
-import { opencloud } from '@opencloud/sdk';
+import { opencloud } from 'opencloud-platform-sdk';
 
-// Initialize with your app ID
+// 1. Initialize with your app ID (slug)
 opencloud.init({ appId: 'your-app-slug' });
 
-// Call AI models
-const response = await opencloud.callAI({
-  model: 'openai/gpt-4',
-  prompt: 'Write a tagline for my startup'
-});
-
-console.log(response.text); // AI-generated response
-console.log(response.cost); // $0.10 (or your app's price per use)
-```
+// 2. Charge the user (opens login popup if needed)
+async function handleAIFeature() {
+  const result = await opencloud.charge('generate_image');
 
-### For HTML/Vanilla JS
+  if (!result.success) {
+    if (result.error === 'CANCELLED') {
+      // User closed the login popup
+      return;
+    }
+    if (result.error === 'INSUFFICIENT_BALANCE') {
+      // SDK already opened top-up popup
+      return;
+    }
+  }
 
-```html
-<script src="https://opencloud.com/sdk/platform-sdk.js"></script>
+  // Charge successful! Now run your AI logic
+  const image = await myAIService.generate(prompt);
+  return image;
+}
+```
 
-<script>
-  PlatformSDK.init({ appId: 'your-app-slug' });
+## How It Works
 
-  async function generate() {
-    const result = await PlatformSDK.callAI({
-      model: 'anthropic/claude-3-5-sonnet',
-      prompt: 'Generate a logo description'
-    });
+1. User visits your app (e.g., `https://your-app.vercel.app`)
+2. User clicks "Generate Image" (or any paid feature)
+3. SDK checks if user has OpenCloud session
+4. If not logged in → Opens OpenCloud login popup
+5. User logs in → Popup closes → SDK gets session token
+6. SDK charges user's OpenCloud wallet
+7. Your app continues with the AI feature
 
-    console.log(result.text);
-  }
-</script>
+```
+Your App                          OpenCloud
+   │                                  │
+   │  User clicks "Generate"          │
+   │  ─────────────────────────────>  │
+   │                                  │
+   │  SDK: opencloud.charge()         │
+   │  ─────────────────────────────>  │
+   │                                  │
+   │  No session? Open popup          │
+   │  <─────────────────────────────  │
+   │                                  │
+   │  User logs in via popup          │
+   │  ─────────────────────────────>  │
+   │                                  │
+   │  Session token returned          │
+   │  <─────────────────────────────  │
+   │                                  │
+   │  Charge wallet                   │
+   │  ─────────────────────────────>  │
+   │                                  │
+   │  Success! Continue...            │
+   │  <─────────────────────────────  │
+   │                                  │
 ```
 
 ## API Reference
 
 ### `opencloud.init(config)`
 
-Initialize the SDK with your app configuration.
+Initialize the SDK.
 
 ```typescript
 opencloud.init({
-  appId: 'your-app-slug',  // Required: Your app's unique identifier
-  apiUrl: 'https://opencloud.com'  // Optional: Platform URL (defaults to current origin)
+  appId: 'your-app-slug',  // Required - your app's slug
+  apiUrl: 'https://opencloud.app'  // Optional - defaults to production
 });
 ```
 
-### `opencloud.callAI(params)`
+### `opencloud.charge(action?, metadata?)`
 
-Call an AI model through OpenCloud's platform.
+Charge the user. Opens login popup if not authenticated.
 
 ```typescript
-const response = await opencloud.callAI({
-  model: 'openai/gpt-4',  // Required: Model identifier
-  prompt: 'Your prompt here',  // Required: The prompt to send
-  options: {  // Optional: Additional model parameters
-    temperature: 0.7,
-    max_tokens: 1000
-  }
-});
+const result = await opencloud.charge('chat_message', { model: 'gpt-4' });
 
-// Response structure:
+// Result:
 {
   success: true,
-  text: "AI-generated response...",
-  usage: {
-    promptTokens: 10,
-    completionTokens: 50,
-    totalTokens: 60
-  },
-  cost: 0.10,  // Amount charged to user
-  model: "openai/gpt-4"
+  charged: 0.10,
+  balance: 4.90,
+  transactionId: 'tx_abc123'
+}
+
+// Or on error:
+{
+  success: false,
+  error: 'INSUFFICIENT_BALANCE' | 'CANCELLED' | 'UNKNOWN'
 }
 ```
 
-### `opencloud.getBalance()`
+### `opencloud.withCharge(fn, options)`
 
-Get the current user's token balance.
+Execute a function and charge the user. Handles auth and balance checks automatically.
 
 ```typescript
-const balance = await opencloud.getBalance();
-console.log(`Balance: $${balance}`);
+const image = await opencloud.withCharge(async () => {
+  return await myAIService.generateImage(prompt);
+}, { action: 'generate_image' });
 ```
 
-### `opencloud.requestTopUp()`
+### `opencloud.isAuthenticated()`
 
-Request the user to purchase more tokens (opens payment dialog).
+Check if user is logged in.
 
 ```typescript
-try {
-  await opencloud.callAI({...});
-} catch (error) {
-  if (error.message.includes('Insufficient balance')) {
-    await opencloud.requestTopUp();
-  }
+if (opencloud.isAuthenticated()) {
+  console.log('User is logged in');
 }
 ```
 
-## Supported AI Models
+### `opencloud.login()`
 
-OpenCloud uses OpenRouter, giving you access to 100+ models:
+Open login popup manually.
 
-**OpenAI:**
-- `openai/gpt-4`
-- `openai/gpt-4-turbo`
-- `openai/gpt-3.5-turbo`
+```typescript
+const session = await opencloud.login();
+if (session) {
+  console.log('Logged in as:', session.user.email);
+}
+```
 
-**Anthropic:**
-- `anthropic/claude-3-5-sonnet`
-- `anthropic/claude-3-haiku`
-- `anthropic/claude-3-opus`
+### `opencloud.logout()`
 
-**Google:**
-- `google/gemini-pro`
-- `google/gemini-pro-vision`
+Log out the current user.
 
-**Meta:**
-- `meta-llama/llama-3-70b`
-- `meta-llama/llama-3-8b`
+```typescript
+opencloud.logout();
+```
 
-**And many more!** See [OpenRouter docs](https://openrouter.ai/docs) for full list.
+### `opencloud.getUser()`
 
-## Example Apps
+Get current user info (synchronous).
 
-### Text Summarizer
+```typescript
+const user = opencloud.getUser();
+// { id, email, username, balance }
+```
+
+### `opencloud.getBalance()`
+
+Get user's current balance (async, fetches from server).
 
 ```typescript
-import { opencloud } from '@opencloud/sdk';
+const balance = await opencloud.getBalance();
+console.log(`Balance: $${balance}`);
+```
 
-opencloud.init({ appId: 'text-summarizer' });
+### `opencloud.canAfford()`
 
-async function summarize(text: string) {
-  const response = await opencloud.callAI({
-    model: 'anthropic/claude-3-haiku',  // Fast and cheap
-    prompt: `Summarize this text in 3 bullet points:\n\n${text}`
-  });
+Check if user can afford to use the app.
 
-  return response.text;
+```typescript
+const canUse = await opencloud.canAfford();
+if (!canUse) {
+  opencloud.openTopUp();
 }
 ```
 
-### Image Description Generator
+### `opencloud.openTopUp()`
+
+Open top-up popup for user to add credits.
 
 ```typescript
-import { opencloud } from '@opencloud/sdk';
+opencloud.openTopUp();
+```
 
-opencloud.init({ appId: 'image-describer' });
+### `opencloud.getAppPrice()`
 
-async function describeImage(imageUrl: string) {
-  const response = await opencloud.callAI({
-    model: 'google/gemini-pro-vision',
-    prompt: 'Describe this image in detail',
-    options: {
-      image: imageUrl
-    }
-  });
+Get your app's price per use.
 
-  return response.text;
+```typescript
+const price = await opencloud.getAppPrice();
+console.log(`Price: $${price}`);
+```
+
+### `opencloud.isPreview()`
+
+Check if running in development mode.
+
+```typescript
+if (opencloud.isPreview()) {
+  console.log('Preview mode - no real charges');
 }
 ```
 
 ## Revenue Model
 
-OpenCloud uses a **70/30 revenue split**:
+**85/15 split** - You keep most of what you earn!
 
-- **70%** goes to you (the app creator)
-- **30%** goes to OpenCloud (platform fee)
-
-Example:
 ```
 User pays:     $0.10 per use
-AI cost:       -$0.03 (OpenAI API)
-Net revenue:   $0.07
-├─ You get:    $0.049 (70%)
-└─ Platform:   $0.021 (30%)
+├─ You get:    $0.085 (85%)
+└─ Platform:   $0.015 (15%)
+```
+
+## Preview Mode
+
+When running locally (localhost), the SDK automatically enters preview mode:
+- `charge()` doesn't charge real money
+- `getBalance()` returns 999.99
+- `canAfford()` always returns true
+
+This lets you develop without worrying about charges.
+
+## Error Handling
+
+```typescript
+const result = await opencloud.charge('chat');
+
+if (!result.success) {
+  switch (result.error) {
+    case 'CANCELLED':
+      // User closed the login popup
+      showMessage('Please log in to use this feature');
+      break;
+    case 'INSUFFICIENT_BALANCE':
+      // SDK already opened top-up popup
+      showMessage('Please add credits to continue');
+      break;
+    default:
+      showMessage('Something went wrong');
+  }
+}
 ```
 
+## Publishing Your App
+
+1. Deploy your app to Vercel
+2. Go to [opencloud.app/publish](/publish)
+3. Create a new app with your deployed URL
+4. Set name, description, and **price per use**
+5. Get your app slug
+6. Use the slug in `opencloud.init({ appId: 'your-slug' })`
+
 ## TypeScript Support
 
 Full TypeScript definitions included:
@@ -213,35 +269,17 @@ Full TypeScript definitions included:
 import {
   opencloud,
   OpenCloudSDK,
-  AICallParams,
-  AIResponse,
-  OpenCloudConfig
-} from '@opencloud/sdk';
-
-const params: AICallParams = {
-  model: 'openai/gpt-4',
-  prompt: 'Hello world'
-};
-
-const response: AIResponse = await opencloud.callAI(params);
+  ChargeResult,
+  UserSession,
+  UserInfo
+} from 'opencloud-platform-sdk';
 ```
 
-## Publishing Your App
-
-1. Build your app with the SDK
-2. Go to [opencloud.com/publish](https://opencloud.com/publish)
-3. Upload your app or connect GitHub
-4. Set pricing and details
-5. Test with $5 free credits
-6. Publish to marketplace!
-
 ## Support
 
-- 📚 [Documentation](https://opencloud.com/docs)
-- 💬 [Discord Community](https://discord.gg/opencloud)
-- 🐛 [Report Issues](https://github.com/opencloud/sdk/issues)
-- ✉️ support@opencloud.com
+- Docs: [opencloud.app/docs](/docs)
+- Issues: [github.com/opencloud/sdk](https://github.com/opencloud/sdk/issues)
 
 ## License
 
-MIT © OpenCloud
+MIT

package/dist/cli.d.mts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/cli.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/cli.js

@@ -0,0 +1,161 @@
+#!/usr/bin/env node
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+// src/cli.ts
+var fs = __toESM(require("fs"));
+var path = __toESM(require("path"));
+var VERCEL_HEADERS = {
+  headers: [
+    {
+      source: "/(.*)",
+      headers: [
+        { key: "X-Frame-Options", value: "ALLOWALL" },
+        { key: "Content-Security-Policy", value: "frame-ancestors *" }
+      ]
+    }
+  ]
+};
+function findProjectRoot() {
+  let dir = process.cwd();
+  while (dir !== path.dirname(dir)) {
+    if (fs.existsSync(path.join(dir, "package.json"))) {
+      return dir;
+    }
+    dir = path.dirname(dir);
+  }
+  return process.cwd();
+}
+function setupVercelJson(projectRoot) {
+  const vercelJsonPath = path.join(projectRoot, "vercel.json");
+  try {
+    let config = {};
+    if (fs.existsSync(vercelJsonPath)) {
+      const content = fs.readFileSync(vercelJsonPath, "utf-8");
+      config = JSON.parse(content);
+      console.log("  Found existing vercel.json");
+    } else {
+      console.log("  Creating vercel.json");
+    }
+    if (config.headers) {
+      const hasFrameHeaders = config.headers.some(
+        (h) => h.headers?.some(
+          (header) => header.key === "X-Frame-Options" || header.key === "Content-Security-Policy"
+        )
+      );
+      if (hasFrameHeaders) {
+        console.log("  \u2713 Headers already configured in vercel.json");
+        return true;
+      }
+      config.headers.push(...VERCEL_HEADERS.headers);
+    } else {
+      config.headers = VERCEL_HEADERS.headers;
+    }
+    fs.writeFileSync(vercelJsonPath, JSON.stringify(config, null, 2));
+    console.log("  \u2713 Added iframe headers to vercel.json");
+    return true;
+  } catch (error) {
+    console.error("  \u2717 Failed to update vercel.json:", error);
+    return false;
+  }
+}
+function printManualInstructions() {
+  console.log(`
+\u250C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510
+\u2502  Manual Configuration Required                          \u2502
+\u251C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2524
+\u2502                                                         \u2502
+\u2502  Add this to your vercel.json:                          \u2502
+\u2502                                                         \u2502
+\u2502  {                                                      \u2502
+\u2502    "headers": [                                         \u2502
+\u2502      {                                                  \u2502
+\u2502        "source": "/(.*)",                               \u2502
+\u2502        "headers": [                                     \u2502
+\u2502          { "key": "X-Frame-Options", "value": "ALLOWALL" },
+\u2502          { "key": "Content-Security-Policy",            \u2502
+\u2502            "value": "frame-ancestors *" }               \u2502
+\u2502        ]                                                \u2502
+\u2502      }                                                  \u2502
+\u2502    ]                                                    \u2502
+\u2502  }                                                      \u2502
+\u2502                                                         \u2502
+\u2502  Or add headers() to next.config.js:                    \u2502
+\u2502                                                         \u2502
+\u2502  async headers() {                                      \u2502
+\u2502    return [{                                            \u2502
+\u2502      source: '/(.*)',                                   \u2502
+\u2502      headers: [                                         \u2502
+\u2502        { key: 'X-Frame-Options', value: 'ALLOWALL' },   \u2502
+\u2502        { key: 'Content-Security-Policy',                \u2502
+\u2502          value: 'frame-ancestors *' }                   \u2502
+\u2502      ]                                                  \u2502
+\u2502    }];                                                  \u2502
+\u2502  }                                                      \u2502
+\u2502                                                         \u2502
+\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518
+`);
+}
+function main() {
+  const args = process.argv.slice(2);
+  const command = args[0];
+  console.log("\n\u{1F680} OpenCloud SDK Setup\n");
+  if (command === "setup" || !command) {
+    const projectRoot = findProjectRoot();
+    console.log(`Project root: ${projectRoot}
+`);
+    console.log("Configuring iframe headers for OpenCloud...\n");
+    const success = setupVercelJson(projectRoot);
+    if (success) {
+      console.log(`
+\u2705 Setup complete!
+
+Your app is now configured to work with OpenCloud.
+After deploying, your app will be embeddable in the OpenCloud marketplace.
+
+Next steps:
+1. Deploy your app: vercel deploy --prod
+2. Publish on OpenCloud: https://opencloud.app/publish
+`);
+    } else {
+      printManualInstructions();
+    }
+  } else if (command === "help" || command === "--help" || command === "-h") {
+    console.log(`
+Usage: opencloud-sdk [command]
+
+Commands:
+  setup     Configure your project for OpenCloud (default)
+  help      Show this help message
+
+Examples:
+  npx opencloud-platform-sdk setup
+  npx opencloud-platform-sdk
+`);
+  } else {
+    console.log(`Unknown command: ${command}`);
+    console.log('Run "opencloud-sdk help" for usage information.');
+  }
+}
+main();