@simplysm/orm-node 13.0.0-beta.6

package/dist/orm-common/src/types/column.d.ts

@@ -0,0 +1,172 @@
+import { DateOnly, DateTime, Time, Uuid, type Bytes } from "@simplysm/core-common";
+/**
+ * SQL 데이터 타입 정의
+ *
+ * DBMS별 매핑:
+ * - `int`: INT (4 bytes)
+ * - `bigint`: BIGINT (8 bytes)
+ * - `float`: FLOAT/REAL (4 bytes)
+ * - `double`: DOUBLE/FLOAT (8 bytes)
+ * - `decimal`: DECIMAL(precision, scale)
+ * - `varchar`: VARCHAR(length)
+ * - `char`: CHAR(length)
+ * - `text`: TEXT/LONGTEXT
+ * - `binary`: LONGBLOB/VARBINARY(MAX)/BYTEA
+ * - `boolean`: TINYINT(1)/BIT/BOOLEAN
+ * - `datetime`: DATETIME
+ * - `date`: DATE
+ * - `time`: TIME
+ * - `uuid`: BINARY(16)/UNIQUEIDENTIFIER/UUID
+ *
+ * @example
+ * ```typescript
+ * const intType: DataType = { type: "int" };
+ * const decimalType: DataType = { type: "decimal", precision: 10, scale: 2 };
+ * const varcharType: DataType = { type: "varchar", length: 100 };
+ * ```
+ */
+export type DataType = {
+    type: "int";
+} | {
+    type: "bigint";
+} | {
+    type: "float";
+} | {
+    type: "double";
+} | {
+    type: "decimal";
+    precision: number;
+    scale?: number;
+} | {
+    type: "varchar";
+    length: number;
+} | {
+    type: "char";
+    length: number;
+} | {
+    type: "text";
+} | {
+    type: "binary";
+} | {
+    type: "boolean";
+} | {
+    type: "datetime";
+} | {
+    type: "date";
+} | {
+    type: "time";
+} | {
+    type: "uuid";
+};
+/**
+ * 컬럼 프리미티브 타입 매핑
+ *
+ * TypeScript 타입명(문자열) → 실제 TypeScript 타입 매핑
+ *
+ * @example
+ * ```typescript
+ * type StringType = ColumnPrimitiveMap["string"];  // string
+ * type DateTimeType = ColumnPrimitiveMap["DateTime"];  // DateTime
+ * ```
+ */
+export type ColumnPrimitiveMap = {
+    string: string;
+    number: number;
+    boolean: boolean;
+    DateTime: DateTime;
+    DateOnly: DateOnly;
+    Time: Time;
+    Uuid: Uuid;
+    Bytes: Bytes;
+};
+/**
+ * 컬럼 프리미티브 타입명 (문자열)
+ *
+ * @example
+ * ```typescript
+ * const typeStr: ColumnPrimitiveStr = "string";  // OK
+ * const typeStr2: ColumnPrimitiveStr = "invalid";  // Error
+ * ```
+ */
+export type ColumnPrimitiveStr = keyof ColumnPrimitiveMap;
+/**
+ * 컬럼에 저장 가능한 모든 프리미티브 타입
+ *
+ * undefined는 NULL을 나타냄
+ */
+export type ColumnPrimitive = ColumnPrimitiveMap[ColumnPrimitiveStr] | undefined;
+/**
+ * SQL DataType → TypeScript 타입명 매핑
+ *
+ * @example
+ * ```typescript
+ * const tsType = dataTypeStrToColumnPrimitiveStr["int"];  // "number"
+ * const tsType2 = dataTypeStrToColumnPrimitiveStr["datetime"];  // "DateTime"
+ * ```
+ */
+export declare const dataTypeStrToColumnPrimitiveStr: {
+    int: "number";
+    bigint: "number";
+    float: "number";
+    double: "number";
+    decimal: "number";
+    varchar: "string";
+    char: "string";
+    text: "string";
+    binary: "Bytes";
+    boolean: "boolean";
+    datetime: "DateTime";
+    date: "DateOnly";
+    time: "Time";
+    uuid: "Uuid";
+};
+/**
+ * DataType에서 TypeScript 타입 추론
+ *
+ * @template T - DataType
+ *
+ * @example
+ * ```typescript
+ * type IntType = InferColumnPrimitiveFromDataType<{ type: "int" }>;  // number
+ * type VarcharType = InferColumnPrimitiveFromDataType<{ type: "varchar"; length: 100 }>;  // string
+ * ```
+ */
+export type InferColumnPrimitiveFromDataType<T extends DataType> = ColumnPrimitiveMap[(typeof dataTypeStrToColumnPrimitiveStr)[T["type"]]];
+/**
+ * 런타임 값에서 ColumnPrimitiveStr 추론
+ *
+ * @param value - 컬럼 값
+ * @returns ColumnPrimitiveStr 타입명
+ * @throws 알 수 없는 값 타입인 경우
+ *
+ * @example
+ * ```typescript
+ * inferColumnPrimitiveStr("hello");  // "string"
+ * inferColumnPrimitiveStr(123);  // "number"
+ * inferColumnPrimitiveStr(new DateTime());  // "DateTime"
+ * ```
+ */
+export declare function inferColumnPrimitiveStr(value: ColumnPrimitive): ColumnPrimitiveStr;
+/**
+ * 컬럼 메타데이터
+ *
+ * ColumnBuilder에서 생성되어 TableBuilder에 전달
+ *
+ * @property type - TypeScript 타입명 (ColumnPrimitiveStr)
+ * @property dataType - SQL 데이터 타입
+ * @property autoIncrement - 자동 증가 여부
+ * @property nullable - NULL 허용 여부
+ * @property default - 기본값
+ * @property description - 컬럼 설명 (DDL 주석)
+ *
+ * @see {@link ColumnBuilder} 컬럼 빌더
+ */
+export interface ColumnMeta {
+    type: ColumnPrimitiveStr;
+    dataType: DataType;
+    autoIncrement?: boolean;
+    nullable?: boolean;
+    default?: ColumnPrimitive;
+    description?: string;
+}
+//# sourceMappingURL=column.d.ts.map

package/dist/orm-common/src/types/column.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"column.d.ts","sourceRoot":"","sources":["../../../../../orm-common/src/types/column.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAMnF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,MAAM,QAAQ,GAChB;IAAE,IAAI,EAAE,KAAK,CAAA;CAAE,GACf;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAClB;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GACjB;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAClB;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GACtD;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACnC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAChC;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAClB;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GACnB;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,GACpB;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAMrB;;;;;;;;;;GAUG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,EAAE,QAAQ,CAAC;IACnB,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,KAAK,CAAC;CACd,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,kBAAkB,CAAC;AAE1D;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,kBAAkB,CAAC,kBAAkB,CAAC,GAAG,SAAS,CAAC;AAMjF;;;;;;;;GAQG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;CAe3C,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,gCAAgC,CAAC,CAAC,SAAS,QAAQ,IAC7D,kBAAkB,CAAC,CAAC,OAAO,+BAA+B,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAE1E;;;;;;;;;;;;;GAaG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,eAAe,GAAG,kBAAkB,CAUlF;AAMD;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,kBAAkB,CAAC;IACzB,QAAQ,EAAE,QAAQ,CAAC;IACnB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}

package/dist/orm-common/src/types/db.d.ts

@@ -0,0 +1,175 @@
+import type { ColumnPrimitive, ColumnPrimitiveStr } from "./column";
+import type { QueryDef } from "./query-def";
+import type { DbContext } from "../db-context";
+/**
+ * 지원하는 데이터베이스 방언
+ *
+ * - `mysql`: MySQL 8.0.14+
+ * - `mssql`: Microsoft SQL Server 2012+
+ * - `postgresql`: PostgreSQL 9.0+
+ */
+export type Dialect = "mysql" | "mssql" | "postgresql";
+/**
+ * 지원하는 모든 데이터베이스 방언 목록
+ *
+ * 테스트에서 dialect별 검증 시 사용
+ *
+ * @example
+ * ```typescript
+ * it.each(dialects)("[%s] SQL 검증", (dialect) => {
+ *   const builder = createQueryBuilder(dialect);
+ *   expect(builder.build(def)).toMatchSql(expected[dialect]);
+ * });
+ * ```
+ */
+export declare const dialects: Dialect[];
+/**
+ * QueryBuilder.build() 반환 타입
+ *
+ * 빌드된 SQL 문자열과 다중 결과셋 처리를 위한 메타데이터
+ *
+ * @property sql - 빌드된 SQL 문자열
+ * @property resultSetIndex - 결과를 가져올 결과셋 인덱스 (기본: 0)
+ *   - MySQL INSERT with OUTPUT: 1 (INSERT + SELECT 중 SELECT)
+ * @property resultSetStride - 다중 결과에서 N번째마다 결과셋 추출
+ *   - 예: index=1, stride=2 → 1, 3, 5, 7... 의 결과셋 반환
+ *   - MySQL 다중 INSERT: INSERT;SELECT; × N → 1, 3, 5...
+ */
+export interface QueryBuildResult {
+    sql: string;
+    resultSetIndex?: number;
+    resultSetStride?: number;
+}
+/**
+ * 트랜잭션 격리 수준
+ *
+ * - `READ_UNCOMMITTED`: 커밋되지 않은 데이터 읽기 가능 (Dirty Read)
+ * - `READ_COMMITTED`: 커밋된 데이터만 읽기 (기본값)
+ * - `REPEATABLE_READ`: 트랜잭션 내 동일 쿼리 동일 결과 보장
+ * - `SERIALIZABLE`: 완전 직렬화 (가장 엄격)
+ */
+export type IsolationLevel = "READ_UNCOMMITTED" | "READ_COMMITTED" | "REPEATABLE_READ" | "SERIALIZABLE";
+/**
+ * 쿼리 결과 데이터 레코드 타입
+ *
+ * 재귀적 구조로 중첩 관계(include) 결과 표현
+ *
+ * @example
+ * ```typescript
+ * // 단순 레코드
+ * type User = { id: number; name: string; }
+ *
+ * // 중첩 관계 포함
+ * type UserWithPosts = {
+ *   id: number;
+ *   name: string;
+ *   posts: { id: number; title: string; }[]  // 1:N 관계
+ *   company: { id: number; name: string; }   // N:1 관계
+ * }
+ * ```
+ */
+export type DataRecord = {
+    [key: string]: ColumnPrimitive | DataRecord | DataRecord[];
+};
+/**
+ * DbContext 실행기 인터페이스
+ *
+ * 실제 DB 연결과 쿼리 실행을 담당
+ * NodeDbContextExecutor (서버) 또는 SdOrmServiceClientDbContextExecutor (클라이언트) 구현
+ *
+ * @example
+ * ```typescript
+ * // 서버 측 구현 예시
+ * class NodeDbContextExecutor implements IDbContextExecutor {
+ *   async connect(): Promise<void> {
+ *     await this.connection.connect();
+ *   }
+ *   // ...
+ * }
+ * ```
+ *
+ * @see {@link DbContext} DbContext에서 사용
+ */
+export interface DbContextExecutor {
+    /**
+     * DB 연결 수립
+     */
+    connect(): Promise<void>;
+    /**
+     * DB 연결 종료
+     */
+    close(): Promise<void>;
+    /**
+     * 트랜잭션 시작
+     *
+     * @param isolationLevel - 격리 수준 (선택)
+     */
+    beginTransaction(isolationLevel?: IsolationLevel): Promise<void>;
+    /**
+     * 트랜잭션 커밋
+     */
+    commitTransaction(): Promise<void>;
+    /**
+     * 트랜잭션 롤백
+     */
+    rollbackTransaction(): Promise<void>;
+    /**
+     * QueryDef 배열 실행
+     *
+     * @template T - 결과 레코드 타입
+     * @param defs - 실행할 QueryDef 배열
+     * @param resultMetas - 결과 변환을 위한 메타데이터 (선택)
+     * @returns 각 QueryDef별 결과 배열의 배열
+     */
+    executeDefs<T = DataRecord>(defs: QueryDef[], resultMetas?: (ResultMeta | undefined)[]): Promise<T[][]>;
+}
+/**
+ * 쿼리 결과 변환을 위한 메타데이터
+ *
+ * SELECT 결과를 TypeScript 객체로 변환 시 사용
+ *
+ * @property columns - 컬럼명 → ColumnPrimitiveStr 매핑
+ * @property joins - JOIN 별칭 → 단일/배열 여부
+ */
+export interface ResultMeta {
+    columns: Record<string, ColumnPrimitiveStr>;
+    joins: Record<string, {
+        isSingle: boolean;
+    }>;
+}
+/**
+ * 데이터베이스 마이그레이션 정의
+ *
+ * 스키마 변경을 버전 관리
+ *
+ * @property name - 마이그레이션 고유 이름 (타임스탬프 권장)
+ * @property up - 마이그레이션 실행 함수
+ *
+ * @example
+ * ```typescript
+ * const migrations: Migration[] = [
+ *   {
+ *     name: "20260105_001_create_user_table",
+ *     up: async (db) => {
+ *       await db.createTable(User);
+ *     },
+ *   },
+ *   {
+ *     name: "20260105_002_add_email_column",
+ *     up: async (db) => {
+ *       await db.addColumn(User, "email", {
+ *         type: "varchar",
+ *         length: 200,
+ *       });
+ *     },
+ *   },
+ * ];
+ * ```
+ *
+ * @see {@link DbContext.initialize} 마이그레이션 실행
+ */
+export interface Migration {
+    name: string;
+    up: (db: DbContext) => Promise<void>;
+}
+//# sourceMappingURL=db.d.ts.map

package/dist/orm-common/src/types/db.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"db.d.ts","sourceRoot":"","sources":["../../../../../orm-common/src/types/db.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AACpE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAM/C;;;;;;GAMG;AACH,MAAM,MAAM,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,YAAY,CAAC;AAEvD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,QAAQ,EAAE,OAAO,EAAqC,CAAC;AAEpE;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,GAAG,kBAAkB,GAAG,gBAAgB,GAAG,iBAAiB,GAAG,cAAc,CAAC;AAMxG;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,GAAG,UAAU,GAAG,UAAU,EAAE,CAAC;CAC5D,CAAC;AAMF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;;;OAIG;IACH,gBAAgB,CAAC,cAAc,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjE;;OAEG;IACH,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnC;;OAEG;IACH,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAErC;;;;;;;OAOG;IACH,WAAW,CAAC,CAAC,GAAG,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,WAAW,CAAC,EAAE,CAAC,UAAU,GAAG,SAAS,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;CACzG;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IAC5C,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,QAAQ,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;CAC9C;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,CAAC,EAAE,EAAE,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACtC"}