typeorm-extensions 1.2.3 → 1.2.4

package/src/extensions/typed/typed-joins/typed-joins.extension.ts

@@ -1,141 +0,0 @@
-import { ObjectLiteral, SelectQueryBuilder } from 'typeorm';
-import { RelationalKeyProxyCallback } from '../typeorm-querybuilder.types';
-import { getSqlKey } from '../../../utils/proxy-key.utils';
-
-declare module 'typeorm/query-builder/SelectQueryBuilder' {
-  interface SelectQueryBuilder<Entity> {
-    leftJoinTyped<Type extends ObjectLiteral = Entity>(
-      this: SelectQueryBuilder<Entity>,
-      selection: RelationalKeyProxyCallback<Type>,
-      alias: string,
-      condition?: string,
-      parameters?: ObjectLiteral
-    ): SelectQueryBuilder<Entity>;
-    innerJoinTyped<Type extends ObjectLiteral = Entity>(
-      this: SelectQueryBuilder<Entity>,
-      selection: RelationalKeyProxyCallback<Type>,
-      alias: string,
-      condition?: string,
-      parameters?: ObjectLiteral
-    ): SelectQueryBuilder<Entity>;
-
-    leftJoinAndSelectTyped<Type extends ObjectLiteral = Entity>(
-      this: SelectQueryBuilder<Entity>,
-      selection: RelationalKeyProxyCallback<Type>,
-      alias: string,
-      condition?: string,
-      parameters?: ObjectLiteral
-    ): SelectQueryBuilder<Entity>;
-    innerJoinAndSelectTyped<Type extends ObjectLiteral = Entity>(
-      this: SelectQueryBuilder<Entity>,
-      selection: RelationalKeyProxyCallback<Type>,
-      alias: string,
-      condition?: string,
-      parameters?: ObjectLiteral
-    ): SelectQueryBuilder<Entity>;
-  }
-}
-
-SelectQueryBuilder.prototype.leftJoinTyped = function <
-  Entity extends ObjectLiteral,
-  Type extends ObjectLiteral = Entity
->(
-  this: SelectQueryBuilder<Entity>,
-  selection: RelationalKeyProxyCallback<Type>,
-  alias: string,
-  condition?: string,
-  parameters?: ObjectLiteral
-) {
-  if (typeof selection === 'function') {
-    return addJoin(this, 'leftJoin', selection, alias, condition, parameters);
-  }
-
-  return this;
-};
-
-SelectQueryBuilder.prototype.innerJoinTyped = function <
-  Entity extends ObjectLiteral,
-  Type extends ObjectLiteral = Entity
->(
-  this: SelectQueryBuilder<Entity>,
-  selection: RelationalKeyProxyCallback<Type>,
-  alias: string,
-  condition?: string,
-  parameters?: ObjectLiteral
-) {
-  if (typeof selection === 'function') {
-    return addJoin(this, 'innerJoin', selection, alias, condition, parameters);
-  }
-
-  return this;
-};
-
-SelectQueryBuilder.prototype.leftJoinAndSelectTyped = function <
-  Entity extends ObjectLiteral,
-  Type extends ObjectLiteral = Entity
->(
-  this: SelectQueryBuilder<Entity>,
-  selection: RelationalKeyProxyCallback<Type>,
-  alias: string,
-  condition?: string,
-  parameters?: ObjectLiteral
-) {
-  if (typeof selection === 'function') {
-    return addJoin(
-      this,
-      'leftJoinAndSelect',
-      selection,
-      alias,
-      condition,
-      parameters
-    );
-  }
-
-  return this;
-};
-
-SelectQueryBuilder.prototype.innerJoinAndSelectTyped = function <
-  Entity extends ObjectLiteral,
-  Type extends ObjectLiteral = Entity
->(
-  this: SelectQueryBuilder<Entity>,
-  selection: RelationalKeyProxyCallback<Type>,
-  alias: string,
-  condition?: string,
-  parameters?: ObjectLiteral
-) {
-  if (typeof selection === 'function') {
-    return addJoin(
-      this,
-      'innerJoinAndSelect',
-      selection,
-      alias,
-      condition,
-      parameters
-    );
-  }
-
-  return this;
-};
-
-type JoinMethod =
-  | 'leftJoin'
-  | 'innerJoin'
-  | 'leftJoinAndSelect'
-  | 'innerJoinAndSelect';
-
-function addJoin<
-  Entity extends ObjectLiteral,
-  Type extends ObjectLiteral = Entity
->(
-  query: SelectQueryBuilder<Entity>,
-  method: JoinMethod,
-  selection: RelationalKeyProxyCallback<Type>,
-  alias: string,
-  condition?: string,
-  parameters?: ObjectLiteral
-) {
-  const key = getSqlKey<Type>(selection, query.alias) as string;
-
-  return query[method](key, alias, condition, parameters);
-}

package/src/extensions/typed/typed-order-by/typed-order-by.extension.ts

@@ -1,73 +0,0 @@
-import { ObjectLiteral, SelectQueryBuilder } from 'typeorm';
-import { ColumnValueType } from '../typeorm.types';
-import { KeyHolder } from '../typeorm-querybuilder.types';
-import { getSqlKey } from '../../../utils/proxy-key.utils';
-
-declare module 'typeorm/query-builder/SelectQueryBuilder' {
-	interface SelectQueryBuilder<Entity> {
-		/**
-		 * Sets ORDER BY condition in the query builder.
-		 * If you had previously ORDER BY expression defined,
-		 * calling this function will override previously set ORDER BY conditions.
-		 */
-		orderByTyped<Type extends ObjectLiteral = Entity>(
-			this: SelectQueryBuilder<Entity>,
-			selection: (proxy: Type) => ColumnValueType | KeyHolder,
-			order?: 'ASC' | 'DESC',
-			nulls?: 'NULLS FIRST' | 'NULLS LAST'
-		): SelectQueryBuilder<Entity>;
-		/**
-		 * Adds ORDER BY condition in the query builder.
-		 */
-		addOrderByTyped<Type extends ObjectLiteral = Entity>(
-			this: SelectQueryBuilder<Entity>,
-			selection: (proxy: Type) => ColumnValueType | KeyHolder,
-			order?: 'ASC' | 'DESC',
-			nulls?: 'NULLS FIRST' | 'NULLS LAST'
-		): SelectQueryBuilder<Entity>;
-	}
-}
-
-SelectQueryBuilder.prototype.orderByTyped = function <
-	Entity extends ObjectLiteral,
-	Type extends ObjectLiteral = Entity
->(
-	this: SelectQueryBuilder<Entity>,
-	selection?: (proxy: Type) => ColumnValueType | KeyHolder,
-	order?: 'ASC' | 'DESC',
-	nulls?: 'NULLS FIRST' | 'NULLS LAST'
-): SelectQueryBuilder<Entity> {
-	if (selection instanceof KeyHolder) {
-		return this.orderBy(selection.toSql(), order, nulls);
-	}
-
-	if (typeof selection === 'function') {
-		const key = getSqlKey<Type>(selection, this.alias) as string;
-
-		return this.orderBy(key, order, nulls);
-	}
-
-	return this;
-};
-
-SelectQueryBuilder.prototype.addOrderByTyped = function <
-	Entity extends ObjectLiteral,
-	Type extends ObjectLiteral = Entity
->(
-	this: SelectQueryBuilder<Entity>,
-	selection?: (proxy: Type) => ColumnValueType | KeyHolder,
-	order?: 'ASC' | 'DESC',
-	nulls?: 'NULLS FIRST' | 'NULLS LAST'
-): SelectQueryBuilder<Entity> {
-	if (selection instanceof KeyHolder) {
-		return this.addOrderBy(selection.toSql(), order, nulls);
-	}
-
-	if (typeof selection === 'function') {
-		const key = getSqlKey<Type>(selection, this.alias) as string;
-
-		return this.addOrderBy(key, order, nulls);
-	}
-
-	return this;
-};

package/src/extensions/typed/typed-select/typed-select.extension.ts

@@ -1,124 +0,0 @@
-import { ObjectLiteral, SelectQueryBuilder } from 'typeorm';
-import { KeyHolder, KeyProxyCallback } from '../typeorm-querybuilder.types';
-import { getSqlKey } from '../../../utils/proxy-key.utils';
-
-declare module 'typeorm/query-builder/SelectQueryBuilder' {
-	interface SelectQueryBuilder<Entity> {
-		/**
-		 * Creates SELECT query.
-		 * Replaces all previous selections if they exist.
-		 */
-		selectTyped<Type extends ObjectLiteral = Entity>(
-			this: SelectQueryBuilder<Entity>,
-			selection: KeyProxyCallback<Type>,
-			selectionAliasName?: string
-		): SelectQueryBuilder<Entity>;
-		/**
-		 * Creates SELECT query and selects given data.
-		 * Replaces all previous selections if they exist.
-		 */
-		selectTyped(
-			this: SelectQueryBuilder<Entity>,
-			selection: string | KeyHolder,
-			selectionAliasName?: string
-		): SelectQueryBuilder<Entity>;
-		/**
-		 * Creates SELECT query and selects given data.
-		 * Replaces all previous selections if they exist.
-		 */
-		selectTyped<Type extends ObjectLiteral = Entity>(
-			this: SelectQueryBuilder<Entity>,
-			selection: string[] | KeyHolder[] | Array<KeyProxyCallback<Type>>
-		): SelectQueryBuilder<Entity>;
-
-		/**
-		 * Adds new selection to the SELECT query.
-		 */
-		addSelectTyped<Type extends ObjectLiteral = Entity>(
-			this: SelectQueryBuilder<Entity>,
-			selection: KeyProxyCallback<Type>,
-			selectionAliasName?: string
-		): SelectQueryBuilder<Entity>;
-		/**
-		 * Adds new selection to the SELECT query.
-		 */
-		addSelectTyped(
-			this: SelectQueryBuilder<Entity>,
-			selection: string | KeyHolder,
-			selectionAliasName?: string
-		): SelectQueryBuilder<Entity>;
-		/**
-		 * Adds new selection to the SELECT query.
-		 */
-		addSelectTyped<Type extends ObjectLiteral = Entity>(
-			this: SelectQueryBuilder<Entity>,
-			selection: string[] | KeyHolder[] | Array<KeyProxyCallback<Type>>
-		): SelectQueryBuilder<Entity>;
-	}
-}
-
-SelectQueryBuilder.prototype.selectTyped = function <Entity extends ObjectLiteral, Type extends ObjectLiteral = Entity>(
-	this: SelectQueryBuilder<Entity>,
-	selection?:
-		| string
-		| KeyHolder
-		| KeyProxyCallback<Type>
-		| string[]
-		| KeyHolder[]
-		| Array<KeyProxyCallback<Type>>,
-	selectionAliasName?: string
-): SelectQueryBuilder<Entity> {
-	return attachSelectMethod<Entity, Type>(this, 'select', selection, selectionAliasName);
-};
-
-SelectQueryBuilder.prototype.addSelectTyped = function <
-	Entity extends ObjectLiteral,
-	Type extends ObjectLiteral = Entity
->(
-	this: SelectQueryBuilder<Entity>,
-	selection?:
-		| string
-		| KeyHolder
-		| KeyProxyCallback<Type>
-		| string[]
-		| KeyHolder[]
-		| Array<KeyProxyCallback<Type>>,
-	selectionAliasName?: string
-): SelectQueryBuilder<Entity> {
-	return attachSelectMethod<Entity, Type>(this, 'addSelect', selection, selectionAliasName);
-};
-
-const attachSelectMethod = <Entity extends ObjectLiteral, Type extends ObjectLiteral = Entity>(
-	query: SelectQueryBuilder<Entity>,
-	method: 'select' | 'addSelect',
-	selection?:
-		| string
-		| KeyHolder
-		| KeyProxyCallback<Type>
-		| string[]
-		| KeyHolder[]
-		| Array<KeyProxyCallback<Type>>,
-	selectionAliasName?: string
-): SelectQueryBuilder<Entity> => {
-	if (selection instanceof KeyHolder) {
-		return query[method](selection.toSql(), selectionAliasName);
-	}
-
-	if (Array.isArray(selection)) {
-		const arrayOfKeys = selection.map((value) => getSqlKey<Type>(value, query.alias) as string);
-
-		return query[method](arrayOfKeys);
-	} else if (typeof selection === 'function') {
-		const keyArrayOrSingleKey = getSqlKey<Type>(selection, query.alias);
-
-		if (Array.isArray(keyArrayOrSingleKey)) {
-			return query[method](keyArrayOrSingleKey);
-		}
-
-		return query[method](keyArrayOrSingleKey, selectionAliasName);
-	} else if (typeof selection === 'string') {
-		return query[method](selection, selectionAliasName);
-	}
-
-	return query;
-};

package/src/extensions/typed/typed-where/typed-where.extension.ts

@@ -1,268 +0,0 @@
-import {
-  ObjectLiteral,
-  SelectQueryBuilder,
-  WhereExpressionBuilder,
-  UpdateQueryBuilder,
-  DeleteQueryBuilder,
-} from 'typeorm';
-import { ColumnValueType } from '../typeorm.types';
-import { getSqlKey } from '../../../utils/proxy-key.utils';
-
-export interface TypedWhereOptions {
-  useDoubleQuotes?: boolean;
-}
-
-declare module 'typeorm/query-builder/WhereExpressionBuilder' {
-  interface WhereExpressionBuilder {
-    /**
-     * Sets WHERE condition in the query builder.
-     * If you had previously WHERE expression defined,
-     * calling this function will override previously set WHERE conditions.
-     * Additionally you can add parameters used in where expression.
-     */
-    whereTyped<Type extends ObjectLiteral>(
-      subQuery: (proxy: Type) => ColumnValueType,
-      conditions: string,
-      parameters?: ObjectLiteral,
-      options?: TypedWhereOptions
-    ): this;
-
-    /**
-     * Adds new AND WHERE condition in the query builder.
-     * Additionally you can add parameters used in where expression.
-     */
-    andWhereTyped<Type extends ObjectLiteral>(
-      subQuery: (proxy: Type) => ColumnValueType,
-      conditions: string,
-      parameters?: ObjectLiteral,
-      options?: TypedWhereOptions
-    ): this;
-
-    /**
-     * Adds new OR WHERE condition in the query builder.
-     * Additionally you can add parameters used in where expression.
-     */
-    orWhereTyped<Type extends ObjectLiteral>(
-      subQuery: (proxy: Type) => ColumnValueType,
-      conditions: string,
-      parameters?: ObjectLiteral,
-      options?: TypedWhereOptions
-    ): this;
-  }
-}
-
-declare module 'typeorm/query-builder/SelectQueryBuilder' {
-  interface SelectQueryBuilder<Entity> {
-    /**
-     * Sets WHERE condition in the query builder.
-     * If you had previously WHERE expression defined,
-     * calling this function will override previously set WHERE conditions.
-     * Additionally you can add parameters used in where expression.
-     */
-    whereTyped<Type extends ObjectLiteral = Entity>(
-      where: (proxy: Type) => ColumnValueType,
-      conditions: string,
-      parameters?: ObjectLiteral,
-      options?: TypedWhereOptions
-    ): this;
-
-    /**
-     * Adds new AND WHERE condition in the query builder.
-     * Additionally you can add parameters used in where expression.
-     */
-    andWhereTyped<Type extends ObjectLiteral = Entity>(
-      where: (proxy: Type) => ColumnValueType,
-      conditions: string,
-      parameters?: ObjectLiteral,
-      options?: TypedWhereOptions
-    ): this;
-
-    /**
-     * Adds new OR WHERE condition in the query builder.
-     * Additionally you can add parameters used in where expression.
-     */
-    orWhereTyped<Type extends ObjectLiteral = Entity>(
-      where: (proxy: Type) => ColumnValueType,
-      conditions: string,
-      parameters?: ObjectLiteral,
-      options?: TypedWhereOptions
-    ): this;
-  }
-}
-
-declare module 'typeorm/query-builder/UpdateQueryBuilder' {
-  interface UpdateQueryBuilder<Entity> {
-    /**
-     * Sets WHERE condition in the query builder.
-     * If you had previously WHERE expression defined,
-     * calling this function will override previously set WHERE conditions.
-     * Additionally you can add parameters used in where expression.
-     */
-    whereTyped<Type extends ObjectLiteral = Entity>(
-      where: (proxy: Type) => ColumnValueType,
-      conditions: string,
-      parameters?: ObjectLiteral,
-      options?: TypedWhereOptions
-    ): this;
-
-    /**
-     * Adds new AND WHERE condition in the query builder.
-     * Additionally you can add parameters used in where expression.
-     */
-    andWhereTyped<Type extends ObjectLiteral = Entity>(
-      where: (proxy: Type) => ColumnValueType,
-      conditions: string,
-      parameters?: ObjectLiteral,
-      options?: TypedWhereOptions
-    ): this;
-
-    /**
-     * Adds new OR WHERE condition in the query builder.
-     * Additionally you can add parameters used in where expression.
-     */
-    orWhereTyped<Type extends ObjectLiteral = Entity>(
-      where: (proxy: Type) => ColumnValueType,
-      conditions: string,
-      parameters?: ObjectLiteral,
-      options?: TypedWhereOptions
-    ): this;
-  }
-}
-
-declare module 'typeorm/query-builder/DeleteQueryBuilder' {
-  interface DeleteQueryBuilder<Entity> {
-    /**
-     * Sets WHERE condition in the query builder.
-     * If you had previously WHERE expression defined,
-     * calling this function will override previously set WHERE conditions.
-     * Additionally you can add parameters used in where expression.
-     */
-    whereTyped<Type extends ObjectLiteral = Entity>(
-      where: (proxy: Type) => ColumnValueType,
-      conditions: string,
-      parameters?: ObjectLiteral,
-      options?: TypedWhereOptions
-    ): this;
-
-    /**
-     * Adds new AND WHERE condition in the query builder.
-     * Additionally you can add parameters used in where expression.
-     */
-    andWhereTyped<Type extends ObjectLiteral = Entity>(
-      where: (proxy: Type) => ColumnValueType,
-      conditions: string,
-      parameters?: ObjectLiteral,
-      options?: TypedWhereOptions
-    ): this;
-
-    /**
-     * Adds new OR WHERE condition in the query builder.
-     * Additionally you can add parameters used in where expression.
-     */
-    orWhereTyped<Type extends ObjectLiteral = Entity>(
-      where: (proxy: Type) => ColumnValueType,
-      conditions: string,
-      parameters?: ObjectLiteral,
-      options?: TypedWhereOptions
-    ): this;
-  }
-}
-
-const queryBuilders = [
-  SelectQueryBuilder,
-  UpdateQueryBuilder,
-  DeleteQueryBuilder,
-];
-
-const extension = {
-  prototype: {
-    whereTyped: function <
-      Entity extends ObjectLiteral,
-      Type extends ObjectLiteral = Entity
-    >(
-      this: SelectQueryBuilder<Entity>,
-      where: (proxy: Type) => ColumnValueType,
-      conditions: string,
-      parameters?: ObjectLiteral,
-      options?: TypedWhereOptions
-    ): SelectQueryBuilder<Entity> {
-      return attachWhere<Type, SelectQueryBuilder<Entity>>(
-        this,
-        'where',
-        where,
-        conditions,
-        parameters,
-        options
-      );
-    },
-    andWhereTyped: function <
-      Entity extends ObjectLiteral,
-      Type extends ObjectLiteral = Entity
-    >(
-      this: SelectQueryBuilder<Entity>,
-      where: (proxy: Type) => ColumnValueType,
-      conditions: string,
-      parameters?: ObjectLiteral,
-      options?: TypedWhereOptions
-    ): SelectQueryBuilder<Entity> {
-      return attachWhere<Type, SelectQueryBuilder<Entity>>(
-        this,
-        'andWhere',
-        where,
-        conditions,
-        parameters,
-        options
-      );
-    },
-    orWhereTyped: function <
-      Entity extends ObjectLiteral,
-      Type extends ObjectLiteral = Entity
-    >(
-      this: SelectQueryBuilder<Entity>,
-      where: (proxy: Type) => ColumnValueType,
-      conditions: string,
-      parameters?: ObjectLiteral,
-      options?: TypedWhereOptions
-    ): SelectQueryBuilder<Entity> {
-      return attachWhere<Type, SelectQueryBuilder<Entity>>(
-        this,
-        'orWhere',
-        where,
-        conditions,
-        parameters,
-        options
-      );
-    },
-  },
-};
-
-queryBuilders.forEach((builder) => {
-	Object.assign(builder, extension);
-});
-
-type WhereMethod = 'where' | 'andWhere' | 'orWhere';
-
-function attachWhere<
-  Type extends ObjectLiteral,
-  Q extends WhereExpressionBuilder = WhereExpressionBuilder
->(
-  builder: Q,
-  method: WhereMethod,
-  where: (proxy: Type) => ColumnValueType,
-  conditions: string,
-  parameters?: ObjectLiteral,
-  options?: TypedWhereOptions
-): Q {
-  if (typeof where === 'function') {
-    const key = getSqlKey<Type>(
-      where,
-      (builder as unknown as SelectQueryBuilder<Type>).alias,
-      options?.useDoubleQuotes
-    );
-
-    // .andWhere(`"table"."column"   IN (:...values)`, { values: ['value'] })
-    return builder[method](`${key} ${conditions}`, parameters);
-  }
-
-  return builder;
-}

package/src/extensions/typed/typeorm-querybuilder.types.ts

@@ -1,75 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { ObjectLiteral } from 'typeorm';
-import { ColumnValueType, EntityOnlyWithRelations, EntityWithoutRelations } from './typeorm.types';
-
-export class KeyHolder {
-	constructor(public keys: string[] = []) {
-		this.keys = [...keys];
-	}
-
-	toSql(length: number = 2, addDobleQuotes = true) {
-		const string = this.toString(length);
-		const sql = addDobleQuotes ? `"${string.replace(/\./g, '"."')}"` : string;
-
-		return sql;
-	}
-
-	toString(length = 2) {
-		const keys = this.keys.slice(0, length);
-		const string = keys.join('.');
-
-		return string;
-	}
-
-	valueOf() {
-		return this.toString();
-	}
-
-	[Symbol.toPrimitive]() {
-		return this.toString();
-	}
-
-	add(key: string | symbol) {
-		if (
-			typeof key !== 'symbol' &&
-			!Object.getOwnPropertyNames(this).includes(key) && // check of getOwnPropertyNames(this) is questionable
-			!Object.getOwnPropertyNames(KeyHolder.prototype).includes(key)
-		) {
-			this.keys.push(key);
-		}
-
-		return this;
-	}
-}
-
-export class TypedProxy {
-	public static defaultHandler = {};
-
-	public static create<T extends ObjectLiteral>(obj: object, handler = TypedProxy.defaultHandler) {
-		return new Proxy(obj, handler) as T;
-	}
-}
-
-export class KeyProxy {
-	public static defaultHandler: ProxyHandler<KeyHolder> = {
-		get(target, key, receiver) {
-			// for each key create new independent layer of KeyProxy
-			const newKeyHolder = new KeyHolder(target.keys).add(key);
-			const newLayer = TypedProxy.create<ObjectLiteral>(newKeyHolder, KeyProxy.defaultHandler);
-
-			return Reflect.get(target, key, receiver) ?? newLayer;
-		},
-	};
-
-	public static create<T extends ObjectLiteral>() {
-		return TypedProxy.create<T>(new KeyHolder(), KeyProxy.defaultHandler);
-	}
-}
-
-export type KeyProxyCallback<T extends ObjectLiteral> = (proxy: T) => ColumnValueType | Array<ColumnValueType>;
-export type RelationalKeyProxyCallback<T extends ObjectLiteral> = (
-	proxy: EntityOnlyWithRelations<T>
-) => ColumnValueType;
-export type NonRelationalKeyProxyCallback<T extends ObjectLiteral> = (
-	proxy: EntityWithoutRelations<T>
-) => ColumnValueType;

package/src/types/interfaces/pagination.interface.ts

@@ -1,8 +0,0 @@
-export type PageSize = number;
-
-export type PageNumber = number; // 1-based index
-
-export interface PaginationFilter {
-  page?: PageNumber;
-  pageSize?: PageSize;
-}