tempest-db-js 0.3.0 → 0.4.0

package/README.md

@@ -5,7 +5,7 @@
 
 📖 **Documentation:** [Português (BR)](https://mauriciobenjamin700.github.io/tempest-db-js/) · [English (US)](https://mauriciobenjamin700.github.io/tempest-db-js/en/)
 
-> ✅ **Status: alpha (v0.3.0), published on [npm](https://www.npmjs.com/package/tempest-db-js).** The full path works end-to-end — declarative models, typed query builder (aggregations, `DISTINCT`, upsert), **real SQLite + PostgreSQL execution**, a **MySQL** dialect, joins, relations, Alembic-style migrations (sync + **async** runner) with a `tempest-db` CLI, a typed `BaseRepository`, and an opt-in active-record layer. The public API may still shift before v1.0.
+> ✅ **Status: alpha (v0.4.0), published on [npm](https://www.npmjs.com/package/tempest-db-js).** The full path works end-to-end — declarative models with **foreign keys, UNIQUE and table constraints**, typed query builder (aggregations, `DISTINCT`, upsert), **real SQLite + PostgreSQL execution**, a **MySQL** dialect, joins, relations, Alembic-style migrations (sync + **async** runner) with a `tempest-db` CLI, a typed `BaseRepository`, and an opt-in active-record layer. The public API may still shift before v1.0.
 
 ## Why tempest-db-js
 
@@ -71,6 +71,7 @@ Sessions and engines are **disposable** — `using session = engine.session()` (
 
 Typed extras, each with a [docs recipe](https://mauriciobenjamin700.github.io/tempest-db-js/):
 
+- **Schema constraints** — column `.unique()` / `.references("users.id", { onDelete })` and composite/named table constraints via `static tableArgs = () => [unique(...), foreignKey(...)]` (SQLAlchemy `ForeignKey`/`__table_args__` style). Rendered across all dialects; reversible in migrations.
 - **Aggregations** — `select(Order).aggregate(["status"], { n: count(), total: sum("amount") })` → rows typed as `{ status; n; total }`. Plus `.distinct()`.
 - **Upsert** — `insert(Row).values(...).onConflictDoUpdate(["key"], { ... })` / `.onConflictDoNothing(["key"])` (portable SQLite ↔ PostgreSQL).
 - **Active-record (opt-in)** — `activeRecord(User, session)` → `save`/`update`/`delete`/`reload` over `.data`; the plain-object default is unchanged.
@@ -105,7 +106,7 @@ HTTP integration recipes (Hono, Express, Fastify) live in the [docs](https://mau
 
 ## Roadmap
 
-See [ROADMAP.md](./ROADMAP.md). Shipped (v0.3.0): SQLite + PostgreSQL execution (both tested in CI, Postgres against a live database), a MySQL dialect, joins, relations, sync + async migration runners with a `tempest-db` CLI, repository, aggregations/upsert, opt-in active-record. Next: MySQL execution in CI + `RETURNING` round-trip, async CLI wiring, then `tempest-ts-sdk`.
+See [ROADMAP.md](./ROADMAP.md). Shipped (v0.4.0): declarative schema with foreign keys / UNIQUE / table constraints, SQLite + PostgreSQL execution (both tested in CI, Postgres against a live database), a MySQL dialect, joins, relations, sync + async migration runners with a `tempest-db` CLI, repository, aggregations/upsert, opt-in active-record. Next: MySQL execution in CI + `RETURNING` round-trip, async CLI wiring, then `tempest-ts-sdk`.
 
 ## Development
 

package/dist/bin.cjs

@@ -38,6 +38,10 @@ function invert(op) {
       return { kind: "rename_column", table: op.table, from: op.to, to: op.from };
     case "recreate_table":
       return { kind: "recreate_table", from: op.to, to: op.from };
+    case "add_constraint":
+      return { kind: "drop_constraint", table: op.table, constraint: op.constraint };
+    case "drop_constraint":
+      return { kind: "add_constraint", table: op.table, constraint: op.constraint };
     case "execute":
       if (op.down === null) {
         throw new IrreversibleMigration("execute() operation has no down SQL");
@@ -227,10 +231,45 @@ function renderDefault(def, dialect) {
   if (typeof value === "object") return quoteLiteral(JSON.stringify(value));
   return quoteLiteral(String(value));
 }
+function renderFkAction(action) {
+  return action.toUpperCase();
+}
+function renderFkActions(fk) {
+  let sql = "";
+  if (fk.onDelete) sql += ` ON DELETE ${renderFkAction(fk.onDelete)}`;
+  if (fk.onUpdate) sql += ` ON UPDATE ${renderFkAction(fk.onUpdate)}`;
+  return sql;
+}
+function columnConstraintSuffix(col, dialect) {
+  let sql = "";
+  if (col.unique) sql += " UNIQUE";
+  if (col.references) {
+    const ref = col.references;
+    sql += ` REFERENCES ${quoteId(ref.table, dialect)} (${quoteId(ref.column, dialect)})`;
+    sql += renderFkActions(ref);
+  }
+  return sql;
+}
+function renderUniqueConstraint(uc, dialect) {
+  const cols = uc.columns.map((c) => quoteId(c, dialect)).join(", ");
+  return `CONSTRAINT ${quoteId(uc.name, dialect)} UNIQUE (${cols})`;
+}
+function renderForeignKeyConstraint(fk, dialect) {
+  const cols = fk.columns.map((c) => quoteId(c, dialect)).join(", ");
+  const refCols = fk.refColumns.map((c) => quoteId(c, dialect)).join(", ");
+  return `CONSTRAINT ${quoteId(fk.name, dialect)} FOREIGN KEY (${cols}) REFERENCES ${quoteId(fk.refTable, dialect)} (${refCols})${renderFkActions(fk)}`;
+}
+function tableConstraintClauses(table, dialect) {
+  return [
+    ...table.uniqueConstraints.map((uc) => renderUniqueConstraint(uc, dialect)),
+    ...table.foreignKeys.map((fk) => renderForeignKeyConstraint(fk, dialect))
+  ];
+}
 function renderColumnDef(col, dialect) {
   let sql = `${quoteId(col.name, dialect)} ${renderColumnType(col.type, dialect)}`;
   if (col.notNull) sql += " NOT NULL";
   if (col.default !== null) sql += ` DEFAULT ${renderDefault(col.default, dialect)}`;
+  sql += columnConstraintSuffix(col, dialect);
   return sql;
 }
 function enumTypeName(table, column) {
@@ -254,13 +293,13 @@ function renderCreateTable(table, dialect) {
       let def = `${quoteId(c.name, dialect)} ${quoteId(typeName, dialect)}`;
       if (c.notNull) def += " NOT NULL";
       if (c.default !== null) def += ` DEFAULT ${renderDefault(c.default, dialect)}`;
-      return def;
+      return def + columnConstraintSuffix(c, dialect);
     }
     if (dialect === "postgresql" && isAutoIncrementPk(table, c)) {
-      return `${quoteId(c.name, dialect)} ${postgresSerialType(c.type.kind)}`;
+      return `${quoteId(c.name, dialect)} ${postgresSerialType(c.type.kind)}${columnConstraintSuffix(c, dialect)}`;
     }
     if (dialect === "mysql" && isAutoIncrementPk(table, c)) {
-      return `${quoteId(c.name, dialect)} ${renderColumnType(c.type, dialect)} NOT NULL AUTO_INCREMENT`;
+      return `${quoteId(c.name, dialect)} ${renderColumnType(c.type, dialect)} NOT NULL AUTO_INCREMENT${columnConstraintSuffix(c, dialect)}`;
     }
     return renderColumnDef(c, dialect);
   });
@@ -269,6 +308,7 @@ function renderCreateTable(table, dialect) {
       `PRIMARY KEY (${table.primaryKey.map((c) => quoteId(c, dialect)).join(", ")})`
     );
   }
+  cols.push(...tableConstraintClauses(table, dialect));
   return [
     ...typeStmts,
     `CREATE TABLE ${quoteId(table.name, dialect)} (
@@ -302,10 +342,38 @@ function renderOperation(op, dialect) {
       return renderAlterColumn(op.table, op.to, dialect);
     case "recreate_table":
       return dialect === "sqlite" ? renderSqliteRebuild(op.from, op.to) : renderTableDiff(op.from, op.to, dialect);
+    case "add_constraint":
+      return renderAddConstraint(op.table, op.constraint, dialect);
+    case "drop_constraint":
+      return renderDropConstraint(op.table, op.constraint, dialect);
     case "execute":
       return [op.up];
   }
 }
+function renderAddConstraint(table, constraint, dialect) {
+  if (dialect === "sqlite") {
+    throw new Error(
+      `add_constraint on SQLite needs a table-rebuild (recreate_table); constraint ${constraint.constraint.name} on ${table}`
+    );
+  }
+  const clause = constraint.type === "unique" ? renderUniqueConstraint(constraint.constraint, dialect) : renderForeignKeyConstraint(constraint.constraint, dialect);
+  return [`ALTER TABLE ${quoteId(table, dialect)} ADD ${clause}`];
+}
+function renderDropConstraint(table, constraint, dialect) {
+  if (dialect === "sqlite") {
+    throw new Error(
+      `drop_constraint on SQLite needs a table-rebuild (recreate_table); constraint ${constraint.constraint.name} on ${table}`
+    );
+  }
+  const t = quoteId(table, dialect);
+  const name = quoteId(constraint.constraint.name, dialect);
+  if (dialect === "mysql") {
+    return [
+      constraint.type === "unique" ? `ALTER TABLE ${t} DROP INDEX ${name}` : `ALTER TABLE ${t} DROP FOREIGN KEY ${name}`
+    ];
+  }
+  return [`ALTER TABLE ${t} DROP CONSTRAINT ${name}`];
+}
 function renderSqliteRebuild(from, to) {
   const tmp = `__new_${to.name}`;
   const common = Object.keys(to.columns).filter((c) => c in from.columns);
@@ -315,6 +383,7 @@ function renderSqliteRebuild(from, to) {
       `PRIMARY KEY (${to.primaryKey.map((c) => quoteId(c, "sqlite")).join(", ")})`
     );
   }
+  cols.push(...tableConstraintClauses(to, "sqlite"));
   const commonSql = common.map((c) => quoteId(c, "sqlite")).join(", ");
   return [
     "PRAGMA foreign_keys=off",
@@ -378,9 +447,74 @@ function columnSignature(col) {
     type: col.type,
     notNull: col.notNull,
     primaryKey: col.primaryKey,
-    default: col.default
+    default: col.default,
+    unique: col.unique,
+    references: col.references
   });
 }
+function uniqueSignature(uc) {
+  return JSON.stringify({ columns: uc.columns });
+}
+function foreignKeySignature(fk) {
+  return JSON.stringify({
+    columns: fk.columns,
+    refTable: fk.refTable,
+    refColumns: fk.refColumns,
+    onDelete: fk.onDelete ?? null,
+    onUpdate: fk.onUpdate ?? null
+  });
+}
+function diffConstraints(current, target) {
+  const ops = [];
+  const table = target.name;
+  const currentUq = new Map(current.uniqueConstraints.map((u) => [u.name, u]));
+  const targetUq = new Map(target.uniqueConstraints.map((u) => [u.name, u]));
+  for (const [name, cur] of currentUq) {
+    const tgt = targetUq.get(name);
+    if (!tgt || uniqueSignature(cur) !== uniqueSignature(tgt)) {
+      ops.push(dropUnique(table, cur));
+    }
+  }
+  for (const [name, tgt] of targetUq) {
+    const cur = currentUq.get(name);
+    if (!cur || uniqueSignature(cur) !== uniqueSignature(tgt)) {
+      ops.push(addUnique(table, tgt));
+    }
+  }
+  const currentFk = new Map(current.foreignKeys.map((f) => [f.name, f]));
+  const targetFk = new Map(target.foreignKeys.map((f) => [f.name, f]));
+  for (const [name, cur] of currentFk) {
+    const tgt = targetFk.get(name);
+    if (!tgt || foreignKeySignature(cur) !== foreignKeySignature(tgt)) {
+      ops.push(dropForeignKey(table, cur));
+    }
+  }
+  for (const [name, tgt] of targetFk) {
+    const cur = currentFk.get(name);
+    if (!cur || foreignKeySignature(cur) !== foreignKeySignature(tgt)) {
+      ops.push(addForeignKey(table, tgt));
+    }
+  }
+  return ops;
+}
+function uniqueNamed(uc) {
+  return { type: "unique", constraint: uc };
+}
+function foreignKeyNamed(fk) {
+  return { type: "foreignKey", constraint: fk };
+}
+function addUnique(table, uc) {
+  return { kind: "add_constraint", table, constraint: uniqueNamed(uc) };
+}
+function dropUnique(table, uc) {
+  return { kind: "drop_constraint", table, constraint: uniqueNamed(uc) };
+}
+function addForeignKey(table, fk) {
+  return { kind: "add_constraint", table, constraint: foreignKeyNamed(fk) };
+}
+function dropForeignKey(table, fk) {
+  return { kind: "drop_constraint", table, constraint: foreignKeyNamed(fk) };
+}
 function diffSchema(current, target) {
   const ops = [];
   const drops = [];
@@ -409,6 +543,7 @@ function diffSchema(current, target) {
         ops.push({ kind: "drop_column", table: name, column: currentCol });
       }
     }
+    ops.push(...diffConstraints(currentTable, targetTable));
   }
   for (const [name, currentTable] of Object.entries(current.tables)) {
     if (!target.tables[name]) {
@@ -476,23 +611,38 @@ function heads(migrations) {
 function isDefaultValue(value) {
   return typeof value === "object" && value !== null && "kind" in value && (value.kind === "literal" || value.kind === "expression");
 }
+function parseReference(ref, options) {
+  const dot = ref.lastIndexOf(".");
+  if (dot <= 0 || dot === ref.length - 1) {
+    throw new Error(`Invalid foreign key reference "${ref}"; expected "table.column".`);
+  }
+  return {
+    table: ref.slice(0, dot),
+    column: ref.slice(dot + 1),
+    onDelete: options?.onDelete,
+    onUpdate: options?.onUpdate
+  };
+}
 var Column = class _Column {
-  constructor(type, flags, defaultValue = null, onUpdateValue = null) {
+  constructor(type, flags, defaultValue = null, onUpdateValue = null, reference = null) {
     this.type = type;
     this.flags = flags;
     this.defaultValue = defaultValue;
     this.onUpdateValue = onUpdateValue;
+    this.reference = reference;
   }
   type;
   flags;
   defaultValue;
   onUpdateValue;
+  reference;
   primaryKey() {
     return new _Column(
       this.type,
       { ...this.flags, primaryKey: true, hasDefault: true },
       this.defaultValue,
-      this.onUpdateValue
+      this.onUpdateValue,
+      this.reference
     );
   }
   notNull() {
@@ -500,7 +650,40 @@ var Column = class _Column {
       this.type,
       { ...this.flags, notNull: true },
       this.defaultValue,
-      this.onUpdateValue
+      this.onUpdateValue,
+      this.reference
+    );
+  }
+  /**
+   * Add a `UNIQUE` constraint to the column (mirrors SQLAlchemy's
+   * `mapped_column(unique=True)`). DDL-only — does not change the inferred type.
+   */
+  unique() {
+    return new _Column(
+      this.type,
+      { ...this.flags, unique: true },
+      this.defaultValue,
+      this.onUpdateValue,
+      this.reference
+    );
+  }
+  /**
+   * Declare a foreign-key reference to another table's column, à la SQLAlchemy's
+   * `mapped_column(ForeignKey("table.column", ondelete=...))`. DDL-only — does
+   * not change the inferred type.
+   *
+   * @param ref The target as `"table.column"` (e.g. `"users.id"`).
+   * @param options Optional `onDelete` / `onUpdate` referential actions.
+   * @returns A new column carrying the reference.
+   * @throws Error When `ref` is not a valid `"table.column"` string.
+   */
+  references(ref, options) {
+    return new _Column(
+      this.type,
+      this.flags,
+      this.defaultValue,
+      this.onUpdateValue,
+      parseReference(ref, options)
     );
   }
   /**
@@ -513,7 +696,8 @@ var Column = class _Column {
       this.type,
       { ...this.flags, hasDefault: true },
       resolved,
-      this.onUpdateValue
+      this.onUpdateValue,
+      this.reference
     );
   }
   /**
@@ -522,7 +706,7 @@ var Column = class _Column {
    */
   onUpdate(value) {
     const resolved = isDefaultValue(value) ? value : { kind: "literal", value };
-    return new _Column(this.type, this.flags, this.defaultValue, resolved);
+    return new _Column(this.type, this.flags, this.defaultValue, resolved, this.reference);
   }
 };
 var columnsCache = /* @__PURE__ */ new WeakMap();
@@ -541,6 +725,9 @@ function columnsOf(model) {
 }
 
 // src/migrations/ir.ts
+function constraintName(prefix, table, columns) {
+  return `${prefix}_${table}_${columns.join("_")}`;
+}
 function reflectTable(model) {
   const columns = {};
   const primaryKey = [];
@@ -551,11 +738,32 @@ function reflectTable(model) {
       type: col.type,
       notNull: col.flags.notNull || isPk,
       primaryKey: isPk,
-      default: col.defaultValue
+      default: col.defaultValue,
+      unique: col.flags.unique,
+      references: col.reference
     };
     if (isPk) primaryKey.push(name);
   }
-  return { name: model.tablename, columns, primaryKey };
+  const uniqueConstraints = [];
+  const foreignKeys = [];
+  for (const c of model.tableArgs?.() ?? []) {
+    if (c.kind === "unique") {
+      uniqueConstraints.push({
+        name: c.name ?? constraintName("uq", model.tablename, c.columns),
+        columns: c.columns
+      });
+    } else {
+      foreignKeys.push({
+        name: c.name ?? constraintName("fk", model.tablename, c.columns),
+        columns: c.columns,
+        refTable: c.refTable,
+        refColumns: c.refColumns,
+        onDelete: c.onDelete,
+        onUpdate: c.onUpdate
+      });
+    }
+  }
+  return { name: model.tablename, columns, primaryKey, uniqueConstraints, foreignKeys };
 }
 function reflectSchema(models) {
   const tables = {};
@@ -592,6 +800,39 @@ function affinityToKind(affinity) {
       return "text";
   }
 }
+function sqliteForeignKeys(driver, table) {
+  const rows = driver.execute(`PRAGMA foreign_key_list(${JSON.stringify(table)})`, []).rows;
+  const byId = /* @__PURE__ */ new Map();
+  for (const r of rows) {
+    const list = byId.get(r.id) ?? [];
+    list.push(r);
+    byId.set(r.id, list);
+  }
+  const fks = [];
+  for (const group of byId.values()) {
+    const ordered = [...group].sort((a, b) => a.seq - b.seq);
+    const columns = ordered.map((r) => r.from);
+    fks.push({
+      name: `fk_${table}_${columns.join("_")}`,
+      columns,
+      refTable: ordered[0]?.table ?? "",
+      refColumns: ordered.map((r) => r.to)
+    });
+  }
+  return fks;
+}
+function sqliteUniques(driver, table) {
+  const indexes = driver.execute(`PRAGMA index_list(${JSON.stringify(table)})`, []).rows;
+  const uniques = [];
+  for (const idx of indexes) {
+    if (Number(idx.unique) !== 1 || idx.origin === "pk") continue;
+    const cols = driver.execute(`PRAGMA index_info(${JSON.stringify(idx.name)})`, []).rows.sort((a, b) => a.seqno - b.seqno).map((c) => c.name);
+    if (cols.length > 0) {
+      uniques.push({ name: `uq_${table}_${cols.join("_")}`, columns: cols });
+    }
+  }
+  return uniques;
+}
 function introspectSqlite(driver) {
   const tablesRows = driver.execute(
     "SELECT name FROM sqlite_master WHERE type = 'table' AND name NOT LIKE 'sqlite_%' AND name != 'tempest_db_js_migrations'",
@@ -611,14 +852,39 @@ function introspectSqlite(driver) {
         type: { kind: affinityToKind(affinity), meta: {} },
         notNull: Number(col.notnull) === 1 || isPk,
         primaryKey: isPk,
-        default: null
+        default: null,
+        unique: false,
+        references: null
       };
       if (isPk) primaryKey.push(col.name);
     }
-    tables[tableName] = { name: tableName, columns, primaryKey };
+    tables[tableName] = {
+      name: tableName,
+      columns,
+      primaryKey,
+      uniqueConstraints: sqliteUniques(driver, tableName),
+      foreignKeys: sqliteForeignKeys(driver, tableName)
+    };
   }
   return { tables };
 }
+function constraintKeys(table) {
+  const fks = /* @__PURE__ */ new Set();
+  const uniques = /* @__PURE__ */ new Set();
+  for (const col of Object.values(table.columns)) {
+    if (col.unique) uniques.add(col.name);
+    if (col.references) {
+      fks.add(`${col.name}=>${col.references.table}(${col.references.column})`);
+    }
+  }
+  for (const uc of table.uniqueConstraints) {
+    uniques.add([...uc.columns].sort().join(","));
+  }
+  for (const fk of table.foreignKeys) {
+    fks.add(`${fk.columns.join(",")}=>${fk.refTable}(${fk.refColumns.join(",")})`);
+  }
+  return { fks, uniques };
+}
 function checkDrift(driver, models) {
   const actual = introspectSqlite(driver);
   const expected = reflectSchema(models);
@@ -656,6 +922,34 @@ function checkDrift(driver, models) {
         );
       }
     }
+    const expectedKeys = constraintKeys(expectedTable);
+    const actualKeys = constraintKeys(actualTable);
+    for (const fk of expectedKeys.fks) {
+      if (!actualKeys.fks.has(fk)) {
+        issues.push(`foreign key "${tableName}: ${fk}" is missing from the database`);
+      }
+    }
+    for (const fk of actualKeys.fks) {
+      if (!expectedKeys.fks.has(fk)) {
+        issues.push(
+          `foreign key "${tableName}: ${fk}" exists in the database but not in the model`
+        );
+      }
+    }
+    for (const uq of expectedKeys.uniques) {
+      if (!actualKeys.uniques.has(uq)) {
+        issues.push(
+          `unique constraint "${tableName}: (${uq})" is missing from the database`
+        );
+      }
+    }
+    for (const uq of actualKeys.uniques) {
+      if (!expectedKeys.uniques.has(uq)) {
+        issues.push(
+          `unique constraint "${tableName}: (${uq})" exists in the database but not in the model`
+        );
+      }
+    }
   }
   for (const tableName of Object.keys(actual.tables)) {
     if (!expected.tables[tableName]) {
@@ -671,7 +965,9 @@ function columnShape(col) {
     type: col.type,
     notNull: col.notNull,
     primaryKey: col.primaryKey,
-    default: col.default
+    default: col.default,
+    unique: col.unique,
+    references: col.references
   });
 }
 function tableShape(columns) {
@@ -790,6 +1086,14 @@ var Op = class {
   recreateTable(from, to) {
     this.run({ kind: "recreate_table", from, to });
   }
+  /** Add a table-level unique / foreign-key constraint. */
+  addConstraint(table, constraint) {
+    this.run({ kind: "add_constraint", table, constraint });
+  }
+  /** Drop a table-level unique / foreign-key constraint. */
+  dropConstraint(table, constraint) {
+    this.run({ kind: "drop_constraint", table, constraint });
+  }
   /** Raw SQL escape hatch (e.g. a data migration). `down` may be `null`. */
   execute(up, down = null) {
     this.run({ kind: "execute", up, down });
@@ -952,6 +1256,30 @@ function applyOperation(schema, op) {
       }
       break;
     }
+    case "add_constraint": {
+      const t = tables[op.table];
+      if (t) {
+        tables[op.table] = op.constraint.type === "unique" ? {
+          ...t,
+          uniqueConstraints: [...t.uniqueConstraints, op.constraint.constraint]
+        } : { ...t, foreignKeys: [...t.foreignKeys, op.constraint.constraint] };
+      }
+      break;
+    }
+    case "drop_constraint": {
+      const t = tables[op.table];
+      if (t) {
+        const dropName = op.constraint.constraint.name;
+        tables[op.table] = op.constraint.type === "unique" ? {
+          ...t,
+          uniqueConstraints: t.uniqueConstraints.filter((u) => u.name !== dropName)
+        } : {
+          ...t,
+          foreignKeys: t.foreignKeys.filter((f) => f.name !== dropName)
+        };
+      }
+      break;
+    }
   }
   return { tables };
 }