@rvoh/dream 2.19.0 → 2.21.1

package/dist/esm/src/helpers/cli/generateMigration.js

@@ -1,6 +1,6 @@
 import * as path from 'node:path';
 import pluralize from 'pluralize-esm';
-import generateMigrationContent from '../cli/generateMigrationContent.js';
+import generateMigrationContent, { MIGRATION_TABLE_NAME_PLACEHOLDER, } from '../cli/generateMigrationContent.js';
 import primaryKeyType from '../db/primaryKeyType.js';
 import hyphenize from '../hyphenize.js';
 import migrationVersion from '../migrationVersion.js';
@@ -9,6 +9,18 @@ import dreamPath from '../path/dreamPath.js';
 import snakeify from '../snakeify.js';
 import generateStiMigrationContent from './generateStiMigrationContent.js';
 import writeGeneratedFile from './writeGeneratedFile.js';
+/**
+ * Equivalent to `migrationName.match(new RegExp(`${marker}(.+)$`))?.[1]`, but
+ * without a regex: CodeQL flags `.+` anchored to `$` as a polynomial-ReDoS
+ * shape, and a plain `indexOf`/`slice` does the same leftmost-match-to-end
+ * job with no backtracking risk.
+ */
+function tableNameFromSuffix(migrationName, marker) {
+    const markerIndex = migrationName.indexOf(marker);
+    if (markerIndex === -1)
+        return undefined;
+    return migrationName.slice(markerIndex + marker.length) || undefined;
+}
 export default async function generateMigration({ migrationName, columnsWithTypes, connectionName, fullyQualifiedModelName, fullyQualifiedParentName, tableName: explicitTableName, modelClassName, softDelete = false, }) {
     const migrationsBasePath = connectionName === 'default'
         ? path.join(dreamPath('db'), 'migrations')
@@ -33,12 +45,17 @@ export default async function generateMigration({ migrationName, columnsWithType
         });
     }
     else {
-        const tableName = migrationName.match(/-to-(.+)$/)?.[1];
+        const toTableName = tableNameFromSuffix(migrationName, '-to-');
+        const fromTableName = toTableName
+            ? undefined
+            : tableNameFromSuffix(migrationName, '-from-');
+        const tableName = toTableName || fromTableName;
         content = generateMigrationContent({
-            table: tableName ? pluralize(snakeify(tableName)) : '<table-name>',
+            table: tableName ? pluralize(snakeify(tableName)) : MIGRATION_TABLE_NAME_PLACEHOLDER,
             columnsWithTypes,
             primaryKeyType: primaryKeyType(connectionName),
             createOrAlter: 'alter',
+            alterDirection: fromTableName ? 'remove' : 'add',
         });
     }
     await writeGeneratedFile({

package/dist/esm/src/helpers/cli/generateMigrationContent.js

@@ -2,11 +2,19 @@ import pluralize from 'pluralize-esm';
 import lookupModelByGlobalName from '../../dream-app/helpers/lookupModelByGlobalName.js';
 import Query from '../../dream/Query.js';
 import InvalidDecimalFieldPassedToGenerator from '../../errors/InvalidDecimalFieldPassedToGenerator.js';
+import NoColumnsToAlterMigration from '../../errors/NoColumnsToAlterMigration.js';
+import UnparseableMigrationColumn from '../../errors/UnparseableMigrationColumn.js';
 import camelize from '../camelize.js';
 import compact from '../compact.js';
 import globalClassNameFromFullyQualifiedModelName from '../globalClassNameFromFullyQualifiedModelName.js';
 import snakeify from '../snakeify.js';
 import standardizeFullyQualifiedModelName from '../standardizeFullyQualifiedModelName.js';
+// Sentinel table name used by generateMigration.ts when a standalone
+// migration name matches neither a `-to-<table>` nor `-from-<table>` suffix.
+// That path intentionally produces a stub the user is expected to hand-edit
+// (e.g. an index-only migration with no column operations at all), so it's
+// exempt from the "no valid columns" check below.
+export const MIGRATION_TABLE_NAME_PLACEHOLDER = '<table-name>';
 const STI_TYPE_COLUMN_NAME = 'type';
 // deleted_at is deliberately NOT in this list: the SoftDelete default scope's
 // `WHERE deleted_at IS NULL` is unselective on healthy tables, Dream internals
@@ -15,8 +23,9 @@ const STI_TYPE_COLUMN_NAME = 'type';
 // default. See spec/unit/cli/generateMigrationContent.spec.ts
 // ("deleted_at is deliberately NOT indexed") and the CHANGELOG.
 const COLUMNS_TO_INDEX = [STI_TYPE_COLUMN_NAME];
-export default function generateMigrationContent({ connectionName = 'default', table, columnsWithTypes = [], primaryKeyType = 'bigserial', createOrAlter = 'create', stiChildClassName, softDelete = false, } = {}) {
+export default function generateMigrationContent({ connectionName = 'default', table, columnsWithTypes = [], primaryKeyType = 'bigserial', createOrAlter = 'create', alterDirection = 'add', stiChildClassName, softDelete = false, } = {}) {
     const altering = createOrAlter === 'alter';
+    const removingInUp = altering && alterDirection === 'remove';
     let requireCitextExtension = false;
     const checkConstraints = [];
     // When creating a new table, we automatically emit `created_at`,
@@ -65,7 +74,17 @@ export default function generateMigrationContent({ connectionName = 'default', t
         // when creating a migration for an STI child, we don't want to include notNull;
         // instead, we'll add a check constraint that uses the STI child class name
         const sqlAttributeType = getAttributeType(attributeType, descriptors);
-        if (attributeType === undefined || ['hasone', 'hasmany'].includes(processedAttrType))
+        if (attributeType === undefined) {
+            // In alter mode (both `-to-`/add and `-from-`/remove), a column whose
+            // type can't be resolved (e.g. a mistyped declaration with no `:type`
+            // segment) must not silently vanish from the generated migration —
+            // that's especially dangerous for `-from-` migrations, whose whole
+            // premise is describing removed columns so `down` can restore them.
+            if (altering)
+                throw new UnparseableMigrationColumn(attributeDeclaration);
+            return acc;
+        }
+        if (['hasone', 'hasmany'].includes(processedAttrType))
             return acc;
         if (attributeType === 'citext')
             requireCitextExtension = true;
@@ -169,6 +188,25 @@ export async function down(db: Kysely<any>): Promise<void> {
 }\
 `;
     }
+    // An alter migration (either `-to-`/add or `-from-`/remove) with no valid
+    // columns to add/drop would otherwise emit a bare `.alterTable(...).execute()`
+    // with no column operation at all, which Postgres rejects at migration-run
+    // time rather than generation time. Fail loudly here instead.
+    //
+    // This guard is scoped to the standalone `g:migration` `-to-`/`-from-` flow
+    // only (`stiChildClassName` is unset there). `g:sti-child` legitimately
+    // calls this function in alter mode with zero `columnsWithTypes` — a
+    // zero-attribute STI child is a documented use case (see `g:sti-child`'s
+    // help example in src/cli/index.ts), and `generateStiMigrationContent`
+    // handles the type-column/check-constraint machinery separately from the
+    // `columnDefs` this check inspects, so an empty `columnDefs` there is
+    // expected, not a sign of a mistyped/unparseable column list.
+    if (altering &&
+        columnDefs.length === 0 &&
+        table !== MIGRATION_TABLE_NAME_PLACEHOLDER &&
+        !stiChildClassName) {
+        throw new NoColumnsToAlterMigration(table, alterDirection);
+    }
     const citextExtension = requireCitextExtension
         ? `  await DreamMigrationHelpers.createExtension(db, 'citext')\n\n`
         : '';
@@ -179,7 +217,22 @@ export async function down(db: Kysely<any>): Promise<void> {
     const newlineIndent = '\n  ';
     const newlineDoubleIndent = '\n    ';
     const doubleNewlineIndent = '\n\n  ';
-    const columnDefLines = columnDefs.length ? newlineDoubleIndent + columnDefs.join(newlineDoubleIndent) : '';
+    // For a `-from-` migration (`alterDirection: 'remove'`), `down` re-adds the
+    // column(s) that `up` removed. The generator has no way to know the
+    // column's original default, so a non-optional (`.notNull()`) column with
+    // no default emitted here will fail at migration-run time against a table
+    // that already has rows. We can't fix that without a lot more heavy
+    // lifting (and the risk that comes with it), so flag it with a comment
+    // instead of silently generating a `down` that's likely to break.
+    const NO_KNOWN_DEFAULT_COMMENT = "// NOTE: the generator doesn't know this column's original default; this addColumn will fail against a table with existing rows unless you add a default by hand.";
+    const finalColumnDefs = removingInUp
+        ? columnDefs.map(def => def.includes('.notNull()') && !def.includes('.defaultTo(')
+            ? `${NO_KNOWN_DEFAULT_COMMENT}\n    ${def}`
+            : def)
+        : columnDefs;
+    const columnDefLines = finalColumnDefs.length
+        ? newlineDoubleIndent + finalColumnDefs.join(newlineDoubleIndent)
+        : '';
     const columnDropLines = columnDrops.length
         ? newlineDoubleIndent + columnDrops.join(newlineDoubleIndent) + newlineDoubleIndent
         : '';
@@ -190,21 +243,33 @@ export async function down(db: Kysely<any>): Promise<void> {
             newlineDoubleIndent +
             ".addColumn('updated_at', 'timestamp', col => col.notNull())" +
             (emitDeletedAtColumn ? newlineDoubleIndent + ".addColumn('deleted_at', 'timestamp')" : '');
+    // For `alterDirection: 'remove'` (a `-from-` migration), the enum *type*
+    // itself must never be created or dropped here, even when the column
+    // declaration includes inline enum values — enums are frequently reused
+    // across columns/tables, so `up` must drop only the column (no `dropType`)
+    // and `down` must re-add only the column (no `createType`), identical to
+    // referencing an existing enum by name with no values.
+    const enumCreateStatements = removingInUp ? '' : generateEnumStatements(columnsWithTypes);
+    const enumDropStatements = removingInUp ? '' : generateEnumDropStatements(columnsWithTypes);
+    const addColumnsBody = `${citextExtension}${enumCreateStatements}  await db.schema
+    .${altering ? 'alterTable' : 'createTable'}('${table}')${altering ? '' : newlineDoubleIndent + generateIdStr({ primaryKeyType })}${columnDefLines}${timestampColumnLines}
+    .execute()${indexDefs.length ? `\n${newlineIndent}` : ''}${indexDefs.join(doubleNewlineIndent)}${checkConstraints.join('')}`;
+    const removeColumnsBody = `  ${altering
+        ? `await db.schema${newlineDoubleIndent}.alterTable('${table}')${columnDropLines}.execute()`
+        : `await db.schema.dropTable('${table}').execute()`}${enumDropStatements}`;
+    const upBody = removingInUp ? removeColumnsBody : addColumnsBody;
+    const downBody = removingInUp ? addColumnsBody : removeColumnsBody;
     return `\
 ${dreamDbImports.length ? `import { ${dreamDbImports.join(', ')} } from '@rvoh/dream/db'\n` : ''}import { ${kyselyImports.join(', ')} } from 'kysely'
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export async function up(db: Kysely<any>): Promise<void> {
-${citextExtension}${generateEnumStatements(columnsWithTypes)}  await db.schema
-    .${altering ? 'alterTable' : 'createTable'}('${table}')${altering ? '' : newlineDoubleIndent + generateIdStr({ primaryKeyType })}${columnDefLines}${timestampColumnLines}
-    .execute()${indexDefs.length ? `\n${newlineIndent}` : ''}${indexDefs.join(doubleNewlineIndent)}${checkConstraints.join('')}
+${upBody}
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export async function down(db: Kysely<any>): Promise<void> {
-  ${altering
-        ? `await db.schema${newlineDoubleIndent}.alterTable('${table}')${columnDropLines}.execute()`
-        : `await db.schema.dropTable('${table}').execute()`}${generateEnumDropStatements(columnsWithTypes)}
+${downBody}
 }\
 `;
 }

package/dist/esm/src/helpers/cli/resolveIgnoredColumns.js

@@ -0,0 +1,198 @@
+import scopeArray from '../../decorators/field/sortable/helpers/scopeArray.js';
+import CannotIgnoreAssociationColumn from '../../errors/schema-builder/CannotIgnoreAssociationColumn.js';
+import CannotIgnoreEncryptedColumn from '../../errors/schema-builder/CannotIgnoreEncryptedColumn.js';
+import CannotIgnorePrimaryKey from '../../errors/schema-builder/CannotIgnorePrimaryKey.js';
+import CannotIgnoreSoftDeleteColumn from '../../errors/schema-builder/CannotIgnoreSoftDeleteColumn.js';
+import CannotIgnoreSortablePositionColumn from '../../errors/schema-builder/CannotIgnoreSortablePositionColumn.js';
+import CannotIgnoreSortableScopeColumn from '../../errors/schema-builder/CannotIgnoreSortableScopeColumn.js';
+import CannotIgnoreStiTypeColumn from '../../errors/schema-builder/CannotIgnoreStiTypeColumn.js';
+import ConflictingIgnoredColumns from '../../errors/schema-builder/ConflictingIgnoredColumns.js';
+import IgnoredColumnMustBeCamelCase from '../../errors/schema-builder/IgnoredColumnMustBeCamelCase.js';
+import camelize from '../camelize.js';
+import uniq from '../uniq.js';
+/**
+ * @internal
+ *
+ * Resolves the set of ignored columns for a table from the `ignoredColumns`
+ * declarations of every model backed by that table, validating the
+ * declarations along the way. Called while `sync` builds the generated types
+ * files (the declarations have no runtime behavior; see the `ignoredColumns`
+ * getter on Dream), so each of these guards fails the sync command loudly
+ * rather than surfacing as broken behavior at runtime:
+ *
+ * - ignored columns must be declared in camelCase, since generated column
+ *   names are camelized, so any other shape can never match a generated
+ *   column and would be silently inert
+ * - a model may never ignore its primary key
+ * - an STI model may never ignore the STI "type" column
+ * - a model may never ignore an @Sortable position field or a plain-column
+ *   @Sortable scope, the backing column of an @Encrypted property, or (on a
+ *   SoftDelete model) its deletedAtField — the framework reads and writes
+ *   those columns by name
+ * - models sharing a table must agree on their ignored columns, since there
+ *   is only one generated schema per table (STI children inherit the base
+ *   model's getter, so agreement is automatic unless a child overrides it)
+ * - no association anywhere in the app may name an ignored column as the
+ *   foreign key (or polymorphic type field) it reads and writes on this
+ *   table — a BelongsTo on a model backed by this table names a foreign key
+ *   on this table, and so does a HasMany/HasOne on any other model that
+ *   points at a model backed by this table
+ * - no association anywhere in the app may name an ignored column as its
+ *   primaryKeyOverride — the column the association's foreign key points
+ *   at, which lives on the associated model's table for a BelongsTo and on
+ *   the declaring model's own table for a HasMany/HasOne
+ *
+ * @param models - every model backed by the table
+ * @param tableName - the table whose ignored columns are being resolved
+ * @param allModels - every model in the app (on the table's connection);
+ *   required because associations declared on other models can name foreign
+ *   keys on this table
+ * @returns the set of column names to omit from the table's generated types
+ */
+export default function resolveIgnoredColumns(models, tableName, allModels) {
+    models.forEach(modelClass => {
+        const ignoredColumns = modelClass.prototype.ignoredColumns;
+        ignoredColumns.forEach(columnName => {
+            if (camelize(columnName) !== columnName)
+                throw new IgnoredColumnMustBeCamelCase(modelClass, columnName);
+        });
+        if (ignoredColumns.includes(modelClass.primaryKey))
+            throw new CannotIgnorePrimaryKey(modelClass);
+        if (ignoredColumns.includes('type') && (modelClass['isSTIBase'] || modelClass['isSTIChild']))
+            throw new CannotIgnoreStiTypeColumn(modelClass);
+        modelClass['sortableFields'].forEach(sortableFieldConfig => {
+            if (ignoredColumns.includes(sortableFieldConfig.positionField))
+                throw new CannotIgnoreSortablePositionColumn(modelClass, sortableFieldConfig.positionField);
+            // a Sortable scope entry names either a column or a BelongsTo
+            // association on the model (getColumnForSortableScope resolves columns
+            // first, then falls back to association metadata), so an ignored scope
+            // entry only breaks @Sortable when no association answers to the name
+            scopeArray(sortableFieldConfig.scope).forEach(scopeEntry => {
+                if (ignoredColumns.includes(scopeEntry) &&
+                    modelClass['associationMetadataMap']()[scopeEntry] === undefined)
+                    throw new CannotIgnoreSortableScopeColumn(modelClass, scopeEntry, sortableFieldConfig.positionField);
+            });
+        });
+        // the Encrypted decorator records each backing column it manages in
+        // explicitUnsafeParamColumns (which nothing else populates)
+        modelClass['explicitUnsafeParamColumns'].forEach(columnName => {
+            if (ignoredColumns.includes(columnName))
+                throw new CannotIgnoreEncryptedColumn(modelClass, columnName);
+        });
+        if (modelClass['softDelete']) {
+            const deletedAtField = modelClass.prototype['_deletedAtField'];
+            if (ignoredColumns.includes(deletedAtField))
+                throw new CannotIgnoreSoftDeleteColumn(modelClass, deletedAtField);
+        }
+    });
+    const distinctDeclarations = uniq(models.map(modelClass => JSON.stringify(uniq([...modelClass.prototype.ignoredColumns]).sort())));
+    if (distinctDeclarations.length > 1)
+        throw new ConflictingIgnoredColumns(tableName, models);
+    const ignoredColumns = new Set(models.flatMap(modelClass => [...modelClass.prototype.ignoredColumns]));
+    if (ignoredColumns.size)
+        guardAssociationColumns(ignoredColumns, tableName, allModels);
+    return ignoredColumns;
+}
+/**
+ * @internal
+ *
+ * fails the sync when an ignored column of the table is the foreign key (or
+ * polymorphic type field) that any association in the app reads and writes
+ * on this table, or the primaryKeyOverride column that any association's
+ * foreign key points at on this table. A BelongsTo association names a
+ * foreign key on the declaring model's own table and a primaryKeyOverride
+ * on the associated model's table; a HasMany/HasOne association names a
+ * foreign key on the associated model's table and a primaryKeyOverride on
+ * the declaring model's own table — so the load-bearing association may be
+ * declared on any model in the app, not just the models backed by this
+ * table.
+ */
+function guardAssociationColumns(ignoredColumns, tableName, allModels) {
+    for (const modelClass of allModels) {
+        for (const associationName of modelClass.associationNames) {
+            const associationMetaData = modelClass['associationMetadataMap']()[associationName];
+            if (associationMetaData === undefined)
+                continue;
+            // a through association names no foreign key of its own; the source
+            // association it travels through is guarded directly
+            if (associationMetaData.through)
+                continue;
+            // unlike foreignKey(), primaryKeyOverride is a plain string on the
+            // association statement, so it can be guarded without consulting the
+            // generated schema — before the foreignKey-specific short-circuits below
+            const primaryKeyOverride = associationMetaData.primaryKeyOverride;
+            if (primaryKeyOverride &&
+                ignoredColumns.has(primaryKeyOverride) &&
+                primaryKeyOverrideTableForAssociationMatches(associationMetaData, modelClass, tableName))
+                throw new CannotIgnoreAssociationColumn(tableName, primaryKeyOverride, modelClass, associationMetaData, 'primary key override');
+            if (!foreignKeyTableForAssociationMatches(associationMetaData, modelClass, tableName))
+                continue;
+            // NOTE
+            // this try-catch mirrors getAssociationData in ASTConnectionBuilder:
+            // computing foreignKey() introspects columns via the generated schema
+            // file, so it may throw — on the first sync pass because the schema
+            // file has not been regenerated yet, and on the second pass because
+            // the regenerated schema omits the ignored column. So in orderings
+            // where foreignKey() throws on the first pass, it throws on the second
+            // pass too, and these guards never see the association's foreign key;
+            // the InvalidComputedForeignKey / ExplicitForeignKeyRequired errors
+            // swallowed here resurface at runtime as the backstop.
+            let foreignKey = null;
+            let foreignKeyTypeColumn = null;
+            try {
+                foreignKey = associationMetaData.foreignKey();
+                foreignKeyTypeColumn = associationMetaData.polymorphic
+                    ? associationMetaData.foreignKeyTypeField()
+                    : null;
+            }
+            catch {
+                continue;
+            }
+            if (ignoredColumns.has(foreignKey))
+                throw new CannotIgnoreAssociationColumn(tableName, foreignKey, modelClass, associationMetaData, 'foreign key');
+            if (foreignKeyTypeColumn && ignoredColumns.has(foreignKeyTypeColumn))
+                throw new CannotIgnoreAssociationColumn(tableName, foreignKeyTypeColumn, modelClass, associationMetaData, 'polymorphic type field');
+        }
+    }
+}
+/**
+ * @internal
+ *
+ * returns whether the given association's foreign key physically lives on
+ * the given table: on the declaring model's own table for a BelongsTo, and
+ * on the associated model's table for a HasMany/HasOne
+ */
+function foreignKeyTableForAssociationMatches(associationMetaData, modelClass, tableName) {
+    if (associationMetaData.type === 'BelongsTo')
+        return modelClass.table === tableName;
+    const dreamClassOrClasses = associationMetaData.modelCB();
+    // a missing associated class raises FailedToIdentifyAssociation while the
+    // builder gathers association data; it is not this guard's concern
+    if (!dreamClassOrClasses)
+        return false;
+    return Array.isArray(dreamClassOrClasses)
+        ? dreamClassOrClasses.some(dreamClass => dreamClass.table === tableName)
+        : dreamClassOrClasses.table === tableName;
+}
+/**
+ * @internal
+ *
+ * returns whether the given association's primaryKeyOverride column
+ * physically lives on the given table — the opposite side from the foreign
+ * key (see associationPrimaryKeyAccessors in
+ * decorators/field/association/shared.ts): on the associated model's table
+ * for a BelongsTo, and on the declaring model's own table for a
+ * HasMany/HasOne
+ */
+function primaryKeyOverrideTableForAssociationMatches(associationMetaData, modelClass, tableName) {
+    if (associationMetaData.type !== 'BelongsTo')
+        return modelClass.table === tableName;
+    const dreamClassOrClasses = associationMetaData.modelCB();
+    // a missing associated class raises FailedToIdentifyAssociation while the
+    // builder gathers association data; it is not this guard's concern
+    if (!dreamClassOrClasses)
+        return false;
+    return Array.isArray(dreamClassOrClasses)
+        ? dreamClassOrClasses.some(dreamClass => dreamClass.table === tableName)
+        : dreamClassOrClasses.table === tableName;
+}

package/dist/types/src/Dream.d.ts

@@ -1120,6 +1120,12 @@ export default class Dream {
      * 3. each nested association will result in an additional record which duplicates data from the outer record. E.g., given `.leftJoinPreload('a', 'b', 'c')`, if each `a` has 10 `b` and each `b` has 10 `c`, then for one `a`, 100 records will be returned, each of which has all of the columns of `a`. `.preload('a', 'b', 'c')` would perform three separate SQL queries, but the data for a single `a` would only be returned once.
      * 4. the individual query becomes more complex the more associations are included
      * 5. associations loading associations loading associations could result in exponential amounts of data; in those cases, `.preload(...).findEach(...)` avoids instantiating massive amounts of data at once
+     * 6. leftJoinPreload must enumerate every compiled column of every joined
+     * model, so unlike base-model reads, `preload`/`load`, and saves, it does
+     * not tolerate schema/image skew from an unplanned column drop during a
+     * rolling deploy; see {@link Query.leftJoinPreload} and the
+     * `ignoredColumns` getter for the two-deploy process that makes a
+     * planned drop safe.
      *
      * ```ts
      * const user = await User.leftJoinPreload('posts', 'comments', { visibilty: 'public' }, 'replies').first()
@@ -1949,6 +1955,81 @@ export default class Dream {
      * @returns The table name for this model
      */
     get table(): AssociationTableNames<any, any>;
+    /**
+     * Columns that Dream should behave as though they do not exist.
+     *
+     * Declaring a column ignored removes it from the generated types the next
+     * time `sync` runs: it is omitted from both the db types file (the Kysely
+     * `DB` interface) and the dream schema file, so it disappears from
+     * `columns()` and from every place that flows from `columns()` — select
+     * lists built for `preload`/`load` and `leftJoinPreload`, save hydration,
+     * attribute definition, and param safety. References to the column in
+     * application code become type errors, which is the point: they must be
+     * removed before the column can be dropped.
+     *
+     * This enables safely dropping a column under rolling deploys — the same
+     * problem Rails solves with `ignored_columns`. The safety requirement is
+     * that no image that can run against the post-drop schema names the
+     * column in any SQL it generates. To satisfy it: remove all application
+     * code that uses the column, declare it here, and run `sync`; then let
+     * the drop migration run only once no image lacking the declaration can
+     * run against the database — whether the migration ships in a later
+     * deploy of its own, or together with the declaration in a pipeline that
+     * runs migrations only after the new images have rolled out. Once the
+     * column is dropped, remove this declaration and resync.
+     *
+     * Precondition: as soon as an image built with this declaration runs,
+     * the column is never placed in INSERT column lists, so before that
+     * image can run, the column must be nullable or carry a database
+     * default — a live `NOT NULL` column without a default fails every
+     * create against the table.
+     *
+     * Dropping the column while an image that names it can still run leaves
+     * a window during which those containers (including a rolled-back image)
+     * fail with `42703 column does not exist` — `leftJoinPreload` in
+     * particular has no runtime tolerance for this, since it must enumerate
+     * aliased columns.
+     *
+     * This is a mechanism for the drop window, not for permanently hiding
+     * wide columns: the ignored column is still transferred from the
+     * database on every `RETURNING *` / `select *` until it is actually
+     * dropped.
+     *
+     * The declaration is read only while `sync` generates the types files; it
+     * has no runtime behavior of its own. A declared-but-not-synced model is
+     * therefore not yet protected — CI should verify that `sync` produces no
+     * diff. `sync` will fail loudly if a declared name is not camelCase
+     * (generated column names are camelized, so any other shape could never
+     * match and would be silently inert), if models sharing a table declare
+     * different ignored columns, or if a model attempts to ignore a column
+     * the framework itself reads and writes by name: its primary key, an STI
+     * model's `type` column, any association's foreign key, polymorphic type
+     * field, or `primaryKeyOverride` column, an `@Sortable` position field or
+     * plain-column `@Sortable` scope, an `@Encrypted` backing column, or a
+     * SoftDelete model's `deletedAt` column.
+     *
+     * Because an ignored column vanishes from `columns()`, runtime access via
+     * type escape hatches behaves exactly like any unknown attribute: reads
+     * return `undefined`, and writes assign a plain instance property that is
+     * never persisted.
+     *
+     * ```ts
+     * class User extends ApplicationModel {
+     *   public override get ignoredColumns() {
+     *     return ['legacyEmail'] as const
+     *   }
+     * }
+     * ```
+     *
+     * NOTE: this getter is intentionally typed as `readonly string[]` rather
+     * than as a union of known column names: during the deploy that declares
+     * a column ignored, the regenerated types no longer contain the column,
+     * so a column-name-derived type would reject the very declaration that
+     * removed it.
+     *
+     * @returns The list of column names this model should ignore
+     */
+    get ignoredColumns(): readonly string[];
     /**
      * @internal
      *

package/dist/types/src/cli/index.d.ts

@@ -14,7 +14,7 @@ export type SpawnOptions = Omit<NodeSpawnOptions, 'shell'> & {
     args?: string[];
 };
 export declare const CLI_INDENT = "                  ";
-export declare const baseColumnsWithTypesDescription = "space separated snake-case properties like this:\n                      title:citext subtitle:string body_markdown:text style:enum:post_styles:formal,informal\n                  \n                  all properties default to not nullable; null can be allowed by appending ':optional':\n                      subtitle:string:optional\n                  \n                  supported types:\n                      - uuid:\n                      - uuid[]:\n                          a column optimized for storing UUIDs\n                  \n                      - citext:\n                      - citext[]:\n                          case insensitive text (indexes and queries are automatically case insensitive)\n                  \n                      - encrypted:\n                          encrypted text (used in conjunction with the @deco.Encrypted decorator)\n                  \n                      - string:\n                      - string[]:\n                          varchar; allowed length defaults to 255, but may be customized, e.g.: subtitle:string:128 or subtitle:string:128:optional\n                  \n                      - text\n                      - text[]\n                      - date\n                      - date[]\n                      - datetime\n                      - datetime[]\n                      - time\n                      - time[]\n                      - timetz\n                      - timetz[]\n                      - integer\n                      - integer[]\n                  \n                      - decimal:\n                      - decimal[]:\n                          precision,scale is required, e.g.: volume:decimal:3,2 or volume:decimal:3,2:optional\n                  \n                          leveraging arrays, add the \"[]\" suffix, e.g.: volume:decimal[]:3,2\n                  \n                      - enum:\n                      - enum[]:\n                          include the enum name to automatically create the enum:\n                            type:enum:room_types:bathroom,kitchen,bedroom or type:enum:room_types:bathroom,kitchen,bedroom:optional\n                  \n                          omit the enum values to leverage an existing enum (omits the enum type creation):\n                            type:enum:room_types or type:enum:room_types:optional\n                  \n                          leveraging arrays, add the \"[]\" suffix, e.g.: type:enum[]:room_types:bathroom,kitchen,bedroom";
+export declare const baseColumnsWithTypesDescription = "space separated snake-case properties like this:\n                      title:citext subtitle:string body_markdown:text style:enum:post_styles:formal,informal\n                  \n                  all properties default to not nullable; null can be allowed by appending ':optional':\n                      subtitle:string:optional\n                  \n                  supported types:\n                      - uuid:\n                      - uuid[]:\n                          a column optimized for storing UUIDs\n                  \n                      - citext:\n                      - citext[]:\n                          case insensitive text (indexes and queries are automatically case insensitive)\n                  \n                      - encrypted:\n                          encrypted text (used in conjunction with the @deco.Encrypted decorator)\n                  \n                      - string:\n                      - string[]:\n                          varchar; allowed length defaults to 255, but may be customized, e.g.: subtitle:string:128 or subtitle:string:128:optional\n                  \n                      - text\n                      - text[]\n                      - date\n                      - date[]\n                      - datetime\n                      - datetime[]\n                      - time\n                      - time[]\n                      - timetz\n                      - timetz[]\n                      - integer\n                      - integer[]\n                      - boolean\n                      - boolean[]\n                  \n                      - decimal:\n                      - decimal[]:\n                          precision,scale is required, e.g.: volume:decimal:3,2 or volume:decimal:3,2:optional\n                  \n                          leveraging arrays, add the \"[]\" suffix, e.g.: volume:decimal[]:3,2\n                  \n                      - enum:\n                      - enum[]:\n                          include the enum name to automatically create the enum:\n                            type:enum:room_types:bathroom,kitchen,bedroom or type:enum:room_types:bathroom,kitchen,bedroom:optional\n                  \n                          omit the enum values to leverage an existing enum (omits the enum type creation):\n                            type:enum:room_types or type:enum:room_types:optional\n                  \n                          leveraging arrays, add the \"[]\" suffix, e.g.: type:enum[]:room_types:bathroom,kitchen,bedroom";
 export declare const columnsWithTypesDescriptionForStiChild: string;
 export default class DreamCLI {
     /**

package/dist/types/src/dream/Query.d.ts

@@ -308,6 +308,17 @@ export default class Query<DreamInstance extends Dream, QueryTypeOpts extends Re
      * 3. each nested association will result in an additional record which duplicates data from the outer record. E.g., given `.leftJoinPreload('a', 'b', 'c')`, if each `a` has 10 `b` and each `b` has 10 `c`, then for one `a`, 100 records will be returned, each of which has all of the columns of `a`. `.preload('a', 'b', 'c')` would perform three separate SQL queries, but the data for a single `a` would only be returned once.
      * 4. the individual query becomes more complex the more associations are included
      * 5. associations loading associations loading associations could result in exponential amounts of data; in those cases, `.preload(...).findEach(...)` avoids instantiating massive amounts of data at once
+     * 6. unlike base-model reads, `preload`/`load`, and saves — which tolerate
+     * schema/image skew (e.g. a rolling deploy dropping a column while
+     * containers compiled against the previous schema are still draining) —
+     * leftJoinPreload must enumerate every compiled column of every joined
+     * model under per-alias names (per-alias `*` is not expressible in a
+     * single flat row), so an **unplanned** column drop breaks
+     * leftJoinPreload queries for the duration of the rollout window. A
+     * **planned** drop is safe when performed via the two-deploy process
+     * documented on the `ignoredColumns` getter of Dream: declaring the
+     * column ignored removes it from the generated schema, so leftJoinPreload
+     * stops naming it a full deploy before the column is actually dropped.
      *
      *
      * ```ts

package/dist/types/src/dream/QueryDriver/Kysely.d.ts

@@ -332,6 +332,27 @@ export default class KyselyQueryDriver<DreamInstance extends Dream> extends Quer
      * is provided as a second argument, it will use that transaction
      * to encapsulate the persisting of the dream, as well as any
      * subsequent model hooks that are fired.
+     *
+     * `RETURNING *` (rather than enumerating the compiled column list) keeps
+     * writes working under schema/image skew: during a rolling deploy, a
+     * container built before a drop-column migration would otherwise name the
+     * dropped column in `RETURNING` and fail with `42703 column does not
+     * exist` on every write, even writes that never touch that column. The
+     * `SET`/`VALUES` half still names only dirty attributes, so a write that
+     * actually sets a dropped column still fails loudly. The returned row is
+     * filtered to the compiled column list before hydration (see
+     * internal/saveDream.ts), so a column the image doesn't know about never
+     * reaches `setAttributes`.
+     *
+     * KNOWN CONSTRAINT: star-selects are only safe because nothing in this
+     * stack uses named prepared statements — node-postgres prepares a
+     * statement only when given an explicit `name`, and Kysely never names
+     * them, so every query is re-planned. With named prepared statements, a
+     * concurrent `ADD COLUMN` changes a cached plan's result shape and
+     * Postgres raises `cached plan must not change result type` (the reason
+     * Rails added `enumerate_columns_in_select_statements`). If a future
+     * driver or pooling layer enables named prepared statements, revisit
+     * every `RETURNING *` / `select *` in this driver.
      */
     static saveDream(dream: Dream, txn?: DreamTransaction<Dream> | null): Promise<any>;
     dbConnectionType(sqlCommandType: SqlCommandType): DbConnectionType;

package/dist/types/src/dream/internal/filterRowToKnownColumns.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @internal
+ *
+ * Returns an object containing only the keys of `row` that are columns
+ * the compiled schema knows about (per the provided column set).
+ *
+ * Under schema/image skew (e.g. a rolling deploy in which a migration adds
+ * a column while containers built against the previous schema are still
+ * draining, or application code is rolled back after an add-column
+ * migration), a `RETURNING *` / `select *` row can include columns this
+ * build has never heard of. Passing such keys to `setAttributes` would
+ * assign them as plain properties — invoking a same-named user-defined
+ * setter, or throwing on a getter-only property — so they must be dropped
+ * before hydration.
+ *
+ * Keys are intersected rather than enumerated from the column set so that
+ * a column missing from the row (the dropped-column direction of skew)
+ * simply does not appear, rather than appearing with an `undefined` value.
+ *
+ * Identity fast path: when every key of `row` is a known column (the
+ * no-skew steady state), `row` itself is returned unchanged, without
+ * allocating a copy; a filtered copy is built only when at least one
+ * unknown key is present.
+ *
+ * @param row - a raw database row
+ * @param columns - the compiled column set for the Dream class being hydrated
+ * @returns `row` itself when every key is a known column; otherwise a new
+ * object containing only the known-column entries of `row`
+ */
+export default function filterRowToKnownColumns(row: Record<string, any>, columns: Set<string>): Record<string, any>;

package/dist/types/src/errors/NoColumnsToAlterMigration.d.ts

@@ -0,0 +1,6 @@
+export default class NoColumnsToAlterMigration extends Error {
+    table: string;
+    alterDirection: 'add' | 'remove';
+    constructor(table: string, alterDirection: 'add' | 'remove');
+    get message(): string;
+}

package/dist/types/src/errors/UnparseableMigrationColumn.d.ts

@@ -0,0 +1,5 @@
+export default class UnparseableMigrationColumn extends Error {
+    declaration: string;
+    constructor(declaration: string);
+    get message(): string;
+}

package/dist/types/src/errors/schema-builder/CannotIgnoreAssociationColumn.d.ts

@@ -0,0 +1,12 @@
+import Dream from '../../Dream.js';
+import { AssociationStatement } from '../../types/associations/shared.js';
+export default class CannotIgnoreAssociationColumn extends Error {
+    private tableName;
+    private columnName;
+    private modelClass;
+    private association;
+    private columnRole;
+    constructor(tableName: string, columnName: string, modelClass: typeof Dream, association: AssociationStatement, columnRole: 'foreign key' | 'polymorphic type field' | 'primary key override');
+    get message(): string;
+    private get consequence();
+}

package/dist/types/src/errors/schema-builder/CannotIgnoreEncryptedColumn.d.ts

@@ -0,0 +1,7 @@
+import Dream from '../../Dream.js';
+export default class CannotIgnoreEncryptedColumn extends Error {
+    private modelClass;
+    private columnName;
+    constructor(modelClass: typeof Dream, columnName: string);
+    get message(): string;
+}

package/dist/types/src/errors/schema-builder/CannotIgnorePrimaryKey.d.ts

@@ -0,0 +1,6 @@
+import Dream from '../../Dream.js';
+export default class CannotIgnorePrimaryKey extends Error {
+    private modelClass;
+    constructor(modelClass: typeof Dream);
+    get message(): string;
+}

package/dist/types/src/errors/schema-builder/CannotIgnoreSoftDeleteColumn.d.ts

@@ -0,0 +1,7 @@
+import Dream from '../../Dream.js';
+export default class CannotIgnoreSoftDeleteColumn extends Error {
+    private modelClass;
+    private columnName;
+    constructor(modelClass: typeof Dream, columnName: string);
+    get message(): string;
+}

package/dist/types/src/errors/schema-builder/CannotIgnoreSortablePositionColumn.d.ts

@@ -0,0 +1,7 @@
+import Dream from '../../Dream.js';
+export default class CannotIgnoreSortablePositionColumn extends Error {
+    private modelClass;
+    private columnName;
+    constructor(modelClass: typeof Dream, columnName: string);
+    get message(): string;
+}