@russ-b/nestjs-common-tools 1.8.0 → 1.9.0

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

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

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

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

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

@@ -10,6 +10,16 @@ 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 {
     totalItems: number;
     totalPages: number;

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

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

@@ -2,7 +2,23 @@
 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 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) {

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

@@ -1 +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"}
+{"version":3,"file":"pagination.js","sourceRoot":"","sources":["../../../src/common/pagination/pagination.ts"],"names":[],"mappings":";;;AAAA,2CAAqD;AAOrD,gFAA0E;AAE1E,MAAsB,UAAU;IAC9B,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;AA7CD,gCA6CC"}