typeorm-extensions 1.2.3 → 1.2.5

package/docs/api_reference/order/index.html

@@ -1,36 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>Order / Api reference / typeorm-extensions</title>
-</head>
-<body>
-  <header>
-    <h1>Category: Order</h1>
-  </header>
-
-  <main>
-    <section>
-      <h2>
-        Categories:
-      </h2>
-      <ul>
-        <li><a href="../pagination">Pagination</a></li>
-        <li><a href="../order">Order</a></li>
-        <li><a href="../typed">Typed Extensions</a></li>
-      </ul>
-    </section>
-
-    <section>
-      <h2>
-        Functions:
-      </h2>
-      <ul>
-        <li><a href="applyOrderFilter.html">applyOrderFilter</a></li>
-        <li><a href="applyOrder.html">applyOrder</a></li>
-      </ul>
-    </section>
-  </main>
-</body>
-</html>

package/docs/api_reference/pagination/applyPaginationFilter.html

@@ -1,78 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>applyPaginationFilter / API reference / typeorm-extensions</title>
-</head>
-<body>
-  <header>
-    <h1>applyPaginationFilter</h1>
-    
-  </header>
-
-  <nav>
-    <ul>
-      <li><a href="../pagination">Pagination</a></li>
-      <li><a href="../order">Order</a></li>
-      <li><a href="../typed">Typed Extensions</a></li>
-    </ul>
-  </nav>
-
-  <main>
-    <section>
-      <h2>Description</h2>
-      <p>
-        <code>applyPaginationFilter</code> is a method that applies pagination to a query.
-      </p>
-    </section>
-    <section>
-      <h2>Signature</h2>
-      <p>
-        <pre><code>applyPaginationFilter(paginationFilter: PaginationFilter, paginationOptions?: ApplyPaginationOptions): void</code></pre>
-      </p>
-    </section>
-    <section>
-      <h2>Arguments</h2>
-      <ul>
-        <li>
-          <h3>paginationFilter: PaginationFilter</h3>
-          <p>The pagination options to apply to the query.</p>
-          <p>
-            <h4>Properties</h4>
-            <ul>
-              <li>
-                <h5>page: number</h5>
-                <p>The page number to retrieve.</p>
-              </li>
-            <li>
-              <h5>pageSize: number</h5>
-              <p>The number of items per page.</p>
-            </li>
-          </ul>
-        </p>
-      </li>
-      <li>
-        <h3>(optional) paginationOptions?: ApplyPaginationOptions</h3>
-        <p>Additional options to apply to the pagination filter.</p>
-        <p>
-          <h4>Properties</h4>
-          <ul>
-            <li>
-              <h5>useTakeAndSkip?: boolean</h5>
-              <p>
-                Whether to use the <code>take</code> and <code>skip</code> methods instead of <code>limit</code> and <code>offset</code> (defaults to false).
-              </p>
-            </li>
-          </ul>
-        </p>
-      </li>
-    </ul>
-    </section>
-    <section>
-      <h2>Usage</h2>
-      <pre><code>query.applyPaginationFilter({ page: 1, pageSize: 10 }, { useTakeAndSkip: true })</code></pre>
-    </section>
-  </main>
-</body>
-</html>

package/docs/api_reference/pagination/index.html

@@ -1,35 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>Pagination / Api reference / typeorm-extensions</title>
-</head>
-<body>
-  <header>
-    <h1>Category: Pagination</h1>
-  </header>
-
-  <main>
-    <section>
-      <h2>
-        Categories:
-      </h2>
-      <ul>
-        <li><a href="../pagination">Pagination</a></li>
-        <li><a href="../order">Order</a></li>
-        <li><a href="../typed">Typed Extensions</a></li>
-      </ul>
-    </section>
-
-    <section>
-      <h2>
-        Functions:
-      </h2>
-      <ul>
-        <li><a href="applyPaginationFilter.html">applyPaginationFilter</a></li>
-      </ul>
-    </section>
-  </main>
-</body>
-</html>

package/docs/api_reference/typed/index.html

@@ -1,37 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>Typed extensions / Api reference / typeorm-extensions</title>
-</head>
-<body>
-  <header>
-    <h1>Category: Typed Extensions</h1>
-  </header>
-
-  <main>
-
-    <section>
-      <h2>
-        Categories:
-      </h2>
-      <ul>
-        <li><a href="../pagination">Pagination</a></li>
-        <li><a href="../order">Order</a></li>
-        <li><a href="../typed">Typed Extensions</a></li>
-      </ul>
-    </section>
-
-    <section>
-      <h2>
-        Functions:
-      </h2>
-      <ul>
-        <li><a href="typed-where.html">whereTyped</a></li>
-        <li><a href="/">...TBD...</a></li>
-      </ul>
-    </section>
-  </main>
-</body>
-</html>

package/docs/examples/index.html

@@ -1,21 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>Examples / typeorm-extensions</title>
-</head>
-<body>
-  <header>
-    <h1>Examples</h1>
-  </header>
-
-  <nav>
-    <ul>
-      <li><a href="pagination">Pagination</a></li>
-      <li><a href="order">Order</a></li>
-      <li><a href="typed">Typed Extensions</a></li>
-    </ul>
-  </nav>
-</body>
-</html>

package/docs/index.html

@@ -1,78 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>typeorm-extensions</title>
-    <link rel="stylesheet" href="styles.css" />
-  </head>
-  <body>
-    <header>
-      <h1>Documentation</h1>
-    </header>
-
-    <nav>
-      <ul>
-        <li><a href="#getting-started">Getting Started</a></li>
-        <li><a href="#usage">Usage</a></li>
-        <li><a href="api_reference">API Reference</a></li>
-        <li><a href="examples">Examples</a></li>
-      </ul>
-    </nav>
-
-    <main>
-      <section id="getting-started">
-        <h2>Getting Started</h2>
-        <p>
-          <h3>Installation</h3>
-          <p>Install using npm, yarn or pnpm:</p>
-          <pre><code>npm install typeorm-extensions</code></pre>
-        </p>
-        <p>
-          <h3>Importing</h3>
-          <h4>Import the entire library:</h4>
-          <pre><code>import from 'typeorm-extensions';</code></pre>
-          <h4>Import the specific extension:</h4>
-          <pre><code>import from 'typeorm-extensions/dist/extensions/typed/typed-where/typed-where.extension';</code></pre>
-        </p>
-      </section>
-
-      <section id="api-reference">
-        <h2>API Reference</h2>
-        <p>
-          API documentation is available <a href="api_reference">here</a>
-        </p>
-      </section>
-
-      <section id="usage">
-        <h2>Usage</h2>
-        <p>
-          <h3>Pagination</h3>
-          <pre><code>query.applyPaginationFilter({ page: 1, pageSize: 10 }, { useTakeAndSkip: true })</code></pre>
-        </p>
-        <p>
-          <h3>Typed Where</h3>
-          <pre><code>query.whereTyped(user => user.name, 'ILIKE :search', { search: value })</code></pre>
-        </p>
-        <p>
-          <h3>Typed Order By</h3>
-          <pre><code>query.orderByTyped(user => user.name, 'ASC')</code></pre>
-        </p>
-        <p>
-          <h3>Typed Select</h3>
-          <pre><code>query.selectTyped(user => user.name)</code></pre>
-        </p>
-        <p>
-          <h3>Typed Join</h3>
-          <pre><code>query.leftJoinTyped(user => user.address, 'address')</code></pre>
-        </p>
-        <br> 
-        <p>
-          For other examples please visit the <a href="examples">Examples</a> page.
-        </p>
-      </section>
-    </main>
-
-    <footer>
-      <p>&copy; 2024 typeorm-extensions</p>
-    </footer>
-  </body>
-</html>

package/src/constants/index.ts

@@ -1,9 +0,0 @@
-export const defaultPageSize = 10;
-
-export const defaultUseTakeAndSkip = false;
-
-export const defaultUseDoubleQuotes = true;
-
-export const defaultOrderDirection = 'ASC';
-
-export const defaultNullsOrder = undefined;

package/src/extensions/get-many-with-totals.extension.ts

@@ -1,62 +0,0 @@
-import { SelectQueryBuilder } from 'typeorm/query-builder/SelectQueryBuilder';
-import { PaginationFilter } from '../types/interfaces/pagination.interface';
-import { getLimitAndOffset } from '../utils/pagination.utils';
-import { ApplyPaginationOptions } from './pagination.extension';
-
-export type GetManyWithTotalsOptions = {
-  disableTotalsCalculation?: boolean;
-  loadAll?: boolean;
-};
-
-export interface ListWithTotals<Entity> {
-  list: Entity[];
-  totalCount: number | null;
-  limit: number | null;
-  offset: number | null;
-}
-
-declare module 'typeorm/query-builder/SelectQueryBuilder' {
-  interface SelectQueryBuilder<Entity> {
-    getManyWithTotals(
-      paginationFilter: PaginationFilter,
-      options?: GetManyWithTotalsOptions
-    ): Promise<ListWithTotals<Entity>>;
-  }
-}
-
-SelectQueryBuilder.prototype.getManyWithTotals = async function <Entity>(
-  paginationFilter: PaginationFilter,
-  options?: GetManyWithTotalsOptions & ApplyPaginationOptions
-): Promise<ListWithTotals<Entity>> {
-  const { disableTotalsCalculation = false, loadAll = false } = options || {};
-
-  const { limit, offset } = loadAll
-    ? { limit: null, offset: null }
-    : getLimitAndOffset(paginationFilter);
-
-  const requests = [];
-
-  if (!disableTotalsCalculation) {
-    requests[0] = this.getCount();
-  } else {
-    requests[0] = Promise.resolve(null);
-  }
-
-  if (loadAll) {
-    requests[1] = this.getMany();
-  } else {
-    requests[1] = this.applyPaginationFilter(paginationFilter).getMany();
-  }
-
-  const [totalCount, list] = (await Promise.all(requests)) as [
-    number | null,
-    Entity[]
-  ];
-
-  return {
-    list,
-    totalCount: totalCount,
-    limit,
-    offset,
-  };
-};

package/src/extensions/order.extension.ts

@@ -1,123 +0,0 @@
-import { SelectQueryBuilder } from 'typeorm/query-builder/SelectQueryBuilder';
-import type {
-  OrderParam,
-  OrderFilter,
-  OrderType,
-} from '../types/interfaces/ordering.interface';
-import {
-  defaultNullsOrder,
-  defaultOrderDirection,
-  defaultUseDoubleQuotes,
-} from '../constants';
-import { ObjectLiteral } from 'typeorm';
-import { isNil } from '../utils/common.utils';
-import { Identifier } from '../utils/identifier.utils';
-
-const alwaysAliasWhiteList = [
-  'id',
-  'createdAt',
-  'created_at',
-  'updatedAt',
-  'updated_at',
-  'deletedAt',
-  'deleted_at',
-];
-
-export type ApplyOrderOptions = {
-  useDoubleQuotes?: boolean;
-  alias?: string;
-  alwaysAliasFields?: string[];
-  resetPreviousOrder?: boolean;
-};
-
-declare module 'typeorm/query-builder/SelectQueryBuilder' {
-  interface SelectQueryBuilder<Entity> {
-    applyOrder<OrderEntity>(
-      orderBy: OrderParam<OrderEntity>,
-      options?: ApplyOrderOptions
-    ): SelectQueryBuilder<Entity>;
-    applyOrderFilter<OrderEntity>(
-      orderFilter: OrderFilter<OrderEntity>,
-      options?: ApplyOrderOptions
-    ): SelectQueryBuilder<Entity>;
-  }
-}
-
-SelectQueryBuilder.prototype.applyOrder = function <
-  Entity extends ObjectLiteral,
-  OrderEntity
->(
-  orderBy: OrderParam<OrderEntity>,
-  options?: ApplyOrderOptions
-): SelectQueryBuilder<Entity> {
-  const { resetPreviousOrder = false } = options ?? {};
-
-  const orderOption = getOrderOption(orderBy, this.alias, options);
-
-  const query = resetPreviousOrder ? this.orderBy() : this;
-
-  return query.addOrderBy(
-    orderOption.selector,
-    orderOption.order,
-    orderOption.nulls
-  );
-};
-
-SelectQueryBuilder.prototype.applyOrderFilter = function <
-  Entity extends ObjectLiteral,
-  OrderEntity
->(
-  orderFilter: OrderFilter<OrderEntity>,
-  options?: ApplyOrderOptions
-): SelectQueryBuilder<Entity> {
-  if (!isNil(orderFilter?.orderBy)) {
-    return orderFilter.orderBy!.reduce(
-      (acc, order, index) =>
-        acc.applyOrder(order, {
-          ...options,
-          resetPreviousOrder: index === 0 ? options?.resetPreviousOrder : false,
-        }),
-      this as SelectQueryBuilder<Entity>
-    );
-  }
-
-  return this;
-};
-
-export const getOrderOption = <OrderEntity>(
-  orderBy: OrderParam<OrderEntity>,
-  defaultAlias: string,
-  options?: ApplyOrderOptions
-): OrderType => {
-  const {
-    useDoubleQuotes = defaultUseDoubleQuotes,
-    alias: customAlias,
-    alwaysAliasFields = alwaysAliasWhiteList,
-  } = options ?? {};
-  const {
-    field,
-    direction = defaultOrderDirection,
-    nulls: nullsOrder = defaultNullsOrder,
-  } = orderBy;
-
-  const alias =
-    customAlias ??
-    (alwaysAliasFields.includes(field as string) ? defaultAlias : undefined);
-
-  const identifier = new Identifier(field, alias, useDoubleQuotes);
-
-  const selector = identifier.fieldIdentifier();
-  const order = direction.toUpperCase() as 'ASC' | 'DESC';
-
-  const nulls = nullsOrder
-    ? (`NULLS ${nullsOrder.toUpperCase()}` as 'NULLS LAST' | 'NULLS FIRST')
-    : undefined;
-
-  return {
-    selector,
-    order,
-    nulls,
-  };
-};
-
-export {};

package/src/extensions/pagination.extension.ts

@@ -1,35 +0,0 @@
-import { SelectQueryBuilder } from 'typeorm/query-builder/SelectQueryBuilder';
-import type { PaginationFilter } from '../types/interfaces/pagination.interface';
-import { defaultUseTakeAndSkip } from '../constants';
-import { getLimitAndOffset } from '../utils/pagination.utils';
-import { ObjectLiteral } from 'typeorm';
-
-export type ApplyPaginationOptions = {
-  useTakeAndSkip?: boolean;
-};
-
-declare module 'typeorm/query-builder/SelectQueryBuilder' {
-  interface SelectQueryBuilder<Entity> {
-    applyPaginationFilter(
-      paginationFilter: PaginationFilter,
-      options?: ApplyPaginationOptions
-    ): SelectQueryBuilder<Entity>;
-  }
-}
-
-SelectQueryBuilder.prototype.applyPaginationFilter = function <Entity extends ObjectLiteral>(
-  paginationFilter: PaginationFilter,
-  options?: ApplyPaginationOptions
-): SelectQueryBuilder<Entity> {
-  const { useTakeAndSkip = defaultUseTakeAndSkip } = options || {};
-
-  const { limit, offset } = getLimitAndOffset(paginationFilter);
-
-  if (useTakeAndSkip) {
-    return this.take(limit).skip(offset);
-  }
-
-  return this.limit(limit).offset(offset);
-};
-
-export {};

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

@@ -1,38 +0,0 @@
-import { ObjectLiteral, SelectQueryBuilder } from 'typeorm';
-import { ColumnValueType } from '../typeorm.types';
-import { getSqlKey } from '../../../utils/proxy-key.utils';
-
-declare module 'typeorm/query-builder/SelectQueryBuilder' {
-	interface SelectQueryBuilder<Entity> {
-		/**
-		 * Sets the distinct on clause for Postgres.
-		 */
-		distinctOnTyped<Type extends ObjectLiteral = Entity>(
-			this: SelectQueryBuilder<Entity>,
-			...distinctOn: Array<(proxy: Type) => ColumnValueType>
-		): SelectQueryBuilder<Entity>;
-		/**
-		 * Sets the distinct on clause for Postgres.
-		 */
-		distinctOnTyped<Type extends ObjectLiteral = Entity>(
-			this: SelectQueryBuilder<Entity>,
-			distinctOn: (proxy: Type) => Array<ColumnValueType>
-		): SelectQueryBuilder<Entity>;
-	}
-}
-
-SelectQueryBuilder.prototype.distinctOnTyped = function <
-	Entity extends ObjectLiteral,
-	Type extends ObjectLiteral = Entity
->(
-	this: SelectQueryBuilder<Entity>,
-	...distinctOn: Array<(proxy: Type) => ColumnValueType | Array<ColumnValueType>>
-): SelectQueryBuilder<Entity> {
-	if (Array.isArray(distinctOn) && distinctOn.length) {
-		const keys = distinctOn.map((callback) => getSqlKey<Type>(callback, this.alias)).flat(3);
-
-		return this.distinctOn(keys as string[]);
-	}
-
-	return this;
-};