@syntropix/database 0.0.2 → 0.0.3

package/.env

@@ -1,2 +1,2 @@
-SYNTROPIX_API_KEY = "MrxxQ9nzk9LNSHMTBLGP1WXx705aTMMyBj8D9tUMoant7UNf/NDVAVH34Pt7dcU+dLFAwglN33hK6u1gItyJTS3TnK4jYzJ3gaiiLTLxcLjNXfnv5PfJTta3MbKrWDFr9DH0JCu0C97ShCigv3XNiZzSvH+MrXHa+XF4pF3wotLZsWU6fhAfgOS2+xXagoSv3aHT8t/tqtx+grJVeNu5aFxBQ3gG9vns2L3Vw8IkaFRck32DEQPMfC9kO0KmvP6wmCKx5Z+1A0tl2+RCLebXcJE/RYv0oseSshe3B3IEnu/NgYaH6+PEYRTyidRBjcNu"
+SYNTROPIX_API_KEY = "MrxxQ9nzk9LNSHMTBLGP1YpTVr+sT+sldRYASP0r/v7qPB16Qaksv3GU3ns/viLTyHDVgh1dN1ihtns+GXPu8pR4CjUuqpjXaowI5glQt2VbDXdScRQOkBs4YfJ9HBCts+Ri/32QYeOIjtWYWh52+349zi34rA91btmDw/0yzSv4mG9esygDm2zCSSvSEh/XZY1VhC+97/gxXwKOEVwINI2Twd/DOV3zvmQxfY733Ono1+2qWbLMLY/0rEKDx16eyRlud1PwauZXKzA1VdVpxC6O1RLwVXkfS7LNkr5QxhaWPdQWcbeJ9fPboFFbGNzICs5hBTEBDGnqbSnqwD6CfsqqgVpl5YM1DGzQyfvjb88="
 SYNTROPIX_API_URL = "http://149.248.14.64:8080"

package/.vscode/settings.json

@@ -1,8 +1 @@
-{
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "editor.formatOnSave": true,
-  "[json]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode",
-    "editor.formatOnSave": true
-  }
-}
+{}

package/dist/core/dataClient.js

@@ -19,8 +19,6 @@ export class DataClient {
         throw new Error(response.message);
     }
     async updateByPrimaryKey(pk, data) {
-        console.log(pk);
-        console.log(data);
         const response = await this.client.post(`/update/${pk}`, data);
         if (response.status === 'success') {
             return response.data;
@@ -32,9 +30,6 @@ export class DataClient {
         if (response.status === 'success') {
             const responseData = response.data;
             if (model !== undefined) {
-                // In TypeScript, we would typically use a validation library or manual validation
-                // For now, we'll return the data as-is, but in a real implementation you might want to use
-                // a library like class-validator or zod for validation
                 return new model(responseData);
             }
             return responseData;

package/dist/core/tableClient.d.ts

@@ -1,10 +1,11 @@
+import { TableCreateResponse } from '@/types/dto/table';
 import { SyntropixDBTable } from '../types/common';
 import { TableAddColumn, TableCreate, TableDrop, TableDropColumn, TableGetSchema, TableModifyColumn, TableRename, TableTruncate } from '../types/requests';
 import { ClientConfig } from './config';
 export declare class TableClient {
     private client;
     constructor(config: ClientConfig);
-    createTable(data: TableCreate): Promise<any>;
+    createTable(data: TableCreate): Promise<TableCreateResponse>;
     dropTable(data: TableDrop): Promise<any>;
     renameTable(data: TableRename): Promise<any>;
     truncateTable(data: TableTruncate): Promise<any>;

package/dist/types/basemodel.d.ts

@@ -1,6 +1,7 @@
 import 'reflect-metadata';
 import { SyntropixClient } from '../core/syntropix';
 import { Aggregate, GroupBy, Index, Join, Sort } from './common';
+import { TableCreateResponse } from './dto/table';
 import { Field, ForeignKeyField } from './field';
 import { Filter } from './filter';
 export declare function Column(options?: {
@@ -37,7 +38,7 @@ export declare class BaseModel {
     protected getPrimaryKeyName(): string;
     protected getPrimaryKey(): Field | undefined;
     protected get client(): SyntropixClient;
-    static createTable(_client?: SyntropixClient | null): Promise<any>;
+    static createTable(_client?: SyntropixClient | null): Promise<TableCreateResponse>;
     static dropTable(_client?: SyntropixClient | null): Promise<any>;
     static renameTable(newName: string, _client?: SyntropixClient | null): Promise<any>;
     static truncateTable(_client?: SyntropixClient | null): Promise<any>;

package/dist/types/dto/base.d.ts

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

package/dist/types/dto/base.js

@@ -0,0 +1 @@
+export {};

package/dist/types/dto/table.d.ts

@@ -0,0 +1,22 @@
+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/dist/types/dto/table.js

@@ -0,0 +1 @@
+export {};

package/eslint.config.mjs

@@ -1,23 +1,23 @@
-import eslint from '@eslint/js';
-import { defineConfig, globalIgnores } from 'eslint/config';
-import tseslint from 'typescript-eslint';
-
-export default defineConfig([
-  globalIgnores(['dist/**', 'node_modules/**', 'examples/**']),
-  eslint.configs.recommended,
-  ...tseslint.configs.recommended,
-  {
-    files: ['**/*.ts', '**/*.tsx'],
-    languageOptions: {
-      parser: tseslint.parser,
-      parserOptions: {
-        project: './tsconfig.json',
-      },
-    },
-    rules: {
-      'no-unused-vars': 'off',
-      '@typescript-eslint/no-unused-vars': 'off',
-      '@typescript-eslint/no-explicit-any': 'off',
-    },
-  },
-]);
+import eslint from '@eslint/js';
+import { defineConfig, globalIgnores } from 'eslint/config';
+import tseslint from 'typescript-eslint';
+
+export default defineConfig([
+  globalIgnores(['dist/**', 'node_modules/**', 'examples/**', 'tests/**', 'jest.config.ts']),
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+  {
+    files: ['**/*.ts', '**/*.tsx'],
+    languageOptions: {
+      parser: tseslint.parser,
+      parserOptions: {
+        project: './tsconfig.json',
+      },
+    },
+    rules: {
+      'no-unused-vars': 'off',
+      '@typescript-eslint/no-unused-vars': 'off',
+      '@typescript-eslint/no-explicit-any': 'off',
+    },
+  },
+]);

package/examples/tsconfig.json

@@ -0,0 +1,13 @@
+// This file is used to let VSCode respect the tsconfig.json for this test folder
+{
+  "extends": "../tsconfig.json",
+  "include": [".", "../src"],
+  "compilerOptions": {
+    "noEmit": true,
+    "baseUrl": ".",
+    "paths": {
+      "@syntropix/database": ["../src/index.ts"],
+      "@syntropix/database/*": ["../src/*"]
+    }
+  }
+}

package/examples/usage.ts

@@ -1,73 +1,94 @@
-// Example usage of the BaseModel ORM
+import { AND, BaseModel, Column, EQ, IN, OR } from '@syntropix/database';
+import { DataClient } from '@syntropix/database/core/dataClient';
+import { TableClient } from '@syntropix/database/core/tableClient';
 import 'dotenv/config';
-import { BaseModel, Column } from '../dist/types/basemodel.js';
-import { AND, EQ, OR } from '../dist/types/filter.js';
 
-// User model extending Audited
-export class User extends BaseModel {
+class User extends BaseModel {
   static tableName = 'users';
 
-  @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: 'Integer', primary: true, auto_increment: true })
+  declare id: number;
+
+  @Column()
+  declare email: string;
+
+  @Column({ name: 'full_name' })
+  declare fullName: string;
+
+  @Column({ type: 'Json', nullable: true })
+  declare profile: any;
+
+  @Column({ type: 'Boolean', name: 'is_active' })
+  declare isActive: boolean;
 }
 
-// Example usage
-async function examples() {
+async function ORMExample() {
   // Create table
-  await User.createTable();
+  // await User.createTable();
 
   // Create a new user
-  const newUser = await User.create({
-    id: 1,
-    email: 'user@example.com',
-    fullName: 'John Doe',
-    isActive: true,
-  });
+  // const newUser = await User.create({
+  //   id: 1,
+  //   email: 'user@example.com',
+  //   fullName: 'John Doe',
+  //   isActive: true,
+  // });
+  // console.log(newUser);
 
-  // Get a user
-  const user = await User.get(OR(AND(EQ('email', 'user@example.com'))));
-  console.log(user);
+  // // Get a user
+  // const user = await User.get(OR(AND(EQ('email', 'user@example.com'))));
+  // console.log(user);
 
-  // Update user
-  user.fullName = 'Jane Doe1';
-  await user.save();
+  // // Update user
+  // user.fullName = 'Jane Doe1';
+  // await user.save();
 
-  // // Filter users
+  // Filter users
   const activeUsers = await User.filter({
-    filter: OR(AND(EQ('is_active', true))),
+    filter: OR(AND(IN('email', ['user@example.com', 'user3@example.com']))),
     limit: 10,
   });
 
-  // // Count users
-  const userCount = await User.count({
-    filter: OR(AND(EQ('is_active', true))),
-  });
   console.log(activeUsers);
-  console.log(userCount);
-  // // Delete user
-  await user.remove();
-
-  // // Bulk create
-  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,
-    },
-  ]);
 
-  // console.log('All operations completed successfully!');
+  // // // Count users
+  // const userCount = await User.count({
+  //   filter: OR(AND(EQ('is_active', true))),
+  // });
+  // console.log(activeUsers);
+  // console.log(userCount);
+  // // // Delete user
+  // await user.remove();
+
+  // // // Bulk create
+  // 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,
+  //   },
+  // ]);
+}
+
+async function ClientExample() {
+  const tableClient = new TableClient();
+  const dataClient = new DataClient();
+  const data = await dataClient.queryMany({
+    table_name: 'users',
+    query: {
+      filter: OR(AND(EQ('is_active', true))),
+    },
+  });
+  console.log(data);
 }
 
 // Run examples
-examples().catch(console.error);
+ORMExample().catch(console.error);
+// ClientExample().catch(console.error);

package/jest.config.ts

@@ -1,10 +1,9 @@
-import type { Config } from 'jest';
-import { createDefaultEsmPreset } from 'ts-jest';
-
-const presetConfig = createDefaultEsmPreset({
-  tsconfig: 'tsconfig.test.json',
-});
-
-export default {
-  ...presetConfig,
-} satisfies Config;
+import type { Config } from 'jest';
+import { createDefaultEsmPreset, pathsToModuleNameMapper } from 'ts-jest';
+
+const presetConfig = createDefaultEsmPreset({});
+
+export default {
+  ...presetConfig,
+  moduleNameMapper: pathsToModuleNameMapper({ '@/*': ['src/*'] }, { prefix: '<rootDir>/' }),
+} satisfies Config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syntropix/database",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "type": "module",
   "description": "TypeScript SDK for database operations with ORM support",
   "main": "dist/index.js",
@@ -14,8 +14,8 @@
     "build": "tsc",
     "dev": "tsc --watch",
     "test": "node --experimental-vm-modules $(yarn bin jest)",
-    "example": "ts-node examples/usage.ts",
-    "advanced": "ts-node examples/advanced-usage.ts",
+    "publish": "npm publish --access public",
+    "example": "tsx --tsconfig examples/tsconfig.json examples/usage.ts",
     "lint": "eslint",
     "lint:fix": "eslint --fix",
     "format": "prettier --write .",
@@ -27,7 +27,7 @@
     "typescript",
     "sdk"
   ],
-  "author": "Syntropix",
+  "author": "Syntropix, Inc.",
   "license": "MIT",
   "dependencies": {
     "dotenv": "^17.2.3",

package/src/core/dataClient.ts

@@ -5,7 +5,7 @@ import { ClientConfig } from './config';
 export class DataClient {
   private client: Client;
 
-  constructor(config: ClientConfig) {
+  constructor(config: ClientConfig = new ClientConfig()) {
     this.client = new Client(config);
   }
 
@@ -26,8 +26,6 @@ export class DataClient {
   }
 
   async updateByPrimaryKey(pk: string, data: Update): Promise<any> {
-    console.log(pk);
-    console.log(data);
     const response = await this.client.post(`/update/${pk}`, data);
     if (response.status === 'success') {
       return response.data;
@@ -40,9 +38,6 @@ export class DataClient {
     if (response.status === 'success') {
       const responseData = response.data;
       if (model !== undefined) {
-        // In TypeScript, we would typically use a validation library or manual validation
-        // For now, we'll return the data as-is, but in a real implementation you might want to use
-        // a library like class-validator or zod for validation
         return new model(responseData);
       }
       return responseData;

package/src/core/tableClient.ts

@@ -1,3 +1,4 @@
+import { TableCreateResponse } from '@/types/dto/table';
 import { SyntropixDBTable } from '../types/common';
 import {
   TableAddColumn,
@@ -15,11 +16,11 @@ import { ClientConfig } from './config';
 export class TableClient {
   private client: Client;
 
-  constructor(config: ClientConfig) {
+  constructor(config: ClientConfig = new ClientConfig()) {
     this.client = new Client(config);
   }
 
-  async createTable(data: TableCreate): Promise<any> {
+  async createTable(data: TableCreate): Promise<TableCreateResponse> {
     const response = await this.client.post('/table/create', data);
     if (response.status === 'success') {
       return response.data;

package/src/types/basemodel.ts

@@ -3,6 +3,7 @@ import 'reflect-metadata';
 import { ClientConfig } from '../core/config';
 import { SyntropixClient } from '../core/syntropix';
 import { Aggregate, AggregateFunction, ForeignKey, GroupBy, Index, Join, Sort } from './common';
+import { TableCreateResponse } from './dto/table';
 import { Field, ForeignKeyField, IntegerField } from './field';
 import { AND, EQ, Filter, GTE, OR, Value } from './filter';
 
@@ -218,7 +219,7 @@ export class BaseModel {
   }
 
   // Table operations
-  static async createTable(_client?: SyntropixClient | null): Promise<any> {
+  static async createTable(_client?: SyntropixClient | null): Promise<TableCreateResponse> {
     const fields = this.getFields();
     const columns = Object.values(fields).map((f) => f.into());
     const foreignKeys: ForeignKey[] = this.getAssociations().map((f) => ({
@@ -465,7 +466,7 @@ export class BaseModel {
     this: new (data?: any) => T,
     options: {
       filter: Filter;
-      sort?: Sort;
+      sort?: Sort[];
       aggregate?: Aggregate[];
       join?: Join;
       limit?: number;

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[];
+}