@rvoh/dream 2.18.1 → 2.19.0

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

@@ -273,6 +273,23 @@ export default class QueryDriverBase {
     async max(columnName) {
         throw new Error('implement max in child class');
     }
+    /**
+     * Retrieves the max value of the specified column within each group,
+     * keyed by the value of the provided group column.
+     *
+     * ```ts
+     * await CompositionAsset.query().maxBy('name', 'score')
+     * // Map(2) { 'primary' => 9, 'secondary' => 4 }
+     * ```
+     *
+     * @param groupColumn - the column to group by
+     * @param aggregatedColumn - the column to take the max of within each group
+     * @returns A Map from each present group value to the max of the aggregated column in that group
+     */
+    // eslint-disable-next-line @typescript-eslint/require-await, @typescript-eslint/no-unused-vars
+    async maxBy(groupColumn, aggregatedColumn) {
+        throw new Error('implement maxBy in child class');
+    }
     /**
      * Retrieves the min value of the specified column
      * for this Query
@@ -289,6 +306,23 @@ export default class QueryDriverBase {
     async min(columnName) {
         throw new Error('implement min in child class');
     }
+    /**
+     * Retrieves the min value of the specified column within each group,
+     * keyed by the value of the provided group column.
+     *
+     * ```ts
+     * await CompositionAsset.query().minBy('name', 'score')
+     * // Map(2) { 'primary' => 1, 'secondary' => 4 }
+     * ```
+     *
+     * @param groupColumn - the column to group by
+     * @param aggregatedColumn - the column to take the min of within each group
+     * @returns A Map from each present group value to the min of the aggregated column in that group
+     */
+    // eslint-disable-next-line @typescript-eslint/require-await, @typescript-eslint/no-unused-vars
+    async minBy(groupColumn, aggregatedColumn) {
+        throw new Error('implement minBy in child class');
+    }
     /**
      * Retrieves the sum value of the specified column
      * for this Query
@@ -305,6 +339,23 @@ export default class QueryDriverBase {
     async sum(columnName) {
         throw new Error('implement sum in child class');
     }
+    /**
+     * Retrieves the sum of the specified column within each group,
+     * keyed by the value of the provided group column.
+     *
+     * ```ts
+     * await CompositionAsset.query().sumBy('name', 'score')
+     * // Map(2) { 'primary' => 10, 'secondary' => 4 }
+     * ```
+     *
+     * @param groupColumn - the column to group by
+     * @param aggregatedColumn - the column to sum within each group
+     * @returns A Map from each present group value to the sum of the aggregated column in that group
+     */
+    // eslint-disable-next-line @typescript-eslint/require-await, @typescript-eslint/no-unused-vars
+    async sumBy(groupColumn, aggregatedColumn) {
+        throw new Error('implement sumBy in child class');
+    }
     /**
      * Retrieves the average value of the specified column
      * for this Query
@@ -321,6 +372,23 @@ export default class QueryDriverBase {
     async avg(columnName) {
         throw new Error('implement avg in child class');
     }
+    /**
+     * Retrieves the average of the specified column within each group,
+     * keyed by the value of the provided group column.
+     *
+     * ```ts
+     * await CompositionAsset.query().avgBy('name', 'score')
+     * // Map(2) { 'primary' => 5, 'secondary' => 4 }
+     * ```
+     *
+     * @param groupColumn - the column to group by
+     * @param aggregatedColumn - the column to average within each group
+     * @returns A Map from each present group value to the average of the aggregated column in that group
+     */
+    // eslint-disable-next-line @typescript-eslint/require-await, @typescript-eslint/no-unused-vars
+    async avgBy(groupColumn, aggregatedColumn) {
+        throw new Error('implement avgBy in child class');
+    }
     /**
      * Retrieves the number of records in the database
      *
@@ -334,6 +402,22 @@ export default class QueryDriverBase {
     async count() {
         throw new Error('implement count in child class');
     }
+    /**
+     * Retrieves the number of records in each group, keyed by the
+     * value of the provided group column.
+     *
+     * ```ts
+     * await User.query().countBy('name')
+     * // Map(2) { 'fred' => 2, 'zed' => 1 }
+     * ```
+     *
+     * @param groupColumn - the column to group by
+     * @returns A Map from each present group value to the number of records in that group
+     */
+    // eslint-disable-next-line @typescript-eslint/require-await, @typescript-eslint/no-unused-vars
+    async countBy(groupColumn) {
+        throw new Error('implement countBy in child class');
+    }
     /**
      * @internal
      *