@withvlibe/base-sdk 1.0.1 → 1.1.0

package/dist/{VlibeBaseAuth-BxS9T0vB.d.mts → VlibeBaseEcommerce-B6l17uup.d.mts}

@@ -236,8 +236,7 @@ interface UsageMetric {
     period: string;
     createdAt: string;
 }
-interface Product {
-    id: string;
+interface Product extends BaseRecord {
     name: string;
     description?: string;
     sku?: string;
@@ -247,19 +246,21 @@ interface Product {
     stock: number;
     isActive: boolean;
     category?: string;
-    createdAt: string;
-    updatedAt: string;
+    metadata?: Record<string, any>;
 }
-interface Order {
-    id: string;
+interface Order extends BaseRecord {
     userId: string;
     status: 'pending' | 'processing' | 'shipped' | 'delivered' | 'cancelled';
     items: OrderItem[];
     subtotal: number;
     tax: number;
+    shipping: number;
     total: number;
     shippingAddress?: Address;
-    createdAt: string;
+    billingAddress?: Address;
+    paymentMethodId?: string;
+    stripePaymentIntentId?: string;
+    notes?: string;
 }
 interface OrderItem {
     productId: string;
@@ -279,6 +280,70 @@ interface CartItem {
     productId: string;
     quantity: number;
 }
+interface CreateProductInput {
+    name: string;
+    description?: string;
+    sku?: string;
+    price: number;
+    currency: string;
+    images?: string[];
+    stock: number;
+    isActive?: boolean;
+    category?: string;
+    metadata?: Record<string, any>;
+}
+interface CreateOrderInput {
+    userId: string;
+    items: Array<{
+        productId: string;
+        quantity: number;
+    }>;
+    shippingAddress: Address;
+    billingAddress?: Address;
+    paymentMethodId?: string;
+    notes?: string;
+}
+interface OrderCalculation {
+    subtotal: number;
+    tax: number;
+    shipping: number;
+    total: number;
+    items: Array<{
+        productId: string;
+        name: string;
+        price: number;
+        quantity: number;
+        lineTotal: number;
+        inStock: boolean;
+    }>;
+}
+interface RevenueStats {
+    totalRevenue: number;
+    totalOrders: number;
+    averageOrderValue: number;
+    period: {
+        start: string;
+        end: string;
+    };
+    trend: {
+        revenue: number;
+        orders: number;
+    };
+}
+interface ProductStats {
+    productId: string;
+    name: string;
+    totalSold: number;
+    revenue: number;
+}
+interface OrderStats {
+    pending: number;
+    processing: number;
+    shipped: number;
+    delivered: number;
+    cancelled: number;
+    averageOrderValue: number;
+}
 /**
  * Standard API response
  */
@@ -564,4 +629,129 @@ declare class VlibeBaseAuth {
     getBaseUrl(): string;
 }
 
-export { type AppCategory as A, type BasePlan as B, type ConnectStatus as C, type DatabaseConfig as D, type FeatureFlag as F, type Media as M, type Order as O, type PaymentsConfig as P, type QueryOptions as Q, type RefundOptions as R, type Subscription as S, type Transaction as T, type UsageMetric as U, VlibeBaseDatabase as V, type CheckoutOptions as a, type CheckoutSession as b, VlibeBaseAuth as c, type VlibeBaseConfig as d, type AuthConfig as e, type ColumnType as f, type TableColumn as g, type TableSchema as h, type TableInfo as i, type BaseRecord as j, type RealtimePayload as k, type VlibeUser as l, type VerifyResponse as m, type AuthSession as n, type Page as o, type Product as p, type OrderItem as q, type Address as r, type CartItem as s, type ApiResponse as t, type PaginatedResponse as u, type UseCollectionReturn as v, type UseCollectionOptions as w, type UseKVReturn as x, type UseAuthReturn as y, type UsePaymentsReturn as z };
+/**
+ * VlibeBaseEcommerce - E-commerce functionality for Vlibe Base apps
+ *
+ * Provides specialized methods for managing products, inventory, orders,
+ * shopping carts, and e-commerce analytics.
+ */
+declare class VlibeBaseEcommerce {
+    private db;
+    constructor(db: VlibeBaseDatabase);
+    /**
+     * Create a new product
+     * Auto-generates SKU if not provided
+     */
+    createProduct(input: CreateProductInput): Promise<Product>;
+    /**
+     * Update an existing product
+     */
+    updateProduct(productId: string, updates: Partial<Product>): Promise<Product>;
+    /**
+     * Get a single product by ID
+     */
+    getProduct(productId: string): Promise<Product | null>;
+    /**
+     * List products with filtering and pagination
+     */
+    listProducts(options?: {
+        category?: string;
+        isActive?: boolean;
+        sortBy?: 'name' | 'price' | 'stock' | 'created_at';
+        limit?: number;
+        offset?: number;
+    }): Promise<{
+        products: Product[];
+        total: number;
+    }>;
+    /**
+     * Soft delete a product (sets isActive = false)
+     */
+    deleteProduct(productId: string): Promise<void>;
+    /**
+     * Update product inventory with atomic operations
+     */
+    updateInventory(productId: string, quantity: number, operation: 'set' | 'increment' | 'decrement'): Promise<Product>;
+    /**
+     * Get products below stock threshold
+     */
+    getLowStockProducts(threshold?: number): Promise<Product[]>;
+    /**
+     * Bulk update inventory for multiple products
+     */
+    bulkUpdateInventory(updates: Array<{
+        productId: string;
+        quantity: number;
+        operation: 'set' | 'increment' | 'decrement';
+    }>): Promise<Product[]>;
+    /**
+     * Calculate order totals from cart items
+     */
+    calculateOrderTotal(items: CartItem[]): Promise<OrderCalculation>;
+    /**
+     * Create an order from cart items
+     * Reduces inventory atomically
+     */
+    createOrder(input: CreateOrderInput): Promise<Order>;
+    /**
+     * Get an order by ID
+     */
+    getOrder(orderId: string): Promise<Order | null>;
+    /**
+     * List orders with filtering
+     */
+    listOrders(options?: {
+        userId?: string;
+        status?: Order['status'];
+        sortBy?: 'created_at' | 'total';
+        limit?: number;
+        offset?: number;
+    }): Promise<{
+        orders: Order[];
+        total: number;
+    }>;
+    /**
+     * Update order status
+     */
+    updateOrderStatus(orderId: string, status: Order['status']): Promise<Order>;
+    /**
+     * Cancel an order and optionally restore inventory
+     */
+    cancelOrder(orderId: string, restoreInventory?: boolean): Promise<Order>;
+    /**
+     * Add item to user's cart
+     */
+    addToCart(userId: string, item: CartItem): Promise<CartItem[]>;
+    /**
+     * Update cart item quantity or remove if quantity = 0
+     */
+    updateCartItem(userId: string, productId: string, quantity: number): Promise<CartItem[]>;
+    /**
+     * Get user's cart
+     */
+    getCart(userId: string): Promise<CartItem[]>;
+    /**
+     * Clear user's cart
+     */
+    clearCart(userId: string): Promise<void>;
+    /**
+     * Checkout - convert cart to order and clear cart
+     */
+    checkout(userId: string, shippingAddress: Address, paymentMethodId?: string): Promise<Order>;
+    /**
+     * Get revenue statistics for a time period
+     */
+    getRevenueStats(period: 'day' | 'week' | 'month' | 'year'): Promise<RevenueStats>;
+    /**
+     * Get top selling products
+     */
+    getTopProducts(limit?: number, period?: 'day' | 'week' | 'month'): Promise<ProductStats[]>;
+    /**
+     * Get order statistics by status
+     */
+    getOrderStats(): Promise<OrderStats>;
+    private generateSKU;
+    private getPeriodStart;
+}
+
+export { type AppCategory as A, type BasePlan as B, type ConnectStatus as C, type DatabaseConfig as D, type ApiResponse as E, type FeatureFlag as F, type PaginatedResponse as G, type UseCollectionReturn as H, type UseCollectionOptions as I, type UseKVReturn as J, type UseAuthReturn as K, type UsePaymentsReturn as L, type Media as M, type Order as O, type PaymentsConfig as P, type QueryOptions as Q, type RefundOptions as R, type Subscription as S, type Transaction as T, type UsageMetric as U, VlibeBaseDatabase as V, type CheckoutOptions as a, type CheckoutSession as b, VlibeBaseAuth as c, VlibeBaseEcommerce as d, type VlibeBaseConfig as e, type AuthConfig as f, type ColumnType as g, type TableColumn as h, type TableSchema as i, type TableInfo as j, type BaseRecord as k, type RealtimePayload as l, type VlibeUser as m, type VerifyResponse as n, type AuthSession as o, type Page as p, type Product as q, type OrderItem as r, type Address as s, type CartItem as t, type CreateProductInput as u, type CreateOrderInput as v, type OrderCalculation as w, type RevenueStats as x, type ProductStats as y, type OrderStats as z };

package/dist/{VlibeBaseAuth-BxS9T0vB.d.ts → VlibeBaseEcommerce-B6l17uup.d.ts}

@@ -236,8 +236,7 @@ interface UsageMetric {
     period: string;
     createdAt: string;
 }
-interface Product {
-    id: string;
+interface Product extends BaseRecord {
     name: string;
     description?: string;
     sku?: string;
@@ -247,19 +246,21 @@ interface Product {
     stock: number;
     isActive: boolean;
     category?: string;
-    createdAt: string;
-    updatedAt: string;
+    metadata?: Record<string, any>;
 }
-interface Order {
-    id: string;
+interface Order extends BaseRecord {
     userId: string;
     status: 'pending' | 'processing' | 'shipped' | 'delivered' | 'cancelled';
     items: OrderItem[];
     subtotal: number;
     tax: number;
+    shipping: number;
     total: number;
     shippingAddress?: Address;
-    createdAt: string;
+    billingAddress?: Address;
+    paymentMethodId?: string;
+    stripePaymentIntentId?: string;
+    notes?: string;
 }
 interface OrderItem {
     productId: string;
@@ -279,6 +280,70 @@ interface CartItem {
     productId: string;
     quantity: number;
 }
+interface CreateProductInput {
+    name: string;
+    description?: string;
+    sku?: string;
+    price: number;
+    currency: string;
+    images?: string[];
+    stock: number;
+    isActive?: boolean;
+    category?: string;
+    metadata?: Record<string, any>;
+}
+interface CreateOrderInput {
+    userId: string;
+    items: Array<{
+        productId: string;
+        quantity: number;
+    }>;
+    shippingAddress: Address;
+    billingAddress?: Address;
+    paymentMethodId?: string;
+    notes?: string;
+}
+interface OrderCalculation {
+    subtotal: number;
+    tax: number;
+    shipping: number;
+    total: number;
+    items: Array<{
+        productId: string;
+        name: string;
+        price: number;
+        quantity: number;
+        lineTotal: number;
+        inStock: boolean;
+    }>;
+}
+interface RevenueStats {
+    totalRevenue: number;
+    totalOrders: number;
+    averageOrderValue: number;
+    period: {
+        start: string;
+        end: string;
+    };
+    trend: {
+        revenue: number;
+        orders: number;
+    };
+}
+interface ProductStats {
+    productId: string;
+    name: string;
+    totalSold: number;
+    revenue: number;
+}
+interface OrderStats {
+    pending: number;
+    processing: number;
+    shipped: number;
+    delivered: number;
+    cancelled: number;
+    averageOrderValue: number;
+}
 /**
  * Standard API response
  */
@@ -564,4 +629,129 @@ declare class VlibeBaseAuth {
     getBaseUrl(): string;
 }
 
-export { type AppCategory as A, type BasePlan as B, type ConnectStatus as C, type DatabaseConfig as D, type FeatureFlag as F, type Media as M, type Order as O, type PaymentsConfig as P, type QueryOptions as Q, type RefundOptions as R, type Subscription as S, type Transaction as T, type UsageMetric as U, VlibeBaseDatabase as V, type CheckoutOptions as a, type CheckoutSession as b, VlibeBaseAuth as c, type VlibeBaseConfig as d, type AuthConfig as e, type ColumnType as f, type TableColumn as g, type TableSchema as h, type TableInfo as i, type BaseRecord as j, type RealtimePayload as k, type VlibeUser as l, type VerifyResponse as m, type AuthSession as n, type Page as o, type Product as p, type OrderItem as q, type Address as r, type CartItem as s, type ApiResponse as t, type PaginatedResponse as u, type UseCollectionReturn as v, type UseCollectionOptions as w, type UseKVReturn as x, type UseAuthReturn as y, type UsePaymentsReturn as z };
+/**
+ * VlibeBaseEcommerce - E-commerce functionality for Vlibe Base apps
+ *
+ * Provides specialized methods for managing products, inventory, orders,
+ * shopping carts, and e-commerce analytics.
+ */
+declare class VlibeBaseEcommerce {
+    private db;
+    constructor(db: VlibeBaseDatabase);
+    /**
+     * Create a new product
+     * Auto-generates SKU if not provided
+     */
+    createProduct(input: CreateProductInput): Promise<Product>;
+    /**
+     * Update an existing product
+     */
+    updateProduct(productId: string, updates: Partial<Product>): Promise<Product>;
+    /**
+     * Get a single product by ID
+     */
+    getProduct(productId: string): Promise<Product | null>;
+    /**
+     * List products with filtering and pagination
+     */
+    listProducts(options?: {
+        category?: string;
+        isActive?: boolean;
+        sortBy?: 'name' | 'price' | 'stock' | 'created_at';
+        limit?: number;
+        offset?: number;
+    }): Promise<{
+        products: Product[];
+        total: number;
+    }>;
+    /**
+     * Soft delete a product (sets isActive = false)
+     */
+    deleteProduct(productId: string): Promise<void>;
+    /**
+     * Update product inventory with atomic operations
+     */
+    updateInventory(productId: string, quantity: number, operation: 'set' | 'increment' | 'decrement'): Promise<Product>;
+    /**
+     * Get products below stock threshold
+     */
+    getLowStockProducts(threshold?: number): Promise<Product[]>;
+    /**
+     * Bulk update inventory for multiple products
+     */
+    bulkUpdateInventory(updates: Array<{
+        productId: string;
+        quantity: number;
+        operation: 'set' | 'increment' | 'decrement';
+    }>): Promise<Product[]>;
+    /**
+     * Calculate order totals from cart items
+     */
+    calculateOrderTotal(items: CartItem[]): Promise<OrderCalculation>;
+    /**
+     * Create an order from cart items
+     * Reduces inventory atomically
+     */
+    createOrder(input: CreateOrderInput): Promise<Order>;
+    /**
+     * Get an order by ID
+     */
+    getOrder(orderId: string): Promise<Order | null>;
+    /**
+     * List orders with filtering
+     */
+    listOrders(options?: {
+        userId?: string;
+        status?: Order['status'];
+        sortBy?: 'created_at' | 'total';
+        limit?: number;
+        offset?: number;
+    }): Promise<{
+        orders: Order[];
+        total: number;
+    }>;
+    /**
+     * Update order status
+     */
+    updateOrderStatus(orderId: string, status: Order['status']): Promise<Order>;
+    /**
+     * Cancel an order and optionally restore inventory
+     */
+    cancelOrder(orderId: string, restoreInventory?: boolean): Promise<Order>;
+    /**
+     * Add item to user's cart
+     */
+    addToCart(userId: string, item: CartItem): Promise<CartItem[]>;
+    /**
+     * Update cart item quantity or remove if quantity = 0
+     */
+    updateCartItem(userId: string, productId: string, quantity: number): Promise<CartItem[]>;
+    /**
+     * Get user's cart
+     */
+    getCart(userId: string): Promise<CartItem[]>;
+    /**
+     * Clear user's cart
+     */
+    clearCart(userId: string): Promise<void>;
+    /**
+     * Checkout - convert cart to order and clear cart
+     */
+    checkout(userId: string, shippingAddress: Address, paymentMethodId?: string): Promise<Order>;
+    /**
+     * Get revenue statistics for a time period
+     */
+    getRevenueStats(period: 'day' | 'week' | 'month' | 'year'): Promise<RevenueStats>;
+    /**
+     * Get top selling products
+     */
+    getTopProducts(limit?: number, period?: 'day' | 'week' | 'month'): Promise<ProductStats[]>;
+    /**
+     * Get order statistics by status
+     */
+    getOrderStats(): Promise<OrderStats>;
+    private generateSKU;
+    private getPeriodStart;
+}
+
+export { type AppCategory as A, type BasePlan as B, type ConnectStatus as C, type DatabaseConfig as D, type ApiResponse as E, type FeatureFlag as F, type PaginatedResponse as G, type UseCollectionReturn as H, type UseCollectionOptions as I, type UseKVReturn as J, type UseAuthReturn as K, type UsePaymentsReturn as L, type Media as M, type Order as O, type PaymentsConfig as P, type QueryOptions as Q, type RefundOptions as R, type Subscription as S, type Transaction as T, type UsageMetric as U, VlibeBaseDatabase as V, type CheckoutOptions as a, type CheckoutSession as b, VlibeBaseAuth as c, VlibeBaseEcommerce as d, type VlibeBaseConfig as e, type AuthConfig as f, type ColumnType as g, type TableColumn as h, type TableSchema as i, type TableInfo as j, type BaseRecord as k, type RealtimePayload as l, type VlibeUser as m, type VerifyResponse as n, type AuthSession as o, type Page as p, type Product as q, type OrderItem as r, type Address as s, type CartItem as t, type CreateProductInput as u, type CreateOrderInput as v, type OrderCalculation as w, type RevenueStats as x, type ProductStats as y, type OrderStats as z };

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { P as PaymentsConfig, C as ConnectStatus, a as CheckoutOptions, b as CheckoutSession, T as Transaction, R as RefundOptions } from './VlibeBaseAuth-BxS9T0vB.mjs';
-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-BxS9T0vB.mjs';
+import { P as PaymentsConfig, C as ConnectStatus, a as CheckoutOptions, b as CheckoutSession, T as Transaction, R as RefundOptions } from './VlibeBaseEcommerce-B6l17uup.mjs';
+export { s as Address, E as ApiResponse, A as AppCategory, f as AuthConfig, o as AuthSession, B as BasePlan, k as BaseRecord, t as CartItem, g as ColumnType, v as CreateOrderInput, u as CreateProductInput, D as DatabaseConfig, F as FeatureFlag, M as Media, O as Order, w as OrderCalculation, r as OrderItem, z as OrderStats, p as Page, G as PaginatedResponse, q as Product, y as ProductStats, Q as QueryOptions, l as RealtimePayload, x as RevenueStats, S as Subscription, h as TableColumn, j as TableInfo, i as TableSchema, U as UsageMetric, K as UseAuthReturn, I as UseCollectionOptions, H as UseCollectionReturn, J as UseKVReturn, L as UsePaymentsReturn, n as VerifyResponse, c as VlibeBaseAuth, e as VlibeBaseConfig, V as VlibeBaseDatabase, d as VlibeBaseEcommerce, m as VlibeUser } from './VlibeBaseEcommerce-B6l17uup.mjs';
 
 /**
  * VlibeBasePayments - Payment processing for Vlibe Base Apps

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { P as PaymentsConfig, C as ConnectStatus, a as CheckoutOptions, b as CheckoutSession, T as Transaction, R as RefundOptions } from './VlibeBaseAuth-BxS9T0vB.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-BxS9T0vB.js';
+import { P as PaymentsConfig, C as ConnectStatus, a as CheckoutOptions, b as CheckoutSession, T as Transaction, R as RefundOptions } from './VlibeBaseEcommerce-B6l17uup.js';
+export { s as Address, E as ApiResponse, A as AppCategory, f as AuthConfig, o as AuthSession, B as BasePlan, k as BaseRecord, t as CartItem, g as ColumnType, v as CreateOrderInput, u as CreateProductInput, D as DatabaseConfig, F as FeatureFlag, M as Media, O as Order, w as OrderCalculation, r as OrderItem, z as OrderStats, p as Page, G as PaginatedResponse, q as Product, y as ProductStats, Q as QueryOptions, l as RealtimePayload, x as RevenueStats, S as Subscription, h as TableColumn, j as TableInfo, i as TableSchema, U as UsageMetric, K as UseAuthReturn, I as UseCollectionOptions, H as UseCollectionReturn, J as UseKVReturn, L as UsePaymentsReturn, n as VerifyResponse, c as VlibeBaseAuth, e as VlibeBaseConfig, V as VlibeBaseDatabase, d as VlibeBaseEcommerce, m as VlibeUser } from './VlibeBaseEcommerce-B6l17uup.js';
 
 /**
  * VlibeBasePayments - Payment processing for Vlibe Base Apps