@mikro-orm/knex 6.0.0-dev.22 → 6.0.0-dev.221

package/typings.d.ts

@@ -1,6 +1,6 @@
 import type { Knex } from 'knex';
-import type { CheckCallback, Dictionary, EntityProperty, GroupOperator, QBFilterQuery, QueryOrderMap, Type } from '@mikro-orm/core';
-import type { QueryType } from './query/enums';
+import type { CheckCallback, Dictionary, EntityProperty, GroupOperator, RawQueryFragment, QBFilterQuery, QueryOrderMap, Type, QueryFlag } from '@mikro-orm/core';
+import type { JoinType, QueryType } from './query/enums';
 import type { DatabaseSchema, DatabaseTable } from './schema';
 export interface Table {
     table_name: string;
@@ -11,11 +11,11 @@ export type KnexStringRef = Knex.Ref<string, {
     [alias: string]: string;
 }>;
 type AnyString = string & {};
-export type Field<T> = AnyString | keyof T | KnexStringRef | Knex.QueryBuilder;
+export type Field<T> = AnyString | keyof T | RawQueryFragment | KnexStringRef | Knex.QueryBuilder;
 export interface JoinOptions {
     table: string;
     schema?: string;
-    type: 'leftJoin' | 'innerJoin' | 'pivotJoin';
+    type: JoinType;
     alias: string;
     ownerAlias: string;
     inverseAlias?: string;
@@ -25,6 +25,8 @@ export interface JoinOptions {
     path?: string;
     prop: EntityProperty;
     cond: Dictionary;
+    cond_?: Dictionary;
+    subquery?: string;
 }
 export interface Column {
     name: string;
@@ -38,6 +40,8 @@ export interface Column {
     scale?: number;
     default?: string | null;
     comment?: string;
+    generated?: string;
+    nativeEnumName?: string;
     enumItems?: string[];
     primary?: boolean;
     unique?: boolean;
@@ -58,9 +62,11 @@ export interface IndexDef {
     columnNames: string[];
     keyName: string;
     unique: boolean;
+    constraint: boolean;
     primary: boolean;
     composite?: boolean;
     expression?: string;
+    options?: Dictionary;
     type?: string | Readonly<{
         indexType?: string;
         storageEngineIndexType?: 'hash' | 'btree';
@@ -119,10 +125,12 @@ export interface IQueryBuilder<T> {
     delete(cond?: QBFilterQuery): this;
     truncate(): this;
     count(field?: string | string[], distinct?: boolean): this;
-    join(field: string, alias: string, cond?: QBFilterQuery, type?: 'leftJoin' | 'innerJoin' | 'pivotJoin', path?: string): this;
+    join(field: string, alias: string, cond?: QBFilterQuery, type?: JoinType, path?: string): this;
+    innerJoin(field: string, alias: string, cond?: QBFilterQuery): this;
     leftJoin(field: string, alias: string, cond?: QBFilterQuery): this;
     joinAndSelect(field: string, alias: string, cond?: QBFilterQuery): this;
-    leftJoinAndSelect(field: string, alias: string, cond?: QBFilterQuery): this;
+    leftJoinAndSelect(field: string, alias: string, cond?: QBFilterQuery, fields?: string[]): this;
+    innerJoinAndSelect(field: string, alias: string, cond?: QBFilterQuery, fields?: string[]): this;
     withSubQuery(subQuery: Knex.QueryBuilder, alias: string): this;
     where(cond: QBFilterQuery<T>, operator?: keyof typeof GroupOperator): this;
     where(cond: string, params?: any[], operator?: keyof typeof GroupOperator): this;
@@ -133,19 +141,30 @@ export interface IQueryBuilder<T> {
     orderBy(orderBy: QueryOrderMap<T>): this;
     groupBy(fields: (string | keyof T) | (string | keyof T)[]): this;
     having(cond?: QBFilterQuery | string, params?: any[]): this;
-    getAliasForJoinPath(path: string): string | undefined;
+    getAliasForJoinPath(path: string, options?: ICriteriaNodeProcessOptions): string | undefined;
+    getJoinForPath(path?: string, options?: ICriteriaNodeProcessOptions): JoinOptions | undefined;
     getNextAlias(entityName?: string): string;
+    clone(reset?: boolean): IQueryBuilder<T>;
+    setFlag(flag: QueryFlag): this;
+    unsetFlag(flag: QueryFlag): this;
+    hasFlag(flag: QueryFlag): boolean;
 }
-export interface ICriteriaNode {
+export interface ICriteriaNodeProcessOptions {
+    alias?: string;
+    matchPopulateJoins?: boolean;
+    ignoreBranching?: boolean;
+    preferNoBranch?: boolean;
+}
+export interface ICriteriaNode<T extends object> {
     readonly entityName: string;
-    readonly parent?: ICriteriaNode | undefined;
+    readonly parent?: ICriteriaNode<T> | undefined;
     readonly key?: string | undefined;
     payload: any;
     prop?: EntityProperty;
     index?: number;
-    process<T>(qb: IQueryBuilder<T>, alias?: string): any;
+    process(qb: IQueryBuilder<T>, options?: ICriteriaNodeProcessOptions): any;
     shouldInline(payload: any): boolean;
-    willAutoJoin<T>(qb: IQueryBuilder<T>, alias?: string): boolean;
+    willAutoJoin(qb: IQueryBuilder<T>, alias?: string): boolean;
     shouldRename(payload: any): boolean;
     renameFieldToPK<T>(qb: IQueryBuilder<T>): string;
     getPath(addIndex?: boolean): string;