@setupless/drizzle 0.3.0 → 0.4.0

package/README.md

@@ -7,14 +7,14 @@ npm install @setupless/drizzle drizzle-orm
 # or: bun add @setupless/drizzle drizzle-orm
 ```
 
-| Function       | Description                                     | Databases          |
-| -------------- | ----------------------------------------------- | ------------------ |
-| `id()`         | Auto-incrementing integer primary key           | PostgreSQL, SQLite |
-| `id("uuid")`   | Generated UUID primary key                      | PostgreSQL, SQLite |
-| `createdAt()`  | Timestamp with the current time as its default  | PostgreSQL, SQLite |
-| `updatedAt()`  | Timestamp set on insert and Drizzle-run updates | PostgreSQL, SQLite |
-| `deletedAt()`  | Nullable timestamp for soft deletion            | PostgreSQL, SQLite |
-| `timestamps()` | `createdAt()` and `updatedAt()` columns         | PostgreSQL, SQLite |
+| Function       | Description                                     | Databases                 |
+| -------------- | ----------------------------------------------- | ------------------------- |
+| `id()`         | Auto-incrementing integer primary key           | PostgreSQL, SQLite, MySQL |
+| `id("uuid")`   | Generated UUID primary key                      | PostgreSQL, SQLite, MySQL |
+| `createdAt()`  | Timestamp with the current time as its default  | PostgreSQL, SQLite, MySQL |
+| `updatedAt()`  | Timestamp set on insert and Drizzle-run updates | PostgreSQL, SQLite, MySQL |
+| `deletedAt()`  | Nullable timestamp for soft deletion            | PostgreSQL, SQLite, MySQL |
+| `timestamps()` | `createdAt()` and `updatedAt()` columns         | PostgreSQL, SQLite, MySQL |
 
 ```ts
 import { pgTable } from "drizzle-orm/pg-core";
@@ -27,8 +27,8 @@ export const users = pgTable("users", {
 });
 ```
 
-Import from `/sqlite` for SQLite. The package root also exports `pg` and
-`sqlite` namespaces. `updatedAt()` uses Drizzle's `$onUpdate` callback; it does
+Import from `/sqlite` for SQLite or `/mysql` for MySQL. The package root also
+exports `pg`, `sqlite`, and `mysql` namespaces. `updatedAt()` uses Drizzle's `$onUpdate` callback; it does
 not create a database trigger for updates made outside Drizzle.
 
 `deletedAt()` adds a nullable `deleted_at` column with no default or automatic
@@ -38,4 +38,29 @@ Queries must filter out soft-deleted rows explicitly.
 PostgreSQL timestamp helpers accept a `withTimezone` option. SQLite stores the
 timestamps as text and does not accept this option.
 
+MySQL helpers require MySQL 8.0.13+ and use `DATETIME(3)` with JavaScript `Date`
+values and millisecond precision. They do not accept `withTimezone`.
+`createdAt()` and `updatedAt()` default to `(utc_timestamp(3))`, and Drizzle
+updates use `utc_timestamp(3)`. These values stay in UTC regardless of the
+MySQL session timezone, matching Drizzle's UTC date mapping. Expression defaults
+require MySQL 8.0.13+ and a supporting storage engine such as InnoDB.
+
+`DATETIME` stores no timezone information. Pass JavaScript `Date` values through
+Drizzle when setting dates explicitly, including `deletedAt`. External writers
+must supply UTC values, for example with `UTC_TIMESTAMP(3)` rather than `NOW(3)`.
+
+```ts
+import { mysqlTable } from "drizzle-orm/mysql-core";
+import { deletedAt, id, timestamps } from "@setupless/drizzle/mysql";
+
+export const users = mysqlTable("users", {
+  ...id(),
+  ...timestamps(),
+  ...deletedAt(),
+});
+```
+
+MySQL `id("uuid")` uses `CHAR(36)` and generates UUIDs in Drizzle through
+`$defaultFn`. Inserts outside Drizzle must supply their own UUID.
+
 Licensed under [Apache 2.0](LICENSE).

package/dist/cjs/index.d.ts

@@ -1,2 +1,3 @@
+export * as mysql from "./mysql/index.js";
 export * as pg from "./pg/index.js";
 export * as sqlite from "./sqlite/index.js";

package/dist/cjs/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sqlite = exports.pg = void 0;
+exports.sqlite = exports.pg = exports.mysql = void 0;
+exports.mysql = require("./mysql/index.js");
 exports.pg = require("./pg/index.js");
 exports.sqlite = require("./sqlite/index.js");

package/dist/cjs/mysql/createdAt.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Defines a non-null `createdAt` DATETIME(3) column with a database default of
+ * `utc_timestamp(3)`, independent of the session timezone. Requires MySQL 8.0.13+.
+ */
+export default function createdAt(): {
+    createdAt: import("drizzle-orm").HasDefault<import("drizzle-orm").NotNull<import("drizzle-orm/mysql-core").MySqlDateTimeBuilderInitial<"created_at">>>;
+};

package/dist/cjs/mysql/createdAt.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = createdAt;
+const drizzle_orm_1 = require("drizzle-orm");
+const mysql_core_1 = require("drizzle-orm/mysql-core");
+/**
+ * Defines a non-null `createdAt` DATETIME(3) column with a database default of
+ * `utc_timestamp(3)`, independent of the session timezone. Requires MySQL 8.0.13+.
+ */
+function createdAt() {
+    return {
+        createdAt: (0, mysql_core_1.datetime)("created_at", { mode: "date", fsp: 3 })
+            .notNull()
+            .default((0, drizzle_orm_1.sql) `(utc_timestamp(3))`),
+    };
+}

package/dist/cjs/mysql/deletedAt.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Defines a nullable `deletedAt` DATETIME(3) column named `deleted_at` for soft deletion.
+ * Has no default or automatic update. Set the timestamp when deleting a row.
+ * Pass a JavaScript Date through Drizzle, or supply UTC values in raw SQL.
+ */
+export default function deletedAt(): {
+    deletedAt: import("drizzle-orm/mysql-core").MySqlDateTimeBuilderInitial<"deleted_at">;
+};

package/dist/cjs/mysql/deletedAt.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = deletedAt;
+const mysql_core_1 = require("drizzle-orm/mysql-core");
+/**
+ * Defines a nullable `deletedAt` DATETIME(3) column named `deleted_at` for soft deletion.
+ * Has no default or automatic update. Set the timestamp when deleting a row.
+ * Pass a JavaScript Date through Drizzle, or supply UTC values in raw SQL.
+ */
+function deletedAt() {
+    return {
+        deletedAt: (0, mysql_core_1.datetime)("deleted_at", { mode: "date", fsp: 3 }),
+    };
+}

package/dist/cjs/mysql/id.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Defines an `id` primary-key column.
+ *
+ * Drizzle generates UUID values in the application through `$defaultFn`.
+ */
+export default function id(strategy?: "auto" | "uuid"): {
+    id: import("drizzle-orm").IsAutoincrement<import("drizzle-orm").HasDefault<import("drizzle-orm").IsPrimaryKey<import("drizzle-orm").NotNull<import("drizzle-orm/mysql-core").MySqlIntBuilderInitial<"id">>>>>;
+} | {
+    id: import("drizzle-orm").HasRuntimeDefault<import("drizzle-orm").HasDefault<import("drizzle-orm").IsPrimaryKey<import("drizzle-orm").NotNull<import("drizzle-orm/mysql-core").MySqlCharBuilderInitial<"id", [string, ...string[]], 36>>>>>;
+};

package/dist/cjs/mysql/id.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = id;
+const mysql_core_1 = require("drizzle-orm/mysql-core");
+/**
+ * Defines an `id` primary-key column.
+ *
+ * Drizzle generates UUID values in the application through `$defaultFn`.
+ */
+function id(strategy = "auto") {
+    switch (strategy) {
+        case "auto":
+            return { id: (0, mysql_core_1.int)("id").primaryKey().autoincrement() };
+        case "uuid":
+            return {
+                id: (0, mysql_core_1.char)("id", { length: 36 })
+                    .primaryKey()
+                    .$defaultFn(() => crypto.randomUUID()),
+            };
+    }
+}

package/dist/cjs/mysql/index.d.ts

@@ -0,0 +1,5 @@
+export { default as createdAt } from "./createdAt.js";
+export { default as deletedAt } from "./deletedAt.js";
+export { default as id } from "./id.js";
+export { default as timestamps } from "./timestamps.js";
+export { default as updatedAt } from "./updatedAt.js";

package/dist/cjs/mysql/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updatedAt = exports.timestamps = exports.id = exports.deletedAt = exports.createdAt = void 0;
+var createdAt_js_1 = require("./createdAt.js");
+Object.defineProperty(exports, "createdAt", { enumerable: true, get: function () { return createdAt_js_1.default; } });
+var deletedAt_js_1 = require("./deletedAt.js");
+Object.defineProperty(exports, "deletedAt", { enumerable: true, get: function () { return deletedAt_js_1.default; } });
+var id_js_1 = require("./id.js");
+Object.defineProperty(exports, "id", { enumerable: true, get: function () { return id_js_1.default; } });
+var timestamps_js_1 = require("./timestamps.js");
+Object.defineProperty(exports, "timestamps", { enumerable: true, get: function () { return timestamps_js_1.default; } });
+var updatedAt_js_1 = require("./updatedAt.js");
+Object.defineProperty(exports, "updatedAt", { enumerable: true, get: function () { return updatedAt_js_1.default; } });

package/dist/cjs/mysql/timestamps.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Defines non-null `createdAt` and `updatedAt` timestamp columns.
+ */
+export default function timestamps(): {
+    updatedAt: import("drizzle-orm").HasDefault<import("drizzle-orm").HasDefault<import("drizzle-orm").NotNull<import("drizzle-orm/mysql-core/index.js").MySqlDateTimeBuilderInitial<"updated_at">>>>;
+    createdAt: import("drizzle-orm").HasDefault<import("drizzle-orm").NotNull<import("drizzle-orm/mysql-core/index.js").MySqlDateTimeBuilderInitial<"created_at">>>;
+};

package/dist/cjs/mysql/timestamps.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = timestamps;
+const createdAt_js_1 = require("./createdAt.js");
+const updatedAt_js_1 = require("./updatedAt.js");
+/**
+ * Defines non-null `createdAt` and `updatedAt` timestamp columns.
+ */
+function timestamps() {
+    return {
+        ...(0, createdAt_js_1.default)(),
+        ...(0, updatedAt_js_1.default)(),
+    };
+}

package/dist/cjs/mysql/updatedAt.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Defines a non-null `updatedAt` DATETIME(3) column. The database supplies the
+ * insert default, and Drizzle supplies UTC values for updates it executes.
+ * Requires MySQL 8.0.13+ for the UTC expression default.
+ */
+export default function updatedAt(): {
+    updatedAt: import("drizzle-orm").HasDefault<import("drizzle-orm").HasDefault<import("drizzle-orm").NotNull<import("drizzle-orm/mysql-core").MySqlDateTimeBuilderInitial<"updated_at">>>>;
+};

package/dist/cjs/mysql/updatedAt.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = updatedAt;
+const drizzle_orm_1 = require("drizzle-orm");
+const mysql_core_1 = require("drizzle-orm/mysql-core");
+/**
+ * Defines a non-null `updatedAt` DATETIME(3) column. The database supplies the
+ * insert default, and Drizzle supplies UTC values for updates it executes.
+ * Requires MySQL 8.0.13+ for the UTC expression default.
+ */
+function updatedAt() {
+    return {
+        updatedAt: (0, mysql_core_1.datetime)("updated_at", { mode: "date", fsp: 3 })
+            .notNull()
+            .default((0, drizzle_orm_1.sql) `(utc_timestamp(3))`)
+            .$onUpdate(() => (0, drizzle_orm_1.sql) `utc_timestamp(3)`),
+    };
+}

package/dist/index.d.ts

@@ -1,2 +1,3 @@
+export * as mysql from "./mysql/index.js";
 export * as pg from "./pg/index.js";
 export * as sqlite from "./sqlite/index.js";

package/dist/index.js

@@ -1,2 +1,3 @@
+export * as mysql from "./mysql/index.js";
 export * as pg from "./pg/index.js";
 export * as sqlite from "./sqlite/index.js";

package/dist/mysql/createdAt.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Defines a non-null `createdAt` DATETIME(3) column with a database default of
+ * `utc_timestamp(3)`, independent of the session timezone. Requires MySQL 8.0.13+.
+ */
+export default function createdAt(): {
+    createdAt: import("drizzle-orm").HasDefault<import("drizzle-orm").NotNull<import("drizzle-orm/mysql-core").MySqlDateTimeBuilderInitial<"created_at">>>;
+};

package/dist/mysql/createdAt.js

@@ -0,0 +1,13 @@
+import { sql } from "drizzle-orm";
+import { datetime } from "drizzle-orm/mysql-core";
+/**
+ * Defines a non-null `createdAt` DATETIME(3) column with a database default of
+ * `utc_timestamp(3)`, independent of the session timezone. Requires MySQL 8.0.13+.
+ */
+export default function createdAt() {
+    return {
+        createdAt: datetime("created_at", { mode: "date", fsp: 3 })
+            .notNull()
+            .default(sql `(utc_timestamp(3))`),
+    };
+}

package/dist/mysql/deletedAt.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Defines a nullable `deletedAt` DATETIME(3) column named `deleted_at` for soft deletion.
+ * Has no default or automatic update. Set the timestamp when deleting a row.
+ * Pass a JavaScript Date through Drizzle, or supply UTC values in raw SQL.
+ */
+export default function deletedAt(): {
+    deletedAt: import("drizzle-orm/mysql-core").MySqlDateTimeBuilderInitial<"deleted_at">;
+};

package/dist/mysql/deletedAt.js

@@ -0,0 +1,11 @@
+import { datetime } from "drizzle-orm/mysql-core";
+/**
+ * Defines a nullable `deletedAt` DATETIME(3) column named `deleted_at` for soft deletion.
+ * Has no default or automatic update. Set the timestamp when deleting a row.
+ * Pass a JavaScript Date through Drizzle, or supply UTC values in raw SQL.
+ */
+export default function deletedAt() {
+    return {
+        deletedAt: datetime("deleted_at", { mode: "date", fsp: 3 }),
+    };
+}

package/dist/mysql/id.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Defines an `id` primary-key column.
+ *
+ * Drizzle generates UUID values in the application through `$defaultFn`.
+ */
+export default function id(strategy?: "auto" | "uuid"): {
+    id: import("drizzle-orm").IsAutoincrement<import("drizzle-orm").HasDefault<import("drizzle-orm").IsPrimaryKey<import("drizzle-orm").NotNull<import("drizzle-orm/mysql-core").MySqlIntBuilderInitial<"id">>>>>;
+} | {
+    id: import("drizzle-orm").HasRuntimeDefault<import("drizzle-orm").HasDefault<import("drizzle-orm").IsPrimaryKey<import("drizzle-orm").NotNull<import("drizzle-orm/mysql-core").MySqlCharBuilderInitial<"id", [string, ...string[]], 36>>>>>;
+};

package/dist/mysql/id.js

@@ -0,0 +1,18 @@
+import { char, int } from "drizzle-orm/mysql-core";
+/**
+ * Defines an `id` primary-key column.
+ *
+ * Drizzle generates UUID values in the application through `$defaultFn`.
+ */
+export default function id(strategy = "auto") {
+    switch (strategy) {
+        case "auto":
+            return { id: int("id").primaryKey().autoincrement() };
+        case "uuid":
+            return {
+                id: char("id", { length: 36 })
+                    .primaryKey()
+                    .$defaultFn(() => crypto.randomUUID()),
+            };
+    }
+}

package/dist/mysql/index.d.ts

@@ -0,0 +1,5 @@
+export { default as createdAt } from "./createdAt.js";
+export { default as deletedAt } from "./deletedAt.js";
+export { default as id } from "./id.js";
+export { default as timestamps } from "./timestamps.js";
+export { default as updatedAt } from "./updatedAt.js";

package/dist/mysql/index.js

@@ -0,0 +1,5 @@
+export { default as createdAt } from "./createdAt.js";
+export { default as deletedAt } from "./deletedAt.js";
+export { default as id } from "./id.js";
+export { default as timestamps } from "./timestamps.js";
+export { default as updatedAt } from "./updatedAt.js";

package/dist/mysql/timestamps.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Defines non-null `createdAt` and `updatedAt` timestamp columns.
+ */
+export default function timestamps(): {
+    updatedAt: import("drizzle-orm").HasDefault<import("drizzle-orm").HasDefault<import("drizzle-orm").NotNull<import("drizzle-orm/mysql-core").MySqlDateTimeBuilderInitial<"updated_at">>>>;
+    createdAt: import("drizzle-orm").HasDefault<import("drizzle-orm").NotNull<import("drizzle-orm/mysql-core").MySqlDateTimeBuilderInitial<"created_at">>>;
+};

package/dist/mysql/timestamps.js

@@ -0,0 +1,11 @@
+import createdAt from "./createdAt.js";
+import updatedAt from "./updatedAt.js";
+/**
+ * Defines non-null `createdAt` and `updatedAt` timestamp columns.
+ */
+export default function timestamps() {
+    return {
+        ...createdAt(),
+        ...updatedAt(),
+    };
+}

package/dist/mysql/updatedAt.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Defines a non-null `updatedAt` DATETIME(3) column. The database supplies the
+ * insert default, and Drizzle supplies UTC values for updates it executes.
+ * Requires MySQL 8.0.13+ for the UTC expression default.
+ */
+export default function updatedAt(): {
+    updatedAt: import("drizzle-orm").HasDefault<import("drizzle-orm").HasDefault<import("drizzle-orm").NotNull<import("drizzle-orm/mysql-core").MySqlDateTimeBuilderInitial<"updated_at">>>>;
+};

package/dist/mysql/updatedAt.js

@@ -0,0 +1,15 @@
+import { sql } from "drizzle-orm";
+import { datetime } from "drizzle-orm/mysql-core";
+/**
+ * Defines a non-null `updatedAt` DATETIME(3) column. The database supplies the
+ * insert default, and Drizzle supplies UTC values for updates it executes.
+ * Requires MySQL 8.0.13+ for the UTC expression default.
+ */
+export default function updatedAt() {
+    return {
+        updatedAt: datetime("updated_at", { mode: "date", fsp: 3 })
+            .notNull()
+            .default(sql `(utc_timestamp(3))`)
+            .$onUpdate(() => sql `utc_timestamp(3)`),
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@setupless/drizzle",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Small, typed helpers for defining Drizzle ORM schemas",
   "homepage": "https://github.com/Setupless/drizzle#readme",
   "bugs": {
@@ -49,6 +49,16 @@
         "types": "./dist/cjs/sqlite/index.d.ts",
         "default": "./dist/cjs/sqlite/index.js"
       }
+    },
+    "./mysql": {
+      "import": {
+        "types": "./dist/mysql/index.d.ts",
+        "default": "./dist/mysql/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/mysql/index.d.ts",
+        "default": "./dist/cjs/mysql/index.js"
+      }
     }
   },
   "publishConfig": {