@stacksjs/database 0.70.376 → 0.70.378

package/dist/index.d.ts

@@ -10,6 +10,7 @@ export type {
   PostgresConfig,
   SqliteConfig,
 } from './driver-config';
+export type { SchemaDriftColumn, SchemaDriftReport } from './schema-drift';
 export type { DeclaredFK, FkAuditResult, FkOrphan, FkOrphanReport, LiveFK } from './fk-audit';
 export type { DeclaredUnique, LiveUniqueIndex, UniqueAuditResult } from './unique-audit';
 export type {
@@ -143,6 +144,10 @@ export * from './ensure-database';
 // Foreign-key audit (stacksjs/stacks#1916) — compare declared
 // `belongsTo` relationships against live FKs.
 export { auditForeignKeys, findFkOrphans, getDeclaredFKs, getLiveFKs } from './fk-audit';
+// Schema drift audit — compare live column types against what the models
+// declare. `migrate` only tracks which files have run, so a database built from
+// a wrong migration set reports "up to date" forever while its columns differ.
+export { auditSchemaDrift, formatSchemaDrift } from './schema-drift';
 // Unique-index drift audit (stacksjs/stacks#1952) — compare declared
 // `unique: true` attributes / indexes against live UNIQUE indexes.
 export { auditUniqueIndexes, getDeclaredUniques, getLiveUniqueIndexes } from './unique-audit';

package/dist/index.js

@@ -1 +1 @@
-export{Database,createDatabase,createMysqlDatabase,createPostgresDatabase,createSqliteDatabase}from"./database";export{detectDriver,driverDefaults,getConfigFromEnv,getConnectionString,mergeWithDefaults,validateDriverConfig}from"./driver-config";export*from"./utils";export*from"./types";export*from"./migrations";export{setQueryTracker,logQuery}from"./query-logger";export{addColumnSafely,backfillInBatches,renameColumnSafely}from"./safe-migrations";export*from"./seeder";export*from"./drivers";export*from"./custom";export*from"./auth-tables";export*from"./uuid-columns";export*from"./managed-columns";export*from"./relation-columns";export{ensureNotificationForeignKeys,migrateNotificationTables}from"./notification-tables";export{migrateRbacTables}from"./rbac-tables";export*from"./trait-tables";export*from"./datetime-columns";export*from"./dialect";export*from"./replicas";export*from"./ddl-constraints";export*from"./vschema";export*from"./sql-helpers";export*from"./defaults";export*from"./migration-dialect";export*from"./migration-path";export*from"./migration-ledger";export*from"./model-sources";export*from"./shadowed-models";export*from"./ensure-database";export{auditForeignKeys,findFkOrphans,getDeclaredFKs,getLiveFKs}from"./fk-audit";export{auditUniqueIndexes,getDeclaredUniques,getLiveUniqueIndexes}from"./unique-audit";export{__flushAfterCommitNow,__pendingAfterCommitCount,enqueueAfterCommit,isInTransaction,runInTransactionScope}from"./transaction-context";export{createQueryBuilder,setConfig}from"@stacksjs/query-builder";export{createDynamo,dynamo,EntityQueryBuilder,generateKeyPattern,parseKeyPattern,buildKey,marshall,unmarshall}from"./drivers/dynamodb";
+export{Database,createDatabase,createMysqlDatabase,createPostgresDatabase,createSqliteDatabase}from"./database";export{detectDriver,driverDefaults,getConfigFromEnv,getConnectionString,mergeWithDefaults,validateDriverConfig}from"./driver-config";export*from"./utils";export*from"./types";export*from"./migrations";export{setQueryTracker,logQuery}from"./query-logger";export{addColumnSafely,backfillInBatches,renameColumnSafely}from"./safe-migrations";export*from"./seeder";export*from"./drivers";export*from"./custom";export*from"./auth-tables";export*from"./uuid-columns";export*from"./managed-columns";export*from"./relation-columns";export{ensureNotificationForeignKeys,migrateNotificationTables}from"./notification-tables";export{migrateRbacTables}from"./rbac-tables";export*from"./trait-tables";export*from"./datetime-columns";export*from"./dialect";export*from"./replicas";export*from"./ddl-constraints";export*from"./vschema";export*from"./sql-helpers";export*from"./defaults";export*from"./migration-dialect";export*from"./migration-path";export*from"./migration-ledger";export*from"./model-sources";export*from"./shadowed-models";export*from"./ensure-database";export{auditForeignKeys,findFkOrphans,getDeclaredFKs,getLiveFKs}from"./fk-audit";export{auditSchemaDrift,formatSchemaDrift}from"./schema-drift";export{auditUniqueIndexes,getDeclaredUniques,getLiveUniqueIndexes}from"./unique-audit";export{__flushAfterCommitNow,__pendingAfterCommitCount,enqueueAfterCommit,isInTransaction,runInTransactionScope}from"./transaction-context";export{createQueryBuilder,setConfig}from"@stacksjs/query-builder";export{createDynamo,dynamo,EntityQueryBuilder,generateKeyPattern,parseKeyPattern,buildKey,marshall,unmarshall}from"./drivers/dynamodb";

package/dist/schema-drift.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Compare the live schema against the application's models.
+ *
+ * Only the application's own models under `app/Models/`. The framework defaults
+ * are deliberately excluded: an application that does not use the commerce or
+ * CMS models has no tables for them, and reporting sixty absent tables would
+ * bury the one column that is actually wrong.
+ *
+ * Never throws. A drift audit that breaks `migrate` is worse than one that does
+ * not run, so an introspection failure, a missing permission or an
+ * unrecognisable model returns `skipped` and the caller carries on.
+ */
+export declare function auditSchemaDrift(): Promise<SchemaDriftReport>;
+/** Re-exported so callers format one way. */
+export declare function formatSchemaDrift(report: SchemaDriftReport): Promise<string>;
+/**
+ * Does the live database still look like the models?
+ *
+ * The companion to `fk-audit.ts`, and the one that catches the quieter failure.
+ * `migrate` decides what to do by asking which migration FILES have not
+ * executed. It never asks whether the database resembles the models. So a
+ * database created from an older, wrong migration set reports "nothing to
+ * migrate — your database is already up to date" on every run, forever, while
+ * its columns are wrong, and a corrected `CREATE TABLE IF NOT EXISTS` deploys
+ * as a no-op against it.
+ *
+ * Two of those reached production on one app: a JSON column left in
+ * varchar(255), which refused a large payload, and a money column left as an
+ * integer, which stored 99.5 as 100. Every layer reported success. The only
+ * symptom was a number that came back different from the one written.
+ *
+ * The comparison itself lives in bun-query-builder, which owns the schema plan
+ * and the introspection. This file's job is the part only the framework knows:
+ * where an application's models actually are.
+ */
+/** One column whose live type does not match what its model declares. */
+export declare interface SchemaDriftColumn {
+  table: string
+  column: string
+  expected: string
+  actual: string
+  actualSqlType: string
+}
+export declare interface SchemaDriftReport {
+  missingTables: string[]
+  missingColumns: Array<{ table: string, column: string, expected: string }>
+  typeMismatches: SchemaDriftColumn[]
+  clean: boolean
+  skipped: boolean
+}

package/dist/schema-drift.js

@@ -0,0 +1 @@
+import fs from"node:fs";import{path}from"@stacksjs/path";async function loadModelsFrom(dir){const out=[];if(!fs.existsSync(dir))return out;for(const entry of fs.readdirSync(dir,{withFileTypes:!0})){const fullPath=path.join(dir,entry.name);if(entry.isDirectory()){out.push(...await loadModelsFrom(fullPath));continue}if(!entry.name.endsWith(".ts")||entry.name.startsWith("_")||entry.name.startsWith("index"))continue;try{const imported=(await import(fullPath)).default;if(imported?.name||imported?.table)out.push(imported)}catch{}}return out}export async function auditSchemaDrift(){const empty={missingTables:[],missingColumns:[],typeMismatches:[],clean:!0,skipped:!0};try{const models=await loadModelsFrom(path.appPath("Models"));if(models.length===0)return empty;const qb=await import("bun-query-builder");if(typeof qb.auditSchemaDrift!=="function"||typeof qb.buildMigrationPlan!=="function")return empty;const defined=qb.defineModels(Object.fromEntries(models.map((model)=>[model.name??model.table,model]))),plan=qb.buildMigrationPlan(defined,{});return{...await qb.auditSchemaDrift(plan,{}),skipped:!1}}catch{return empty}}export async function formatSchemaDrift(report){if(report.skipped||report.clean)return"";const{formatSchemaDrift:format}=await import("bun-query-builder");return typeof format==="function"?format(report):""}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@stacksjs/database",
   "type": "module",
   "sideEffects": false,
-  "version": "0.70.376",
+  "version": "0.70.378",
   "description": "The Stacks database integration.",
   "author": "Chris Breuer",
   "contributors": [
@@ -61,19 +61,19 @@
   },
   "dependencies": {
     "@stacksjs/ts-validation": "^0.5.4",
-    "bun-query-builder": "^0.2.30",
+    "bun-query-builder": "^0.2.36",
     "dynamodb-tooling": "^0.3.2"
   },
   "devDependencies": {
-    "@stacksjs/cli": "0.70.376",
-    "@stacksjs/config": "0.70.376",
-    "@stacksjs/logging": "0.70.376",
-    "@stacksjs/router": "0.70.376",
+    "@stacksjs/cli": "0.70.378",
+    "@stacksjs/config": "0.70.378",
+    "@stacksjs/logging": "0.70.378",
+    "@stacksjs/router": "0.70.378",
     "better-dx": "^0.2.17",
-    "@stacksjs/path": "0.70.376",
-    "@stacksjs/query-builder": "0.70.376",
-    "@stacksjs/storage": "0.70.376",
-    "@stacksjs/strings": "0.70.376",
-    "@stacksjs/utils": "0.70.376"
+    "@stacksjs/path": "0.70.378",
+    "@stacksjs/query-builder": "0.70.378",
+    "@stacksjs/storage": "0.70.378",
+    "@stacksjs/strings": "0.70.378",
+    "@stacksjs/utils": "0.70.378"
   }
 }