@nestarc/pagination 0.1.0

package/dist/pagination.module.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;
+};
+var PaginationModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaginationModule = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const pagination_constants_1 = require("./pagination.constants");
+const paginate_service_1 = require("./paginate.service");
+let PaginationModule = PaginationModule_1 = class PaginationModule {
+    static forRoot(options) {
+        return {
+            module: PaginationModule_1,
+            global: true,
+            providers: [
+                {
+                    provide: pagination_constants_1.PAGINATION_MODULE_OPTIONS,
+                    useValue: options ?? {},
+                },
+                paginate_service_1.PaginateService,
+                core_1.Reflector,
+            ],
+            exports: [pagination_constants_1.PAGINATION_MODULE_OPTIONS, paginate_service_1.PaginateService],
+        };
+    }
+    static forRootAsync(options) {
+        return {
+            module: PaginationModule_1,
+            global: true,
+            imports: options.imports ?? [],
+            providers: [
+                {
+                    provide: pagination_constants_1.PAGINATION_MODULE_OPTIONS,
+                    useFactory: options.useFactory,
+                    inject: options.inject ?? [],
+                },
+                paginate_service_1.PaginateService,
+                core_1.Reflector,
+            ],
+            exports: [pagination_constants_1.PAGINATION_MODULE_OPTIONS, paginate_service_1.PaginateService],
+        };
+    }
+};
+exports.PaginationModule = PaginationModule;
+exports.PaginationModule = PaginationModule = PaginationModule_1 = __decorate([
+    (0, common_1.Module)({})
+], PaginationModule);

package/dist/pipes/paginate-query.pipe.d.ts

@@ -0,0 +1,2 @@
+import { PaginateQuery } from '../interfaces/paginate-query.interface';
+export declare function parsePaginateQuery(request: any): PaginateQuery;

package/dist/pipes/paginate-query.pipe.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parsePaginateQuery = parsePaginateQuery;
+function parsePaginateQuery(request) {
+    const query = request.query || {};
+    const path = request.path || request.url || '/';
+    const result = { path };
+    if (query.page !== undefined) {
+        const page = parseInt(query.page, 10);
+        result.page = isNaN(page) || page < 1 ? 1 : page;
+    }
+    if (query.limit !== undefined) {
+        const limit = parseInt(query.limit, 10);
+        result.limit = isNaN(limit) || limit < 1 ? 1 : limit;
+    }
+    if (query.sortBy !== undefined) {
+        const sortValues = Array.isArray(query.sortBy) ? query.sortBy : [query.sortBy];
+        result.sortBy = sortValues.map((s) => {
+            const [column, order = 'ASC'] = s.split(':');
+            return [column, order.toUpperCase()];
+        });
+    }
+    if (query.search !== undefined) {
+        result.search = query.search;
+    }
+    const filterEntries = [];
+    for (const key of Object.keys(query)) {
+        if (key.startsWith('filter.')) {
+            const column = key.substring('filter.'.length);
+            filterEntries.push([column, query[key]]);
+        }
+    }
+    if (filterEntries.length > 0) {
+        result.filter = Object.fromEntries(filterEntries);
+    }
+    if (query.after !== undefined) {
+        result.after = query.after;
+    }
+    if (query.before !== undefined) {
+        result.before = query.before;
+    }
+    return result;
+}

package/dist/testing/create-paginate-query.d.ts

@@ -0,0 +1,2 @@
+import { PaginateQuery } from '../interfaces/paginate-query.interface';
+export declare function createPaginateQuery(overrides?: Partial<PaginateQuery>): PaginateQuery;

package/dist/testing/create-paginate-query.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPaginateQuery = createPaginateQuery;
+function createPaginateQuery(overrides = {}) {
+    return {
+        path: '/',
+        ...overrides,
+    };
+}

package/dist/testing/index.d.ts

@@ -0,0 +1,2 @@
+export { createPaginateQuery } from './create-paginate-query';
+export { TestPaginationModule } from './test-pagination.module';

package/dist/testing/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestPaginationModule = exports.createPaginateQuery = void 0;
+var create_paginate_query_1 = require("./create-paginate-query");
+Object.defineProperty(exports, "createPaginateQuery", { enumerable: true, get: function () { return create_paginate_query_1.createPaginateQuery; } });
+var test_pagination_module_1 = require("./test-pagination.module");
+Object.defineProperty(exports, "TestPaginationModule", { enumerable: true, get: function () { return test_pagination_module_1.TestPaginationModule; } });

package/dist/testing/test-pagination.module.d.ts

@@ -0,0 +1,5 @@
+import { DynamicModule } from '@nestjs/common';
+import { PaginationModuleOptions } from '../interfaces/pagination-options.interface';
+export declare class TestPaginationModule {
+    static register(options?: PaginationModuleOptions): DynamicModule;
+}

package/dist/testing/test-pagination.module.js

@@ -0,0 +1,30 @@
+"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 TestPaginationModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestPaginationModule = void 0;
+const common_1 = require("@nestjs/common");
+const pagination_constants_1 = require("../pagination.constants");
+let TestPaginationModule = TestPaginationModule_1 = class TestPaginationModule {
+    static register(options) {
+        return {
+            module: TestPaginationModule_1,
+            providers: [
+                {
+                    provide: pagination_constants_1.PAGINATION_MODULE_OPTIONS,
+                    useValue: options ?? {},
+                },
+            ],
+            exports: [pagination_constants_1.PAGINATION_MODULE_OPTIONS],
+        };
+    }
+};
+exports.TestPaginationModule = TestPaginationModule;
+exports.TestPaginationModule = TestPaginationModule = TestPaginationModule_1 = __decorate([
+    (0, common_1.Module)({})
+], TestPaginationModule);

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@nestarc/pagination",
+  "version": "0.1.0",
+  "description": "Prisma cursor & offset pagination for NestJS with filtering, sorting, search, and Swagger auto-documentation",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./testing": {
+      "types": "./dist/testing/index.d.ts",
+      "default": "./dist/testing/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "test": "jest",
+    "test:cov": "jest --coverage"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^10.0.0 || ^11.0.0",
+    "@nestjs/core": "^10.0.0 || ^11.0.0",
+    "@prisma/client": "^5.0.0 || ^6.0.0",
+    "reflect-metadata": "^0.1.13 || ^0.2.0",
+    "rxjs": "^7.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@nestjs/swagger": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@nestjs/common": "^11.0.0",
+    "@nestjs/core": "^11.0.0",
+    "@nestjs/swagger": "^11.0.0",
+    "@nestjs/testing": "^11.0.0",
+    "@prisma/client": "^6.0.0",
+    "@types/jest": "^29.5.0",
+    "@types/node": "^22.0.0",
+    "jest": "^29.7.0",
+    "reflect-metadata": "^0.2.0",
+    "rxjs": "^7.8.0",
+    "ts-jest": "^29.2.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.7.0"
+  },
+  "license": "MIT"
+}