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

package/dist/index.d.cts

@@ -341,6 +341,30 @@ declare class SettingsModule {
 interface ReportsModuleConfig {
     client: HttpClient;
 }
+/**
+ * Stats query for the stats endpoint
+ */
+interface StatsQuery {
+    /** Unique name for this stats query */
+    name: string;
+    /** Collection to query */
+    collection: string;
+    /** Query parameters including aggregate, groupBy, filter, fields */
+    query: {
+        aggregate?: Aggregate;
+        groupBy?: string[];
+        filter?: Filter;
+        fields?: string[];
+    };
+}
+/**
+ * Stats result from a single query
+ */
+interface StatsResult {
+    name: string;
+    collection: string;
+    data: Record<string, unknown>[];
+}
 /**
  * Reports module for generating analytics and reports.
  *
@@ -367,7 +391,7 @@ declare class ReportsModule {
     private client;
     constructor(config: ReportsModuleConfig);
     /**
-     * Generate a report for a collection
+     * Generate a report for a collection using POST method
      *
      * @example
      * ```typescript
@@ -377,7 +401,7 @@ declare class ReportsModule {
      *     revenue: { function: 'sum', field: 'total' },
      *     orders: { function: 'count', field: 'id' }
      *   },
-     *   groupBy: 'month',
+     *   groupBy: ['month'],
      *   dateRange: {
      *     start: '2025-01-01',
      *     end: '2025-12-31'
@@ -387,22 +411,51 @@ declare class ReportsModule {
      */
     generate(collection: string, config: Omit<ReportConfig, "collection">): Promise<ReportResult>;
     /**
-     * Get collection statistics
+     * Query a report for a collection using GET method with query params
      *
      * @example
      * ```typescript
-     * const stats = await baasix.reports.getStats('products');
-     * console.log(stats.totalCount, stats.recentCount);
+     * const report = await baasix.reports.query('orders', {
+     *   aggregate: {
+     *     total: { function: 'sum', field: 'amount' }
+     *   },
+     *   groupBy: ['status']
+     * });
      * ```
      */
-    getStats(collection: string, options?: {
-        timeframe?: "24h" | "7d" | "30d" | "90d" | "1y";
-    }): Promise<{
-        totalCount: number;
-        recentCount: number;
-        deletedCount?: number;
-        byDate?: Record<string, number>;
-    }>;
+    query(collection: string, params?: {
+        aggregate?: Aggregate;
+        groupBy?: string[];
+        filter?: Filter;
+        fields?: string[];
+    }): Promise<ReportResult>;
+    /**
+     * Get statistics for multiple collections in a single request
+     *
+     * @example
+     * ```typescript
+     * const stats = await baasix.reports.getStats([
+     *   {
+     *     name: 'total_products',
+     *     collection: 'products',
+     *     query: {
+     *       aggregate: { count: { function: 'count', field: '*' } }
+     *     }
+     *   },
+     *   {
+     *     name: 'total_orders',
+     *     collection: 'orders',
+     *     query: {
+     *       aggregate: {
+     *         count: { function: 'count', field: '*' },
+     *         total_amount: { function: 'sum', field: 'amount' }
+     *       }
+     *     }
+     *   }
+     * ]);
+     * ```
+     */
+    getStats(stats: StatsQuery[]): Promise<StatsResult[]>;
     /**
      * Generate an aggregation query
      *
@@ -1629,4 +1682,4 @@ declare class Baasix {
  */
 declare function createBaasix(config: BaasixConfig): Baasix;
 
-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 };
+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, type StatsQuery, type StatsResult, StorageAdapter, type SubscriptionCallback, type SubscriptionEvent, type SubscriptionPayload, type UpdateUserData, type UserQueryOptions, UsersModule, Workflow, WorkflowExecution, type WorkflowExecutionUpdate, WorkflowsModule, createBaasix };

package/dist/index.d.ts

@@ -341,6 +341,30 @@ declare class SettingsModule {
 interface ReportsModuleConfig {
     client: HttpClient;
 }
+/**
+ * Stats query for the stats endpoint
+ */
+interface StatsQuery {
+    /** Unique name for this stats query */
+    name: string;
+    /** Collection to query */
+    collection: string;
+    /** Query parameters including aggregate, groupBy, filter, fields */
+    query: {
+        aggregate?: Aggregate;
+        groupBy?: string[];
+        filter?: Filter;
+        fields?: string[];
+    };
+}
+/**
+ * Stats result from a single query
+ */
+interface StatsResult {
+    name: string;
+    collection: string;
+    data: Record<string, unknown>[];
+}
 /**
  * Reports module for generating analytics and reports.
  *
@@ -367,7 +391,7 @@ declare class ReportsModule {
     private client;
     constructor(config: ReportsModuleConfig);
     /**
-     * Generate a report for a collection
+     * Generate a report for a collection using POST method
      *
      * @example
      * ```typescript
@@ -377,7 +401,7 @@ declare class ReportsModule {
      *     revenue: { function: 'sum', field: 'total' },
      *     orders: { function: 'count', field: 'id' }
      *   },
-     *   groupBy: 'month',
+     *   groupBy: ['month'],
      *   dateRange: {
      *     start: '2025-01-01',
      *     end: '2025-12-31'
@@ -387,22 +411,51 @@ declare class ReportsModule {
      */
     generate(collection: string, config: Omit<ReportConfig, "collection">): Promise<ReportResult>;
     /**
-     * Get collection statistics
+     * Query a report for a collection using GET method with query params
      *
      * @example
      * ```typescript
-     * const stats = await baasix.reports.getStats('products');
-     * console.log(stats.totalCount, stats.recentCount);
+     * const report = await baasix.reports.query('orders', {
+     *   aggregate: {
+     *     total: { function: 'sum', field: 'amount' }
+     *   },
+     *   groupBy: ['status']
+     * });
      * ```
      */
-    getStats(collection: string, options?: {
-        timeframe?: "24h" | "7d" | "30d" | "90d" | "1y";
-    }): Promise<{
-        totalCount: number;
-        recentCount: number;
-        deletedCount?: number;
-        byDate?: Record<string, number>;
-    }>;
+    query(collection: string, params?: {
+        aggregate?: Aggregate;
+        groupBy?: string[];
+        filter?: Filter;
+        fields?: string[];
+    }): Promise<ReportResult>;
+    /**
+     * Get statistics for multiple collections in a single request
+     *
+     * @example
+     * ```typescript
+     * const stats = await baasix.reports.getStats([
+     *   {
+     *     name: 'total_products',
+     *     collection: 'products',
+     *     query: {
+     *       aggregate: { count: { function: 'count', field: '*' } }
+     *     }
+     *   },
+     *   {
+     *     name: 'total_orders',
+     *     collection: 'orders',
+     *     query: {
+     *       aggregate: {
+     *         count: { function: 'count', field: '*' },
+     *         total_amount: { function: 'sum', field: 'amount' }
+     *       }
+     *     }
+     *   }
+     * ]);
+     * ```
+     */
+    getStats(stats: StatsQuery[]): Promise<StatsResult[]>;
     /**
      * Generate an aggregation query
      *
@@ -1629,4 +1682,4 @@ declare class Baasix {
  */
 declare function createBaasix(config: BaasixConfig): Baasix;
 
-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 };
+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, type StatsQuery, type StatsResult, StorageAdapter, type SubscriptionCallback, type SubscriptionEvent, type SubscriptionPayload, type UpdateUserData, type UserQueryOptions, UsersModule, Workflow, WorkflowExecution, type WorkflowExecutionUpdate, WorkflowsModule, createBaasix };

package/dist/index.js

@@ -1080,35 +1080,6 @@ var AuthModule = class {
   }
 };
 
-// src/utils/sort.ts
-function normalizeSort(sort) {
-  if (!sort) return void 0;
-  if (typeof sort === "string") {
-    return sort;
-  }
-  if (Array.isArray(sort)) {
-    if (sort.length === 0) return void 0;
-    if (typeof sort[0] === "object" && "column" in sort[0]) {
-      return sort.map((s) => `${s.column}:${s.order.toLowerCase()}`).join(",");
-    }
-    return sort.map((s) => {
-      if (s.startsWith("-")) {
-        return `${s.substring(1)}:desc`;
-      }
-      if (s.includes(":")) {
-        return s;
-      }
-      return `${s}:asc`;
-    }).join(",");
-  }
-  if (typeof sort === "object") {
-    const entries = Object.entries(sort);
-    if (entries.length === 0) return void 0;
-    return entries.map(([field, direction]) => `${field}:${direction.toLowerCase()}`).join(",");
-  }
-  return void 0;
-}
-
 // src/modules/items.ts
 var QueryBuilder = class {
   collection;
@@ -1416,12 +1387,8 @@ var ItemsModule = class {
    * ```
    */
   async find(params) {
-    const normalizedParams = params ? {
-      ...params,
-      sort: normalizeSort(params.sort)
-    } : void 0;
     return this.client.get(`/items/${this.collection}`, {
-      params: normalizedParams
+      params
     });
   }
   /**
@@ -1837,12 +1804,8 @@ var FilesModule = class {
    * ```
    */
   async find(params) {
-    const normalizedParams = params ? {
-      ...params,
-      sort: normalizeSort(params.sort)
-    } : void 0;
     return this.client.get("/files", {
-      params: normalizedParams
+      params
     });
   }
   /**
@@ -2011,6 +1974,35 @@ var FilesModule = class {
   }
 };
 
+// src/utils/sort.ts
+function normalizeSort(sort) {
+  if (!sort) return void 0;
+  if (typeof sort === "string") {
+    return sort;
+  }
+  if (Array.isArray(sort)) {
+    if (sort.length === 0) return void 0;
+    if (typeof sort[0] === "object" && "column" in sort[0]) {
+      return sort.map((s) => `${s.column}:${s.order.toLowerCase()}`).join(",");
+    }
+    return sort.map((s) => {
+      if (s.startsWith("-")) {
+        return `${s.substring(1)}:desc`;
+      }
+      if (s.includes(":")) {
+        return s;
+      }
+      return `${s}:asc`;
+    }).join(",");
+  }
+  if (typeof sort === "object") {
+    const entries = Object.entries(sort);
+    if (entries.length === 0) return void 0;
+    return entries.map(([field, direction]) => `${field}:${direction.toLowerCase()}`).join(",");
+  }
+  return void 0;
+}
+
 // src/modules/schemas.ts
 var SchemasModule = class {
   client;
@@ -2656,7 +2648,7 @@ var ReportsModule = class {
     this.client = config.client;
   }
   /**
-   * Generate a report for a collection
+   * Generate a report for a collection using POST method
    *
    * @example
    * ```typescript
@@ -2666,7 +2658,7 @@ var ReportsModule = class {
    *     revenue: { function: 'sum', field: 'total' },
    *     orders: { function: 'count', field: 'id' }
    *   },
-   *   groupBy: 'month',
+   *   groupBy: ['month'],
    *   dateRange: {
    *     start: '2025-01-01',
    *     end: '2025-12-31'
@@ -2682,19 +2674,56 @@ var ReportsModule = class {
     return response;
   }
   /**
-   * Get collection statistics
+   * Query a report for a collection using GET method with query params
+   *
+   * @example
+   * ```typescript
+   * const report = await baasix.reports.query('orders', {
+   *   aggregate: {
+   *     total: { function: 'sum', field: 'amount' }
+   *   },
+   *   groupBy: ['status']
+   * });
+   * ```
+   */
+  async query(collection, params) {
+    const response = await this.client.get(
+      `/reports/${collection}`,
+      { params }
+    );
+    return response;
+  }
+  /**
+   * Get statistics for multiple collections in a single request
    *
    * @example
    * ```typescript
-   * const stats = await baasix.reports.getStats('products');
-   * console.log(stats.totalCount, stats.recentCount);
+   * const stats = await baasix.reports.getStats([
+   *   {
+   *     name: 'total_products',
+   *     collection: 'products',
+   *     query: {
+   *       aggregate: { count: { function: 'count', field: '*' } }
+   *     }
+   *   },
+   *   {
+   *     name: 'total_orders',
+   *     collection: 'orders',
+   *     query: {
+   *       aggregate: {
+   *         count: { function: 'count', field: '*' },
+   *         total_amount: { function: 'sum', field: 'amount' }
+   *       }
+   *     }
+   *   }
+   * ]);
    * ```
    */
-  async getStats(collection, options) {
-    const response = await this.client.get(`/reports/${collection}/stats`, {
-      params: options
+  async getStats(stats) {
+    const response = await this.client.post(`/reports/stats`, {
+      stats
     });
-    return response.data;
+    return response;
   }
   /**
    * Generate an aggregation query