@syntropix/database 0.0.2 → 0.0.4

package/src/types/common.ts

@@ -1,83 +1,83 @@
-// Common types used across the SDK
-
-export enum ForeignKeyAction {
-  CASCADE = 'Cascade',
-  RESTRICT = 'Restrict',
-  SET_NULL = 'SetNull',
-  NO_ACTION = 'NoAction',
-  SET_DEFAULT = 'SetDefault',
-}
-
-export enum AggregateFunction {
-  COUNT = 'Count',
-  SUM = 'Sum',
-  AVG = 'AVG',
-  MIN = 'Min',
-  MAX = 'Max',
-  COUNT_DISTINCT = 'CountDistinct',
-}
-
-export interface Sort {
-  column: string;
-  direction: 'ASCENDING' | 'DESCENDING';
-}
-
-export interface Join {
-  type: 'INNER' | 'LEFT' | 'RIGHT' | 'FULL';
-  table: string;
-  on: any;
-}
-
-export interface Aggregate {
-  column: string;
-  function: AggregateFunction;
-  alias: string;
-}
-
-export interface GroupBy {
-  columns: string[];
-}
-
-export interface ForeignKey {
-  from_table: string;
-  from_column: string;
-  to_table: string;
-  to_column: string;
-  on_delete?: ForeignKeyAction;
-  on_update?: ForeignKeyAction;
-}
-
-export interface Column {
-  name: string;
-  column_type: string | Record<string, any>;
-  description?: string;
-  is_primary_key?: boolean;
-  is_nullable?: boolean;
-  auto_increment?: boolean;
-  default?: any;
-}
-
-export interface Index {
-  name: string;
-  columns: string[];
-  unique?: boolean;
-}
-
-export interface SyntropixDBColumn {
-  id: string; // UUID as string in TypeScript
-  name: string;
-  description: string;
-  column_type: string | Record<string, any>;
-  is_nullable: boolean;
-  is_primary_key: boolean;
-  auto_increment: boolean;
-  default?: any; // Optional field
-}
-
-export interface SyntropixDBTable {
-  id: string; // UUID as string in TypeScript
-  name: string;
-  description: string;
-  created_at: Date;
-  columns: SyntropixDBColumn[];
-}
+// Common types used across the SDK
+
+export enum ForeignKeyAction {
+  CASCADE = 'Cascade',
+  RESTRICT = 'Restrict',
+  SET_NULL = 'SetNull',
+  NO_ACTION = 'NoAction',
+  SET_DEFAULT = 'SetDefault',
+}
+
+export enum AggregateFunction {
+  COUNT = 'Count',
+  SUM = 'Sum',
+  AVG = 'AVG',
+  MIN = 'Min',
+  MAX = 'Max',
+  COUNT_DISTINCT = 'CountDistinct',
+}
+
+export interface Sort {
+  column: string;
+  direction: 'ASCENDING' | 'DESCENDING';
+}
+
+export interface Join {
+  type: 'INNER' | 'LEFT' | 'RIGHT' | 'FULL';
+  table: string;
+  on: any;
+}
+
+export interface Aggregate {
+  column: string;
+  function: AggregateFunction;
+  alias: string;
+}
+
+export interface GroupBy {
+  columns: string[];
+}
+
+export interface ForeignKey {
+  from_table: string;
+  from_column: string;
+  to_table: string;
+  to_column: string;
+  on_delete?: ForeignKeyAction;
+  on_update?: ForeignKeyAction;
+}
+
+export interface Column {
+  name: string;
+  column_type: string | Record<string, any>;
+  description?: string;
+  is_primary_key?: boolean;
+  is_nullable?: boolean;
+  auto_increment?: boolean;
+  default?: any;
+}
+
+export interface Index {
+  name: string;
+  columns: string[];
+  unique?: boolean;
+}
+
+export interface SyntropixDBColumn {
+  id: string; // UUID as string in TypeScript
+  name: string;
+  description: string;
+  column_type: string | Record<string, any>;
+  is_nullable: boolean;
+  is_primary_key: boolean;
+  auto_increment: boolean;
+  default?: any; // Optional field
+}
+
+export interface SyntropixDBTable {
+  id: string; // UUID as string in TypeScript
+  name: string;
+  description: string;
+  created_at: Date;
+  columns: SyntropixDBColumn[];
+}

package/src/types/dto/base.ts

@@ -0,0 +1,4 @@
+export interface ApiResponse<T> {
+  status: string;
+  data: T;
+}

package/src/types/dto/table.ts

@@ -0,0 +1,21 @@
+import { Column, ForeignKey, Index } from '../common';
+
+export interface TableCreateResponse {
+  _id: { $oid: string };
+  table: {
+    id: string;
+    name: string;
+    description: string;
+    created_at: any;
+    columns: Column[];
+    foreign_keys: ForeignKey[];
+    indexes: Index[];
+    schema: string;
+    default_access: string | null;
+  };
+  created_at: any;
+  updated_at: any;
+  created_by: string;
+  metadata: Record<string, any>;
+  triggers: any[];
+}

package/src/types/filter.ts

@@ -1,5 +1,4 @@
 // Filter types for database queries
-
 export enum SortType {
   DESCENDING = 'DESCENDING',
   ASCENDING = 'ASCENDING',
@@ -20,9 +19,13 @@ export enum FilterOperation {
   NEQ = 'NEQ',
   Between = 'Between',
   In = 'In',
+  Contains = 'Contains',
+  Overlap = 'Overlap',
   NotIn = 'NotIn',
   Like = 'Like',
   NotLike = 'NotLike',
+  ILike = 'ILike',
+  NotILike = 'NotILike',
   IsNull = 'IsNull',
   IsNotNull = 'IsNotNull',
   Similarity = 'Similarity',
@@ -99,6 +102,30 @@ export const IN = (field: string, values: any[]): SyntropixDBFilterItem => ({
   static_value: values,
 });
 
+export const CONTAINS = (field: string, value: any): SyntropixDBFilterItem => ({
+  column: field,
+  operator: FilterOperation.Contains,
+  static_value: value,
+});
+
+export const OVERLAP = (field: string, value: any): SyntropixDBFilterItem => ({
+  column: field,
+  operator: FilterOperation.Overlap,
+  static_value: value,
+});
+
+export const I_LIKE = (field: string, pattern: string): SyntropixDBFilterItem => ({
+  column: field,
+  operator: FilterOperation.ILike,
+  static_value: pattern,
+});
+
+export const NOT_I_LIKE = (field: string, pattern: string): SyntropixDBFilterItem => ({
+  column: field,
+  operator: FilterOperation.NotILike,
+  static_value: pattern,
+});
+
 export const NOT_IN = (field: string, values: any[]): SyntropixDBFilterItem => ({
   column: field,
   operator: FilterOperation.NotIn,

package/src/types/requests.ts

@@ -1,6 +1,6 @@
 // Request types for database operations
 import { Aggregate, Column, ForeignKey, GroupBy, Index, Join, Sort } from './common';
-import { Filter, SortType, SyntropixDBFilter } from './filter';
+import { Filter } from './filter';
 
 // Table operations
 export interface TableCreate {
@@ -76,7 +76,7 @@ export interface DeleteData {
 
 export interface QueryPayload {
   filter?: Filter;
-  sort?: Sort;
+  sort?: Sort[];
   aggregate?: Aggregate[];
   join?: Join[];
   limit?: number;
@@ -89,53 +89,3 @@ export interface Query {
   table_name: string;
   query: QueryPayload;
 }
-
-// Rust-compatible type definitions
-export interface SyntropixDBSortItem {
-  column: string;
-  direction: SortType;
-}
-
-export type SyntropixDBSort = SyntropixDBSortItem[];
-
-export interface SyntropixDBJoin {
-  table: string;
-  on: string;
-}
-
-export interface SyntropixDBAggregate {
-  function: string;
-  column: string;
-  alias: string;
-}
-
-export type SyntropixDBGroupBy = string[];
-
-export type SyntropixDBDistinct = string[];
-
-export interface SyntropixDBQuery {
-  filter: SyntropixDBFilter;
-  sort?: SyntropixDBSort;
-  limit?: number;
-  offset?: number;
-  select?: string[];
-  join?: SyntropixDBJoin[];
-  aggregate?: SyntropixDBAggregate[];
-  group_by?: SyntropixDBGroupBy;
-  distinct?: SyntropixDBDistinct;
-}
-
-export interface SyntropixDBInsert {
-  columns: string[];
-  values: any[][];
-}
-
-export interface SyntropixDBUpdate {
-  filter: SyntropixDBFilter;
-  columns: string[];
-  values: any[];
-}
-
-export interface SyntropixDBDelete {
-  filter: SyntropixDBFilter;
-}

package/tests/basic.test.ts

@@ -1,57 +1,73 @@
-// Jest tests for BaseModel ORM
 import { BaseModel, Column } from '@/types/basemodel';
 import { AND, EQ, OR } from '@/types/filter';
+
 import 'dotenv/config';
 
-// User model for testing
+const getRandomString = () => {
+  return Math.random().toString(36).substring(2, 15);
+};
+
 class User extends BaseModel {
-  static tableName = 'users';
+  static tableName = `test_users_${getRandomString()}`;
+
+  @Column({ type: 'Integer', primary: true, auto_increment: true })
+  declare id: number;
+
+  @Column()
+  declare email: string;
+
+  @Column({ name: 'full_name' })
+  declare fullName: string;
 
-  @Column({ type: 'Integer', primary: true, auto_increment: true }) id!: number;
-  @Column() email!: string;
-  @Column({ name: 'full_name' }) fullName!: string;
-  @Column({ type: 'Json', nullable: true }) profile?: any;
-  @Column({ type: 'Boolean', name: 'is_active' }) isActive!: boolean;
+  @Column({ type: 'Json', nullable: true })
+  declare profile: any;
+
+  @Column({ type: 'Boolean', name: 'is_active' })
+  declare isActive: boolean;
 }
 
 describe('BaseModel ORM', () => {
   beforeAll(async () => {
-    // Create table before running tests
     await User.createTable();
   });
 
   describe('User CRUD Operations', () => {
-    let createdUser: User;
-
-    test('should create a new user', async () => {
-      createdUser = await User.create({
-        id: 1,
-        email: 'user@example.com',
-        fullName: 'John Doe',
+    let userId: number;
+    let userEmail: string;
+    let userFullName: string;
+
+    test('should create a user', async () => {
+      const randomValue = getRandomString();
+      userEmail = `user${randomValue}@example.com`;
+      userFullName = `User ${randomValue}`;
+      const userCreateResp = await User.create({
+        email: userEmail,
+        fullName: userFullName,
         isActive: true,
       });
 
-      expect(createdUser).toBeDefined();
-      expect(createdUser.email).toBe('user@example.com');
-      expect(createdUser.fullName).toBe('John Doe');
-      expect(createdUser.isActive).toBe(true);
+      expect(userCreateResp).toBeDefined();
+      expect(userCreateResp.pk).toBeDefined();
+      userId = userCreateResp.pk;
     });
 
-    test('should retrieve a user by email', async () => {
-      const user = await User.get(OR(AND(EQ('email', 'user@example.com'))));
-
+    test('should retrieve the created user by id', async () => {
+      const user = await User.get(OR(AND(EQ('id', userId))));
       expect(user).toBeDefined();
-      expect(user.email).toBe('user@example.com');
-      expect(user.fullName).toBe('John Doe');
+      expect(user.email).toBe(userEmail);
+      expect(user.fullName).toBe(userFullName);
+      expect(user.isActive).toBe(true);
+      expect(user.profile).toBeNull();
     });
 
     test('should update a user', async () => {
-      const user = await User.get(OR(AND(EQ('email', 'user@example.com'))));
-      user.fullName = 'Jane Doe';
+      const user = await User.get(OR(AND(EQ('id', userId))));
+      userFullName = `User ${getRandomString()}`;
+      user.fullName = userFullName;
       await user.save();
 
-      const updatedUser = await User.get(OR(AND(EQ('email', 'user@example.com'))));
-      expect(updatedUser.fullName).toBe('Jane Doe');
+      const updatedUser = await User.get(OR(AND(EQ('id', userId))));
+      expect(updatedUser.fullName).toBe(userFullName);
     });
 
     test('should filter users by active status', async () => {
@@ -78,11 +94,11 @@ describe('BaseModel ORM', () => {
     });
 
     test('should delete a user', async () => {
-      const user = await User.get(OR(AND(EQ('email', 'user@example.com'))));
+      const user = await User.get(OR(AND(EQ('id', userId))));
       await user.remove();
 
       // Verify user is deleted (this might throw or return null depending on implementation)
-      await expect(User.get(OR(AND(EQ('email', 'user@example.com'))))).rejects.toThrow();
+      await expect(User.get(OR(AND(EQ('id', userId))))).rejects.toThrow();
     });
   });
 
@@ -90,13 +106,11 @@ describe('BaseModel ORM', () => {
     test('should bulk create multiple users', async () => {
       const users = await User.bulkCreate([
         {
-          id: 2,
           email: 'user2@example.com',
           fullName: 'User 2',
           isActive: true,
         },
         {
-          id: 3,
           email: 'user3@example.com',
           fullName: 'User 3',
           isActive: false,
@@ -104,7 +118,7 @@ describe('BaseModel ORM', () => {
       ]);
 
       expect(users).toBeDefined();
-      expect(Array.isArray(users)).toBe(true);
+      expect(users).toBe(2);
     });
 
     test('should retrieve bulk created users', async () => {
@@ -120,4 +134,8 @@ describe('BaseModel ORM', () => {
       expect(user3.isActive).toBe(false);
     });
   });
+
+  afterAll(async () => {
+    await User.dropTable();
+  });
 });

package/tests/tsconfig.json

@@ -0,0 +1,8 @@
+// This file is used to let VSCode respect the tsconfig.json for this test folder
+{
+  "extends": "../tsconfig.json",
+  "include": [".", "../src"],
+  "compilerOptions": {
+    "noEmit": true
+  }
+}

package/tsconfig.json

@@ -1,21 +1,18 @@
-{
-  "extends": "./tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "declaration": true
-  },
-  "include": [
-    "src"
-  ],
-  "exclude": [
-    "tests",
-    "examples",
-    "dist",
-    "node_modules"
-  ],
-  "references": [
-    {
-      "path": "./tsconfig.test.json"
-    }
-  ]
-}
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "esModuleInterop": true,
+    "strict": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["src/*"]
+    },
+    "outDir": "dist",
+    "declaration": true
+  },
+  "include": ["src"]
+}

package/examples/advanced-usage.d.ts

@@ -1,42 +0,0 @@
-import 'dotenv/config';
-import { BaseModel } from '../src/types/basemodel';
-export declare class CompanyGroup extends BaseModel {
-    static tableName: string;
-    static description: string;
-    id: number;
-    name: string;
-    description: string;
-}
-export declare class CompanyGroupMember extends BaseModel {
-    static tableName: string;
-    static description: string;
-    id: number;
-    groupId: number;
-    memberId: number;
-}
-export declare class CompanyMember extends BaseModel {
-    static tableName: string;
-    static description: string;
-    id: number;
-    userId: string;
-    firstName: string;
-    lastName: string;
-    middleName: string | null;
-    email: string;
-    avatar: string | null;
-    bio: string;
-    role: 'admin' | 'user';
-    personalKey: string;
-}
-export declare class CompanyApiKey extends BaseModel {
-    static tableName: string;
-    static description: string;
-    id: number;
-    name: string;
-    description: string | null;
-    key: string;
-    createdAt: Date | string;
-    isPersonal: boolean;
-    createdBy: number;
-}
-//# sourceMappingURL=advanced-usage.d.ts.map

package/examples/advanced-usage.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"advanced-usage.d.ts","sourceRoot":"","sources":["advanced-usage.ts"],"names":[],"mappings":"AAAA,OAAO,eAAe,CAAC;AAGvB,OAAO,EAAE,SAAS,EAAsB,MAAM,wBAAwB,CAAC;AAGvE,qBAAa,YAAa,SAAQ,SAAS;IACzC,MAAM,CAAC,SAAS,SAA8B;IAC9C,MAAM,CAAC,WAAW,SAAoB;IAQtC,EAAE,EAAG,MAAM,CAAC;IAGZ,IAAI,EAAG,MAAM,CAAC;IAGd,WAAW,EAAG,MAAM,CAAC;CACtB;AAED,qBAAa,kBAAmB,SAAQ,SAAS;IAC/C,MAAM,CAAC,SAAS,SAAqC;IACrD,MAAM,CAAC,WAAW,SAA2B;IAQ7C,EAAE,EAAG,MAAM,CAAC;IAGZ,OAAO,EAAG,MAAM,CAAC;IAGjB,QAAQ,EAAG,MAAM,CAAC;CACnB;AAED,qBAAa,aAAc,SAAQ,SAAS;IAC1C,MAAM,CAAC,SAAS,SAA+B;IAC/C,MAAM,CAAC,WAAW,SAAqB;IAQvC,EAAE,EAAG,MAAM,CAAC;IAQZ,MAAM,EAAG,MAAM,CAAC;IAQhB,SAAS,EAAG,MAAM,CAAC;IAOnB,QAAQ,EAAG,MAAM,CAAC;IAOlB,UAAU,EAAG,MAAM,GAAG,IAAI,CAAC;IAO3B,KAAK,EAAG,MAAM,CAAC;IAOf,MAAM,EAAG,MAAM,GAAG,IAAI,CAAC;IAEvB,GAAG,EAAG,MAAM,CAAC;IAOb,IAAI,EAAG,OAAO,GAAG,MAAM,CAAC;IAOxB,WAAW,EAAG,MAAM,CAAC;CACtB;AAED,qBAAa,aAAc,SAAQ,SAAS;IAC1C,MAAM,CAAC,SAAS,SAAgC;IAChD,MAAM,CAAC,WAAW,SAAsB;IAQxC,EAAE,EAAG,MAAM,CAAC;IAOZ,IAAI,EAAG,MAAM,CAAC;IAOd,WAAW,EAAG,MAAM,GAAG,IAAI,CAAC;IAO5B,GAAG,EAAG,MAAM,CAAC;IAOb,SAAS,EAAG,IAAI,GAAG,MAAM,CAAC;IAQ1B,UAAU,EAAG,OAAO,CAAC;IAGrB,SAAS,EAAG,MAAM,CAAC;CACpB"}