@tspvivek/baasix-sdk 0.1.0-alpha.1 → 0.1.0-alpha.3

package/dist/index.d.ts

@@ -22,7 +22,7 @@ interface NotificationsModuleConfig {
  * const { data } = await baasix.notifications.find();
  *
  * // Mark as seen
- * await baasix.notifications.markAsSeen('notification-id');
+ * await baasix.notifications.markAsSeen(['notification-id']);
  *
  * // Send notification (admin)
  * await baasix.notifications.send({
@@ -49,57 +49,47 @@ declare class NotificationsModule {
     find(params?: {
         limit?: number;
         page?: number;
-        seen?: boolean;
+        filter?: Record<string, unknown>;
     }): Promise<PaginatedResponse<Notification>>;
     /**
-     * Get a single notification by ID
-     */
-    findOne(id: string): Promise<Notification>;
-    /**
-     * Mark a notification as seen
+     * Get unread notification count
      *
      * @example
      * ```typescript
-     * await baasix.notifications.markAsSeen('notification-uuid');
+     * const count = await baasix.notifications.getUnreadCount();
      * ```
      */
-    markAsSeen(id: string): Promise<void>;
+    getUnreadCount(): Promise<number>;
     /**
-     * Mark multiple notifications as seen
+     * Mark notifications as seen
      *
      * @example
      * ```typescript
-     * await baasix.notifications.markManySeen(['id1', 'id2', 'id3']);
-     * ```
-     */
-    markManySeen(ids: string[]): Promise<void>;
-    /**
-     * Mark all notifications as seen
+     * // Mark specific notifications as seen
+     * await baasix.notifications.markAsSeen(['id1', 'id2']);
      *
-     * @example
-     * ```typescript
-     * await baasix.notifications.markAllSeen();
+     * // Mark all notifications as seen
+     * await baasix.notifications.markAsSeen();
      * ```
      */
-    markAllSeen(): Promise<void>;
+    markAsSeen(notificationIds?: string[]): Promise<{
+        count: number;
+    }>;
     /**
-     * Get unread notification count
+     * Delete notifications for the current user
      *
      * @example
      * ```typescript
-     * const count = await baasix.notifications.getUnreadCount();
-     * ```
-     */
-    getUnreadCount(): Promise<number>;
-    /**
-     * Delete a notification
+     * // Delete specific notifications
+     * await baasix.notifications.delete(['id1', 'id2']);
      *
-     * @example
-     * ```typescript
-     * await baasix.notifications.delete('notification-uuid');
+     * // Delete all notifications
+     * await baasix.notifications.delete();
      * ```
      */
-    delete(id: string): Promise<void>;
+    delete(notificationIds?: string[]): Promise<{
+        count: number;
+    }>;
     /**
      * Send a notification to users (requires admin permissions)
      *
@@ -114,7 +104,24 @@ declare class NotificationsModule {
      * });
      * ```
      */
-    send(data: SendNotificationData): Promise<void>;
+    send(data: SendNotificationData): Promise<{
+        notificationIds: string[];
+    }>;
+    /**
+     * Cleanup old notifications (requires admin permissions)
+     *
+     * @example
+     * ```typescript
+     * // Clean up notifications older than 30 days (default)
+     * await baasix.notifications.cleanup();
+     *
+     * // Clean up notifications older than 7 days
+     * await baasix.notifications.cleanup(7);
+     * ```
+     */
+    cleanup(days?: number): Promise<{
+        count: number;
+    }>;
 }
 
 interface PermissionsModuleConfig {
@@ -1178,23 +1185,60 @@ interface MigrationStatus {
 }
 interface Migration {
     id: string;
+    version: string;
     name: string;
+    type: string;
+    status: string;
     batch: number;
     migratedAt: string;
+    executionTime?: number;
 }
 interface PendingMigration {
+    version: string;
     name: string;
+    type: string;
     path?: string;
 }
-interface MigrationResult {
-    success: boolean;
-    migrationsRun: string[];
-    errors?: string[];
+interface MigrationRunOptions {
+    /** Run only a specific migration version */
+    version?: string;
+    /** Run migrations up to and including this version */
+    toVersion?: string;
+    /** Number of migrations to run */
+    step?: number;
+    /** Preview without executing */
+    dryRun?: boolean;
+}
+interface MigrationRunResult {
+    results: Array<{
+        version: string;
+        name: string;
+        status: "completed" | "failed";
+        error?: string;
+    }>;
+    summary: {
+        total: number;
+        completed: number;
+        failed: number;
+    };
 }
 interface RollbackResult {
-    success: boolean;
-    migrationsRolledBack: string[];
-    errors?: string[];
+    results: Array<{
+        version: string;
+        name: string;
+        status: string;
+    }>;
+    summary: {
+        total: number;
+    };
+}
+interface CreateMigrationOptions {
+    /** Migration type (system, schema, data, custom) */
+    type?: "system" | "schema" | "data" | "custom";
+    /** Migration description */
+    description?: string;
+    /** Custom version (auto-generated if not provided) */
+    version?: string;
 }
 /**
  * Migrations module for managing database schema migrations.
@@ -1225,14 +1269,21 @@ declare class MigrationsModule {
      */
     status(): Promise<MigrationStatus>;
     /**
-     * Get all completed migrations
+     * Get all migrations with optional filtering
      *
      * @example
      * ```typescript
+     * // Get all migrations
      * const migrations = await baasix.migrations.list();
+     *
+     * // Get completed migrations
+     * const completed = await baasix.migrations.list({ status: 'completed' });
      * ```
      */
-    list(): Promise<Migration[]>;
+    list(options?: {
+        status?: "pending" | "completed" | "failed";
+        type?: "system" | "schema" | "data" | "custom";
+    }): Promise<Migration[]>;
     /**
      * Get pending migrations
      *
@@ -1243,78 +1294,147 @@ declare class MigrationsModule {
      */
     pending(): Promise<PendingMigration[]>;
     /**
-     * Check if there are pending migrations
+     * Check if migrations are needed
      *
      * @example
      * ```typescript
-     * const needsMigration = await baasix.migrations.hasPending();
+     * const check = await baasix.migrations.check();
+     * if (check.hasPending) {
+     *   console.log('Migrations needed');
+     * }
      * ```
      */
-    hasPending(): Promise<boolean>;
+    check(): Promise<{
+        hasPending: boolean;
+        pendingCount: number;
+    }>;
     /**
-     * Get a specific migration by name
+     * Get a specific migration by version
      *
      * @example
      * ```typescript
-     * const migration = await baasix.migrations.get('20231201_create_users');
+     * const migration = await baasix.migrations.get('20231201000000');
      * ```
      */
-    get(name: string): Promise<Migration | null>;
+    get(version: string): Promise<Migration | null>;
     /**
      * Run pending migrations
      *
      * @example
      * ```typescript
+     * // Run all pending migrations
      * const result = await baasix.migrations.run();
-     * console.log(`Ran ${result.migrationsRun.length} migrations`);
+     *
+     * // Run with options
+     * const result = await baasix.migrations.run({
+     *   step: 1,  // Run only 1 migration
+     *   dryRun: true  // Preview without executing
+     * });
      * ```
      */
-    run(): Promise<MigrationResult>;
+    run(options?: MigrationRunOptions): Promise<MigrationRunResult>;
     /**
      * Rollback a specific migration
      *
      * @example
      * ```typescript
-     * const result = await baasix.migrations.rollback('20231201_create_users');
+     * const result = await baasix.migrations.rollback('20231201000000');
      * ```
      */
-    rollback(name: string): Promise<RollbackResult>;
+    rollback(version: string): Promise<RollbackResult>;
     /**
      * Rollback the last batch of migrations
      *
      * @example
      * ```typescript
-     * const result = await baasix.migrations.rollbackLast();
+     * const result = await baasix.migrations.rollbackBatch();
      * ```
      */
-    rollbackLast(): Promise<RollbackResult>;
+    rollbackBatch(): Promise<RollbackResult>;
     /**
      * Create a new migration file
      *
      * @example
      * ```typescript
-     * const migrationName = await baasix.migrations.create('add_status_column');
+     * const { filepath } = await baasix.migrations.create('add_status_column', {
+     *   type: 'schema',
+     *   description: 'Add status column to orders'
+     * });
+     * ```
+     */
+    create(name: string, options?: CreateMigrationOptions): Promise<{
+        filepath: string;
+    }>;
+    /**
+     * Mark a specific migration as completed without running it
+     * Useful for existing installations that already have the changes
+     *
+     * @example
+     * ```typescript
+     * await baasix.migrations.markCompleted('20231201000000');
+     * ```
+     */
+    markCompleted(version: string, metadata?: Record<string, unknown>): Promise<Migration>;
+    /**
+     * Mark all pending migrations as completed
+     * Useful for bringing an existing database up to date without running migrations
+     *
+     * @example
+     * ```typescript
+     * // Mark all pending
+     * await baasix.migrations.markAllCompleted();
+     *
+     * // Mark up to a specific version
+     * await baasix.migrations.markAllCompleted('20231201000000');
      * ```
      */
-    create(name: string): Promise<string>;
+    markAllCompleted(toVersion?: string): Promise<MigrationRunResult>;
+}
+
+interface ServerInfo {
+    project?: {
+        name?: string;
+        multitenant?: boolean | string;
+        [key: string]: unknown;
+    };
+    version?: string;
+    [key: string]: unknown;
+}
+interface ServerModuleConfig {
+    client: HttpClient;
+}
+/**
+ * Server module for retrieving server information.
+ *
+ * @example
+ * ```typescript
+ * const info = await baasix.server.info();
+ * console.log(info.project?.name);
+ * ```
+ */
+declare class ServerModule {
+    private client;
+    constructor(config: ServerModuleConfig);
     /**
-     * Mark a migration as complete (without running it)
+     * Get server information including project settings
      *
      * @example
      * ```typescript
-     * await baasix.migrations.markComplete('20231201_create_users');
+     * const info = await baasix.server.info();
+     * console.log('Project:', info.project?.name);
+     * console.log('Version:', info.version);
      * ```
      */
-    markComplete(name: string): Promise<void>;
+    info(): Promise<ServerInfo>;
     /**
-     * Mark all pending migrations as complete
+     * Check server health
      *
      * @example
      * ```typescript
-     * await baasix.migrations.markAllComplete();
+     * const isHealthy = await baasix.server.health();
      * ```
      */
-    markAllComplete(): Promise<void>;
+    health(): Promise<boolean>;
 }
 
 /**
@@ -1367,6 +1487,7 @@ declare class Baasix {
     readonly roles: RolesModule;
     readonly users: UsersModule;
     readonly migrations: MigrationsModule;
+    readonly server: ServerModule;
     private itemsModules;
     constructor(config: BaasixConfig);
     /**
@@ -1455,6 +1576,19 @@ declare class Baasix {
      * Clear the tenant
      */
     clearTenant(): Promise<void>;
+    /**
+     * Set a static token (convenience method that delegates to auth.setToken)
+     *
+     * @example
+     * ```typescript
+     * baasix.setToken('your-api-token');
+     * ```
+     */
+    setToken(token: string): Promise<void>;
+    /**
+     * Get the current auth token
+     */
+    getToken(): Promise<string | null>;
     /**
      * Get the base URL
      */
@@ -1495,4 +1629,4 @@ declare class Baasix {
  */
 declare function createBaasix(config: BaasixConfig): Baasix;
 
-export { Aggregate, AuthMode, AuthModule, Baasix, BaasixConfig, BaseItem, CreatePermissionData, type CreateRoleData, type CreateUserData, FilesModule, Filter, HttpClient, ItemsModule, type Migration, type MigrationResult, type MigrationStatus, MigrationsModule, Notification, NotificationsModule, PaginatedResponse, type PendingMigration, Permission, PermissionsModule, RealtimeChannel, type RealtimeConfig, RealtimeModule, ReportConfig, ReportResult, ReportsModule, type Role, RolesModule, type RollbackResult, SchemasModule, SendNotificationData, Settings, SettingsModule, StorageAdapter, type SubscriptionCallback, type SubscriptionEvent, type SubscriptionPayload, type UpdateUserData, type UserQueryOptions, UsersModule, Workflow, WorkflowExecution, type WorkflowExecutionUpdate, WorkflowsModule, createBaasix };
+export { Aggregate, AuthMode, AuthModule, Baasix, BaasixConfig, BaseItem, type CreateMigrationOptions, CreatePermissionData, type CreateRoleData, type CreateUserData, FilesModule, Filter, HttpClient, ItemsModule, type Migration, type MigrationRunOptions, type MigrationRunResult, type MigrationStatus, MigrationsModule, Notification, NotificationsModule, PaginatedResponse, type PendingMigration, Permission, PermissionsModule, RealtimeChannel, type RealtimeConfig, RealtimeModule, ReportConfig, ReportResult, ReportsModule, type Role, RolesModule, type RollbackResult, SchemasModule, SendNotificationData, Settings, SettingsModule, StorageAdapter, type SubscriptionCallback, type SubscriptionEvent, type SubscriptionPayload, type UpdateUserData, type UserQueryOptions, UsersModule, Workflow, WorkflowExecution, type WorkflowExecutionUpdate, WorkflowsModule, createBaasix };