@taylordb/query-builder 0.9.0 → 0.9.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 TaylorDB
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -111,3 +111,45 @@ const aggregates = await qb
   })
   .execute();
 ```
+
+## Recipes
+
+### Select with Relations
+
+You can use the `with` method to fetch related records from a linked table.
+
+```typescript
+// Assuming 'customers' has a link field 'orders' to the 'orders' table
+const customersWithOrders = await qb
+  .selectFrom('customers')
+  .select(['firstName', 'lastName'])
+  .with({
+    orders: qb => qb.select(['orderDate', 'total']),
+  })
+  .execute();
+```
+
+### Cross-Filters
+
+You can filter records in one table based on the values in a linked table.
+
+```typescript
+// Get all customers who have placed an order with a total greater than 100
+const highValueCustomers = await qb
+  .selectFrom('customers')
+  .where('orders', 'hasAnyOf', qb => qb.where('total', '>', 100))
+  .execute();
+```
+
+### Conditional Updates
+
+You can use `where` clauses to update only the records that match a specific condition.
+
+```typescript
+// Update the status of all orders placed before a certain date
+const { affectedRecords } = await qb
+  .update('orders')
+  .set({ status: 'archived' })
+  .where('orderDate', '<', '2023-01-01')
+  .execute();
+```

package/dist/cjs/aggregation-query-builder.d.ts

@@ -2,23 +2,115 @@ import type { AggregateNode, AggregateRecord } from './@types/aggregate.js';
 import type { AnyDB } from './@types/internal-types.js';
 import { Executor } from './executor.js';
 import { FilterableQueryBuilder } from './where-query-builder.js';
+/**
+ * A query builder for performing aggregation queries.
+ * @template DB - The database type.
+ * @template TableName - The name of the table to aggregate from.
+ * @template TGroupBy - The fields to group by.
+ * @template TAggregations - The aggregations to perform.
+ */
 export declare class AggregationQueryBuilder<DB extends AnyDB, TableName extends keyof DB, TGroupBy extends readonly (keyof DB[TableName] & string)[] = [], TAggregations extends {
     [K in keyof DB[TableName] & string]?: readonly (keyof DB[TableName][K]['aggregations'])[];
 } = object> extends FilterableQueryBuilder<DB, TableName> {
     #private;
     constructor(node: AggregateNode, executor: Executor);
+    /**
+     * Groups the results by a specified field.
+     * @param field - The field to group by.
+     * @param direction - The sort direction for the grouping.
+     * @returns A new `AggregationQueryBuilder` instance with the grouping applied.
+     *
+     * @example
+     * ```typescript
+     * const userCounts = await qb
+     *   .aggregateFrom('users')
+     *   .groupBy('role')
+     *   .withAggregates({ id: ['count'] })
+     *   .execute();
+     * ```
+     */
     groupBy<const TField extends keyof DB[TableName] & string>(field: TField, direction?: 'asc' | 'desc'): AggregationQueryBuilder<DB, TableName, [
         ...TGroupBy,
         TField
     ], TAggregations>;
+    /**
+     * Specifies the aggregations to perform.
+     * @param aggregates - An object where the keys are field names and the values are arrays of aggregation functions.
+     * @returns A new `AggregationQueryBuilder` instance with the aggregations applied.
+     *
+     * @example
+     * ```typescript
+     * const userStats = await qb
+     *   .aggregateFrom('users')
+     *   .withAggregates({
+     *     id: ['count'],
+     *     age: ['avg', 'sum'],
+     *   })
+     *   .execute();
+     * ```
+     */
     withAggregates<const T extends {
         [K in keyof DB[TableName] & string]?: readonly (keyof DB[TableName][K]['aggregations'])[];
     }>(aggregates: T): AggregationQueryBuilder<DB, TableName, TGroupBy, TAggregations & T>;
+    /**
+     * Sets the maximum number of records to return.
+     * @param count - The maximum number of records.
+     * @returns A new `AggregationQueryBuilder` instance with the limit applied.
+     */
     limit(count: number): AggregationQueryBuilder<DB, TableName, TGroupBy, TAggregations>;
+    /**
+     * Sets the number of records to skip.
+     * @param count - The number of records to skip.
+     * @returns A new `AggregationQueryBuilder` instance with the offset applied.
+     */
     offset(count: number): AggregationQueryBuilder<DB, TableName, TGroupBy, TAggregations>;
+    /**
+     * Paginates the results.
+     * @param page - The page number to retrieve.
+     * @param limit - The number of records per page.
+     * @returns A new `AggregationQueryBuilder` instance with pagination applied.
+     */
     paginate(page: number, limit: number): AggregationQueryBuilder<DB, TableName, TGroupBy, TAggregations>;
+    /**
+     * Sorts the results by a specified field.
+     * @param field - The field to sort by.
+     * @param direction - The sort direction ('asc' or 'desc').
+     * @returns A new `AggregationQueryBuilder` instance with the sorting applied.
+     */
     orderBy(field: keyof DB[TableName], direction?: 'asc' | 'desc'): AggregationQueryBuilder<DB, TableName, TGroupBy, TAggregations>;
+    /**
+     * Executes the aggregation query.
+     * @returns A promise that resolves with an array of the aggregation results.
+     *
+     * @example
+     * ```typescript
+     * const userCounts = await qb
+     *   .aggregateFrom('users')
+     *   .groupBy('role')
+     *   .withAggregates({ id: ['count'] })
+     *   .execute();
+     * ```
+     */
     execute(): Promise<AggregateRecord<DB, TableName, TGroupBy, TAggregations>[]>;
+    /**
+     * Subscribes to the results of the aggregation query.
+     * @param callback - A callback function that will be called with the results of the aggregation query.
+     * @returns A function to unsubscribe from the query.
+     *
+     * @example
+     * ```typescript
+     * const unsubscribe = qb
+     *   .aggregateFrom('users')
+     *   .groupBy('role')
+     *   .withAggregates({ id: ['count'] })
+     *   .subscribe((userCounts) => {
+     *     console.log('User counts by role:', userCounts);
+     *   });
+     *
+     * // To stop listening for updates
+     * unsubscribe();
+     * ```
+     */
     subscribe(callback: (result: AggregateRecord<DB, TableName, TGroupBy, TAggregations>[]) => void): Promise<{
         unsubscribe: () => Promise<void>;
     }>;

package/dist/cjs/aggregation-query-builder.js

@@ -2,12 +2,34 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AggregationQueryBuilder = void 0;
 const where_query_builder_js_1 = require("./where-query-builder.js");
+/**
+ * A query builder for performing aggregation queries.
+ * @template DB - The database type.
+ * @template TableName - The name of the table to aggregate from.
+ * @template TGroupBy - The fields to group by.
+ * @template TAggregations - The aggregations to perform.
+ */
 class AggregationQueryBuilder extends where_query_builder_js_1.FilterableQueryBuilder {
     #node;
     constructor(node, executor) {
         super(node, executor);
         this.#node = node;
     }
+    /**
+     * Groups the results by a specified field.
+     * @param field - The field to group by.
+     * @param direction - The sort direction for the grouping.
+     * @returns A new `AggregationQueryBuilder` instance with the grouping applied.
+     *
+     * @example
+     * ```typescript
+     * const userCounts = await qb
+     *   .aggregateFrom('users')
+     *   .groupBy('role')
+     *   .withAggregates({ id: ['count'] })
+     *   .execute();
+     * ```
+     */
     groupBy(field, direction = 'asc') {
         const newGrouping = {
             field,
@@ -18,6 +40,22 @@ class AggregationQueryBuilder extends where_query_builder_js_1.FilterableQueryBu
             groupings: [...(this.#node.groupings || []), newGrouping],
         }, this._executor);
     }
+    /**
+     * Specifies the aggregations to perform.
+     * @param aggregates - An object where the keys are field names and the values are arrays of aggregation functions.
+     * @returns A new `AggregationQueryBuilder` instance with the aggregations applied.
+     *
+     * @example
+     * ```typescript
+     * const userStats = await qb
+     *   .aggregateFrom('users')
+     *   .withAggregates({
+     *     id: ['count'],
+     *     age: ['avg', 'sum'],
+     *   })
+     *   .execute();
+     * ```
+     */
     withAggregates(aggregates) {
         const newAggregates = { ...this.#node.aggregations };
         for (const key in aggregates) {
@@ -28,21 +66,43 @@ class AggregationQueryBuilder extends where_query_builder_js_1.FilterableQueryBu
             aggregations: newAggregates,
         }, this._executor);
     }
+    /**
+     * Sets the maximum number of records to return.
+     * @param count - The maximum number of records.
+     * @returns A new `AggregationQueryBuilder` instance with the limit applied.
+     */
     limit(count) {
         return new AggregationQueryBuilder({
             ...this.#node,
             pagination: { ...this.#node.pagination, limit: count },
         }, this._executor);
     }
+    /**
+     * Sets the number of records to skip.
+     * @param count - The number of records to skip.
+     * @returns A new `AggregationQueryBuilder` instance with the offset applied.
+     */
     offset(count) {
         return new AggregationQueryBuilder({
             ...this.#node,
             pagination: { ...this.#node.pagination, offset: count },
         }, this._executor);
     }
+    /**
+     * Paginates the results.
+     * @param page - The page number to retrieve.
+     * @param limit - The number of records per page.
+     * @returns A new `AggregationQueryBuilder` instance with pagination applied.
+     */
     paginate(page, limit) {
         return this.offset((page - 1) * limit).limit(limit);
     }
+    /**
+     * Sorts the results by a specified field.
+     * @param field - The field to sort by.
+     * @param direction - The sort direction ('asc' or 'desc').
+     * @returns A new `AggregationQueryBuilder` instance with the sorting applied.
+     */
     orderBy(field, direction = 'asc') {
         const newSorting = {
             field: field,
@@ -53,10 +113,42 @@ class AggregationQueryBuilder extends where_query_builder_js_1.FilterableQueryBu
             sorting: [...(this.#node.sorting || []), newSorting],
         }, this._executor);
     }
+    /**
+     * Executes the aggregation query.
+     * @returns A promise that resolves with an array of the aggregation results.
+     *
+     * @example
+     * ```typescript
+     * const userCounts = await qb
+     *   .aggregateFrom('users')
+     *   .groupBy('role')
+     *   .withAggregates({ id: ['count'] })
+     *   .execute();
+     * ```
+     */
     async execute() {
         const response = await this._executor.execute(this);
         return response;
     }
+    /**
+     * Subscribes to the results of the aggregation query.
+     * @param callback - A callback function that will be called with the results of the aggregation query.
+     * @returns A function to unsubscribe from the query.
+     *
+     * @example
+     * ```typescript
+     * const unsubscribe = qb
+     *   .aggregateFrom('users')
+     *   .groupBy('role')
+     *   .withAggregates({ id: ['count'] })
+     *   .subscribe((userCounts) => {
+     *     console.log('User counts by role:', userCounts);
+     *   });
+     *
+     * // To stop listening for updates
+     * unsubscribe();
+     * ```
+     */
     subscribe(callback) {
         return this._executor.subscribe([this], callback);
     }

package/dist/cjs/aggregation-query-builder.js.map

@@ -1 +1 @@
-{"version":3,"file":"aggregation-query-builder.js","sourceRoot":"","sources":["../../src/aggregation-query-builder.ts"],"names":[],"mappings":";;;AAOA,qEAAkE;AAElE,MAAa,uBAQX,SAAQ,+CAAqC;IAC7C,KAAK,CAAgB;IAErB,YAAY,IAAmB,EAAE,QAAkB;QACjD,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED,OAAO,CACL,KAAa,EACb,YAA4B,KAAK;QAOjC,MAAM,WAAW,GAAkC;YACjD,KAAK;YACL,SAAS;SACV,CAAC;QAEF,OAAO,IAAI,uBAAuB,CAChC;YACE,GAAG,IAAI,CAAC,KAAK;YACb,SAAS,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,IAAI,EAAE,CAAC,EAAE,WAAW,CAAC;SAC1D,EACD,IAAI,CAAC,SAAS,CACf,CAAC;IACJ,CAAC;IAED,cAAc,CAMZ,UAAa;QAEb,MAAM,aAAa,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;QACrD,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;YAC7B,aAAa,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAE,CAAC,GAAG,CACvC,SAAS,CAAC,EAAE,CAAC,SAAmB,CACjC,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,uBAAuB,CAChC;YACE,GAAG,IAAI,CAAC,KAAK;YACb,YAAY,EAAE,aAAa;SAC5B,EACD,IAAI,CAAC,SAAS,CACf,CAAC;IACJ,CAAC;IAED,KAAK,CACH,KAAa;QAEb,OAAO,IAAI,uBAAuB,CAChC;YACE,GAAG,IAAI,CAAC,KAAK;YACb,UAAU,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,EAAE,KAAK,EAAE;SACvD,EACD,IAAI,CAAC,SAAS,CACf,CAAC;IACJ,CAAC;IAED,MAAM,CACJ,KAAa;QAEb,OAAO,IAAI,uBAAuB,CAChC;YACE,GAAG,IAAI,CAAC,KAAK;YACb,UAAU,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE;SACxD,EACD,IAAI,CAAC,SAAS,CACf,CAAC;IACJ,CAAC;IAED,QAAQ,CACN,IAAY,EACZ,KAAa;QAEb,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACtD,CAAC;IAED,OAAO,CACL,KAA0B,EAC1B,YAA4B,KAAK;QAEjC,MAAM,UAAU,GAA+B;YAC7C,KAAK,EAAE,KAAe;YACtB,SAAS;SACV,CAAC;QAEF,OAAO,IAAI,uBAAuB,CAChC;YACE,GAAG,IAAI,CAAC,KAAK;YACb,OAAO,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,UAAU,CAAC;SACrD,EACD,IAAI,CAAC,SAAS,CACf,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,OAAO;QAGX,MAAM,QAAQ,GACZ,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAE1B,IAAI,CAAC,CAAC;QACV,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,SAAS,CACP,QAES;QAET,OAAO,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC;IACpD,CAAC;IAED,OAAO;QACL,MAAM,KAAK,GAAG,6DAA6D,CAAC;QAC5E,MAAM,QAAQ,GAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;QAC3C,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC;IAC5C,CAAC;IAED,gBAAgB;QACd,OAAO;YACL,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS;YAC/B,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS;YAC/B,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY;YACrC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;gBAC7C,CAAC,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE;gBACvC,CAAC,CAAC,EAAE,CAAC;YACP,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACvE,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC/D,CAAC;IACJ,CAAC;CACF;AArJD,0DAqJC"}
+{"version":3,"file":"aggregation-query-builder.js","sourceRoot":"","sources":["../../src/aggregation-query-builder.ts"],"names":[],"mappings":";;;AAOA,qEAAkE;AAElE;;;;;;GAMG;AACH,MAAa,uBAQX,SAAQ,+CAAqC;IAC7C,KAAK,CAAgB;IAErB,YAAY,IAAmB,EAAE,QAAkB;QACjD,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,OAAO,CACL,KAAa,EACb,YAA4B,KAAK;QAOjC,MAAM,WAAW,GAAkC;YACjD,KAAK;YACL,SAAS;SACV,CAAC;QAEF,OAAO,IAAI,uBAAuB,CAChC;YACE,GAAG,IAAI,CAAC,KAAK;YACb,SAAS,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,IAAI,EAAE,CAAC,EAAE,WAAW,CAAC;SAC1D,EACD,IAAI,CAAC,SAAS,CACf,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CAMZ,UAAa;QAEb,MAAM,aAAa,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;QACrD,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;YAC7B,aAAa,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,GAAG,CAAE,CAAC,GAAG,CACvC,SAAS,CAAC,EAAE,CAAC,SAAmB,CACjC,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,uBAAuB,CAChC;YACE,GAAG,IAAI,CAAC,KAAK;YACb,YAAY,EAAE,aAAa;SAC5B,EACD,IAAI,CAAC,SAAS,CACf,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CACH,KAAa;QAEb,OAAO,IAAI,uBAAuB,CAChC;YACE,GAAG,IAAI,CAAC,KAAK;YACb,UAAU,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,EAAE,KAAK,EAAE;SACvD,EACD,IAAI,CAAC,SAAS,CACf,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,KAAa;QAEb,OAAO,IAAI,uBAAuB,CAChC;YACE,GAAG,IAAI,CAAC,KAAK;YACb,UAAU,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE;SACxD,EACD,IAAI,CAAC,SAAS,CACf,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CACN,IAAY,EACZ,KAAa;QAEb,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACtD,CAAC;IAED;;;;;OAKG;IACH,OAAO,CACL,KAA0B,EAC1B,YAA4B,KAAK;QAEjC,MAAM,UAAU,GAA+B;YAC7C,KAAK,EAAE,KAAe;YACtB,SAAS;SACV,CAAC;QAEF,OAAO,IAAI,uBAAuB,CAChC;YACE,GAAG,IAAI,CAAC,KAAK;YACb,OAAO,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,UAAU,CAAC;SACrD,EACD,IAAI,CAAC,SAAS,CACf,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,OAAO;QAGX,MAAM,QAAQ,GACZ,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAE1B,IAAI,CAAC,CAAC;QACV,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CACP,QAES;QAET,OAAO,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC;IACpD,CAAC;IAED,OAAO;QACL,MAAM,KAAK,GAAG,6DAA6D,CAAC;QAC5E,MAAM,QAAQ,GAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;QAC3C,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC;IAC5C,CAAC;IAED,gBAAgB;QACd,OAAO;YACL,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS;YAC/B,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS;YAC/B,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY;YACrC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;gBAC7C,CAAC,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE;gBACvC,CAAC,CAAC,EAAE,CAAC;YACP,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACvE,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC/D,CAAC;IACJ,CAAC;CACF;AA1OD,0DA0OC"}

package/dist/cjs/batch-query-builder.d.ts

@@ -10,12 +10,48 @@ type InferExecuteResult<TBuilder> = TBuilder extends {
     execute: () => Promise<any>;
 } ? Awaited<ReturnType<TBuilder['execute']>> : never;
 export type AreAllBuildersSubscribable<TBuilders extends readonly AnyQueryBuilder[]> = TBuilders[number] extends AnySubscribableQueryBuilder ? true : false;
+/**
+ * A query builder for executing multiple queries in a single batch.
+ * @template TBuilders - An array of query builders to execute.
+ */
 export declare class BatchQueryBuilder<const TBuilders extends readonly AnyQueryBuilder[]> {
     #private;
     constructor(builders: TBuilders, executor: Executor);
+    /**
+     * Executes the batch query.
+     * @returns A promise that resolves with an array of the results from each query in the batch.
+     *
+     * @example
+     * ```typescript
+     * const [users, newUser] = await qb.batch([
+     *   qb.selectFrom('users').select(['id', 'name']),
+     *   qb.insertInto('users').values({ name: 'New User' }).returning(['id', 'name']),
+     * ]).execute();
+     * ```
+     */
     execute(): Promise<{
         -readonly [K in keyof TBuilders]: InferExecuteResult<TBuilders[K]>;
     }>;
+    /**
+     * Subscribes to the results of the batch query.
+     * This is only possible if all queries in the batch are subscribable (select and aggregate).
+     * @param callback - A callback function that will be called with the results of the batch query.
+     * @returns A function to unsubscribe from the query.
+     *
+     * @example
+     * ```typescript
+     * const unsubscribe = qb.batch([
+     *   qb.selectFrom('users').select(['id', 'name']),
+     *   qb.aggregateFrom('users').groupBy('role').withAggregates({ id: ['count'] }),
+     * ]).subscribe(([users, userAggregates]) => {
+     *   console.log('Users:', users);
+     *   console.log('User Aggregates:', userAggregates);
+     * });
+     *
+     * // To stop listening for updates
+     * unsubscribe();
+     * ```
+     */
     subscribe(callback: (...results: {
         -readonly [K in keyof TBuilders]: InferExecuteResult<TBuilders[K]>;
     }) => void): Promise<{

package/dist/cjs/batch-query-builder.js

@@ -3,6 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BatchQueryBuilder = void 0;
 const aggregation_query_builder_js_1 = require("./aggregation-query-builder.js");
 const query_builder_js_1 = require("./query-builder.js");
+/**
+ * A query builder for executing multiple queries in a single batch.
+ * @template TBuilders - An array of query builders to execute.
+ */
 class BatchQueryBuilder {
     #builders;
     #executor;
@@ -10,9 +14,41 @@ class BatchQueryBuilder {
         this.#builders = builders;
         this.#executor = executor;
     }
+    /**
+     * Executes the batch query.
+     * @returns A promise that resolves with an array of the results from each query in the batch.
+     *
+     * @example
+     * ```typescript
+     * const [users, newUser] = await qb.batch([
+     *   qb.selectFrom('users').select(['id', 'name']),
+     *   qb.insertInto('users').values({ name: 'New User' }).returning(['id', 'name']),
+     * ]).execute();
+     * ```
+     */
     async execute() {
         return this.#executor.execute(this);
     }
+    /**
+     * Subscribes to the results of the batch query.
+     * This is only possible if all queries in the batch are subscribable (select and aggregate).
+     * @param callback - A callback function that will be called with the results of the batch query.
+     * @returns A function to unsubscribe from the query.
+     *
+     * @example
+     * ```typescript
+     * const unsubscribe = qb.batch([
+     *   qb.selectFrom('users').select(['id', 'name']),
+     *   qb.aggregateFrom('users').groupBy('role').withAggregates({ id: ['count'] }),
+     * ]).subscribe(([users, userAggregates]) => {
+     *   console.log('Users:', users);
+     *   console.log('User Aggregates:', userAggregates);
+     * });
+     *
+     * // To stop listening for updates
+     * unsubscribe();
+     * ```
+     */
     subscribe(callback) {
         const builders = this.#builders.filter(builder => builder instanceof aggregation_query_builder_js_1.AggregationQueryBuilder ||
             builder instanceof query_builder_js_1.QueryBuilder);

package/dist/cjs/batch-query-builder.js.map

@@ -1 +1 @@
-{"version":3,"file":"batch-query-builder.js","sourceRoot":"","sources":["../../src/batch-query-builder.ts"],"names":[],"mappings":";;;AAAA,iFAAyE;AAIzE,yDAAkD;AAuBlD,MAAa,iBAAiB;IAG5B,SAAS,CAAY;IACrB,SAAS,CAAW;IAEpB,YAAY,QAAmB,EAAE,QAAkB;QACjD,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,OAAO;QAGX,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED,SAAS,CACP,QAIS;QAET,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CACpC,OAAO,CAAC,EAAE,CACR,OAAO,YAAY,sDAAuB;YAC1C,OAAO,YAAY,+BAAY,CAClC,CAAC;QAEF,IAAI,QAAQ,CAAC,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;YAC9C,MAAM,IAAI,KAAK,CACb,wEAAwE,CACzE,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAe,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO;QACL,MAAM,KAAK,GAAG,6DAA6D,CAAC;QAE5E,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;YAC5C,OAAO,OAAO,CAAC,gBAAgB,EAAE,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,OAAO;YACL,KAAK;YACL,SAAS,EAAE;gBACT,QAAQ;aACT;SACF,CAAC;IACJ,CAAC;CACF;AArDD,8CAqDC"}
+{"version":3,"file":"batch-query-builder.js","sourceRoot":"","sources":["../../src/batch-query-builder.ts"],"names":[],"mappings":";;;AAAA,iFAAyE;AAIzE,yDAAkD;AAuBlD;;;GAGG;AACH,MAAa,iBAAiB;IAG5B,SAAS,CAAY;IACrB,SAAS,CAAW;IAEpB,YAAY,QAAmB,EAAE,QAAkB;QACjD,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,OAAO;QAGX,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CACP,QAIS;QAET,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CACpC,OAAO,CAAC,EAAE,CACR,OAAO,YAAY,sDAAuB;YAC1C,OAAO,YAAY,+BAAY,CAClC,CAAC;QAEF,IAAI,QAAQ,CAAC,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;YAC9C,MAAM,IAAI,KAAK,CACb,wEAAwE,CACzE,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAe,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO;QACL,MAAM,KAAK,GAAG,6DAA6D,CAAC;QAE5E,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;YAC5C,OAAO,OAAO,CAAC,gBAAgB,EAAE,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,OAAO;YACL,KAAK;YACL,SAAS,EAAE;gBACT,QAAQ;aACT;SACF,CAAC;IACJ,CAAC;CACF;AArFD,8CAqFC"}

package/dist/cjs/delete-query-builder.d.ts

@@ -2,9 +2,26 @@ import type { DeleteNode } from './@types/delete.js';
 import type { AnyDB } from './@types/internal-types.js';
 import { Executor } from './executor.js';
 import { FilterableQueryBuilder } from './where-query-builder.js';
+/**
+ * A query builder for deleting records from the database.
+ * @template DB - The database type.
+ * @template TableName - The name of the table to delete from.
+ */
 export declare class DeleteQueryBuilder<DB extends AnyDB, TableName extends keyof DB> extends FilterableQueryBuilder<DB, TableName> {
     #private;
     constructor(node: DeleteNode, executor: Executor);
+    /**
+     * Executes the delete query.
+     * @returns A promise that resolves with the number of affected records.
+     *
+     * @example
+     * ```typescript
+     * const { affectedRecords } = await qb
+     *   .deleteFrom('users')
+     *   .where('id', '=', 1)
+     *   .execute();
+     * ```
+     */
     execute(): Promise<{
         affectedRecords: number;
     }>;

package/dist/cjs/delete-query-builder.js

@@ -2,12 +2,29 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DeleteQueryBuilder = void 0;
 const where_query_builder_js_1 = require("./where-query-builder.js");
+/**
+ * A query builder for deleting records from the database.
+ * @template DB - The database type.
+ * @template TableName - The name of the table to delete from.
+ */
 class DeleteQueryBuilder extends where_query_builder_js_1.FilterableQueryBuilder {
     #node;
     constructor(node, executor) {
         super(node, executor);
         this.#node = node;
     }
+    /**
+     * Executes the delete query.
+     * @returns A promise that resolves with the number of affected records.
+     *
+     * @example
+     * ```typescript
+     * const { affectedRecords } = await qb
+     *   .deleteFrom('users')
+     *   .where('id', '=', 1)
+     *   .execute();
+     * ```
+     */
     async execute() {
         const response = await this._executor.execute(this);
         return response[0];

package/dist/cjs/delete-query-builder.js.map

@@ -1 +1 @@
-{"version":3,"file":"delete-query-builder.js","sourceRoot":"","sources":["../../src/delete-query-builder.ts"],"names":[],"mappings":";;;AAGA,qEAAkE;AAElE,MAAa,kBAGX,SAAQ,+CAAqC;IAC7C,KAAK,CAAa;IAElB,YAAY,IAAgB,EAAE,QAAkB;QAC9C,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,OAAO;QACX,MAAM,QAAQ,GACZ,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAgC,IAAI,CAAC,CAAC;QAEpE,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC;IACrB,CAAC;IAED,OAAO;QACL,MAAM,KAAK,GAAG,6DAA6D,CAAC;QAE5E,MAAM,QAAQ,GAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;QAE3C,OAAO;YACL,KAAK;YACL,SAAS,EAAE;gBACT,QAAQ;aACT;SACF,CAAC;IACJ,CAAC;IAED,gBAAgB;QACd,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS;YAC/B,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;gBAC7C,CAAC,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE;gBACvC,CAAC,CAAC,EAAE,CAAC;SACR,CAAC;IACJ,CAAC;CACF;AAxCD,gDAwCC"}
+{"version":3,"file":"delete-query-builder.js","sourceRoot":"","sources":["../../src/delete-query-builder.ts"],"names":[],"mappings":";;;AAGA,qEAAkE;AAElE;;;;GAIG;AACH,MAAa,kBAGX,SAAQ,+CAAqC;IAC7C,KAAK,CAAa;IAElB,YAAY,IAAgB,EAAE,QAAkB;QAC9C,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,OAAO;QACX,MAAM,QAAQ,GACZ,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAgC,IAAI,CAAC,CAAC;QAEpE,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC;IACrB,CAAC;IAED,OAAO;QACL,MAAM,KAAK,GAAG,6DAA6D,CAAC;QAE5E,MAAM,QAAQ,GAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;QAE3C,OAAO;YACL,KAAK;YACL,SAAS,EAAE;gBACT,QAAQ;aACT;SACF,CAAC;IACJ,CAAC;IAED,gBAAgB;QACd,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS;YAC/B,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;gBAC7C,CAAC,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE;gBACvC,CAAC,CAAC,EAAE,CAAC;SACR,CAAC;IACJ,CAAC;CACF;AApDD,gDAoDC"}

package/dist/cjs/insert-query-builder.d.ts

@@ -3,14 +3,82 @@ import type { AnyDB } from './@types/internal-types.js';
 import { NonLinkColumnNames } from './@types/query-builder.js';
 import { ResolveSelection } from './@types/type-helpers.js';
 import { Executor } from './executor.js';
+/**
+ * A query builder for creating new records in the database.
+ * @template DB - The database type.
+ * @template TableName - The name of the table to insert into.
+ * @template Selection - The type of the selected fields.
+ */
 export declare class InsertQueryBuilder<DB extends AnyDB, TableName extends keyof DB, Selection = {
     id: number;
 }> {
     #private;
     constructor(node: InsertNode, executor: Executor);
+    /**
+     * The values to insert into the table.
+     * @param values - An object or array of objects representing the records to create.
+     * @returns The `InsertQueryBuilder` instance for chaining.
+     *
+     * @example Single Record Insertion
+     * ```typescript
+     * const newUser = await qb
+     *   .insertInto('users')
+     *   .values({ name: 'John Doe', email: 'john.doe@example.com' })
+     *   .executeTakeFirst();
+     * ```
+     *
+     * @example Multiple Record Insertion
+     * ```typescript
+     * const newUsers = await qb
+     *   .insertInto('users')
+     *   .values([{ name: 'John Doe' }, { name: 'Jane Doe' }])
+     *   .execute();
+     * ```
+     */
     values(values: Insertable<DB[TableName]> | Insertable<DB[TableName]>[]): InsertQueryBuilder<DB, TableName, Selection>;
+    /**
+     * The fields to return after the insert operation.
+     * @param fields - An array of field names to return.
+     * @returns The `InsertQueryBuilder` instance for chaining.
+     *
+     * @example
+     * ```typescript
+     * const newUser = await qb
+     *   .insertInto('users')
+     *   .values({ name: 'John Doe' })
+     *   .returning(['id', 'name'])
+     *   .executeTakeFirst();
+     * ```
+     */
     returning<const TFields extends readonly NonLinkColumnNames<DB[TableName]>[]>(fields: TFields): InsertQueryBuilder<DB, TableName, ResolveSelection<DB, TableName, TFields, object>>;
+    /**
+     * Executes the insert query.
+     * @returns A promise that resolves with an array of the selected fields from the inserted records.
+     *
+     * @example
+     * ```typescript
+     * const newUsers = await qb
+     *   .insertInto('users')
+     *   .values([{ name: 'John Doe' }, { name: 'Jane Doe' }])
+     *   .returning(['id', 'name'])
+     *   .execute();
+     * ```
+     */
     execute(): Promise<Selection[]>;
+    /**
+     * Executes the insert query and returns the first result.
+     * @returns A promise that resolves with the first inserted record, or `null` if no records were inserted.
+     *
+     * @example
+     * ```typescript
+     * const newUser = await qb
+     *   .insertInto('users')
+     *   .values({ name: 'John Doe' })
+     *   .returning(['id', 'name'])
+     *   .executeTakeFirst();
+     * ```
+     */
+    executeTakeFirst(): Promise<Selection | null>;
     compile(): {
         query: string;
         variables: Record<string, any>;