cocobase 1.1.3 → 1.2.0

package/dist/cjs/core/core.d.ts

@@ -1,5 +1,35 @@
-import { CocobaseConfig, Document, AppUser, Query, Connection } from "../types/types";
+import { CocobaseConfig, Document, AppUser, Query, AppUserList, GoogleLoginResponse, Connection, AggregateResults, AggregateParams } from "../types/types";
 import { CloudFunction } from "./functions";
+/**
+ * Main Cocobase client for interacting with the Cocobase backend API.
+ *
+ * Provides methods for:
+ * - Document CRUD operations (Create, Read, Update, Delete)
+ * - User authentication and management
+ * - File uploads
+ * - Real-time data synchronization
+ * - Cloud functions execution
+ * - Batch operations
+ * - Advanced querying and aggregations
+ *
+ * @example
+ * ```typescript
+ * // Initialize the client
+ * const db = new Cocobase({
+ *   apiKey: 'your-api-key',
+ *   projectId: 'your-project-id'
+ * });
+ *
+ * // Create a document
+ * await db.createDocument('users', { name: 'John Doe' });
+ *
+ * // Query documents
+ * const users = await db.listDocuments('users', {
+ *   filters: { status: 'active' },
+ *   limit: 10
+ * });
+ * ```
+ */
 export declare class Cocobase {
     private baseURL;
     apiKey?: string;
@@ -7,11 +37,63 @@ export declare class Cocobase {
     projectId?: string;
     user?: AppUser;
     functions: CloudFunction;
+    /**
+     * Creates a new Cocobase client instance.
+     *
+     * @param config - Configuration object for the client
+     * @param config.apiKey - Your Cocobase API key (required for most operations)
+     * @param config.projectId - Your Cocobase project ID (required for cloud functions)
+     * @param config.baseURL - Optional custom base URL (defaults to https://api.cocobase.buzz)
+     *
+     * @example
+     * ```typescript
+     * const db = new Cocobase({
+     *   apiKey: 'your-api-key',
+     *   projectId: 'your-project-id'
+     * });
+     * ```
+     */
     constructor(config: CocobaseConfig);
+    /**
+     * Gets the current authentication token.
+     *
+     * @returns The current JWT token, or undefined if not authenticated
+     */
     getToken(): string | undefined;
     private request;
     private getErrorSuggestion;
+    /**
+     * Retrieves a single document by ID from a collection.
+     *
+     * @template T - The type of the document data
+     * @param collection - Name of the collection
+     * @param docId - Unique ID of the document
+     * @returns Promise resolving to the document with metadata
+     *
+     * @example
+     * ```typescript
+     * const user = await db.getDocument('users', 'user-123');
+     * console.log(user.data.name);
+     * ```
+     */
     getDocument<T = any>(collection: string, docId: string): Promise<Document<T>>;
+    /**
+     * Creates a new document in a collection.
+     *
+     * @template T - The type of the document data
+     * @param collection - Name of the collection
+     * @param data - Document data to store
+     * @returns Promise resolving to the created document with metadata
+     *
+     * @example
+     * ```typescript
+     * const newUser = await db.createDocument('users', {
+     *   name: 'John Doe',
+     *   email: 'john@example.com',
+     *   age: 30
+     * });
+     * ```
+     */
     createDocument<T = any>(collection: string, data: T): Promise<Document<T>>;
     /**
      * Create a document with file uploads
@@ -42,6 +124,23 @@ export declare class Cocobase {
      * ```
      */
     createDocumentWithFiles<T = any>(collection: string, data: T, files: Record<string, File | File[]>): Promise<Document<T>>;
+    /**
+     * Updates an existing document in a collection.
+     *
+     * @template T - The type of the document data
+     * @param collection - Name of the collection
+     * @param docId - Unique ID of the document to update
+     * @param data - Partial document data to update (only specified fields are updated)
+     * @returns Promise resolving to the updated document with metadata
+     *
+     * @example
+     * ```typescript
+     * await db.updateDocument('users', 'user-123', {
+     *   age: 31,
+     *   status: 'active'
+     * });
+     * ```
+     */
     updateDocument<T = any>(collection: string, docId: string, data: Partial<T>): Promise<Document<T>>;
     /**
      * Update a document with file uploads
@@ -67,14 +166,125 @@ export declare class Cocobase {
      * ```
      */
     updateDocumentWithFiles<T = any>(collection: string, docId: string, data?: Partial<T>, files?: Record<string, File | File[]>): Promise<Document<T>>;
+    /**
+     * Deletes a document from a collection.
+     *
+     * @param collection - Name of the collection
+     * @param docId - Unique ID of the document to delete
+     * @returns Promise resolving to a success status object
+     *
+     * @example
+     * ```typescript
+     * await db.deleteDocument('users', 'user-123');
+     * ```
+     */
     deleteDocument(collection: string, docId: string): Promise<{
         success: boolean;
     }>;
+    /**
+     * Lists documents from a collection with optional filtering and pagination.
+     *
+     * @template T - The type of the document data
+     * @param collection - Name of the collection
+     * @param query - Optional query parameters for filtering, sorting, and pagination
+     * @returns Promise resolving to an array of documents
+     *
+     * @example
+     * ```typescript
+     * // Simple query
+     * const users = await db.listDocuments('users', {
+     *   filters: { status: 'active' },
+     *   limit: 10
+     * });
+     *
+     * // Advanced query with sorting
+     * const posts = await db.listDocuments('posts', {
+     *   filters: { published: true },
+     *   sort: 'createdAt',
+     *   order: 'desc',
+     *   limit: 20
+     * });
+     * ```
+     */
     listDocuments<T = any>(collection: string, query?: Query): Promise<Document<T>[]>;
+    /**
+     * Initializes authentication by restoring the session from local storage.
+     * Call this method when your application loads to restore user sessions.
+     *
+     * @example
+     * ```typescript
+     * await db.initAuth();
+     * if (db.isAuthenticated()) {
+     *   console.log('User is logged in:', db.user);
+     * }
+     * ```
+     */
     initAuth(): Promise<void>;
+    /**
+     * Sets the authentication token and stores it in local storage.
+     *
+     * @param token - JWT authentication token
+     */
     setToken(token: string): void;
+    /**
+     * Authenticates a user with email and password.
+     *
+     * @param email - User's email address
+     * @param password - User's password
+     * @returns Promise that resolves when login is complete
+     *
+     * @example
+     * ```typescript
+     * await db.login('user@example.com', 'password123');
+     * console.log('Logged in as:', db.user.email);
+     * ```
+     */
     login(email: string, password: string): Promise<void>;
+    /**
+     * Registers a new user with email, password, and optional additional data.
+     *
+     * @param email - User's email address
+     * @param password - User's password
+     * @param data - Optional additional user data
+     * @returns Promise that resolves when registration is complete
+     *
+     * @example
+     * ```typescript
+     * await db.register('user@example.com', 'password123', {
+     *   username: 'johndoe',
+     *   fullName: 'John Doe'
+     * });
+     * ```
+     */
     register(email: string, password: string, data?: Record<string, any>): Promise<void>;
+    /**
+     * Initiates Google OAuth login flow.
+     *
+     * @returns Promise resolving to an object with the Google OAuth URL
+     *
+     * @example
+     * ```typescript
+     * const { url } = await db.loginWithGoogle();
+     * window.location.href = url; // Redirect to Google login
+     * ```
+     */
+    loginWithGoogle(): Promise<GoogleLoginResponse>;
+    /**
+     * Completes the Google OAuth login flow after redirect.
+     *
+     * @param token - JWT token received from OAuth callback
+     * @returns Promise that resolves when login is complete
+     *
+     * @example
+     * ```typescript
+     * // After Google redirects back to your app with a token
+     * const token = new URLSearchParams(window.location.search).get('token');
+     * if (token) {
+     *   await db.completeGoogleLogin(token);
+     * }
+     * ```
+     */
+    completeGoogleLogin(token: string): Promise<void>;
     /**
      * Register a new user with file uploads (avatar, cover photo, etc.)
      *
@@ -146,5 +356,32 @@ export declare class Cocobase {
     }) => void, connectionName?: string, onOpen?: () => void, onError?: () => void): Connection;
     hasRole(role: string): boolean;
     closeConnection(name: string): void;
+    listUsers<T = any>(query?: Query): Promise<AppUserList>;
+    getUserById<T = any>(userId: string): Promise<AppUser>;
+    deleteDocuments(collection: string, docIds: string[]): Promise<{
+        status: string;
+        message: string;
+        count: number;
+    }>;
+    createDocuments<T = any>(collection: string, documents: T[]): Promise<Document<T>[]>;
+    /**
+     * Batch update documents
+     *
+     * @param collection - Collection name
+     * @param updates - Object mapping document IDs to partial update objects.
+     *   Example: { "docId1": { fieldA: "value" }, "docId2": { fieldB: 2 } }
+     */
+    updateDocuments<T = any>(collection: string, updates: Record<string, Partial<T>>): Promise<Document<T>[]>;
+    /**
+     * Count documents matching filters without returning the documents.
+     *
+     * Example:
+     *  await db.countDocuments('users', { status: 'active', age_gte: 18 })
+     *  // returns { count: 42 }
+     */
+    countDocuments(collection: string, query?: Query): Promise<{
+        count: number;
+    }>;
+    aggregateDocuments(collection: string, params: AggregateParams): Promise<AggregateResults>;
 }
 //# sourceMappingURL=core.d.ts.map

package/dist/cjs/core/core.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../../src/core/core.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,QAAQ,EAER,OAAO,EACP,KAAK,EACL,UAAU,EACX,MAAM,gBAAgB,CAAC;AAUxB,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,qBAAa,QAAQ;IACnB,OAAO,CAAC,OAAO,CAAS;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,KAAK,CAAC,CAAS;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,SAAS,EAAE,aAAa,CAAC;gBAEb,MAAM,EAAE,cAAc;IAWlC,QAAQ,IAAI,MAAM,GAAG,SAAS;YAIhB,OAAO;IAoDrB,OAAO,CAAC,kBAAkB;IAkBpB,WAAW,CAAC,CAAC,GAAG,GAAG,EACvB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAQjB,cAAc,CAAC,CAAC,GAAG,GAAG,EAC1B,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,CAAC,GACN,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAQvB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,uBAAuB,CAAC,CAAC,GAAG,GAAG,EACnC,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,GAAG,IAAI,EAAE,CAAC,GACnC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAsCjB,cAAc,CAAC,CAAC,GAAG,GAAG,EAC1B,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,GACf,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAQvB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,uBAAuB,CAAC,CAAC,GAAG,GAAG,EACnC,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EACjB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,GAAG,IAAI,EAAE,CAAC,GACpC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAwCjB,cAAc,CAClB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IAQ1B,aAAa,CAAC,CAAC,GAAG,GAAG,EACzB,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,KAAK,GACZ,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IAUnB,QAAQ;IAgBd,QAAQ,CAAC,KAAK,EAAE,MAAM;IAKhB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAYrC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAY1E;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,iBAAiB,CACrB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC1B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,GAAG,IAAI,EAAE,CAAC,GACpC,OAAO,CAAC,OAAO,CAAC;IA0CnB,MAAM;IAGN,eAAe,IAAI,OAAO;IAGpB,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC;IAalC,UAAU,CACd,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,EACjC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,EACrB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GACvB,OAAO,CAAC,OAAO,CAAC;IAuBnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,mBAAmB,CACvB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,EACjC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,EACrB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,EACxB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,GAAG,IAAI,EAAE,CAAC,GACpC,OAAO,CAAC,OAAO,CAAC;IAoDnB,eAAe,CACb,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,CAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAA;KAAE,KAAK,IAAI,EACjE,cAAc,CAAC,EAAE,MAAM,EACvB,MAAM,GAAE,MAAM,IAAe,EAC7B,OAAO,GAAE,MAAM,IAAe,GAC7B,UAAU;IAiCb,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAM9B,eAAe,CAAC,IAAI,EAAE,MAAM;CAG7B"}
+{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../../src/core/core.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,QAAQ,EAER,OAAO,EACP,KAAK,EACL,WAAW,EACX,mBAAmB,EACnB,UAAU,EACV,gBAAgB,EAChB,eAAe,EAChB,MAAM,gBAAgB,CAAC;AASxB,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,OAAO,CAAS;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,KAAK,CAAC,CAAS;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,SAAS,EAAE,aAAa,CAAC;IAEzB;;;;;;;;;;;;;;;OAeG;gBACS,MAAM,EAAE,cAAc;IAWlC;;;;OAIG;IACH,QAAQ,IAAI,MAAM,GAAG,SAAS;YAIhB,OAAO;IAoDrB,OAAO,CAAC,kBAAkB;IAiB1B;;;;;;;;;;;;;OAaG;IACG,WAAW,CAAC,CAAC,GAAG,GAAG,EACvB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAOvB;;;;;;;;;;;;;;;;OAgBG;IACG,cAAc,CAAC,CAAC,GAAG,GAAG,EAC1B,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,CAAC,GACN,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAQvB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,uBAAuB,CAAC,CAAC,GAAG,GAAG,EACnC,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,GAAG,IAAI,EAAE,CAAC,GACnC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAqCvB;;;;;;;;;;;;;;;;OAgBG;IACG,cAAc,CAAC,CAAC,GAAG,GAAG,EAC1B,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,GACf,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAQvB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,uBAAuB,CAAC,CAAC,GAAG,GAAG,EACnC,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EACjB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,GAAG,IAAI,EAAE,CAAC,GACpC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAuCvB;;;;;;;;;;;OAWG;IACG,cAAc,CAClB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IAOhC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,aAAa,CAAC,CAAC,GAAG,GAAG,EACzB,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,KAAK,GACZ,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IASzB;;;;;;;;;;;OAWG;IACG,QAAQ;IAgBd;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM;IAKtB;;;;;;;;;;;;OAYG;IACG,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAY3C;;;;;;;;;;;;;;;OAeG;IACG,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAY1E;;;;;;;;;;OAUG;IACG,eAAe;IAOrB;;;;;;;;;;;;;;OAcG;IACG,mBAAmB,CAAC,KAAK,EAAE,MAAM;IAKvC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,iBAAiB,CACrB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC1B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,GAAG,IAAI,EAAE,CAAC,GACpC,OAAO,CAAC,OAAO,CAAC;IA0CnB,MAAM;IAGN,eAAe,IAAI,OAAO;IAGpB,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC;IAalC,UAAU,CACd,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,EACjC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,EACrB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GACvB,OAAO,CAAC,OAAO,CAAC;IAuBnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,mBAAmB,CACvB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,EACjC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,EACrB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,EACxB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,GAAG,IAAI,EAAE,CAAC,GACpC,OAAO,CAAC,OAAO,CAAC;IAoDnB,eAAe,CACb,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,CAAC,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAA;KAAE,KAAK,IAAI,EACjE,cAAc,CAAC,EAAE,MAAM,EACvB,MAAM,GAAE,MAAM,IAAe,EAC7B,OAAO,GAAE,MAAM,IAAe,GAC7B,UAAU;IAiCb,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAM9B,eAAe,CAAC,IAAI,EAAE,MAAM;IAK5B,SAAS,CAAC,CAAC,GAAG,GAAG,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC;IASvD,WAAW,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAKhD,eAAe,CACnB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EAAE,GACf,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IASxD,eAAe,CAAC,CAAC,GAAG,GAAG,EAC3B,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,CAAC,EAAE,GACb,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IAQzB;;;;;;OAMG;IACG,eAAe,CAAC,CAAC,GAAG,GAAG,EAC3B,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,GAClC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IAQzB;;;;;;OAMG;IACG,cAAc,CAClB,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,KAAK,GACZ,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAUvB,kBAAkB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAC,eAAe,GAAE,OAAO,CAAC,gBAAgB,CAAC;CAS/F"}

package/dist/cjs/core/core.js

@@ -4,13 +4,64 @@ exports.Cocobase = void 0;
 const utils_1 = require("../utils/utils");
 const socket_1 = require("../utils/socket");
 const functions_1 = require("./functions");
+/**
+ * Main Cocobase client for interacting with the Cocobase backend API.
+ *
+ * Provides methods for:
+ * - Document CRUD operations (Create, Read, Update, Delete)
+ * - User authentication and management
+ * - File uploads
+ * - Real-time data synchronization
+ * - Cloud functions execution
+ * - Batch operations
+ * - Advanced querying and aggregations
+ *
+ * @example
+ * ```typescript
+ * // Initialize the client
+ * const db = new Cocobase({
+ *   apiKey: 'your-api-key',
+ *   projectId: 'your-project-id'
+ * });
+ *
+ * // Create a document
+ * await db.createDocument('users', { name: 'John Doe' });
+ *
+ * // Query documents
+ * const users = await db.listDocuments('users', {
+ *   filters: { status: 'active' },
+ *   limit: 10
+ * });
+ * ```
+ */
 class Cocobase {
+    /**
+     * Creates a new Cocobase client instance.
+     *
+     * @param config - Configuration object for the client
+     * @param config.apiKey - Your Cocobase API key (required for most operations)
+     * @param config.projectId - Your Cocobase project ID (required for cloud functions)
+     * @param config.baseURL - Optional custom base URL (defaults to https://api.cocobase.buzz)
+     *
+     * @example
+     * ```typescript
+     * const db = new Cocobase({
+     *   apiKey: 'your-api-key',
+     *   projectId: 'your-project-id'
+     * });
+     * ```
+     */
     constructor(config) {
         this.baseURL = config.baseURL ?? utils_1.BASEURL;
         this.apiKey = config.apiKey;
         this.projectId = config.projectId;
         this.functions = new functions_1.CloudFunction(config.projectId || "project id required", () => this.token);
     }
+    /**
+     * Gets the current authentication token.
+     *
+     * @returns The current JWT token, or undefined if not authenticated
+     */
     getToken() {
         return this.token;
     }
@@ -70,11 +121,40 @@ class Cocobase {
                 return "Check the API documentation and verify your request format";
         }
     }
-    // Fetch a single document
+    /**
+     * Retrieves a single document by ID from a collection.
+     *
+     * @template T - The type of the document data
+     * @param collection - Name of the collection
+     * @param docId - Unique ID of the document
+     * @returns Promise resolving to the document with metadata
+     *
+     * @example
+     * ```typescript
+     * const user = await db.getDocument('users', 'user-123');
+     * console.log(user.data.name);
+     * ```
+     */
     async getDocument(collection, docId) {
         return this.request("GET", `/collections/${collection}/documents/${docId}`);
     }
-    // Create a new document
+    /**
+     * Creates a new document in a collection.
+     *
+     * @template T - The type of the document data
+     * @param collection - Name of the collection
+     * @param data - Document data to store
+     * @returns Promise resolving to the created document with metadata
+     *
+     * @example
+     * ```typescript
+     * const newUser = await db.createDocument('users', {
+     *   name: 'John Doe',
+     *   email: 'john@example.com',
+     *   age: 30
+     * });
+     * ```
+     */
     async createDocument(collection, data) {
         return this.request("POST", `/collections/documents?collection=${collection}`, data);
     }
@@ -138,7 +218,23 @@ class Cocobase {
         }
         return res.json();
     }
-    // Update a document
+    /**
+     * Updates an existing document in a collection.
+     *
+     * @template T - The type of the document data
+     * @param collection - Name of the collection
+     * @param docId - Unique ID of the document to update
+     * @param data - Partial document data to update (only specified fields are updated)
+     * @returns Promise resolving to the updated document with metadata
+     *
+     * @example
+     * ```typescript
+     * await db.updateDocument('users', 'user-123', {
+     *   age: 31,
+     *   status: 'active'
+     * });
+     * ```
+     */
     async updateDocument(collection, docId, data) {
         return this.request("PATCH", `/collections/${collection}/documents/${docId}`, data);
     }
@@ -199,16 +295,62 @@ class Cocobase {
         }
         return res.json();
     }
-    // Delete a document
+    /**
+     * Deletes a document from a collection.
+     *
+     * @param collection - Name of the collection
+     * @param docId - Unique ID of the document to delete
+     * @returns Promise resolving to a success status object
+     *
+     * @example
+     * ```typescript
+     * await db.deleteDocument('users', 'user-123');
+     * ```
+     */
     async deleteDocument(collection, docId) {
         return this.request("DELETE", `/collections/${collection}/documents/${docId}`);
     }
-    // List documents
+    /**
+     * Lists documents from a collection with optional filtering and pagination.
+     *
+     * @template T - The type of the document data
+     * @param collection - Name of the collection
+     * @param query - Optional query parameters for filtering, sorting, and pagination
+     * @returns Promise resolving to an array of documents
+     *
+     * @example
+     * ```typescript
+     * // Simple query
+     * const users = await db.listDocuments('users', {
+     *   filters: { status: 'active' },
+     *   limit: 10
+     * });
+     *
+     * // Advanced query with sorting
+     * const posts = await db.listDocuments('posts', {
+     *   filters: { published: true },
+     *   sort: 'createdAt',
+     *   order: 'desc',
+     *   limit: 20
+     * });
+     * ```
+     */
     async listDocuments(collection, query) {
         const query_str = (0, utils_1.buildFilterQuery)(query);
         return this.request("GET", `/collections/${collection}/documents${query_str ? `?${query_str}` : ""}`);
     }
-    // authentication features
+    /**
+     * Initializes authentication by restoring the session from local storage.
+     * Call this method when your application loads to restore user sessions.
+     *
+     * @example
+     * ```typescript
+     * await db.initAuth();
+     * if (db.isAuthenticated()) {
+     *   console.log('User is logged in:', db.user);
+     * }
+     * ```
+     */
     async initAuth() {
         const token = (0, utils_1.getFromLocalStorage)("cocobase-token");
         const user = (0, utils_1.getFromLocalStorage)("cocobase-user");
@@ -226,17 +368,51 @@ class Cocobase {
             this.token = undefined;
         }
     }
+    /**
+     * Sets the authentication token and stores it in local storage.
+     *
+     * @param token - JWT authentication token
+     */
     setToken(token) {
         this.token = token;
         (0, utils_1.setToLocalStorage)("cocobase-token", token);
     }
+    /**
+     * Authenticates a user with email and password.
+     *
+     * @param email - User's email address
+     * @param password - User's password
+     * @returns Promise that resolves when login is complete
+     *
+     * @example
+     * ```typescript
+     * await db.login('user@example.com', 'password123');
+     * console.log('Logged in as:', db.user.email);
+     * ```
+     */
     async login(email, password) {
         const response = this.request(`POST`, `/auth-collections/login`, { email, password }, false // Do not use data key for auth endpoints
         );
         this.token = (await response).access_token;
         this.setToken(this.token);
-        this.user = await this.getCurrentUser();
+        await this.getCurrentUser();
     }
+    /**
+     * Registers a new user with email, password, and optional additional data.
+     *
+     * @param email - User's email address
+     * @param password - User's password
+     * @param data - Optional additional user data
+     * @returns Promise that resolves when registration is complete
+     *
+     * @example
+     * ```typescript
+     * await db.register('user@example.com', 'password123', {
+     *   username: 'johndoe',
+     *   fullName: 'John Doe'
+     * });
+     * ```
+     */
     async register(email, password, data) {
         const response = this.request(`POST`, `/auth-collections/signup`, { email, password, data }, false // Do not use data key for auth endpoints
         );
@@ -244,6 +420,39 @@ class Cocobase {
         this.setToken(this.token);
         await this.getCurrentUser();
     }
+    /**
+     * Initiates Google OAuth login flow.
+     *
+     * @returns Promise resolving to an object with the Google OAuth URL
+     *
+     * @example
+     * ```typescript
+     * const { url } = await db.loginWithGoogle();
+     * window.location.href = url; // Redirect to Google login
+     * ```
+     */
+    async loginWithGoogle() {
+        return (await this.request(`GET`, "/auth-collections/login-google"));
+    }
+    /**
+     * Completes the Google OAuth login flow after redirect.
+     *
+     * @param token - JWT token received from OAuth callback
+     * @returns Promise that resolves when login is complete
+     *
+     * @example
+     * ```typescript
+     * // After Google redirects back to your app with a token
+     * const token = new URLSearchParams(window.location.search).get('token');
+     * if (token) {
+     *   await db.completeGoogleLogin(token);
+     * }
+     * ```
+     */
+    async completeGoogleLogin(token) {
+        this.setToken(token);
+        await this.getCurrentUser();
+    }
     /**
      * Register a new user with file uploads (avatar, cover photo, etc.)
      *
@@ -458,6 +667,46 @@ class Cocobase {
     closeConnection(name) {
         (0, socket_1.closeConnection)(name);
     }
+    // AUTH COLLECTION ROUTES
+    listUsers(query) {
+        const query_str = (0, utils_1.buildFilterQuery)(query);
+        return this.request("GET", `/auth-collections/users${query_str ? `?${query_str}` : ""}`);
+    }
+    getUserById(userId) {
+        return this.request("GET", `/auth-collections/users/${userId}`);
+    }
+    // BATCH OPERATIONS
+    async deleteDocuments(collection, docIds) {
+        return this.request("POST", `/collections/${collection}/batch/documents/delete`, { document_ids: docIds }, false);
+    }
+    async createDocuments(collection, documents) {
+        return this.request("POST", `/collections/${collection}/batch/documents/create`, { documents }, false);
+    }
+    /**
+     * Batch update documents
+     *
+     * @param collection - Collection name
+     * @param updates - Object mapping document IDs to partial update objects.
+     *   Example: { "docId1": { fieldA: "value" }, "docId2": { fieldB: 2 } }
+     */
+    async updateDocuments(collection, updates) {
+        return this.request("POST", `/collections/${collection}/batch/documents/update`, { updates }, false);
+    }
+    /**
+     * Count documents matching filters without returning the documents.
+     *
+     * Example:
+     *  await db.countDocuments('users', { status: 'active', age_gte: 18 })
+     *  // returns { count: 42 }
+     */
+    async countDocuments(collection, query) {
+        const query_str = (0, utils_1.buildFilterQuery)(query);
+        return this.request("GET", `/collections/${collection}/query/documents/count${query_str ? `?${query_str}` : ""}`);
+    }
+    async aggregateDocuments(collection, params) {
+        const query_str = (0, utils_1.buildFilterQuery)(params.query);
+        return (await this.request("GET", `/collections/${collection}/query/documents/aggregate?field=${params.field}&operation=${params.operation}&${query_str ? `${query_str}` : ""}`));
+    }
 }
 exports.Cocobase = Cocobase;
 //# sourceMappingURL=core.js.map