@taylordb/query-builder 0.9.0 → 0.9.2

package/dist/esm/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/esm/aggregation-query-builder.js

@@ -1,10 +1,32 @@
 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 class AggregationQueryBuilder extends 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,
@@ -15,6 +37,22 @@ export class AggregationQueryBuilder extends FilterableQueryBuilder {
             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) {
@@ -25,21 +63,43 @@ export class AggregationQueryBuilder extends FilterableQueryBuilder {
             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,
@@ -50,10 +110,42 @@ export class AggregationQueryBuilder extends FilterableQueryBuilder {
             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/esm/aggregation-query-builder.js.map

@@ -1 +1 @@
-{"version":3,"file":"aggregation-query-builder.js","sourceRoot":"","sources":["../../src/aggregation-query-builder.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,MAAM,OAAO,uBAQX,SAAQ,sBAAqC;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"}
+{"version":3,"file":"aggregation-query-builder.js","sourceRoot":"","sources":["../../src/aggregation-query-builder.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE;;;;;;GAMG;AACH,MAAM,OAAO,uBAQX,SAAQ,sBAAqC;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"}

package/dist/esm/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/esm/batch-query-builder.js

@@ -1,5 +1,9 @@
 import { AggregationQueryBuilder } from './aggregation-query-builder.js';
 import { QueryBuilder } from './query-builder.js';
+/**
+ * A query builder for executing multiple queries in a single batch.
+ * @template TBuilders - An array of query builders to execute.
+ */
 export class BatchQueryBuilder {
     #builders;
     #executor;
@@ -7,9 +11,41 @@ export 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 AggregationQueryBuilder ||
             builder instanceof QueryBuilder);

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

@@ -1 +1 @@
-{"version":3,"file":"batch-query-builder.js","sourceRoot":"","sources":["../../src/batch-query-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AAIzE,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAuBlD,MAAM,OAAO,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,uBAAuB;YAC1C,OAAO,YAAY,YAAY,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"}
+{"version":3,"file":"batch-query-builder.js","sourceRoot":"","sources":["../../src/batch-query-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AAIzE,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAuBlD;;;GAGG;AACH,MAAM,OAAO,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,uBAAuB;YAC1C,OAAO,YAAY,YAAY,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"}

package/dist/esm/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/esm/delete-query-builder.js

@@ -1,10 +1,27 @@
 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 class DeleteQueryBuilder extends 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/esm/delete-query-builder.js.map

@@ -1 +1 @@
-{"version":3,"file":"delete-query-builder.js","sourceRoot":"","sources":["../../src/delete-query-builder.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,MAAM,OAAO,kBAGX,SAAQ,sBAAqC;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"}
+{"version":3,"file":"delete-query-builder.js","sourceRoot":"","sources":["../../src/delete-query-builder.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE;;;;GAIG;AACH,MAAM,OAAO,kBAGX,SAAQ,sBAAqC;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"}

package/dist/esm/executor.d.ts

@@ -1,4 +1,5 @@
 import { AnySubscribableQueryBuilder } from './batch-query-builder.js';
+import { SocketConnection } from './socket-connection.js';
 interface Compilable {
     compile(): {
         query: string;
@@ -7,7 +8,9 @@ interface Compilable {
 }
 export declare class Executor {
     #private;
-    constructor(baseUrl: string, apiKey: string);
+    constructor(baseUrl: string, apiKey: string, transactionId?: string, socketConnection?: SocketConnection);
+    get isInTransaction(): boolean;
+    withTransactionId(transactionId: string): Executor;
     execute<T>(builder: Compilable): Promise<T>;
     rawRequest<T>(query: string, variables: Record<string, any>, headers?: Record<string, string>): Promise<T>;
     subscribe<TResult>(builders: AnySubscribableQueryBuilder[], callback: (result: TResult) => void): Promise<{

package/dist/esm/executor.js

@@ -1,4 +1,4 @@
-import { SubscriptionManager } from './subscription-manager.js';
+import { SocketConnection } from './socket-connection.js';
 const generateUUID = () => {
     if (globalThis.crypto && globalThis.crypto.randomUUID) {
         return globalThis.crypto.randomUUID();
@@ -13,51 +13,36 @@ const generateUUID = () => {
 export class Executor {
     #baseUrl;
     #apiKey;
-    #subscriptionManager;
-    constructor(baseUrl, apiKey) {
+    #socketConnection;
+    #transactionId;
+    constructor(baseUrl, apiKey, transactionId, socketConnection) {
         this.#baseUrl = baseUrl;
         this.#apiKey = apiKey;
-        this.#subscriptionManager = new SubscriptionManager(this, {
-            baseUrl,
-            apiKey,
-            clientId: generateUUID(),
-        });
+        this.#transactionId = transactionId;
+        this.#socketConnection =
+            socketConnection ??
+                new SocketConnection({
+                    baseUrl,
+                    apiKey,
+                    clientId: generateUUID(),
+                });
+    }
+    get isInTransaction() {
+        return !!this.#transactionId;
+    }
+    withTransactionId(transactionId) {
+        return new Executor(this.#baseUrl, this.#apiKey, transactionId, this.#socketConnection);
     }
     async execute(builder) {
         const { query, variables } = builder.compile();
         return this.rawRequest(query, variables);
     }
     async rawRequest(query, variables, headers) {
-        const response = await fetch(this.#baseUrl, {
-            method: 'POST',
-            headers: {
-                'Content-Type': 'application/json',
-                Authorization: `Bearer ${this.#apiKey}`,
-                schema: 'readable',
-                ...(headers ? { ...headers } : {}),
-            },
-            body: JSON.stringify({ query, variables }),
-        });
-        if (!response.ok) {
-            const errorText = await response.text();
-            throw new Error(`Request failed with status ${response.status}: ${errorText}`);
-        }
-        const jsonResponse = await response.json();
-        if (jsonResponse.errors) {
-            throw new Error(`GraphQL errors: ${jsonResponse.errors.map(error => error.message).join('\n')}`);
-        }
-        if (jsonResponse.data) {
-            const [firstKey] = Object.keys(jsonResponse.data);
-            if (Array.isArray(jsonResponse.data[firstKey])) {
-                return jsonResponse.data[firstKey];
-            }
-            return jsonResponse.data;
-        }
-        throw new Error('Unexpected response format');
+        return this.#socketConnection.rawRequest(query, variables, headers, this.#transactionId);
     }
     subscribe(builders, callback) {
         const metadatas = builders.map(b => b._prepareMetadata());
-        return this.#subscriptionManager.subscribe(metadatas, callback);
+        return this.#socketConnection.subscribe(metadatas, callback);
     }
 }
 //# sourceMappingURL=executor.js.map

package/dist/esm/executor.js.map

@@ -1 +1 @@
-{"version":3,"file":"executor.js","sourceRoot":"","sources":["../../src/executor.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAMhE,MAAM,YAAY,GAAG,GAAG,EAAE;IACxB,IAAI,UAAU,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;QACtD,OAAO,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;IACxC,CAAC;IACD,+DAA+D;IAC/D,OAAO,sCAAsC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE;QACjE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC;QACnC,MAAM,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC;QAC1C,OAAO,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,OAAO,QAAQ;IACnB,QAAQ,CAAS;IACjB,OAAO,CAAS;IAChB,oBAAoB,CAAsB;IAE1C,YAAY,OAAe,EAAE,MAAc;QACzC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,oBAAoB,GAAG,IAAI,mBAAmB,CAAC,IAAI,EAAE;YACxD,OAAO;YACP,MAAM;YACN,QAAQ,EAAE,YAAY,EAAE;SACzB,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,OAAO,CAAI,OAAmB;QAClC,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QAC/C,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,UAAU,CACd,KAAa,EACb,SAA8B,EAC9B,OAAgC;QAEhC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE;YAC1C,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,aAAa,EAAE,UAAU,IAAI,CAAC,OAAO,EAAE;gBACvC,MAAM,EAAE,UAAU;gBAClB,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;SAC3C,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CACb,8BAA8B,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAC9D,CAAC;QACJ,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAE3C,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CACb,mBAAmB,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAChF,CAAC;QACJ,CAAC;QAED,IAAI,YAAY,CAAC,IAAI,EAAE,CAAC;YACtB,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YAClD,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;gBAC/C,OAAO,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAM,CAAC;YAC1C,CAAC;YACD,OAAO,YAAY,CAAC,IAAI,CAAC;QAC3B,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAChD,CAAC;IAED,SAAS,CACP,QAAuC,EACvC,QAAmC;QAEnC,MAAM,SAAS,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAE,CAAS,CAAC,gBAAgB,EAAE,CAAC,CAAC;QACnE,OAAO,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAClE,CAAC;CACF"}
+{"version":3,"file":"executor.js","sourceRoot":"","sources":["../../src/executor.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAM1D,MAAM,YAAY,GAAG,GAAG,EAAE;IACxB,IAAI,UAAU,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;QACtD,OAAO,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;IACxC,CAAC;IACD,+DAA+D;IAC/D,OAAO,sCAAsC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE;QACjE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC;QACnC,MAAM,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC;QAC1C,OAAO,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,OAAO,QAAQ;IACnB,QAAQ,CAAS;IACjB,OAAO,CAAS;IAChB,iBAAiB,CAAmB;IACpC,cAAc,CAAU;IAExB,YACE,OAAe,EACf,MAAc,EACd,aAAsB,EACtB,gBAAmC;QAEnC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,iBAAiB;YACpB,gBAAgB;gBAChB,IAAI,gBAAgB,CAAC;oBACnB,OAAO;oBACP,MAAM;oBACN,QAAQ,EAAE,YAAY,EAAE;iBACzB,CAAC,CAAC;IACP,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC;IAC/B,CAAC;IAED,iBAAiB,CAAC,aAAqB;QACrC,OAAO,IAAI,QAAQ,CACjB,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,OAAO,EACZ,aAAa,EACb,IAAI,CAAC,iBAAiB,CACvB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,OAAO,CAAI,OAAmB;QAClC,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QAC/C,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,UAAU,CACd,KAAa,EACb,SAA8B,EAC9B,OAAgC;QAEhC,OAAO,IAAI,CAAC,iBAAiB,CAAC,UAAU,CACtC,KAAK,EACL,SAAS,EACT,OAAO,EACP,IAAI,CAAC,cAAc,CACpB,CAAC;IACJ,CAAC;IAED,SAAS,CACP,QAAuC,EACvC,QAAmC;QAEnC,MAAM,SAAS,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAE,CAAS,CAAC,gBAAgB,EAAE,CAAC,CAAC;QACnE,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC/D,CAAC;CACF"}

package/dist/esm/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>;