@setupless/drizzle 0.2.0 → 0.3.0

package/README.md

@@ -13,15 +13,17 @@ npm install @setupless/drizzle drizzle-orm
 | `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 |
 
 ```ts
 import { pgTable } from "drizzle-orm/pg-core";
-import { id, timestamps } from "@setupless/drizzle/pg";
+import { deletedAt, id, timestamps } from "@setupless/drizzle/pg";
 
 export const users = pgTable("users", {
   ...id(),
   ...timestamps({ withTimezone: true }),
+  ...deletedAt({ withTimezone: true }),
 });
 ```
 
@@ -29,6 +31,10 @@ Import from `/sqlite` for SQLite. The package root also exports `pg` and
 `sqlite` 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
+update. Set it when soft-deleting a row, and set it to `null` to restore the row.
+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.
 

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

@@ -0,0 +1,12 @@
+/**
+ * Defines a nullable `deletedAt` timestamp column named `deleted_at` for soft deletion.
+ * Has no default or automatic update. Set the timestamp when deleting a row.
+ *
+ * @param options - Set `withTimezone` to `true` to use `timestamp with time zone`.
+ * Defaults to `timestamp` without a time zone.
+ */
+export default function deletedAt({ withTimezone, }?: {
+    withTimezone?: boolean;
+}): {
+    deletedAt: import("drizzle-orm/pg-core").PgTimestampBuilderInitial<"deleted_at">;
+};

package/dist/cjs/pg/deletedAt.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = deletedAt;
+const pg_core_1 = require("drizzle-orm/pg-core");
+/**
+ * Defines a nullable `deletedAt` timestamp column named `deleted_at` for soft deletion.
+ * Has no default or automatic update. Set the timestamp when deleting a row.
+ *
+ * @param options - Set `withTimezone` to `true` to use `timestamp with time zone`.
+ * Defaults to `timestamp` without a time zone.
+ */
+function deletedAt({ withTimezone, } = {}) {
+    return {
+        deletedAt: (0, pg_core_1.timestamp)("deleted_at", { withTimezone }),
+    };
+}

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

@@ -1,4 +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/pg/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updatedAt = exports.timestamps = exports.id = exports.createdAt = void 0;
+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");

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

@@ -0,0 +1,7 @@
+/**
+ * Defines a nullable `deletedAt` text column named `deleted_at` for soft deletion.
+ * Has no default or automatic update. Set the timestamp text when deleting a row.
+ */
+export default function deletedAt(): {
+    deletedAt: import("drizzle-orm/sqlite-core").SQLiteTextBuilderInitial<"deleted_at", [string, ...string[]], number | undefined>;
+};

package/dist/cjs/sqlite/deletedAt.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = deletedAt;
+const sqlite_core_1 = require("drizzle-orm/sqlite-core");
+/**
+ * Defines a nullable `deletedAt` text column named `deleted_at` for soft deletion.
+ * Has no default or automatic update. Set the timestamp text when deleting a row.
+ */
+function deletedAt() {
+    return {
+        deletedAt: (0, sqlite_core_1.text)("deleted_at"),
+    };
+}

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

@@ -1,4 +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/sqlite/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updatedAt = exports.timestamps = exports.id = exports.createdAt = void 0;
+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");

package/dist/pg/deletedAt.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Defines a nullable `deletedAt` timestamp column named `deleted_at` for soft deletion.
+ * Has no default or automatic update. Set the timestamp when deleting a row.
+ *
+ * @param options - Set `withTimezone` to `true` to use `timestamp with time zone`.
+ * Defaults to `timestamp` without a time zone.
+ */
+export default function deletedAt({ withTimezone, }?: {
+    withTimezone?: boolean;
+}): {
+    deletedAt: import("drizzle-orm/pg-core").PgTimestampBuilderInitial<"deleted_at">;
+};

package/dist/pg/deletedAt.js

@@ -0,0 +1,13 @@
+import { timestamp } from "drizzle-orm/pg-core";
+/**
+ * Defines a nullable `deletedAt` timestamp column named `deleted_at` for soft deletion.
+ * Has no default or automatic update. Set the timestamp when deleting a row.
+ *
+ * @param options - Set `withTimezone` to `true` to use `timestamp with time zone`.
+ * Defaults to `timestamp` without a time zone.
+ */
+export default function deletedAt({ withTimezone, } = {}) {
+    return {
+        deletedAt: timestamp("deleted_at", { withTimezone }),
+    };
+}

package/dist/pg/index.d.ts

@@ -1,4 +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/pg/index.js

@@ -1,4 +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/sqlite/deletedAt.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Defines a nullable `deletedAt` text column named `deleted_at` for soft deletion.
+ * Has no default or automatic update. Set the timestamp text when deleting a row.
+ */
+export default function deletedAt(): {
+    deletedAt: import("drizzle-orm/sqlite-core").SQLiteTextBuilderInitial<"deleted_at", [string, ...string[]], number | undefined>;
+};

package/dist/sqlite/deletedAt.js

@@ -0,0 +1,10 @@
+import { text } from "drizzle-orm/sqlite-core";
+/**
+ * Defines a nullable `deletedAt` text column named `deleted_at` for soft deletion.
+ * Has no default or automatic update. Set the timestamp text when deleting a row.
+ */
+export default function deletedAt() {
+    return {
+        deletedAt: text("deleted_at"),
+    };
+}

package/dist/sqlite/index.d.ts

@@ -1,4 +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/sqlite/index.js

@@ -1,4 +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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@setupless/drizzle",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Small, typed helpers for defining Drizzle ORM schemas",
   "homepage": "https://github.com/Setupless/drizzle#readme",
   "bugs": {