@rvoh/dream 2.19.0 → 2.20.0

package/dist/esm/src/errors/schema-builder/CannotIgnoreEncryptedColumn.js

@@ -0,0 +1,20 @@
+export default class CannotIgnoreEncryptedColumn extends Error {
+    modelClass;
+    columnName;
+    constructor(modelClass, columnName) {
+        super();
+        this.modelClass = modelClass;
+        this.columnName = columnName;
+    }
+    get message() {
+        return `
+${this.modelClass.sanitizedName} declares "${this.columnName}" in
+ignoredColumns, but "${this.columnName}" is the backing column of an
+@Encrypted property on ${this.modelClass.sanitizedName}.
+
+@Encrypted stores its ciphertext in this column, so it can never be
+ignored. Remove the @Encrypted declaration (and its property) from
+${this.modelClass.sanitizedName} before ignoring "${this.columnName}".
+`;
+    }
+}

package/dist/esm/src/errors/schema-builder/CannotIgnorePrimaryKey.js

@@ -0,0 +1,18 @@
+export default class CannotIgnorePrimaryKey extends Error {
+    modelClass;
+    constructor(modelClass) {
+        super();
+        this.modelClass = modelClass;
+    }
+    get message() {
+        return `
+${this.modelClass.sanitizedName} declares its primary key ("${this.modelClass.primaryKey}")
+in ignoredColumns.
+
+The primary key is required to identify rows for hydration, updates, and
+associations, so it can never be ignored. Remove
+"${this.modelClass.primaryKey}" from the ignoredColumns getter on
+${this.modelClass.sanitizedName}.
+`;
+    }
+}

package/dist/esm/src/errors/schema-builder/CannotIgnoreSoftDeleteColumn.js

@@ -0,0 +1,21 @@
+export default class CannotIgnoreSoftDeleteColumn extends Error {
+    modelClass;
+    columnName;
+    constructor(modelClass, columnName) {
+        super();
+        this.modelClass = modelClass;
+        this.columnName = columnName;
+    }
+    get message() {
+        return `
+${this.modelClass.sanitizedName} declares "${this.columnName}" in
+ignoredColumns, but ${this.modelClass.sanitizedName} is a SoftDelete model
+and "${this.columnName}" is its deletedAtField.
+
+SoftDelete writes this column on destroy and filters on it in its default
+scope, so it can never be ignored. Remove the @SoftDelete decorator from
+${this.modelClass.sanitizedName} (or point deletedAtField at a different
+column) before ignoring "${this.columnName}".
+`;
+    }
+}

package/dist/esm/src/errors/schema-builder/CannotIgnoreSortablePositionColumn.js

@@ -0,0 +1,20 @@
+export default class CannotIgnoreSortablePositionColumn extends Error {
+    modelClass;
+    columnName;
+    constructor(modelClass, columnName) {
+        super();
+        this.modelClass = modelClass;
+        this.columnName = columnName;
+    }
+    get message() {
+        return `
+${this.modelClass.sanitizedName} declares "${this.columnName}" in
+ignoredColumns, but "${this.columnName}" is the position field of an
+@Sortable declaration on ${this.modelClass.sanitizedName}.
+
+@Sortable reads and rewrites this column to keep positions contiguous, so
+it can never be ignored. Remove the @Sortable decorator (and its property)
+from ${this.modelClass.sanitizedName} before ignoring "${this.columnName}".
+`;
+    }
+}

package/dist/esm/src/errors/schema-builder/CannotIgnoreSortableScopeColumn.js

@@ -0,0 +1,24 @@
+export default class CannotIgnoreSortableScopeColumn extends Error {
+    modelClass;
+    columnName;
+    positionField;
+    constructor(modelClass, columnName, positionField) {
+        super();
+        this.modelClass = modelClass;
+        this.columnName = columnName;
+        this.positionField = positionField;
+    }
+    get message() {
+        return `
+${this.modelClass.sanitizedName} declares "${this.columnName}" in
+ignoredColumns, but "${this.columnName}" is a scope column of the @Sortable
+declaration on "${this.positionField}" on ${this.modelClass.sanitizedName}.
+
+@Sortable reads this column by name on every save and destroy to partition
+position values, so it can never be ignored. Remove "${this.columnName}"
+from the @Sortable scope on "${this.positionField}" (or remove the
+@Sortable decorator and its property) on ${this.modelClass.sanitizedName}
+before ignoring "${this.columnName}".
+`;
+    }
+}

package/dist/esm/src/errors/schema-builder/CannotIgnoreStiTypeColumn.js

@@ -0,0 +1,17 @@
+export default class CannotIgnoreStiTypeColumn extends Error {
+    modelClass;
+    constructor(modelClass) {
+        super();
+        this.modelClass = modelClass;
+    }
+    get message() {
+        return `
+${this.modelClass.sanitizedName} participates in single-table inheritance
+and declares the STI "type" column in ignoredColumns.
+
+The "type" column determines which model class each row hydrates into, so
+an STI model can never ignore it. Remove "type" from the ignoredColumns
+getter on ${this.modelClass.sanitizedName}.
+`;
+    }
+}

package/dist/esm/src/errors/schema-builder/ConflictingIgnoredColumns.js

@@ -0,0 +1,27 @@
+export default class ConflictingIgnoredColumns extends Error {
+    tableName;
+    modelClasses;
+    constructor(tableName, modelClasses) {
+        super();
+        this.tableName = tableName;
+        this.modelClasses = modelClasses;
+    }
+    get message() {
+        const declarations = this.modelClasses
+            .map(modelClass => `    ${modelClass.sanitizedName}: [${[...modelClass.prototype.ignoredColumns]
+            .sort()
+            .map(column => `'${column}'`)
+            .join(', ')}]`)
+            .join('\n');
+        return `
+Models sharing the table "${this.tableName}" declare different ignoredColumns:
+
+${declarations}
+
+There is only one generated schema per table, so every model backed by a
+table must agree on which of its columns are ignored. Align the
+ignoredColumns getters (STI children inherit the base model's getter, so
+the common fix is to declare ignored columns only on the base model).
+`;
+    }
+}

package/dist/esm/src/errors/schema-builder/IgnoredColumnMustBeCamelCase.js

@@ -0,0 +1,21 @@
+import camelize from '../../helpers/camelize.js';
+export default class IgnoredColumnMustBeCamelCase extends Error {
+    modelClass;
+    columnName;
+    constructor(modelClass, columnName) {
+        super();
+        this.modelClass = modelClass;
+        this.columnName = columnName;
+    }
+    get message() {
+        return `
+${this.modelClass.sanitizedName} declares "${this.columnName}" in
+ignoredColumns, but ignored columns must be declared in camelCase.
+
+Dream camelizes database column names when generating types, so a
+declaration that is not camelCase can never match a generated column and
+would be silently inert. Declare "${camelize(this.columnName)}" in the
+ignoredColumns getter on ${this.modelClass.sanitizedName} instead.
+`;
+    }
+}

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

@@ -11,6 +11,7 @@ import intersection from '../intersection.js';
 import sortBy from '../sortBy.js';
 import uniq from '../uniq.js';
 import ASTBuilder from './ASTBuilder.js';
+import resolveIgnoredColumns from './resolveIgnoredColumns.js';
 /**
  * @internal
  *
@@ -265,12 +266,48 @@ may need to update the table getter in the corresponding Dream.
                 default: uniq(models.flatMap(model => model['scopes'].default.map(scopeStatement => scopeStatement.method))),
                 named: uniq(models.flatMap(model => model['scopes'].named.map(scopeStatement => scopeStatement.method))),
             },
-            columns: await this.getColumnData(tableName, associationData),
+            columns: this.withoutIgnoredColumns(await this.getColumnData(tableName, associationData), tableName),
             virtualColumns: uniq(models.flatMap(model => model['virtualAttributes'].map(prop => prop.property) || [])),
             associations: associationData,
             serializerKeys,
         };
     }
+    /**
+     * @internal
+     *
+     * resolves the ignored columns declared by the models backed by the
+     * given table (validating the declarations; see resolveIgnoredColumns)
+     */
+    ignoredColumnsForTable(tableName) {
+        const dreamApp = DreamApp.getOrFail();
+        const allModels = Object.values(dreamApp.models).filter(model => model.prototype?.connectionName === this.connectionName);
+        const models = allModels.filter(model => model.table === tableName);
+        return resolveIgnoredColumns(models, tableName, allModels);
+    }
+    /**
+     * @internal
+     *
+     * returns the provided column data without the columns that the table's
+     * models declare in ignoredColumns. This is what removes ignored columns
+     * from the generated dream schema file: `columns()` reads the generated
+     * schema at runtime, so every column enumeration built from `columns()`
+     * (preload and join-load select lists, save hydration, attribute
+     * definition) inherits this filtering. A column that is ignored but not
+     * present in the introspected table (e.g. after the drop migration has
+     * run but before the declaration is removed) is a no-op.
+     */
+    withoutIgnoredColumns(columnData, tableName) {
+        const ignoredColumns = this.ignoredColumnsForTable(tableName);
+        if (!ignoredColumns.size)
+            return columnData;
+        return Object.keys(columnData)
+            .filter(columnName => !ignoredColumns.has(columnName))
+            .reduce((filtered, columnName) => {
+            ;
+            filtered[columnName] = columnData[columnName];
+            return filtered;
+        }, {});
+    }
     /**
      * @internal
      *

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

@@ -25,6 +25,7 @@ export default class ASTKyselyCodegenEnhancer extends ASTConnectionBuilder {
     async enhance() {
         let dbSourceFile = await this.getDbSourceFile();
         dbSourceFile = this.camelizeKeys(dbSourceFile);
+        dbSourceFile = this.removeIgnoredColumns(dbSourceFile);
         dbSourceFile = this.replaceTimestampExport(dbSourceFile);
         dbSourceFile = await this.replaceTimeFieldsInInterfaces(dbSourceFile);
         dbSourceFile = this.addMissingImports(dbSourceFile);
@@ -283,6 +284,65 @@ ${output}`);
         const result = ts.transform(dbSourceFile, [transformer]);
         return result.transformed[0];
     }
+    /**
+     * @internal
+     *
+     * removes columns declared in model `ignoredColumns` getters from the
+     * table interfaces generated by kysely-codegen. This is what removes
+     * ignored columns from the generated db types file: every column-name
+     * level type (`DreamColumnNames`, `UpdateableProperties`, where-clause
+     * statements) derives from the Kysely `DB` interface, so filtering here
+     * turns any remaining code reference to an ignored column into a type
+     * error. Runs after camelizeKeys so that member names align with the
+     * camelCase column names models declare in ignoredColumns.
+     */
+    removeIgnoredColumns(dbSourceFile) {
+        const dbInterface = this.findDbExport(dbSourceFile, 'DB');
+        if (!dbInterface)
+            return dbSourceFile;
+        // the DB interface maps table names to table interfaces (e.g.
+        // `collars: Collars`), so it provides the table name each table
+        // interface corresponds to
+        const ignoredColumnsByInterfaceName = {};
+        dbInterface.members.forEach(member => {
+            if (!ts.isPropertySignature(member))
+                return;
+            if (!member.type || !ts.isTypeReferenceNode(member.type))
+                return;
+            if (!ts.isIdentifier(member.type.typeName))
+                return;
+            const tableName = ts.isIdentifier(member.name)
+                ? member.name.text
+                : ts.isStringLiteral(member.name)
+                    ? member.name.text
+                    : null;
+            if (!tableName)
+                return;
+            const ignoredColumns = this.ignoredColumnsForTable(tableName);
+            if (ignoredColumns.size)
+                ignoredColumnsByInterfaceName[member.type.typeName.text] = ignoredColumns;
+        });
+        if (!Object.keys(ignoredColumnsByInterfaceName).length)
+            return dbSourceFile;
+        // @ts-expect-error cannot lock this type down, though implementation is correct
+        const transformer = context => {
+            const visit = node => {
+                const interfaceNode = this.exportedInterfaceOrNull(node);
+                const ignoredColumns = interfaceNode
+                    ? ignoredColumnsByInterfaceName[interfaceNode.name.text]
+                    : undefined;
+                if (interfaceNode && ignoredColumns) {
+                    return f.updateInterfaceDeclaration(interfaceNode, interfaceNode.modifiers, interfaceNode.name, interfaceNode.typeParameters, interfaceNode.heritageClauses, interfaceNode.members.filter(member => !(ts.isPropertySignature(member) &&
+                        (ts.isIdentifier(member.name) || ts.isStringLiteral(member.name)) &&
+                        ignoredColumns.has(member.name.text))));
+                }
+                return ts.visitEachChild(node, visit, context);
+            };
+            return node => ts.visitNode(node, visit);
+        };
+        const result = ts.transform(dbSourceFile, [transformer]);
+        return result.transformed[0];
+    }
     /**
      * @internal
      *

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/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;