@x-spacy/pagination 1.0.8 → 1.0.11

package/@types/enums/PaginationLinkType.d.ts

@@ -0,0 +1,7 @@
+export declare enum PaginationLinkType {
+  FIRST = 'FIRST',
+  LAST = 'LAST',
+  PREVIOUS = 'PREVIOUS',
+  NEXT = 'NEXT',
+  PAGE = 'PAGE'
+}

package/@types/index.d.ts

@@ -0,0 +1,6 @@
+/// <reference path="./enums/PaginationLinkType.d.ts" />
+/// <reference path="./interceptors/PaginationInterceptor.d.ts" />
+/// <reference path="./operators/paginate.d.ts" />
+/// <reference path="./schemas/PaginatedResponse.d.ts" />
+/// <reference path="./schemas/PaginationLink.d.ts" />
+/// <reference path="./schemas/PaginationMeta.d.ts" />

package/@types/interceptors/PaginationInterceptor.d.ts

@@ -0,0 +1,14 @@
+import {
+  CallHandler,
+  ExecutionContext,
+  NestInterceptor
+} from '@nestjs/common';
+
+import { Observable } from 'rxjs';
+
+import { Page } from '../schemas/Page';
+import { PaginatedResponse } from '../schemas/PaginatedResponse';
+
+export declare class PaginateInterceptor<T> implements NestInterceptor<Page<T>, PaginatedResponse<T>> {
+  intercept(context: ExecutionContext, next: CallHandler<Page<T>>): Observable<PaginatedResponse<T>>;
+}

package/@types/operators/paginate.d.ts

@@ -0,0 +1,3 @@
+import { Page } from '../schemas/Page';
+
+export declare function paginate<T>(items: Array<T>, total: number): Page<T>;

package/@types/schemas/Page.d.ts

@@ -0,0 +1,5 @@
+export class Page<T> {
+  public readonly items: Array<T>;
+
+  public readonly total: number;
+}

package/@types/schemas/PaginatedResponse.d.ts

@@ -0,0 +1,20 @@
+import { PaginationLink } from './PaginationLink';
+import { PaginationMeta } from './PaginationMeta';
+
+export declare class PaginatedResponse<T> {
+  public readonly items: Array<T>;
+
+  public readonly meta: PaginationMeta;
+
+  public readonly path: string;
+
+  public readonly firstPageURL: string;
+
+  public readonly previousPageURL: string | null;
+
+  public readonly nextPageURL: string | null;
+
+  public readonly lastPageURL: string;
+
+  public readonly links: Array<PaginationLink>;
+}

package/@types/schemas/PaginationLink.d.ts

@@ -0,0 +1,11 @@
+import { PaginationLinkType } from './PaginationLinkType';
+
+export declare class PaginationLink {
+  public readonly url: string | null;
+
+  public readonly label: string;
+
+  public readonly type: PaginationLinkType;
+
+  public readonly active: boolean;
+}

package/@types/schemas/PaginationMeta.d.ts

@@ -0,0 +1,13 @@
+export declare class PaginationMeta {
+  public readonly from: number;
+
+  public readonly to: number;
+
+  public readonly currentPage: number;
+
+  public readonly lastPage: number;
+
+  public readonly perPage: number;
+
+  public readonly total: number;
+}

package/dist/enums/PaginationLinkType.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaginationLinkType = void 0;
+var PaginationLinkType;
+(function (PaginationLinkType) {
+    PaginationLinkType["FIRST"] = "FIRST";
+    PaginationLinkType["LAST"] = "LAST";
+    PaginationLinkType["PREVIOUS"] = "PREVIOUS";
+    PaginationLinkType["NEXT"] = "NEXT";
+    PaginationLinkType["PAGE"] = "PAGE";
+})(PaginationLinkType || (exports.PaginationLinkType = PaginationLinkType = {}));

package/dist/index.js

@@ -0,0 +1,22 @@
+"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("./interceptors/PaginationInterceptor"), exports);
+__exportStar(require("./operators/paginate"), exports);
+__exportStar(require("./schemas/Page"), exports);
+__exportStar(require("./schemas/PaginatedResponse"), exports);
+__exportStar(require("./schemas/PaginationLink"), exports);
+__exportStar(require("./schemas/PaginationMeta"), exports);

package/dist/interceptors/PaginationInterceptor.js

@@ -0,0 +1,52 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaginateInterceptor = void 0;
+const common_1 = require("@nestjs/common");
+const operators_1 = require("rxjs/operators");
+const Page_1 = require("../schemas/Page");
+const PaginatedResponse_1 = require("../schemas/PaginatedResponse");
+const PaginationLink_1 = require("../schemas/PaginationLink");
+const PaginationMeta_1 = require("../schemas/PaginationMeta");
+const PaginationLinkType_1 = require("../enums/PaginationLinkType");
+let PaginateInterceptor = class PaginateInterceptor {
+    intercept(context, next) {
+        const request = context.switchToHttp().getRequest();
+        const page = Math.max(1, parseInt(request.query.page, 10) ?? 1);
+        const perPage = Math.min(100, Math.max(1, parseInt(request.query.perPage, 10) ?? 10));
+        const path = `${request.protocol}://${request.get('host') + request.path}`;
+        return next.handle().pipe((0, operators_1.map)((data) => {
+            if (!(data instanceof Page_1.Page)) {
+                return data;
+            }
+            const { total, items } = data;
+            const lastPage = Math.max(1, Math.ceil(total / perPage));
+            const currentPage = Math.min(page, lastPage);
+            const startIndex = (currentPage - 1) * perPage;
+            const endIndex = Math.min(startIndex + perPage, total);
+            const from = total > 0 ? startIndex + 1 : 0;
+            const to = endIndex;
+            const buildUrl = (pageNumber) => `${path}?page=${pageNumber}&perPage=${perPage}`;
+            const links = this.buildLinks(currentPage, lastPage, buildUrl);
+            return new PaginatedResponse_1.PaginatedResponse(items, new PaginationMeta_1.PaginationMeta(from, to, currentPage, lastPage, perPage, total), path, buildUrl(1), currentPage > 1 ? buildUrl(currentPage - 1) : null, currentPage < lastPage ? buildUrl(currentPage + 1) : null, buildUrl(lastPage), links);
+        }));
+    }
+    buildLinks(currentPage, lastPage, buildUrl) {
+        const links = new Array();
+        links.push(new PaginationLink_1.PaginationLink(currentPage > 1 ? buildUrl(currentPage - 1) : null, '&laquo; Anterior', PaginationLinkType_1.PaginationLinkType.PREVIOUS, false));
+        for (let i = 1; i <= lastPage; i++) {
+            links.push(new PaginationLink_1.PaginationLink(buildUrl(i), String(i), PaginationLinkType_1.PaginationLinkType.PAGE, i === currentPage));
+        }
+        links.push(new PaginationLink_1.PaginationLink(currentPage < lastPage ? buildUrl(currentPage + 1) : null, 'Próximo &raquo;', PaginationLinkType_1.PaginationLinkType.NEXT, false));
+        return links;
+    }
+};
+exports.PaginateInterceptor = PaginateInterceptor;
+exports.PaginateInterceptor = PaginateInterceptor = __decorate([
+    (0, common_1.Injectable)()
+], PaginateInterceptor);

package/dist/operators/paginate.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.paginate = paginate;
+const Page_1 = require("../schemas/Page");
+function paginate(items, total) {
+    return new Page_1.Page(items, total);
+}

package/dist/schemas/Page.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Page = void 0;
+class Page {
+    items;
+    total;
+    constructor(items, total) {
+        this.items = items;
+        this.total = total;
+    }
+}
+exports.Page = Page;

package/dist/schemas/PaginatedResponse.js

@@ -0,0 +1,67 @@
+"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.PaginatedResponse = void 0;
+const class_transformer_1 = require("class-transformer");
+const PaginationMeta_1 = require("./PaginationMeta");
+class PaginatedResponse {
+    items;
+    meta;
+    path;
+    firstPageURL;
+    previousPageURL;
+    nextPageURL;
+    lastPageURL;
+    links;
+    constructor(items, meta, path, firstPageURL, previousPageURL, nextPageURL, lastPageURL, links) {
+        this.items = items;
+        this.meta = meta;
+        this.path = path;
+        this.firstPageURL = firstPageURL;
+        this.previousPageURL = previousPageURL;
+        this.nextPageURL = nextPageURL;
+        this.lastPageURL = lastPageURL;
+        this.links = links;
+    }
+}
+exports.PaginatedResponse = PaginatedResponse;
+__decorate([
+    (0, class_transformer_1.Expose)({ name: 'items' }),
+    __metadata("design:type", Array)
+], PaginatedResponse.prototype, "items", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)({ name: 'meta' }),
+    __metadata("design:type", PaginationMeta_1.PaginationMeta)
+], PaginatedResponse.prototype, "meta", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)({ name: 'path' }),
+    __metadata("design:type", String)
+], PaginatedResponse.prototype, "path", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)({ name: 'first_page_url' }),
+    __metadata("design:type", String)
+], PaginatedResponse.prototype, "firstPageURL", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)({ name: 'previous_page_url' }),
+    __metadata("design:type", Object)
+], PaginatedResponse.prototype, "previousPageURL", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)({ name: 'next_page_url' }),
+    __metadata("design:type", Object)
+], PaginatedResponse.prototype, "nextPageURL", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)({ name: 'last_page_url' }),
+    __metadata("design:type", String)
+], PaginatedResponse.prototype, "lastPageURL", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)({ name: 'links' }),
+    __metadata("design:type", Array)
+], PaginatedResponse.prototype, "links", void 0);

package/dist/schemas/PaginationLink.js

@@ -0,0 +1,43 @@
+"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.PaginationLink = void 0;
+const class_transformer_1 = require("class-transformer");
+const PaginationLinkType_1 = require("../enums/PaginationLinkType");
+class PaginationLink {
+    url;
+    label;
+    type;
+    active;
+    constructor(url, label, type, active) {
+        this.url = url;
+        this.label = label;
+        this.type = type;
+        this.active = active;
+    }
+}
+exports.PaginationLink = PaginationLink;
+__decorate([
+    (0, class_transformer_1.Expose)({ name: 'url' }),
+    __metadata("design:type", Object)
+], PaginationLink.prototype, "url", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)({ name: 'label' }),
+    __metadata("design:type", String)
+], PaginationLink.prototype, "label", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)({ name: 'type' }),
+    __metadata("design:type", String)
+], PaginationLink.prototype, "type", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)({ name: 'active' }),
+    __metadata("design:type", Boolean)
+], PaginationLink.prototype, "active", void 0);

package/dist/schemas/PaginationMeta.js

@@ -0,0 +1,54 @@
+"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.PaginationMeta = void 0;
+const class_transformer_1 = require("class-transformer");
+class PaginationMeta {
+    from;
+    to;
+    currentPage;
+    lastPage;
+    perPage;
+    total;
+    constructor(from, to, currentPage, lastPage, perPage, total) {
+        this.from = from;
+        this.to = to;
+        this.currentPage = currentPage;
+        this.lastPage = lastPage;
+        this.perPage = perPage;
+        this.total = total;
+    }
+}
+exports.PaginationMeta = PaginationMeta;
+__decorate([
+    (0, class_transformer_1.Expose)({ name: 'from' }),
+    __metadata("design:type", Number)
+], PaginationMeta.prototype, "from", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)({ name: 'to' }),
+    __metadata("design:type", Number)
+], PaginationMeta.prototype, "to", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)({ name: 'current_page' }),
+    __metadata("design:type", Number)
+], PaginationMeta.prototype, "currentPage", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)({ name: 'last_page' }),
+    __metadata("design:type", Number)
+], PaginationMeta.prototype, "lastPage", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)({ name: 'per_page' }),
+    __metadata("design:type", Number)
+], PaginationMeta.prototype, "perPage", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)({ name: 'total' }),
+    __metadata("design:type", Number)
+], PaginationMeta.prototype, "total", void 0);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@x-spacy/pagination",
-  "version": "1.0.8",
+  "version": "1.0.11",
   "description": "A pagination library for NestJS",
   "license": "X SPACY LICENSE AGREEMENT",
   "private": false,

package/tsconfig.json

@@ -2,16 +2,14 @@
   "compilerOptions": {
     "target": "es2024",
     "module": "commonjs",
-    "rootDir": ".",
+    "rootDir": "src",
     "outDir": "dist",
-    "declarationDir": "@types",
     "paths": {
       "@x-spacy/pagination/*": [
         "./src/*"
       ]
     },
     "strict": true,
-    "declaration": true,
     "skipLibCheck": true,
     "removeComments": true,
     "esModuleInterop": true,