@pdg/drizzle-mysql 1.0.0 → 1.0.2

package/README.md

@@ -42,7 +42,7 @@ const db = drizzleMySql({
 const user = db.query(users);
 ```
 
-`drizzleMySql` 옵션은 `url`, `schema`, 선택 사항인 `timestamp`, `timestampColumns`입니다. `db.query(table)`은 해당 테이블에 맞춰 타입이 지정된 쿼리 객체를 반환합니다. 연결을 다 사용한 뒤 `await db.close()`로 커넥션 풀을 닫습니다.
+`drizzleMySql` 옵션은 `url`, `schema`, 선택 사항인 `timestamp`입니다. `db.query(table)`은 해당 테이블에 맞춰 타입이 지정된 쿼리 객체를 반환합니다. 연결을 다 사용한 뒤 `await db.close()`로 커넥션 풀을 닫습니다.
 
 ### 데이터 추가·수정·삭제
 
@@ -320,23 +320,25 @@ await db.trans(async () => {
 
 ### 생성·수정 시각
 
-시각 자동 입력 메서드를 사용하려면 `timestamp` 생성 함수를 설정합니다. 기본 컬럼 이름은 `created_at`과 `updated_at`이며, `timestampColumns`의 `createdAt`과 `updatedAt`으로 변경할 수 있습니다.
+컬럼 정책은 이 패키지에서 가져온 `mysqlTable`에 선언합니다. 자동 증가 컬럼은 기본적으로 등록과 수정이 금지되며, 각각 `insertAllowed()`와 `updateAllowed()`로 허용할 수 있습니다. `primaryKey()`로 지정한 컬럼도 기본적으로 수정이 금지되며, `updateAllowed()`를 명시해야 수정할 수 있습니다. 다른 컬럼은 `insertBlocked()`와 `updateBlocked()`로 금지하거나 `updateRequired()`로 수정 시 필수로 지정합니다. 금지된 값을 전달하거나 필수 수정 값을 누락하면 런타임에도 오류가 발생합니다.
 
 ```ts
-const dbWithTimestamp = drizzleMySql({
-  url: process.env.DATABASE_URL!,
-  schema: { users },
-  timestamp: () => new Date(),
-  timestampColumns: { createdAt: 'created_at', updatedAt: 'updated_at' },
-});
-const timestampedUser = dbWithTimestamp.query(users);
+import { drizzleMySql, mysqlTable, int, varchar, datetime } from '@pdg/drizzle-mysql';
 
-await timestampedUser.addWithCreatedAt({ name: '생성 시각 입력' });
-await timestampedUser.addWithCreatedUpdatedAt({ name: '생성·수정 시각 입력' });
-await timestampedUser.editWithUpdatedAtByPrimaryKey({ name: '수정 시각 갱신' }, id);
+const users = mysqlTable('users', {
+  id: int().autoincrement().primaryKey(),
+  name: varchar({ length: 50 }).notNull(),
+  locked: int().default(0).notNull().updateBlocked(),
+  created_at: datetime({ mode: 'string' }).notNull().createdAt(),
+  updated_at: datetime({ mode: 'string' }).notNull().updatedAt(),
+});
+const db = drizzleMySql({ url: process.env.DATABASE_URL!, schema: { users }, timestamp: () => new Date().toISOString() });
+const usersQuery = db.query(users);
+const id = await usersQuery.add({ name: '사용자' });
+await usersQuery.editByPrimaryKey({ name: '수정' }, id);
 ```
 
-시각 관련 메서드는 `addWithCreatedAt`, `addWithCreatedUpdatedAt`, `editWithUpdatedAt`, `editWithUpdatedAtByPrimaryKey`입니다. 직접 시각 값을 지정하는 대신 설정한 생성 함수의 값을 사용합니다.
+`createdAt()`은 등록 시, `updatedAt()`은 등록과 수정 시 `timestamp` 생성 함수의 값을 자동으로 넣습니다. 지정된 시각 컬럼은 직접 입력할 수 없으며 생성 함수를 설정하지 않으면 해당 작업에서 오류가 발생합니다. 컬럼의 데이터 형식에 맞는 값을 반환해야 합니다. 정책은 `MySqlQuery`에만 적용되며 `db.current()`의 원본 Drizzle 쿼리에는 적용되지 않습니다. `mysqlTableCreator`, `mysqlSchema` 또는 Drizzle에서 직접 가져온 `mysqlTable`은 컬럼 정책을 수집하지 않으므로 정책이 필요한 테이블에는 이 패키지의 `mysqlTable`을 사용합니다.
 
 ### 집계·SQL 표현식
 

package/dist/@types/MySqlInsertValues.d.cts

@@ -1,7 +1,16 @@
 import type { MySqlTable } from 'drizzle-orm/mysql-core/table';
 import type { MySqlInsertValue as InsertValue } from 'drizzle-orm/mysql-core/query-builders/insert';
-export type MySqlInsertValues<TTable extends MySqlTable, TBlocked extends keyof InsertValue<TTable> = never> = [
-    TBlocked
-] extends [never] ? InsertValue<TTable> : Omit<InsertValue<TTable>, TBlocked> & {
-    [P in TBlocked]?: never;
+import type { TablePolicies } from '../mysqlTable.cjs';
+type Blocked<T extends MySqlTable> = {
+    [K in keyof InsertValue<T>]: K extends keyof TablePolicies<T> ? TablePolicies<T>[K] extends {
+        timestamp: string;
+    } | {
+        insert: 'blocked';
+    } ? K : TablePolicies<T>[K] extends {
+        insert: 'allowed';
+    } ? never : K extends keyof T['_']['columns'] ? T['_']['columns'][K]['_']['isAutoincrement'] extends true ? K : never : never : K extends keyof T['_']['columns'] ? T['_']['columns'][K]['_']['isAutoincrement'] extends true ? K : never : never;
+}[keyof InsertValue<T>];
+export type MySqlInsertValues<T extends MySqlTable, B extends keyof InsertValue<T> = never> = Omit<InsertValue<T>, B | Blocked<T>> & {
+    [K in B | Blocked<T>]?: never;
 };
+export {};

package/dist/@types/MySqlInsertValues.d.ts

@@ -1,7 +1,16 @@
 import type { MySqlTable } from 'drizzle-orm/mysql-core/table';
 import type { MySqlInsertValue as InsertValue } from 'drizzle-orm/mysql-core/query-builders/insert';
-export type MySqlInsertValues<TTable extends MySqlTable, TBlocked extends keyof InsertValue<TTable> = never> = [
-    TBlocked
-] extends [never] ? InsertValue<TTable> : Omit<InsertValue<TTable>, TBlocked> & {
-    [P in TBlocked]?: never;
+import type { TablePolicies } from '../mysqlTable.js';
+type Blocked<T extends MySqlTable> = {
+    [K in keyof InsertValue<T>]: K extends keyof TablePolicies<T> ? TablePolicies<T>[K] extends {
+        timestamp: string;
+    } | {
+        insert: 'blocked';
+    } ? K : TablePolicies<T>[K] extends {
+        insert: 'allowed';
+    } ? never : K extends keyof T['_']['columns'] ? T['_']['columns'][K]['_']['isAutoincrement'] extends true ? K : never : never : K extends keyof T['_']['columns'] ? T['_']['columns'][K]['_']['isAutoincrement'] extends true ? K : never : never;
+}[keyof InsertValue<T>];
+export type MySqlInsertValues<T extends MySqlTable, B extends keyof InsertValue<T> = never> = Omit<InsertValue<T>, B | Blocked<T>> & {
+    [K in B | Blocked<T>]?: never;
 };
+export {};

package/dist/@types/MySqlUpdateValues.d.cts

@@ -1,7 +1,26 @@
 import type { MySqlTable } from 'drizzle-orm/mysql-core/table';
 import type { MySqlUpdateSetSource } from 'drizzle-orm/mysql-core/query-builders/update';
-export type MySqlUpdateValues<TTable extends MySqlTable, TBlocked extends keyof MySqlUpdateSetSource<TTable> = never, TRequired extends Exclude<keyof MySqlUpdateSetSource<TTable>, TBlocked> = never> = Omit<MySqlUpdateSetSource<TTable>, TBlocked | TRequired> & {
-    [P in TBlocked]?: never;
+import type { TablePolicies } from '../mysqlTable.cjs';
+type DefaultBlocked<T extends MySqlTable, K> = K extends keyof T['_']['columns'] ? T['_']['columns'][K]['_']['isPrimaryKey'] extends true ? K : T['_']['columns'][K]['_']['isAutoincrement'] extends true ? K : never : never;
+type Blocked<T extends MySqlTable> = {
+    [K in keyof MySqlUpdateSetSource<T>]-?: K extends keyof TablePolicies<T> ? TablePolicies<T>[K] extends {
+        timestamp: string;
+    } | {
+        update: 'blocked';
+    } ? K : TablePolicies<T>[K] extends {
+        update: 'allowed';
+    } ? never : K extends keyof T['_']['columns'] ? T['_']['columns'][K]['_']['isPrimaryKey'] extends true ? K : TablePolicies<T>[K] extends {
+        update: 'required';
+    } ? never : DefaultBlocked<T, K> : never : DefaultBlocked<T, K>;
+}[keyof MySqlUpdateSetSource<T>] & keyof MySqlUpdateSetSource<T>;
+type RequiredKeys<T extends MySqlTable> = {
+    [K in keyof MySqlUpdateSetSource<T>]-?: K extends keyof TablePolicies<T> ? TablePolicies<T>[K] extends {
+        update: 'required';
+    } ? K : never : never;
+}[keyof MySqlUpdateSetSource<T>] & keyof MySqlUpdateSetSource<T>;
+export type MySqlUpdateValues<T extends MySqlTable, B extends keyof MySqlUpdateSetSource<T> = never, R extends Exclude<keyof MySqlUpdateSetSource<T>, B | Blocked<T>> = never> = Omit<MySqlUpdateSetSource<T>, B | Blocked<T> | R | RequiredKeys<T>> & {
+    [K in B | Blocked<T>]?: never;
 } & {
-    [P in TRequired]-?: Exclude<MySqlUpdateSetSource<TTable>[P], undefined>;
+    [K in Exclude<R | RequiredKeys<T>, B | Blocked<T>>]-?: Exclude<MySqlUpdateSetSource<T>[K], undefined>;
 };
+export {};

package/dist/@types/MySqlUpdateValues.d.ts

@@ -1,7 +1,26 @@
 import type { MySqlTable } from 'drizzle-orm/mysql-core/table';
 import type { MySqlUpdateSetSource } from 'drizzle-orm/mysql-core/query-builders/update';
-export type MySqlUpdateValues<TTable extends MySqlTable, TBlocked extends keyof MySqlUpdateSetSource<TTable> = never, TRequired extends Exclude<keyof MySqlUpdateSetSource<TTable>, TBlocked> = never> = Omit<MySqlUpdateSetSource<TTable>, TBlocked | TRequired> & {
-    [P in TBlocked]?: never;
+import type { TablePolicies } from '../mysqlTable.js';
+type DefaultBlocked<T extends MySqlTable, K> = K extends keyof T['_']['columns'] ? T['_']['columns'][K]['_']['isPrimaryKey'] extends true ? K : T['_']['columns'][K]['_']['isAutoincrement'] extends true ? K : never : never;
+type Blocked<T extends MySqlTable> = {
+    [K in keyof MySqlUpdateSetSource<T>]-?: K extends keyof TablePolicies<T> ? TablePolicies<T>[K] extends {
+        timestamp: string;
+    } | {
+        update: 'blocked';
+    } ? K : TablePolicies<T>[K] extends {
+        update: 'allowed';
+    } ? never : K extends keyof T['_']['columns'] ? T['_']['columns'][K]['_']['isPrimaryKey'] extends true ? K : TablePolicies<T>[K] extends {
+        update: 'required';
+    } ? never : DefaultBlocked<T, K> : never : DefaultBlocked<T, K>;
+}[keyof MySqlUpdateSetSource<T>] & keyof MySqlUpdateSetSource<T>;
+type RequiredKeys<T extends MySqlTable> = {
+    [K in keyof MySqlUpdateSetSource<T>]-?: K extends keyof TablePolicies<T> ? TablePolicies<T>[K] extends {
+        update: 'required';
+    } ? K : never : never;
+}[keyof MySqlUpdateSetSource<T>] & keyof MySqlUpdateSetSource<T>;
+export type MySqlUpdateValues<T extends MySqlTable, B extends keyof MySqlUpdateSetSource<T> = never, R extends Exclude<keyof MySqlUpdateSetSource<T>, B | Blocked<T>> = never> = Omit<MySqlUpdateSetSource<T>, B | Blocked<T> | R | RequiredKeys<T>> & {
+    [K in B | Blocked<T>]?: never;
 } & {
-    [P in TRequired]-?: Exclude<MySqlUpdateSetSource<TTable>[P], undefined>;
+    [K in Exclude<R | RequiredKeys<T>, B | Blocked<T>>]-?: Exclude<MySqlUpdateSetSource<T>[K], undefined>;
 };
+export {};

package/dist/MySqlQuery.d.cts

@@ -8,18 +8,14 @@ import type { MySql2Database } from 'drizzle-orm/mysql2';
 /********************************************************************************************************************
  * MySqlQuery
  * ******************************************************************************************************************/
-export declare class MySqlQuery<TTable extends MySqlTable, IV extends MySqlInsertValues<TTable> = MySqlInsertValues<TTable>, UV extends MySqlUpdateValues<TTable> = MySqlUpdateValues<TTable>, TCreatedAt extends string = 'created_at', TUpdatedAt extends string = 'updated_at', AR = AddResult<TTable>> {
+export declare class MySqlQuery<TTable extends MySqlTable, IV extends MySqlInsertValues<TTable> = MySqlInsertValues<TTable>, UV extends MySqlUpdateValues<TTable> = MySqlUpdateValues<TTable>, AR = AddResult<TTable>> {
     private readonly current;
     private readonly getTimestamp;
-    private readonly timestampColumns;
     readonly t: TTable;
     /********************************************************************************************************************
      * constructor
      * ******************************************************************************************************************/
-    constructor(table: TTable, current: () => MySql2Database, getTimestamp: () => any, timestampColumns?: {
-        createdAt?: TCreatedAt;
-        updatedAt?: TUpdatedAt;
-    });
+    constructor(table: TTable, current: () => MySql2Database, getTimestamp: () => any);
     private readonly drizzle;
     /********************************************************************************************************************
      * (PROTECTED) getTx
@@ -94,6 +90,7 @@ export declare class MySqlQuery<TTable extends MySqlTable, IV extends MySqlInser
      * count
      * ******************************************************************************************************************/
     count(where?: BaseWhere<this>): Promise<number>;
+    private prepareValues;
     /********************************************************************************************************************
      * (PRIVATE) insertValues
      * ******************************************************************************************************************/
@@ -103,16 +100,6 @@ export declare class MySqlQuery<TTable extends MySqlTable, IV extends MySqlInser
      * ******************************************************************************************************************/
     add(value: IV[]): Promise<AR[]>;
     add(value: IV): Promise<AR>;
-    /********************************************************************************************************************
-     * addWithCreatedAt
-     * ******************************************************************************************************************/
-    addWithCreatedAt(value: TimestampInput<IV, TCreatedAt, TUpdatedAt>[]): Promise<AR[]>;
-    addWithCreatedAt(value: TimestampInput<IV, TCreatedAt, TUpdatedAt>): Promise<AR>;
-    /********************************************************************************************************************
-     * addWithCreatedUpdatedAt
-     * ******************************************************************************************************************/
-    addWithCreatedUpdatedAt(value: TimestampInput<IV, TCreatedAt, TUpdatedAt>[]): Promise<AR[]>;
-    addWithCreatedUpdatedAt(value: TimestampInput<IV, TCreatedAt, TUpdatedAt>): Promise<AR>;
     /********************************************************************************************************************
      * edit
      * ******************************************************************************************************************/
@@ -121,18 +108,6 @@ export declare class MySqlQuery<TTable extends MySqlTable, IV extends MySqlInser
      * editByPrimaryKey
      * ******************************************************************************************************************/
     editByPrimaryKey(set: UV, key: PrimaryKeyInput<TTable>): Omit<import("drizzle-orm/mysql-core").MySqlAsyncUpdateBase<import("drizzle-orm").Assume<import("drizzle-orm").Assume<TTable, MySqlTable<import("drizzle-orm/mysql-core").TableConfig>>, MySqlTable<import("drizzle-orm/mysql-core").TableConfig>>, import("drizzle-orm/mysql2").MySql2QueryResultHKT, false, "where">, "where">;
-    /********************************************************************************************************************
-     * editWithUpdatedAt
-     * ******************************************************************************************************************/
-    editWithUpdatedAt(set: Omit<UV, TUpdatedAt> & {
-        [P in TUpdatedAt]?: never;
-    }, where: BaseWhere<this>): Omit<import("drizzle-orm/mysql-core").MySqlAsyncUpdateBase<import("drizzle-orm").Assume<import("drizzle-orm").Assume<TTable, MySqlTable<import("drizzle-orm/mysql-core").TableConfig>>, MySqlTable<import("drizzle-orm/mysql-core").TableConfig>>, import("drizzle-orm/mysql2").MySql2QueryResultHKT, false, "where">, "where">;
-    /********************************************************************************************************************
-     * editWithUpdatedAtByPrimaryKey
-     * ******************************************************************************************************************/
-    editWithUpdatedAtByPrimaryKey(set: Omit<UV, TUpdatedAt> & {
-        [P in TUpdatedAt]?: never;
-    }, key: PrimaryKeyInput<TTable>): Omit<import("drizzle-orm/mysql-core").MySqlAsyncUpdateBase<import("drizzle-orm").Assume<import("drizzle-orm").Assume<TTable, MySqlTable<import("drizzle-orm/mysql-core").TableConfig>>, MySqlTable<import("drizzle-orm/mysql-core").TableConfig>>, import("drizzle-orm/mysql2").MySql2QueryResultHKT, false, "where">, "where">;
     /********************************************************************************************************************
      * remove
      * ******************************************************************************************************************/
@@ -257,8 +232,5 @@ type AutoIncrementKeys<TTable extends MySqlTable> = {
     } ? P : never;
 }[keyof TTable['_']['columns']];
 type HasAutoIncrement<TTable extends MySqlTable> = [AutoIncrementKeys<TTable>] extends [never] ? false : true;
-type TimestampInput<T, C extends string, U extends string> = Omit<T, C | U> & {
-    [P in C | U]?: never;
-};
 type AddResult<TTable extends MySqlTable> = HasAutoIncrement<TTable> extends true ? number : undefined;
 export {};

package/dist/MySqlQuery.d.ts

@@ -8,18 +8,14 @@ import type { MySql2Database } from 'drizzle-orm/mysql2';
 /********************************************************************************************************************
  * MySqlQuery
  * ******************************************************************************************************************/
-export declare class MySqlQuery<TTable extends MySqlTable, IV extends MySqlInsertValues<TTable> = MySqlInsertValues<TTable>, UV extends MySqlUpdateValues<TTable> = MySqlUpdateValues<TTable>, TCreatedAt extends string = 'created_at', TUpdatedAt extends string = 'updated_at', AR = AddResult<TTable>> {
+export declare class MySqlQuery<TTable extends MySqlTable, IV extends MySqlInsertValues<TTable> = MySqlInsertValues<TTable>, UV extends MySqlUpdateValues<TTable> = MySqlUpdateValues<TTable>, AR = AddResult<TTable>> {
     private readonly current;
     private readonly getTimestamp;
-    private readonly timestampColumns;
     readonly t: TTable;
     /********************************************************************************************************************
      * constructor
      * ******************************************************************************************************************/
-    constructor(table: TTable, current: () => MySql2Database, getTimestamp: () => any, timestampColumns?: {
-        createdAt?: TCreatedAt;
-        updatedAt?: TUpdatedAt;
-    });
+    constructor(table: TTable, current: () => MySql2Database, getTimestamp: () => any);
     private readonly drizzle;
     /********************************************************************************************************************
      * (PROTECTED) getTx
@@ -94,6 +90,7 @@ export declare class MySqlQuery<TTable extends MySqlTable, IV extends MySqlInser
      * count
      * ******************************************************************************************************************/
     count(where?: BaseWhere<this>): Promise<number>;
+    private prepareValues;
     /********************************************************************************************************************
      * (PRIVATE) insertValues
      * ******************************************************************************************************************/
@@ -103,16 +100,6 @@ export declare class MySqlQuery<TTable extends MySqlTable, IV extends MySqlInser
      * ******************************************************************************************************************/
     add(value: IV[]): Promise<AR[]>;
     add(value: IV): Promise<AR>;
-    /********************************************************************************************************************
-     * addWithCreatedAt
-     * ******************************************************************************************************************/
-    addWithCreatedAt(value: TimestampInput<IV, TCreatedAt, TUpdatedAt>[]): Promise<AR[]>;
-    addWithCreatedAt(value: TimestampInput<IV, TCreatedAt, TUpdatedAt>): Promise<AR>;
-    /********************************************************************************************************************
-     * addWithCreatedUpdatedAt
-     * ******************************************************************************************************************/
-    addWithCreatedUpdatedAt(value: TimestampInput<IV, TCreatedAt, TUpdatedAt>[]): Promise<AR[]>;
-    addWithCreatedUpdatedAt(value: TimestampInput<IV, TCreatedAt, TUpdatedAt>): Promise<AR>;
     /********************************************************************************************************************
      * edit
      * ******************************************************************************************************************/
@@ -121,18 +108,6 @@ export declare class MySqlQuery<TTable extends MySqlTable, IV extends MySqlInser
      * editByPrimaryKey
      * ******************************************************************************************************************/
     editByPrimaryKey(set: UV, key: PrimaryKeyInput<TTable>): Omit<import("drizzle-orm/mysql-core").MySqlAsyncUpdateBase<import("drizzle-orm").Assume<import("drizzle-orm").Assume<TTable, MySqlTable<import("drizzle-orm/mysql-core").TableConfig>>, MySqlTable<import("drizzle-orm/mysql-core").TableConfig>>, import("drizzle-orm/mysql2").MySql2QueryResultHKT, false, "where">, "where">;
-    /********************************************************************************************************************
-     * editWithUpdatedAt
-     * ******************************************************************************************************************/
-    editWithUpdatedAt(set: Omit<UV, TUpdatedAt> & {
-        [P in TUpdatedAt]?: never;
-    }, where: BaseWhere<this>): Omit<import("drizzle-orm/mysql-core").MySqlAsyncUpdateBase<import("drizzle-orm").Assume<import("drizzle-orm").Assume<TTable, MySqlTable<import("drizzle-orm/mysql-core").TableConfig>>, MySqlTable<import("drizzle-orm/mysql-core").TableConfig>>, import("drizzle-orm/mysql2").MySql2QueryResultHKT, false, "where">, "where">;
-    /********************************************************************************************************************
-     * editWithUpdatedAtByPrimaryKey
-     * ******************************************************************************************************************/
-    editWithUpdatedAtByPrimaryKey(set: Omit<UV, TUpdatedAt> & {
-        [P in TUpdatedAt]?: never;
-    }, key: PrimaryKeyInput<TTable>): Omit<import("drizzle-orm/mysql-core").MySqlAsyncUpdateBase<import("drizzle-orm").Assume<import("drizzle-orm").Assume<TTable, MySqlTable<import("drizzle-orm/mysql-core").TableConfig>>, MySqlTable<import("drizzle-orm/mysql-core").TableConfig>>, import("drizzle-orm/mysql2").MySql2QueryResultHKT, false, "where">, "where">;
     /********************************************************************************************************************
      * remove
      * ******************************************************************************************************************/
@@ -257,8 +232,5 @@ type AutoIncrementKeys<TTable extends MySqlTable> = {
     } ? P : never;
 }[keyof TTable['_']['columns']];
 type HasAutoIncrement<TTable extends MySqlTable> = [AutoIncrementKeys<TTable>] extends [never] ? false : true;
-type TimestampInput<T, C extends string, U extends string> = Omit<T, C | U> & {
-    [P in C | U]?: never;
-};
 type AddResult<TTable extends MySqlTable> = HasAutoIncrement<TTable> extends true ? number : undefined;
 export {};

package/dist/drizzleMySql.d.cts

@@ -4,14 +4,10 @@ import type { MySqlTable } from 'drizzle-orm/mysql-core';
 import * as native from 'drizzle-orm';
 import { TableColumns } from './columns.cjs';
 import { MySqlQuery } from './MySqlQuery.cjs';
-export declare function drizzleMySql<TSchema extends Record<string, MySqlTable>, TCreatedAt extends string = 'created_at', TUpdatedAt extends string = 'updated_at'>(options: {
+export declare function drizzleMySql<TSchema extends Record<string, MySqlTable>>(options: {
     url: string;
     schema: TSchema;
     timestamp?: () => unknown;
-    timestampColumns?: {
-        createdAt?: TCreatedAt;
-        updatedAt?: TUpdatedAt;
-    };
 }): {
     columns: typeof TableColumns;
     sql: typeof sql;
@@ -21,7 +17,7 @@ export declare function drizzleMySql<TSchema extends Record<string, MySqlTable>,
     current: () => (import("drizzle-orm/mysql2").MySql2Database<native.ExtractTablesWithRelations<{}, native.ExtractTablesFromSchema<TSchema>>> & {
         $client: mysql.Pool;
     }) | import("drizzle-orm/mysql-core").MySqlAsyncTransaction<import("drizzle-orm/mysql2").MySql2QueryResultHKT, native.ExtractTablesWithRelations<{}, native.ExtractTablesFromSchema<TSchema>>>;
-    query: <TTable extends TSchema[keyof TSchema]>(table: TTable) => MySqlQuery<TTable, ({ [Key in keyof TTable["_"]["columns"] & string as native.RequiredKeyOnly<Key, TTable["_"]["columns"][Key]>]: TTable["_"]["columns"][Key]["_"]["notNull"] extends true ? TTable["_"]["columns"][Key]["_"]["data"] : TTable["_"]["columns"][Key]["_"]["data"] | null; } & { [Key_1 in keyof TTable["_"]["columns"] & string as native.OptionalKeyOnly<Key_1, TTable["_"]["columns"][Key_1], false>]?: (TTable["_"]["columns"][Key_1]["_"]["notNull"] extends true ? TTable["_"]["columns"][Key_1]["_"]["data"] : TTable["_"]["columns"][Key_1]["_"]["data"] | null) | undefined; } extends infer T_1 ? { [K_1 in keyof T_1]: T_1[K_1]; } : never) extends infer T extends Record<string, any> ? { [K in keyof T as K]: SQL<unknown> | native.Placeholder<string, any> | T[K]; } : never, import("./@types.cjs").MySqlUpdateValues<TTable>, TCreatedAt, TUpdatedAt, ([{ [P in keyof TTable["_"]["columns"]]: TTable["_"]["columns"][P]["_"] extends {
+    query: <TTable extends TSchema[keyof TSchema]>(table: TTable) => MySqlQuery<TTable, import("./@types.cjs").MySqlInsertValues<TTable>, import("./@types.cjs").MySqlUpdateValues<TTable>, ([{ [P in keyof TTable["_"]["columns"]]: TTable["_"]["columns"][P]["_"] extends {
         isAutoincrement: true;
     } ? P : never; }[keyof TTable["_"]["columns"]]] extends [never] ? false : true) extends true ? number : undefined>;
     trans: <T>(callback: () => Promise<T>) => Promise<T>;

package/dist/drizzleMySql.d.ts

@@ -4,14 +4,10 @@ import type { MySqlTable } from 'drizzle-orm/mysql-core';
 import * as native from 'drizzle-orm';
 import { TableColumns } from './columns.js';
 import { MySqlQuery } from './MySqlQuery.js';
-export declare function drizzleMySql<TSchema extends Record<string, MySqlTable>, TCreatedAt extends string = 'created_at', TUpdatedAt extends string = 'updated_at'>(options: {
+export declare function drizzleMySql<TSchema extends Record<string, MySqlTable>>(options: {
     url: string;
     schema: TSchema;
     timestamp?: () => unknown;
-    timestampColumns?: {
-        createdAt?: TCreatedAt;
-        updatedAt?: TUpdatedAt;
-    };
 }): {
     columns: typeof TableColumns;
     sql: typeof sql;
@@ -21,7 +17,7 @@ export declare function drizzleMySql<TSchema extends Record<string, MySqlTable>,
     current: () => (import("drizzle-orm/mysql2").MySql2Database<native.ExtractTablesWithRelations<{}, native.ExtractTablesFromSchema<TSchema>>> & {
         $client: mysql.Pool;
     }) | import("drizzle-orm/mysql-core").MySqlAsyncTransaction<import("drizzle-orm/mysql2").MySql2QueryResultHKT, native.ExtractTablesWithRelations<{}, native.ExtractTablesFromSchema<TSchema>>>;
-    query: <TTable extends TSchema[keyof TSchema]>(table: TTable) => MySqlQuery<TTable, ({ [Key in keyof TTable["_"]["columns"] & string as native.RequiredKeyOnly<Key, TTable["_"]["columns"][Key]>]: TTable["_"]["columns"][Key]["_"]["notNull"] extends true ? TTable["_"]["columns"][Key]["_"]["data"] : TTable["_"]["columns"][Key]["_"]["data"] | null; } & { [Key_1 in keyof TTable["_"]["columns"] & string as native.OptionalKeyOnly<Key_1, TTable["_"]["columns"][Key_1], false>]?: (TTable["_"]["columns"][Key_1]["_"]["notNull"] extends true ? TTable["_"]["columns"][Key_1]["_"]["data"] : TTable["_"]["columns"][Key_1]["_"]["data"] | null) | undefined; } extends infer T_1 ? { [K_1 in keyof T_1]: T_1[K_1]; } : never) extends infer T extends Record<string, any> ? { [K in keyof T as K]: SQL<unknown> | native.Placeholder<string, any> | T[K]; } : never, import("./@types.js").MySqlUpdateValues<TTable>, TCreatedAt, TUpdatedAt, ([{ [P in keyof TTable["_"]["columns"]]: TTable["_"]["columns"][P]["_"] extends {
+    query: <TTable extends TSchema[keyof TSchema]>(table: TTable) => MySqlQuery<TTable, import("./@types.js").MySqlInsertValues<TTable>, import("./@types.js").MySqlUpdateValues<TTable>, ([{ [P in keyof TTable["_"]["columns"]]: TTable["_"]["columns"][P]["_"] extends {
         isAutoincrement: true;
     } ? P : never; }[keyof TTable["_"]["columns"]]] extends [never] ? false : true) extends true ? number : undefined>;
     trans: <T>(callback: () => Promise<T>) => Promise<T>;

package/dist/index.cjs

@@ -1,4 +1,4 @@
-'use strict';Object.defineProperty(exports,'__esModule',{value:true});var mysql=require('mysql2/promise'),mysql2=require('drizzle-orm/mysql2'),native=require('drizzle-orm'),node_async_hooks=require('node:async_hooks'),alias=require('drizzle-orm/mysql-core/alias'),mysqlCore=require('drizzle-orm/mysql-core');function _interopNamespaceDefault(e){var n=Object.create(null);if(e){Object.keys(e).forEach(function(k){if(k!=='default'){var d=Object.getOwnPropertyDescriptor(e,k);Object.defineProperty(n,k,d.get?d:{enumerable:true,get:function(){return e[k]}});}})}n.default=e;return Object.freeze(n)}var native__namespace=/*#__PURE__*/_interopNamespaceDefault(native);function createAlias(schema) {
+'use strict';Object.defineProperty(exports,'__esModule',{value:true});var mysql=require('mysql2/promise'),mysql2=require('drizzle-orm/mysql2'),native=require('drizzle-orm'),node_async_hooks=require('node:async_hooks'),alias=require('drizzle-orm/mysql-core/alias'),mysqlCore=require('drizzle-orm/mysql-core'),columnBuilder=require('drizzle-orm/column-builder');function _interopNamespaceDefault(e){var n=Object.create(null);if(e){Object.keys(e).forEach(function(k){if(k!=='default'){var d=Object.getOwnPropertyDescriptor(e,k);Object.defineProperty(n,k,d.get?d:{enumerable:true,get:function(){return e[k]}});}})}n.default=e;return Object.freeze(n)}var native__namespace=/*#__PURE__*/_interopNamespaceDefault(native);function createAlias(schema) {
     /********************************************************************************************************************
      * getDefaultAlias
      * ******************************************************************************************************************/
@@ -192,22 +192,49 @@
             throw new Error('columns: expected a column object.');
         return [column.name, column];
     }));
+}const policies = new WeakMap();
+for (const [method, policy] of Object.entries({
+    insertBlocked: { insert: 'blocked' },
+    insertAllowed: { insert: 'allowed' },
+    updateBlocked: { update: 'blocked' },
+    updateAllowed: { update: 'allowed' },
+    updateRequired: { update: 'required' },
+    createdAt: { timestamp: 'created' },
+    updatedAt: { timestamp: 'updated' },
+})) {
+    Object.defineProperty(columnBuilder.ColumnBuilder.prototype, method, {
+        configurable: true,
+        value: function () {
+            policies.set(this, { ...policies.get(this), ...policy });
+            return this;
+        },
+    });
+}
+const tablePolicies = new WeakMap();
+function getColumnPolicies(table) {
+    return tablePolicies.get(table) ?? {};
+}
+function mysqlTable(name, columns, extraConfig) {
+    let builders = {};
+    const table = typeof columns === 'function'
+        ? mysqlCore.mysqlTable(name, (types) => (builders = columns(types)), extraConfig)
+        : mysqlCore.mysqlTable(name, (builders = columns), extraConfig);
+    tablePolicies.set(table, Object.fromEntries(Object.entries(builders).map(([key, builder]) => [key, policies.get(builder) ?? {}])));
+    return table;
 }/********************************************************************************************************************
  * MySqlQuery
  * ******************************************************************************************************************/
 class MySqlQuery {
     current;
     getTimestamp;
-    timestampColumns;
     // Table
     t;
     /********************************************************************************************************************
      * constructor
      * ******************************************************************************************************************/
-    constructor(table, current, getTimestamp, timestampColumns = {}) {
+    constructor(table, current, getTimestamp) {
         this.current = current;
         this.getTimestamp = getTimestamp;
-        this.timestampColumns = timestampColumns;
         this.t = table;
     }
     drizzle = { ...createConditions({}), sqlNumber: (value) => native.sql `${value}`.mapWith(Number) };
@@ -368,6 +395,36 @@ class MySqlQuery {
         const [{ cnt }] = await this.select({ cnt: native.count() }).where(condition);
         return cnt;
     }
+    prepareValues(input, operation) {
+        const values = { ...input };
+        const columns = native.getTableColumns(this.t);
+        const policies = getColumnPolicies(this.t);
+        let timestamp;
+        let generated = false;
+        for (const [key, column] of Object.entries(columns)) {
+            const policy = policies[key] ?? {};
+            const auto = 'autoIncrement' in column && column.autoIncrement === true;
+            const rule = operation === 'insert' ? policy.insert : policy.update;
+            const primary = column.primary;
+            const blocked = !!policy.timestamp ||
+                rule === 'blocked' ||
+                (operation === 'update' && primary && rule !== 'allowed') ||
+                (auto && rule !== 'allowed' && rule !== 'required');
+            if (blocked && Object.hasOwn(values, key))
+                throw new Error(`${operation}: column "${key}" is blocked.`);
+            if (operation === 'update' && !blocked && rule === 'required' && values[key] === undefined) {
+                throw new Error(`update: column "${key}" is required.`);
+            }
+            if (policy.timestamp && (operation === 'insert' || policy.timestamp === 'updated')) {
+                if (!generated) {
+                    timestamp = this.getTimestamp();
+                    generated = true;
+                }
+                values[key] = timestamp;
+            }
+        }
+        return values;
+    }
     /********************************************************************************************************************
      * (PRIVATE) insertValues
      * ******************************************************************************************************************/
@@ -399,26 +456,9 @@ class MySqlQuery {
         }
     }
     add(value) {
-        return this.insertValues(value);
-    }
-    addWithCreatedAt(value) {
-        const created_at = this.getTimestamp();
         const items = Array.isArray(value) ? value : [value];
-        const values = items.map((item) => ({
-            ...item,
-            [this.timestampColumns.createdAt ?? 'created_at']: created_at,
-        }));
-        return this.insertValues(Array.isArray(value) ? values : values[0]);
-    }
-    addWithCreatedUpdatedAt(value) {
-        const dateTime = this.getTimestamp();
-        const items = Array.isArray(value) ? value : [value];
-        const values = items.map((item) => ({
-            ...item,
-            [this.timestampColumns.createdAt ?? 'created_at']: dateTime,
-            [this.timestampColumns.updatedAt ?? 'updated_at']: dateTime,
-        }));
-        return this.insertValues(Array.isArray(value) ? values : values[0]);
+        const values = items.map((item) => this.prepareValues(item, 'insert'));
+        return this.insertValues((Array.isArray(value) ? values : values[0]));
     }
     /********************************************************************************************************************
      * edit
@@ -429,7 +469,10 @@ class MySqlQuery {
             throw new Error('edit: a SQL where condition is required.');
         }
         const tx = this.getTx();
-        return tx.update(this.t).set(set).where(condition);
+        return tx
+            .update(this.t)
+            .set(this.prepareValues(set, 'update'))
+            .where(condition);
     }
     /********************************************************************************************************************
      * editByPrimaryKey
@@ -437,27 +480,6 @@ class MySqlQuery {
     editByPrimaryKey(set, key) {
         return this.edit(set, this.primaryKeyCondition(key, 'editByPrimaryKey'));
     }
-    /********************************************************************************************************************
-     * editWithUpdatedAt
-     * ******************************************************************************************************************/
-    editWithUpdatedAt(set, where) {
-        const condition = typeof where === 'function' ? where(this) : where;
-        if (!native.is(condition, native.SQL)) {
-            throw new Error('editWithUpdatedAt: a SQL where condition is required.');
-        }
-        const tx = this.getTx();
-        const values = {
-            ...set,
-            [this.timestampColumns.updatedAt ?? 'updated_at']: this.getTimestamp(),
-        };
-        return tx.update(this.t).set(values).where(condition);
-    }
-    /********************************************************************************************************************
-     * editWithUpdatedAtByPrimaryKey
-     * ******************************************************************************************************************/
-    editWithUpdatedAtByPrimaryKey(set, key) {
-        return this.editWithUpdatedAt(set, this.primaryKeyCondition(key, 'editWithUpdatedAtByPrimaryKey'));
-    }
     /********************************************************************************************************************
      * remove
      * ******************************************************************************************************************/
@@ -658,9 +680,9 @@ const normalizeFields = (fields) => {
             if (!options.timestamp)
                 throw new Error('timestamp generator is not configured');
             return options.timestamp();
-        }, options.timestampColumns),
+        }),
         trans,
         paginate,
         close: () => pool.end(),
     };
-}Object.defineProperty(exports,"asc",{enumerable:true,get:function(){return native.asc}});Object.defineProperty(exports,"avg",{enumerable:true,get:function(){return native.avg}});Object.defineProperty(exports,"avgDistinct",{enumerable:true,get:function(){return native.avgDistinct}});Object.defineProperty(exports,"count",{enumerable:true,get:function(){return native.count}});Object.defineProperty(exports,"countDistinct",{enumerable:true,get:function(){return native.countDistinct}});Object.defineProperty(exports,"desc",{enumerable:true,get:function(){return native.desc}});Object.defineProperty(exports,"exists",{enumerable:true,get:function(){return native.exists}});Object.defineProperty(exports,"max",{enumerable:true,get:function(){return native.max}});Object.defineProperty(exports,"min",{enumerable:true,get:function(){return native.min}});Object.defineProperty(exports,"not",{enumerable:true,get:function(){return native.not}});Object.defineProperty(exports,"notExists",{enumerable:true,get:function(){return native.notExists}});Object.defineProperty(exports,"sum",{enumerable:true,get:function(){return native.sum}});Object.defineProperty(exports,"sumDistinct",{enumerable:true,get:function(){return native.sumDistinct}});Object.defineProperty(exports,"bigint",{enumerable:true,get:function(){return mysqlCore.bigint}});Object.defineProperty(exports,"binary",{enumerable:true,get:function(){return mysqlCore.binary}});Object.defineProperty(exports,"blob",{enumerable:true,get:function(){return mysqlCore.blob}});Object.defineProperty(exports,"boolean",{enumerable:true,get:function(){return mysqlCore.boolean}});Object.defineProperty(exports,"char",{enumerable:true,get:function(){return mysqlCore.char}});Object.defineProperty(exports,"check",{enumerable:true,get:function(){return mysqlCore.check}});Object.defineProperty(exports,"customType",{enumerable:true,get:function(){return mysqlCore.customType}});Object.defineProperty(exports,"date",{enumerable:true,get:function(){return mysqlCore.date}});Object.defineProperty(exports,"datetime",{enumerable:true,get:function(){return mysqlCore.datetime}});Object.defineProperty(exports,"decimal",{enumerable:true,get:function(){return mysqlCore.decimal}});Object.defineProperty(exports,"double",{enumerable:true,get:function(){return mysqlCore.double}});Object.defineProperty(exports,"float",{enumerable:true,get:function(){return mysqlCore.float}});Object.defineProperty(exports,"foreignKey",{enumerable:true,get:function(){return mysqlCore.foreignKey}});Object.defineProperty(exports,"index",{enumerable:true,get:function(){return mysqlCore.index}});Object.defineProperty(exports,"int",{enumerable:true,get:function(){return mysqlCore.int}});Object.defineProperty(exports,"json",{enumerable:true,get:function(){return mysqlCore.json}});Object.defineProperty(exports,"longblob",{enumerable:true,get:function(){return mysqlCore.longblob}});Object.defineProperty(exports,"longtext",{enumerable:true,get:function(){return mysqlCore.longtext}});Object.defineProperty(exports,"mediumblob",{enumerable:true,get:function(){return mysqlCore.mediumblob}});Object.defineProperty(exports,"mediumint",{enumerable:true,get:function(){return mysqlCore.mediumint}});Object.defineProperty(exports,"mediumtext",{enumerable:true,get:function(){return mysqlCore.mediumtext}});Object.defineProperty(exports,"mysqlDatabase",{enumerable:true,get:function(){return mysqlCore.mysqlDatabase}});Object.defineProperty(exports,"mysqlEnum",{enumerable:true,get:function(){return mysqlCore.mysqlEnum}});Object.defineProperty(exports,"mysqlSchema",{enumerable:true,get:function(){return mysqlCore.mysqlSchema}});Object.defineProperty(exports,"mysqlTable",{enumerable:true,get:function(){return mysqlCore.mysqlTable}});Object.defineProperty(exports,"mysqlTableCreator",{enumerable:true,get:function(){return mysqlCore.mysqlTableCreator}});Object.defineProperty(exports,"mysqlView",{enumerable:true,get:function(){return mysqlCore.mysqlView}});Object.defineProperty(exports,"primaryKey",{enumerable:true,get:function(){return mysqlCore.primaryKey}});Object.defineProperty(exports,"real",{enumerable:true,get:function(){return mysqlCore.real}});Object.defineProperty(exports,"serial",{enumerable:true,get:function(){return mysqlCore.serial}});Object.defineProperty(exports,"smallint",{enumerable:true,get:function(){return mysqlCore.smallint}});Object.defineProperty(exports,"text",{enumerable:true,get:function(){return mysqlCore.text}});Object.defineProperty(exports,"time",{enumerable:true,get:function(){return mysqlCore.time}});Object.defineProperty(exports,"timestamp",{enumerable:true,get:function(){return mysqlCore.timestamp}});Object.defineProperty(exports,"tinyblob",{enumerable:true,get:function(){return mysqlCore.tinyblob}});Object.defineProperty(exports,"tinyint",{enumerable:true,get:function(){return mysqlCore.tinyint}});Object.defineProperty(exports,"tinytext",{enumerable:true,get:function(){return mysqlCore.tinytext}});Object.defineProperty(exports,"unique",{enumerable:true,get:function(){return mysqlCore.unique}});Object.defineProperty(exports,"uniqueIndex",{enumerable:true,get:function(){return mysqlCore.uniqueIndex}});Object.defineProperty(exports,"varbinary",{enumerable:true,get:function(){return mysqlCore.varbinary}});Object.defineProperty(exports,"varchar",{enumerable:true,get:function(){return mysqlCore.varchar}});Object.defineProperty(exports,"year",{enumerable:true,get:function(){return mysqlCore.year}});exports.MySqlQuery=MySqlQuery;exports.TableColumns=TableColumns;exports.createConditions=createConditions;exports.default=drizzleMySql;exports.drizzleMySql=drizzleMySql;
+}Object.defineProperty(exports,"asc",{enumerable:true,get:function(){return native.asc}});Object.defineProperty(exports,"avg",{enumerable:true,get:function(){return native.avg}});Object.defineProperty(exports,"avgDistinct",{enumerable:true,get:function(){return native.avgDistinct}});Object.defineProperty(exports,"count",{enumerable:true,get:function(){return native.count}});Object.defineProperty(exports,"countDistinct",{enumerable:true,get:function(){return native.countDistinct}});Object.defineProperty(exports,"desc",{enumerable:true,get:function(){return native.desc}});Object.defineProperty(exports,"exists",{enumerable:true,get:function(){return native.exists}});Object.defineProperty(exports,"max",{enumerable:true,get:function(){return native.max}});Object.defineProperty(exports,"min",{enumerable:true,get:function(){return native.min}});Object.defineProperty(exports,"not",{enumerable:true,get:function(){return native.not}});Object.defineProperty(exports,"notExists",{enumerable:true,get:function(){return native.notExists}});Object.defineProperty(exports,"sum",{enumerable:true,get:function(){return native.sum}});Object.defineProperty(exports,"sumDistinct",{enumerable:true,get:function(){return native.sumDistinct}});Object.defineProperty(exports,"bigint",{enumerable:true,get:function(){return mysqlCore.bigint}});Object.defineProperty(exports,"binary",{enumerable:true,get:function(){return mysqlCore.binary}});Object.defineProperty(exports,"blob",{enumerable:true,get:function(){return mysqlCore.blob}});Object.defineProperty(exports,"boolean",{enumerable:true,get:function(){return mysqlCore.boolean}});Object.defineProperty(exports,"char",{enumerable:true,get:function(){return mysqlCore.char}});Object.defineProperty(exports,"check",{enumerable:true,get:function(){return mysqlCore.check}});Object.defineProperty(exports,"customType",{enumerable:true,get:function(){return mysqlCore.customType}});Object.defineProperty(exports,"date",{enumerable:true,get:function(){return mysqlCore.date}});Object.defineProperty(exports,"datetime",{enumerable:true,get:function(){return mysqlCore.datetime}});Object.defineProperty(exports,"decimal",{enumerable:true,get:function(){return mysqlCore.decimal}});Object.defineProperty(exports,"double",{enumerable:true,get:function(){return mysqlCore.double}});Object.defineProperty(exports,"float",{enumerable:true,get:function(){return mysqlCore.float}});Object.defineProperty(exports,"foreignKey",{enumerable:true,get:function(){return mysqlCore.foreignKey}});Object.defineProperty(exports,"index",{enumerable:true,get:function(){return mysqlCore.index}});Object.defineProperty(exports,"int",{enumerable:true,get:function(){return mysqlCore.int}});Object.defineProperty(exports,"json",{enumerable:true,get:function(){return mysqlCore.json}});Object.defineProperty(exports,"longblob",{enumerable:true,get:function(){return mysqlCore.longblob}});Object.defineProperty(exports,"longtext",{enumerable:true,get:function(){return mysqlCore.longtext}});Object.defineProperty(exports,"mediumblob",{enumerable:true,get:function(){return mysqlCore.mediumblob}});Object.defineProperty(exports,"mediumint",{enumerable:true,get:function(){return mysqlCore.mediumint}});Object.defineProperty(exports,"mediumtext",{enumerable:true,get:function(){return mysqlCore.mediumtext}});Object.defineProperty(exports,"mysqlDatabase",{enumerable:true,get:function(){return mysqlCore.mysqlDatabase}});Object.defineProperty(exports,"mysqlEnum",{enumerable:true,get:function(){return mysqlCore.mysqlEnum}});Object.defineProperty(exports,"mysqlSchema",{enumerable:true,get:function(){return mysqlCore.mysqlSchema}});Object.defineProperty(exports,"mysqlTableCreator",{enumerable:true,get:function(){return mysqlCore.mysqlTableCreator}});Object.defineProperty(exports,"mysqlView",{enumerable:true,get:function(){return mysqlCore.mysqlView}});Object.defineProperty(exports,"primaryKey",{enumerable:true,get:function(){return mysqlCore.primaryKey}});Object.defineProperty(exports,"real",{enumerable:true,get:function(){return mysqlCore.real}});Object.defineProperty(exports,"serial",{enumerable:true,get:function(){return mysqlCore.serial}});Object.defineProperty(exports,"smallint",{enumerable:true,get:function(){return mysqlCore.smallint}});Object.defineProperty(exports,"text",{enumerable:true,get:function(){return mysqlCore.text}});Object.defineProperty(exports,"time",{enumerable:true,get:function(){return mysqlCore.time}});Object.defineProperty(exports,"timestamp",{enumerable:true,get:function(){return mysqlCore.timestamp}});Object.defineProperty(exports,"tinyblob",{enumerable:true,get:function(){return mysqlCore.tinyblob}});Object.defineProperty(exports,"tinyint",{enumerable:true,get:function(){return mysqlCore.tinyint}});Object.defineProperty(exports,"tinytext",{enumerable:true,get:function(){return mysqlCore.tinytext}});Object.defineProperty(exports,"unique",{enumerable:true,get:function(){return mysqlCore.unique}});Object.defineProperty(exports,"uniqueIndex",{enumerable:true,get:function(){return mysqlCore.uniqueIndex}});Object.defineProperty(exports,"varbinary",{enumerable:true,get:function(){return mysqlCore.varbinary}});Object.defineProperty(exports,"varchar",{enumerable:true,get:function(){return mysqlCore.varchar}});Object.defineProperty(exports,"year",{enumerable:true,get:function(){return mysqlCore.year}});exports.MySqlQuery=MySqlQuery;exports.TableColumns=TableColumns;exports.createConditions=createConditions;exports.default=drizzleMySql;exports.drizzleMySql=drizzleMySql;exports.mysqlTable=mysqlTable;

package/dist/index.d.cts

@@ -2,8 +2,9 @@ import { drizzleMySql } from './drizzleMySql.cjs';
 export default drizzleMySql;
 export * from './@types/index.cjs';
 export * from './columns.cjs';
+export { mysqlTable } from './mysqlTable.cjs';
 export * from './conditions.cjs';
 export * from './drizzleMySql.cjs';
 export * from './MySqlQuery.cjs';
 export { asc, desc, count, countDistinct, avg, avgDistinct, sum, sumDistinct, max, min, not, exists, notExists, type InferColumnsDataTypes, } from 'drizzle-orm';
-export { mysqlTable, mysqlTableCreator, mysqlSchema, mysqlDatabase, mysqlView, bigint, binary, blob, boolean, char, customType, date, datetime, decimal, double, float, int, json, longblob, longtext, mediumblob, mediumint, mediumtext, mysqlEnum, real, serial, smallint, text, time, timestamp, tinyblob, tinyint, tinytext, varbinary, varchar, year, check, foreignKey, index, primaryKey, unique, uniqueIndex, } from 'drizzle-orm/mysql-core';
+export { mysqlTableCreator, mysqlSchema, mysqlDatabase, mysqlView, bigint, binary, blob, boolean, char, customType, date, datetime, decimal, double, float, int, json, longblob, longtext, mediumblob, mediumint, mediumtext, mysqlEnum, real, serial, smallint, text, time, timestamp, tinyblob, tinyint, tinytext, varbinary, varchar, year, check, foreignKey, index, primaryKey, unique, uniqueIndex, } from 'drizzle-orm/mysql-core';

package/dist/index.d.ts

@@ -2,8 +2,9 @@ import { drizzleMySql } from './drizzleMySql.js';
 export default drizzleMySql;
 export * from './@types/index.js';
 export * from './columns.js';
+export { mysqlTable } from './mysqlTable.js';
 export * from './conditions.js';
 export * from './drizzleMySql.js';
 export * from './MySqlQuery.js';
 export { asc, desc, count, countDistinct, avg, avgDistinct, sum, sumDistinct, max, min, not, exists, notExists, type InferColumnsDataTypes, } from 'drizzle-orm';
-export { mysqlTable, mysqlTableCreator, mysqlSchema, mysqlDatabase, mysqlView, bigint, binary, blob, boolean, char, customType, date, datetime, decimal, double, float, int, json, longblob, longtext, mediumblob, mediumint, mediumtext, mysqlEnum, real, serial, smallint, text, time, timestamp, tinyblob, tinyint, tinytext, varbinary, varchar, year, check, foreignKey, index, primaryKey, unique, uniqueIndex, } from 'drizzle-orm/mysql-core';
+export { mysqlTableCreator, mysqlSchema, mysqlDatabase, mysqlView, bigint, binary, blob, boolean, char, customType, date, datetime, decimal, double, float, int, json, longblob, longtext, mediumblob, mediumint, mediumtext, mysqlEnum, real, serial, smallint, text, time, timestamp, tinyblob, tinyint, tinytext, varbinary, varchar, year, check, foreignKey, index, primaryKey, unique, uniqueIndex, } from 'drizzle-orm/mysql-core';

package/dist/index.esm.js

@@ -1,4 +1,4 @@
-import mysql from'mysql2/promise';import {drizzle}from'drizzle-orm/mysql2';import*as native from'drizzle-orm';import {isTable,getTableColumns,sql,is,SQL,eq,and,count,defineRelations}from'drizzle-orm';export{asc,avg,avgDistinct,count,countDistinct,desc,exists,max,min,not,notExists,sum,sumDistinct}from'drizzle-orm';import {AsyncLocalStorage}from'node:async_hooks';import {alias}from'drizzle-orm/mysql-core/alias';import {MySqlTable,getTableConfig,MySqlColumn}from'drizzle-orm/mysql-core';export{bigint,binary,blob,boolean,char,check,customType,date,datetime,decimal,double,float,foreignKey,index,int,json,longblob,longtext,mediumblob,mediumint,mediumtext,mysqlDatabase,mysqlEnum,mysqlSchema,mysqlTable,mysqlTableCreator,mysqlView,primaryKey,real,serial,smallint,text,time,timestamp,tinyblob,tinyint,tinytext,unique,uniqueIndex,varbinary,varchar,year}from'drizzle-orm/mysql-core';function createAlias(schema) {
+import mysql from'mysql2/promise';import {drizzle}from'drizzle-orm/mysql2';import*as native from'drizzle-orm';import {isTable,getTableColumns,sql,is,SQL,eq,and,count,defineRelations}from'drizzle-orm';export{asc,avg,avgDistinct,count,countDistinct,desc,exists,max,min,not,notExists,sum,sumDistinct}from'drizzle-orm';import {AsyncLocalStorage}from'node:async_hooks';import {alias}from'drizzle-orm/mysql-core/alias';import {MySqlTable,mysqlTable as mysqlTable$1,getTableConfig,MySqlColumn}from'drizzle-orm/mysql-core';export{bigint,binary,blob,boolean,char,check,customType,date,datetime,decimal,double,float,foreignKey,index,int,json,longblob,longtext,mediumblob,mediumint,mediumtext,mysqlDatabase,mysqlEnum,mysqlSchema,mysqlTableCreator,mysqlView,primaryKey,real,serial,smallint,text,time,timestamp,tinyblob,tinyint,tinytext,unique,uniqueIndex,varbinary,varchar,year}from'drizzle-orm/mysql-core';import {ColumnBuilder}from'drizzle-orm/column-builder';function createAlias(schema) {
     /********************************************************************************************************************
      * getDefaultAlias
      * ******************************************************************************************************************/
@@ -192,22 +192,49 @@ import mysql from'mysql2/promise';import {drizzle}from'drizzle-orm/mysql2';impor
             throw new Error('columns: expected a column object.');
         return [column.name, column];
     }));
+}const policies = new WeakMap();
+for (const [method, policy] of Object.entries({
+    insertBlocked: { insert: 'blocked' },
+    insertAllowed: { insert: 'allowed' },
+    updateBlocked: { update: 'blocked' },
+    updateAllowed: { update: 'allowed' },
+    updateRequired: { update: 'required' },
+    createdAt: { timestamp: 'created' },
+    updatedAt: { timestamp: 'updated' },
+})) {
+    Object.defineProperty(ColumnBuilder.prototype, method, {
+        configurable: true,
+        value: function () {
+            policies.set(this, { ...policies.get(this), ...policy });
+            return this;
+        },
+    });
+}
+const tablePolicies = new WeakMap();
+function getColumnPolicies(table) {
+    return tablePolicies.get(table) ?? {};
+}
+function mysqlTable(name, columns, extraConfig) {
+    let builders = {};
+    const table = typeof columns === 'function'
+        ? mysqlTable$1(name, (types) => (builders = columns(types)), extraConfig)
+        : mysqlTable$1(name, (builders = columns), extraConfig);
+    tablePolicies.set(table, Object.fromEntries(Object.entries(builders).map(([key, builder]) => [key, policies.get(builder) ?? {}])));
+    return table;
 }/********************************************************************************************************************
  * MySqlQuery
  * ******************************************************************************************************************/
 class MySqlQuery {
     current;
     getTimestamp;
-    timestampColumns;
     // Table
     t;
     /********************************************************************************************************************
      * constructor
      * ******************************************************************************************************************/
-    constructor(table, current, getTimestamp, timestampColumns = {}) {
+    constructor(table, current, getTimestamp) {
         this.current = current;
         this.getTimestamp = getTimestamp;
-        this.timestampColumns = timestampColumns;
         this.t = table;
     }
     drizzle = { ...createConditions({}), sqlNumber: (value) => sql `${value}`.mapWith(Number) };
@@ -368,6 +395,36 @@ class MySqlQuery {
         const [{ cnt }] = await this.select({ cnt: count() }).where(condition);
         return cnt;
     }
+    prepareValues(input, operation) {
+        const values = { ...input };
+        const columns = getTableColumns(this.t);
+        const policies = getColumnPolicies(this.t);
+        let timestamp;
+        let generated = false;
+        for (const [key, column] of Object.entries(columns)) {
+            const policy = policies[key] ?? {};
+            const auto = 'autoIncrement' in column && column.autoIncrement === true;
+            const rule = operation === 'insert' ? policy.insert : policy.update;
+            const primary = column.primary;
+            const blocked = !!policy.timestamp ||
+                rule === 'blocked' ||
+                (operation === 'update' && primary && rule !== 'allowed') ||
+                (auto && rule !== 'allowed' && rule !== 'required');
+            if (blocked && Object.hasOwn(values, key))
+                throw new Error(`${operation}: column "${key}" is blocked.`);
+            if (operation === 'update' && !blocked && rule === 'required' && values[key] === undefined) {
+                throw new Error(`update: column "${key}" is required.`);
+            }
+            if (policy.timestamp && (operation === 'insert' || policy.timestamp === 'updated')) {
+                if (!generated) {
+                    timestamp = this.getTimestamp();
+                    generated = true;
+                }
+                values[key] = timestamp;
+            }
+        }
+        return values;
+    }
     /********************************************************************************************************************
      * (PRIVATE) insertValues
      * ******************************************************************************************************************/
@@ -399,26 +456,9 @@ class MySqlQuery {
         }
     }
     add(value) {
-        return this.insertValues(value);
-    }
-    addWithCreatedAt(value) {
-        const created_at = this.getTimestamp();
         const items = Array.isArray(value) ? value : [value];
-        const values = items.map((item) => ({
-            ...item,
-            [this.timestampColumns.createdAt ?? 'created_at']: created_at,
-        }));
-        return this.insertValues(Array.isArray(value) ? values : values[0]);
-    }
-    addWithCreatedUpdatedAt(value) {
-        const dateTime = this.getTimestamp();
-        const items = Array.isArray(value) ? value : [value];
-        const values = items.map((item) => ({
-            ...item,
-            [this.timestampColumns.createdAt ?? 'created_at']: dateTime,
-            [this.timestampColumns.updatedAt ?? 'updated_at']: dateTime,
-        }));
-        return this.insertValues(Array.isArray(value) ? values : values[0]);
+        const values = items.map((item) => this.prepareValues(item, 'insert'));
+        return this.insertValues((Array.isArray(value) ? values : values[0]));
     }
     /********************************************************************************************************************
      * edit
@@ -429,7 +469,10 @@ class MySqlQuery {
             throw new Error('edit: a SQL where condition is required.');
         }
         const tx = this.getTx();
-        return tx.update(this.t).set(set).where(condition);
+        return tx
+            .update(this.t)
+            .set(this.prepareValues(set, 'update'))
+            .where(condition);
     }
     /********************************************************************************************************************
      * editByPrimaryKey
@@ -437,27 +480,6 @@ class MySqlQuery {
     editByPrimaryKey(set, key) {
         return this.edit(set, this.primaryKeyCondition(key, 'editByPrimaryKey'));
     }
-    /********************************************************************************************************************
-     * editWithUpdatedAt
-     * ******************************************************************************************************************/
-    editWithUpdatedAt(set, where) {
-        const condition = typeof where === 'function' ? where(this) : where;
-        if (!is(condition, SQL)) {
-            throw new Error('editWithUpdatedAt: a SQL where condition is required.');
-        }
-        const tx = this.getTx();
-        const values = {
-            ...set,
-            [this.timestampColumns.updatedAt ?? 'updated_at']: this.getTimestamp(),
-        };
-        return tx.update(this.t).set(values).where(condition);
-    }
-    /********************************************************************************************************************
-     * editWithUpdatedAtByPrimaryKey
-     * ******************************************************************************************************************/
-    editWithUpdatedAtByPrimaryKey(set, key) {
-        return this.editWithUpdatedAt(set, this.primaryKeyCondition(key, 'editWithUpdatedAtByPrimaryKey'));
-    }
     /********************************************************************************************************************
      * remove
      * ******************************************************************************************************************/
@@ -658,9 +680,9 @@ const normalizeFields = (fields) => {
             if (!options.timestamp)
                 throw new Error('timestamp generator is not configured');
             return options.timestamp();
-        }, options.timestampColumns),
+        }),
         trans,
         paginate,
         close: () => pool.end(),
     };
-}export{MySqlQuery,TableColumns,createConditions,drizzleMySql as default,drizzleMySql};
+}export{MySqlQuery,TableColumns,createConditions,drizzleMySql as default,drizzleMySql,mysqlTable};

package/dist/mysqlTable.d.cts

@@ -0,0 +1,60 @@
+import { type ColumnBuilderBase } from 'drizzle-orm/column-builder';
+import { type MySqlTable, type MySqlTableWithColumns } from 'drizzle-orm/mysql-core';
+import type { BuildColumns } from 'drizzle-orm/column-builder';
+import type { MySqlColumnBuilders } from 'drizzle-orm/mysql-core/columns/all';
+import type { MySqlTableExtraConfig, MySqlTableExtraConfigValue } from 'drizzle-orm/mysql-core/table';
+export type ColumnPolicy = {
+    insert?: 'blocked' | 'allowed';
+    update?: 'blocked' | 'allowed' | 'required';
+    timestamp?: 'created' | 'updated';
+};
+declare const policyType: unique symbol;
+declare const tablePolicyType: unique symbol;
+type Mark<T, P extends ColumnPolicy> = T & {
+    readonly [policyType]: P;
+};
+declare module 'drizzle-orm/column-builder' {
+    interface ColumnBuilder<T, TRuntimeConfig, TExtraConfig> {
+        insertBlocked(): Mark<this, {
+            insert: 'blocked';
+        }>;
+        insertAllowed(): Mark<this, {
+            insert: 'allowed';
+        }>;
+        updateBlocked(): Mark<this, {
+            update: 'blocked';
+        }>;
+        updateAllowed(): Mark<this, {
+            update: 'allowed';
+        }>;
+        updateRequired(): Mark<this, {
+            update: 'required';
+        }>;
+        createdAt(): Mark<this, {
+            timestamp: 'created';
+        }>;
+        updatedAt(): Mark<this, {
+            timestamp: 'updated';
+        }>;
+    }
+}
+type Policies<C> = {
+    [K in keyof C]: C[K] extends {
+        readonly [policyType]: infer P;
+    } ? P : {};
+};
+export type TablePolicies<T> = T extends {
+    readonly [tablePolicyType]: infer P;
+} ? P : {};
+type TableResult<N extends string, C extends Record<string, ColumnBuilderBase>> = MySqlTableWithColumns<{
+    name: N;
+    schema: undefined;
+    columns: BuildColumns<N, C, 'mysql'>;
+    dialect: 'mysql';
+    isAlias: false;
+}> & {
+    readonly [tablePolicyType]: Policies<C>;
+};
+export declare function getColumnPolicies(table: MySqlTable): Record<string, ColumnPolicy>;
+export declare function mysqlTable<N extends string, C extends Record<string, ColumnBuilderBase>>(name: N, columns: C | ((types: MySqlColumnBuilders) => C), extraConfig?: (self: BuildColumns<N, C, 'mysql'>) => MySqlTableExtraConfig | (MySqlTableExtraConfigValue | MySqlTableExtraConfigValue[])[]): TableResult<N, C>;
+export {};

package/dist/mysqlTable.d.ts

@@ -0,0 +1,60 @@
+import { type ColumnBuilderBase } from 'drizzle-orm/column-builder';
+import { type MySqlTable, type MySqlTableWithColumns } from 'drizzle-orm/mysql-core';
+import type { BuildColumns } from 'drizzle-orm/column-builder';
+import type { MySqlColumnBuilders } from 'drizzle-orm/mysql-core/columns/all';
+import type { MySqlTableExtraConfig, MySqlTableExtraConfigValue } from 'drizzle-orm/mysql-core/table';
+export type ColumnPolicy = {
+    insert?: 'blocked' | 'allowed';
+    update?: 'blocked' | 'allowed' | 'required';
+    timestamp?: 'created' | 'updated';
+};
+declare const policyType: unique symbol;
+declare const tablePolicyType: unique symbol;
+type Mark<T, P extends ColumnPolicy> = T & {
+    readonly [policyType]: P;
+};
+declare module 'drizzle-orm/column-builder' {
+    interface ColumnBuilder<T, TRuntimeConfig, TExtraConfig> {
+        insertBlocked(): Mark<this, {
+            insert: 'blocked';
+        }>;
+        insertAllowed(): Mark<this, {
+            insert: 'allowed';
+        }>;
+        updateBlocked(): Mark<this, {
+            update: 'blocked';
+        }>;
+        updateAllowed(): Mark<this, {
+            update: 'allowed';
+        }>;
+        updateRequired(): Mark<this, {
+            update: 'required';
+        }>;
+        createdAt(): Mark<this, {
+            timestamp: 'created';
+        }>;
+        updatedAt(): Mark<this, {
+            timestamp: 'updated';
+        }>;
+    }
+}
+type Policies<C> = {
+    [K in keyof C]: C[K] extends {
+        readonly [policyType]: infer P;
+    } ? P : {};
+};
+export type TablePolicies<T> = T extends {
+    readonly [tablePolicyType]: infer P;
+} ? P : {};
+type TableResult<N extends string, C extends Record<string, ColumnBuilderBase>> = MySqlTableWithColumns<{
+    name: N;
+    schema: undefined;
+    columns: BuildColumns<N, C, 'mysql'>;
+    dialect: 'mysql';
+    isAlias: false;
+}> & {
+    readonly [tablePolicyType]: Policies<C>;
+};
+export declare function getColumnPolicies(table: MySqlTable): Record<string, ColumnPolicy>;
+export declare function mysqlTable<N extends string, C extends Record<string, ColumnBuilderBase>>(name: N, columns: C | ((types: MySqlColumnBuilders) => C), extraConfig?: (self: BuildColumns<N, C, 'mysql'>) => MySqlTableExtraConfig | (MySqlTableExtraConfigValue | MySqlTableExtraConfigValue[])[]): TableResult<N, C>;
+export {};

package/package.json

@@ -2,7 +2,7 @@
   "name": "@pdg/drizzle-mysql",
   "title": "Drizzle for MySql",
   "description": "Drizzle for MySql",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.esm.js",