@russ-b/nestjs-common-tools 1.3.5 → 1.4.0

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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,46 @@
+"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.PaginatedRequestDto = void 0;
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+class PaginatedRequestDto {
+    constructor() {
+        this.page = 1;
+        this.perPage = 50;
+    }
+    get offset() {
+        return (this.page - 1) * this.perPage;
+    }
+    getPaginationParams() {
+        return {
+            perPage: this.perPage,
+            offset: this.offset,
+        };
+    }
+}
+exports.PaginatedRequestDto = PaginatedRequestDto;
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsNumber)(),
+    (0, class_validator_1.Min)(1),
+    (0, class_transformer_1.Type)(() => Number),
+    __metadata("design:type", Number)
+], PaginatedRequestDto.prototype, "page", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsNumber)(),
+    (0, class_validator_1.Max)(1000),
+    (0, class_validator_1.Min)(1),
+    (0, class_transformer_1.Type)(() => Number),
+    __metadata("design:type", Number)
+], PaginatedRequestDto.prototype, "perPage", void 0);
+//# sourceMappingURL=paginated-request.dto.js.map

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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,50 @@
+"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

@@ -0,0 +1 @@
+{"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/index.d.ts

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

package/dist/common/pagination/index.js

@@ -0,0 +1,21 @@
+"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("./interfaces/pagination.interface"), exports);
+//# sourceMappingURL=index.js.map

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

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

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

@@ -0,0 +1,19 @@
+export interface IPaginationRequestParams {
+    page: number;
+    perPage: number;
+}
+export interface IPaginationParams {
+    perPage: number;
+    offset: number;
+}
+export interface IPaginatedResponse<T> {
+    data: T[];
+    pagination: IPaginationData;
+}
+export interface IPaginationData {
+    totalItems: number;
+    totalPages: number;
+    page: number;
+    perPage: number;
+}
+export type CountableResponse<T> = [T[], number];

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

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=pagination.interface.js.map

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

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

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

@@ -0,0 +1,5 @@
+import { PaginatedResponseDto } from './dto/paginated-response.dto';
+import { CountableResponse, IPaginationRequestParams } from './interfaces/pagination.interface';
+export declare abstract class Pagination {
+    static response<T>({ page, perPage }: IPaginationRequestParams, [data, total]: CountableResponse<T>): PaginatedResponseDto<T>;
+}

package/dist/common/pagination/pagination.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Pagination = void 0;
+const common_1 = require("@nestjs/common");
+class Pagination {
+    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

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.js","sourceRoot":"","sources":["../../../src/common/pagination/pagination.ts"],"names":[],"mappings":";;;AACA,2CAAqD;AAMrD,MAAsB,UAAU;IAC9B,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;AArBD,gCAqBC"}