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

package/README.md

@@ -451,15 +451,54 @@ await baasix.schemas.create({
         primaryKey: true,
         defaultValue: { type: 'UUIDV4' },
       },
+      sku: {
+        type: 'SUID',
+        unique: true,
+        defaultValue: { type: 'SUID' },
+      },
       name: {
         type: 'String',
         allowNull: false,
         values: { length: 255 },
+        validate: {
+          notEmpty: true,
+          len: [3, 255],
+        },
       },
       price: {
         type: 'Decimal',
         values: { precision: 10, scale: 2 },
         defaultValue: 0,
+        validate: {
+          min: 0,
+          max: 999999.99,
+        },
+      },
+      quantity: {
+        type: 'Integer',
+        defaultValue: 0,
+        validate: {
+          isInt: true,
+          min: 0,
+        },
+      },
+      email: {
+        type: 'String',
+        validate: {
+          isEmail: true,
+        },
+      },
+      website: {
+        type: 'String',
+        validate: {
+          isUrl: true,
+        },
+      },
+      slug: {
+        type: 'String',
+        validate: {
+          matches: '^[a-z0-9-]+$',
+        },
       },
       tags: {
         type: 'Array',
@@ -470,11 +509,51 @@ await baasix.schemas.create({
         type: 'JSONB',
         defaultValue: {},
       },
+      status: {
+        type: 'String',
+        defaultValue: 'draft',
+      },
+      isActive: {
+        type: 'Boolean',
+        defaultValue: true,
+      },
+      sortOrder: {
+        type: 'Integer',
+        defaultValue: { type: 'AUTOINCREMENT' },
+      },
+      publishedAt: {
+        type: 'DateTime',
+        defaultValue: { type: 'NOW' },
+      },
     },
   },
 });
 ```
 
+### Validation Rules
+
+| Rule | Type | Description |
+|------|------|-------------|
+| `min` | number | Minimum value for numeric fields |
+| `max` | number | Maximum value for numeric fields |
+| `isInt` | boolean | Validate as integer |
+| `notEmpty` | boolean | String must not be empty |
+| `isEmail` | boolean | Validate email format |
+| `isUrl` | boolean | Validate URL format |
+| `len` | [min, max] | String length range |
+| `is` / `matches` | string | Pattern matching with regex |
+
+### Default Value Types
+
+| Type | Description |
+|------|-------------|
+| `UUIDV4` | Random UUID v4 |
+| `SUID` | Short unique ID (compact, URL-safe) |
+| `NOW` | Current timestamp |
+| `AUTOINCREMENT` | Auto-incrementing integer |
+| `SQL` | Custom SQL expression |
+| Static | Any constant value (`"active"`, `false`, `0`) |
+
 ### Relationships
 
 ```typescript
@@ -507,27 +586,111 @@ await baasix.schemas.createIndex('products', {
 
 ## Reports & Analytics
 
+### Generate Report (POST)
+
+Use `generate()` to create a report with a POST request, sending the query in the request body:
+
 ```typescript
-// Generate report
 const report = await baasix.reports.generate('orders', {
   aggregate: {
     revenue: { function: 'sum', field: 'total' },
     orders: { function: 'count', field: 'id' },
   },
-  groupBy: 'category',
+  groupBy: ['category'],
   filter: { status: { eq: 'completed' } },
   dateRange: {
     start: '2025-01-01',
     end: '2025-12-31',
   },
 });
+```
+
+### Query Report (GET)
+
+Use `query()` to fetch a report with a GET request, sending parameters as query strings:
+
+```typescript
+const report = await baasix.reports.query('orders', {
+  aggregate: {
+    total: { function: 'sum', field: 'amount' },
+  },
+  groupBy: ['status'],
+  filter: { createdAt: { gte: '$NOW-DAYS_30' } },
+});
+```
+
+### Multi-Collection Stats
+
+Get statistics for multiple collections in a single request:
+
+```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' },
+      },
+    },
+  },
+  {
+    name: 'products_by_category',
+    collection: 'products',
+    query: {
+      groupBy: ['categoryId'],
+      aggregate: {
+        count: { function: 'count', field: 'id' },
+        avg_price: { function: 'avg', field: 'price' },
+      },
+      fields: ['categoryId', 'category.name'],
+    },
+  },
+]);
+// Returns: [{ name: 'total_products', collection: 'products', data: [...] }, ...]
+```
+
+### Aggregation Query
+
+Run aggregation queries directly on a collection (uses items endpoint):
+
+```typescript
+const results = await baasix.reports.aggregate('orders', {
+  aggregate: {
+    total: { function: 'sum', field: 'amount' },
+    count: { function: 'count', field: 'id' },
+    min: { function: 'min', field: 'amount' },
+    max: { function: 'max', field: 'amount' },
+    avg: { function: 'avg', field: 'amount' },
+  },
+  groupBy: ['status', 'paymentMethod'],
+  filter: { createdAt: { gte: '$NOW-DAYS_30' } },
+});
+```
+
+### Quick Count
 
-// Quick count
+```typescript
 const activeUsers = await baasix.reports.count('users', {
   status: { eq: 'active' },
 });
 ```
 
+### Distinct Values
+
+```typescript
+const categories = await baasix.reports.distinct('products', 'category');
+// Returns: ['Electronics', 'Clothing', 'Books', ...]
+```
+
 ## Workflows
 
 ```typescript

package/dist/{client-aXK_gEyr.d.cts → client-BeD1V4Xg.d.cts}

@@ -296,13 +296,49 @@ interface BulkResponse<T = string[]> {
         error: string;
     }>;
 }
-type FieldType = "String" | "Text" | "Integer" | "BigInt" | "Float" | "Double" | "Decimal" | "Boolean" | "Date" | "DateTime" | "Time" | "UUID" | "JSON" | "JSONB" | "Array" | "Geometry" | "Point" | "LineString" | "Polygon" | "Enum";
+type FieldType = "String" | "Text" | "Integer" | "BigInt" | "Float" | "Real" | "Double" | "Decimal" | "Boolean" | "Date" | "DateTime" | "Time" | "UUID" | "SUID" | "JSON" | "JSONB" | "Array" | "Geometry" | "Point" | "LineString" | "Polygon" | "Enum";
+/**
+ * Default value types supported by Baasix
+ */
+type DefaultValueType = {
+    type: "UUIDV4";
+} | {
+    type: "SUID";
+} | {
+    type: "NOW";
+} | {
+    type: "AUTOINCREMENT";
+} | {
+    type: "SQL";
+    value: string;
+} | {
+    type: "CURRENT_USER";
+} | {
+    type: "CURRENT_TENANT";
+};
 interface FieldDefinition {
     type: FieldType;
     primaryKey?: boolean;
     allowNull?: boolean;
     unique?: boolean;
-    defaultValue?: unknown;
+    /**
+     * Default value for the field
+     * Can be a static value or a dynamic type
+     * @example
+     * // Static values
+     * defaultValue: "active"
+     * defaultValue: 0
+     * defaultValue: false
+     * defaultValue: []
+     *
+     * // Dynamic types
+     * defaultValue: { type: "UUIDV4" }
+     * defaultValue: { type: "SUID" }
+     * defaultValue: { type: "NOW" }
+     * defaultValue: { type: "AUTOINCREMENT" }
+     * defaultValue: { type: "SQL", value: "CURRENT_DATE" }
+     */
+    defaultValue?: DefaultValueType | string | number | boolean | null | unknown[] | Record<string, unknown>;
     values?: {
         length?: number;
         precision?: number;
@@ -311,11 +347,25 @@ interface FieldDefinition {
         values?: string[];
     };
     validate?: {
+        /** Minimum value for numeric fields */
         min?: number;
+        /** Maximum value for numeric fields */
         max?: number;
-        len?: [number, number];
+        /** Validate as integer */
+        isInt?: boolean;
+        /** String must not be empty */
+        notEmpty?: boolean;
+        /** Validate email format */
         isEmail?: boolean;
+        /** Validate URL format */
         isUrl?: boolean;
+        /** String length range [min, max] */
+        len?: [number, number];
+        /** Pattern matching with regex (alias: matches) */
+        is?: string;
+        /** Pattern matching with regex (alias: is) */
+        matches?: string;
+        /** @deprecated Use 'is' or 'matches' instead */
         regex?: string;
     };
     comment?: string;
@@ -611,4 +661,4 @@ declare class HttpClient {
     }): Promise<T>;
 }
 
-export { type WorkflowTrigger as $, type AuthMode as A, type BaseItem as B, type CreatePermissionData as C, type DeleteResponse as D, type FilterValue as E, type Filter as F, type FilterCondition as G, HttpClient as H, type IndexDefinition as I, type LogicalFilter as J, type SortDirection as K, type LoginCredentials as L, type MagicLinkOptions as M, type Notification as N, type AggregateFunction as O, type PasswordResetOptions as P, type QueryParams as Q, type RegisterData as R, type Sort as S, type Tenant as T, type User as U, type AggregateConfig as V, type Workflow as W, type FieldType as X, type FieldDefinition as Y, type RelationshipType as Z, type PermissionAction as _, type AuthStateEvent as a, type WorkflowNode as a0, type WorkflowEdge as a1, type BaasixErrorDetails as a2, BaasixError as a3, type DeepPartial as a4, type CollectionItem as a5, type AuthResponse as b, type AuthTokens as c, type AuthState as d, type PaginatedResponse as e, type BulkResponse as f, type MutationResponse as g, type SingleResponse as h, type UploadOptions as i, type FileMetadata as j, type AssetTransformOptions as k, type SchemaInfo as l, type SchemaDefinition as m, type RelationshipDefinition as n, type SendNotificationData as o, type Permission as p, type Role as q, type Settings as r, type ReportConfig as s, type ReportResult as t, type Aggregate as u, type WorkflowExecution as v, type BaasixConfig as w, type RequestOptions as x, type HttpClientConfig as y, type FilterOperator as z };
+export { type PermissionAction as $, type AuthMode as A, type BaseItem as B, type CreatePermissionData as C, type DeleteResponse as D, type FilterValue as E, type Filter as F, type FilterCondition as G, HttpClient as H, type IndexDefinition as I, type LogicalFilter as J, type SortDirection as K, type LoginCredentials as L, type MagicLinkOptions as M, type Notification as N, type AggregateFunction as O, type PasswordResetOptions as P, type QueryParams as Q, type RegisterData as R, type Sort as S, type Tenant as T, type User as U, type AggregateConfig as V, type Workflow as W, type FieldType as X, type DefaultValueType as Y, type FieldDefinition as Z, type RelationshipType as _, type AuthStateEvent as a, type WorkflowTrigger as a0, type WorkflowNode as a1, type WorkflowEdge as a2, type BaasixErrorDetails as a3, BaasixError as a4, type DeepPartial as a5, type CollectionItem as a6, type AuthResponse as b, type AuthTokens as c, type AuthState as d, type PaginatedResponse as e, type BulkResponse as f, type MutationResponse as g, type SingleResponse as h, type UploadOptions as i, type FileMetadata as j, type AssetTransformOptions as k, type SchemaInfo as l, type SchemaDefinition as m, type RelationshipDefinition as n, type SendNotificationData as o, type Permission as p, type Role as q, type Settings as r, type ReportConfig as s, type ReportResult as t, type Aggregate as u, type WorkflowExecution as v, type BaasixConfig as w, type RequestOptions as x, type HttpClientConfig as y, type FilterOperator as z };

package/dist/{client-CzF9B60b.d.ts → client-C7qJEINh.d.ts}

@@ -296,13 +296,49 @@ interface BulkResponse<T = string[]> {
         error: string;
     }>;
 }
-type FieldType = "String" | "Text" | "Integer" | "BigInt" | "Float" | "Double" | "Decimal" | "Boolean" | "Date" | "DateTime" | "Time" | "UUID" | "JSON" | "JSONB" | "Array" | "Geometry" | "Point" | "LineString" | "Polygon" | "Enum";
+type FieldType = "String" | "Text" | "Integer" | "BigInt" | "Float" | "Real" | "Double" | "Decimal" | "Boolean" | "Date" | "DateTime" | "Time" | "UUID" | "SUID" | "JSON" | "JSONB" | "Array" | "Geometry" | "Point" | "LineString" | "Polygon" | "Enum";
+/**
+ * Default value types supported by Baasix
+ */
+type DefaultValueType = {
+    type: "UUIDV4";
+} | {
+    type: "SUID";
+} | {
+    type: "NOW";
+} | {
+    type: "AUTOINCREMENT";
+} | {
+    type: "SQL";
+    value: string;
+} | {
+    type: "CURRENT_USER";
+} | {
+    type: "CURRENT_TENANT";
+};
 interface FieldDefinition {
     type: FieldType;
     primaryKey?: boolean;
     allowNull?: boolean;
     unique?: boolean;
-    defaultValue?: unknown;
+    /**
+     * Default value for the field
+     * Can be a static value or a dynamic type
+     * @example
+     * // Static values
+     * defaultValue: "active"
+     * defaultValue: 0
+     * defaultValue: false
+     * defaultValue: []
+     *
+     * // Dynamic types
+     * defaultValue: { type: "UUIDV4" }
+     * defaultValue: { type: "SUID" }
+     * defaultValue: { type: "NOW" }
+     * defaultValue: { type: "AUTOINCREMENT" }
+     * defaultValue: { type: "SQL", value: "CURRENT_DATE" }
+     */
+    defaultValue?: DefaultValueType | string | number | boolean | null | unknown[] | Record<string, unknown>;
     values?: {
         length?: number;
         precision?: number;
@@ -311,11 +347,25 @@ interface FieldDefinition {
         values?: string[];
     };
     validate?: {
+        /** Minimum value for numeric fields */
         min?: number;
+        /** Maximum value for numeric fields */
         max?: number;
-        len?: [number, number];
+        /** Validate as integer */
+        isInt?: boolean;
+        /** String must not be empty */
+        notEmpty?: boolean;
+        /** Validate email format */
         isEmail?: boolean;
+        /** Validate URL format */
         isUrl?: boolean;
+        /** String length range [min, max] */
+        len?: [number, number];
+        /** Pattern matching with regex (alias: matches) */
+        is?: string;
+        /** Pattern matching with regex (alias: is) */
+        matches?: string;
+        /** @deprecated Use 'is' or 'matches' instead */
         regex?: string;
     };
     comment?: string;
@@ -611,4 +661,4 @@ declare class HttpClient {
     }): Promise<T>;
 }
 
-export { type WorkflowTrigger as $, type AuthMode as A, type BaseItem as B, type CreatePermissionData as C, type DeleteResponse as D, type FilterValue as E, type Filter as F, type FilterCondition as G, HttpClient as H, type IndexDefinition as I, type LogicalFilter as J, type SortDirection as K, type LoginCredentials as L, type MagicLinkOptions as M, type Notification as N, type AggregateFunction as O, type PasswordResetOptions as P, type QueryParams as Q, type RegisterData as R, type Sort as S, type Tenant as T, type User as U, type AggregateConfig as V, type Workflow as W, type FieldType as X, type FieldDefinition as Y, type RelationshipType as Z, type PermissionAction as _, type AuthStateEvent as a, type WorkflowNode as a0, type WorkflowEdge as a1, type BaasixErrorDetails as a2, BaasixError as a3, type DeepPartial as a4, type CollectionItem as a5, type AuthResponse as b, type AuthTokens as c, type AuthState as d, type PaginatedResponse as e, type BulkResponse as f, type MutationResponse as g, type SingleResponse as h, type UploadOptions as i, type FileMetadata as j, type AssetTransformOptions as k, type SchemaInfo as l, type SchemaDefinition as m, type RelationshipDefinition as n, type SendNotificationData as o, type Permission as p, type Role as q, type Settings as r, type ReportConfig as s, type ReportResult as t, type Aggregate as u, type WorkflowExecution as v, type BaasixConfig as w, type RequestOptions as x, type HttpClientConfig as y, type FilterOperator as z };
+export { type PermissionAction as $, type AuthMode as A, type BaseItem as B, type CreatePermissionData as C, type DeleteResponse as D, type FilterValue as E, type Filter as F, type FilterCondition as G, HttpClient as H, type IndexDefinition as I, type LogicalFilter as J, type SortDirection as K, type LoginCredentials as L, type MagicLinkOptions as M, type Notification as N, type AggregateFunction as O, type PasswordResetOptions as P, type QueryParams as Q, type RegisterData as R, type Sort as S, type Tenant as T, type User as U, type AggregateConfig as V, type Workflow as W, type FieldType as X, type DefaultValueType as Y, type FieldDefinition as Z, type RelationshipType as _, type AuthStateEvent as a, type WorkflowTrigger as a0, type WorkflowNode as a1, type WorkflowEdge as a2, type BaasixErrorDetails as a3, BaasixError as a4, type DeepPartial as a5, type CollectionItem as a6, type AuthResponse as b, type AuthTokens as c, type AuthState as d, type PaginatedResponse as e, type BulkResponse as f, type MutationResponse as g, type SingleResponse as h, type UploadOptions as i, type FileMetadata as j, type AssetTransformOptions as k, type SchemaInfo as l, type SchemaDefinition as m, type RelationshipDefinition as n, type SendNotificationData as o, type Permission as p, type Role as q, type Settings as r, type ReportConfig as s, type ReportResult as t, type Aggregate as u, type WorkflowExecution as v, type BaasixConfig as w, type RequestOptions as x, type HttpClientConfig as y, type FilterOperator as z };

package/dist/index.cjs

@@ -1082,35 +1082,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;
@@ -1418,12 +1389,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
     });
   }
   /**
@@ -1839,12 +1806,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
     });
   }
   /**
@@ -2013,6 +1976,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;
@@ -2658,7 +2650,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
@@ -2668,7 +2660,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'
@@ -2684,19 +2676,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