@freshpointcz/fresh-core 0.0.20 → 0.0.21

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { BaseEntity, ColumnOptions, Repository, EntityTarget, EntityManager, ObjectLiteral, EntitySubscriberInterface, InsertEvent, UpdateEvent, SoftRemoveEvent, TransactionCommitEvent, DataSourceOptions } from 'typeorm';
+import { FindOperator, BaseEntity, FindOptionsOrder, ColumnOptions, Repository, EntityTarget, EntityManager, ObjectLiteral, EntitySubscriberInterface, InsertEvent, UpdateEvent, SoftRemoveEvent, TransactionCommitEvent, DataSourceOptions } from 'typeorm';
 import dayjs, { Dayjs } from 'dayjs';
 import { Job } from 'node-schedule';
 import * as _eslint_core from '@eslint/core';
@@ -54,6 +54,36 @@ declare class StatusDto {
     constructor(status: Status, details?: string, timestamp?: string);
 }
 
+/**
+ * Converts optional date range strings into a TypeORM `FindOperator<Date>`.
+ *
+ * - Both provided → `Between(from, to)`
+ * - Only `from`   → `MoreThanOrEqual(from)`
+ * - Only `to`     → `LessThanOrEqual(to)`
+ * - Neither       → `undefined`
+ *
+ * @param from - ISO date string for the lower bound (inclusive).
+ * @param to   - ISO date string for the upper bound (inclusive).
+ * @returns A TypeORM date range operator, or `undefined` if no bounds are provided.
+ */
+declare function buildDateRange(from?: string, to?: string): FindOperator<Date> | undefined;
+
+/**
+ * Converts optional sort query params into a TypeORM `FindOptionsOrder` object.
+ *
+ * Defaults to `ASC` if `sortBy` is provided but `sortOrder` is omitted.
+ * Returns `undefined` if no sort field is specified, leaving the order to TypeORM's default.
+ *
+ * @param sortBy    - Entity field to sort by.
+ * @param sortOrder - Sort direction. Defaults to `"ASC"`.
+ * @returns A `FindOptionsOrder` object, or `undefined` if `sortBy` is not provided.
+ *
+ * @example
+ * buildOrder("createdAt", "DESC") // → { createdAt: "DESC" }
+ * buildOrder()                    // → undefined
+ */
+declare function buildOrder<TEntity extends BaseEntity, TSortableFields extends keyof TEntity>(sortBy?: TSortableFields, sortOrder?: "ASC" | "DESC"): FindOptionsOrder<TEntity> | undefined;
+
 /**
  * Pagination parameters used to describe the current page slice of a query.
  *
@@ -122,6 +152,21 @@ declare function getPaginationParams(params?: Partial<PaginationParams>): Pagina
  */
 declare const DEFAULT_PAGINATION_PARAMS: PaginationParams;
 
+/**
+ * Converts optional pagination query params into a `PaginationParams` object
+ * with a pre-calculated `skip` offset for TypeORM queries.
+ *
+ * Defaults to page `1` and limit `1000` if only one side is provided.
+ * Returns `undefined` if neither param is present, allowing the caller
+ * to opt out of pagination entirely.
+ *
+ * @param page  - 1-based page number. Must be ≥ 1 if provided.
+ * @param limit - Maximum number of records per page. Must be ≥ 0 if provided.
+ * @returns Resolved `PaginationParams` with `skip`, or `undefined` if both params are absent.
+ * @throws {ApiError} `400 BAD_REQUEST` if `page < 1` or `limit < 0`.
+ */
+declare function buildPagination(page?: number, limit?: number): PaginationParams | undefined;
+
 /**
  * Converts {@link PaginationParams} into the `take`/`skip` shape expected by
  * TypeORM's `find`, `findAndCount`, and `findOne` options.
@@ -1317,4 +1362,4 @@ interface HealthCheckResult {
     };
 }
 
-export { AMOUNT_UNIT, ActionCommandCode, ApiError, BadGatewayError, BadRequestError, BaseEntityChangeSubscriber, type BinaryFlag, BusinessWarning, type CardNumber, Category, ConflictError, DEFAULT_PAGINATION_PARAMS, DataHelper, DateUtils, type Deferred, DepotPoolStatus, Device, type EntityChangeEvent, ExpectationFailedError, FailedDependencyError, ForbiddenError, FreshDao, FreshEntity, FreshError, type FreshErrorOptions, FreshHyperEntity, FreshJob, FreshTranslationBase, GatewayTimeoutError, GoneError, type HealthCheckResult, HttpStatus, HttpVersionNotSupportedError, ImATeapotError, InsufficientStorageError, InternalServerError, type IsDecimalOptions, LanguageCode, LengthRequiredError, LockedError, LoopDetectedError, Manufacturer, type Maybe, MethodNotAllowedError, MisdirectedRequestError, NetworkAuthenticationRequiredError, NotAcceptableError, NotExtendedError, NotFoundError, NotImplementedError, type PaginatedList, type PaginationMeta, type PaginationParams, PayloadTooLargeError, PaymentMethod, PaymentRequiredError, PG_DATA_SOURCE_OPTIONS as PgDataSourceOptions, PreconditionFailedError, PreconditionRequiredError, Product, ProxyAuthenticationRequiredError, RangeNotSatisfiableError, RequestHeaderFieldsTooLargeError, RequestTimeoutError, ServiceUnavailableError, SinglePromiseWaiter, Singleton, type Status, StatusDto, Subcategory, TO_BINARY_FLAG, TimestampColumn, TooEarlyError, TooManyRequestsError, TransactionType, UnauthorizedError, UnavailableForLegalReasonsError, UnprocessableEntityError, UnsupportedMediaTypeError, UpgradeRequiredError, UriTooLongError, VariantAlsoNegotiatesError, buildPatch, constructTypeormPagination, createDeferred, FRESH_ESLINT_CONFIG as freshEslintConfig, getPaginationMeta, getPaginationParams, hasOwn, isDecimal, isEnumValue, isFlag01, isMaybe, isNumber, isNumberInRange, isObject, isString, isValidCron, listAll, parsePaginationFromURL, resolvePathParameterId, runWithConcurrency, toDecimal };
+export { AMOUNT_UNIT, ActionCommandCode, ApiError, BadGatewayError, BadRequestError, BaseEntityChangeSubscriber, type BinaryFlag, BusinessWarning, type CardNumber, Category, ConflictError, DEFAULT_PAGINATION_PARAMS, DataHelper, DateUtils, type Deferred, DepotPoolStatus, Device, type EntityChangeEvent, ExpectationFailedError, FailedDependencyError, ForbiddenError, FreshDao, FreshEntity, FreshError, type FreshErrorOptions, FreshHyperEntity, FreshJob, FreshTranslationBase, GatewayTimeoutError, GoneError, type HealthCheckResult, HttpStatus, HttpVersionNotSupportedError, ImATeapotError, InsufficientStorageError, InternalServerError, type IsDecimalOptions, LanguageCode, LengthRequiredError, LockedError, LoopDetectedError, Manufacturer, type Maybe, MethodNotAllowedError, MisdirectedRequestError, NetworkAuthenticationRequiredError, NotAcceptableError, NotExtendedError, NotFoundError, NotImplementedError, type PaginatedList, type PaginationMeta, type PaginationParams, PayloadTooLargeError, PaymentMethod, PaymentRequiredError, PG_DATA_SOURCE_OPTIONS as PgDataSourceOptions, PreconditionFailedError, PreconditionRequiredError, Product, ProxyAuthenticationRequiredError, RangeNotSatisfiableError, RequestHeaderFieldsTooLargeError, RequestTimeoutError, ServiceUnavailableError, SinglePromiseWaiter, Singleton, type Status, StatusDto, Subcategory, TO_BINARY_FLAG, TimestampColumn, TooEarlyError, TooManyRequestsError, TransactionType, UnauthorizedError, UnavailableForLegalReasonsError, UnprocessableEntityError, UnsupportedMediaTypeError, UpgradeRequiredError, UriTooLongError, VariantAlsoNegotiatesError, buildDateRange, buildOrder, buildPagination, buildPatch, constructTypeormPagination, createDeferred, FRESH_ESLINT_CONFIG as freshEslintConfig, getPaginationMeta, getPaginationParams, hasOwn, isDecimal, isEnumValue, isFlag01, isMaybe, isNumber, isNumberInRange, isObject, isString, isValidCron, listAll, parsePaginationFromURL, resolvePathParameterId, runWithConcurrency, toDecimal };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { BaseEntity, ColumnOptions, Repository, EntityTarget, EntityManager, ObjectLiteral, EntitySubscriberInterface, InsertEvent, UpdateEvent, SoftRemoveEvent, TransactionCommitEvent, DataSourceOptions } from 'typeorm';
+import { FindOperator, BaseEntity, FindOptionsOrder, ColumnOptions, Repository, EntityTarget, EntityManager, ObjectLiteral, EntitySubscriberInterface, InsertEvent, UpdateEvent, SoftRemoveEvent, TransactionCommitEvent, DataSourceOptions } from 'typeorm';
 import dayjs, { Dayjs } from 'dayjs';
 import { Job } from 'node-schedule';
 import * as _eslint_core from '@eslint/core';
@@ -54,6 +54,36 @@ declare class StatusDto {
     constructor(status: Status, details?: string, timestamp?: string);
 }
 
+/**
+ * Converts optional date range strings into a TypeORM `FindOperator<Date>`.
+ *
+ * - Both provided → `Between(from, to)`
+ * - Only `from`   → `MoreThanOrEqual(from)`
+ * - Only `to`     → `LessThanOrEqual(to)`
+ * - Neither       → `undefined`
+ *
+ * @param from - ISO date string for the lower bound (inclusive).
+ * @param to   - ISO date string for the upper bound (inclusive).
+ * @returns A TypeORM date range operator, or `undefined` if no bounds are provided.
+ */
+declare function buildDateRange(from?: string, to?: string): FindOperator<Date> | undefined;
+
+/**
+ * Converts optional sort query params into a TypeORM `FindOptionsOrder` object.
+ *
+ * Defaults to `ASC` if `sortBy` is provided but `sortOrder` is omitted.
+ * Returns `undefined` if no sort field is specified, leaving the order to TypeORM's default.
+ *
+ * @param sortBy    - Entity field to sort by.
+ * @param sortOrder - Sort direction. Defaults to `"ASC"`.
+ * @returns A `FindOptionsOrder` object, or `undefined` if `sortBy` is not provided.
+ *
+ * @example
+ * buildOrder("createdAt", "DESC") // → { createdAt: "DESC" }
+ * buildOrder()                    // → undefined
+ */
+declare function buildOrder<TEntity extends BaseEntity, TSortableFields extends keyof TEntity>(sortBy?: TSortableFields, sortOrder?: "ASC" | "DESC"): FindOptionsOrder<TEntity> | undefined;
+
 /**
  * Pagination parameters used to describe the current page slice of a query.
  *
@@ -122,6 +152,21 @@ declare function getPaginationParams(params?: Partial<PaginationParams>): Pagina
  */
 declare const DEFAULT_PAGINATION_PARAMS: PaginationParams;
 
+/**
+ * Converts optional pagination query params into a `PaginationParams` object
+ * with a pre-calculated `skip` offset for TypeORM queries.
+ *
+ * Defaults to page `1` and limit `1000` if only one side is provided.
+ * Returns `undefined` if neither param is present, allowing the caller
+ * to opt out of pagination entirely.
+ *
+ * @param page  - 1-based page number. Must be ≥ 1 if provided.
+ * @param limit - Maximum number of records per page. Must be ≥ 0 if provided.
+ * @returns Resolved `PaginationParams` with `skip`, or `undefined` if both params are absent.
+ * @throws {ApiError} `400 BAD_REQUEST` if `page < 1` or `limit < 0`.
+ */
+declare function buildPagination(page?: number, limit?: number): PaginationParams | undefined;
+
 /**
  * Converts {@link PaginationParams} into the `take`/`skip` shape expected by
  * TypeORM's `find`, `findAndCount`, and `findOne` options.
@@ -1317,4 +1362,4 @@ interface HealthCheckResult {
     };
 }
 
-export { AMOUNT_UNIT, ActionCommandCode, ApiError, BadGatewayError, BadRequestError, BaseEntityChangeSubscriber, type BinaryFlag, BusinessWarning, type CardNumber, Category, ConflictError, DEFAULT_PAGINATION_PARAMS, DataHelper, DateUtils, type Deferred, DepotPoolStatus, Device, type EntityChangeEvent, ExpectationFailedError, FailedDependencyError, ForbiddenError, FreshDao, FreshEntity, FreshError, type FreshErrorOptions, FreshHyperEntity, FreshJob, FreshTranslationBase, GatewayTimeoutError, GoneError, type HealthCheckResult, HttpStatus, HttpVersionNotSupportedError, ImATeapotError, InsufficientStorageError, InternalServerError, type IsDecimalOptions, LanguageCode, LengthRequiredError, LockedError, LoopDetectedError, Manufacturer, type Maybe, MethodNotAllowedError, MisdirectedRequestError, NetworkAuthenticationRequiredError, NotAcceptableError, NotExtendedError, NotFoundError, NotImplementedError, type PaginatedList, type PaginationMeta, type PaginationParams, PayloadTooLargeError, PaymentMethod, PaymentRequiredError, PG_DATA_SOURCE_OPTIONS as PgDataSourceOptions, PreconditionFailedError, PreconditionRequiredError, Product, ProxyAuthenticationRequiredError, RangeNotSatisfiableError, RequestHeaderFieldsTooLargeError, RequestTimeoutError, ServiceUnavailableError, SinglePromiseWaiter, Singleton, type Status, StatusDto, Subcategory, TO_BINARY_FLAG, TimestampColumn, TooEarlyError, TooManyRequestsError, TransactionType, UnauthorizedError, UnavailableForLegalReasonsError, UnprocessableEntityError, UnsupportedMediaTypeError, UpgradeRequiredError, UriTooLongError, VariantAlsoNegotiatesError, buildPatch, constructTypeormPagination, createDeferred, FRESH_ESLINT_CONFIG as freshEslintConfig, getPaginationMeta, getPaginationParams, hasOwn, isDecimal, isEnumValue, isFlag01, isMaybe, isNumber, isNumberInRange, isObject, isString, isValidCron, listAll, parsePaginationFromURL, resolvePathParameterId, runWithConcurrency, toDecimal };
+export { AMOUNT_UNIT, ActionCommandCode, ApiError, BadGatewayError, BadRequestError, BaseEntityChangeSubscriber, type BinaryFlag, BusinessWarning, type CardNumber, Category, ConflictError, DEFAULT_PAGINATION_PARAMS, DataHelper, DateUtils, type Deferred, DepotPoolStatus, Device, type EntityChangeEvent, ExpectationFailedError, FailedDependencyError, ForbiddenError, FreshDao, FreshEntity, FreshError, type FreshErrorOptions, FreshHyperEntity, FreshJob, FreshTranslationBase, GatewayTimeoutError, GoneError, type HealthCheckResult, HttpStatus, HttpVersionNotSupportedError, ImATeapotError, InsufficientStorageError, InternalServerError, type IsDecimalOptions, LanguageCode, LengthRequiredError, LockedError, LoopDetectedError, Manufacturer, type Maybe, MethodNotAllowedError, MisdirectedRequestError, NetworkAuthenticationRequiredError, NotAcceptableError, NotExtendedError, NotFoundError, NotImplementedError, type PaginatedList, type PaginationMeta, type PaginationParams, PayloadTooLargeError, PaymentMethod, PaymentRequiredError, PG_DATA_SOURCE_OPTIONS as PgDataSourceOptions, PreconditionFailedError, PreconditionRequiredError, Product, ProxyAuthenticationRequiredError, RangeNotSatisfiableError, RequestHeaderFieldsTooLargeError, RequestTimeoutError, ServiceUnavailableError, SinglePromiseWaiter, Singleton, type Status, StatusDto, Subcategory, TO_BINARY_FLAG, TimestampColumn, TooEarlyError, TooManyRequestsError, TransactionType, UnauthorizedError, UnavailableForLegalReasonsError, UnprocessableEntityError, UnsupportedMediaTypeError, UpgradeRequiredError, UriTooLongError, VariantAlsoNegotiatesError, buildDateRange, buildOrder, buildPagination, buildPatch, constructTypeormPagination, createDeferred, FRESH_ESLINT_CONFIG as freshEslintConfig, getPaginationMeta, getPaginationParams, hasOwn, isDecimal, isEnumValue, isFlag01, isMaybe, isNumber, isNumberInRange, isObject, isString, isValidCron, listAll, parsePaginationFromURL, resolvePathParameterId, runWithConcurrency, toDecimal };