capybara-game-sdk 0.0.0

package/dist/index.d.mts

@@ -0,0 +1,246 @@
+interface GameSDKConfig {
+    gameId: string;
+    onReady?: () => void;
+    devMode?: boolean;
+}
+interface User {
+    id: string;
+    displayName: string;
+    avatar?: string;
+}
+interface CreditBalance {
+    credits: number;
+}
+interface PaymentResult {
+    success: boolean;
+    newBalance: number;
+    error?: string;
+}
+interface Transaction {
+    amount: number;
+    description: string;
+    timestamp: number;
+}
+
+/**
+ * Secure communication bridge between iframe and parent app
+ * Uses postMessage with origin verification
+ */
+declare class ParentBridge {
+    private allowedOrigins;
+    private messageHandlers;
+    private pendingRequests;
+    private requestIdCounter;
+    constructor(allowedOrigins?: string[]);
+    private setupMessageListener;
+    /**
+     * Send a message to parent and wait for response
+     */
+    private sendRequest;
+    /**
+     * Send a message to parent without expecting a response
+     */
+    private sendMessage;
+    /**
+     * Listen for messages from parent
+     */
+    on(type: string, handler: (data: any) => void): void;
+    /**
+     * Remove message listener
+     */
+    off(type: string): void;
+    /**
+     * Get current authenticated user
+     */
+    getCurrentUser(): Promise<User | null>;
+    /**
+     * Request user to login (triggers parent app UI)
+     */
+    requestLogin(): Promise<void>;
+    /**
+     * Logout current user
+     */
+    logout(): Promise<void>;
+    /**
+     * Get bearer token for authenticated user
+     */
+    getBearerToken(): Promise<string | null>;
+    /**
+     * Get user's credit balance
+     */
+    getBalance(): Promise<CreditBalance>;
+    /**
+     * Charge credits from user's balance
+     */
+    chargeCredits(amount: number, description: string): Promise<PaymentResult>;
+    /**
+     * Notify parent that SDK is ready
+     */
+    notifyReady(): void;
+}
+
+declare class AuthModule {
+    private bridge;
+    private currentUser;
+    private authChangeListeners;
+    constructor(bridge: ParentBridge);
+    private initialize;
+    private notifyAuthChange;
+    /**
+     * Get the currently authenticated user
+     */
+    getCurrentUser(): Promise<User | null>;
+    /**
+     * Get bearer token for the authenticated user
+     */
+    getBearerToken(): Promise<string | null>;
+    /**
+     * Request user authentication (triggers parent app UI)
+     */
+    requestLogin(): Promise<void>;
+    /**
+     * Logout the current user
+     */
+    logout(): Promise<void>;
+    /**
+     * Listen for authentication state changes
+     */
+    onAuthChange(callback: (user: User | null) => void): () => void;
+    /**
+     * Check if user is authenticated
+     */
+    isAuthenticated(): boolean;
+}
+
+declare class PaymentsModule {
+    private bridge;
+    private auth;
+    private devMode;
+    private currentBalance;
+    private balanceChangeListeners;
+    private transactions;
+    constructor(bridge: ParentBridge, auth: AuthModule, devMode: boolean);
+    private initialize;
+    private refreshBalance;
+    private notifyBalanceChange;
+    /**
+     * Get the current credit balance
+     */
+    getBalance(): Promise<CreditBalance>;
+    /**
+     * Charge credits from the user's balance
+     * In dev mode, this is a no-op (free)
+     */
+    charge(amount: number, description: string): Promise<PaymentResult>;
+    /**
+     * Listen for balance changes
+     */
+    onBalanceChange(callback: (balance: CreditBalance) => void): () => void;
+    /**
+     * Get transaction history
+     * Note: This only includes transactions made during the current session
+     * For full history, the parent app should provide an API
+     */
+    getHistory(): Promise<Transaction[]>;
+    /**
+     * Gift credits to another user (requires server-side implementation)
+     */
+    giftCredits(userId: string, amount: number, description: string): Promise<PaymentResult>;
+    /**
+     * Set development mode
+     */
+    setDevMode(enabled: boolean): void;
+}
+
+declare class GameSDK {
+    private static instance;
+    readonly auth: AuthModule;
+    readonly payments: PaymentsModule;
+    private bridge;
+    private config;
+    readonly gameId: string;
+    private constructor();
+    /**
+     * Initialize the Game SDK
+     */
+    static init(config: GameSDKConfig): Promise<GameSDK>;
+    /**
+     * Get the current SDK instance
+     */
+    static getInstance(): GameSDK;
+    /**
+     * Set development mode
+     */
+    setDevMode(enabled: boolean): void;
+    /**
+     * Get SDK configuration
+     */
+    getConfig(): Readonly<GameSDKConfig>;
+    /**
+     * Clean up SDK resources
+     */
+    destroy(): Promise<void>;
+}
+
+/**
+ * Storage module for persisting game data
+ * Data is automatically scoped to userId + gameId
+ */
+declare class StorageModule {
+    private auth;
+    private gameId;
+    private apiClient;
+    constructor(gameId: string, auth: AuthModule);
+    /**
+     * Save data to storage
+     * Data is automatically scoped to current user and game
+     * Maximum size: 5MB
+     */
+    save<T = any>(data: T): Promise<void>;
+    /**
+     * Load data from storage
+     * Returns null if no data exists
+     */
+    load<T = any>(): Promise<T | null>;
+    /**
+     * Clear all stored data for current user and game
+     */
+    clear(): Promise<void>;
+    /**
+     * Check if data exists in storage
+     */
+    exists(): Promise<boolean>;
+    /**
+     * Get the size of stored data in bytes
+     */
+    getSize(): Promise<number>;
+}
+
+/**
+ * Hook to initialize the Game SDK
+ */
+declare function useGameSDK(config: GameSDKConfig): {
+    sdk: GameSDK | null;
+    isReady: boolean;
+    error: Error | null;
+};
+/**
+ * Hook to access the current user
+ */
+declare function useAuth(): {
+    user: User | null;
+    isLoading: boolean;
+    isAuthenticated: boolean;
+    login: () => Promise<void>;
+    logout: () => Promise<void>;
+};
+/**
+ * Hook to access credit balance
+ */
+declare function useCredits(): {
+    balance: number;
+    isLoading: boolean;
+    charge: (amount: number, description: string) => Promise<PaymentResult>;
+};
+
+export { AuthModule, GameSDK, PaymentsModule, StorageModule, useAuth, useCredits, useGameSDK };

package/dist/index.d.ts

@@ -0,0 +1,246 @@
+interface GameSDKConfig {
+    gameId: string;
+    onReady?: () => void;
+    devMode?: boolean;
+}
+interface User {
+    id: string;
+    displayName: string;
+    avatar?: string;
+}
+interface CreditBalance {
+    credits: number;
+}
+interface PaymentResult {
+    success: boolean;
+    newBalance: number;
+    error?: string;
+}
+interface Transaction {
+    amount: number;
+    description: string;
+    timestamp: number;
+}
+
+/**
+ * Secure communication bridge between iframe and parent app
+ * Uses postMessage with origin verification
+ */
+declare class ParentBridge {
+    private allowedOrigins;
+    private messageHandlers;
+    private pendingRequests;
+    private requestIdCounter;
+    constructor(allowedOrigins?: string[]);
+    private setupMessageListener;
+    /**
+     * Send a message to parent and wait for response
+     */
+    private sendRequest;
+    /**
+     * Send a message to parent without expecting a response
+     */
+    private sendMessage;
+    /**
+     * Listen for messages from parent
+     */
+    on(type: string, handler: (data: any) => void): void;
+    /**
+     * Remove message listener
+     */
+    off(type: string): void;
+    /**
+     * Get current authenticated user
+     */
+    getCurrentUser(): Promise<User | null>;
+    /**
+     * Request user to login (triggers parent app UI)
+     */
+    requestLogin(): Promise<void>;
+    /**
+     * Logout current user
+     */
+    logout(): Promise<void>;
+    /**
+     * Get bearer token for authenticated user
+     */
+    getBearerToken(): Promise<string | null>;
+    /**
+     * Get user's credit balance
+     */
+    getBalance(): Promise<CreditBalance>;
+    /**
+     * Charge credits from user's balance
+     */
+    chargeCredits(amount: number, description: string): Promise<PaymentResult>;
+    /**
+     * Notify parent that SDK is ready
+     */
+    notifyReady(): void;
+}
+
+declare class AuthModule {
+    private bridge;
+    private currentUser;
+    private authChangeListeners;
+    constructor(bridge: ParentBridge);
+    private initialize;
+    private notifyAuthChange;
+    /**
+     * Get the currently authenticated user
+     */
+    getCurrentUser(): Promise<User | null>;
+    /**
+     * Get bearer token for the authenticated user
+     */
+    getBearerToken(): Promise<string | null>;
+    /**
+     * Request user authentication (triggers parent app UI)
+     */
+    requestLogin(): Promise<void>;
+    /**
+     * Logout the current user
+     */
+    logout(): Promise<void>;
+    /**
+     * Listen for authentication state changes
+     */
+    onAuthChange(callback: (user: User | null) => void): () => void;
+    /**
+     * Check if user is authenticated
+     */
+    isAuthenticated(): boolean;
+}
+
+declare class PaymentsModule {
+    private bridge;
+    private auth;
+    private devMode;
+    private currentBalance;
+    private balanceChangeListeners;
+    private transactions;
+    constructor(bridge: ParentBridge, auth: AuthModule, devMode: boolean);
+    private initialize;
+    private refreshBalance;
+    private notifyBalanceChange;
+    /**
+     * Get the current credit balance
+     */
+    getBalance(): Promise<CreditBalance>;
+    /**
+     * Charge credits from the user's balance
+     * In dev mode, this is a no-op (free)
+     */
+    charge(amount: number, description: string): Promise<PaymentResult>;
+    /**
+     * Listen for balance changes
+     */
+    onBalanceChange(callback: (balance: CreditBalance) => void): () => void;
+    /**
+     * Get transaction history
+     * Note: This only includes transactions made during the current session
+     * For full history, the parent app should provide an API
+     */
+    getHistory(): Promise<Transaction[]>;
+    /**
+     * Gift credits to another user (requires server-side implementation)
+     */
+    giftCredits(userId: string, amount: number, description: string): Promise<PaymentResult>;
+    /**
+     * Set development mode
+     */
+    setDevMode(enabled: boolean): void;
+}
+
+declare class GameSDK {
+    private static instance;
+    readonly auth: AuthModule;
+    readonly payments: PaymentsModule;
+    private bridge;
+    private config;
+    readonly gameId: string;
+    private constructor();
+    /**
+     * Initialize the Game SDK
+     */
+    static init(config: GameSDKConfig): Promise<GameSDK>;
+    /**
+     * Get the current SDK instance
+     */
+    static getInstance(): GameSDK;
+    /**
+     * Set development mode
+     */
+    setDevMode(enabled: boolean): void;
+    /**
+     * Get SDK configuration
+     */
+    getConfig(): Readonly<GameSDKConfig>;
+    /**
+     * Clean up SDK resources
+     */
+    destroy(): Promise<void>;
+}
+
+/**
+ * Storage module for persisting game data
+ * Data is automatically scoped to userId + gameId
+ */
+declare class StorageModule {
+    private auth;
+    private gameId;
+    private apiClient;
+    constructor(gameId: string, auth: AuthModule);
+    /**
+     * Save data to storage
+     * Data is automatically scoped to current user and game
+     * Maximum size: 5MB
+     */
+    save<T = any>(data: T): Promise<void>;
+    /**
+     * Load data from storage
+     * Returns null if no data exists
+     */
+    load<T = any>(): Promise<T | null>;
+    /**
+     * Clear all stored data for current user and game
+     */
+    clear(): Promise<void>;
+    /**
+     * Check if data exists in storage
+     */
+    exists(): Promise<boolean>;
+    /**
+     * Get the size of stored data in bytes
+     */
+    getSize(): Promise<number>;
+}
+
+/**
+ * Hook to initialize the Game SDK
+ */
+declare function useGameSDK(config: GameSDKConfig): {
+    sdk: GameSDK | null;
+    isReady: boolean;
+    error: Error | null;
+};
+/**
+ * Hook to access the current user
+ */
+declare function useAuth(): {
+    user: User | null;
+    isLoading: boolean;
+    isAuthenticated: boolean;
+    login: () => Promise<void>;
+    logout: () => Promise<void>;
+};
+/**
+ * Hook to access credit balance
+ */
+declare function useCredits(): {
+    balance: number;
+    isLoading: boolean;
+    charge: (amount: number, description: string) => Promise<PaymentResult>;
+};
+
+export { AuthModule, GameSDK, PaymentsModule, StorageModule, useAuth, useCredits, useGameSDK };