@zhin.js/database 1.0.0

package/src/types.ts

@@ -0,0 +1,403 @@
+
+export type QueryType = 
+  | 'create' 
+  | 'alter' 
+  | 'drop_table' 
+  | 'drop_index' 
+  | 'select' 
+  | 'insert' 
+  | 'update' 
+  | 'delete';
+
+// ============================================================================
+// Column Type Definitions
+// ============================================================================
+
+export type ColumnType = 
+  | "text" 
+  | "integer" 
+  | "float" 
+  | "boolean" 
+  | "date" 
+  | "json";
+
+export interface Column<T = any> {
+  type: ColumnType;
+  nullable?: boolean;
+  default?: T;
+  autoIncrement?: boolean;
+  primary?: boolean;
+  unique?: boolean;
+  length?: number;
+}
+
+export type Schema<T extends object=object> = {
+  [P in keyof T]: Column<T[P]>;
+}
+
+// ============================================================================
+// Column Alteration Types
+// ============================================================================
+
+export interface AddSchema<T = any> {
+  action: "add";
+  type: ColumnType;
+  nullable?: boolean;
+  default?: T;
+  primary?: boolean;
+  length?: number;
+}
+
+export interface ModifySchema<T = any> {
+  action: "modify";
+  type?: ColumnType;
+  nullable?: boolean;
+  default?: T;
+  length?: number;
+}
+
+export interface DropSchema {
+  action: "drop";
+}
+
+export type AlterSchema<T extends object> = {
+  [P in keyof T]?:AddSchema<T[P]> | ModifySchema<T[P]> | DropSchema
+};
+
+// ============================================================================
+// Condition Types
+// ============================================================================
+
+export interface ComparisonOperators<T> {
+  $eq?: T;
+  $ne?: T;
+  $gt?: T;
+  $gte?: T;
+  $lt?: T;
+  $lte?: T;
+  $in?: T[];
+  $nin?: T[];
+  $like?: string;
+  $nlike?: string;
+}
+
+export interface LogicOperators<T = any> {
+  $and?: Condition<T>[];
+  $or?: Condition<T>[];
+  $not?: Condition<T>;
+}
+
+export type Condition<T = object> ={
+  [P in keyof T]?: T[P] | ComparisonOperators<T[P]> | LogicOperators<T[P]>;
+}|LogicOperators<T>;
+
+// ============================================================================
+// Ordering Types
+// ============================================================================
+
+export type SortDirection = "ASC" | "DESC";
+
+export interface Ordering<T extends object> {
+  field: keyof T;
+  direction: SortDirection;
+}
+
+// ============================================================================
+// Query Parameter Types (Discriminated Union)
+// ============================================================================
+
+export interface BaseQueryParams {
+  tableName: string;
+}
+
+export interface CreateQueryParams<T extends object = any> extends BaseQueryParams {
+  type: 'create';
+  schema: Schema<T>;
+}
+
+export interface AlterQueryParams<T extends object = any> extends BaseQueryParams {
+  type: 'alter';
+  alterations: AlterSchema<T>;
+}
+
+export interface DropTableQueryParams<T extends object = any> extends BaseQueryParams {
+  type: 'drop_table';
+  conditions?: Condition<T>;
+}
+
+export interface DropIndexQueryParams extends BaseQueryParams {
+  type: 'drop_index';
+  indexName: string;
+  conditions?: Condition<any>;
+}
+
+export interface SelectQueryParams<T extends object = any> extends BaseQueryParams {
+  type: 'select';
+  fields?: (keyof T)[];
+  conditions?: Condition<T>;
+  groupings?: (keyof T)[];
+  orderings?: Ordering<T>[];
+  limitCount?: number;
+  offsetCount?: number;
+}
+
+export interface InsertQueryParams<T extends object = any> extends BaseQueryParams {
+  type: 'insert';
+  data: T;
+}
+
+export interface UpdateQueryParams<T extends object = any> extends BaseQueryParams {
+  type: 'update';
+  update: Partial<T>;
+  conditions?: Condition<T>;
+}
+
+export interface DeleteQueryParams<T extends object = any> extends BaseQueryParams {
+  type: 'delete';
+  conditions?: Condition<T>;
+}
+
+export type QueryParams<T extends object = any> = 
+  | CreateQueryParams<T>
+  | AlterQueryParams<T>
+  | DropTableQueryParams<T>
+  | DropIndexQueryParams
+  | SelectQueryParams<T>
+  | InsertQueryParams<T>
+  | UpdateQueryParams<T>
+  | DeleteQueryParams<T>;
+
+// ============================================================================
+// Query Result Types
+// ============================================================================
+
+export interface BuildQueryResult<R> {
+  query: R;
+  params: any[];
+}
+
+// ============================================================================
+// NoSQL Query Result Types
+// ============================================================================
+
+/**
+ * 文档查询结果类型
+ */
+export interface DocumentQueryResult {
+  collection: string;
+  filter: Record<string, any>;
+  sort?: Record<string, 1 | -1>;
+  limit?: number;
+  skip?: number;
+  projection?: Record<string, 1 | 0>;
+  operation?: 'find' | 'insertOne' | 'insertMany' | 'updateOne' | 'updateMany' | 'deleteOne' | 'deleteMany' | 'createCollection' | 'createIndex' | 'dropIndex' | 'dropCollection';
+}
+
+/**
+ * 键值查询结果类型
+ */
+export interface KeyValueQueryResult {
+  bucket: string;
+  operation: 'get' | 'set' | 'delete' | 'has' | 'keys' | 'values' | 'entries' | 'clear' | 'size' | 'expire' | 'ttl' | 'persist' | 'cleanup' | 'keysByPattern';
+  key?: string;
+  value?: any;
+  ttl?: number;
+  pattern?: string;
+  keys?: string[];
+}
+
+/**
+ * 文档操作结果类型
+ */
+export interface DocumentOperationResult<T = any> {
+  success: boolean;
+  data?: T | T[];
+  count?: number;
+  error?: string;
+}
+
+/**
+ * 键值操作结果类型
+ */
+export interface KeyValueOperationResult<T = any> {
+  success: boolean;
+  data?: T | T[] | number | boolean;
+  error?: string;
+}
+
+/**
+ * 数据库方言信息接口
+ */
+export interface DatabaseDialect {
+  name: string;
+  version: string;
+  features: string[];
+  dataTypes: Record<string, string>;
+  identifierQuote: string;
+  parameterPlaceholder: string;
+  supportsTransactions: boolean;
+  supportsIndexes: boolean;
+  supportsForeignKeys: boolean;
+  supportsViews: boolean;
+  supportsStoredProcedures: boolean;
+}
+
+export interface SelectResult<T> {
+  rows: T[];
+  count?: number;
+}
+
+export interface InsertResult<T = any> {
+  insertId?: number | string;
+  affectedRows?: number;
+  data?: T;
+}
+
+export interface UpdateResult {
+  affectedRows: number;
+}
+
+export interface DeleteResult {
+  affectedRows: number;
+}
+
+// ============================================================================
+// Driver Configuration Types
+// ============================================================================
+
+export interface BaseDriverConfig {
+  timeout?: number;
+  retries?: number;
+}
+
+
+export interface MemoryConfig{
+}
+
+
+// ============================================================================
+// Driver Interface Types
+// ============================================================================
+
+export interface DriverConnection {
+  isConnected(): boolean;
+  connect(): Promise<void>;
+  disconnect(): Promise<void>;
+  healthCheck(): Promise<boolean>;
+}
+
+export interface DriverQuery {
+  query<T = any>(sql: string, params?: any[]): Promise<T>;
+}
+
+export interface DriverSchema {
+  getTables(): Promise<string[]>;
+  getTableInfo(tableName: string): Promise<TableInfo[]>;
+}
+
+export interface DriverQueryBuilder<R> {
+  buildQuery<T extends object = any>(params: QueryParams<T>): BuildQueryResult<R>;
+}
+
+export interface DriverLifecycle {
+  dispose(): Promise<void>;
+}
+
+export interface TableInfo {
+  name: string;
+  type: string;
+  nullable: boolean;
+  defaultValue: any;
+  primaryKey: boolean;
+  unique: boolean;
+  length?: number;
+}
+
+// ============================================================================
+// Model Types
+// ============================================================================
+
+export interface ModelField {
+  type: 
+    | "string"
+    | "integer" 
+    | "number"
+    | "float"
+    | "json"
+    | "boolean"
+    | "date"
+    | "object"
+    | "array";
+  initial?: any;
+  length?: number;
+  primary?: boolean;
+  autoIncrement?: boolean;
+  unique?: boolean;
+  notNull?: boolean;
+}
+
+export interface ModelConfig {
+  driver?: string;
+  timestamps?: boolean;
+  softDelete?: boolean;
+  relations?: ModelRelation[];
+}
+
+export interface ModelRelation {
+  model: string;
+  type: "belongs-to" | "has-one" | "has-many" | "many-to-many";
+  foreignKey?: string;
+  through?: string;
+}
+
+// ============================================================================
+// Utility Types
+// ========================================
+
+export type RequiredKeys<T, K extends keyof T> = T & Required<Pick<T, K>>;
+
+export type OptionalKeys<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+
+export type DeepPartial<T> = {
+  [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+
+export type DeepRequired<T> = {
+  [P in keyof T]-?: T[P] extends object ? DeepRequired<T[P]> : T[P];
+};
+
+// ============================================================================
+// Type Guards
+// ============================================================================
+
+export function isCreateQuery<T extends object>(params: QueryParams<T>): params is CreateQueryParams<T> {
+  return params.type === 'create';
+}
+
+export function isAlterQuery<T extends object>(params: QueryParams<T>): params is AlterQueryParams<T> {
+  return params.type === 'alter';
+}
+
+export function isSelectQuery<T extends object>(params: QueryParams<T>): params is SelectQueryParams<T> {
+  return params.type === 'select';
+}
+
+export function isInsertQuery<T extends object>(params: QueryParams<T>): params is InsertQueryParams<T> {
+  return params.type === 'insert';
+}
+
+export function isUpdateQuery<T extends object>(params: QueryParams<T>): params is UpdateQueryParams<T> {
+  return params.type === 'update';
+}
+
+export function isDeleteQuery<T extends object>(params: QueryParams<T>): params is DeleteQueryParams<T> {
+  return params.type === 'delete';
+}
+
+export function isDropTableQuery<T extends object>(params: QueryParams<T>): params is DropTableQueryParams<T> {
+  return params.type === 'drop_table';
+}
+
+export function isDropIndexQuery(params: QueryParams): params is DropIndexQueryParams {
+  return params.type === 'drop_index';
+}

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "outDir": "./lib",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "allowSyntheticDefaultImports": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "verbatimModuleSyntax": false
+  },
+  "include": ["src/**/*"],
+  "exclude": ["lib", "node_modules"]
+}