@oxyhq/services 5.9.1 → 5.9.3

package/lib/typescript/core/index.d.ts

@@ -1,662 +1,24 @@
-import { OxyConfig, User, Notification, Wallet, Transaction, TransferFundsRequest, PurchaseRequest, WithdrawalRequest, TransactionResponse, KarmaRule, KarmaHistory, KarmaLeaderboardEntry, KarmaAwardRequest, PaymentMethod, PaymentRequest, PaymentResponse, AnalyticsData, FollowerDetails, ContentViewer, FileMetadata, FileUploadResponse, FileListResponse, FileUpdateRequest, FileDeleteResponse, DeviceSession, DeviceSessionLogoutResponse, UpdateDeviceNameResponse } from '../models/interfaces';
-import { SecureLoginResponse } from '../models/secureSession';
 /**
- * Default cloud URL for Oxy services, cloud is where the user files are. (e.g. images, videos, etc.). Not the API.
- */
-export declare const OXY_CLOUD_URL = "https://cloud.oxy.so";
-export { DeviceManager } from '../utils/deviceManager';
-export type { DeviceFingerprint, StoredDeviceInfo } from '../utils/deviceManager';
-/**
- * OxyServices - Client library for interacting with the Oxy API
+ * OxyServices Core Module - Modular Architecture
  *
- * Note: For authentication status in UI components, use `isAuthenticated` from useOxy() context
- * instead of checking token status directly on this service.
+ * This module exports the main OxyServices class and all individual service modules
+ * for a clean, maintainable, and focused architecture.
  */
-export declare class OxyServices {
-    private client;
-    private accessToken;
-    private refreshToken;
-    /**
-     * Creates a new instance of the OxyServices client
-     * @param config - Configuration for the client
-     */
-    constructor(config: OxyConfig);
-    /**
-     * Gets the base URL configured for this OxyServices instance
-     * @returns The base URL
-     */
-    getBaseURL(): string;
-    /**
-     * Set authentication tokens manually
-     * @param accessToken - The access token
-     * @param refreshToken - The refresh token (optional for session-based auth)
-     */
-    setTokens(accessToken: string, refreshToken?: string): void;
-    /**
-     * Clear stored authentication tokens
-     */
-    clearTokens(): void;
-    /**
-     * Get the current user ID from the stored token
-     * @returns User ID or null if not authenticated
-     */
-    getCurrentUserId(): string | null;
-    /**
-     * Internal method to check if we have an access token
-     * @private
-     * @returns Boolean indicating if access token exists
-     * @internal - Use `isAuthenticated` from useOxy() context in UI components instead
-     */
-    private hasAccessToken;
-    /**
-     * Validate current access token
-     * @returns Boolean indicating if the token is valid
-     */
-    validate(): Promise<boolean>;
-    /**
-     * Get device sessions for a specific session ID
-     * @param sessionId - The session ID to get device sessions for
-     * @param deviceId - Optional device ID filter
-     * @returns Array of device sessions
-     */
-    getDeviceSessions(sessionId: string, deviceId?: string): Promise<DeviceSession[]>;
-    /**
-     * Logout all device sessions for a specific device
-     * @param sessionId - The session ID
-     * @param deviceId - Optional device ID (uses current session's device if not provided)
-     * @param excludeCurrent - Whether to exclude the current session from logout
-     * @returns Logout response
-     */
-    logoutAllDeviceSessions(sessionId: string, deviceId?: string, excludeCurrent?: boolean): Promise<DeviceSessionLogoutResponse>;
-    /**
-     * Update device name for a session
-     * @param sessionId - The session ID
-     * @param deviceName - The new device name
-     * @returns Update response
-     */
-    updateDeviceName(sessionId: string, deviceName: string): Promise<UpdateDeviceNameResponse>;
-    /**
-     * Fetch profile by username
-     * @param username - The username to look up
-     * @returns User profile data
-     */
-    getProfileByUsername(username: string): Promise<User>;
-    /**
-     * Search profiles
-     * @param query - Search query string
-     * @param limit - Maximum number of results to return
-     * @param offset - Number of results to skip for pagination
-     * @returns Array of matching user profiles
-     */
-    searchProfiles(query: string, limit?: number, offset?: number): Promise<User[]>;
-    /**
-     * Get recommended profiles for the authenticated user
-     * @returns Array of recommended profiles
-     */
-    getProfileRecommendations(): Promise<Array<{
-        id: string;
-        username: string;
-        name?: {
-            first?: string;
-            last?: string;
-            full?: string;
-        };
-        description?: string;
-        _count?: {
-            followers: number;
-            following: number;
-        };
-        [key: string]: any;
-    }>>;
-    /**
-     * Get general user by ID
-     * @param userId - The user ID to look up
-     * @returns User data
-     */
-    getUserById(userId: string): Promise<User>;
-    /**
-     * Get the currently authenticated user's profile
-     * @returns User data for the current user
-     */
-    getCurrentUser(): Promise<User>;
-    /**
-     * Update the authenticated user's profile
-     * @param updates - Object containing fields to update
-     * @returns Updated user data
-     */
-    updateProfile(updates: Record<string, any>): Promise<User>;
-    /**
-     * Update user profile (requires auth)
-     * @param userId - User ID to update (must match authenticated user or have admin rights)
-     * @param updates - Object containing fields to update
-     * @returns Updated user data
-     */
-    updateUser(userId: string, updates: Record<string, any>): Promise<User>;
-    /**
-     * Follow a user
-     * @param userId - User ID to follow
-     * @returns Status of the follow operation
-     */
-    followUser(userId: string): Promise<{
-        success: boolean;
-        message: string;
-    }>;
-    /**
-     * Unfollow a user
-     * @param userId - User ID to unfollow
-     * @returns Status of the unfollow operation
-     */
-    unfollowUser(userId: string): Promise<{
-        success: boolean;
-        message: string;
-    }>;
-    /**
-     * Get follow status for a user
-     * @param userId - User ID to check follow status for
-     * @returns Whether the current user is following the specified user
-     */
-    getFollowStatus(userId: string): Promise<{
-        isFollowing: boolean;
-    }>;
-    /**
-     * Get all followers of a user
-     * @param userId - User ID to get followers for
-     * @param limit - Maximum number of followers to return
-     * @param offset - Number of followers to skip for pagination
-     * @returns Array of users who follow the specified user and pagination info
-     */
-    getUserFollowers(userId: string, limit?: number, offset?: number): Promise<{
-        followers: User[];
-        total: number;
-        hasMore: boolean;
-    }>;
-    /**
-     * Get all users that a user is following
-     * @param userId - User ID to get following list for
-     * @param limit - Maximum number of users to return
-     * @param offset - Number of users to skip for pagination
-     * @returns Array of users the specified user follows and pagination info
-     */
-    getUserFollowing(userId: string, limit?: number, offset?: number): Promise<{
-        following: User[];
-        total: number;
-        hasMore: boolean;
-    }>;
-    /**
-     * Fetch all notifications for the authenticated user
-     * @returns Array of notifications
-     */
-    getNotifications(): Promise<Notification[]>;
-    /**
-     * Get count of unread notifications
-     * @returns Number of unread notifications
-     */
-    getUnreadCount(): Promise<number>;
-    /**
-     * Create a new notification (admin use)
-     * @param data - Notification data
-     * @returns Created notification
-     */
-    createNotification(data: Partial<Notification>): Promise<Notification>;
-    /**
-     * Mark a single notification as read
-     * @param notificationId - ID of notification to mark as read
-     */
-    markNotificationAsRead(notificationId: string): Promise<void>;
-    /**
-     * Mark all notifications as read
-     */
-    markAllNotificationsAsRead(): Promise<void>;
-    /**
-     * Delete a notification
-     * @param notificationId - ID of notification to delete
-     */
-    deleteNotification(notificationId: string): Promise<void>;
-    /**
-     * Process a payment
-     * @param data - Payment data including user ID, plan, and payment method
-     * @returns Payment result with transaction ID
-     */
-    processPayment(data: PaymentRequest): Promise<PaymentResponse>;
-    /**
-     * Validate a payment method
-     * @param paymentMethod - Payment method to validate
-     * @returns Object indicating if the payment method is valid
-     */
-    validatePaymentMethod(paymentMethod: any): Promise<{
-        valid: boolean;
-    }>;
-    /**
-     * Get saved payment methods for a user
-     * @param userId - User ID to get payment methods for
-     * @returns Array of payment methods
-     */
-    getPaymentMethods(userId: string): Promise<PaymentMethod[]>;
-    /**
-     * Get analytics data
-     * @param userId - User ID to get analytics for
-     * @param period - Time period for analytics (e.g., "day", "week", "month")
-     * @returns Analytics data
-     */
-    getAnalytics(userId: string, period?: string): Promise<AnalyticsData>;
-    /**
-     * Update analytics (internal use)
-     * @param userId - User ID to update analytics for
-     * @param type - Type of analytics to update
-     * @param data - Analytics data to update
-     * @returns Message indicating success
-     */
-    updateAnalytics(userId: string, type: string, data: Record<string, any>): Promise<{
-        message: string;
-    }>;
-    /**
-     * Get content viewers analytics
-     * @param userId - User ID to get viewer data for
-     * @param period - Time period for analytics
-     * @returns Array of content viewer data
-     */
-    getContentViewers(userId: string, period?: string): Promise<ContentViewer[]>;
-    /**
-     * Get follower analytics details
-     * @param userId - User ID to get follower data for
-     * @param period - Time period for follower data
-     * @returns Follower details
-     */
-    getFollowerDetails(userId: string, period?: string): Promise<FollowerDetails>;
-    /**
-     * Get wallet info
-     * @param userId - User ID to get wallet for
-     * @returns Wallet data
-     */
-    getWallet(userId: string): Promise<Wallet>;
-    /**
-     * Get transaction history
-     * @param userId - User ID to get transactions for
-     * @param limit - Maximum number of transactions to return
-     * @param offset - Number of transactions to skip for pagination
-     * @returns Array of transactions and pagination info
-     */
-    getTransactionHistory(userId: string, limit?: number, offset?: number): Promise<{
-        transactions: Transaction[];
-        total: number;
-        hasMore: boolean;
-    }>;
-    /**
-     * Get a specific transaction
-     * @param transactionId - ID of transaction to retrieve
-     * @returns Transaction data
-     */
-    getTransaction(transactionId: string): Promise<Transaction>;
-    /**
-     * Transfer funds between users
-     * @param data - Transfer details including source, destination, and amount
-     * @returns Transaction response
-     */
-    transferFunds(data: TransferFundsRequest): Promise<TransactionResponse>;
-    /**
-     * Process a purchase
-     * @param data - Purchase details including user, item, and amount
-     * @returns Transaction response
-     */
-    processPurchase(data: PurchaseRequest): Promise<TransactionResponse>;
-    /**
-     * Request a withdrawal
-     * @param data - Withdrawal details including user, amount, and address
-     * @returns Transaction response
-     */
-    requestWithdrawal(data: WithdrawalRequest): Promise<TransactionResponse>;
-    /**
-     * Get karma leaderboard
-     * @returns Array of karma leaderboard entries
-     */
-    getKarmaLeaderboard(): Promise<KarmaLeaderboardEntry[]>;
-    /**
-     * Get karma rules
-     * @returns Array of karma rules
-     */
-    getKarmaRules(): Promise<KarmaRule[]>;
-    /**
-     * Get total karma for a user
-     * @param userId - User ID to get karma for
-     * @returns Object with total karma points
-     */
-    getUserKarmaTotal(userId: string): Promise<{
-        total: number;
-    }>;
-    /**
-     * Get karma history for a user
-     * @param userId - User ID to get karma history for
-     * @param limit - Maximum number of history entries to return
-     * @param offset - Number of entries to skip for pagination
-     * @returns Karma history entries and pagination info
-     */
-    getUserKarmaHistory(userId: string, limit?: number, offset?: number): Promise<{
-        history: KarmaHistory[];
-        total: number;
-        hasMore: boolean;
-    }>;
-    /**
-     * Award karma points to a user
-     * @param data - Karma award details
-     * @returns Karma award response
-     */
-    awardKarma(data: KarmaAwardRequest): Promise<{
-        success: boolean;
-        message: string;
-        history: KarmaHistory;
-    }>;
-    /**
-     * Deduct karma points from a user
-     * @param data - Karma deduction details
-     * @returns Karma deduction response
-     */
-    deductKarma(data: KarmaAwardRequest): Promise<{
-        success: boolean;
-        message: string;
-        history: KarmaHistory;
-    }>;
-    /**
-     * Create or update karma rule (admin)
-     * @param data - Karma rule data
-     * @returns Created or updated karma rule
-     */
-    createOrUpdateKarmaRule(data: Partial<KarmaRule>): Promise<KarmaRule>;
-    /**
-     * Upload a file using GridFS
-     * @param file - The file to upload (File or Blob in browser, Buffer in Node.js)
-     * @param filename - The name of the file
-     * @param metadata - Optional metadata to associate with the file
-     * @returns File metadata including ID and download URL
-     */
-    uploadFile(file: File | Blob | any, // Use 'any' to handle Buffer type in cross-platform scenarios
-    filename: string, metadata?: Record<string, any>): Promise<FileMetadata>;
-    /**
-     * Upload multiple files using GridFS
-     * @param files - Array of files to upload
-     * @param filenames - Array of filenames (must match files array length)
-     * @param metadata - Optional metadata to associate with all files
-     * @returns Array of file metadata
-     */
-    uploadFiles(files: (File | Blob | any)[], filenames: string[], metadata?: Record<string, any>): Promise<FileUploadResponse>;
-    /**
-     * Get file metadata by ID
-     * @param fileId - ID of the file to retrieve metadata for
-     * @returns File metadata
-     */
-    getFileMetadata(fileId: string): Promise<FileMetadata>;
-    /**
-     * Update file metadata
-     * @param fileId - ID of the file to update
-     * @param updates - Metadata updates to apply
-     * @returns Updated file metadata
-     */
-    updateFileMetadata(fileId: string, updates: FileUpdateRequest): Promise<FileMetadata>;
-    /**
-     * Delete a file by ID
-     * @param fileId - ID of the file to delete
-     * @returns Status of the delete operation
-     */
-    deleteFile(fileId: string): Promise<FileDeleteResponse>;
-    /**
-     * Get download URL for a file
-     * @param fileId - ID of the file to get download URL for
-     * @returns Full URL to download the file
-     */
-    getFileDownloadUrl(fileId: string): string;
-    /**
-     * Stream a file (useful for playing audio/video without full download)
-     * @param fileId - ID of the file to stream
-     * @returns Full URL to stream the file
-     */
-    getFileStreamUrl(fileId: string): string;
-    /**
-     * List files for a specific user
-     * @param userId - User ID to list files for
-     * @param limit - Maximum number of files to return
-     * @param offset - Number of files to skip for pagination
-     * @param filters - Optional filters for the file list (e.g., contentType)
-     * @returns Array of file metadata and pagination info
-     */
-    listUserFiles(userId: string, limit?: number, offset?: number, filters?: Record<string, any>): Promise<FileListResponse>;
-    /**
-     * Sign up a new user and create a session
-     * @param username - Desired username
-     * @param email - User's email address
-     * @param password - User's password
-     * @returns Object containing the message, token and user data
-     */
-    signUp(username: string, email: string, password: string): Promise<{
-        message: string;
-        token: string;
-        user: User;
-    }>;
-    /**
-     * Secure login that creates a device-based session
-     * @param username - User's username or email
-     * @param password - User's password
-     * @param deviceName - Optional device name
-     * @param deviceFingerprint - Optional device fingerprint
-     * @returns Login response with session data
-     */
-    secureLogin(username: string, password: string, deviceName?: string, deviceFingerprint?: any): Promise<SecureLoginResponse>;
-    /**
-     * Get full user data by session ID
-     * @param sessionId - The session ID
-     * @returns Full user data
-     */
-    getUserBySession(sessionId: string): Promise<User>;
-    /**
-     * Get access token by session ID (for API calls)
-     * @param sessionId - The session ID
-     * @returns Access token and expiry info
-     */
-    getTokenBySession(sessionId: string): Promise<{
-        accessToken: string;
-        expiresAt: string;
-    }>;
-    /**
-     * Get all active sessions for current user
-     * @param sessionId - Current session ID
-     * @returns Array of user sessions
-     */
-    getSessionsBySessionId(sessionId: string): Promise<any[]>;
-    /**
-     * Logout specific session
-     * @param sessionId - Current session ID
-     * @param targetSessionId - Optional target session to logout (defaults to current)
-     */
-    logoutSecureSession(sessionId: string, targetSessionId?: string): Promise<void>;
-    /**
-     * Logout all sessions for current user
-     * @param sessionId - Current session ID
-     */
-    logoutAllSecureSessions(sessionId: string): Promise<void>;
-    /**
-     * Validate session
-     * @param sessionId - The session ID to validate
-     * @returns Session validation status with user data
-     */
-    validateSession(sessionId: string): Promise<{
-        valid: boolean;
-        expiresAt: string;
-        lastActivity: string;
-        user: User;
-    }>;
-    /**
-     * Validate session using x-session-id header
-     * @param sessionId - The session ID to validate (sent as header)
-     * @param deviceFingerprint - Optional device fingerprint for enhanced security
-     * @returns Session validation status with user data
-     */
-    validateSessionFromHeader(sessionId: string, deviceFingerprint?: string): Promise<{
-        valid: boolean;
-        expiresAt: string;
-        lastActivity: string;
-        user: User;
-        sessionId?: string;
-    }>;
-    /**
-     * Validate session using automatic header detection
-     * The validateSession endpoint will automatically read from x-session-id header
-     * @param sessionId - The session ID to validate (sent as header)
-     * @param deviceFingerprint - Optional device fingerprint for enhanced security
-     * @returns Session validation status with user data
-     */
-    validateSessionAuto(sessionId: string, deviceFingerprint?: string): Promise<{
-        valid: boolean;
-        expiresAt: string;
-        lastActivity: string;
-        user: User;
-        source?: string;
-    }>;
-    /**
-     * Create authentication middleware for Express.js applications
-     * This is the recommended way to protect routes in server applications
-     * @returns Express middleware function
-     */
-    createAuthMiddleware(): (req: any, res: any, next: any) => Promise<any>;
-    /**
-     * Helper method for validating tokens without Express middleware
-     * Useful for standalone token validation in various contexts
-     * @param token - The access token to validate
-     * @returns Object with validation result and user information
-     */
-    authenticateToken(token: string): Promise<{
-        valid: boolean;
-        userId?: string;
-        user?: any;
-        error?: string;
-    }>;
-    /**
-     * Centralized error handling
-     * @private
-     * @param error - Error object from API call
-     * @returns Formatted API error
-     */
-    private handleError;
-    /**
-     * Check if a username is available
-     * @param username - The username to check
-     * @returns Promise with availability status
-     */
-    checkUsernameAvailability(username: string): Promise<{
-        available: boolean;
-        message: string;
-    }>;
-    /**
-     * Check if an email is available
-     * @param email - The email to check
-     * @returns Promise with availability status
-     */
-    checkEmailAvailability(email: string): Promise<{
-        available: boolean;
-        message: string;
-    }>;
-    /**
-     * Get user profile by username
-     * @param username - The username to look up
-     * @returns Promise with user profile
-     */
-    getUserProfileByUsername(username: string): Promise<User>;
-    /**
-     * Health check endpoint to verify API connectivity
-     * @returns Health status and basic server info
-     */
-    healthCheck(): Promise<{
-        status: string;
-        users?: number;
-        timestamp?: string;
-        [key: string]: any;
-    }>;
-    /**
-     * Download file content using authenticated request
-     * @param fileId - The file ID to download
-     * @returns Response object for further processing
-     */
-    downloadFileContent(fileId: string): Promise<Response>;
-    /**
-     * Get file content as text using authenticated request
-     * @param fileId - The file ID to get content for
-     * @returns File content as string
-     */
-    getFileContentAsText(fileId: string): Promise<string>;
-    /**
-     * Get file content as blob using authenticated request
-     * @param fileId - The file ID to get content for
-     * @returns File content as blob
-     */
-    getFileContentAsBlob(fileId: string): Promise<Blob>;
-    /**
-     * Fetch metadata for a URL (title, description, image)
-     * @param url - The URL to fetch metadata for
-     * @returns Promise with metadata object
-     */
-    fetchLinkMetadata(url: string): Promise<{
-        url: string;
-        title: string;
-        description: string;
-        image?: string;
-    }>;
-    /**
-     * Search for locations using the enhanced location search API
-     * @param query - Search query string
-     * @param limit - Maximum number of results (default: 5)
-     * @param countrycodes - Optional country codes filter (e.g., "us,ca")
-     * @returns Promise with array of location results
-     */
-    searchLocations(query: string, limit?: number, countrycodes?: string): Promise<any[]>;
-    /**
-     * Get detailed information about a specific location by coordinates
-     * @param lat - Latitude
-     * @param lon - Longitude
-     * @returns Promise with detailed location information
-     */
-    getLocationDetails(lat: number, lon: number): Promise<any>;
-    /**
-     * Find locations near a point using geospatial queries
-     * @param lat - Latitude
-     * @param lon - Longitude
-     * @param maxDistance - Maximum distance in meters (default: 10000)
-     * @param limit - Maximum number of results (default: 10)
-     * @param skip - Number of results to skip (default: 0)
-     * @returns Promise with nearby locations
-     */
-    findLocationsNear(lat: number, lon: number, maxDistance?: number, limit?: number, skip?: number): Promise<any>;
-    /**
-     * Search locations in database by text
-     * @param query - Search query
-     * @param limit - Maximum number of results (default: 10)
-     * @param skip - Number of results to skip (default: 0)
-     * @param type - Filter by location type
-     * @param country - Filter by country
-     * @param city - Filter by city
-     * @returns Promise with search results
-     */
-    searchLocationsInDB(query: string, limit?: number, skip?: number, type?: string, country?: string, city?: string): Promise<any>;
-    /**
-     * Get location statistics
-     * @returns Promise with location statistics
-     */
-    getLocationStats(): Promise<any>;
-    /**
-     * Get cache statistics
-     * @returns Promise with cache statistics
-     */
-    getLocationCacheStats(): Promise<any>;
-    /**
-     * Clear location cache
-     * @returns Promise with success status
-     */
-    clearLocationCache(): Promise<any>;
-    /**
-     * Get performance statistics
-     * @returns Promise with performance statistics
-     */
-    getLocationPerformanceStats(): Promise<any>;
-}
-export default OxyServices;
+export { OxyServicesMain as OxyServices } from './OxyServicesMain';
+export { AuthService } from './auth/AuthService';
+export { UserService } from './users/UserService';
+export { PaymentService } from './payments/PaymentService';
+export { KarmaService } from './karma/KarmaService';
+export { FileService } from './files/FileService';
+export { LocationService } from './locations/LocationService';
+export { AnalyticsService } from './analytics/AnalyticsService';
+export { DeviceService } from './devices/DeviceService';
+export { OxyServices as BaseOxyServices } from './OxyServices';
+export { OXY_CLOUD_URL } from './files/FileService';
 export * from '../models/interfaces';
-export * from '../models/secureSession';
-export type { AuthRequest, SimpleAuthRequest } from '../types/middleware';
-export declare const createAuthMiddleware: (oxyServices: OxyServices) => (req: any, res: any, next: any) => Promise<any>;
+export * from '../models/session';
+export { DeviceManager } from '../utils/deviceManager';
+export type { DeviceFingerprint, StoredDeviceInfo } from '../utils/deviceManager';
+import { OxyServicesMain } from './OxyServicesMain';
+export default OxyServicesMain;
 //# sourceMappingURL=index.d.ts.map