spaps-sdk 1.0.2 → 1.1.0

package/dist/index.d.mts

@@ -0,0 +1,302 @@
+/**
+ * Permission checking utilities for SPAPS SDK
+ * Client-side role and permission management
+ */
+interface User$1 {
+    id: string;
+    email?: string;
+    wallet_address?: string;
+    role?: string;
+    permissions?: string[];
+    tier?: string;
+}
+interface AdminConfig {
+    email: string;
+    wallets: {
+        ethereum: string;
+        solana: string;
+    };
+}
+interface PermissionCheckResult {
+    allowed: boolean;
+    reason?: string;
+    userRole: string;
+    requiredRole?: string;
+}
+declare const DEFAULT_ADMIN_ACCOUNTS: AdminConfig;
+/**
+ * Check if an identifier (email/wallet) is an admin account
+ */
+declare function isAdminAccount(identifier: string, customAdmins?: (string | AdminConfig)[]): boolean;
+/**
+ * Get user role based on identifier
+ */
+declare function getUserRole(identifier?: string, customAdmins?: (string | AdminConfig)[]): string;
+/**
+ * Check if user has specific permissions
+ */
+declare function hasPermission(user: User$1 | null, requiredPermissions: string | string[], customAdmins?: (string | AdminConfig)[]): boolean;
+/**
+ * Check if user can access admin features
+ */
+declare function canAccessAdmin(user: User$1 | null, customAdmins?: (string | AdminConfig)[]): PermissionCheckResult;
+/**
+ * Get role-aware error message
+ */
+declare function getRoleAwareErrorMessage(requiredRole: string, userRole: string, action?: string): string;
+/**
+ * Get user display information with role indicators
+ */
+declare function getUserDisplay(user: User$1 | null, customAdmins?: (string | AdminConfig)[]): {
+    displayName: string;
+    role: string;
+    badge: string | null;
+    isAdmin: boolean;
+};
+/**
+ * Permission checker class for easier usage
+ */
+declare class PermissionChecker {
+    private customAdmins;
+    constructor(customAdmins?: (string | AdminConfig)[]);
+    isAdmin(identifier: string): boolean;
+    getRole(identifier?: string): string;
+    hasPermission(user: User$1 | null, permissions: string | string[]): boolean;
+    canAccessAdmin(user: User$1 | null): PermissionCheckResult;
+    getErrorMessage(requiredRole: string, userRole: string, action?: string): string;
+    getUserDisplay(user: User$1 | null): {
+        displayName: string;
+        role: string;
+        badge: string | null;
+        isAdmin: boolean;
+    };
+    requiresAuth(user: User$1 | null): boolean;
+    requiresAdmin(user: User$1 | null): boolean;
+    addCustomAdmin(admin: string | AdminConfig): void;
+    removeCustomAdmin(admin: string | AdminConfig): void;
+}
+/**
+ * Create a permission checker instance
+ */
+declare function createPermissionChecker(customAdmins?: (string | AdminConfig)[]): PermissionChecker;
+declare const defaultPermissionChecker: PermissionChecker;
+
+/**
+ * @spaps/sdk - Sweet Potato Authentication & Payment Service SDK
+ * Zero-config client for SPAPS authentication and payments
+ */
+interface SPAPSConfig {
+    apiUrl?: string;
+    apiKey?: string;
+    autoDetect?: boolean;
+    timeout?: number;
+}
+interface AuthResponse {
+    access_token: string;
+    refresh_token: string;
+    user: User;
+}
+interface User {
+    id: string;
+    email?: string;
+    wallet_address?: string;
+    chain_type?: string;
+    role: string;
+    created_at?: string;
+}
+interface CheckoutSession {
+    sessionId: string;
+    url: string;
+}
+interface Subscription {
+    id: string;
+    status: string;
+    plan: string;
+    current_period_end: string;
+}
+interface UsageBalance {
+    balance: number;
+    currency: string;
+    updated_at: string;
+}
+interface Product {
+    id: string;
+    name: string;
+    description?: string;
+    category: string;
+    active: boolean;
+    images?: string[];
+    metadata?: Record<string, string>;
+    statement_descriptor?: string;
+    unit_label?: string;
+    created?: number;
+    updated?: number;
+}
+interface Price {
+    id: string;
+    product: string;
+    unit_amount: number;
+    currency: string;
+    recurring?: {
+        interval: 'day' | 'week' | 'month' | 'year';
+        interval_count: number;
+    };
+    nickname?: string;
+    active: boolean;
+}
+interface CreateProductRequest {
+    name: string;
+    description?: string;
+    category: string;
+    images?: string[];
+    metadata?: Record<string, string>;
+    active?: boolean;
+    statement_descriptor?: string;
+    unit_label?: string;
+}
+interface UpdateProductRequest {
+    name?: string;
+    description?: string;
+    category?: string;
+    images?: string[];
+    metadata?: Record<string, string>;
+    active?: boolean;
+    statement_descriptor?: string;
+    unit_label?: string;
+}
+interface CreatePriceRequest {
+    product_id: string;
+    unit_amount: number;
+    currency: string;
+    interval?: 'day' | 'week' | 'month' | 'year';
+    interval_count?: number;
+    nickname?: string;
+}
+interface ProductSyncResult {
+    synced_count: number;
+    updated_count: number;
+    created_count: number;
+    errors: any[];
+    sync_time: string;
+}
+declare class SPAPSClient {
+    private client;
+    private apiKey?;
+    private accessToken?;
+    private refreshToken?;
+    private _isLocalMode;
+    admin: {
+        createProduct: (productData: CreateProductRequest) => Promise<{
+            data: Product;
+        }>;
+        updateProduct: (productId: string, updates: UpdateProductRequest) => Promise<{
+            data: Product;
+        }>;
+        deleteProduct: (productId: string) => Promise<{
+            data: {
+                id: string;
+                active: boolean;
+                archived: boolean;
+            };
+        }>;
+        createPrice: (priceData: CreatePriceRequest) => Promise<{
+            data: Price;
+        }>;
+        syncProducts: () => Promise<{
+            data: ProductSyncResult;
+        }>;
+        getProducts: () => Promise<{
+            data: {
+                products: Product[];
+                total: number;
+                adminMetadata?: any;
+            };
+        }>;
+    };
+    constructor(config?: SPAPSConfig);
+    login(email: string, password: string): Promise<{
+        data: AuthResponse;
+    }>;
+    register(email: string, password: string): Promise<{
+        data: AuthResponse;
+    }>;
+    walletSignIn(walletAddress: string, signature: string, message: string, chainType?: 'solana' | 'ethereum'): Promise<{
+        data: AuthResponse;
+    }>;
+    refresh(refreshToken?: string): Promise<{
+        data: AuthResponse;
+    }>;
+    logout(): Promise<void>;
+    getUser(): Promise<{
+        data: User;
+    }>;
+    createCheckoutSession(priceId: string, successUrl: string, cancelUrl?: string): Promise<{
+        data: CheckoutSession;
+    }>;
+    getSubscription(): Promise<{
+        data: Subscription;
+    }>;
+    cancelSubscription(): Promise<void>;
+    getUsageBalance(): Promise<{
+        data: UsageBalance;
+    }>;
+    recordUsage(feature: string, amount: number): Promise<void>;
+    /**
+     * Create a new Stripe product (Admin required)
+     */
+    createProduct(productData: CreateProductRequest): Promise<{
+        data: Product;
+    }>;
+    /**
+     * Update an existing Stripe product (Admin required)
+     */
+    updateProduct(productId: string, updates: UpdateProductRequest): Promise<{
+        data: Product;
+    }>;
+    /**
+     * Archive (soft delete) a Stripe product (Admin required)
+     */
+    deleteProduct(productId: string): Promise<{
+        data: {
+            id: string;
+            active: boolean;
+            archived: boolean;
+        };
+    }>;
+    /**
+     * Create a new price for a product (Admin required)
+     */
+    createPrice(priceData: CreatePriceRequest): Promise<{
+        data: Price;
+    }>;
+    /**
+     * Sync all products from Stripe to local database (Super Admin required)
+     */
+    syncProducts(): Promise<{
+        data: ProductSyncResult;
+    }>;
+    /**
+     * Get products with admin metadata (if user is admin)
+     */
+    getProducts(): Promise<{
+        data: {
+            products: Product[];
+            total: number;
+            adminMetadata?: any;
+        };
+    }>;
+    isAuthenticated(): boolean;
+    getAccessToken(): string | undefined;
+    setAccessToken(token: string): void;
+    isLocalMode(): boolean;
+    /**
+     * Check if current user has admin privileges
+     * Note: This requires the user object from authentication
+     */
+    isAdmin(user?: User): boolean;
+    health(): Promise<{
+        data: any;
+    }>;
+}
+
+export { type AdminConfig, type AuthResponse, type CheckoutSession, type CreatePriceRequest, type CreateProductRequest, DEFAULT_ADMIN_ACCOUNTS, type PermissionCheckResult, PermissionChecker, type Price, type Product, type ProductSyncResult, SPAPSClient as SPAPS, SPAPSClient, type SPAPSConfig, type Subscription, SPAPSClient as SweetPotatoSDK, type UpdateProductRequest, type UsageBalance, type User, canAccessAdmin, createPermissionChecker, SPAPSClient as default, defaultPermissionChecker, getRoleAwareErrorMessage, getUserDisplay, getUserRole, hasPermission, isAdminAccount };

package/dist/index.d.ts

@@ -0,0 +1,302 @@
+/**
+ * Permission checking utilities for SPAPS SDK
+ * Client-side role and permission management
+ */
+interface User$1 {
+    id: string;
+    email?: string;
+    wallet_address?: string;
+    role?: string;
+    permissions?: string[];
+    tier?: string;
+}
+interface AdminConfig {
+    email: string;
+    wallets: {
+        ethereum: string;
+        solana: string;
+    };
+}
+interface PermissionCheckResult {
+    allowed: boolean;
+    reason?: string;
+    userRole: string;
+    requiredRole?: string;
+}
+declare const DEFAULT_ADMIN_ACCOUNTS: AdminConfig;
+/**
+ * Check if an identifier (email/wallet) is an admin account
+ */
+declare function isAdminAccount(identifier: string, customAdmins?: (string | AdminConfig)[]): boolean;
+/**
+ * Get user role based on identifier
+ */
+declare function getUserRole(identifier?: string, customAdmins?: (string | AdminConfig)[]): string;
+/**
+ * Check if user has specific permissions
+ */
+declare function hasPermission(user: User$1 | null, requiredPermissions: string | string[], customAdmins?: (string | AdminConfig)[]): boolean;
+/**
+ * Check if user can access admin features
+ */
+declare function canAccessAdmin(user: User$1 | null, customAdmins?: (string | AdminConfig)[]): PermissionCheckResult;
+/**
+ * Get role-aware error message
+ */
+declare function getRoleAwareErrorMessage(requiredRole: string, userRole: string, action?: string): string;
+/**
+ * Get user display information with role indicators
+ */
+declare function getUserDisplay(user: User$1 | null, customAdmins?: (string | AdminConfig)[]): {
+    displayName: string;
+    role: string;
+    badge: string | null;
+    isAdmin: boolean;
+};
+/**
+ * Permission checker class for easier usage
+ */
+declare class PermissionChecker {
+    private customAdmins;
+    constructor(customAdmins?: (string | AdminConfig)[]);
+    isAdmin(identifier: string): boolean;
+    getRole(identifier?: string): string;
+    hasPermission(user: User$1 | null, permissions: string | string[]): boolean;
+    canAccessAdmin(user: User$1 | null): PermissionCheckResult;
+    getErrorMessage(requiredRole: string, userRole: string, action?: string): string;
+    getUserDisplay(user: User$1 | null): {
+        displayName: string;
+        role: string;
+        badge: string | null;
+        isAdmin: boolean;
+    };
+    requiresAuth(user: User$1 | null): boolean;
+    requiresAdmin(user: User$1 | null): boolean;
+    addCustomAdmin(admin: string | AdminConfig): void;
+    removeCustomAdmin(admin: string | AdminConfig): void;
+}
+/**
+ * Create a permission checker instance
+ */
+declare function createPermissionChecker(customAdmins?: (string | AdminConfig)[]): PermissionChecker;
+declare const defaultPermissionChecker: PermissionChecker;
+
+/**
+ * @spaps/sdk - Sweet Potato Authentication & Payment Service SDK
+ * Zero-config client for SPAPS authentication and payments
+ */
+interface SPAPSConfig {
+    apiUrl?: string;
+    apiKey?: string;
+    autoDetect?: boolean;
+    timeout?: number;
+}
+interface AuthResponse {
+    access_token: string;
+    refresh_token: string;
+    user: User;
+}
+interface User {
+    id: string;
+    email?: string;
+    wallet_address?: string;
+    chain_type?: string;
+    role: string;
+    created_at?: string;
+}
+interface CheckoutSession {
+    sessionId: string;
+    url: string;
+}
+interface Subscription {
+    id: string;
+    status: string;
+    plan: string;
+    current_period_end: string;
+}
+interface UsageBalance {
+    balance: number;
+    currency: string;
+    updated_at: string;
+}
+interface Product {
+    id: string;
+    name: string;
+    description?: string;
+    category: string;
+    active: boolean;
+    images?: string[];
+    metadata?: Record<string, string>;
+    statement_descriptor?: string;
+    unit_label?: string;
+    created?: number;
+    updated?: number;
+}
+interface Price {
+    id: string;
+    product: string;
+    unit_amount: number;
+    currency: string;
+    recurring?: {
+        interval: 'day' | 'week' | 'month' | 'year';
+        interval_count: number;
+    };
+    nickname?: string;
+    active: boolean;
+}
+interface CreateProductRequest {
+    name: string;
+    description?: string;
+    category: string;
+    images?: string[];
+    metadata?: Record<string, string>;
+    active?: boolean;
+    statement_descriptor?: string;
+    unit_label?: string;
+}
+interface UpdateProductRequest {
+    name?: string;
+    description?: string;
+    category?: string;
+    images?: string[];
+    metadata?: Record<string, string>;
+    active?: boolean;
+    statement_descriptor?: string;
+    unit_label?: string;
+}
+interface CreatePriceRequest {
+    product_id: string;
+    unit_amount: number;
+    currency: string;
+    interval?: 'day' | 'week' | 'month' | 'year';
+    interval_count?: number;
+    nickname?: string;
+}
+interface ProductSyncResult {
+    synced_count: number;
+    updated_count: number;
+    created_count: number;
+    errors: any[];
+    sync_time: string;
+}
+declare class SPAPSClient {
+    private client;
+    private apiKey?;
+    private accessToken?;
+    private refreshToken?;
+    private _isLocalMode;
+    admin: {
+        createProduct: (productData: CreateProductRequest) => Promise<{
+            data: Product;
+        }>;
+        updateProduct: (productId: string, updates: UpdateProductRequest) => Promise<{
+            data: Product;
+        }>;
+        deleteProduct: (productId: string) => Promise<{
+            data: {
+                id: string;
+                active: boolean;
+                archived: boolean;
+            };
+        }>;
+        createPrice: (priceData: CreatePriceRequest) => Promise<{
+            data: Price;
+        }>;
+        syncProducts: () => Promise<{
+            data: ProductSyncResult;
+        }>;
+        getProducts: () => Promise<{
+            data: {
+                products: Product[];
+                total: number;
+                adminMetadata?: any;
+            };
+        }>;
+    };
+    constructor(config?: SPAPSConfig);
+    login(email: string, password: string): Promise<{
+        data: AuthResponse;
+    }>;
+    register(email: string, password: string): Promise<{
+        data: AuthResponse;
+    }>;
+    walletSignIn(walletAddress: string, signature: string, message: string, chainType?: 'solana' | 'ethereum'): Promise<{
+        data: AuthResponse;
+    }>;
+    refresh(refreshToken?: string): Promise<{
+        data: AuthResponse;
+    }>;
+    logout(): Promise<void>;
+    getUser(): Promise<{
+        data: User;
+    }>;
+    createCheckoutSession(priceId: string, successUrl: string, cancelUrl?: string): Promise<{
+        data: CheckoutSession;
+    }>;
+    getSubscription(): Promise<{
+        data: Subscription;
+    }>;
+    cancelSubscription(): Promise<void>;
+    getUsageBalance(): Promise<{
+        data: UsageBalance;
+    }>;
+    recordUsage(feature: string, amount: number): Promise<void>;
+    /**
+     * Create a new Stripe product (Admin required)
+     */
+    createProduct(productData: CreateProductRequest): Promise<{
+        data: Product;
+    }>;
+    /**
+     * Update an existing Stripe product (Admin required)
+     */
+    updateProduct(productId: string, updates: UpdateProductRequest): Promise<{
+        data: Product;
+    }>;
+    /**
+     * Archive (soft delete) a Stripe product (Admin required)
+     */
+    deleteProduct(productId: string): Promise<{
+        data: {
+            id: string;
+            active: boolean;
+            archived: boolean;
+        };
+    }>;
+    /**
+     * Create a new price for a product (Admin required)
+     */
+    createPrice(priceData: CreatePriceRequest): Promise<{
+        data: Price;
+    }>;
+    /**
+     * Sync all products from Stripe to local database (Super Admin required)
+     */
+    syncProducts(): Promise<{
+        data: ProductSyncResult;
+    }>;
+    /**
+     * Get products with admin metadata (if user is admin)
+     */
+    getProducts(): Promise<{
+        data: {
+            products: Product[];
+            total: number;
+            adminMetadata?: any;
+        };
+    }>;
+    isAuthenticated(): boolean;
+    getAccessToken(): string | undefined;
+    setAccessToken(token: string): void;
+    isLocalMode(): boolean;
+    /**
+     * Check if current user has admin privileges
+     * Note: This requires the user object from authentication
+     */
+    isAdmin(user?: User): boolean;
+    health(): Promise<{
+        data: any;
+    }>;
+}
+
+export { type AdminConfig, type AuthResponse, type CheckoutSession, type CreatePriceRequest, type CreateProductRequest, DEFAULT_ADMIN_ACCOUNTS, type PermissionCheckResult, PermissionChecker, type Price, type Product, type ProductSyncResult, SPAPSClient as SPAPS, SPAPSClient, type SPAPSConfig, type Subscription, SPAPSClient as SweetPotatoSDK, type UpdateProductRequest, type UsageBalance, type User, canAccessAdmin, createPermissionChecker, SPAPSClient as default, defaultPermissionChecker, getRoleAwareErrorMessage, getUserDisplay, getUserRole, hasPermission, isAdminAccount };