@rvoh/dream 2.28.2 → 2.28.3

package/dist/cjs/src/Dream.js

@@ -878,9 +878,11 @@ export default class Dream {
         });
     }
     /**
-     * Returns a query for this model which disregards default scopes
+     * Returns a query which bypasses user-removable default scopes, including on
+     * association loads. An STI child's reserved type discriminator remains
+     * enforced; query the STI base model to span its registered children.
      *
-     * @returns A query for this model which disregards default scopes
+     * @returns A query which bypasses user-removable default scopes
      */
     static removeAllDefaultScopes() {
         return this.query().removeAllDefaultScopes();
@@ -3141,7 +3143,7 @@ export default class Dream {
      * @param options - Options for destroying the instance
      * @param options.skipHooks - If true, skips applying model hooks during the destroy operation. Defaults to false
      * @param options.cascade - If false, skips destroying associations marked `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when cascade destroying. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when cascade destroying; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when cascade destroying. Defaults to an empty array
      * @returns The instance that was destroyed
      */
@@ -3166,7 +3168,7 @@ export default class Dream {
      * @param options - Options for destroying the instance
      * @param options.skipHooks - If true, skips applying model hooks during the destroy operation. Defaults to false
      * @param options.cascade - If false, skips destroying associations marked `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when cascade destroying. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when cascade destroying; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when cascade destroying. Defaults to an empty array
      * @returns The instance that was destroyed
      */
@@ -3188,7 +3190,7 @@ export default class Dream {
      * @param options - Options for undestroying the instance
      * @param options.skipHooks - If true, skips applying model hooks during the undestroy operation. Defaults to false
      * @param options.cascade - If false, skips undestroying associations marked `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when cascade undestroying. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when cascade undestroying; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when cascade undestroying (soft delete is always bypassed). Defaults to an empty array
      * @returns The undestroyed record
      */
@@ -3297,7 +3299,7 @@ export default class Dream {
      * @param options.andAny - Optional andAny statement to apply to query before destroying
      * @param options.skipHooks - If true, skips applying model hooks during the destroy operation. Defaults to false
      * @param options.cascade - If false, skips destroying associations marked `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when destroying the association. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when destroying the association; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when destroying the association. Defaults to an empty array
      * @returns The number of records deleted
      */
@@ -3333,7 +3335,7 @@ export default class Dream {
      * @param options.andAny - Optional andAny statement to apply to query before destroying
      * @param options.skipHooks - If true, skips applying model hooks during the destroy operation. Defaults to false
      * @param options.cascade - If true, cascades the destroy operation to associations marked with `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when destroying the association. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when destroying the association; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when destroying the association. Defaults to an empty array
      * @returns The number of records deleted
      */
@@ -3366,7 +3368,7 @@ export default class Dream {
      * @param options.andAny - Optional andAny statement to apply to query before undestroying
      * @param options.skipHooks - If true, skips applying model hooks during the undestroy operation. Defaults to false
      * @param options.cascade - If false, skips undestroying associations marked `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when undestroying the association. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when undestroying the association; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when undestroying the association. Defaults to an empty array
      * @returns The number of records undestroyed
      */
@@ -3419,7 +3421,7 @@ export default class Dream {
      * @param options - Options for updating the association
      * @param options.and - Optional on statement to apply to query before updating
      * @param options.skipHooks - If true, skips applying model hooks during the update operation. Defaults to false
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when updating the association. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when updating the association; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when updating the association. Defaults to an empty array
      * @returns The number of updated records
      */

package/dist/cjs/src/dream/DreamClassTransactionBuilder.js

@@ -629,9 +629,11 @@ export default class DreamClassTransactionBuilder {
         return new Query(this.dreamInstance).txn(this.dreamTransaction);
     }
     /**
-     * Returns a query for this model which disregards default scopes
+     * Returns a query which bypasses user-removable default scopes, including on
+     * association loads. An STI child's reserved type discriminator remains
+     * enforced; query the STI base model to span its registered children.
      *
-     * @returns A query for this model which disregards default scopes
+     * @returns A query which bypasses user-removable default scopes
      */
     removeAllDefaultScopes() {
         return this.queryInstance().removeAllDefaultScopes();

package/dist/cjs/src/dream/DreamInstanceTransactionBuilder.js

@@ -190,7 +190,7 @@ export default class DreamInstanceTransactionBuilder {
      * @param options - Options for destroying the instance
      * @param options.skipHooks - If true, skips applying model hooks during the destroy operation. Defaults to false
      * @param options.cascade - If false, skips destroying associations marked `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when cascade destroying. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when cascade destroying; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when cascade destroying. Defaults to an empty array
      * @returns The instance that was destroyed
      */
@@ -212,7 +212,7 @@ export default class DreamInstanceTransactionBuilder {
      * @param options - Options for destroying the instance
      * @param options.skipHooks - If true, skips applying model hooks during the destroy operation. Defaults to false
      * @param options.cascade - If false, skips destroying associations marked `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when cascade destroying. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when cascade destroying; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when cascade destroying. Defaults to an empty array
      * @returns The instance that was destroyed
      */
@@ -234,7 +234,7 @@ export default class DreamInstanceTransactionBuilder {
      * @param options - Options for undestroying the instance
      * @param options.skipHooks - If true, skips applying model hooks during the undestroy operation. Defaults to false
      * @param options.cascade - If false, skips undestroying associations marked `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when cascade undestroying. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when cascade undestroying; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when cascade undestroying (soft delete is always bypassed). Defaults to an empty array
      * @returns The undestroyed instance
      */
@@ -403,7 +403,7 @@ export default class DreamInstanceTransactionBuilder {
      * @param attributes - The attributes to update on the association
      * @param updateAssociationOptions - Options for updating the association
      * @param updateAssociationOptions.where - Optional where statement to apply to query before updating
-     * @param updateAssociationOptions.bypassAllDefaultScopes - If true, bypasses all default scopes when updating the association. Defaults to false
+     * @param updateAssociationOptions.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when updating the association; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param updateAssociationOptions.defaultScopesToBypass - An array of default scope names to bypass when updating the association. Defaults to an empty array
      * @param updateAssociationOptions.skipHooks - If true, skips applying model hooks during the update operation. Defaults to false
      * @returns The number of updated records
@@ -460,7 +460,7 @@ export default class DreamInstanceTransactionBuilder {
      * @param options.andAny - Optional andAny statement to apply to query before destroying
      * @param options.skipHooks - If true, skips applying model hooks during the destroy operation. Defaults to false
      * @param options.cascade - If false, skips destroying associations marked `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when destroying the association. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when destroying the association; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when destroying the association. Defaults to an empty array
      * @returns The number of records deleted
      */
@@ -498,7 +498,7 @@ export default class DreamInstanceTransactionBuilder {
      * @param options.andAny - Optional andAny statement to apply to query before destroying
      * @param options.skipHooks - If true, skips applying model hooks during the destroy operation. Defaults to false
      * @param options.cascade - If true, cascades the destroy operation to associations marked with `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when destroying the association. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when destroying the association; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when destroying the association. Defaults to an empty array
      * @returns The number of records deleted
      */
@@ -531,7 +531,7 @@ export default class DreamInstanceTransactionBuilder {
      * @param options.andAny - Optional andAny statement to apply to query before undestroying
      * @param options.skipHooks - If true, skips applying model hooks during the undestroy operation. Defaults to false
      * @param options.cascade - If false, skips undestroying associations marked `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when undestroying the association. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when undestroying the association; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when undestroying the association. Defaults to an empty array
      * @returns The number of records undestroyed
      */

package/dist/cjs/src/dream/LoadBuilder.js

@@ -44,8 +44,9 @@ export default class LoadBuilder {
         return this;
     }
     /**
-     * Prevents all default scopes from applying when
-     * loading associations
+     * Prevents user-removable default scopes from applying when loading
+     * associations. An associated STI child's reserved type discriminator remains
+     * enforced; loading through its STI base still spans registered children.
      *
      * ```ts
      * const user = await User.firstOrFail()

package/dist/cjs/src/dream/Query.js

@@ -177,13 +177,13 @@ export default class Query {
     /**
      * @internal
      *
-     * Whether or not to bypass all default scopes for this Query
+     * Whether or not to bypass all user-removable default scopes for this Query
      */
     bypassAllDefaultScopes = false;
     /**
      * @internal
      *
-     * Whether or not to bypass all default scopes for this Query, but not associations
+     * Whether or not to bypass all user-removable default scopes for this Query, but not associations
      */
     bypassAllDefaultScopesExceptOnAssociations = false;
     /**
@@ -778,10 +778,12 @@ export default class Query {
         });
     }
     /**
-     * Prevents default scopes from applying when
-     * the Query is executed
+     * Prevents user-removable default scopes from applying when the Query is
+     * executed, including when associations are loaded. An STI child's reserved
+     * type discriminator remains enforced; query the STI base model to span its
+     * registered children.
      *
-     * @returns A new Query which will prevent default scopes from applying
+     * @returns A new Query which bypasses user-removable default scopes
      */
     removeAllDefaultScopes() {
         return this.clone({
@@ -1044,8 +1046,19 @@ export default class Query {
      * @returns A Kysely query. Depending on the type passed, it will return either a SelectQueryBuilder, DeleteQueryBuilder, or an UpdateQueryBuilder
      */
     toKysely(type) {
+        if (type !== 'select')
+            this.assertMutationPreservesAssociationQuery();
         return this.dbDriverInstance().toKysely(type);
     }
+    /**
+     * @internal
+     *
+     * Prevents mutation paths that discard an association query's ownership constraint.
+     */
+    assertMutationPreservesAssociationQuery() {
+        if (this.baseSelectQuery)
+            throw new NoUpdateOnAssociationQuery();
+    }
     /**
      * Applies transaction to the Query instance
      *
@@ -1904,7 +1917,7 @@ export default class Query {
      * @param options.cascade - If false, skips destroying associations marked `dependent: 'destroy'`. Defaults to true
      * @param options.lock - If true, each batch is re-selected with an exclusive row lock inside its own transaction before being destroyed, making the destroy a compare-and-set. Defaults to false
      * @param options.batchSize - The number of records to process per batch. Must be a positive integer. Defaults to 10 when `lock` is true, and to 1000 otherwise
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when cascade destroying. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when cascade destroying; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when cascade destroying. Defaults to an empty array
      * @returns The number of records that were removed
      * @throws InvalidBatchSize if `batchSize` is not a positive integer
@@ -2126,7 +2139,7 @@ export default class Query {
      * @param options.cascade - If false, skips destroying associations marked `dependent: 'destroy'`. Defaults to true
      * @param options.lock - If true, each batch is re-selected with an exclusive row lock inside its own transaction before being destroyed, making the destroy a compare-and-set. See {@link Query.destroy} for the full semantics. Defaults to false
      * @param options.batchSize - The number of records to process per batch. Must be a positive integer. Defaults to 10 when `lock` is true, and to 1000 otherwise
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when cascade destroying. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when cascade destroying; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when cascade destroying. Defaults to an empty array
      * @returns The number of records that were removed
      * @throws InvalidBatchSize if `batchSize` is not a positive integer
@@ -2156,7 +2169,7 @@ export default class Query {
      * @param options - Options for undestroying the instance
      * @param options.skipHooks - If true, skips applying model hooks during the undestroy operation. Defaults to false
      * @param options.cascade - If false, skips undestroying associations marked `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when cascade undestroying. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when cascade undestroying; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when cascade undestroying (soft delete is always bypassed). Defaults to an empty array
      * @returns The number of records that were removed
      * @throws BatchingIncompatibleWithLimitOrOffset if the query carries a `limit` or `offset`
@@ -2196,11 +2209,11 @@ export default class Query {
      * @returns The number of records that were removed
      */
     async delete() {
+        this.assertMutationPreservesAssociationQuery();
         return await this.dbDriverInstance().delete();
     }
     async update(attributesOrCb, { skipHooks, lock, batchSize } = {}) {
-        if (this.baseSelectQuery)
-            throw new NoUpdateOnAssociationQuery();
+        this.assertMutationPreservesAssociationQuery();
         if (Object.keys(this.innerJoinStatements).length)
             throw new NoUpdateAllOnJoins();
         if (Object.keys(this.leftJoinStatements).length)

package/dist/cjs/src/dream/QueryDriver/Base.js

@@ -18,6 +18,14 @@ export default class QueryDriverBase {
         this.connectionOverride = query['originalOpts'].connection;
         this.innerJoinDreamClasses = Object.freeze(query['originalOpts'].innerJoinDreamClasses || []);
     }
+    /**
+     * @internal
+     *
+     * Prevents mutation paths that discard an association query's ownership constraint.
+     */
+    assertMutationPreservesAssociationQuery() {
+        this.query['assertMutationPreservesAssociationQuery']();
+    }
     // eslint-disable-next-line @typescript-eslint/require-await
     static async ensureAllMigrationsHaveBeenRun(
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -110,6 +118,8 @@ export default class QueryDriverBase {
      * @returns A Kysely query. Depending on the type passed, it will return either a SelectQueryBuilder, DeleteQueryBuilder, or an UpdateQueryBuilder
      */
     toKysely(type) {
+        if (type !== 'select')
+            this.assertMutationPreservesAssociationQuery();
         throw new Error('implement toKysely in child class (if it makes sense)');
     }
     /**
@@ -543,6 +553,7 @@ export default class QueryDriverBase {
      */
     // eslint-disable-next-line @typescript-eslint/require-await
     async delete() {
+        this.assertMutationPreservesAssociationQuery();
         throw new Error('implement delete in child class');
     }
     /**
@@ -551,6 +562,7 @@ export default class QueryDriverBase {
      */
     // eslint-disable-next-line @typescript-eslint/require-await, @typescript-eslint/no-unused-vars
     async update(attributes) {
+        this.assertMutationPreservesAssociationQuery();
         throw new Error('implement update in child class');
     }
     /**

package/dist/cjs/src/dream/QueryDriver/Kysely.js

@@ -301,6 +301,8 @@ export default class KyselyQueryDriver extends QueryDriverBase {
      * @returns A Kysely query. Depending on the type passed, it will return either a SelectQueryBuilder, DeleteQueryBuilder, or an UpdateQueryBuilder
      */
     toKysely(type) {
+        if (type !== 'select')
+            this.assertMutationPreservesAssociationQuery();
         switch (type) {
             case 'select':
                 return this.buildSelect();
@@ -740,6 +742,7 @@ export default class KyselyQueryDriver extends QueryDriverBase {
      * @returns the number of deleted rows
      */
     async delete() {
+        this.assertMutationPreservesAssociationQuery();
         const deletionResult = await executeDatabaseQuery(this.buildDelete(), 'executeTakeFirst');
         return Number(deletionResult?.numDeletedRows || 0);
     }
@@ -748,6 +751,7 @@ export default class KyselyQueryDriver extends QueryDriverBase {
      * @returns the number of updated rows
      */
     async update(attributes) {
+        this.assertMutationPreservesAssociationQuery();
         const kyselyQuery = this.buildUpdate(attributes);
         const res = await executeDatabaseQuery(kyselyQuery, 'execute');
         const resultData = Array.from(res.entries())?.[0]?.[1];
@@ -1014,7 +1018,11 @@ export default class KyselyQueryDriver extends QueryDriverBase {
         return { kyselyQuery, clone: this.query };
     }
     columnsWithRequiredLoadColumns(columns) {
-        return uniq(compact([this.dreamClass.primaryKey, this.dreamClass['isSTIBase'] ? 'type' : null, ...columns]));
+        return uniq(compact([
+            this.dreamClass.primaryKey,
+            this.dreamClass['isSTIBase'] || this.dreamClass['isSTIChild'] ? 'type' : null,
+            ...columns,
+        ]));
     }
     /**
      * @internal
@@ -1784,12 +1792,13 @@ export default class KyselyQueryDriver extends QueryDriverBase {
         }, {});
     }
     conditionallyApplyDefaultScopes() {
-        if (this.query['bypassAllDefaultScopes'] || this.query['bypassAllDefaultScopesExceptOnAssociations'])
+        if (this.query['bypassAllDefaultScopesExceptOnAssociations'])
             return this.query;
         const thisScopes = this.dreamClass['scopes'].default;
         let query = this.query;
         for (const scope of thisScopes) {
             if (!shouldBypassDefaultScope(scope.method, {
+                bypassAllDefaultScopes: this.query['bypassAllDefaultScopes'],
                 defaultScopesToBypass: [
                     ...this.query['defaultScopesToBypass'],
                     ...this.query['defaultScopesToBypassExceptOnAssociations'],

package/dist/cjs/src/dream/internal/shouldBypassDefaultScope.js

@@ -1,9 +1,8 @@
+import { STI_SCOPE_NAME } from '../../decorators/class/STI.js';
 export default function shouldBypassDefaultScope(scopeName, { bypassAllDefaultScopes = false, defaultScopesToBypass, }) {
-    if (bypassAllDefaultScopes)
-        return true;
-    if (!defaultScopesToBypass.length)
-        return false;
     if (defaultScopesToBypass.includes(scopeName))
         return true;
+    if (bypassAllDefaultScopes)
+        return scopeName !== STI_SCOPE_NAME;
     return false;
 }

package/dist/cjs/src/dream/internal/sqlResultToDreamInstance.js

@@ -1,6 +1,9 @@
 import STIChildMissing from '../../errors/sti/STIChildMissing.js';
+import STIChildTypeMismatch from '../../errors/sti/STIChildTypeMismatch.js';
 import filterRowToKnownColumns from './filterRowToKnownColumns.js';
 export default function sqlResultToDreamInstance(dreamClass, sqlResult) {
+    if (dreamClass['isSTIChild'] && sqlResult.type !== dreamClass['sti'].value)
+        throw new STIChildTypeMismatch(dreamClass, sqlResult.type, sqlResult[dreamClass.primaryKey]);
     // base-model reads select `*`, so under schema/image skew (or with a
     // column declared in ignoredColumns but not yet dropped) the row can
     // contain columns the compiled schema doesn't know about. Passing such
@@ -32,7 +35,7 @@ export default function sqlResultToDreamInstance(dreamClass, sqlResult) {
 export function findExtendingDreamClass(dreamClass, type) {
     if (!dreamClass['extendedBy'])
         return undefined;
-    const extendingDreamClass = dreamClass['extendedBy'].find(extendingDreamClass => extendingDreamClass.sanitizedName === type);
+    const extendingDreamClass = dreamClass['extendedBy'].find(extendingDreamClass => extendingDreamClass['sti'].value === type);
     if (extendingDreamClass)
         return extendingDreamClass;
     return dreamClass['extendedBy']

package/dist/cjs/src/errors/NoUpdateOnAssociationQuery.js

@@ -1,7 +1,7 @@
 export default class NoUpdateOnAssociationQuery extends Error {
     get message() {
         return `
-udpate may not be called on an associationQuery. Use updateAssociation instead.
+Mutations may not be called on an associationQuery because its ownership constraint cannot be preserved. Use an association-specific mutation method or query the associated model with explicit conditions.
     `;
     }
 }

package/dist/cjs/src/errors/sti/STIChildTypeMismatch.js

@@ -0,0 +1,28 @@
+export default class STIChildTypeMismatch extends Error {
+    expectedDreamClass;
+    expectedType;
+    actualType;
+    baseDreamClass;
+    table;
+    primaryKeyValue;
+    constructor(expectedDreamClass, actualType, primaryKeyValue) {
+        super();
+        this.expectedDreamClass = expectedDreamClass;
+        this.expectedType = expectedDreamClass['sti'].value;
+        this.actualType = actualType;
+        this.baseDreamClass = expectedDreamClass['sti'].baseClass;
+        this.table = this.baseDreamClass.table;
+        this.primaryKeyValue = primaryKeyValue;
+    }
+    get message() {
+        return `
+Cannot hydrate STI child from a row with a different discriminator.
+Expected Dream class: ${this.expectedDreamClass.sanitizedName}
+Expected type: ${this.expectedType}
+Type specified in DB record: ${String(this.actualType)}
+STI base Dream class: ${this.baseDreamClass.sanitizedName}
+Table: ${this.table}
+Primary key value: ${String(this.primaryKeyValue)}
+    `;
+    }
+}

package/dist/esm/src/Dream.js

@@ -878,9 +878,11 @@ export default class Dream {
         });
     }
     /**
-     * Returns a query for this model which disregards default scopes
+     * Returns a query which bypasses user-removable default scopes, including on
+     * association loads. An STI child's reserved type discriminator remains
+     * enforced; query the STI base model to span its registered children.
      *
-     * @returns A query for this model which disregards default scopes
+     * @returns A query which bypasses user-removable default scopes
      */
     static removeAllDefaultScopes() {
         return this.query().removeAllDefaultScopes();
@@ -3141,7 +3143,7 @@ export default class Dream {
      * @param options - Options for destroying the instance
      * @param options.skipHooks - If true, skips applying model hooks during the destroy operation. Defaults to false
      * @param options.cascade - If false, skips destroying associations marked `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when cascade destroying. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when cascade destroying; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when cascade destroying. Defaults to an empty array
      * @returns The instance that was destroyed
      */
@@ -3166,7 +3168,7 @@ export default class Dream {
      * @param options - Options for destroying the instance
      * @param options.skipHooks - If true, skips applying model hooks during the destroy operation. Defaults to false
      * @param options.cascade - If false, skips destroying associations marked `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when cascade destroying. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when cascade destroying; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when cascade destroying. Defaults to an empty array
      * @returns The instance that was destroyed
      */
@@ -3188,7 +3190,7 @@ export default class Dream {
      * @param options - Options for undestroying the instance
      * @param options.skipHooks - If true, skips applying model hooks during the undestroy operation. Defaults to false
      * @param options.cascade - If false, skips undestroying associations marked `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when cascade undestroying. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when cascade undestroying; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when cascade undestroying (soft delete is always bypassed). Defaults to an empty array
      * @returns The undestroyed record
      */
@@ -3297,7 +3299,7 @@ export default class Dream {
      * @param options.andAny - Optional andAny statement to apply to query before destroying
      * @param options.skipHooks - If true, skips applying model hooks during the destroy operation. Defaults to false
      * @param options.cascade - If false, skips destroying associations marked `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when destroying the association. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when destroying the association; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when destroying the association. Defaults to an empty array
      * @returns The number of records deleted
      */
@@ -3333,7 +3335,7 @@ export default class Dream {
      * @param options.andAny - Optional andAny statement to apply to query before destroying
      * @param options.skipHooks - If true, skips applying model hooks during the destroy operation. Defaults to false
      * @param options.cascade - If true, cascades the destroy operation to associations marked with `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when destroying the association. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when destroying the association; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when destroying the association. Defaults to an empty array
      * @returns The number of records deleted
      */
@@ -3366,7 +3368,7 @@ export default class Dream {
      * @param options.andAny - Optional andAny statement to apply to query before undestroying
      * @param options.skipHooks - If true, skips applying model hooks during the undestroy operation. Defaults to false
      * @param options.cascade - If false, skips undestroying associations marked `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when undestroying the association. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when undestroying the association; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when undestroying the association. Defaults to an empty array
      * @returns The number of records undestroyed
      */
@@ -3419,7 +3421,7 @@ export default class Dream {
      * @param options - Options for updating the association
      * @param options.and - Optional on statement to apply to query before updating
      * @param options.skipHooks - If true, skips applying model hooks during the update operation. Defaults to false
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when updating the association. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when updating the association; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when updating the association. Defaults to an empty array
      * @returns The number of updated records
      */

package/dist/esm/src/dream/DreamClassTransactionBuilder.js

@@ -629,9 +629,11 @@ export default class DreamClassTransactionBuilder {
         return new Query(this.dreamInstance).txn(this.dreamTransaction);
     }
     /**
-     * Returns a query for this model which disregards default scopes
+     * Returns a query which bypasses user-removable default scopes, including on
+     * association loads. An STI child's reserved type discriminator remains
+     * enforced; query the STI base model to span its registered children.
      *
-     * @returns A query for this model which disregards default scopes
+     * @returns A query which bypasses user-removable default scopes
      */
     removeAllDefaultScopes() {
         return this.queryInstance().removeAllDefaultScopes();

package/dist/esm/src/dream/DreamInstanceTransactionBuilder.js

@@ -190,7 +190,7 @@ export default class DreamInstanceTransactionBuilder {
      * @param options - Options for destroying the instance
      * @param options.skipHooks - If true, skips applying model hooks during the destroy operation. Defaults to false
      * @param options.cascade - If false, skips destroying associations marked `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when cascade destroying. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when cascade destroying; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when cascade destroying. Defaults to an empty array
      * @returns The instance that was destroyed
      */
@@ -212,7 +212,7 @@ export default class DreamInstanceTransactionBuilder {
      * @param options - Options for destroying the instance
      * @param options.skipHooks - If true, skips applying model hooks during the destroy operation. Defaults to false
      * @param options.cascade - If false, skips destroying associations marked `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when cascade destroying. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when cascade destroying; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when cascade destroying. Defaults to an empty array
      * @returns The instance that was destroyed
      */
@@ -234,7 +234,7 @@ export default class DreamInstanceTransactionBuilder {
      * @param options - Options for undestroying the instance
      * @param options.skipHooks - If true, skips applying model hooks during the undestroy operation. Defaults to false
      * @param options.cascade - If false, skips undestroying associations marked `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when cascade undestroying. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when cascade undestroying; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when cascade undestroying (soft delete is always bypassed). Defaults to an empty array
      * @returns The undestroyed instance
      */
@@ -403,7 +403,7 @@ export default class DreamInstanceTransactionBuilder {
      * @param attributes - The attributes to update on the association
      * @param updateAssociationOptions - Options for updating the association
      * @param updateAssociationOptions.where - Optional where statement to apply to query before updating
-     * @param updateAssociationOptions.bypassAllDefaultScopes - If true, bypasses all default scopes when updating the association. Defaults to false
+     * @param updateAssociationOptions.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when updating the association; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param updateAssociationOptions.defaultScopesToBypass - An array of default scope names to bypass when updating the association. Defaults to an empty array
      * @param updateAssociationOptions.skipHooks - If true, skips applying model hooks during the update operation. Defaults to false
      * @returns The number of updated records
@@ -460,7 +460,7 @@ export default class DreamInstanceTransactionBuilder {
      * @param options.andAny - Optional andAny statement to apply to query before destroying
      * @param options.skipHooks - If true, skips applying model hooks during the destroy operation. Defaults to false
      * @param options.cascade - If false, skips destroying associations marked `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when destroying the association. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when destroying the association; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when destroying the association. Defaults to an empty array
      * @returns The number of records deleted
      */
@@ -498,7 +498,7 @@ export default class DreamInstanceTransactionBuilder {
      * @param options.andAny - Optional andAny statement to apply to query before destroying
      * @param options.skipHooks - If true, skips applying model hooks during the destroy operation. Defaults to false
      * @param options.cascade - If true, cascades the destroy operation to associations marked with `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when destroying the association. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when destroying the association; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when destroying the association. Defaults to an empty array
      * @returns The number of records deleted
      */
@@ -531,7 +531,7 @@ export default class DreamInstanceTransactionBuilder {
      * @param options.andAny - Optional andAny statement to apply to query before undestroying
      * @param options.skipHooks - If true, skips applying model hooks during the undestroy operation. Defaults to false
      * @param options.cascade - If false, skips undestroying associations marked `dependent: 'destroy'`. Defaults to true
-     * @param options.bypassAllDefaultScopes - If true, bypasses all default scopes when undestroying the association. Defaults to false
+     * @param options.bypassAllDefaultScopes - If true, bypasses user-removable default scopes when undestroying the association; an STI child's reserved discriminator remains enforced, including when associations are loaded. Defaults to false
      * @param options.defaultScopesToBypass - An array of default scope names to bypass when undestroying the association. Defaults to an empty array
      * @returns The number of records undestroyed
      */

package/dist/esm/src/dream/LoadBuilder.js

@@ -44,8 +44,9 @@ export default class LoadBuilder {
         return this;
     }
     /**
-     * Prevents all default scopes from applying when
-     * loading associations
+     * Prevents user-removable default scopes from applying when loading
+     * associations. An associated STI child's reserved type discriminator remains
+     * enforced; loading through its STI base still spans registered children.
      *
      * ```ts
      * const user = await User.firstOrFail()