opencloud-platform-sdk 2.0.0 → 3.0.0

package/dist/index.d.mts

@@ -1,11 +1,11 @@
 /**
- * opencloud-platform-sdk v2.0.0
+ * opencloud-platform-sdk v3.0.0
  * Official SDK for OpenCloud - AI App Marketplace
  *
- * New Model:
- * - Creators use their own AI/APIs
- * - SDK only tracks usage and charges end users
- * - Creators set price per use, platform takes 15% commission
+ * Standalone Mode:
+ * - Works directly on any domain (no iframe required)
+ * - Uses popup for authentication
+ * - Charges from user's OpenCloud wallet
  */
 interface OpenCloudConfig {
     appId: string;
@@ -21,8 +21,21 @@ interface TrackUsageResponse {
     userBalance: number;
     transactionId: string;
 }
+interface ChargeResult {
+    success: boolean;
+    charged?: number;
+    balance?: number;
+    transactionId?: string;
+    error?: 'CANCELLED' | 'INSUFFICIENT_BALANCE' | 'NOT_AUTHENTICATED' | 'UNKNOWN';
+}
 interface UserSession {
     token: string;
+    user?: {
+        id: string;
+        email: string;
+        username?: string;
+        balance?: number;
+    };
 }
 interface UserInfo {
     id: string;
@@ -32,11 +45,15 @@ interface UserInfo {
 }
 declare class OpenCloudSDK {
     private config;
-    private heartbeatInterval?;
     private _isPreviewMode;
-    private _cachedSession;
+    private _session;
+    private _authPopup;
     constructor();
     private detectPreviewMode;
+    private loadStoredSession;
+    private saveSession;
+    private clearStoredSession;
+    private setupMessageListener;
     /**
      * Check if running in preview/development mode
      */
@@ -46,85 +63,61 @@ declare class OpenCloudSDK {
      */
     init(options: OpenCloudConfig): void;
     /**
-     * Track a usage event and charge the user
-     * Call this BEFORE or AFTER your AI/API call
-     *
-     * Example:
-     * ```
-     * // Check if user can afford it first
-     * const canUse = await opencloud.canAfford();
-     * if (!canUse) {
-     *   opencloud.requestTopUp();
-     *   return;
-     * }
-     *
-     * // Do your AI call
-     * const result = await myAICall();
-     *
-     * // Track the usage (charges user)
-     * await opencloud.trackUsage({ action: 'chat_message' });
-     * ```
+     * Check if user is authenticated with OpenCloud
      */
-    trackUsage(params?: TrackUsageParams): Promise<TrackUsageResponse>;
+    isAuthenticated(): boolean;
     /**
-     * Check if the user can afford to use the app
-     * Returns true if user has enough balance
+     * Open login popup for user authentication
+     * Returns a promise that resolves when login is complete
      */
-    canAfford(): Promise<boolean>;
+    login(): Promise<UserSession | null>;
     /**
-     * Get current user's balance
+     * Log out the current user
      */
-    getBalance(): Promise<number>;
+    logout(): void;
     /**
      * Get current user info
      */
-    getUserInfo(): Promise<UserInfo>;
+    getUser(): UserInfo | null;
     /**
-     * Get the price per use for this app
+     * Charge the user for using a feature
+     * Will automatically prompt for login if not authenticated
+     *
+     * @param action - Optional action name for analytics
+     * @returns ChargeResult with success status
      */
-    getAppPrice(): Promise<number>;
+    charge(action?: string, metadata?: Record<string, any>): Promise<ChargeResult>;
     /**
-     * Request user to add more credits
-     * Opens the top-up modal or redirects to payment page
+     * Check if user can afford to use the app
      */
-    requestTopUp(): void;
+    canAfford(): Promise<boolean>;
     /**
-     * Check if user is authenticated
+     * Get user's current balance
      */
-    isAuthenticated(): Promise<boolean>;
+    getBalance(): Promise<number>;
     /**
-     * Request user to log in
+     * Open top-up popup for user to add credits
      */
-    requestLogin(): void;
-    private startHeartbeat;
-    private sendHeartbeat;
-    private getUserSession;
+    openTopUp(): void;
     /**
-     * Clear cached session (call on logout)
+     * Get price per use for this app
      */
-    clearSession(): void;
+    getAppPrice(): Promise<number>;
     /**
-     * Cleanup resources
+     * Execute a function and charge the user
+     * Handles authentication, balance check, and charging automatically
      */
+    withCharge<T>(fn: () => Promise<T>, options?: {
+        action?: string;
+        metadata?: Record<string, any>;
+    }): Promise<T>;
+    trackUsage(params?: TrackUsageParams): Promise<TrackUsageResponse>;
+    requestTopUp(): void;
+    requestLogin(): void;
+    getUserInfo(): Promise<UserInfo>;
+    clearSession(): void;
     destroy(): void;
-    /**
-     * Execute a function and automatically charge the user
-     * This is a convenience method that combines canAfford + your code + trackUsage
-     *
-     * @param fn - The async function to execute (your AI call, etc.)
-     * @param options - Optional tracking options
-     * @returns The result of your function
-     *
-     * Example:
-     * ```typescript
-     * const result = await opencloud.withUsage(async () => {
-     *   const response = await fetch('https://api.openai.com/...', { ... });
-     *   return await response.json();
-     * }, { action: 'chat_message' });
-     * ```
-     */
-    withUsage<T>(fn: () => Promise<T>, options?: TrackUsageParams): Promise<T>;
 }
 declare const opencloud: OpenCloudSDK;
 
-export { type OpenCloudConfig, OpenCloudSDK, type TrackUsageParams, type TrackUsageResponse, type UserInfo, type UserSession, opencloud };
+export { type ChargeResult, type OpenCloudConfig, OpenCloudSDK, type TrackUsageParams, type TrackUsageResponse, type UserInfo, type UserSession, opencloud };

package/dist/index.d.ts

@@ -1,11 +1,11 @@
 /**
- * opencloud-platform-sdk v2.0.0
+ * opencloud-platform-sdk v3.0.0
  * Official SDK for OpenCloud - AI App Marketplace
  *
- * New Model:
- * - Creators use their own AI/APIs
- * - SDK only tracks usage and charges end users
- * - Creators set price per use, platform takes 15% commission
+ * Standalone Mode:
+ * - Works directly on any domain (no iframe required)
+ * - Uses popup for authentication
+ * - Charges from user's OpenCloud wallet
  */
 interface OpenCloudConfig {
     appId: string;
@@ -21,8 +21,21 @@ interface TrackUsageResponse {
     userBalance: number;
     transactionId: string;
 }
+interface ChargeResult {
+    success: boolean;
+    charged?: number;
+    balance?: number;
+    transactionId?: string;
+    error?: 'CANCELLED' | 'INSUFFICIENT_BALANCE' | 'NOT_AUTHENTICATED' | 'UNKNOWN';
+}
 interface UserSession {
     token: string;
+    user?: {
+        id: string;
+        email: string;
+        username?: string;
+        balance?: number;
+    };
 }
 interface UserInfo {
     id: string;
@@ -32,11 +45,15 @@ interface UserInfo {
 }
 declare class OpenCloudSDK {
     private config;
-    private heartbeatInterval?;
     private _isPreviewMode;
-    private _cachedSession;
+    private _session;
+    private _authPopup;
     constructor();
     private detectPreviewMode;
+    private loadStoredSession;
+    private saveSession;
+    private clearStoredSession;
+    private setupMessageListener;
     /**
      * Check if running in preview/development mode
      */
@@ -46,85 +63,61 @@ declare class OpenCloudSDK {
      */
     init(options: OpenCloudConfig): void;
     /**
-     * Track a usage event and charge the user
-     * Call this BEFORE or AFTER your AI/API call
-     *
-     * Example:
-     * ```
-     * // Check if user can afford it first
-     * const canUse = await opencloud.canAfford();
-     * if (!canUse) {
-     *   opencloud.requestTopUp();
-     *   return;
-     * }
-     *
-     * // Do your AI call
-     * const result = await myAICall();
-     *
-     * // Track the usage (charges user)
-     * await opencloud.trackUsage({ action: 'chat_message' });
-     * ```
+     * Check if user is authenticated with OpenCloud
      */
-    trackUsage(params?: TrackUsageParams): Promise<TrackUsageResponse>;
+    isAuthenticated(): boolean;
     /**
-     * Check if the user can afford to use the app
-     * Returns true if user has enough balance
+     * Open login popup for user authentication
+     * Returns a promise that resolves when login is complete
      */
-    canAfford(): Promise<boolean>;
+    login(): Promise<UserSession | null>;
     /**
-     * Get current user's balance
+     * Log out the current user
      */
-    getBalance(): Promise<number>;
+    logout(): void;
     /**
      * Get current user info
      */
-    getUserInfo(): Promise<UserInfo>;
+    getUser(): UserInfo | null;
     /**
-     * Get the price per use for this app
+     * Charge the user for using a feature
+     * Will automatically prompt for login if not authenticated
+     *
+     * @param action - Optional action name for analytics
+     * @returns ChargeResult with success status
      */
-    getAppPrice(): Promise<number>;
+    charge(action?: string, metadata?: Record<string, any>): Promise<ChargeResult>;
     /**
-     * Request user to add more credits
-     * Opens the top-up modal or redirects to payment page
+     * Check if user can afford to use the app
      */
-    requestTopUp(): void;
+    canAfford(): Promise<boolean>;
     /**
-     * Check if user is authenticated
+     * Get user's current balance
      */
-    isAuthenticated(): Promise<boolean>;
+    getBalance(): Promise<number>;
     /**
-     * Request user to log in
+     * Open top-up popup for user to add credits
      */
-    requestLogin(): void;
-    private startHeartbeat;
-    private sendHeartbeat;
-    private getUserSession;
+    openTopUp(): void;
     /**
-     * Clear cached session (call on logout)
+     * Get price per use for this app
      */
-    clearSession(): void;
+    getAppPrice(): Promise<number>;
     /**
-     * Cleanup resources
+     * Execute a function and charge the user
+     * Handles authentication, balance check, and charging automatically
      */
+    withCharge<T>(fn: () => Promise<T>, options?: {
+        action?: string;
+        metadata?: Record<string, any>;
+    }): Promise<T>;
+    trackUsage(params?: TrackUsageParams): Promise<TrackUsageResponse>;
+    requestTopUp(): void;
+    requestLogin(): void;
+    getUserInfo(): Promise<UserInfo>;
+    clearSession(): void;
     destroy(): void;
-    /**
-     * Execute a function and automatically charge the user
-     * This is a convenience method that combines canAfford + your code + trackUsage
-     *
-     * @param fn - The async function to execute (your AI call, etc.)
-     * @param options - Optional tracking options
-     * @returns The result of your function
-     *
-     * Example:
-     * ```typescript
-     * const result = await opencloud.withUsage(async () => {
-     *   const response = await fetch('https://api.openai.com/...', { ... });
-     *   return await response.json();
-     * }, { action: 'chat_message' });
-     * ```
-     */
-    withUsage<T>(fn: () => Promise<T>, options?: TrackUsageParams): Promise<T>;
 }
 declare const opencloud: OpenCloudSDK;
 
-export { type OpenCloudConfig, OpenCloudSDK, type TrackUsageParams, type TrackUsageResponse, type UserInfo, type UserSession, opencloud };
+export { type ChargeResult, type OpenCloudConfig, OpenCloudSDK, type TrackUsageParams, type TrackUsageResponse, type UserInfo, type UserSession, opencloud };