@russ-b/nestjs-common-tools 1.14.5 → 2.0.0

package/README.md

@@ -26,10 +26,148 @@ This package uses subpath exports for most features.
 | `@russ-b/nestjs-common-tools/validators` | validation decorators and constraints |
 | `@russ-b/nestjs-common-tools/typeorm` | TypeORM filters, helpers, transformers, and types |
 | `@russ-b/nestjs-common-tools/logger` | logger builder and logger-related interfaces/types |
+| `@russ-b/nestjs-common-tools/pagination` | pagination DTOs, response builders, and errors |
 | `@russ-b/nestjs-common-tools/common/util` | generic utility helpers |
-| `@russ-b/nestjs-common-tools/common/pagination` | pagination DTOs and helpers |
+| `@russ-b/nestjs-common-tools/common/pagination` | legacy compatibility alias for `pagination` |
 | `@russ-b/nestjs-common-tools/common/filters` | shared filter exports |
 
+## Pagination
+
+Import pagination helpers from `@russ-b/nestjs-common-tools/pagination`.
+
+The pagination module includes:
+
+- request DTOs for `page` and `perPage`
+- a sortable request DTO with `sortOrder`
+- response builders for the standard and legacy response shapes
+- a transport-agnostic out-of-range error
+- Swagger schema helpers
+
+### Request DTOs
+
+`PaginatedRequestDto` gives you validated pagination query params with sensible defaults:
+
+- `page` defaults to `1`
+- `perPage` defaults to `50`
+- `perPage` is limited to `1000`
+- string query values such as `?page=2&perPage=25` are coerced to numbers
+
+```typescript
+import { Controller, Get, Query } from '@nestjs/common';
+import { PaginatedRequestDto } from '@russ-b/nestjs-common-tools/pagination';
+
+@Controller('users')
+export class UsersController {
+  @Get()
+  findAll(@Query() query: PaginatedRequestDto) {
+    return {
+      page: query.page,
+      perPage: query.perPage,
+      offset: query.offset,
+      params: query.getParams(),
+    };
+  }
+}
+```
+
+If you also want a sort direction, use `SortablePaginatedRequestDto`:
+
+```typescript
+import { SortablePaginatedRequestDto } from '@russ-b/nestjs-common-tools/pagination';
+
+export class UserListQueryDto extends SortablePaginatedRequestDto {}
+```
+
+`sortOrder` accepts `asc` or `desc`.
+
+### Building Responses
+
+Use `Pagination.createResponse(...)` for the standard contract with `total` and `pages`.
+
+```typescript
+import { Pagination, PaginatedRequestDto } from '@russ-b/nestjs-common-tools/pagination';
+
+async findAll(query: PaginatedRequestDto) {
+  const [users, total] = await this.userRepository.findAndCount({
+    skip: query.offset,
+    take: query.perPage,
+  });
+
+  return Pagination.createResponse(query, [users, total]);
+}
+```
+
+This returns:
+
+```typescript
+{
+  data: users,
+  pagination: {
+    total: 125,
+    pages: 13,
+    page: 1,
+    perPage: 10,
+  },
+}
+```
+
+If you still need the old contract with `totalItems` and `totalPages`, use `Pagination.createLegacyResponse(...)`.
+
+### Out-Of-Range Errors
+
+`Pagination.createResponse(...)` and `Pagination.createLegacyResponse(...)` throw a transport-agnostic pagination error when the requested page is out of range.
+
+```typescript
+import {
+  PAGINATION_OUT_OF_RANGE,
+  Pagination,
+  PaginationOutOfRangeError,
+} from '@russ-b/nestjs-common-tools/pagination';
+
+try {
+  return Pagination.createResponse(query, [users, total]);
+} catch (error) {
+  if (
+    error instanceof PaginationOutOfRangeError &&
+    error.code === PAGINATION_OUT_OF_RANGE
+  ) {
+    // map to the transport or framework you use
+  }
+
+  throw error;
+}
+```
+
+## Pagination And Swagger
+
+Generic DTOs such as `PaginationResponseDto<T>` are useful at runtime, but Swagger usually does not infer the concrete `T` item type automatically.
+
+For Swagger/OpenAPI responses, this package exposes explicit schema helpers from `@russ-b/nestjs-common-tools/pagination`.
+
+```typescript
+import { ApiExtraModels, ApiOkResponse, getSchemaPath } from '@nestjs/swagger';
+import {
+  createPaginatedResponseSchema,
+  PaginationResponseDto,
+} from '@russ-b/nestjs-common-tools/pagination';
+
+@ApiExtraModels(UserDto, PaginationResponseDto)
+@ApiOkResponse({
+  schema: createPaginatedResponseSchema({
+    $ref: getSchemaPath(UserDto),
+  }),
+})
+findAll() {
+  // ...
+}
+```
+
+If you still return the legacy pagination shape, use `createLegacyPaginatedResponseSchema(...)` instead.
+
+`PaginationResponseDto` is the standard response DTO with `total` and `pages`.
+`LegacyPaginatedResponseDto` preserves the old `totalItems` and `totalPages` shape.
+The older `PaginatedResponseDto` name remains only as a deprecated legacy alias.
+
 ## Class Transformer Helpers
 
 This package also exposes small reusable decorators for `class-transformer`.

package/dist/common/pagination/index.d.ts

@@ -1,5 +1 @@
-export * from './pagination';
-export * from './dto/paginated-request.dto';
-export * from './dto/paginated-response.dto';
-export * from './interfaces/pagination.interface';
-export * from './exceptions';
+export * from '../../pagination';

package/dist/common/pagination/index.js

@@ -14,9 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./pagination"), exports);
-__exportStar(require("./dto/paginated-request.dto"), exports);
-__exportStar(require("./dto/paginated-response.dto"), exports);
-__exportStar(require("./interfaces/pagination.interface"), exports);
-__exportStar(require("./exceptions"), exports);
+__exportStar(require("../../pagination"), exports);
 //# sourceMappingURL=index.js.map

package/dist/common/pagination/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/common/pagination/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,8DAA4C;AAC5C,+DAA6C;AAC7C,oEAAkD;AAClD,+CAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/common/pagination/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAGA,mDAAiC"}

package/dist/jest.setup.d.ts

@@ -0,0 +1 @@
+import 'reflect-metadata';

package/dist/jest.setup.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("reflect-metadata");
+//# sourceMappingURL=jest.setup.js.map

package/dist/jest.setup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jest.setup.js","sourceRoot":"","sources":["../src/jest.setup.ts"],"names":[],"mappings":";;AAAA,4BAA0B"}

package/dist/pagination/dto/paginated-request.dto.d.ts

@@ -0,0 +1,7 @@
+import { PaginationParams, PaginationRequest } from '../interfaces/pagination.interface';
+export declare class PaginatedRequestDto implements PaginationRequest {
+    page: number;
+    perPage: number;
+    get offset(): number;
+    getParams(): PaginationParams;
+}

package/dist/{common/pagination → pagination}/dto/paginated-request.dto.js

@@ -10,8 +10,9 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PaginatedRequestDto = void 0;
-const class_validator_1 = require("class-validator");
 const class_transformer_1 = require("class-transformer");
+const class_validator_1 = require("class-validator");
+const api_property_optional_if_available_decorator_1 = require("../swagger/api-property-optional-if-available.decorator");
 class PaginatedRequestDto {
     constructor() {
         this.page = 1;
@@ -20,7 +21,7 @@ class PaginatedRequestDto {
     get offset() {
         return (this.page - 1) * this.perPage;
     }
-    getPaginationParams() {
+    getParams() {
         return {
             perPage: this.perPage,
             offset: this.offset,
@@ -29,6 +30,13 @@ class PaginatedRequestDto {
 }
 exports.PaginatedRequestDto = PaginatedRequestDto;
 __decorate([
+    (0, api_property_optional_if_available_decorator_1.ApiPropertyOptionalIfAvailable)({
+        type: 'integer',
+        example: 1,
+        default: 1,
+        minimum: 1,
+        description: 'Page number starting from 1.',
+    }),
     (0, class_validator_1.IsOptional)(),
     (0, class_validator_1.IsNumber)(),
     (0, class_validator_1.Min)(1),
@@ -36,6 +44,14 @@ __decorate([
     __metadata("design:type", Number)
 ], PaginatedRequestDto.prototype, "page", void 0);
 __decorate([
+    (0, api_property_optional_if_available_decorator_1.ApiPropertyOptionalIfAvailable)({
+        type: 'integer',
+        example: 50,
+        default: 50,
+        minimum: 1,
+        maximum: 1000,
+        description: 'Number of items to return per page.',
+    }),
     (0, class_validator_1.IsOptional)(),
     (0, class_validator_1.IsNumber)(),
     (0, class_validator_1.Max)(1000),

package/dist/pagination/dto/paginated-request.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paginated-request.dto.js","sourceRoot":"","sources":["../../../src/pagination/dto/paginated-request.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAAyC;AACzC,qDAAiE;AAKjE,0HAAyG;AAEzG,MAAa,mBAAmB;IAAhC;QAYE,SAAI,GAAW,CAAC,CAAC;QAejB,YAAO,GAAW,EAAE,CAAC;IAYvB,CAAC;IAVC,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;IACxC,CAAC;IAED,SAAS;QACP,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC;IACJ,CAAC;CACF;AAvCD,kDAuCC;AA3BC;IAXC,IAAA,6EAA8B,EAAC;QAC9B,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,CAAC;QACV,OAAO,EAAE,CAAC;QACV,OAAO,EAAE,CAAC;QACV,WAAW,EAAE,8BAA8B;KAC5C,CAAC;IACD,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;IACV,IAAA,qBAAG,EAAC,CAAC,CAAC;IACN,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;;iDACF;AAejB;IAbC,IAAA,6EAA8B,EAAC;QAC9B,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,EAAE;QACX,OAAO,EAAE,EAAE;QACX,OAAO,EAAE,CAAC;QACV,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,qCAAqC;KACnD,CAAC;IACD,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;IACV,IAAA,qBAAG,EAAC,IAAI,CAAC;IACT,IAAA,qBAAG,EAAC,CAAC,CAAC;IACN,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;;oDACE"}

package/dist/pagination/dto/paginated-response.dto.d.ts

@@ -0,0 +1,24 @@
+import { LegacyPaginatedResponse, LegacyPaginationMeta, PaginatedResponse, PaginationMeta } from '../interfaces/pagination.interface';
+declare class PaginationMetaDto implements PaginationMeta {
+    total: number;
+    pages: number;
+    page: number;
+    perPage: number;
+}
+declare class LegacyPaginationMetaDto implements LegacyPaginationMeta {
+    totalItems: number;
+    totalPages: number;
+    page: number;
+    perPage: number;
+}
+export declare class PaginationResponseDto<T> implements PaginatedResponse<T> {
+    pagination: PaginationMetaDto;
+    data: T[];
+}
+export declare class LegacyPaginatedResponseDto<T> implements LegacyPaginatedResponse<T> {
+    pagination: LegacyPaginationMetaDto;
+    data: T[];
+}
+export declare class PaginatedResponseDto<T> extends LegacyPaginatedResponseDto<T> {
+}
+export {};

package/dist/pagination/dto/paginated-response.dto.js

@@ -0,0 +1,89 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaginatedResponseDto = exports.LegacyPaginatedResponseDto = exports.PaginationResponseDto = void 0;
+const class_transformer_1 = require("class-transformer");
+let PaginationMetaDto = class PaginationMetaDto {
+};
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], PaginationMetaDto.prototype, "total", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], PaginationMetaDto.prototype, "pages", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], PaginationMetaDto.prototype, "page", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], PaginationMetaDto.prototype, "perPage", void 0);
+PaginationMetaDto = __decorate([
+    (0, class_transformer_1.Exclude)()
+], PaginationMetaDto);
+let LegacyPaginationMetaDto = class LegacyPaginationMetaDto {
+};
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], LegacyPaginationMetaDto.prototype, "totalItems", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], LegacyPaginationMetaDto.prototype, "totalPages", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], LegacyPaginationMetaDto.prototype, "page", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Number)
+], LegacyPaginationMetaDto.prototype, "perPage", void 0);
+LegacyPaginationMetaDto = __decorate([
+    (0, class_transformer_1.Exclude)()
+], LegacyPaginationMetaDto);
+let PaginationResponseDto = class PaginationResponseDto {
+};
+exports.PaginationResponseDto = PaginationResponseDto;
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_transformer_1.Type)(() => PaginationMetaDto),
+    __metadata("design:type", PaginationMetaDto)
+], PaginationResponseDto.prototype, "pagination", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Array)
+], PaginationResponseDto.prototype, "data", void 0);
+exports.PaginationResponseDto = PaginationResponseDto = __decorate([
+    (0, class_transformer_1.Exclude)()
+], PaginationResponseDto);
+let LegacyPaginatedResponseDto = class LegacyPaginatedResponseDto {
+};
+exports.LegacyPaginatedResponseDto = LegacyPaginatedResponseDto;
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_transformer_1.Type)(() => LegacyPaginationMetaDto),
+    __metadata("design:type", LegacyPaginationMetaDto)
+], LegacyPaginatedResponseDto.prototype, "pagination", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    __metadata("design:type", Array)
+], LegacyPaginatedResponseDto.prototype, "data", void 0);
+exports.LegacyPaginatedResponseDto = LegacyPaginatedResponseDto = __decorate([
+    (0, class_transformer_1.Exclude)()
+], LegacyPaginatedResponseDto);
+class PaginatedResponseDto extends LegacyPaginatedResponseDto {
+}
+exports.PaginatedResponseDto = PaginatedResponseDto;
+//# sourceMappingURL=paginated-response.dto.js.map

package/dist/pagination/dto/paginated-response.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paginated-response.dto.js","sourceRoot":"","sources":["../../../src/pagination/dto/paginated-response.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAA0D;AAS1D,IAAM,iBAAiB,GAAvB,MAAM,iBAAiB;CAYtB,CAAA;AAVC;IADC,IAAA,0BAAM,GAAE;;gDACK;AAGd;IADC,IAAA,0BAAM,GAAE;;gDACK;AAGd;IADC,IAAA,0BAAM,GAAE;;+CACI;AAGb;IADC,IAAA,0BAAM,GAAE;;kDACO;AAXZ,iBAAiB;IADtB,IAAA,2BAAO,GAAE;GACJ,iBAAiB,CAYtB;AAGD,IAAM,uBAAuB,GAA7B,MAAM,uBAAuB;CAY5B,CAAA;AAVC;IADC,IAAA,0BAAM,GAAE;;2DACU;AAGnB;IADC,IAAA,0BAAM,GAAE;;2DACU;AAGnB;IADC,IAAA,0BAAM,GAAE;;qDACI;AAGb;IADC,IAAA,0BAAM,GAAE;;wDACO;AAXZ,uBAAuB;IAD5B,IAAA,2BAAO,GAAE;GACJ,uBAAuB,CAY5B;AAGM,IAAM,qBAAqB,GAA3B,MAAM,qBAAqB;CAOjC,CAAA;AAPY,sDAAqB;AAGhC;IAFC,IAAA,0BAAM,GAAE;IACR,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,iBAAiB,CAAC;8BAClB,iBAAiB;yDAAC;AAG9B;IADC,IAAA,0BAAM,GAAE;;mDACC;gCANC,qBAAqB;IADjC,IAAA,2BAAO,GAAE;GACG,qBAAqB,CAOjC;AAGM,IAAM,0BAA0B,GAAhC,MAAM,0BAA0B;CAStC,CAAA;AATY,gEAA0B;AAKrC;IAFC,IAAA,0BAAM,GAAE;IACR,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,uBAAuB,CAAC;8BACxB,uBAAuB;8DAAC;AAGpC;IADC,IAAA,0BAAM,GAAE;;wDACC;qCARC,0BAA0B;IADtC,IAAA,2BAAO,GAAE;GACG,0BAA0B,CAStC;AAQD,MAAa,oBAAwB,SAAQ,0BAA6B;CAAG;AAA7E,oDAA6E"}

package/dist/pagination/dto/sortable-paginated-request.dto.d.ts

@@ -0,0 +1,8 @@
+import { PaginatedRequestDto } from './paginated-request.dto';
+export declare enum SortOrder {
+    ASC = "asc",
+    DESC = "desc"
+}
+export declare class SortablePaginatedRequestDto extends PaginatedRequestDto {
+    sortOrder?: SortOrder;
+}

package/dist/pagination/dto/sortable-paginated-request.dto.js

@@ -0,0 +1,34 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SortablePaginatedRequestDto = exports.SortOrder = void 0;
+const class_validator_1 = require("class-validator");
+const paginated_request_dto_1 = require("./paginated-request.dto");
+const api_property_optional_if_available_decorator_1 = require("../swagger/api-property-optional-if-available.decorator");
+var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "asc";
+    SortOrder["DESC"] = "desc";
+})(SortOrder || (exports.SortOrder = SortOrder = {}));
+class SortablePaginatedRequestDto extends paginated_request_dto_1.PaginatedRequestDto {
+}
+exports.SortablePaginatedRequestDto = SortablePaginatedRequestDto;
+__decorate([
+    (0, api_property_optional_if_available_decorator_1.ApiPropertyOptionalIfAvailable)({
+        enum: SortOrder,
+        example: SortOrder.ASC,
+        description: 'Sort direction for the requested collection.',
+    }),
+    (0, class_validator_1.IsEnum)(SortOrder),
+    (0, class_validator_1.IsOptional)(),
+    __metadata("design:type", String)
+], SortablePaginatedRequestDto.prototype, "sortOrder", void 0);
+//# sourceMappingURL=sortable-paginated-request.dto.js.map

package/dist/pagination/dto/sortable-paginated-request.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sortable-paginated-request.dto.js","sourceRoot":"","sources":["../../../src/pagination/dto/sortable-paginated-request.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAAqD;AACrD,mEAA8D;AAC9D,0HAAyG;AAEzG,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAED,MAAa,2BAA4B,SAAQ,2CAAmB;CASnE;AATD,kEASC;AADC;IAPC,IAAA,6EAA8B,EAAC;QAC9B,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,SAAS,CAAC,GAAG;QACtB,WAAW,EAAE,8CAA8C;KAC5D,CAAC;IACD,IAAA,wBAAM,EAAC,SAAS,CAAC;IACjB,IAAA,4BAAU,GAAE;;8DACS"}

package/dist/pagination/exceptions/index.d.ts

@@ -0,0 +1 @@
+export * from './pagination-out-of-range.error';

package/dist/pagination/exceptions/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./pagination-out-of-range.error"), exports);
+//# sourceMappingURL=index.js.map

package/dist/pagination/exceptions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/pagination/exceptions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kEAAgD"}

package/dist/pagination/exceptions/pagination-out-of-range.error.d.ts

@@ -0,0 +1,8 @@
+export declare const PAGINATION_OUT_OF_RANGE = "PAGINATION_OUT_OF_RANGE";
+export declare class PaginationOutOfRangeError extends Error {
+    readonly code = "PAGINATION_OUT_OF_RANGE";
+    constructor(message?: string);
+}
+export declare class OutOfRangeException extends PaginationOutOfRangeError {
+    constructor(message?: string);
+}

package/dist/pagination/exceptions/pagination-out-of-range.error.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OutOfRangeException = exports.PaginationOutOfRangeError = exports.PAGINATION_OUT_OF_RANGE = void 0;
+const DEFAULT_MESSAGE = 'Page is out of range';
+exports.PAGINATION_OUT_OF_RANGE = 'PAGINATION_OUT_OF_RANGE';
+class PaginationOutOfRangeError extends Error {
+    constructor(message = DEFAULT_MESSAGE) {
+        super(message);
+        this.code = exports.PAGINATION_OUT_OF_RANGE;
+        this.name = 'PaginationOutOfRangeError';
+        Object.setPrototypeOf(this, new.target.prototype);
+    }
+}
+exports.PaginationOutOfRangeError = PaginationOutOfRangeError;
+class OutOfRangeException extends PaginationOutOfRangeError {
+    constructor(message = DEFAULT_MESSAGE) {
+        super(message);
+        this.name = 'OutOfRangeException';
+    }
+}
+exports.OutOfRangeException = OutOfRangeException;
+//# sourceMappingURL=pagination-out-of-range.error.js.map

package/dist/pagination/exceptions/pagination-out-of-range.error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination-out-of-range.error.js","sourceRoot":"","sources":["../../../src/pagination/exceptions/pagination-out-of-range.error.ts"],"names":[],"mappings":";;;AAAA,MAAM,eAAe,GAAG,sBAAsB,CAAC;AAElC,QAAA,uBAAuB,GAAG,yBAAyB,CAAC;AAEjE,MAAa,yBAA0B,SAAQ,KAAK;IAGlD,YAAY,UAAkB,eAAe;QAC3C,KAAK,CAAC,OAAO,CAAC,CAAC;QAHR,SAAI,GAAG,+BAAuB,CAAC;QAItC,IAAI,CAAC,IAAI,GAAG,2BAA2B,CAAC;QACxC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACpD,CAAC;CACF;AARD,8DAQC;AAED,MAAa,mBAAoB,SAAQ,yBAAyB;IAChE,YAAY,UAAkB,eAAe;QAC3C,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;IACpC,CAAC;CACF;AALD,kDAKC"}

package/dist/pagination/index.d.ts

@@ -0,0 +1,7 @@
+export * from './pagination';
+export * from './dto/paginated-request.dto';
+export * from './dto/paginated-response.dto';
+export * from './dto/sortable-paginated-request.dto';
+export * from './interfaces/pagination.interface';
+export * from './exceptions';
+export * from './swagger';

package/dist/pagination/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./pagination"), exports);
+__exportStar(require("./dto/paginated-request.dto"), exports);
+__exportStar(require("./dto/paginated-response.dto"), exports);
+__exportStar(require("./dto/sortable-paginated-request.dto"), exports);
+__exportStar(require("./interfaces/pagination.interface"), exports);
+__exportStar(require("./exceptions"), exports);
+__exportStar(require("./swagger"), exports);
+//# sourceMappingURL=index.js.map

package/dist/pagination/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/pagination/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,8DAA4C;AAC5C,+DAA6C;AAC7C,uEAAqD;AACrD,oEAAkD;AAClD,+CAA6B;AAC7B,4CAA0B"}

package/dist/{common/pagination → pagination}/interfaces/pagination.interface.d.ts

@@ -1,29 +1,29 @@
-export interface IPaginationRequestParams {
+export interface PaginationRequest {
     page: number;
     perPage: number;
 }
-export interface IPaginationParams {
+export interface PaginationParams {
     perPage: number;
     offset: number;
 }
-export interface IPaginatedResponse<T> {
-    data: T[];
-    pagination: IPaginationData;
-}
-export interface PaginatedResponse<T> {
-    data: T[];
-    pagination: PaginationMeta;
-}
 export interface PaginationMeta {
     total: number;
     pages: number;
     page: number;
     perPage: number;
 }
-export interface IPaginationData {
+export interface LegacyPaginationMeta {
     totalItems: number;
     totalPages: number;
     page: number;
     perPage: number;
 }
+export interface PaginatedResponse<T> {
+    data: T[];
+    pagination: PaginationMeta;
+}
+export interface LegacyPaginatedResponse<T> {
+    data: T[];
+    pagination: LegacyPaginationMeta;
+}
 export type CountableResponse<T> = [T[], number];

package/dist/pagination/interfaces/pagination.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.interface.js","sourceRoot":"","sources":["../../../src/pagination/interfaces/pagination.interface.ts"],"names":[],"mappings":""}

package/dist/pagination/pagination.d.ts

@@ -0,0 +1,11 @@
+import { CountableResponse, LegacyPaginatedResponse, PaginatedResponse, PaginationParams, PaginationRequest } from './interfaces/pagination.interface';
+export declare abstract class Pagination {
+    static params(page: number, perPage: number): PaginationParams;
+    static paginationParams(page: number, perPage: number): PaginationParams;
+    static offset(page: number, perPage: number): number;
+    static createResponse<T>({ page, perPage }: PaginationRequest, [data, total]: CountableResponse<T>): PaginatedResponse<T>;
+    static createLegacyResponse<T>({ page, perPage }: PaginationRequest, [data, total]: CountableResponse<T>): LegacyPaginatedResponse<T>;
+    static response<T>(pagination: PaginationRequest, result: CountableResponse<T>): LegacyPaginatedResponse<T>;
+    private static createMeta;
+    private static createLegacyMeta;
+}

package/dist/pagination/pagination.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Pagination = void 0;
+const common_1 = require("@nestjs/common");
+const exceptions_1 = require("./exceptions");
+class Pagination {
+    static params(page, perPage) {
+        return { perPage, offset: Pagination.offset(page, perPage) };
+    }
+    static paginationParams(page, perPage) {
+        return Pagination.params(page, perPage);
+    }
+    static offset(page, perPage) {
+        return (page - 1) * perPage;
+    }
+    static createResponse({ page, perPage }, [data, total]) {
+        return {
+            data,
+            pagination: Pagination.createMeta(page, perPage, total),
+        };
+    }
+    static createLegacyResponse({ page, perPage }, [data, total]) {
+        return {
+            data,
+            pagination: Pagination.createLegacyMeta(Pagination.createMeta(page, perPage, total)),
+        };
+    }
+    static response(pagination, result) {
+        try {
+            return Pagination.createLegacyResponse(pagination, result);
+        }
+        catch (error) {
+            if (error instanceof exceptions_1.PaginationOutOfRangeError) {
+                throw new common_1.BadRequestException(error.message);
+            }
+            throw error;
+        }
+    }
+    static createMeta(page, perPage, total) {
+        const pages = Math.ceil(total / perPage);
+        if (page > pages && pages > 0) {
+            throw new exceptions_1.OutOfRangeException();
+        }
+        return {
+            total,
+            pages,
+            perPage,
+            page,
+        };
+    }
+    static createLegacyMeta({ total, pages, page, perPage, }) {
+        return {
+            totalItems: total,
+            totalPages: pages,
+            perPage,
+            page,
+        };
+    }
+}
+exports.Pagination = Pagination;
+//# sourceMappingURL=pagination.js.map

package/dist/pagination/pagination.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.js","sourceRoot":"","sources":["../../src/pagination/pagination.ts"],"names":[],"mappings":";;;AAAA,2CAAqD;AAUrD,6CAA8E;AAE9E,MAAsB,UAAU;IAC9B,MAAM,CAAC,MAAM,CAAC,IAAY,EAAE,OAAe;QACzC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;IAC/D,CAAC;IAKD,MAAM,CAAC,gBAAgB,CAAC,IAAY,EAAE,OAAe;QACnD,OAAO,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAY,EAAE,OAAe;QACzC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC;IAC9B,CAAC;IAED,MAAM,CAAC,cAAc,CACnB,EAAE,IAAI,EAAE,OAAO,EAAqB,EACpC,CAAC,IAAI,EAAE,KAAK,CAAuB;QAEnC,OAAO;YACL,IAAI;YACJ,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC;SACxD,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,oBAAoB,CACzB,EAAE,IAAI,EAAE,OAAO,EAAqB,EACpC,CAAC,IAAI,EAAE,KAAK,CAAuB;QAEnC,OAAO;YACL,IAAI;YACJ,UAAU,EAAE,UAAU,CAAC,gBAAgB,CACrC,UAAU,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,CAC5C;SACF,CAAC;IACJ,CAAC;IAKD,MAAM,CAAC,QAAQ,CACb,UAA6B,EAC7B,MAA4B;QAE5B,IAAI,CAAC;YACH,OAAO,UAAU,CAAC,oBAAoB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QAC7D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,sCAAyB,EAAE,CAAC;gBAC/C,MAAM,IAAI,4BAAmB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC/C,CAAC;YAED,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,UAAU,CACvB,IAAY,EACZ,OAAe,EACf,KAAa;QAEb,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,CAAC;QAEzC,IAAI,IAAI,GAAG,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,gCAAmB,EAAE,CAAC;QAClC,CAAC;QAED,OAAO;YACL,KAAK;YACL,KAAK;YACL,OAAO;YACP,IAAI;SACL,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,EAC9B,KAAK,EACL,KAAK,EACL,IAAI,EACJ,OAAO,GACQ;QACf,OAAO;YACL,UAAU,EAAE,KAAK;YACjB,UAAU,EAAE,KAAK;YACjB,OAAO;YACP,IAAI;SACL,CAAC;IACJ,CAAC;CACF;AAxFD,gCAwFC"}

package/dist/pagination/swagger/api-property-optional-if-available.decorator.d.ts

@@ -0,0 +1,12 @@
+interface SwaggerApiPropertyOptions {
+    default?: unknown;
+    description?: string;
+    enum?: object;
+    example?: unknown;
+    format?: string;
+    maximum?: number;
+    minimum?: number;
+    type?: 'array' | 'boolean' | 'integer' | 'number' | 'object' | 'string';
+}
+export declare function ApiPropertyOptionalIfAvailable(options?: SwaggerApiPropertyOptions): PropertyDecorator;
+export {};

package/dist/pagination/swagger/api-property-optional-if-available.decorator.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiPropertyOptionalIfAvailable = ApiPropertyOptionalIfAvailable;
+function loadApiPropertyOptionalDecorator() {
+    try {
+        const swaggerModule = require('@nestjs/swagger');
+        return swaggerModule.ApiPropertyOptional;
+    }
+    catch {
+        return undefined;
+    }
+}
+function ApiPropertyOptionalIfAvailable(options) {
+    const apiPropertyOptional = loadApiPropertyOptionalDecorator();
+    if (!apiPropertyOptional) {
+        return () => undefined;
+    }
+    return apiPropertyOptional(options);
+}
+//# sourceMappingURL=api-property-optional-if-available.decorator.js.map

package/dist/pagination/swagger/api-property-optional-if-available.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-property-optional-if-available.decorator.js","sourceRoot":"","sources":["../../../src/pagination/swagger/api-property-optional-if-available.decorator.ts"],"names":[],"mappings":";;AA6BA,wEAUC;AAxBD,SAAS,gCAAgC;IAGvC,IAAI,CAAC;QACH,MAAM,aAAa,GAAG,OAAO,CAAC,iBAAiB,CAE9C,CAAC;QAEF,OAAO,aAAa,CAAC,mBAAmB,CAAC;IAC3C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAgB,8BAA8B,CAC5C,OAAmC;IAEnC,MAAM,mBAAmB,GAAG,gCAAgC,EAAE,CAAC;IAE/D,IAAI,CAAC,mBAAmB,EAAE,CAAC;QACzB,OAAO,GAAG,EAAE,CAAC,SAAS,CAAC;IACzB,CAAC;IAED,OAAO,mBAAmB,CAAC,OAAO,CAAC,CAAC;AACtC,CAAC"}

package/dist/pagination/swagger/index.d.ts

@@ -0,0 +1 @@
+export * from './paginated-response.schema';

package/dist/pagination/swagger/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./paginated-response.schema"), exports);
+//# sourceMappingURL=index.js.map

package/dist/pagination/swagger/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/pagination/swagger/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8DAA4C"}

package/dist/pagination/swagger/paginated-response.schema.d.ts

@@ -0,0 +1,14 @@
+export interface OpenApiSchema {
+    $ref?: string;
+    allOf?: OpenApiSchema[];
+    description?: string;
+    example?: unknown;
+    format?: string;
+    items?: OpenApiSchema;
+    nullable?: boolean;
+    properties?: Record<string, OpenApiSchema>;
+    required?: string[];
+    type?: 'array' | 'boolean' | 'integer' | 'number' | 'object' | 'string';
+}
+export declare function createPaginatedResponseSchema(itemSchema: OpenApiSchema): OpenApiSchema;
+export declare function createLegacyPaginatedResponseSchema(itemSchema: OpenApiSchema): OpenApiSchema;

package/dist/pagination/swagger/paginated-response.schema.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPaginatedResponseSchema = createPaginatedResponseSchema;
+exports.createLegacyPaginatedResponseSchema = createLegacyPaginatedResponseSchema;
+function createPaginationMetaSchema() {
+    return {
+        type: 'object',
+        required: ['total', 'pages', 'page', 'perPage'],
+        properties: {
+            total: {
+                type: 'integer',
+                example: 125,
+            },
+            pages: {
+                type: 'integer',
+                example: 13,
+            },
+            page: {
+                type: 'integer',
+                example: 1,
+            },
+            perPage: {
+                type: 'integer',
+                example: 10,
+            },
+        },
+    };
+}
+function createLegacyPaginationMetaSchema() {
+    return {
+        type: 'object',
+        required: ['totalItems', 'totalPages', 'page', 'perPage'],
+        properties: {
+            totalItems: {
+                type: 'integer',
+                example: 125,
+            },
+            totalPages: {
+                type: 'integer',
+                example: 13,
+            },
+            page: {
+                type: 'integer',
+                example: 1,
+            },
+            perPage: {
+                type: 'integer',
+                example: 10,
+            },
+        },
+    };
+}
+function createPaginatedResponseSchema(itemSchema) {
+    return {
+        type: 'object',
+        required: ['data', 'pagination'],
+        properties: {
+            data: {
+                type: 'array',
+                items: itemSchema,
+            },
+            pagination: createPaginationMetaSchema(),
+        },
+    };
+}
+function createLegacyPaginatedResponseSchema(itemSchema) {
+    return {
+        type: 'object',
+        required: ['data', 'pagination'],
+        properties: {
+            data: {
+                type: 'array',
+                items: itemSchema,
+            },
+            pagination: createLegacyPaginationMetaSchema(),
+        },
+    };
+}
+//# sourceMappingURL=paginated-response.schema.js.map

package/dist/pagination/swagger/paginated-response.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paginated-response.schema.js","sourceRoot":"","sources":["../../../src/pagination/swagger/paginated-response.schema.ts"],"names":[],"mappings":";;AA+DA,sEAcC;AAED,kFAcC;AAhFD,SAAS,0BAA0B;IACjC,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC;QAC/C,UAAU,EAAE;YACV,KAAK,EAAE;gBACL,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,GAAG;aACb;YACD,KAAK,EAAE;gBACL,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,EAAE;aACZ;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,CAAC;aACX;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,EAAE;aACZ;SACF;KACF,CAAC;AACJ,CAAC;AAED,SAAS,gCAAgC;IACvC,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,CAAC,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,SAAS,CAAC;QACzD,UAAU,EAAE;YACV,UAAU,EAAE;gBACV,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,GAAG;aACb;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,EAAE;aACZ;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,CAAC;aACX;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,EAAE;aACZ;SACF;KACF,CAAC;AACJ,CAAC;AAED,SAAgB,6BAA6B,CAC3C,UAAyB;IAEzB,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC;QAChC,UAAU,EAAE;YACV,IAAI,EAAE;gBACJ,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,UAAU;aAClB;YACD,UAAU,EAAE,0BAA0B,EAAE;SACzC;KACF,CAAC;AACJ,CAAC;AAED,SAAgB,mCAAmC,CACjD,UAAyB;IAEzB,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC;QAChC,UAAU,EAAE;YACV,IAAI,EAAE;gBACJ,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,UAAU;aAClB;YACD,UAAU,EAAE,gCAAgC,EAAE;SAC/C;KACF,CAAC;AACJ,CAAC"}

package/dist/typeorm/enums/index.d.ts

@@ -0,0 +1 @@
+export * from './sort-order.enum';

package/dist/{common/pagination/exceptions → typeorm/enums}/index.js

@@ -14,5 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./out-of-range.exception"), exports);
+__exportStar(require("./sort-order.enum"), exports);
 //# sourceMappingURL=index.js.map

package/dist/typeorm/enums/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/typeorm/enums/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC"}

package/dist/typeorm/enums/sort-order.enum.d.ts

@@ -0,0 +1,4 @@
+export declare enum SortOrder {
+    ASC = "asc",
+    DESC = "desc"
+}

package/dist/typeorm/enums/sort-order.enum.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SortOrder = void 0;
+var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "asc";
+    SortOrder["DESC"] = "desc";
+})(SortOrder || (exports.SortOrder = SortOrder = {}));
+//# sourceMappingURL=sort-order.enum.js.map

package/dist/typeorm/enums/sort-order.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort-order.enum.js","sourceRoot":"","sources":["../../../src/typeorm/enums/sort-order.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB"}

package/dist/typeorm/index.d.ts

@@ -2,3 +2,4 @@ export * from './filters';
 export * from './errors';
 export * from './transformers';
 export * from './types';
+export * from './utils';

package/dist/typeorm/index.js

@@ -18,4 +18,5 @@ __exportStar(require("./filters"), exports);
 __exportStar(require("./errors"), exports);
 __exportStar(require("./transformers"), exports);
 __exportStar(require("./types"), exports);
+__exportStar(require("./utils"), exports);
 //# sourceMappingURL=index.js.map

package/dist/typeorm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/typeorm/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,2CAAyB;AACzB,iDAA+B;AAC/B,0CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/typeorm/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,2CAAyB;AACzB,iDAA+B;AAC/B,0CAAwB;AACxB,0CAAwB"}

package/dist/typeorm/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './query-sort.util';

package/dist/typeorm/utils/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./query-sort.util"), exports);
+//# sourceMappingURL=index.js.map

package/dist/typeorm/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/typeorm/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC"}

package/dist/typeorm/utils/query-sort.util.d.ts

@@ -0,0 +1,19 @@
+import { ObjectLiteral, SelectQueryBuilder } from 'typeorm';
+import { SortOrder } from '../enums';
+export type QueryOrderNulls = 'NULLS FIRST' | 'NULLS LAST';
+export interface QuerySortConfig {
+    column: string;
+    nulls?: QueryOrderNulls;
+    selectExpression?: string;
+}
+export interface QueryOrderByConfig extends QuerySortConfig {
+    order: 'ASC' | 'DESC';
+}
+export type QuerySortMap<TSort extends string> = Record<TSort, QuerySortConfig>;
+export declare function applyQuerySorting<TEntity extends ObjectLiteral, TSort extends string>(qb: SelectQueryBuilder<TEntity>, params: {
+    sortBy?: TSort;
+    sortOrder?: SortOrder;
+    sortMap: QuerySortMap<TSort>;
+    defaultSort: QuerySortConfig;
+    tieBreakers?: QueryOrderByConfig[];
+}): void;

package/dist/typeorm/utils/query-sort.util.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyQuerySorting = applyQuerySorting;
+const enums_1 = require("../enums");
+function applyQuerySorting(qb, params) {
+    const primarySort = params.sortBy
+        ? (params.sortMap[params.sortBy] ?? params.defaultSort)
+        : params.defaultSort;
+    const resolvedSortOrder = params.sortOrder === enums_1.SortOrder.ASC ? 'ASC' : 'DESC';
+    const orderedColumns = new Set([primarySort.column]);
+    if (primarySort.selectExpression) {
+        qb.addSelect(primarySort.selectExpression, primarySort.column);
+    }
+    qb.orderBy(primarySort.column, resolvedSortOrder, primarySort.nulls);
+    for (const tieBreaker of params.tieBreakers ?? []) {
+        if (orderedColumns.has(tieBreaker.column)) {
+            continue;
+        }
+        qb.addOrderBy(tieBreaker.column, tieBreaker.order, tieBreaker.nulls);
+        orderedColumns.add(tieBreaker.column);
+    }
+}
+//# sourceMappingURL=query-sort.util.js.map

package/dist/typeorm/utils/query-sort.util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-sort.util.js","sourceRoot":"","sources":["../../../src/typeorm/utils/query-sort.util.ts"],"names":[],"mappings":";;AAiBA,8CAiCC;AAjDD,oCAAqC;AAgBrC,SAAgB,iBAAiB,CAI/B,EAA+B,EAC/B,MAMC;IAED,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM;QAC/B,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,WAAW,CAAC;QACvD,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC;IACvB,MAAM,iBAAiB,GAAG,MAAM,CAAC,SAAS,KAAK,iBAAS,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;IAC9E,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;IAErD,IAAI,WAAW,CAAC,gBAAgB,EAAE,CAAC;QACjC,EAAE,CAAC,SAAS,CAAC,WAAW,CAAC,gBAAgB,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IACjE,CAAC;IAED,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,EAAE,iBAAiB,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;IAErE,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,WAAW,IAAI,EAAE,EAAE,CAAC;QAClD,IAAI,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1C,SAAS;QACX,CAAC;QAED,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;QACrE,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@russ-b/nestjs-common-tools",
-  "version": "1.14.5",
+  "version": "2.0.0",
   "description": "NestJS utility tools",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -35,6 +35,10 @@
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
+    "./pagination": {
+      "types": "./dist/pagination/index.d.ts",
+      "default": "./dist/pagination/index.js"
+    },
     "./common/util": {
       "types": "./dist/common/util/index.d.ts",
       "default": "./dist/common/util/index.js"
@@ -71,6 +75,9 @@
   },
   "typesVersions": {
     "*": {
+      "pagination": [
+        "dist/pagination/index.d.ts"
+      ],
       "validators": [
         "dist/validators/index.d.ts"
       ],
@@ -137,6 +144,9 @@
       "ts"
     ],
     "rootDir": "src",
+    "setupFiles": [
+      "<rootDir>/jest.setup.ts"
+    ],
     "testRegex": ".*\\.spec\\.ts$",
     "transform": {
       "^.+\\.(t|j)s$": "ts-jest"

package/dist/common/pagination/dto/paginated-request.dto.d.ts

@@ -1,7 +0,0 @@
-import { IPaginationParams, IPaginationRequestParams } from '../interfaces/pagination.interface';
-export declare class PaginatedRequestDto implements IPaginationRequestParams {
-    page: number;
-    perPage: number;
-    get offset(): number;
-    getPaginationParams(): IPaginationParams;
-}

package/dist/common/pagination/dto/paginated-request.dto.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"paginated-request.dto.js","sourceRoot":"","sources":["../../../../src/common/pagination/dto/paginated-request.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAAiE;AACjE,yDAAyC;AAMzC,MAAa,mBAAmB;IAAhC;QAKE,SAAI,GAAW,CAAC,CAAC;QAOjB,YAAO,GAAW,EAAE,CAAC;IAYvB,CAAC;IAVC,IAAI,MAAM;QACR,OAAO,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;IACxC,CAAC;IAED,mBAAmB;QACjB,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB,CAAC;IACJ,CAAC;CACF;AAxBD,kDAwBC;AAnBC;IAJC,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;IACV,IAAA,qBAAG,EAAC,CAAC,CAAC;IACN,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;;iDACF;AAOjB;IALC,IAAA,4BAAU,GAAE;IACZ,IAAA,0BAAQ,GAAE;IACV,IAAA,qBAAG,EAAC,IAAI,CAAC;IACT,IAAA,qBAAG,EAAC,CAAC,CAAC;IACN,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,MAAM,CAAC;;oDACE"}

package/dist/common/pagination/dto/paginated-response.dto.d.ts

@@ -1,12 +0,0 @@
-import { IPaginatedResponse, IPaginationData } from '../interfaces/pagination.interface';
-declare class PaginationDataDto implements IPaginationData {
-    totalItems: number;
-    totalPages: number;
-    page: number;
-    perPage: number;
-}
-export declare class PaginatedResponseDto<T> implements IPaginatedResponse<T> {
-    pagination: PaginationDataDto;
-    data: T[];
-}
-export {};

package/dist/common/pagination/dto/paginated-response.dto.js

@@ -1,50 +0,0 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PaginatedResponseDto = void 0;
-const class_transformer_1 = require("class-transformer");
-let PaginationDataDto = class PaginationDataDto {
-};
-__decorate([
-    (0, class_transformer_1.Expose)(),
-    __metadata("design:type", Number)
-], PaginationDataDto.prototype, "totalItems", void 0);
-__decorate([
-    (0, class_transformer_1.Expose)(),
-    __metadata("design:type", Number)
-], PaginationDataDto.prototype, "totalPages", void 0);
-__decorate([
-    (0, class_transformer_1.Expose)(),
-    __metadata("design:type", Number)
-], PaginationDataDto.prototype, "page", void 0);
-__decorate([
-    (0, class_transformer_1.Expose)(),
-    __metadata("design:type", Number)
-], PaginationDataDto.prototype, "perPage", void 0);
-PaginationDataDto = __decorate([
-    (0, class_transformer_1.Exclude)()
-], PaginationDataDto);
-let PaginatedResponseDto = class PaginatedResponseDto {
-};
-exports.PaginatedResponseDto = PaginatedResponseDto;
-__decorate([
-    (0, class_transformer_1.Expose)(),
-    (0, class_transformer_1.Type)(() => PaginationDataDto),
-    __metadata("design:type", PaginationDataDto)
-], PaginatedResponseDto.prototype, "pagination", void 0);
-__decorate([
-    (0, class_transformer_1.Expose)(),
-    __metadata("design:type", Array)
-], PaginatedResponseDto.prototype, "data", void 0);
-exports.PaginatedResponseDto = PaginatedResponseDto = __decorate([
-    (0, class_transformer_1.Exclude)()
-], PaginatedResponseDto);
-//# sourceMappingURL=paginated-response.dto.js.map

package/dist/common/pagination/dto/paginated-response.dto.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"paginated-response.dto.js","sourceRoot":"","sources":["../../../../src/common/pagination/dto/paginated-response.dto.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAA0D;AAO1D,IAAM,iBAAiB,GAAvB,MAAM,iBAAiB;CAYtB,CAAA;AAVC;IADC,IAAA,0BAAM,GAAE;;qDACU;AAGnB;IADC,IAAA,0BAAM,GAAE;;qDACU;AAGnB;IADC,IAAA,0BAAM,GAAE;;+CACI;AAGb;IADC,IAAA,0BAAM,GAAE;;kDACO;AAXZ,iBAAiB;IADtB,IAAA,2BAAO,GAAE;GACJ,iBAAiB,CAYtB;AAGM,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;CAOhC,CAAA;AAPY,oDAAoB;AAG/B;IAFC,IAAA,0BAAM,GAAE;IACR,IAAA,wBAAI,EAAC,GAAG,EAAE,CAAC,iBAAiB,CAAC;8BAClB,iBAAiB;wDAAC;AAG9B;IADC,IAAA,0BAAM,GAAE;;kDACC;+BANC,oBAAoB;IADhC,IAAA,2BAAO,GAAE;GACG,oBAAoB,CAOhC"}

package/dist/common/pagination/exceptions/index.d.ts

@@ -1 +0,0 @@
-export * from './out-of-range.exception';

package/dist/common/pagination/exceptions/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/common/pagination/exceptions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2DAAyC"}

package/dist/common/pagination/exceptions/out-of-range.exception.d.ts

@@ -1,3 +0,0 @@
-export declare class OutOfRangeException extends Error {
-    message: string;
-}

package/dist/common/pagination/exceptions/out-of-range.exception.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OutOfRangeException = void 0;
-class OutOfRangeException extends Error {
-    constructor() {
-        super(...arguments);
-        this.message = 'Page is out of range';
-    }
-}
-exports.OutOfRangeException = OutOfRangeException;
-//# sourceMappingURL=out-of-range.exception.js.map

package/dist/common/pagination/exceptions/out-of-range.exception.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"out-of-range.exception.js","sourceRoot":"","sources":["../../../../src/common/pagination/exceptions/out-of-range.exception.ts"],"names":[],"mappings":";;;AAAA,MAAa,mBAAoB,SAAQ,KAAK;IAA9C;;QACE,YAAO,GAAG,sBAAsB,CAAC;IACnC,CAAC;CAAA;AAFD,kDAEC"}

package/dist/common/pagination/interfaces/pagination.interface.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"pagination.interface.js","sourceRoot":"","sources":["../../../../src/common/pagination/interfaces/pagination.interface.ts"],"names":[],"mappings":""}

package/dist/common/pagination/pagination.d.ts

@@ -1,7 +0,0 @@
-import { CountableResponse, IPaginatedResponse, IPaginationParams, IPaginationRequestParams, PaginatedResponse } from './interfaces/pagination.interface';
-export declare abstract class Pagination {
-    static paginationParams(page: number, perPage: number): IPaginationParams;
-    static offset(page: number, perPage: number): number;
-    static createResponse<T>({ page, perPage }: IPaginationRequestParams, [data, total]: CountableResponse<T>): PaginatedResponse<T>;
-    static response<T>({ page, perPage }: IPaginationRequestParams, [data, total]: CountableResponse<T>): IPaginatedResponse<T>;
-}

package/dist/common/pagination/pagination.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Pagination = void 0;
-const common_1 = require("@nestjs/common");
-const out_of_range_exception_1 = require("./exceptions/out-of-range.exception");
-class Pagination {
-    static paginationParams(page, perPage) {
-        return { perPage, offset: Pagination.offset(page, perPage) };
-    }
-    static offset(page, perPage) {
-        return (page - 1) * perPage;
-    }
-    static createResponse({ page, perPage }, [data, total]) {
-        const pages = Math.ceil(total / perPage);
-        if (page > pages && pages > 0) {
-            throw new out_of_range_exception_1.OutOfRangeException();
-        }
-        return {
-            data,
-            pagination: {
-                total,
-                pages,
-                perPage,
-                page,
-            },
-        };
-    }
-    static response({ page, perPage }, [data, total]) {
-        const totalPages = Math.ceil(total / perPage);
-        if (page > totalPages && totalPages > 0) {
-            throw new common_1.BadRequestException('Page is out of range');
-        }
-        return {
-            data,
-            pagination: {
-                totalItems: total,
-                totalPages,
-                perPage,
-                page,
-            },
-        };
-    }
-}
-exports.Pagination = Pagination;
-//# sourceMappingURL=pagination.js.map

package/dist/common/pagination/pagination.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"pagination.js","sourceRoot":"","sources":["../../../src/common/pagination/pagination.ts"],"names":[],"mappings":";;;AAAA,2CAAqD;AAQrD,gFAA0E;AAE1E,MAAsB,UAAU;IAC9B,MAAM,CAAC,gBAAgB,CAAC,IAAY,EAAE,OAAe;QACnD,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;IAC/D,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAY,EAAE,OAAe;QACzC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC;IAC9B,CAAC;IAED,MAAM,CAAC,cAAc,CACnB,EAAE,IAAI,EAAE,OAAO,EAA4B,EAC3C,CAAC,IAAI,EAAE,KAAK,CAAuB;QAEnC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,CAAC;QAEzC,IAAI,IAAI,GAAG,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,4CAAmB,EAAE,CAAC;QAClC,CAAC;QAED,OAAO;YACL,IAAI;YACJ,UAAU,EAAE;gBACV,KAAK;gBACL,KAAK;gBACL,OAAO;gBACP,IAAI;aACL;SACF,CAAC;IACJ,CAAC;IAKD,MAAM,CAAC,QAAQ,CACb,EAAE,IAAI,EAAE,OAAO,EAA4B,EAC3C,CAAC,IAAI,EAAE,KAAK,CAAuB;QAEnC,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,CAAC;QAE9C,IAAI,IAAI,GAAG,UAAU,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,4BAAmB,CAAC,sBAAsB,CAAC,CAAC;QACxD,CAAC;QAED,OAAO;YACL,IAAI;YACJ,UAAU,EAAE;gBACV,UAAU,EAAE,KAAK;gBACjB,UAAU;gBACV,OAAO;gBACP,IAAI;aACL;SACF,CAAC;IACJ,CAAC;CACF;AArDD,gCAqDC"}