pqb 0.18.33 → 0.19.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as orchid_core from 'orchid-core';
-import { QueryResultRow, AdapterBase, QueryInput, Sql, QueryBaseCommon, ColumnsShapeBase, QueryInternal, QueryMetaBase, StringKey, Expression, ColumnTypeBase, MaybeArray, TemplateLiteralArgs, ColumnsParsers, getValueKey, ColumnTypesBase, ColumnShapeOutput, DefaultSelectColumns, EmptyObject, DbBase, QueryThen, QueryCatch, TransactionState, SQLQueryArgs, NullableColumn, SetOptional, EmptyTuple, MergeObjects, RawSQLBase, RawSQLValues, ExpressionTypeMethod, DynamicSQLArg, StaticSQLArgs, Spread, Code, OperatorToSQL, BaseNumberData, NumberTypeMethods, ColumnWithDefault, StringTypeData, PrimaryKeyColumn, stringTypeMethods, DateTypeMethods, DateColumnData, EncodeColumn, ParseColumn, JSONType, JSONUnknown, JSONTypes, ArrayMethodsData, arrayTypeMethods, ForeignKeyTable, TimestampHelpers, ColumnNameOfTable, ColumnDataBase, ValidationContext, ErrorMessage } from 'orchid-core';
+import { QueryResultRow, AdapterBase, QueryInput, Sql, StringKey, QueryBaseCommon, ColumnsShapeBase, QueryInternal, QueryMetaBase, Expression, ColumnTypeBase, MaybeArray, TemplateLiteralArgs, ColumnsParsers, getValueKey, ColumnTypesBase, ColumnShapeOutput, DefaultSelectColumns, EmptyObject, DbBase, QueryThen, QueryCatch, TransactionState, SQLQueryArgs, NullableColumn, SetOptional, EmptyTuple, MergeObjects, RawSQLBase, RawSQLValues, ExpressionTypeMethod, DynamicSQLArg, StaticSQLArgs, Spread, Code, OperatorToSQL, BaseNumberData, NumberTypeMethods, ColumnWithDefault, StringTypeData, PrimaryKeyColumn, stringTypeMethods, DateTypeMethods, DateColumnData, EncodeColumn, ParseColumn, JSONType, JSONUnknown, JSONTypes, ArrayMethodsData, arrayTypeMethods, ForeignKeyTable, TimestampHelpers, ColumnNameOfTable, ColumnDataBase, ValidationContext, ErrorMessage } from 'orchid-core';
 import { PoolConfig, Pool, PoolClient } from 'pg';
 import { inspect } from 'node:util';
 import { AsyncLocalStorage } from 'node:async_hooks';
@@ -50,30 +50,12 @@ declare class TransactionAdapter implements Adapter {
     close(): Promise<void>;
 }
 
-declare abstract class QueryBase implements QueryBaseCommon {
-    /**
-     * Clones the current query chain, useful for re-using partial query snippets in other queries without mutating the original.
-     *
-     * Used under the hood, and not really needed on the app side.
-     */
-    clone<T extends QueryBase>(this: T): T;
-    abstract result: ColumnsShapeBase;
-    q: QueryData;
-    table?: string;
-    selectable: SelectableBase;
-    shape: ColumnsShapeBase;
-    relations: RelationsBase;
-    withData: WithDataBase;
-    baseQuery: Query;
-    internal: QueryInternal;
-    meta: QueryMetaBase;
-    returnType: QueryReturnType;
-}
-
+type RelationsChain = (Query | RelationQuery)[];
+type RelationJoinQuery = (joiningQuery: Query, baseQuery: Query) => Query;
 type RelationConfigBase = {
     table: QueryWithTable;
     query: QueryWithTable;
-    joinQuery(fromQuery: QueryBase, toQuery: Query): Query;
+    joinQuery: RelationJoinQuery;
     one: boolean;
     required: boolean;
     omitForeignKeyInCreate: PropertyKey;
@@ -102,6 +84,26 @@ type RelationQuery<Name extends PropertyKey = PropertyKey, Config extends Relati
     } : K extends 'join' ? <T extends Query>(this: T) => T : K extends CreateMethodsNames ? Config['chainedCreate'] extends true ? T[K] : never : K extends DeleteMethodsNames ? Config['chainedDelete'] extends true ? T[K] : never : K extends keyof T ? T[K] : K extends 'relationConfig' ? Config : never;
 }> = ((params: Config['params']) => Config['one'] extends true ? Config['required'] extends true ? SetQueryReturnsOne<Q> : SetQueryReturnsOneOptional<Q> : Q) & Q;
 
+declare abstract class QueryBase implements QueryBaseCommon {
+    /**
+     * Clones the current query chain, useful for re-using partial query snippets in other queries without mutating the original.
+     *
+     * Used under the hood, and not really needed on the app side.
+     */
+    clone<T extends QueryBase>(this: T): T;
+    abstract result: ColumnsShapeBase;
+    q: QueryData;
+    table?: string;
+    selectable: SelectableBase;
+    shape: ColumnsShapeBase;
+    relations: RelationsBase;
+    withData: WithDataBase;
+    baseQuery: Query;
+    internal: QueryInternal;
+    meta: QueryMetaBase;
+    returnType: QueryReturnType;
+}
+
 declare const checkIfASimpleQuery: (q: Query) => boolean;
 type WithItem = [
     as: string,
@@ -314,6 +316,7 @@ type CommonQueryData = {
     transform?: ((input: unknown) => unknown)[];
     language?: string;
     isSubQuery?: true;
+    relChain?: RelationsChain;
     /**
      * Stores current operator functions available for the query.
      * Is needed to remove these operators from query object when changing the query type, see {@link setQueryOperators}.
@@ -591,6 +594,73 @@ type DbResult<ColumnTypes> = Db<string, Record<string, never>, EmptyObject, Colu
     adapter: Adapter;
     close: Adapter['close'];
 };
+/**
+ * For the case of using the query builder as a standalone tool, use `createDb` from `pqb` package.
+ *
+ * As `Orchid ORM` focuses on ORM usage, docs examples mostly demonstrates how to work with ORM-defined tables,
+ * but everything that's not related to table relations should also work with `pqb` query builder on its own.
+ *
+ * It is accepting the same options as `orchidORM` + options of `createBaseTable`:
+ *
+ * ```ts
+ * import { createDb } from 'orchid-orm';
+ *
+ * const db = createDb({
+ *   // db connection options
+ *   databaseURL: process.env.DATABASE_URL,
+ *   log: true,
+ *
+ *   // columns in db are in snake case:
+ *   snakeCase: true,
+ *
+ *   // override default SQL for timestamp, see `nowSQL` above
+ *   nowSQL: `now() AT TIME ZONE 'UTC'`,
+ *
+ *   // override column types:
+ *   columnTypes: (t) => ({
+ *     // by default timestamp is returned as a string, override to a number
+ *     timestamp: () => t.timestamp().asNumber(),
+ *   }),
+ * });
+ * ```
+ *
+ * After `db` is defined, construct queryable tables in such way:
+ *
+ * ```ts
+ * export const User = db('user', (t) => ({
+ *   id: t.identity().primaryKey(),
+ *   name: t.text(3, 100),
+ *   password: t.text(8, 200),
+ *   age: t.integer().nullable(),
+ *   ...t.timestamps(),
+ * }));
+ * ```
+ *
+ * Now the `User` can be used for making type-safe queries:
+ *
+ * ```ts
+ * const users = await User.select('id', 'name') // only known columns are allowed
+ *   .where({ age: { gte: 20 } }) // gte is available only on the numeric field, and the only number is allowed
+ *   .order({ createdAt: 'DESC' }) // type safe as well
+ *   .limit(10);
+ *
+ * // users array has a proper type of Array<{ id: number, name: string }>
+ * ```
+ *
+ * The optional third argument is for table options:
+ *
+ * ```ts
+ * const Table = db('table', (t) => ({ ...columns }), {
+ *   // provide this value if the table belongs to a specific database schema:
+ *   schema: 'customTableSchema',
+ *   // override `log` option of `createDb`:
+ *   log: true, // boolean or object described `createdDb` section
+ *   logger: { ... }, // override logger
+ *   noPrimaryKey: 'ignore', // override noPrimaryKey
+ *   snakeCase: true, // override snakeCase
+ * })
+ * ```
+ */
 declare const createDb: <ColumnTypes extends Record<string, orchid_core.AnyColumnTypeCreator> = DefaultColumnTypes>({ log, logger, columnTypes: ctOrFn, snakeCase, nowSQL, ...options }: DbOptions<ColumnTypes>) => DbResult<ColumnTypes>;
 
 type ToSQLCtx = {
@@ -1891,7 +1961,7 @@ declare class QueryGet {
      * It will throw `NotFoundError` when not found.
      *
      * ```ts
-     * import { NumberColumn } from 'pqb';
+     * import { NumberColumn } from 'orchid-orm';
      *
      * const firstName: string = await db.table.get('name');
      *
@@ -3754,7 +3824,7 @@ declare abstract class JsonModifiers extends QueryBase {
      * Selects a value from JSON data using a JSON path.
      *
      * ```ts
-     * import { columnTypes } from 'pqb';
+     * import { columnTypes } from 'orchid-orm';
      *
      * db.table.jsonPathQuery(
      *   columnTypes.text(3, 100), // type of the value
@@ -4001,7 +4071,7 @@ declare class With {
      * Add Common Table Expression (CTE) to the query.
      *
      * ```ts
-     * import { columnTypes } from 'pqb';
+     * import { columnTypes } from 'orchid-orm';
      * import { NumberColumn } from './number';
      *
      * // .with optionally accepts such options:
@@ -4345,7 +4415,7 @@ declare class Update {
      * To make sure that at least one row was updated use `updateOrThrow`:
      *
      * ```ts
-     * import { NotFoundError } from 'pqb';
+     * import { NotFoundError } from 'orchid-orm';
      *
      * try {
      *   // updatedCount is guaranteed to be greater than 0
@@ -5635,6 +5705,20 @@ declare class QueryMethods<ColumnTypes> {
      * await selectFollowing(db.user.select('id', 'name'), currentUser);
      * ```
      *
+     * To get the result type of query helper, use `QueryHelperResult` type:
+     *
+     * ```ts
+     * import { QueryHelperResult } from 'orchid-orm';
+     *
+     * const selectHelper = db.table.makeHelper((q) => q.select('id', 'name'));
+     *
+     * // This type is identical to `db.table.select('id', 'name')`
+     * type SelectQuery = QueryHelperResult<typeof selectHelper>;
+     *
+     * // Await to get result, the type is `{ id: number, name: string }[]`
+     * type Result = Awaited<QueryHelperResult<typeof selectHelper>>;
+     * ```
+     *
      * @param fn - helper function
      */
     makeHelper<T extends Query, Args extends unknown[], Result>(this: T, fn: (q: T, ...args: Args) => Result): QueryHelper<T, Args, Result>;
@@ -7155,4 +7239,4 @@ declare module 'orchid-core' {
 }
 declare function addComputedColumns<T extends Query, Computed extends ComputedColumnsBase<T>>(q: T, computed: Computed): QueryWithComputed<T, Computed>;
 
-export { Adapter, AdapterConfig, AdapterOptions, AddQueryDefaults, AddQuerySelect, AddQueryWith, AfterHook, AggregateMethods, AggregateOptions, AliasOrTable, ArrayColumn, ArrayData, ArrayOfColumnsObjects, AsMethods, BaseOperators, BigIntColumn, BigSerialColumn, BitColumn, BitVaryingColumn, BooleanColumn, BooleanNullable, BoxColumn, ByteaColumn, CharColumn, CidrColumn, CircleColumn, CitextColumn, Clear, ClearStatement, ColumnData, ColumnExpression, ColumnFromDbParams, ColumnInfo, ColumnInfoMethods, ColumnInfoQueryData, ColumnOperators, ColumnRefExpression, ColumnType, ColumnsObject, ColumnsShape, CommonQueryData, ComputedColumnsBase, CopyMethods, CopyOptions, CopyQueryData, Create, CreateColumn, CreateCtx, CreateData, CreateKind, CreateMethodsNames, CreateRelationDataOmittingFKeys, CreateRelationsData, CreateRelationsDataOmittingFKeys, CustomTypeColumn, DateBaseColumn, DateColumn, DateTimeBaseClass, DateTimeTzBaseClass, Db, DbOptions, DbResult, DbTableOptions, DecimalBaseColumn, DecimalColumn, DefaultColumnTypes, Delete, DeleteMethodsNames, DeleteQueryData, DomainColumn, DoublePrecisionColumn, DropMode, DynamicRawSQL, EnumColumn, ExpressionOutput, FnExpression, FnExpressionArgs, For, ForeignKey, ForeignKeyAction, ForeignKeyMatch, ForeignKeyOptions, From, FromArgs, FromResult, GetArg, GetQueryResult, GetStringArg, GroupArg, Having, HavingItem, HookAction, HookSelect, IdentityColumn, IndexColumnOptions, IndexOptions, InetColumn, InsertQueryData, IntegerBaseColumn, IntegerColumn, IntervalColumn, IsolationLevel, JSONColumn, JSONTextColumn, Join, JoinArgs, JoinCallback, JoinFirstArg, JoinItem, JoinLateralCallback, JoinLateralItem, JoinLateralResult, JoinOverrides, JoinResult, JoinedParsers, JoinedShapes, JsonItem, JsonMethods, JsonModifiers, LimitedTextBaseColumn, LineColumn, LsegColumn, MacAddr8Column, MacAddrColumn, MergeQuery, MergeQueryMethods, MoneyColumn, MoreThanOneRowError, NoPrimaryKeyOption, NotFoundError, NumberAsStringBaseColumn, NumberBaseColumn, NumberColumn, NumberColumnData, OnConflictItem, OnConflictMergeUpdate, OnConflictQueryBuilder, OnQueryBuilder, Operator, Operators, OrCreateArg, OrchidOrmError, OrchidOrmInternalError, OrderArg, OrderArgs, OrderItem, OrderTsQueryConfig, Over, PathColumn, PluckResultColumnType, PointColumn, PolygonColumn, Query, QueryAfterHook, QueryArraysResult, QueryBase, QueryBeforeHook, QueryData, QueryDefaultReturnData, QueryError, QueryErrorName, QueryGet, QueryHelperResult, QueryHookSelect, QueryHooks, QueryLog, QueryLogObject, QueryLogOptions, QueryLogger, QueryMethods, QueryResult, QueryReturnType, QueryReturnsAll, QuerySourceItem, QueryTransform, QueryTransformFn, QueryUpsertOrCreate, QueryWithComputed, QueryWithTable, RawSQL, RawSqlMethods, RealColumn, RelationConfigBase, RelationConfigDataForCreate, RelationQuery, RelationQueryBase, RelationsBase, SearchArg, SearchMethods, SearchWeight, Select, SelectArg, SelectAs, SelectItem, SelectQueryData, SelectSubQueryResult, SelectableBase, SelectableFromShape, SelectableOfType, SelectableOrExpression, SelectableOrExpressionOfType, SerialColumn, SerialColumnData, SetQueryKind, SetQueryReturns, SetQueryReturnsAll, SetQueryReturnsColumn, SetQueryReturnsColumnInfo, SetQueryReturnsColumnOptional, SetQueryReturnsOne, SetQueryReturnsOneOptional, SetQueryReturnsPluck, SetQueryReturnsPluckColumn, SetQueryReturnsRowCount, SetQueryReturnsRows, SetQueryReturnsValue, SetQueryReturnsValueOptional, SetQueryReturnsVoid, SetQueryTableAlias, SetQueryWith, SimpleJoinItem, SingleColumnIndexOptions, SmallIntColumn, SmallSerialColumn, SortDir, StringColumn, TableData, TextBaseColumn, TextColumn, TextColumnData, Then, TimeColumn, TimeInterval, TimestampColumn, TimestampTZColumn, ToSQLCtx, ToSQLOptions, Transaction, TransactionAdapter, TransactionOptions, TransformMethods, TruncateQueryData, TsQueryColumn, TsVectorColumn, TypeParsers, UUIDColumn, UnhandledTypeError, Union, UnionArg, UnionItem, UnionKind, UnknownColumn, Update, UpdateCtx, UpdateData, UpdateQueryData, UpdateQueryDataItem, UpdateQueryDataObject, UpdatedAtDataInjector, UpsertArg, UpsertResult, UpsertThis, VarCharColumn, VirtualColumn, Where, WhereArg, WhereArgs, WhereInArg, WhereInColumn, WhereInItem, WhereInValues, WhereItem, WhereJsonPathEqualsItem, WhereOnItem, WhereOnJoinItem, WhereQueryBase, WhereQueryBuilder, WhereResult, WhereSearchItem, WhereSearchResult, WindowArg, WindowArgDeclaration, WindowDeclaration, WindowItem, With, WithDataBase, WithDataItem, WithItem, WithOptions, XMLColumn, addComputedColumns, addOr, addOrNot, addParserForRawExpression, addParserForSelectItem, addQueryOn, addWhere, addWhereIn, addWhereNot, anyShape, checkIfASimpleQuery, cloneQueryArrays, columnCheckToCode, columnCode, columnForeignKeysToCode, columnIndexesToCode, columnTypes, columnsByType, columnsShapeToCode, constraintPropsToCode, constraintToCode, countSelect, createDb, extendQuery, foreignKeyArgumentToCode, getClonedQueryData, getColumnTypes, getConstraintKind, getQueryAs, getShapeFromSelect, getTableData, handleResult, identityToCode, indexToCode, instantiateColumn, isQueryReturnsAll, isSelectingCount, joinSubQuery, logColors, logParamToLogObject, makeExpression, makeFnExpression, makeRegexToFindInSql, makeSQL, newTableData, parseRecord, parseResult, primaryKeyToCode, processSelectArg, pushLimitSQL, pushQueryArray, pushQueryOn, pushQueryOrOn, pushQueryValue, queryMethodByReturnType, queryTypeWithLimitOne, quote, quoteString, raw, referencesArgsToCode, resetTableData, resolveSubQueryCallback, saveSearchAlias, setParserForSelectedString, setQueryObjectValue, setQueryOperators, simplifyColumnDefault, templateLiteralToSQL, testTransaction, throwIfNoWhere, toSQL, toSQLCacheKey };
+export { Adapter, AdapterConfig, AdapterOptions, AddQueryDefaults, AddQuerySelect, AddQueryWith, AfterHook, AggregateMethods, AggregateOptions, AliasOrTable, ArrayColumn, ArrayData, ArrayOfColumnsObjects, AsMethods, BaseOperators, BigIntColumn, BigSerialColumn, BitColumn, BitVaryingColumn, BooleanColumn, BooleanNullable, BoxColumn, ByteaColumn, CharColumn, CidrColumn, CircleColumn, CitextColumn, Clear, ClearStatement, ColumnData, ColumnExpression, ColumnFromDbParams, ColumnInfo, ColumnInfoMethods, ColumnInfoQueryData, ColumnOperators, ColumnRefExpression, ColumnType, ColumnsObject, ColumnsShape, CommonQueryData, ComputedColumnsBase, CopyMethods, CopyOptions, CopyQueryData, Create, CreateColumn, CreateCtx, CreateData, CreateKind, CreateMethodsNames, CreateRelationDataOmittingFKeys, CreateRelationsData, CreateRelationsDataOmittingFKeys, CustomTypeColumn, DateBaseColumn, DateColumn, DateTimeBaseClass, DateTimeTzBaseClass, Db, DbOptions, DbResult, DbTableOptions, DecimalBaseColumn, DecimalColumn, DefaultColumnTypes, Delete, DeleteMethodsNames, DeleteQueryData, DomainColumn, DoublePrecisionColumn, DropMode, DynamicRawSQL, EnumColumn, ExpressionOutput, FnExpression, FnExpressionArgs, For, ForeignKey, ForeignKeyAction, ForeignKeyMatch, ForeignKeyOptions, From, FromArgs, FromResult, GetArg, GetQueryResult, GetStringArg, GroupArg, Having, HavingItem, HookAction, HookSelect, IdentityColumn, IndexColumnOptions, IndexOptions, InetColumn, InsertQueryData, IntegerBaseColumn, IntegerColumn, IntervalColumn, IsolationLevel, JSONColumn, JSONTextColumn, Join, JoinArgs, JoinCallback, JoinFirstArg, JoinItem, JoinLateralCallback, JoinLateralItem, JoinLateralResult, JoinOverrides, JoinResult, JoinedParsers, JoinedShapes, JsonItem, JsonMethods, JsonModifiers, LimitedTextBaseColumn, LineColumn, LsegColumn, MacAddr8Column, MacAddrColumn, MergeQuery, MergeQueryMethods, MoneyColumn, MoreThanOneRowError, NoPrimaryKeyOption, NotFoundError, NumberAsStringBaseColumn, NumberBaseColumn, NumberColumn, NumberColumnData, OnConflictItem, OnConflictMergeUpdate, OnConflictQueryBuilder, OnQueryBuilder, Operator, Operators, OrCreateArg, OrchidOrmError, OrchidOrmInternalError, OrderArg, OrderArgs, OrderItem, OrderTsQueryConfig, Over, PathColumn, PluckResultColumnType, PointColumn, PolygonColumn, Query, QueryAfterHook, QueryArraysResult, QueryBase, QueryBeforeHook, QueryData, QueryDefaultReturnData, QueryError, QueryErrorName, QueryGet, QueryHelperResult, QueryHookSelect, QueryHooks, QueryLog, QueryLogObject, QueryLogOptions, QueryLogger, QueryMethods, QueryResult, QueryReturnType, QueryReturnsAll, QuerySourceItem, QueryTransform, QueryTransformFn, QueryUpsertOrCreate, QueryWithComputed, QueryWithTable, RawSQL, RawSqlMethods, RealColumn, RelationConfigBase, RelationConfigDataForCreate, RelationJoinQuery, RelationQuery, RelationQueryBase, RelationsBase, RelationsChain, SearchArg, SearchMethods, SearchWeight, Select, SelectArg, SelectAs, SelectItem, SelectQueryData, SelectSubQueryResult, SelectableBase, SelectableFromShape, SelectableOfType, SelectableOrExpression, SelectableOrExpressionOfType, SerialColumn, SerialColumnData, SetQueryKind, SetQueryReturns, SetQueryReturnsAll, SetQueryReturnsColumn, SetQueryReturnsColumnInfo, SetQueryReturnsColumnOptional, SetQueryReturnsOne, SetQueryReturnsOneOptional, SetQueryReturnsPluck, SetQueryReturnsPluckColumn, SetQueryReturnsRowCount, SetQueryReturnsRows, SetQueryReturnsValue, SetQueryReturnsValueOptional, SetQueryReturnsVoid, SetQueryTableAlias, SetQueryWith, SimpleJoinItem, SingleColumnIndexOptions, SmallIntColumn, SmallSerialColumn, SortDir, StringColumn, TableData, TextBaseColumn, TextColumn, TextColumnData, Then, TimeColumn, TimeInterval, TimestampColumn, TimestampTZColumn, ToSQLCtx, ToSQLOptions, Transaction, TransactionAdapter, TransactionOptions, TransformMethods, TruncateQueryData, TsQueryColumn, TsVectorColumn, TypeParsers, UUIDColumn, UnhandledTypeError, Union, UnionArg, UnionItem, UnionKind, UnknownColumn, Update, UpdateCtx, UpdateData, UpdateQueryData, UpdateQueryDataItem, UpdateQueryDataObject, UpdatedAtDataInjector, UpsertArg, UpsertResult, UpsertThis, VarCharColumn, VirtualColumn, Where, WhereArg, WhereArgs, WhereInArg, WhereInColumn, WhereInItem, WhereInValues, WhereItem, WhereJsonPathEqualsItem, WhereOnItem, WhereOnJoinItem, WhereQueryBase, WhereQueryBuilder, WhereResult, WhereSearchItem, WhereSearchResult, WindowArg, WindowArgDeclaration, WindowDeclaration, WindowItem, With, WithDataBase, WithDataItem, WithItem, WithOptions, XMLColumn, addComputedColumns, addOr, addOrNot, addParserForRawExpression, addParserForSelectItem, addQueryOn, addWhere, addWhereIn, addWhereNot, anyShape, checkIfASimpleQuery, cloneQueryArrays, columnCheckToCode, columnCode, columnForeignKeysToCode, columnIndexesToCode, columnTypes, columnsByType, columnsShapeToCode, constraintPropsToCode, constraintToCode, countSelect, createDb, extendQuery, foreignKeyArgumentToCode, getClonedQueryData, getColumnTypes, getConstraintKind, getQueryAs, getShapeFromSelect, getTableData, handleResult, identityToCode, indexToCode, instantiateColumn, isQueryReturnsAll, isSelectingCount, joinSubQuery, logColors, logParamToLogObject, makeExpression, makeFnExpression, makeRegexToFindInSql, makeSQL, newTableData, parseRecord, parseResult, primaryKeyToCode, processSelectArg, pushLimitSQL, pushQueryArray, pushQueryOn, pushQueryOrOn, pushQueryValue, queryMethodByReturnType, queryTypeWithLimitOne, quote, quoteString, raw, referencesArgsToCode, resetTableData, resolveSubQueryCallback, saveSearchAlias, setParserForSelectedString, setQueryObjectValue, setQueryOperators, simplifyColumnDefault, templateLiteralToSQL, testTransaction, throwIfNoWhere, toSQL, toSQLCacheKey };

package/dist/index.js

@@ -1074,7 +1074,7 @@ const processWhere = (ands, ctx, table, query, data, quotedAs, not) => {
     const res = data(qb);
     const expr = res instanceof orchidCore.Expression ? res : res.q.expr;
     if (!(res instanceof orchidCore.Expression) && res.q.expr) {
-      const q = "relationConfig" in res ? res.relationConfig.joinQuery(table, res) : res.clone();
+      const q = "relationConfig" in res ? res.relationConfig.joinQuery(res, table) : res.clone();
       q.q.select = [expr];
       ands.push(`${prefix}(${makeSQL(q, ctx).text})`);
     } else {
@@ -1308,7 +1308,7 @@ const processJoinItem = (ctx, table, query, item, quotedAs) => {
   if (typeof first === "string") {
     if (first in table.relations) {
       const { query: toQuery, joinQuery } = table.relations[first].relationConfig;
-      const jq = joinQuery(table, toQuery);
+      const jq = joinQuery(toQuery, table);
       const { q: j } = jq;
       const tableName = typeof j.from === "string" ? j.from : jq.table;
       target = quoteSchemaAndTable(j.schema, tableName);
@@ -1436,8 +1436,8 @@ const processArgs = (args, ctx, table, query, first, joinAs, joinShape, quotedAs
             base = base.as(q.q.as);
           }
           const { q: query2 } = first.joinQueryAfterCallback(
-            table,
-            base
+            base,
+            table
           );
           if (query2.and) {
             pushQueryArray(q, "and", query2.and);
@@ -2431,16 +2431,18 @@ const makeRegexToFindInSql = (value) => {
   return new RegExp(`${value}(?=(?:[^']*'[^']*')*[^']*$)`, "g");
 };
 const resolveSubQueryCallback = (q, cb) => {
-  const { isSubQuery } = q.q;
+  const { isSubQuery, relChain } = q.q;
   q.q.isSubQuery = true;
+  q.q.relChain = void 0;
   const result = cb(q);
   q.q.isSubQuery = isSubQuery;
+  q.q.relChain = relChain;
   return result;
 };
 const joinSubQuery = (q, sub) => {
   if (!("relationConfig" in sub))
     return sub;
-  return sub.relationConfig.joinQuery(q, sub);
+  return sub.relationConfig.joinQuery(sub, q);
 };
 
 const pushQueryArray = (q, key, value) => {
@@ -5816,8 +5818,8 @@ const _joinLateral = (q, type, arg, cb, as) => {
   let result = cb(query);
   if (relation) {
     result = relation.relationConfig.joinQuery(
-      q,
-      result
+      result,
+      q
     );
   }
   const joinKey = as || result.q.as || result.table;
@@ -5888,7 +5890,7 @@ const processSelectArg = (q, as, arg, columnAs) => {
     if (typeof value === "function") {
       value = resolveSubQueryCallback(q, value);
       if (!orchidCore.isExpression(value) && value.joinQuery) {
-        value = value.joinQuery(q, value);
+        value = value.joinQuery(value, q);
         let query;
         const returnType = value.q.returnType;
         if (!returnType || returnType === "all") {
@@ -6185,7 +6187,7 @@ class QueryGet {
    * It will throw `NotFoundError` when not found.
    *
    * ```ts
-   * import { NumberColumn } from 'pqb';
+   * import { NumberColumn } from 'orchid-orm';
    *
    * const firstName: string = await db.table.get('name');
    *
@@ -7469,7 +7471,7 @@ class JsonModifiers extends QueryBase {
    * Selects a value from JSON data using a JSON path.
    *
    * ```ts
-   * import { columnTypes } from 'pqb';
+   * import { columnTypes } from 'orchid-orm';
    *
    * db.table.jsonPathQuery(
    *   columnTypes.text(3, 100), // type of the value
@@ -8056,7 +8058,7 @@ class With {
    * Add Common Table Expression (CTE) to the query.
    *
    * ```ts
-   * import { columnTypes } from 'pqb';
+   * import { columnTypes } from 'orchid-orm';
    * import { NumberColumn } from './number';
    *
    * // .with optionally accepts such options:
@@ -8561,7 +8563,7 @@ class Update {
    * To make sure that at least one row was updated use `updateOrThrow`:
    *
    * ```ts
-   * import { NotFoundError } from 'pqb';
+   * import { NotFoundError } from 'orchid-orm';
    *
    * try {
    *   // updatedCount is guaranteed to be greater than 0
@@ -9897,6 +9899,20 @@ class QueryMethods {
    * await selectFollowing(db.user.select('id', 'name'), currentUser);
    * ```
    *
+   * To get the result type of query helper, use `QueryHelperResult` type:
+   *
+   * ```ts
+   * import { QueryHelperResult } from 'orchid-orm';
+   *
+   * const selectHelper = db.table.makeHelper((q) => q.select('id', 'name'));
+   *
+   * // This type is identical to `db.table.select('id', 'name')`
+   * type SelectQuery = QueryHelperResult<typeof selectHelper>;
+   *
+   * // Await to get result, the type is `{ id: number, name: string }[]`
+   * type Result = Awaited<QueryHelperResult<typeof selectHelper>>;
+   * ```
+   *
    * @param fn - helper function
    */
   makeHelper(fn) {