@simplysm/orm-common 13.0.99 → 14.0.1

package/dist/schema/table-builder.js

@@ -1,208 +1,277 @@
-import {
-  createColumnFactory
-} from "./factory/column-builder.js";
+import { createColumnFactory, } from "./factory/column-builder.js";
 import { createIndexFactory } from "./factory/index-builder.js";
-import {
-  createRelationFactory
-} from "./factory/relation-builder.js";
-class TableBuilder {
-  /**
-   * @param meta - Table Metadata
-   * @param meta.name - Table name
-   * @param meta.description - Table description (comment)
-   * @param meta.database - Database name
-   * @param meta.schema - Schema name (MSSQL/PostgreSQL)
-   * @param meta.columns - Column definition
-   * @param meta.primaryKey - PK column array
-   * @param meta.relations - Relation definition
-   * @param meta.indexes - Index definition
-   */
-  constructor(meta) {
-    this.meta = meta;
-  }
-  /** Column definition (type for inference) */
-  $columns;
-  /** Relation definition (type for inference) */
-  $relations;
-  /** Full Type inference (column + relation) */
-  $inferSelect;
-  /** Column-only Type inference */
-  $inferColumns;
-  /** INSERT Type inference (autoIncrement excluded, nullable/default are optional) */
-  $inferInsert;
-  /** UPDATE Type inference (all fields optional) */
-  $inferUpdate;
-  /**
-   * Table set description
-   *
-   * @param desc - Table description (used as DDL Comment)
-   * @returns new TableBuilder instance
-   */
-  description(desc) {
-    return new TableBuilder({ ...this.meta, description: desc });
-  }
-  /**
-   * Database set name
-   *
-   * @param db - Database name
-   * @returns new TableBuilder instance
-   *
-   * @example
-   * ```typescript
-   * const User = Table("User").database("mydb");
-   * ```
-   */
-  database(db) {
-    return new TableBuilder({ ...this.meta, database: db });
-  }
-  /**
-   * schema set name
-   *
-   * Used in MSSQL, PostgreSQL
-   *
-   * @param schema - Schema name (MSSQL: dbo, PostgreSQL: public)
-   * @returns new TableBuilder instance
-   *
-   * @example
-   * ```typescript
-   * const User = Table("User")
-   *   .database("mydb")
-   *   .schema("custom_schema");
-   * ```
-   */
-  schema(schema) {
-    return new TableBuilder({ ...this.meta, schema });
-  }
-  /**
-   * Column definition
-   *
-   * Type-safe Column definition through column factory
-   *
-   * @template TNewColumnDefs - New Column definition type
-   * @param fn - Function that receives a Column factory and returns Column definitions
-   * @returns new TableBuilder instance
-   *
-   * @example
-   * ```typescript
-   * const User = Table("User")
-   *   .columns((c) => ({
-   *     id: c.bigint().autoIncrement(),
-   *     name: c.varchar(100),
-   *     email: c.varchar(200).nullable(),
-   *     createdAt: c.datetime().default("CURRENT_TIMESTAMP"),
-   *   }));
-   * ```
-   */
-  columns(fn) {
-    return new TableBuilder({
-      ...this.meta,
-      columns: fn(createColumnFactory())
-    });
-  }
-  /**
-   * Primary Key configuration
-   *
-   * @param columns - Column names composing the PK (composite PK supported)
-   * @returns new TableBuilder instance
-   *
-   * @example
-   * ```typescript
-   * // Single PK
-   * const User = Table("User")
-   *   .columns((c) => ({ id: c.bigint() }))
-   *   .primaryKey("id");
-   *
-   * // Composite PK
-   * const UserRole = Table("UserRole")
-   *   .columns((c) => ({
-   *     userId: c.bigint(),
-   *     roleId: c.bigint(),
-   *   }))
-   *   .primaryKey("userId", "roleId");
-   * ```
-   */
-  primaryKey(...columns) {
-    return new TableBuilder({
-      ...this.meta,
-      primaryKey: columns
-    });
-  }
-  /**
-   * Index definition
-   *
-   * @param fn - Function that receives an Index factory and returns an Index array
-   * @returns new TableBuilder instance
-   *
-   * @example
-   * ```typescript
-   * const User = Table("User")
-   *   .columns((c) => ({
-   *     id: c.bigint(),
-   *     email: c.varchar(200),
-   *     name: c.varchar(100),
-   *   }))
-   *   .indexes((i) => [
-   *     i.index("email").unique(),
-   *     i.index("name").orderBy("ASC"),
-   *   ]);
-   * ```
-   */
-  indexes(fn) {
-    return new TableBuilder({
-      ...this.meta,
-      indexes: fn(createIndexFactory())
-    });
-  }
-  /**
-   * Relation definition
-   *
-   * Set up FK, reverse-references, and other inter-Table relations
-   *
-   * @template T - Relation definition type
-   * @param fn - Function that receives a relation factory and returns relation definitions
-   * @returns new TableBuilder instance
-   *
-   * @example
-   * ```typescript
-   * const Post = Table("Post")
-   *   .columns((c) => ({
-   *     id: c.bigint().autoIncrement(),
-   *     authorId: c.bigint(),
-   *     title: c.varchar(200),
-   *   }))
-   *   .primaryKey("id")
-   *   .relations((r) => ({
-   *     // FK relation (N:1)
-   *     author: r.foreignKey(["authorId"], () => User),
-   *   }));
-   *
-   * const User = Table("User")
-   *   .columns((c) => ({
-   *     id: c.bigint().autoIncrement(),
-   *     name: c.varchar(100),
-   *   }))
-   *   .primaryKey("id")
-   *   .relations((r) => ({
-   *     // Reverse-reference (1:N)
-   *     posts: r.foreignKeyTarget(() => Post, "author"),
-   *   }));
-   * ```
-   *
-   * @see {@link ForeignKeyBuilder} FK builder
-   * @see {@link ForeignKeyTargetBuilder} FK reverse-reference builder
-   */
-  relations(fn) {
-    return new TableBuilder({
-      ...this.meta,
-      relations: fn(createRelationFactory(() => this))
-    });
-  }
+import { createRelationFactory, } from "./factory/relation-builder.js";
+// ============================================
+// TableBuilder
+// ============================================
+/**
+ * Database Table 정의 builder
+ *
+ * Fluent API로 Table column, PK, index, 관계를 정의
+ * DbContext의 queryable()과 함께 사용하여 타입 안전한 query 구성
+ *
+ * @template TColumns - Column 정의 레코드 타입
+ * @template TRelations - 관계 정의 레코드 타입
+ *
+ * @example
+ * ```typescript
+ * // Table definition
+ * const User = Table("User")
+ *   .database("mydb")
+ *   .columns((c) => ({
+ *     id: c.bigint().autoIncrement(),
+ *     name: c.varchar(100),
+ *     email: c.varchar(200).nullable(),
+ *     status: c.varchar(20).default("active"),
+ *   }))
+ *   .primaryKey("id")
+ *   .indexes((i) => [i.index("email").unique()]);
+ *
+ * // Used in DbContext
+ * class MyDb extends DbContext {
+ *   readonly user = queryable(this, User);
+ * }
+ * ```
+ *
+ * @see {@link Table} factory 함수
+ * @see {@link queryable} Queryable 생성
+ */
+export class TableBuilder {
+    meta;
+    /** Column 정의 (타입 추론용) */
+    $columns;
+    /** 관계 정의 (타입 추론용) */
+    $relations;
+    /** 전체 타입 추론 (column + 관계) */
+    $inferSelect;
+    /** Column 전용 타입 추론 */
+    $inferColumns;
+    /** INSERT 타입 추론 (autoIncrement 제외, nullable/default는 optional) */
+    $inferInsert;
+    /** UPDATE 타입 추론 (모든 필드 optional) */
+    $inferUpdate;
+    /**
+     * @param meta - Table 메타데이터
+     * @param meta.name - Table 이름
+     * @param meta.description - Table 설명 (comment)
+     * @param meta.database - Database 이름
+     * @param meta.schema - Schema 이름 (MSSQL/PostgreSQL)
+     * @param meta.columns - Column 정의
+     * @param meta.primaryKey - PK column 배열
+     * @param meta.relations - 관계 정의
+     * @param meta.indexes - Index 정의
+     */
+    constructor(meta) {
+        this.meta = meta;
+    }
+    /**
+     * Table 설명 설정
+     *
+     * @param desc - Table 설명 (DDL Comment로 사용됨)
+     * @returns 새 TableBuilder 인스턴스
+     */
+    description(desc) {
+        return new TableBuilder({ ...this.meta, description: desc });
+    }
+    /**
+     * Database 이름 설정
+     *
+     * @param db - Database 이름
+     * @returns 새 TableBuilder 인스턴스
+     *
+     * @example
+     * ```typescript
+     * const User = Table("User").database("mydb");
+     * ```
+     */
+    database(db) {
+        return new TableBuilder({ ...this.meta, database: db });
+    }
+    /**
+     * Schema 이름 설정
+     *
+     * MSSQL, PostgreSQL에서 사용
+     *
+     * @param schema - Schema 이름 (MSSQL: dbo, PostgreSQL: public)
+     * @returns 새 TableBuilder 인스턴스
+     *
+     * @example
+     * ```typescript
+     * const User = Table("User")
+     *   .database("mydb")
+     *   .schema("custom_schema");
+     * ```
+     */
+    schema(schema) {
+        return new TableBuilder({ ...this.meta, schema });
+    }
+    /**
+     * Column 정의
+     *
+     * Column factory를 통한 타입 안전한 column 정의
+     *
+     * @template TNewColumnDefs - 새 Column 정의 타입
+     * @param fn - Column factory를 받아 column 정의를 반환하는 함수
+     * @returns 새 TableBuilder 인스턴스
+     *
+     * @example
+     * ```typescript
+     * const User = Table("User")
+     *   .columns((c) => ({
+     *     id: c.bigint().autoIncrement(),
+     *     name: c.varchar(100),
+     *     email: c.varchar(200).nullable(),
+     *     createdAt: c.datetime().default("CURRENT_TIMESTAMP"),
+     *   }));
+     * ```
+     */
+    columns(fn) {
+        return new TableBuilder({
+            ...this.meta,
+            columns: fn(createColumnFactory()),
+        });
+    }
+    /**
+     * Primary Key 설정
+     *
+     * @param columns - PK를 구성하는 column 이름 (복합 PK 지원)
+     * @returns 새 TableBuilder 인스턴스
+     *
+     * @example
+     * ```typescript
+     * // 단일 PK
+     * const User = Table("User")
+     *   .columns((c) => ({ id: c.bigint() }))
+     *   .primaryKey("id");
+     *
+     * // 복합 PK
+     * const UserRole = Table("UserRole")
+     *   .columns((c) => ({
+     *     userId: c.bigint(),
+     *     roleId: c.bigint(),
+     *   }))
+     *   .primaryKey("userId", "roleId");
+     * ```
+     */
+    primaryKey(...columns) {
+        return new TableBuilder({
+            ...this.meta,
+            primaryKey: columns,
+        });
+    }
+    /**
+     * Index 정의
+     *
+     * @param fn - Index factory를 받아 index 배열을 반환하는 함수
+     * @returns 새 TableBuilder 인스턴스
+     *
+     * @example
+     * ```typescript
+     * const User = Table("User")
+     *   .columns((c) => ({
+     *     id: c.bigint(),
+     *     email: c.varchar(200),
+     *     name: c.varchar(100),
+     *   }))
+     *   .indexes((i) => [
+     *     i.index("email").unique(),
+     *     i.index("name").orderBy("ASC"),
+     *   ]);
+     * ```
+     */
+    indexes(fn) {
+        return new TableBuilder({
+            ...this.meta,
+            indexes: fn(createIndexFactory()),
+        });
+    }
+    /**
+     * 관계 정의
+     *
+     * FK, 역참조 등 Table 간 관계를 설정
+     *
+     * @template T - 관계 정의 타입
+     * @param fn - 관계 factory를 받아 관계 정의를 반환하는 함수
+     * @returns 새 TableBuilder 인스턴스
+     *
+     * @example
+     * ```typescript
+     * const Post = Table("Post")
+     *   .columns((c) => ({
+     *     id: c.bigint().autoIncrement(),
+     *     authorId: c.bigint(),
+     *     title: c.varchar(200),
+     *   }))
+     *   .primaryKey("id")
+     *   .relations((r) => ({
+     *     // FK relation (N:1)
+     *     author: r.foreignKey(["authorId"], () => User),
+     *   }));
+     *
+     * const User = Table("User")
+     *   .columns((c) => ({
+     *     id: c.bigint().autoIncrement(),
+     *     name: c.varchar(100),
+     *   }))
+     *   .primaryKey("id")
+     *   .relations((r) => ({
+     *     // Reverse-reference (1:N)
+     *     posts: r.foreignKeyTarget(() => Post, "author"),
+     *   }));
+     * ```
+     *
+     * @see {@link ForeignKeyBuilder} FK builder
+     * @see {@link ForeignKeyTargetBuilder} FK reverse-reference builder
+     */
+    relations(fn) {
+        return new TableBuilder({
+            ...this.meta,
+            relations: fn(createRelationFactory(() => this)),
+        });
+    }
 }
-function Table(name) {
-  return new TableBuilder({ name });
+// ============================================
+// Table 함수
+// ============================================
+/**
+ * Table builder factory 함수
+ *
+ * Fluent API로 Table schema를 정의하기 위한 TableBuilder를 생성
+ *
+ * @param name - Table 이름
+ * @returns TableBuilder 인스턴스
+ *
+ * @example
+ * ```typescript
+ * // Basic usage
+ * const User = Table("User")
+ *   .database("mydb")
+ *   .columns((c) => ({
+ *     id: c.bigint().autoIncrement(),
+ *     name: c.varchar(100),
+ *     email: c.varchar(200).nullable(),
+ *   }))
+ *   .primaryKey("id")
+ *   .indexes((i) => [i.index("email").unique()]);
+ *
+ * // With relations
+ * const Post = Table("Post")
+ *   .database("mydb")
+ *   .columns((c) => ({
+ *     id: c.bigint().autoIncrement(),
+ *     authorId: c.bigint(),
+ *     title: c.varchar(200),
+ *     content: c.text(),
+ *   }))
+ *   .primaryKey("id")
+ *   .relations((r) => ({
+ *     author: r.foreignKey(["authorId"], () => User),
+ *   }));
+ * ```
+ *
+ * @see {@link TableBuilder} builder 클래스
+ */
+export function Table(name) {
+    return new TableBuilder({ name });
 }
-export {
-  Table,
-  TableBuilder
-};
-//# sourceMappingURL=table-builder.js.map
+//# sourceMappingURL=table-builder.js.map

package/dist/schema/table-builder.js.map

@@ -1,6 +1 @@
-{
-  "version": 3,
-  "sources": ["../../src/schema/table-builder.ts"],
-  "mappings": "AAAA;AAAA,EAEE;AAAA,OAIK;AACP,SAAS,0BAA6C;AACtD;AAAA,EACE;AAAA,OAGK;AAsCA,MAAM,aAGX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA0BA,YACW,MAWT;AAXS;AAAA,EAWR;AAAA;AAAA,EApCM;AAAA;AAAA,EAEA;AAAA;AAAA,EAGA;AAAA;AAAA,EAEA;AAAA;AAAA,EAEA;AAAA;AAAA,EAEA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiCT,YAAY,MAAc;AACxB,WAAO,IAAI,aAAa,EAAE,GAAG,KAAK,MAAM,aAAa,KAAK,CAAC;AAAA,EAC7D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,SAAS,IAAY;AACnB,WAAO,IAAI,aAAa,EAAE,GAAG,KAAK,MAAM,UAAU,GAAG,CAAC;AAAA,EACxD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,OAAO,QAAgB;AACrB,WAAO,IAAI,aAAa,EAAE,GAAG,KAAK,MAAM,OAAO,CAAC;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,QACE,IACA;AACA,WAAO,IAAI,aAAyC;AAAA,MAClD,GAAG,KAAK;AAAA,MACR,SAAS,GAAG,oBAAoB,CAAC;AAAA,IACnC,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAwBA,cAAc,SAAsC;AAClD,WAAO,IAAI,aAAa;AAAA,MACtB,GAAG,KAAK;AAAA,MACR,YAAY;AAAA,IACd,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,QACE,IAGA;AACA,WAAO,IAAI,aAAa;AAAA,MACtB,GAAG,KAAK;AAAA,MACR,SAAS,GAAG,mBAA4C,CAAC;AAAA,IAC3D,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAwCA,UACE,IAC2B;AAC3B,WAAO,IAAI,aAAa;AAAA,MACtB,GAAG,KAAK;AAAA,MACR,WAAW,GAAG,sBAAqD,MAAM,IAAI,CAAC;AAAA,IAChF,CAAC;AAAA,EACH;AACF;AA4CO,SAAS,MAAM,MAAc;AAClC,SAAO,IAAI,aAAa,EAAE,KAAK,CAAC;AAClC;",
-  "names": []
-}
+{"version":3,"file":"table-builder.js","sourceRoot":"","sources":["..\\..\\src\\schema\\table-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,mBAAmB,GAIpB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,kBAAkB,EAAqB,MAAM,yBAAyB,CAAC;AAChF,OAAO,EACL,qBAAqB,GAGtB,MAAM,4BAA4B,CAAC;AAEpC,+CAA+C;AAC/C,eAAe;AACf,+CAA+C;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,OAAO,YAAY;IA8BZ;IA1BX,yBAAyB;IAChB,QAAQ,CAAY;IAC7B,qBAAqB;IACZ,UAAU,CAAc;IAEjC,6BAA6B;IACpB,YAAY,CAA2D;IAChF,sBAAsB;IACb,aAAa,CAA0B;IAChD,kEAAkE;IACzD,YAAY,CAAgC;IACrD,oCAAoC;IAC3B,YAAY,CAAgC;IAErD;;;;;;;;;;OAUG;IACH,YACW,IAUR;QAVQ,SAAI,GAAJ,IAAI,CAUZ;IACA,CAAC;IAEJ;;;;;OAKG;IACH,WAAW,CAAC,IAAY;QACtB,OAAO,IAAI,YAAY,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU;QACjB,OAAO,IAAI,YAAY,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,MAAc;QACnB,OAAO,IAAI,YAAY,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,OAAO,CACL,EAAiE;QAEjE,OAAO,IAAI,YAAY,CAA6B;YAClD,GAAG,IAAI,CAAC,IAAI;YACZ,OAAO,EAAE,EAAE,CAAC,mBAAmB,EAAE,CAAC;SACnC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,UAAU,CAAC,GAAG,OAAoC;QAChD,OAAO,IAAI,YAAY,CAAC;YACtB,GAAG,IAAI,CAAC,IAAI;YACZ,UAAU,EAAE,OAAO;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,OAAO,CACL,EAE6B;QAE7B,OAAO,IAAI,YAAY,CAAC;YACtB,GAAG,IAAI,CAAC,IAAI;YACZ,OAAO,EAAE,EAAE,CAAC,kBAAkB,EAA2B,CAAC;SAC3D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,SAAS,CACP,EAAqF;QAErF,OAAO,IAAI,YAAY,CAAC;YACtB,GAAG,IAAI,CAAC,IAAI;YACZ,SAAS,EAAE,EAAE,CAAC,qBAAqB,CAAgC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;SAChF,CAAC,CAAC;IACL,CAAC;CACF;AAED,+CAA+C;AAC/C,WAAW;AACX,+CAA+C;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,UAAU,KAAK,CAAC,IAAY;IAChC,OAAO,IAAI,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;AACpC,CAAC"}