@simplysm/orm-node 14.0.17 → 14.0.19

package/README.md

@@ -17,18 +17,13 @@ Peer dependencies (install the driver for your DBMS):
 
 ## API Overview
 
-### ORM Factory
+### ORM Factory & Query Execution
 
 | Export | Type | Description |
 |--------|------|-------------|
-| [`createOrm`](./docs/orm-factory.md#createorm) | Function | Create an ORM instance with connection management |
+| [`createOrm`](./docs/orm-factory.md#createorm) | Function | Create an ORM instance from a DbContext subclass and connection config |
 | [`Orm`](./docs/orm-factory.md#orm) | Interface | ORM instance type with `connect` and `connectWithoutTransaction` |
 | [`OrmOptions`](./docs/orm-factory.md#ormoptions) | Interface | ORM options (database/schema override) |
-
-### Query Execution
-
-| Export | Type | Description |
-|--------|------|-------------|
 | [`NodeDbContextExecutor`](./docs/orm-factory.md#nodedbcontextexecutor) | Class | Node.js `DbContextExecutor` implementation |
 
 ### Connection
@@ -64,12 +59,13 @@ Peer dependencies (install the driver for your DBMS):
 ### Basic ORM Usage
 
 ```typescript
-import { defineDbContext } from "@simplysm/orm-common";
+import { DbContext } from "@simplysm/orm-common";
 import { createOrm } from "@simplysm/orm-node";
 
-const MyDb = defineDbContext({
-  tables: { user: User, post: Post },
-});
+class MyDb extends DbContext {
+  user = this.queryable(User);
+  post = this.queryable(Post);
+}
 
 const orm = createOrm(MyDb, {
   dialect: "mysql",

package/docs/orm-factory.md

@@ -5,28 +5,31 @@ High-level ORM instance creation and Node.js query execution.
 ## createOrm
 
 ```typescript
-function createOrm<TDef extends DbContextDef<any, any, any>>(
-  dbContextDef: TDef,
+function createOrm<T extends DbContext>(
+  DbClass: new (executor: DbContextExecutor, opt: { database: string; schema?: string }) => T,
   config: DbConnConfig,
   options?: OrmOptions,
-): Orm<TDef>
+): Orm<T>
 ```
 
 Creates an ORM instance that manages DbContext creation and database connections. Each `connect()` or `connectWithoutTransaction()` call creates a fresh DbContext and connection.
 
+The `database` parameter is required -- it is resolved from `options.database` first, then `config.database`. An error is thrown if neither is provided.
+
 | Parameter | Type | Description |
 |-----------|------|-------------|
-| `dbContextDef` | `DbContextDef` | DbContext definition from `defineDbContext()` |
+| `DbClass` | `new (executor, opt) => T` | DbContext subclass constructor |
 | `config` | `DbConnConfig` | Database connection configuration |
 | `options` | `OrmOptions?` | Optional overrides for database/schema |
 
 ```typescript
-import { defineDbContext } from "@simplysm/orm-common";
+import { DbContext } from "@simplysm/orm-common";
 import { createOrm } from "@simplysm/orm-node";
 
-const MyDb = defineDbContext({
-  tables: { user: User, post: Post },
-});
+class MyDb extends DbContext {
+  user = this.queryable(User);
+  post = this.queryable(Post);
+}
 
 const orm = createOrm(MyDb, {
   dialect: "mysql",
@@ -40,25 +43,27 @@ const orm = createOrm(MyDb, {
 // Transaction mode
 await orm.connect(async (db) => {
   const users = await db.user().execute();
-  await db.post().insert([{ title: "Hello", authorId: users[0].id }]);
   return users;
 });
 
 // No-transaction mode (for DDL, read-only)
 await orm.connectWithoutTransaction(async (db) => {
-  await db.initialize();
+  // ...
 });
 ```
 
 ## Orm
 
 ```typescript
-interface Orm<TDef extends DbContextDef<any, any, any>> {
-  readonly dbContextDef: TDef;
+interface Orm<T extends DbContext> {
+  readonly DbClass: new (
+    executor: DbContextExecutor,
+    opt: { database: string; schema?: string },
+  ) => T;
   readonly config: DbConnConfig;
   readonly options?: OrmOptions;
-  connect<R>(callback: (conn: DbContextInstance<TDef>) => Promise<R>, isolationLevel?: IsolationLevel): Promise<R>;
-  connectWithoutTransaction<R>(callback: (conn: DbContextInstance<TDef>) => Promise<R>): Promise<R>;
+  connect<R>(callback: (conn: T) => Promise<R>, isolationLevel?: IsolationLevel): Promise<R>;
+  connectWithoutTransaction<R>(callback: (conn: T) => Promise<R>): Promise<R>;
 }
 ```
 
@@ -66,14 +71,14 @@ ORM instance returned by `createOrm()`.
 
 | Field | Type | Description |
 |-------|------|-------------|
-| `dbContextDef` | `TDef` | The DbContext definition |
+| `DbClass` | `new (executor, opt) => T` | The DbContext subclass constructor |
 | `config` | `DbConnConfig` | The connection configuration |
 | `options` | `OrmOptions?` | The ORM options |
 
 | Method | Signature | Description |
 |--------|-----------|-------------|
-| `connect` | `<R>(callback: (conn) => Promise<R>, isolationLevel?) => Promise<R>` | Open connection, begin transaction, execute callback, commit (auto-rollback on error), close |
-| `connectWithoutTransaction` | `<R>(callback: (conn) => Promise<R>) => Promise<R>` | Open connection, execute callback, close (no transaction) |
+| `connect` | `<R>(callback: (conn: T) => Promise<R>, isolationLevel?) => Promise<R>` | Open connection, begin transaction, execute callback, commit (auto-rollback on error), close |
+| `connectWithoutTransaction` | `<R>(callback: (conn: T) => Promise<R>) => Promise<R>` | Open connection, execute callback, close (no transaction) |
 
 ## OrmOptions
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simplysm/orm-node",
-  "version": "14.0.17",
+  "version": "14.0.19",
   "description": "심플리즘 패키지 - ORM (node)",
   "author": "심플리즘",
   "license": "Apache-2.0",
@@ -20,8 +20,8 @@
   "sideEffects": false,
   "dependencies": {
     "consola": "^3.4.2",
-    "@simplysm/core-common": "14.0.17",
-    "@simplysm/orm-common": "14.0.17"
+    "@simplysm/core-common": "14.0.19",
+    "@simplysm/orm-common": "14.0.19"
   },
   "devDependencies": {
     "@types/pg": "^8.20.0",