@syntropix/database 0.0.5 → 0.1.0

package/README.md

@@ -1,31 +1,31 @@
 # DB TypeScript SDK
 
-一个类似于 Python ORM 的 TypeScript SDK，用于数据库操作。
+A TypeScript SDK for database operations, similar to a Python ORM.
 
-## 安装
+## Installation
 
 ```bash
 yarn add reflect-metadata
 ```
 
-## 功能特性
+## Features
 
-- 🎯 **装饰器支持** - 使用 TypeScript 装饰器定义模型
-- 🔑 **自动主键** - 如果未定义主键，自动创建 `id` 字段
-- 🔗 **外键关系** - 支持外键定义和关系
-- 📝 **完整的 CRUD** - 提供 create, read, update, delete 操作
-- 🔍 **高级查询** - 支持过滤、排序、聚合、连接等
-- 🚀 **批量操作** - 支持批量创建和更新
-- 🎨 **类型安全** - 完整的 TypeScript 类型支持
+- 🎯 **Decorator Support** - Define models using TypeScript decorators
+- 🔑 **Automatic Primary Keys** - `id` field is automatically created if not defined
+- 🔗 **Foreign Key Relations** - Supports defining and handling foreign key relations
+- 📝 **Full CRUD** - Create, read, update, and delete operations
+- 🔍 **Advanced Queries** - Filtering, sorting, aggregation, joins, etc.
+- 🚀 **Batch Operations** - Bulk create and update support
+- 🎨 **Type Safety** - Full TypeScript types, type-safe models
 
-## 快速开始
+## Quick Start
 
-### 1. 定义模型
+### 1. Define Models
 
 ```typescript
 import { BaseModel, Column } from 'db-ts-sdk';
 
-// 基础审计模型
+// Audited base model
 export class Audited extends BaseModel {
   @Column({ type: 'date', name: 'created_at' })
   createdAt!: Date;
@@ -34,7 +34,7 @@ export class Audited extends BaseModel {
   updatedAt!: Date;
 }
 
-// 用户模型
+// User model
 export class User extends Audited {
   static tableName = 'users';
 
@@ -55,28 +55,28 @@ export class User extends Audited {
 }
 ```
 
-### 2. 表操作
+### 2. Table Operations
 
 ```typescript
-// 创建表
+// Create table
 await User.createTable();
 
-// 删除表
+// Drop table
 await User.dropTable();
 
-// 重命名表
+// Rename table
 await User.renameTable('new_users');
 
-// 清空表
+// Truncate table
 await User.truncateTable();
 ```
 
-### 3. 数据操作
+### 3. Data Operations
 
-#### 创建数据
+#### Create Data
 
 ```typescript
-// 单条创建
+// Single insert
 const user = await User.create({
   id: '1',
   email: 'user@example.com',
@@ -86,7 +86,7 @@ const user = await User.create({
   updatedAt: new Date(),
 });
 
-// 批量创建
+// Bulk insert
 await User.bulkCreate(
   [
     {
@@ -106,19 +106,19 @@ await User.bulkCreate(
       updatedAt: new Date(),
     },
   ],
-  32,
-); // 批次大小
+  32, // Batch size
+);
 ```
 
-#### 查询数据
+#### Query Data
 
 ```typescript
 import { AND, EQ, OR, GTE } from 'db-ts-sdk';
 
-// 获取单个记录
+// Get a single record
 const user = await User.get(OR(AND(EQ('email', 'user@example.com'))));
 
-// 过滤查询
+// Filter query
 const activeUsers = await User.filter({
   filter: OR(AND(EQ('is_active', true))),
   limit: 10,
@@ -126,38 +126,38 @@ const activeUsers = await User.filter({
   sort: { column: 'created_at', order: 'DESC' },
 });
 
-// 统计数量
+// Count records
 const count = await User.count({
   filter: OR(AND(EQ('is_active', true))),
 });
 ```
 
-#### 更新数据
+#### Update Data
 
 ```typescript
-// 实例更新
+// Instance update
 const user = await User.get(OR(AND(EQ('id', '1'))));
 user.fullName = 'Jane Doe';
 await user.save();
 
-// 批量更新
+// Bulk update
 await User.update(OR(AND(EQ('is_active', false))), { isActive: true });
 ```
 
-#### 删除数据
+#### Delete Data
 
 ```typescript
-// 实例删除
+// Instance delete
 const user = await User.get(OR(AND(EQ('id', '1'))));
 await user.remove();
 
-// 批量删除
+// Bulk delete
 await User.delete(OR(AND(EQ('is_active', false))));
 ```
 
-## 字段类型
+## Field Types
 
-SDK 支持多种字段类型：
+The SDK supports various field types:
 
 ```typescript
 import {
@@ -180,22 +180,22 @@ import {
 } from 'db-ts-sdk';
 ```
 
-### 使用装饰器
+### Using Decorators
 
 ```typescript
 @Column({
-  type: 'string',           // 字段类型
-  name: 'column_name',      // 数据库列名（可选）
-  description: 'desc',      // 描述（可选）
-  primary: false,           // 是否主键（可选）
-  nullable: false,          // 是否可为空（可选）
-  auto_increment: false,     // 是否自增（可选）
-  default: null             // 默认值（可选）
+  type: 'string',           // Field type
+  name: 'column_name',      // Database column name (optional)
+  description: 'desc',      // Description (optional)
+  primary: false,           // Is primary key (optional)
+  nullable: false,          // Nullable (optional)
+  auto_increment: false,    // Auto increment (optional)
+  default: null             // Default value (optional)
 })
 fieldName!: string;
 ```
 
-### 外键字段
+### Foreign Key Fields
 
 ```typescript
 import { ForeignKey } from 'db-ts-sdk';
@@ -208,42 +208,42 @@ import { ForeignKey } from 'db-ts-sdk';
 userId!: number;
 ```
 
-## 过滤器构建
+## Filter Builder
 
 ```typescript
 import { AND, OR, EQ, NE, GT, GTE, LT, LTE, IN, LIKE } from 'db-ts-sdk';
 
-// 等于
+// Equals
 EQ('field', value);
 
-// 不等于
+// Not equals
 NE('field', value);
 
-// 大于
+// Greater than
 GT('field', value);
 
-// 大于等于
+// Greater than or equal
 GTE('field', value);
 
-// 小于
+// Less than
 LT('field', value);
 
-// 小于等于
+// Less than or equal
 LTE('field', value);
 
-// 包含
+// In array
 IN('field', [value1, value2]);
 
-// 模糊匹配
+// Pattern matching (LIKE)
 LIKE('field', '%pattern%');
 
-// 组合条件
+// Combine conditions
 OR(AND(EQ('status', 'active'), GTE('age', 18)), AND(EQ('status', 'pending')));
 ```
 
-## 高级查询
+## Advanced Queries
 
-### 聚合查询
+### Aggregate Query
 
 ```typescript
 import { AggregateFunction } from 'db-ts-sdk';
@@ -261,7 +261,7 @@ const results = await User.filter({
 });
 ```
 
-### 连接查询
+### Join Query
 
 ```typescript
 const results = await User.filter({
@@ -274,9 +274,9 @@ const results = await User.filter({
 });
 ```
 
-## 配置
+## Configuration
 
-在 `tsconfig.json` 中确保启用装饰器支持：
+In your `tsconfig.json`, make sure to enable decorator support:
 
 ```json
 {
@@ -287,34 +287,34 @@ const results = await User.filter({
 }
 ```
 
-在应用入口导入 reflect-metadata：
+And at the entrypoint of your app, import reflect-metadata:
 
 ```typescript
 import 'reflect-metadata';
 ```
 
-## API 参考
+## API Reference
 
-### BaseModel 静态方法
+### BaseModel Static Methods
 
-- `createTable()` - 创建表
-- `dropTable()` - 删除表
-- `renameTable(newName)` - 重命名表
-- `truncateTable()` - 清空表
-- `create(data)` - 创建记录
-- `bulkCreate(datas, batchSize)` - 批量创建
-- `get(filter, select?)` - 获取单个记录
-- `filter(options)` - 过滤查询
-- `update(filter, data)` - 批量更新
-- `delete(filter)` - 批量删除
-- `count(options)` - 统计数量
+- `createTable()` - Create table
+- `dropTable()` - Drop table
+- `renameTable(newName)` - Rename table
+- `truncateTable()` - Truncate table
+- `create(data)` - Create a record
+- `bulkCreate(datas, batchSize)` - Create records in bulk
+- `get(filter, select?)` - Get a single record
+- `filter(options)` - Filter query
+- `update(filter, data)` - Bulk update
+- `delete(filter)` - Bulk delete
+- `count(options)` - Count records
 
-### BaseModel 实例方法
+### BaseModel Instance Methods
 
-- `save()` - 保存实例（创建或更新）
-- `remove(filter?)` - 删除实例
-- `toString()` - 转换为字符串
-- `toJSON()` - 转换为 JSON 对象
+- `save()` - Save instance (create or update)
+- `remove(filter?)` - Remove instance
+- `toString()` - Convert to string
+- `toJSON()` - Convert to JSON object
 
 ## License
 

package/dist/core/dataClient.js

@@ -1,3 +1,4 @@
+import { FilterWrapper } from '../types/filter';
 import { Client } from './client';
 import { ClientConfig } from './config';
 export class DataClient {
@@ -27,6 +28,7 @@ export class DataClient {
         throw new Error(response.message);
     }
     async queryOne(data, model) {
+        data.query.filter = FilterWrapper(data.query.filter);
         const response = await this.client.post('/query', { One: data });
         if (response.status === 'success') {
             const responseData = response.data;
@@ -38,6 +40,7 @@ export class DataClient {
         throw new Error(response.message);
     }
     async queryMany(data, model) {
+        data.query.filter = FilterWrapper(data.query.filter);
         const response = await this.client.post('/query', { Many: data });
         if (response.status === 'success') {
             const responseData = response.data;

package/dist/core/syntropix.d.ts

@@ -5,7 +5,7 @@ export declare class SyntropixClient {
     private config;
     private _tableClient?;
     private _dataClient?;
-    constructor(config: ClientConfig);
+    constructor(config?: ClientConfig);
     get table(): TableClient;
     get data(): DataClient;
 }

package/dist/core/syntropix.js

@@ -1,10 +1,11 @@
+import { ClientConfig } from './config';
 import { DataClient } from './dataClient';
 import { TableClient } from './tableClient';
 export class SyntropixClient {
     config;
     _tableClient;
     _dataClient;
-    constructor(config) {
+    constructor(config = new ClientConfig()) {
         this.config = config;
     }
     get table() {

package/dist/index.d.ts

@@ -3,7 +3,7 @@ export * from './core/config';
 export { SyntropixClient } from './core/syntropix';
 export { BaseModel, Column, ForeignKey } from './types/basemodel';
 export * from './types/common';
-export { DataType } from './types/data-type';
+export { ColumnType } from './types/data-type';
 export * from './types/field';
 export * from './types/filter';
 export * from './types/requests';

package/dist/index.js

@@ -4,7 +4,7 @@ export * from './core/config';
 export { SyntropixClient } from './core/syntropix';
 export { BaseModel, Column, ForeignKey } from './types/basemodel';
 export * from './types/common';
-export { DataType } from './types/data-type';
+export { ColumnType } from './types/data-type';
 export * from './types/field';
 export * from './types/filter';
 export * from './types/requests';

package/dist/types/basemodel.d.ts

@@ -1,21 +1,22 @@
 import 'reflect-metadata';
 import { SyntropixClient } from '../core/syntropix';
 import { Aggregate, GroupBy, Index, Join, Sort } from './common';
+import { ColumnType } from './data-type';
 import { TableCreateResponse } from './dto/table';
 import { Field, ForeignKeyField } from './field';
 import { Filter } from './filter';
 export declare function Column(options?: {
-    type?: string | Record<string, any>;
+    type?: ColumnType;
     name?: string;
     description?: string;
     primary?: boolean;
     nullable?: boolean;
-    auto_increment?: boolean;
+    autoIncrement?: boolean;
     default?: any;
 }): (target: any, propertyKey: string) => void;
 export declare function Description(description: string): (target: any) => void;
 export declare function ForeignKey(tableName: string, columnName: string, options?: {
-    type?: string | Record<string, any>;
+    type?: ColumnType;
     name?: string;
     onDelete?: string;
     onUpdate?: string;

package/dist/types/basemodel.js

@@ -3,6 +3,7 @@ import 'reflect-metadata';
 import { ClientConfig } from '../core/config';
 import { SyntropixClient } from '../core/syntropix';
 import { AggregateFunction } from './common';
+import { ColumnType } from './data-type';
 import { Field, ForeignKeyField, IntegerField } from './field';
 import { AND, EQ, GTE, OR, Value } from './filter';
 // Metadata keys
@@ -15,15 +16,15 @@ export function Column(options = {}) {
     return function (target, propertyKey) {
         const fields = Reflect.getMetadata(FIELDS_KEY, target.constructor) || {};
         const fieldName = options.name || propertyKey.toLowerCase();
-        const column_type = options.type || 'Text';
+        const columnType = options.type || ColumnType.Text;
         const field = new (class extends Field {
             constructor() {
-                super(column_type, {
+                super(columnType, {
                     name: fieldName,
                     description: options.description,
-                    is_primary_key: options.primary,
-                    is_nullable: options.nullable,
-                    auto_increment: options.auto_increment,
+                    isPrimaryKey: options.primary,
+                    isNullable: options.nullable,
+                    autoIncrement: options.autoIncrement,
                     default: options.default,
                 });
             }
@@ -42,11 +43,11 @@ export function Description(description) {
 export function ForeignKey(tableName, columnName, options = {}) {
     return function (target, propertyKey) {
         const fields = Reflect.getMetadata(FIELDS_KEY, target.constructor) || {};
-        const field = new ForeignKeyField(options.type || 'Integer', tableName, columnName, {
+        const field = new ForeignKeyField(options.type || ColumnType.Integer, tableName, columnName, {
             onDelete: options.onDelete,
             onUpdate: options.onUpdate,
             description: options.description,
-            is_nullable: options.nullable,
+            isNullable: options.nullable,
             default: options.default,
         });
         field.name = options.name || propertyKey.toLowerCase();
@@ -108,18 +109,18 @@ export class BaseModel {
         // Check if there's a primary key
         let hasPrimaryKey = false;
         for (const field of Object.values(fields)) {
-            if (field.is_primary_key) {
+            if (field.isPrimaryKey) {
                 hasPrimaryKey = true;
-                field.is_nullable = false;
+                field.isNullable = false;
                 break;
             }
         }
         // If no primary key, add default 'id' field
         if (!hasPrimaryKey && !('id' in fields)) {
             fields['id'] = new IntegerField({
-                is_primary_key: true,
-                is_nullable: false,
-                auto_increment: true,
+                isPrimaryKey: true,
+                isNullable: false,
+                autoIncrement: true,
                 description: 'Primary key',
             });
             fields['id'].name = 'id';
@@ -129,7 +130,7 @@ export class BaseModel {
     static getPrimaryKeyName() {
         const fields = this.getFields();
         for (const [key, field] of Object.entries(fields)) {
-            if (field.is_primary_key) {
+            if (field.isPrimaryKey) {
                 return field.name;
             }
         }
@@ -152,7 +153,7 @@ export class BaseModel {
     getPrimaryKey() {
         const fields = this.getFields();
         for (const field of Object.values(fields)) {
-            if (field.is_primary_key) {
+            if (field.isPrimaryKey) {
                 return field;
             }
         }
@@ -170,12 +171,12 @@ export class BaseModel {
         const fields = this.getFields();
         const columns = Object.values(fields).map((f) => f.into());
         const foreignKeys = this.getAssociations().map((f) => ({
-            from_table: this.getTableName(),
-            from_column: f.name,
-            to_table: f.tableName,
-            to_column: f.columnName,
-            on_delete: f.onDelete,
-            on_update: f.onUpdate,
+            fromTable: this.getTableName(),
+            fromColumn: f.name,
+            toTable: f.tableName,
+            toColumn: f.columnName,
+            onDelete: f.onDelete,
+            onUpdate: f.onUpdate,
         }));
         const indexes = this.getIndexes();
         const client = _client || new SyntropixClient(new ClientConfig());
@@ -183,7 +184,7 @@ export class BaseModel {
             name: this.getTableName(),
             description: this.getDescription() || 'No description',
             columns,
-            foreign_keys: foreignKeys,
+            foreignKeys: foreignKeys,
             indexes,
         });
     }
@@ -195,7 +196,7 @@ export class BaseModel {
         const client = _client || new SyntropixClient(new ClientConfig());
         return client.table.renameTable({
             name: this.getTableName(),
-            new_name: newName,
+            newName: newName,
         });
     }
     static async truncateTable(_client) {
@@ -219,7 +220,7 @@ export class BaseModel {
         }
         const client = _client || new SyntropixClient(new ClientConfig());
         return client.data.insertOne({
-            table_name: model.getTableName(),
+            tableName: model.getTableName(),
             data: {
                 columns,
                 values: [values],
@@ -247,7 +248,7 @@ export class BaseModel {
         }
         return (_client ||
             this.client.data.updateByPrimaryKey(pkValue, {
-                table_name: this.getTableName(),
+                tableName: this.getTableName(),
                 payload: {
                     filter: [[]],
                     columns,
@@ -261,7 +262,7 @@ export class BaseModel {
         const finalFilter = filter || OR(AND(EQ(pk?.name || 'id', pkValue)));
         return (_client ||
             this.client.data.deleteData({
-                table_name: this.getTableName(),
+                tableName: this.getTableName(),
                 payload: {
                     filter: finalFilter,
                 },
@@ -292,7 +293,7 @@ export class BaseModel {
             values.push(columns.map((c) => data[c]));
             if (values.length === batchSize) {
                 cnt += await client.data.insertData({
-                    table_name: model.getTableName(),
+                    tableName: model.getTableName(),
                     data: { columns: columns.map((c) => fields[c].name), values },
                 });
                 values = [];
@@ -300,7 +301,7 @@ export class BaseModel {
         }
         if (values.length > 0) {
             cnt += await client.data.insertData({
-                table_name: model.getTableName(),
+                tableName: model.getTableName(),
                 data: { columns: columns.map((c) => fields[c].name), values },
             });
         }
@@ -321,7 +322,7 @@ export class BaseModel {
         const values = columns.map((c) => data[c]);
         const client = _client || new SyntropixClient(new ClientConfig());
         return client.data.updateData({
-            table_name: model.getTableName(),
+            tableName: model.getTableName(),
             payload: {
                 filter,
                 columns: columns.map((c) => fields[c].name),
@@ -333,7 +334,7 @@ export class BaseModel {
         const model = this;
         const client = _client || new SyntropixClient(new ClientConfig());
         return client.data.deleteData({
-            table_name: model.getTableName(),
+            tableName: model.getTableName(),
             payload: { filter },
         });
     }
@@ -342,7 +343,7 @@ export class BaseModel {
         const fields = model.getFields();
         const client = _client || new SyntropixClient(new ClientConfig());
         const data = await client.data.queryOne({
-            table_name: model.getTableName(),
+            tableName: model.getTableName(),
             query: {
                 filter,
                 select: select || Object.values(fields).map((f) => f.name),
@@ -355,7 +356,7 @@ export class BaseModel {
         const model = this;
         const client = options._client || new SyntropixClient(new ClientConfig());
         const data = await client.data.queryMany({
-            table_name: model.getTableName(),
+            tableName: model.getTableName(),
             query: {
                 filter: options.filter,
                 sort: options.sort,
@@ -363,7 +364,7 @@ export class BaseModel {
                 join: options.join ? [options.join] : undefined,
                 limit: options.limit,
                 offset: options.offset,
-                group_by: options.groupBy,
+                groupBy: options.groupBy,
                 select: options.select,
             },
         });
@@ -373,20 +374,20 @@ export class BaseModel {
         const model = this;
         const client = options._client || new SyntropixClient(new ClientConfig());
         const data = await client.data.queryMany({
-            table_name: model.getTableName(),
+            tableName: model.getTableName(),
             query: {
                 filter: options.filter || [[GTE('id', Value(0))]],
                 aggregate: [
                     {
                         column: 'id',
-                        function: AggregateFunction.COUNT,
+                        function: AggregateFunction.Count,
                         alias: 'count',
                     },
                 ],
                 join: options.join ? [options.join] : undefined,
                 limit: 1,
                 offset: 0,
-                group_by: options.groupBy,
+                groupBy: options.groupBy,
                 select: ['count'],
             },
         });