@rvoh/dream 0.36.4 → 0.38.0

package/README.md

@@ -360,7 +360,7 @@ class B extends A {
 
 @STI(A)
 class C extends A {
-  @deco.HasMany('X', { on: { something: true } })
+  @deco.HasMany('X', { and: { something: true } })
   public xx: X[]
 }
 

package/dist/cjs/src/Dream.js

@@ -772,11 +772,14 @@ class Dream {
     }
     /**
      * Returns a new instance of Query scoped to the given
-     * model class
+     * model class. Especially useful with {@link Query#toKysely}.
      *
      * ```ts
-     * await User.query().all()
-     * // [User{id: 1}, User{id: 2}, ...]
+     *  await Balloon.query().toKysely('update').
+     *  .set({
+     *    multicolor: sql`array_remove(multicolor, ${colorToRemoveFromAllBalloons})`,
+     *  })
+     *  .execute()
      * ```
      *
      * @returns A new Query instance scoped to this Dream class
@@ -786,17 +789,18 @@ class Dream {
         return new Query_js_1.default(this.prototype);
     }
     /**
-     * @internal
-     *
      * Returns a new instance of Query scoped to the given
-     * Dream instance
+     * model class. Especially useful with {@link Query#toKysely}.
      *
      * ```ts
-     * await user = User.first()
-     * await user.query()
+     *  await balloon.query().toKysely('update')
+     *  .set({
+     *    multicolor: sql`array_append(multicolor, 'red')`,
+     *  })
+     *  .execute()
      * ```
      *
-     * @returns A new Query instance scoped to this Dream instance
+     * @returns A new Query instance scoped to this Dream class
      *
      */
     query() {
@@ -2555,7 +2559,9 @@ class Dream {
      *
      * @param associationName - The name of the association to destroy
      * @param options - Options for destroying the association
-     * @param options.on - Optional where statement to apply to query before destroying
+     * @param options.and - Optional and statement to apply to query before destroying
+     * @param options.andNot - Optional andNot statement to apply to query before destroying
+     * @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
@@ -2567,10 +2573,10 @@ class Dream {
             throw new CannotDestroyAssociationOnUnpersistedDream_js_1.default(this, associationName);
         return await (0, destroyAssociation_js_1.default)(this, null, associationName, {
             ...(0, destroyOptions_js_1.destroyOptions)(options),
-            joinOnStatements: {
-                on: options?.on,
-                notOn: options?.notOn,
-                onAny: options?.onAny,
+            joinAndStatements: {
+                and: options?.and,
+                andNot: options?.andNot,
+                andAny: options?.andAny,
             },
         });
     }
@@ -2589,7 +2595,9 @@ class Dream {
      *
      * @param associationName - The name of the association to destroy
      * @param options - Options for destroying the association
-     * @param options.on - Optional where statement to apply to query before destroying
+     * @param options.and - Optional and statement to apply to query before destroying
+     * @param options.andNot - Optional andNot statement to apply to query before destroying
+     * @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
@@ -2601,10 +2609,10 @@ class Dream {
             throw new CannotDestroyAssociationOnUnpersistedDream_js_1.default(this, associationName);
         return await (0, destroyAssociation_js_1.default)(this, null, associationName, {
             ...(0, destroyOptions_js_1.reallyDestroyOptions)(options),
-            joinOnStatements: {
-                on: options?.on,
-                notOn: options?.notOn,
-                onAny: options?.onAny,
+            joinAndStatements: {
+                and: options?.and,
+                andNot: options?.andNot,
+                andAny: options?.andAny,
             },
         });
     }
@@ -2620,7 +2628,9 @@ class Dream {
      *
      * @param associationName - The name of the association to undestroy
      * @param options - Options for undestroying the association
-     * @param options.on - Optional where statement to apply to query before undestroying
+     * @param options.and - Optional and statement to apply to query before undestroying
+     * @param options.andNot - Optional andNot statement to apply to query before undestroying
+     * @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
@@ -2630,10 +2640,10 @@ class Dream {
     async undestroyAssociation(associationName, options) {
         return await (0, undestroyAssociation_js_1.default)(this, null, associationName, {
             ...(0, destroyOptions_js_1.undestroyOptions)(options),
-            joinOnStatements: {
-                on: options?.on,
-                notOn: options?.notOn,
-                onAny: options?.onAny,
+            joinAndStatements: {
+                and: options?.and,
+                andNot: options?.andNot,
+                andAny: options?.andAny,
             },
         });
     }
@@ -2649,11 +2659,11 @@ class Dream {
      * @returns A Query scoped to the specified association on the current instance
      *
      */
-    associationQuery(associationName, joinOnStatements) {
+    associationQuery(associationName, joinAndStatements) {
         if (this.isNewRecord)
             throw new CannotAssociationQueryOnUnpersistedDream_js_1.default(this, associationName);
         return (0, associationQuery_js_1.default)(this, null, associationName, {
-            joinOnStatements: joinOnStatements,
+            joinAndStatements: joinAndStatements,
             bypassAllDefaultScopes: scopeHelpers_js_1.DEFAULT_BYPASS_ALL_DEFAULT_SCOPES,
             defaultScopesToBypass: scopeHelpers_js_1.DEFAULT_DEFAULT_SCOPES_TO_BYPASS,
         });
@@ -2667,14 +2677,14 @@ class Dream {
      * ```ts
      * await user.createAssociation('posts', { body: 'hello world' })
      * await user.createAssociation('posts', { body: 'howyadoin' })
-     * await user.updateAssociation('posts', { body: 'goodbye world' }, { on: { body: 'hello world' }})
+     * await user.updateAssociation('posts', { body: 'goodbye world' }, { and: { body: 'hello world' }})
      * // 1
      * ```
      *
      * @param associationName - The name of the association to update
      * @param attributes - The attributes to update on the association
      * @param options - Options for updating the association
-     * @param options.on - Optional on statement to apply to query before updating
+     * @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.defaultScopesToBypass - An array of default scope names to bypass when updating the association. Defaults to an empty array
@@ -2684,10 +2694,10 @@ class Dream {
         if (this.isNewRecord)
             throw new CannotUpdateAssociationOnUnpersistedDream_js_1.default(this, associationName);
         return (0, associationUpdateQuery_js_1.default)(this, null, associationName, {
-            joinOnStatements: {
-                on: updateAssociationOptions?.on,
-                notOn: updateAssociationOptions?.notOn,
-                onAny: updateAssociationOptions?.onAny,
+            joinAndStatements: {
+                and: updateAssociationOptions?.and,
+                andNot: updateAssociationOptions?.andNot,
+                andAny: updateAssociationOptions?.andAny,
             },
             bypassAllDefaultScopes: updateAssociationOptions?.bypassAllDefaultScopes ?? scopeHelpers_js_1.DEFAULT_BYPASS_ALL_DEFAULT_SCOPES,
             defaultScopesToBypass: updateAssociationOptions?.defaultScopesToBypass ?? scopeHelpers_js_1.DEFAULT_DEFAULT_SCOPES_TO_BYPASS,

package/dist/cjs/src/decorators/field/association/HasMany.js

@@ -24,21 +24,21 @@ const shared_js_1 = require("./shared.js");
  * @param opts.dependent - Can be either "destroy" or undefined. If "destroy", this record will be cascade deleted if the base model is destroyed.
  * @param opts.distinct - Can be a column name, or else a boolean. If a column name, a distinct clause will be applied to the column. If true, a distinct clause will be applied to the primary key.
  * @param opts.foreignKey - A custom column name to use for the foreign key.
- * @param opts.on - An on clause to be applied when this association is loaded
- * @param opts.notOn - A not on clause to be applied when this association is loaded
- * @param opts.onAny - An onAny clause to be applied when this association is loaded
+ * @param opts.and - An and-clause to be applied when this association is loaded
+ * @param opts.andNot - A not and-clause to be applied when this association is loaded
+ * @param opts.andAny - An andAny clause to be applied when this association is loaded
  * @param opts.order - A custom order statement to apply to this association.
  * @param opts.polymorphic - If true, this association will be treated as a polymorphic association.
  * @param opts.preloadThroughColumns - An array of columns to pluck off the through association attached to this association. Can only be set if `through` is also set.
  * @param opts.primaryKeyOverride - A custom column name to use for the primary key.
- * @param opts.selfOn - Adds an on clause to an association between a column on the associated model and a column on this model.
- * @param opts.selfNotOn - Adds a not on clause to an association between a column on the associated model and a column on this model.
+ * @param opts.selfAnd - Adds an and-clause to an association between a column on the associated model and a column on this model.
+ * @param opts.selfAndNot - Adds a not and-clause to an association between a column on the associated model and a column on this model.
  * @param opts.source - Used in conjunction with 'through' to specify the source association on a child model.
  * @param opts.through - If passed, this association will travel through another association.
  * @param opts.withoutDefaultScopes - A list of default scopes to bypass when loading this association
  */
 function HasMany(globalAssociationNameOrNames, opts = {}) {
-    const { dependent, distinct, foreignKey, on, notOn, onAny, order, polymorphic = false, preloadThroughColumns, primaryKeyOverride = null, selfOn, selfNotOn, source, through, withoutDefaultScopes, } = opts;
+    const { dependent, distinct, foreignKey, and, andNot, andAny, order, polymorphic = false, preloadThroughColumns, primaryKeyOverride = null, selfAnd, selfAndNot, source, through, withoutDefaultScopes, } = opts;
     return function (_, context) {
         const key = context.name;
         context.addInitializer(function () {
@@ -60,21 +60,21 @@ function HasMany(globalAssociationNameOrNames, opts = {}) {
                 dreamClass,
                 dependent: dependent ?? null,
                 methodName: key,
-                on: on ?? null,
+                and: and ?? null,
             });
             const partialAssociation = (0, shared_js_1.associationPrimaryKeyAccessors)({
                 modelCB: () => (0, lookupModelByGlobalNameOrNames_js_1.default)(globalAssociationNameOrNames),
                 as: key,
                 dependent,
                 globalAssociationNameOrNames,
-                on,
-                notOn,
-                onAny,
+                and,
+                andNot,
+                andAny,
                 polymorphic,
                 preloadThroughColumns,
                 primaryKeyOverride,
-                selfOn,
-                selfNotOn,
+                selfAnd,
+                selfAndNot,
                 source: source || key,
                 type: 'HasMany',
                 withoutDefaultScopes,

package/dist/cjs/src/decorators/field/association/HasOne.js

@@ -23,20 +23,20 @@ const shared_js_1 = require("./shared.js");
  *
  * @param opts.dependent - Can be either "destroy" or undefined. If "destroy", this record will be cascade deleted if the base model is destroyed.
  * @param opts.foreignKey - A custom column name to use for the foreign key.
- * @param opts.on - An on clause to be applied when this association is loaded
- * @param opts.notOn - A not on clause to be applied when this association is loaded
- * @param opts.onAny - An onAny clause to be applied when this association is loaded
+ * @param opts.and - An and-clause to be applied when this association is loaded
+ * @param opts.andNot - A not and-clause to be applied when this association is loaded
+ * @param opts.andAny - An andAny clause to be applied when this association is loaded
  * @param opts.polymorphic - If true, this association will be treated as a polymorphic association.
  * @param opts.preloadThroughColumns - An array of columns to pluck off the through association attached to this association. Can only be set if `through` is also set.
  * @param opts.primaryKeyOverride - A custom column name to use for the primary key.
- * @param opts.selfOn - Adds an on clause to an association between a column on the associated model and a column on this model.
- * @param opts.selfNotOn - Adds a not on clause to an association between a column on the associated model and a column on this model.
+ * @param opts.selfAnd - Adds an and-clause to an association between a column on the associated model and a column on this model.
+ * @param opts.selfAndNot - Adds a not and-clause to an association between a column on the associated model and a column on this model.
  * @param opts.source - Used in conjunction with 'through' to specify the source association on a child model.
  * @param opts.through - If passed, this association will travel through another association.
  * @param opts.withoutDefaultScopes - A list of default scopes to bypass when loading this association
  */
 function HasOne(globalAssociationNameOrNames, opts = {}) {
-    const { dependent, foreignKey, on, notOn, onAny, polymorphic = false, preloadThroughColumns, primaryKeyOverride = null, selfOn, selfNotOn, source, through, withoutDefaultScopes, } = opts;
+    const { dependent, foreignKey, and, andNot, andAny, polymorphic = false, preloadThroughColumns, primaryKeyOverride = null, selfAnd, selfAndNot, source, through, withoutDefaultScopes, } = opts;
     return function (_, context) {
         const key = context.name;
         context.addInitializer(function () {
@@ -58,21 +58,21 @@ function HasOne(globalAssociationNameOrNames, opts = {}) {
                 dreamClass,
                 dependent: dependent ?? null,
                 methodName: key,
-                on: on ?? null,
+                and: and ?? null,
             });
             const partialAssociation = (0, shared_js_1.associationPrimaryKeyAccessors)({
                 modelCB: () => (0, lookupModelByGlobalNameOrNames_js_1.default)(globalAssociationNameOrNames),
                 as: key,
                 dependent,
                 globalAssociationNameOrNames,
-                on,
-                notOn,
-                onAny,
+                and,
+                andNot,
+                andAny,
                 polymorphic,
                 preloadThroughColumns,
                 primaryKeyOverride,
-                selfOn,
-                selfNotOn,
+                selfAnd,
+                selfAndNot,
                 source: source || key,
                 through,
                 type: 'HasOne',

package/dist/cjs/src/decorators/field/association/shared.js

@@ -12,7 +12,7 @@ const constants_js_1 = require("../../../dream/constants.js");
 const InvalidComputedForeignKey_js_1 = require("../../../errors/associations/InvalidComputedForeignKey.js");
 const NonLoadedAssociation_js_1 = require("../../../errors/associations/NonLoadedAssociation.js");
 const CannotDefineAssociationWithBothDependentAndPassthrough_js_1 = require("../../../errors/CannotDefineAssociationWithBothDependentAndPassthrough.js");
-const CannotDefineAssociationWithBothDependentAndRequiredOnClause_js_1 = require("../../../errors/CannotDefineAssociationWithBothDependentAndRequiredOnClause.js");
+const CannotDefineAssociationWithBothDependentAndRequiredAndClause_js_1 = require("../../../errors/CannotDefineAssociationWithBothDependentAndRequiredAndClause.js");
 const camelize_js_1 = require("../../../helpers/camelize.js");
 const freezeBaseClassArrayMap_js_1 = require("../../helpers/freezeBaseClassArrayMap.js");
 const associationToGetterSetterProp_js_1 = require("./associationToGetterSetterProp.js");
@@ -122,11 +122,11 @@ association: ${this.as}
         },
     };
 }
-function validateHasStatementArgs({ dreamClass, dependent, methodName, on, }) {
-    const hasPassthroughOn = Object.values(on || {}).find(val => val === constants_js_1.DreamConst.passthrough);
-    const hasRequiredOn = Object.values(on || {}).find(val => val === constants_js_1.DreamConst.required);
-    if (dependent && hasPassthroughOn)
+function validateHasStatementArgs({ dreamClass, dependent, methodName, and, }) {
+    const hasPassthroughAnd = Object.values(and || {}).find(val => val === constants_js_1.DreamConst.passthrough);
+    const hasRequiredAnd = Object.values(and || {}).find(val => val === constants_js_1.DreamConst.required);
+    if (dependent && hasPassthroughAnd)
         throw new CannotDefineAssociationWithBothDependentAndPassthrough_js_1.default(dreamClass, methodName);
-    if (dependent && hasRequiredOn)
-        throw new CannotDefineAssociationWithBothDependentAndRequiredOnClause_js_1.default(dreamClass, methodName);
+    if (dependent && hasRequiredAnd)
+        throw new CannotDefineAssociationWithBothDependentAndRequiredAndClause_js_1.default(dreamClass, methodName);
 }

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

@@ -313,11 +313,11 @@ class DreamInstanceTransactionBuilder {
      *
      * @returns A Query scoped to the specified association on the current instance
      */
-    associationQuery(associationName, joinOnStatements) {
+    associationQuery(associationName, joinAndStatements) {
         if (this.dreamInstance.isNewRecord)
             throw new CannotAssociationQueryOnUnpersistedDream_js_1.default(this.dreamInstance, associationName);
         return (0, associationQuery_js_1.default)(this.dreamInstance, this.dreamTransaction, associationName, {
-            joinOnStatements: joinOnStatements,
+            joinAndStatements: joinAndStatements,
             bypassAllDefaultScopes: scopeHelpers_js_1.DEFAULT_BYPASS_ALL_DEFAULT_SCOPES,
             defaultScopesToBypass: scopeHelpers_js_1.DEFAULT_DEFAULT_SCOPES_TO_BYPASS,
         });
@@ -332,7 +332,7 @@ class DreamInstanceTransactionBuilder {
      * await ApplicationModel.transaction(async txn => {
      *   await user.txn(txn).createAssociation('posts', { body: 'hello world' })
      *   await user.txn(txn).createAssociation('posts', { body: 'howyadoin' })
-     *   await user.txn(txn).updateAssociation('posts', { body: 'goodbye world' }, { on: { body: 'hello world' }})
+     *   await user.txn(txn).updateAssociation('posts', { body: 'goodbye world' }, { and: { body: 'hello world' }})
      *   // 1
      * })
      * ```
@@ -350,10 +350,10 @@ class DreamInstanceTransactionBuilder {
         if (this.dreamInstance.isNewRecord)
             throw new CannotUpdateAssociationOnUnpersistedDream_js_1.default(this.dreamInstance, associationName);
         return await (0, associationUpdateQuery_js_1.default)(this.dreamInstance, this.dreamTransaction, associationName, {
-            joinOnStatements: {
-                on: updateAssociationOptions?.on,
-                notOn: updateAssociationOptions?.notOn,
-                onAny: updateAssociationOptions?.onAny,
+            joinAndStatements: {
+                and: updateAssociationOptions?.and,
+                andNot: updateAssociationOptions?.andNot,
+                andAny: updateAssociationOptions?.andAny,
             },
             bypassAllDefaultScopes: updateAssociationOptions?.bypassAllDefaultScopes ?? scopeHelpers_js_1.DEFAULT_BYPASS_ALL_DEFAULT_SCOPES,
             defaultScopesToBypass: updateAssociationOptions?.defaultScopesToBypass ?? scopeHelpers_js_1.DEFAULT_DEFAULT_SCOPES_TO_BYPASS,
@@ -385,13 +385,15 @@ class DreamInstanceTransactionBuilder {
      *
      * ```ts
      * await ApplicationModel.transaction(async txn => {
-     *   await user.txn(txn).destroyAssociation('posts', { on: { body: 'hello world' } })
+     *   await user.txn(txn).destroyAssociation('posts', { and: { body: 'hello world' } })
      * })
      * ```
      *
      * @param associationName - The name of the association to destroy
      * @param options - Options for destroying the association
-     * @param options.on - Optional where statement to apply to query before destroying
+     * @param options.and - Optional and statement to apply to query before destroying
+     * @param options.andNot - Optional andNot statement to apply to query before destroying
+     * @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
@@ -403,10 +405,10 @@ class DreamInstanceTransactionBuilder {
             throw new CannotDestroyAssociationOnUnpersistedDream_js_1.default(this.dreamInstance, associationName);
         return await (0, destroyAssociation_js_1.default)(this.dreamInstance, this.dreamTransaction, associationName, {
             ...(0, destroyOptions_js_1.destroyOptions)(options),
-            joinOnStatements: {
-                on: options?.on,
-                notOn: options?.notOn,
-                onAny: options?.onAny,
+            joinAndStatements: {
+                and: options?.and,
+                andNot: options?.andNot,
+                andAny: options?.andAny,
             },
         });
     }
@@ -421,13 +423,15 @@ class DreamInstanceTransactionBuilder {
      *
      * ```ts
      * await ApplicationModel.transaction(async txn => {
-     *   await user.txn(txn).reallyDestroyAssociation('posts', { on: { body: 'hello world' } })
+     *   await user.txn(txn).reallyDestroyAssociation('posts', { and: { body: 'hello world' } })
      * })
      * ```
      *
      * @param associationName - The name of the association to destroy
      * @param options - Options for destroying the association
-     * @param options.on - Optional where statement to apply to query before destroying
+     * @param options.and - Optional and statement to apply to query before destroying
+     * @param options.andNot - Optional andNot statement to apply to query before destroying
+     * @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
@@ -439,10 +443,10 @@ class DreamInstanceTransactionBuilder {
             throw new CannotDestroyAssociationOnUnpersistedDream_js_1.default(this.dreamInstance, associationName);
         return await (0, destroyAssociation_js_1.default)(this.dreamInstance, this.dreamTransaction, associationName, {
             ...(0, destroyOptions_js_1.reallyDestroyOptions)(options),
-            joinOnStatements: {
-                on: options?.on,
-                notOn: options?.notOn,
-                onAny: options?.onAny,
+            joinAndStatements: {
+                and: options?.and,
+                andNot: options?.andNot,
+                andAny: options?.andAny,
             },
         });
     }
@@ -453,12 +457,14 @@ class DreamInstanceTransactionBuilder {
      * will also be undeleted.
      *
      * ```ts
-     * await user.undestroyAssociation('posts', { on: { body: 'hello world' } })
+     * await user.undestroyAssociation('posts', { and: { body: 'hello world' } })
      * ```
      *
      * @param associationName - The name of the association to undestroy
      * @param options - Options for undestroying the association
-     * @param options.on - Optional where statement to apply to query before undestroying
+     * @param options.and - Optional and statement to apply to query before undestroying
+     * @param options.andNot - Optional andNot statement to apply to query before undestroying
+     * @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
@@ -468,10 +474,10 @@ class DreamInstanceTransactionBuilder {
     async undestroyAssociation(associationName, options) {
         return await (0, undestroyAssociation_js_1.default)(this.dreamInstance, this.dreamTransaction, associationName, {
             ...(0, destroyOptions_js_1.undestroyOptions)(options),
-            joinOnStatements: {
-                on: options?.on,
-                notOn: options?.notOn,
-                onAny: options?.onAny,
+            joinAndStatements: {
+                and: options?.and,
+                andNot: options?.andNot,
+                andAny: options?.andAny,
             },
         });
     }