@zeno-lib/db 0.3.0 → 0.3.2

package/dist/triggers.mjs

@@ -0,0 +1,93 @@
+import { getTableName, is } from "drizzle-orm";
+import { PgTable, getTableConfig } from "drizzle-orm/pg-core";
+//#region src/triggers.ts
+const DEFAULT_EXTENSION_SCHEMA = "extensions";
+const DEFAULT_COLUMN = "updated_at";
+const DEFAULT_AUTHOR_COLUMN = "updated_by";
+const DEFAULT_TABLE_SCHEMA = "public";
+const quote = (identifier) => `"${identifier.split("\"").join("\"\"")}"`;
+function resolveTable(table, schema) {
+	const name = is(table, PgTable) ? getTableName(table) : table;
+	const tableSchema = schema ?? (is(table, PgTable) ? getTableConfig(table).schema ?? DEFAULT_TABLE_SCHEMA : DEFAULT_TABLE_SCHEMA);
+	return { qualified: `${quote(tableSchema)}.${quote(name)}` };
+}
+/**
+* `CREATE TRIGGER` SQL that keeps `updated_at` current for **every** writer,
+* including PostgREST, the dashboard and psql.
+*
+* `timestamps()` gives the column a `DEFAULT now()`, which covers the insert.
+* SQL has no "on update" default, so without this trigger the column is only
+* ever the insert time. Required, not optional.
+*
+* ```ts
+* // pnpm db:generate --custom --name=posts_audit_triggers
+* // then paste the output into the generated migration:
+* console.log(updatedAtTrigger(posts))
+* ```
+*/
+function updatedAtTrigger(table, { column = DEFAULT_COLUMN, createExtension = true, extensionSchema = DEFAULT_EXTENSION_SCHEMA, name, schema } = {}) {
+	const { qualified } = resolveTable(table, schema);
+	const triggerName = name ?? `handle_${column}`;
+	const trigger = [
+		`drop trigger if exists ${quote(triggerName)} on ${qualified};`,
+		`create trigger ${quote(triggerName)}`,
+		`  before update on ${qualified}`,
+		"  for each row",
+		`  execute function ${quote(extensionSchema)}.moddatetime (${quote(column)});`
+	].join("\n");
+	return createExtension ? `${moddatetimeExtension(extensionSchema)}\n\n${trigger}` : trigger;
+}
+/** `create extension if not exists moddatetime`, safe to repeat per migration. */
+function moddatetimeExtension(schema = DEFAULT_EXTENSION_SCHEMA) {
+	return `create extension if not exists moddatetime with schema ${quote(schema)};`;
+}
+/**
+* `CREATE TRIGGER` SQL that stamps an author column with `auth.uid()` on every
+* update, the `updated_at` story for `updated_by`.
+*
+* `updatedBy()` gives the column a `DEFAULT (select auth.uid())`, which covers
+* the insert. This covers the update, for every writer rather than only the
+* ones going through Drizzle.
+*
+* A write with no session (the admin or `service_role` clients) records `NULL`,
+* because that is what `auth.uid()` returns there.
+*/
+function updatedByTrigger(table, { column = DEFAULT_AUTHOR_COLUMN, createFunction = true, functionSchema = DEFAULT_TABLE_SCHEMA, name, schema } = {}) {
+	const { qualified } = resolveTable(table, schema);
+	const triggerName = name ?? `handle_${column}`;
+	const functionName = `set_${column}`;
+	const qualifiedFunction = `${quote(functionSchema)}.${quote(functionName)}`;
+	const routine = [
+		`create or replace function ${qualifiedFunction}()`,
+		"  returns trigger",
+		"  language plpgsql",
+		"  security invoker",
+		`  set search_path = ''`,
+		"as $$",
+		"begin",
+		`  new.${quote(column)} = (select auth.uid());`,
+		"  return new;",
+		"end;",
+		"$$;"
+	].join("\n");
+	const trigger = [
+		`drop trigger if exists ${quote(triggerName)} on ${qualified};`,
+		`create trigger ${quote(triggerName)}`,
+		`  before update on ${qualified}`,
+		"  for each row",
+		`  execute function ${qualifiedFunction}();`
+	].join("\n");
+	return createFunction ? `${routine}\n\n${trigger}` : trigger;
+}
+/**
+* Both update triggers `auditColumns()` needs, in one string.
+*
+* `auditColumns()` and `timestamps()` leave `updated_at` and `updated_by` at
+* their insert values without these, so a table using either helper wants this
+* in a `drizzle-kit generate --custom` migration.
+*/
+function auditTriggers(table, options = {}) {
+	return `${updatedAtTrigger(table, options)}\n\n${updatedByTrigger(table, options)}`;
+}
+//#endregion
+export { auditTriggers, moddatetimeExtension, updatedAtTrigger, updatedByTrigger };

package/package.json

@@ -1,15 +1,36 @@
 {
   "name": "@zeno-lib/db",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "type": "module",
   "exports": {
-    ".": "./src/index.ts",
-    "./auth": "./src/auth-schema.ts",
-    "./config": "./src/config.ts",
-    "./schema": "./src/schema.ts",
-    "./triggers": "./src/triggers.ts"
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs",
+      "default": "./dist/index.mjs"
+    },
+    "./auth": {
+      "types": "./dist/auth-schema.d.mts",
+      "import": "./dist/auth-schema.mjs",
+      "default": "./dist/auth-schema.mjs"
+    },
+    "./config": {
+      "types": "./dist/config.d.mts",
+      "import": "./dist/config.mjs",
+      "default": "./dist/config.mjs"
+    },
+    "./schema": {
+      "types": "./dist/schema.d.mts",
+      "import": "./dist/schema.mjs",
+      "default": "./dist/schema.mjs"
+    },
+    "./triggers": {
+      "types": "./dist/triggers.d.mts",
+      "import": "./dist/triggers.mjs",
+      "default": "./dist/triggers.mjs"
+    }
   },
   "files": [
+    "dist",
     "src"
   ],
   "publishConfig": {
@@ -33,12 +54,15 @@
     "drizzle-orm": "1.0.0-rc.3",
     "postgres": "3.4.7",
     "supabase": "2.84.1",
+    "tsdown": "^0.22.14",
+    "typescript": "7.0.2",
     "vite": "8.0.16",
     "vitest": "4.1.0",
     "@zeno-lib/test": "0.0.3",
     "@zeno-lib/typescript": "^1.1.0"
   },
   "scripts": {
+    "build": "tsdown",
     "dev": "pnpm exec supabase start",
     "stop": "pnpm exec supabase stop",
     "reset": "pnpm exec supabase db reset",