@withvlibe/base-sdk 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,158 @@
+import { P as PaymentsConfig, C as ConnectStatus, a as CheckoutOptions, b as CheckoutSession, T as Transaction, R as RefundOptions } from './VlibeBaseAuth-ChuzgzDl.js';
+export { r as Address, t as ApiResponse, A as AppCategory, e as AuthConfig, n as AuthSession, B as BasePlan, j as BaseRecord, s as CartItem, f as ColumnType, D as DatabaseConfig, F as FeatureFlag, M as Media, O as Order, q as OrderItem, o as Page, u as PaginatedResponse, p as Product, Q as QueryOptions, k as RealtimePayload, S as Subscription, g as TableColumn, i as TableInfo, h as TableSchema, U as UsageMetric, y as UseAuthReturn, w as UseCollectionOptions, v as UseCollectionReturn, x as UseKVReturn, z as UsePaymentsReturn, m as VerifyResponse, c as VlibeBaseAuth, d as VlibeBaseConfig, V as VlibeBaseDatabase, l as VlibeUser } from './VlibeBaseAuth-ChuzgzDl.js';
+
+/**
+ * VlibeBasePayments - Payment processing for Vlibe Base Apps
+ *
+ * Provides Stripe Connect payment processing with transaction fees.
+ * Unlike Vlibe Official (50/50 revenue split), Base apps pay a small
+ * transaction fee (0.5-2% depending on plan).
+ *
+ * @example
+ * ```typescript
+ * import { VlibeBasePayments } from '@withvlibe/base-sdk';
+ *
+ * const payments = new VlibeBasePayments({
+ *   appId: process.env.VLIBE_BASE_APP_ID!,
+ *   appSecret: process.env.VLIBE_BASE_APP_SECRET!,
+ * });
+ *
+ * // Create a checkout session
+ * const session = await payments.createCheckout({
+ *   amount: 1999, // $19.99 in cents
+ *   successUrl: '/success',
+ *   cancelUrl: '/cancel',
+ * });
+ *
+ * // Redirect user to session.url
+ *
+ * // Get transaction history
+ * const transactions = await payments.getTransactions();
+ * ```
+ */
+
+declare class VlibeBasePayments {
+    private appId;
+    private appSecret;
+    private baseUrl;
+    /**
+     * Create a new VlibeBasePayments instance
+     *
+     * @param config - Payments configuration
+     * @throws Error if appId or appSecret is missing
+     *
+     * @remarks
+     * This class should only be used server-side. Never expose your
+     * appSecret to the client.
+     */
+    constructor(config: PaymentsConfig);
+    /**
+     * Make an authenticated API request
+     */
+    private apiRequest;
+    /**
+     * Get Stripe Connect onboarding URL
+     *
+     * Redirect users to this URL to connect their Stripe account.
+     *
+     * @param returnUrl - URL to return to after onboarding
+     * @returns The Stripe Connect onboarding URL
+     */
+    getConnectOnboardingUrl(returnUrl: string): Promise<string>;
+    /**
+     * Check Stripe Connect status
+     *
+     * @returns The current Stripe Connect status
+     */
+    getConnectStatus(): Promise<ConnectStatus>;
+    /**
+     * Create a checkout session for one-time payments
+     *
+     * @param options - Checkout options
+     * @returns The checkout session with URL to redirect user
+     *
+     * @remarks
+     * Transaction fees are automatically calculated based on your plan:
+     * - Free plan: 2% of transaction
+     * - Premium plan: 0.5% of transaction
+     */
+    createCheckout(options: CheckoutOptions): Promise<CheckoutSession>;
+    /**
+     * Get checkout session by ID
+     *
+     * @param sessionId - The checkout session ID
+     * @returns The checkout session details
+     */
+    getCheckoutSession(sessionId: string): Promise<CheckoutSession | null>;
+    /**
+     * Get all transactions
+     *
+     * @param options - Query options
+     * @returns List of transactions
+     */
+    getTransactions(options?: {
+        limit?: number;
+        offset?: number;
+        status?: 'pending' | 'succeeded' | 'failed' | 'refunded';
+    }): Promise<Transaction[]>;
+    /**
+     * Get a single transaction
+     *
+     * @param transactionId - The transaction ID
+     * @returns The transaction details
+     */
+    getTransaction(transactionId: string): Promise<Transaction | null>;
+    /**
+     * Get transaction summary/stats
+     *
+     * @returns Transaction statistics
+     */
+    getTransactionStats(): Promise<{
+        totalRevenue: number;
+        totalFees: number;
+        netRevenue: number;
+        transactionCount: number;
+        thisMonth: {
+            revenue: number;
+            fees: number;
+            net: number;
+            count: number;
+        };
+    }>;
+    /**
+     * Create a refund
+     *
+     * @param options - Refund options
+     * @returns The updated transaction
+     *
+     * @remarks
+     * Note: Transaction fees are not refunded when you issue a refund.
+     */
+    createRefund(options: RefundOptions): Promise<Transaction>;
+    /**
+     * Calculate the Vlibe fee for an amount
+     *
+     * @param amount - Amount in cents
+     * @param plan - The Base plan ('free' or 'premium')
+     * @returns The fee amount in cents
+     */
+    calculateFee(amount: number, plan?: 'free' | 'premium'): number;
+    /**
+     * Calculate net amount after fees
+     *
+     * @param amount - Gross amount in cents
+     * @param plan - The Base plan ('free' or 'premium')
+     * @returns The net amount in cents
+     */
+    calculateNetAmount(amount: number, plan?: 'free' | 'premium'): number;
+    /**
+     * Get the app ID
+     */
+    getAppId(): string;
+    /**
+     * Get the base URL
+     */
+    getBaseUrl(): string;
+}
+
+export { CheckoutOptions, CheckoutSession, ConnectStatus, PaymentsConfig, RefundOptions, Transaction, VlibeBasePayments };