@rvoh/dream 2.28.3 → 2.29.0

package/dist/cjs/src/Dream.js

@@ -878,6 +878,8 @@ export default class Dream {
         });
     }
     /**
+     * @deprecated Use {@link removeDefaultScope} instead. This method will become private in v3.
+     *
      * 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.
@@ -885,7 +887,7 @@ export default class Dream {
      * @returns A query which bypasses user-removable default scopes
      */
     static removeAllDefaultScopes() {
-        return this.query().removeAllDefaultScopes();
+        return this.query()['removeAllDefaultScopes']();
     }
     /**
      * imports an object from the IOC. This is usually done in rare cases,
@@ -3183,7 +3185,7 @@ export default class Dream {
      * this will raise an exception.
      *
      * ```ts
-     * const user = await User.removeAllDefaultScopes().last()
+     * const user = await User.removeDefaultScope('dream:SoftDelete').last()
      * await user.undestroy()
      * ```
      *

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

@@ -629,6 +629,8 @@ export default class DreamClassTransactionBuilder {
         return new Query(this.dreamInstance).txn(this.dreamTransaction);
     }
     /**
+     * @deprecated Use {@link removeDefaultScope} instead. This method will become private in v3.
+     *
      * 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.
@@ -636,7 +638,7 @@ export default class DreamClassTransactionBuilder {
      * @returns A query which bypasses user-removable default scopes
      */
     removeAllDefaultScopes() {
-        return this.queryInstance().removeAllDefaultScopes();
+        return this.queryInstance()['removeAllDefaultScopes']();
     }
     /**
      * Prevents a specific default scope from applying when

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

@@ -227,7 +227,7 @@ export default class DreamInstanceTransactionBuilder {
      * this will raise an exception.
      *
      * ```ts
-     * const user = await User.removeAllDefaultScopes().last()
+     * const user = await User.removeDefaultScope('dream:SoftDelete').last()
      * await user.txn(txn).undestroy()
      * ```
      *

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

@@ -44,6 +44,8 @@ export default class LoadBuilder {
         return this;
     }
     /**
+     * @deprecated Use {@link removeDefaultScope} instead. This method will become private in v3.
+     *
      * 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.
@@ -52,14 +54,14 @@ export default class LoadBuilder {
      * const user = await User.firstOrFail()
      * const loaded = await user
      *   .load('posts')
-     *   .removeAllDefaultScopes()
+     *   .removeDefaultScope('dream:SoftDelete')
      *   .execute()
      * ```
      *
      * @returns The LoadBuilder instance for chaining
      */
     removeAllDefaultScopes() {
-        this.query = this.query.removeAllDefaultScopes();
+        this.query = this.query['removeAllDefaultScopes']();
         return this;
     }
     /**

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

@@ -778,6 +778,8 @@ export default class Query {
         });
     }
     /**
+     * @deprecated Use {@link removeDefaultScope} instead. This method will become private in v3.
+     *
      * 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

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

@@ -1,6 +1,6 @@
 export default function applyScopeBypassingSettingsToQuery(query, { bypassAllDefaultScopes, defaultScopesToBypass, }) {
     if (bypassAllDefaultScopes)
-        query = query.removeAllDefaultScopes();
+        query = query['removeAllDefaultScopes']();
     defaultScopesToBypass.forEach(defaultScopeToBypass => {
         query = query.removeDefaultScope(defaultScopeToBypass);
     });

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

@@ -21,7 +21,7 @@ export default async function loadDependentDestroyTree(dream, txn, { reallyDestr
         loadBuilder = loadBuilder.load(...args);
     }
     if (bypassAllDefaultScopes) {
-        loadBuilder = loadBuilder.removeAllDefaultScopes();
+        loadBuilder = loadBuilder['removeAllDefaultScopes']();
     }
     else {
         for (const scopeName of defaultScopesToBypass) {

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

@@ -10,7 +10,9 @@ export default async function reload(dream, txn = null) {
     // we have persisted are not yet propagated
     else
         query = query.connection('primary');
-    query = query.removeAllDefaultScopes().where({ [dream['_primaryKey']]: dream.primaryKeyValue() });
+    query = query['removeAllDefaultScopes']().where({
+        [dream['_primaryKey']]: dream.primaryKeyValue(),
+    });
     const reloadedRecord = await query.firstOrFail();
     dream.setAttributes(reloadedRecord.getAttributes());
     dream['freezeAttributes']();

package/dist/esm/src/Dream.js

@@ -878,6 +878,8 @@ export default class Dream {
         });
     }
     /**
+     * @deprecated Use {@link removeDefaultScope} instead. This method will become private in v3.
+     *
      * 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.
@@ -885,7 +887,7 @@ export default class Dream {
      * @returns A query which bypasses user-removable default scopes
      */
     static removeAllDefaultScopes() {
-        return this.query().removeAllDefaultScopes();
+        return this.query()['removeAllDefaultScopes']();
     }
     /**
      * imports an object from the IOC. This is usually done in rare cases,
@@ -3183,7 +3185,7 @@ export default class Dream {
      * this will raise an exception.
      *
      * ```ts
-     * const user = await User.removeAllDefaultScopes().last()
+     * const user = await User.removeDefaultScope('dream:SoftDelete').last()
      * await user.undestroy()
      * ```
      *

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

@@ -629,6 +629,8 @@ export default class DreamClassTransactionBuilder {
         return new Query(this.dreamInstance).txn(this.dreamTransaction);
     }
     /**
+     * @deprecated Use {@link removeDefaultScope} instead. This method will become private in v3.
+     *
      * 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.
@@ -636,7 +638,7 @@ export default class DreamClassTransactionBuilder {
      * @returns A query which bypasses user-removable default scopes
      */
     removeAllDefaultScopes() {
-        return this.queryInstance().removeAllDefaultScopes();
+        return this.queryInstance()['removeAllDefaultScopes']();
     }
     /**
      * Prevents a specific default scope from applying when

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

@@ -227,7 +227,7 @@ export default class DreamInstanceTransactionBuilder {
      * this will raise an exception.
      *
      * ```ts
-     * const user = await User.removeAllDefaultScopes().last()
+     * const user = await User.removeDefaultScope('dream:SoftDelete').last()
      * await user.txn(txn).undestroy()
      * ```
      *

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

@@ -44,6 +44,8 @@ export default class LoadBuilder {
         return this;
     }
     /**
+     * @deprecated Use {@link removeDefaultScope} instead. This method will become private in v3.
+     *
      * 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.
@@ -52,14 +54,14 @@ export default class LoadBuilder {
      * const user = await User.firstOrFail()
      * const loaded = await user
      *   .load('posts')
-     *   .removeAllDefaultScopes()
+     *   .removeDefaultScope('dream:SoftDelete')
      *   .execute()
      * ```
      *
      * @returns The LoadBuilder instance for chaining
      */
     removeAllDefaultScopes() {
-        this.query = this.query.removeAllDefaultScopes();
+        this.query = this.query['removeAllDefaultScopes']();
         return this;
     }
     /**

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

@@ -778,6 +778,8 @@ export default class Query {
         });
     }
     /**
+     * @deprecated Use {@link removeDefaultScope} instead. This method will become private in v3.
+     *
      * 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

package/dist/esm/src/dream/internal/applyScopeBypassingSettingsToQuery.js

@@ -1,6 +1,6 @@
 export default function applyScopeBypassingSettingsToQuery(query, { bypassAllDefaultScopes, defaultScopesToBypass, }) {
     if (bypassAllDefaultScopes)
-        query = query.removeAllDefaultScopes();
+        query = query['removeAllDefaultScopes']();
     defaultScopesToBypass.forEach(defaultScopeToBypass => {
         query = query.removeDefaultScope(defaultScopeToBypass);
     });

package/dist/esm/src/dream/internal/loadDependentDestroyTree.js

@@ -21,7 +21,7 @@ export default async function loadDependentDestroyTree(dream, txn, { reallyDestr
         loadBuilder = loadBuilder.load(...args);
     }
     if (bypassAllDefaultScopes) {
-        loadBuilder = loadBuilder.removeAllDefaultScopes();
+        loadBuilder = loadBuilder['removeAllDefaultScopes']();
     }
     else {
         for (const scopeName of defaultScopesToBypass) {

package/dist/esm/src/dream/internal/reload.js

@@ -10,7 +10,9 @@ export default async function reload(dream, txn = null) {
     // we have persisted are not yet propagated
     else
         query = query.connection('primary');
-    query = query.removeAllDefaultScopes().where({ [dream['_primaryKey']]: dream.primaryKeyValue() });
+    query = query['removeAllDefaultScopes']().where({
+        [dream['_primaryKey']]: dream.primaryKeyValue(),
+    });
     const reloadedRecord = await query.firstOrFail();
     dream.setAttributes(reloadedRecord.getAttributes());
     dream['freezeAttributes']();

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

@@ -594,6 +594,8 @@ export default class Dream {
      */
     static get associationNames(): string[];
     /**
+     * @deprecated Use {@link removeDefaultScope} instead. This method will become private in v3.
+     *
      * 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.
@@ -2508,7 +2510,7 @@ export default class Dream {
      * this will raise an exception.
      *
      * ```ts
-     * const user = await User.removeAllDefaultScopes().last()
+     * const user = await User.removeDefaultScope('dream:SoftDelete').last()
      * await user.undestroy()
      * ```
      *

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

@@ -1,7 +1,7 @@
 import { SelectArg, SelectExpression } from 'kysely';
 import Dream from '../Dream.js';
 import { PassthroughOnClause, WhereStatement } from '../types/associations/shared.js';
-import { CreateOrFindByExtraOpts, DefaultScopeName, DreamColumnNames, DreamSerializerKey, FindablePropertiesForClass, OrderDir, PassthroughColumnNames, PluckEachArgs, PrimaryKeyForFind, TableColumnNames, UpdateableProperties, UpdateOrCreateByExtraOpts, ValidatedPluckEachColumnNames } from '../types/dream.js';
+import { AllDefaultScopeNames, CreateOrFindByExtraOpts, DreamColumnNames, DreamSerializerKey, FindablePropertiesForClass, OrderDir, PassthroughColumnNames, PluckEachArgs, PrimaryKeyForFind, TableColumnNames, UpdateableProperties, UpdateOrCreateByExtraOpts, ValidatedPluckEachColumnNames } from '../types/dream.js';
 import { BaseModelColumnTypes, FindEachOpts, LoadForModifierFn, QueryWithJoinedAssociationsType, QueryWithJoinedAssociationsTypeAndNoPreload } from '../types/query.js';
 import { JoinedAssociation, JoinedAssociationsTypeFromAssociations, VariadicJoinsArgs, VariadicLeftJoinLoadArgs, VariadicLoadArgs } from '../types/variadic.js';
 import DreamTransaction from './DreamTransaction.js';
@@ -599,6 +599,8 @@ export default class DreamClassTransactionBuilder<DreamClass extends typeof Drea
      */
     queryInstance<I extends DreamClassTransactionBuilder<DreamClass, DreamInstance>>(this: I): Query<DreamInstance>;
     /**
+     * @deprecated Use {@link removeDefaultScope} instead. This method will become private in v3.
+     *
      * 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.
@@ -612,7 +614,7 @@ export default class DreamClassTransactionBuilder<DreamClass extends typeof Drea
      *
      * @returns A new Query which will prevent a specific default scope from applying
      */
-    removeDefaultScope<I extends DreamClassTransactionBuilder<DreamClass, DreamInstance>>(this: I, scopeName: DefaultScopeName<DreamInstance>): Query<DreamInstance>;
+    removeDefaultScope<I extends DreamClassTransactionBuilder<DreamClass, DreamInstance>>(this: I, scopeName: AllDefaultScopeNames<DreamInstance>): Query<DreamInstance>;
     /**
      * Returns the last record corresponding to the
      * model, ordered by primary key.

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

@@ -207,7 +207,7 @@ export default class DreamInstanceTransactionBuilder<DreamInstance extends Dream
      * this will raise an exception.
      *
      * ```ts
-     * const user = await User.removeAllDefaultScopes().last()
+     * const user = await User.removeDefaultScope('dream:SoftDelete').last()
      * await user.txn(txn).undestroy()
      * ```
      *

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

@@ -41,6 +41,8 @@ export default class LoadBuilder<DreamInstance extends Dream> {
      */
     removeDefaultScope<I extends LoadBuilder<DreamInstance>>(this: I, scopeName: AllDefaultScopeNames<DreamInstance>): I;
     /**
+     * @deprecated Use {@link removeDefaultScope} instead. This method will become private in v3.
+     *
      * 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.
@@ -49,7 +51,7 @@ export default class LoadBuilder<DreamInstance extends Dream> {
      * const user = await User.firstOrFail()
      * const loaded = await user
      *   .load('posts')
-     *   .removeAllDefaultScopes()
+     *   .removeDefaultScope('dream:SoftDelete')
      *   .execute()
      * ```
      *

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

@@ -511,6 +511,8 @@ export default class Query<DreamInstance extends Dream, QueryTypeOpts extends Re
      */
     private setAssociationQueryBase;
     /**
+     * @deprecated Use {@link removeDefaultScope} instead. This method will become private in v3.
+     *
      * 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