@takentrade/takentrade-libs 1.2.57 → 1.2.59

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

@@ -1,4 +1 @@
-export declare class PaginationDto {
-    page: number;
-    limit: number;
-}
+export * from './pagination';

package/dist/utils/dto/index.js

@@ -1,31 +1,17 @@
 "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 __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 });
-exports.PaginationDto = void 0;
-const swagger_1 = require("@nestjs/swagger");
-const class_validator_1 = require("class-validator");
-const class_transformer_1 = require("class-transformer");
-class PaginationDto {
-    page = 1;
-    limit = 10;
-}
-exports.PaginationDto = PaginationDto;
-__decorate([
-    (0, swagger_1.ApiProperty)({ minimum: 1, default: 1 }),
-    (0, class_validator_1.IsInt)(),
-    (0, class_validator_1.IsOptional)(),
-    (0, class_transformer_1.Transform)(({ value }) => (value ? parseInt(value) : 10))
-], PaginationDto.prototype, "page", void 0);
-__decorate([
-    (0, swagger_1.ApiProperty)({ minimum: 1, maximum: 100, default: 10 }),
-    (0, class_validator_1.IsInt)(),
-    (0, class_validator_1.Min)(1),
-    (0, class_validator_1.Max)(100),
-    (0, class_validator_1.IsOptional)(),
-    (0, class_transformer_1.Transform)(({ value }) => (value ? parseInt(value) : 10))
-], PaginationDto.prototype, "limit", void 0);
+__exportStar(require("./pagination"), exports);

package/dist/utils/dto/pagination.d.ts

@@ -0,0 +1,8 @@
+import { PaginationParams } from '../interfaces';
+export declare class PaginationQueryDto implements PaginationParams {
+    page?: number;
+    limit: number;
+    search?: string;
+    sortBy?: string;
+    sortOrder?: 'asc' | 'desc';
+}

package/dist/utils/dto/pagination.js

@@ -0,0 +1,49 @@
+"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.PaginationQueryDto = void 0;
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+const swagger_1 = require("@nestjs/swagger");
+class PaginationQueryDto {
+    page;
+    limit;
+    search;
+    sortBy;
+    sortOrder;
+}
+exports.PaginationQueryDto = PaginationQueryDto;
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ minimum: 1, default: 1 }),
+    (0, class_transformer_1.Type)(() => Number),
+    (0, class_validator_1.IsInt)(),
+    (0, class_validator_1.Min)(1),
+    (0, class_validator_1.IsOptional)()
+], PaginationQueryDto.prototype, "page", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ minimum: 1, maximum: 100, default: 10 }),
+    (0, class_transformer_1.Type)(() => Number),
+    (0, class_validator_1.IsInt)(),
+    (0, class_validator_1.Min)(1),
+    (0, class_validator_1.IsOptional)()
+], PaginationQueryDto.prototype, "limit", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsOptional)()
+], PaginationQueryDto.prototype, "search", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsOptional)()
+], PaginationQueryDto.prototype, "sortBy", void 0);
+__decorate([
+    (0, swagger_1.ApiPropertyOptional)({ enum: ['asc', 'desc'], default: 'desc' }),
+    (0, class_validator_1.IsEnum)(['asc', 'desc']),
+    (0, class_validator_1.IsOptional)()
+], PaginationQueryDto.prototype, "sortOrder", void 0);

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

@@ -1,2 +1 @@
-export * from './pagination.interceptor';
 export * from './response.interceptor';

package/dist/utils/interceptors/index.js

@@ -14,5 +14,4 @@ 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.interceptor"), exports);
 __exportStar(require("./response.interceptor"), exports);

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

@@ -1,17 +1,16 @@
-export interface PaginationOptions {
-    /** The page value from the client. It is used to evaluate the value of `offset` and `skip`. Defaults to 1. */
+export interface PaginationParams {
     page?: number;
-    /** The number of rows to take */
     limit?: number;
-    /** The number of rows to skip */
-    offset?: number;
-    /** Logically same as offset. */
-    skip?: number;
+    search?: string;
+    sortBy?: string;
+    sortOrder?: 'asc' | 'desc';
 }
-export interface PaginatedResult<R = unknown> {
-    records: R[];
-    /** The total number of records matched across all pages */
-    count: number;
-    limit: number;
-    page: number;
+export interface PaginatedResult<T> {
+    data: T[];
+    meta: {
+        total: number;
+        page: number;
+        lastPage: number;
+        limit: number;
+    };
 }

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

@@ -3,3 +3,4 @@ export * from './response.utils';
 export * from './country.utils';
 export * from './utils';
 export * from './configuration';
+export * from './pagination';

package/dist/utils/utils/index.js

@@ -19,3 +19,4 @@ __exportStar(require("./response.utils"), exports);
 __exportStar(require("./country.utils"), exports);
 __exportStar(require("./utils"), exports);
 __exportStar(require("./configuration"), exports);
+__exportStar(require("./pagination"), exports);

package/dist/utils/utils/pagination.d.ts

@@ -0,0 +1,10 @@
+import { PaginatedResult, PaginationParams } from '../interfaces';
+export declare const getPaginationParams: (params: PaginationParams) => {
+    take: number;
+    skip: number;
+    orderBy: {
+        [x: string]: "asc" | "desc";
+    };
+    page: number;
+};
+export declare const createPaginatedResponse: <T>(data: T[], total: number, page: number, limit: number) => PaginatedResult<T>;

package/dist/utils/utils/pagination.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPaginatedResponse = exports.getPaginationParams = void 0;
+const getPaginationParams = (params) => {
+    const page = Math.max(1, Number(params.page) || 1);
+    const limit = Math.max(1, Math.min(100, Number(params.limit) || 10));
+    const offset = (page - 1) * limit;
+    const sortBy = params.sortBy || 'createdAt';
+    const sortOrder = params.sortOrder || 'desc';
+    return {
+        take: limit,
+        skip: offset,
+        orderBy: {
+            [sortBy]: sortOrder,
+        },
+        page,
+    };
+};
+exports.getPaginationParams = getPaginationParams;
+const createPaginatedResponse = (data, total, page, limit) => {
+    return {
+        data,
+        meta: {
+            total,
+            page,
+            lastPage: Math.ceil(total / limit),
+            limit,
+        },
+    };
+};
+exports.createPaginatedResponse = createPaginatedResponse;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@takentrade/takentrade-libs",
-  "version": "1.2.57",
+  "version": "1.2.59",
   "description": "TakeNTrade shared libraries",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

package/dist/utils/interceptors/pagination.interceptor.d.ts

@@ -1,19 +0,0 @@
-import { NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
-import { Observable } from 'rxjs';
-/**
- * This is intended to intercept incoming requests for routes that intend to use pagination.
- * It attaches a `Pagination` object named `pagination` to the request object.
- *
- * This new `pagination` property on the request body uses the `page` and `limit` properties on
- * the request's query object if they exist. If no `page` or `limit` property is provided by
- * the request client, this interceptor sets defaults.
- *
- * Defaults:
- *
- * `page` = 1 and;
- *
- * `limit` = 10
- */
-export declare class PaginationInterceptor implements NestInterceptor {
-    intercept(context: ExecutionContext, next: CallHandler): Observable<any>;
-}

package/dist/utils/interceptors/pagination.interceptor.js

@@ -1,49 +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;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PaginationInterceptor = void 0;
-const common_1 = require("@nestjs/common");
-/**
- * This is intended to intercept incoming requests for routes that intend to use pagination.
- * It attaches a `Pagination` object named `pagination` to the request object.
- *
- * This new `pagination` property on the request body uses the `page` and `limit` properties on
- * the request's query object if they exist. If no `page` or `limit` property is provided by
- * the request client, this interceptor sets defaults.
- *
- * Defaults:
- *
- * `page` = 1 and;
- *
- * `limit` = 10
- */
-let PaginationInterceptor = class PaginationInterceptor {
-    intercept(context, next) {
-        const request = context.switchToHttp().getRequest();
-        let page = Number.parseInt(request.query.page);
-        let limit = Number.parseInt(request.query.limit);
-        // check validity and set defaults where necessary
-        page = page.toString() === Number.NaN.toString() ? 1 : page;
-        limit = limit.toString() === Number.NaN.toString() ? 10 : limit;
-        // set boundaries
-        page = page <= 0 ? 1 : page;
-        limit = limit > 100 ? 100 : limit;
-        const pagination = {
-            offset: page * limit - limit,
-            skip: (page - 1) * limit,
-            limit,
-            page,
-        };
-        request.pagination = pagination;
-        return next.handle();
-    }
-};
-exports.PaginationInterceptor = PaginationInterceptor;
-exports.PaginationInterceptor = PaginationInterceptor = __decorate([
-    (0, common_1.Injectable)()
-], PaginationInterceptor);