@pdg/drizzle-mysql 1.0.2 → 1.0.4

package/dist/index.cjs

@@ -211,15 +211,28 @@ for (const [method, policy] of Object.entries({
     });
 }
 const tablePolicies = new WeakMap();
+const tableMutationPolicies = new WeakMap();
 function getColumnPolicies(table) {
     return tablePolicies.get(table) ?? {};
 }
-function mysqlTable(name, columns, extraConfig) {
+function getTablePolicy(table) {
+    return tableMutationPolicies.get(table) ?? {};
+}
+function mysqlTable(name, columns, extraConfigOrPolicy, policy) {
+    const extraConfig = typeof extraConfigOrPolicy === 'function' ? extraConfigOrPolicy : undefined;
+    const mutationPolicy = typeof extraConfigOrPolicy === 'object' ? extraConfigOrPolicy : policy;
+    const nativeExtraConfig = extraConfig
+        ? (self) => {
+            const config = extraConfig(self);
+            return Array.isArray(config) ? config : Object.values(config);
+        }
+        : undefined;
     let builders = {};
     const table = typeof columns === 'function'
-        ? mysqlCore.mysqlTable(name, (types) => (builders = columns(types)), extraConfig)
-        : mysqlCore.mysqlTable(name, (builders = columns), extraConfig);
+        ? mysqlCore.mysqlTable(name, (types) => (builders = columns(types)), nativeExtraConfig)
+        : mysqlCore.mysqlTable(name, (builders = columns), nativeExtraConfig);
     tablePolicies.set(table, Object.fromEntries(Object.entries(builders).map(([key, builder]) => [key, policies.get(builder) ?? {}])));
+    tableMutationPolicies.set(table, { ...mutationPolicy });
     return table;
 }/********************************************************************************************************************
  * MySqlQuery
@@ -406,18 +419,25 @@ class MySqlQuery {
             const auto = 'autoIncrement' in column && column.autoIncrement === true;
             const rule = operation === 'insert' ? policy.insert : policy.update;
             const primary = column.primary;
-            const blocked = !!policy.timestamp ||
+            const blocked = (operation === 'update' && policy.timestamp === 'created') ||
                 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) {
+            if (operation === 'update' &&
+                !blocked &&
+                rule === 'required' &&
+                policy.timestamp !== 'updated' &&
+                values[key] === undefined) {
                 throw new Error(`update: column "${key}" is required.`);
             }
-            if (policy.timestamp && (operation === 'insert' || policy.timestamp === 'updated')) {
+            if (policy.timestamp && values[key] === undefined && (operation === 'insert' || policy.timestamp === 'updated')) {
                 if (!generated) {
-                    timestamp = this.getTimestamp();
+                    const getTimestamp = this.getTimestamp ?? this.current.getTimestamp;
+                    if (!getTimestamp)
+                        throw new Error('timestamp generator is not configured');
+                    timestamp = getTimestamp();
                     generated = true;
                 }
                 values[key] = timestamp;
@@ -426,9 +446,9 @@ class MySqlQuery {
         return values;
     }
     /********************************************************************************************************************
-     * (PRIVATE) insertValues
+     * (PRIVATE) executeInsert
      * ******************************************************************************************************************/
-    async insertValues(value) {
+    async executeInsert(value) {
         const tx = this.getTx();
         const autoIncrementColumn = mysqlCore.getTableConfig(this.t).columns.find((column) => 'autoIncrement' in column && column.autoIncrement === true);
         const hasAutoIncrement = !!autoIncrementColumn;
@@ -455,15 +475,25 @@ class MySqlQuery {
             }
         }
     }
+    insertValues(values) {
+        return values;
+    }
+    /********************************************************************************************************************
+     * updateValues
+     * ******************************************************************************************************************/
+    updateValues(values) {
+        return values;
+    }
     add(value) {
         const items = Array.isArray(value) ? value : [value];
         const values = items.map((item) => this.prepareValues(item, 'insert'));
-        return this.insertValues((Array.isArray(value) ? values : values[0]));
+        return this.executeInsert((Array.isArray(value) ? values : values[0]));
     }
     /********************************************************************************************************************
      * edit
      * ******************************************************************************************************************/
     edit(set, where) {
+        this.assertMutationAllowed('update', 'edit');
         const condition = typeof where === 'function' ? where(this) : where;
         if (!native.is(condition, native.SQL)) {
             throw new Error('edit: a SQL where condition is required.');
@@ -478,12 +508,14 @@ class MySqlQuery {
      * editByPrimaryKey
      * ******************************************************************************************************************/
     editByPrimaryKey(set, key) {
+        this.assertMutationAllowed('update', 'editByPrimaryKey');
         return this.edit(set, this.primaryKeyCondition(key, 'editByPrimaryKey'));
     }
     /********************************************************************************************************************
      * remove
      * ******************************************************************************************************************/
     remove(where) {
+        this.assertMutationAllowed('delete', 'remove');
         const condition = typeof where === 'function' ? where(this) : where;
         if (!native.is(condition, native.SQL)) {
             throw new Error('remove: a SQL where condition is required.');
@@ -495,8 +527,15 @@ class MySqlQuery {
      * removeByPrimaryKey
      * ******************************************************************************************************************/
     removeByPrimaryKey(key) {
+        this.assertMutationAllowed('delete', 'removeByPrimaryKey');
         return this.remove(this.primaryKeyCondition(key, 'removeByPrimaryKey'));
     }
+    assertMutationAllowed(operation, method) {
+        const policy = getTablePolicy(this.t);
+        if (operation === 'update' ? policy.updateBlocked : policy.deleteBlocked) {
+            throw new Error(`${method}: ${operation} is blocked for table "${mysqlCore.getTableConfig(this.t).name}".`);
+        }
+    }
     /********************************************************************************************************************
      * eq
      * ******************************************************************************************************************/
@@ -623,7 +662,7 @@ const normalizeFields = (fields) => {
     const pool = mysql.createPool({ uri: options.url });
     const raw = mysql2.drizzle({ client: pool, relations: native.defineRelations(options.schema) });
     const context = new node_async_hooks.AsyncLocalStorage();
-    const current = () => context.getStore() ?? raw;
+    const current = Object.assign(() => context.getStore() ?? raw, { getTimestamp: options.getTimestamp });
     const trans = (callback) => {
         const parent = context.getStore();
         const execute = (tx) => context.run(tx, callback);
@@ -676,11 +715,7 @@ const normalizeFields = (fields) => {
         sqlString: (value) => (native.is(value, native.SQL) ? value : native.sql `${value}`).mapWith(String),
         sqlBoolean: (value) => (native.is(value, native.SQL) ? value : native.sql `${value}`).mapWith((v) => v === true || v === 1),
         current,
-        query: (table) => new MySqlQuery(table, current, () => {
-            if (!options.timestamp)
-                throw new Error('timestamp generator is not configured');
-            return options.timestamp();
-        }),
+        query: (table) => new MySqlQuery(table, current),
         trans,
         paginate,
         close: () => pool.end(),

package/dist/index.d.cts

@@ -2,7 +2,7 @@ import { drizzleMySql } from './drizzleMySql.cjs';
 export default drizzleMySql;
 export * from './@types/index.cjs';
 export * from './columns.cjs';
-export { mysqlTable } from './mysqlTable.cjs';
+export { mysqlTable, type TablePolicy } from './mysqlTable.cjs';
 export * from './conditions.cjs';
 export * from './drizzleMySql.cjs';
 export * from './MySqlQuery.cjs';

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import { drizzleMySql } from './drizzleMySql.js';
 export default drizzleMySql;
 export * from './@types/index.js';
 export * from './columns.js';
-export { mysqlTable } from './mysqlTable.js';
+export { mysqlTable, type TablePolicy } from './mysqlTable.js';
 export * from './conditions.js';
 export * from './drizzleMySql.js';
 export * from './MySqlQuery.js';

package/dist/index.esm.js

@@ -211,15 +211,28 @@ for (const [method, policy] of Object.entries({
     });
 }
 const tablePolicies = new WeakMap();
+const tableMutationPolicies = new WeakMap();
 function getColumnPolicies(table) {
     return tablePolicies.get(table) ?? {};
 }
-function mysqlTable(name, columns, extraConfig) {
+function getTablePolicy(table) {
+    return tableMutationPolicies.get(table) ?? {};
+}
+function mysqlTable(name, columns, extraConfigOrPolicy, policy) {
+    const extraConfig = typeof extraConfigOrPolicy === 'function' ? extraConfigOrPolicy : undefined;
+    const mutationPolicy = typeof extraConfigOrPolicy === 'object' ? extraConfigOrPolicy : policy;
+    const nativeExtraConfig = extraConfig
+        ? (self) => {
+            const config = extraConfig(self);
+            return Array.isArray(config) ? config : Object.values(config);
+        }
+        : undefined;
     let builders = {};
     const table = typeof columns === 'function'
-        ? mysqlTable$1(name, (types) => (builders = columns(types)), extraConfig)
-        : mysqlTable$1(name, (builders = columns), extraConfig);
+        ? mysqlTable$1(name, (types) => (builders = columns(types)), nativeExtraConfig)
+        : mysqlTable$1(name, (builders = columns), nativeExtraConfig);
     tablePolicies.set(table, Object.fromEntries(Object.entries(builders).map(([key, builder]) => [key, policies.get(builder) ?? {}])));
+    tableMutationPolicies.set(table, { ...mutationPolicy });
     return table;
 }/********************************************************************************************************************
  * MySqlQuery
@@ -406,18 +419,25 @@ class MySqlQuery {
             const auto = 'autoIncrement' in column && column.autoIncrement === true;
             const rule = operation === 'insert' ? policy.insert : policy.update;
             const primary = column.primary;
-            const blocked = !!policy.timestamp ||
+            const blocked = (operation === 'update' && policy.timestamp === 'created') ||
                 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) {
+            if (operation === 'update' &&
+                !blocked &&
+                rule === 'required' &&
+                policy.timestamp !== 'updated' &&
+                values[key] === undefined) {
                 throw new Error(`update: column "${key}" is required.`);
             }
-            if (policy.timestamp && (operation === 'insert' || policy.timestamp === 'updated')) {
+            if (policy.timestamp && values[key] === undefined && (operation === 'insert' || policy.timestamp === 'updated')) {
                 if (!generated) {
-                    timestamp = this.getTimestamp();
+                    const getTimestamp = this.getTimestamp ?? this.current.getTimestamp;
+                    if (!getTimestamp)
+                        throw new Error('timestamp generator is not configured');
+                    timestamp = getTimestamp();
                     generated = true;
                 }
                 values[key] = timestamp;
@@ -426,9 +446,9 @@ class MySqlQuery {
         return values;
     }
     /********************************************************************************************************************
-     * (PRIVATE) insertValues
+     * (PRIVATE) executeInsert
      * ******************************************************************************************************************/
-    async insertValues(value) {
+    async executeInsert(value) {
         const tx = this.getTx();
         const autoIncrementColumn = getTableConfig(this.t).columns.find((column) => 'autoIncrement' in column && column.autoIncrement === true);
         const hasAutoIncrement = !!autoIncrementColumn;
@@ -455,15 +475,25 @@ class MySqlQuery {
             }
         }
     }
+    insertValues(values) {
+        return values;
+    }
+    /********************************************************************************************************************
+     * updateValues
+     * ******************************************************************************************************************/
+    updateValues(values) {
+        return values;
+    }
     add(value) {
         const items = Array.isArray(value) ? value : [value];
         const values = items.map((item) => this.prepareValues(item, 'insert'));
-        return this.insertValues((Array.isArray(value) ? values : values[0]));
+        return this.executeInsert((Array.isArray(value) ? values : values[0]));
     }
     /********************************************************************************************************************
      * edit
      * ******************************************************************************************************************/
     edit(set, where) {
+        this.assertMutationAllowed('update', 'edit');
         const condition = typeof where === 'function' ? where(this) : where;
         if (!is(condition, SQL)) {
             throw new Error('edit: a SQL where condition is required.');
@@ -478,12 +508,14 @@ class MySqlQuery {
      * editByPrimaryKey
      * ******************************************************************************************************************/
     editByPrimaryKey(set, key) {
+        this.assertMutationAllowed('update', 'editByPrimaryKey');
         return this.edit(set, this.primaryKeyCondition(key, 'editByPrimaryKey'));
     }
     /********************************************************************************************************************
      * remove
      * ******************************************************************************************************************/
     remove(where) {
+        this.assertMutationAllowed('delete', 'remove');
         const condition = typeof where === 'function' ? where(this) : where;
         if (!is(condition, SQL)) {
             throw new Error('remove: a SQL where condition is required.');
@@ -495,8 +527,15 @@ class MySqlQuery {
      * removeByPrimaryKey
      * ******************************************************************************************************************/
     removeByPrimaryKey(key) {
+        this.assertMutationAllowed('delete', 'removeByPrimaryKey');
         return this.remove(this.primaryKeyCondition(key, 'removeByPrimaryKey'));
     }
+    assertMutationAllowed(operation, method) {
+        const policy = getTablePolicy(this.t);
+        if (operation === 'update' ? policy.updateBlocked : policy.deleteBlocked) {
+            throw new Error(`${method}: ${operation} is blocked for table "${getTableConfig(this.t).name}".`);
+        }
+    }
     /********************************************************************************************************************
      * eq
      * ******************************************************************************************************************/
@@ -623,7 +662,7 @@ const normalizeFields = (fields) => {
     const pool = mysql.createPool({ uri: options.url });
     const raw = drizzle({ client: pool, relations: defineRelations(options.schema) });
     const context = new AsyncLocalStorage();
-    const current = () => context.getStore() ?? raw;
+    const current = Object.assign(() => context.getStore() ?? raw, { getTimestamp: options.getTimestamp });
     const trans = (callback) => {
         const parent = context.getStore();
         const execute = (tx) => context.run(tx, callback);
@@ -676,11 +715,7 @@ const normalizeFields = (fields) => {
         sqlString: (value) => (is(value, SQL) ? value : sql `${value}`).mapWith(String),
         sqlBoolean: (value) => (is(value, SQL) ? value : sql `${value}`).mapWith((v) => v === true || v === 1),
         current,
-        query: (table) => new MySqlQuery(table, current, () => {
-            if (!options.timestamp)
-                throw new Error('timestamp generator is not configured');
-            return options.timestamp();
-        }),
+        query: (table) => new MySqlQuery(table, current),
         trans,
         paginate,
         close: () => pool.end(),

package/dist/mysqlTable.d.cts

@@ -8,8 +8,13 @@ export type ColumnPolicy = {
     update?: 'blocked' | 'allowed' | 'required';
     timestamp?: 'created' | 'updated';
 };
+export type TablePolicy = {
+    updateBlocked?: boolean;
+    deleteBlocked?: boolean;
+};
 declare const policyType: unique symbol;
 declare const tablePolicyType: unique symbol;
+declare const tableMutationPolicyType: unique symbol;
 type Mark<T, P extends ColumnPolicy> = T & {
     readonly [policyType]: P;
 };
@@ -46,7 +51,10 @@ type Policies<C> = {
 export type TablePolicies<T> = T extends {
     readonly [tablePolicyType]: infer P;
 } ? P : {};
-type TableResult<N extends string, C extends Record<string, ColumnBuilderBase>> = MySqlTableWithColumns<{
+export type TableMutationPolicy<T> = T extends {
+    readonly [tableMutationPolicyType]: infer P;
+} ? P : {};
+type TableResult<N extends string, C extends Record<string, ColumnBuilderBase>, P extends TablePolicy> = MySqlTableWithColumns<{
     name: N;
     schema: undefined;
     columns: BuildColumns<N, C, 'mysql'>;
@@ -54,7 +62,10 @@ type TableResult<N extends string, C extends Record<string, ColumnBuilderBase>>
     isAlias: false;
 }> & {
     readonly [tablePolicyType]: Policies<C>;
+    readonly [tableMutationPolicyType]: P;
 };
 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 declare function getTablePolicy(table: MySqlTable): TablePolicy;
+type ExtraConfig<N extends string, C extends Record<string, ColumnBuilderBase>> = (self: BuildColumns<N, C, 'mysql'>) => MySqlTableExtraConfig | (MySqlTableExtraConfigValue | MySqlTableExtraConfigValue[])[];
+export declare function mysqlTable<N extends string, C extends Record<string, ColumnBuilderBase>, const P extends TablePolicy = {}, const Q extends TablePolicy = {}>(name: N, columns: C | ((types: MySqlColumnBuilders) => C), extraConfigOrPolicy?: ExtraConfig<N, C> | (P & TablePolicy), policy?: Q & TablePolicy): TableResult<N, C, P & Q>;
 export {};

package/dist/mysqlTable.d.ts

@@ -8,8 +8,13 @@ export type ColumnPolicy = {
     update?: 'blocked' | 'allowed' | 'required';
     timestamp?: 'created' | 'updated';
 };
+export type TablePolicy = {
+    updateBlocked?: boolean;
+    deleteBlocked?: boolean;
+};
 declare const policyType: unique symbol;
 declare const tablePolicyType: unique symbol;
+declare const tableMutationPolicyType: unique symbol;
 type Mark<T, P extends ColumnPolicy> = T & {
     readonly [policyType]: P;
 };
@@ -46,7 +51,10 @@ type Policies<C> = {
 export type TablePolicies<T> = T extends {
     readonly [tablePolicyType]: infer P;
 } ? P : {};
-type TableResult<N extends string, C extends Record<string, ColumnBuilderBase>> = MySqlTableWithColumns<{
+export type TableMutationPolicy<T> = T extends {
+    readonly [tableMutationPolicyType]: infer P;
+} ? P : {};
+type TableResult<N extends string, C extends Record<string, ColumnBuilderBase>, P extends TablePolicy> = MySqlTableWithColumns<{
     name: N;
     schema: undefined;
     columns: BuildColumns<N, C, 'mysql'>;
@@ -54,7 +62,10 @@ type TableResult<N extends string, C extends Record<string, ColumnBuilderBase>>
     isAlias: false;
 }> & {
     readonly [tablePolicyType]: Policies<C>;
+    readonly [tableMutationPolicyType]: P;
 };
 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 declare function getTablePolicy(table: MySqlTable): TablePolicy;
+type ExtraConfig<N extends string, C extends Record<string, ColumnBuilderBase>> = (self: BuildColumns<N, C, 'mysql'>) => MySqlTableExtraConfig | (MySqlTableExtraConfigValue | MySqlTableExtraConfigValue[])[];
+export declare function mysqlTable<N extends string, C extends Record<string, ColumnBuilderBase>, const P extends TablePolicy = {}, const Q extends TablePolicy = {}>(name: N, columns: C | ((types: MySqlColumnBuilders) => C), extraConfigOrPolicy?: ExtraConfig<N, C> | (P & TablePolicy), policy?: Q & TablePolicy): TableResult<N, C, P & Q>;
 export {};

package/package.json

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