@catbee/utils 2.0.0-next.0 → 2.0.0

package/request/index.cjs

@@ -1,7 +1,7 @@
 /*
  * The MIT License
  * 
- * Copyright (c) 2025 Catbee Technologies. https://catbee.in/license
+ * Copyright (c) 2026 Catbee Technologies. https://catbee.in/license
  * 
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -61,7 +61,7 @@ function parseNumberParam(value, options = {}) {
     };
   }
   const num = Number(value);
-  if (isNaN(num)) {
+  if (Number.isNaN(num)) {
     if (throwOnError) throw new exception.BadRequestException(errorMessage);
     return {
       isValid: false,
@@ -143,38 +143,50 @@ function extractPaginationParams(query, defaultPage = 1, defaultLimit = 20, maxL
   };
 }
 __name(extractPaginationParams, "extractPaginationParams");
-function extractSortParams(query, allowedFields, defaultSort = {
+var DEFAULT_SORT = {
   sortBy: "createdAt",
   sortOrder: "desc"
-}) {
-  let sortBy = defaultSort.sortBy;
-  let sortOrder = defaultSort.sortOrder;
-  if (typeof query.sortBy === "string") {
-    sortBy = query.sortBy;
-  } else if (Array.isArray(query.sortBy)) {
-    sortBy = query.sortBy[0];
-  } else if (typeof query.sort === "string") {
-    sortBy = query.sort.startsWith("-") ? query.sort.slice(1) : query.sort;
-    sortOrder = query.sort.startsWith("-") ? "desc" : "asc";
-  } else if (Array.isArray(query.sort)) {
-    sortBy = query.sort[0].startsWith("-") ? query.sort[0].slice(1) : query.sort[0];
-    sortOrder = query.sort[0].startsWith("-") ? "desc" : "asc";
-  }
-  if (typeof query.sortOrder === "string") {
-    const order = query.sortOrder.toLowerCase();
-    if (order === "asc" || order === "desc") {
-      sortOrder = order;
-    }
-  }
-  if (allowedFields.length && !allowedFields.includes(sortBy)) {
-    sortBy = defaultSort.sortBy;
+};
+function extractSortParams(query, allowedFields, defaultSort = DEFAULT_SORT) {
+  const inferredSortBy = getSortByFromQuery(query, defaultSort);
+  let sortOrder = getSortOrderFromQuery(query, defaultSort);
+  const explicit = applyExplicitSortOrder(query.sortOrder);
+  if (explicit) {
+    sortOrder = explicit;
   }
+  const sortBy = validateSortField(inferredSortBy, allowedFields, defaultSort.sortBy);
   return {
     sortBy,
     sortOrder
   };
 }
 __name(extractSortParams, "extractSortParams");
+function getSortByFromQuery(query, defaultSort) {
+  if (typeof query.sortBy === "string") return query.sortBy;
+  if (Array.isArray(query.sortBy)) return query.sortBy[0];
+  if (typeof query.sort === "string") return query.sort.startsWith("-") ? query.sort.slice(1) : query.sort;
+  if (Array.isArray(query.sort)) return query.sort[0].startsWith("-") ? query.sort[0].slice(1) : query.sort[0];
+  return defaultSort.sortBy;
+}
+__name(getSortByFromQuery, "getSortByFromQuery");
+function getSortOrderFromQuery(query, defaultSort) {
+  if (typeof query.sort === "string") return query.sort.startsWith("-") ? "desc" : "asc";
+  if (Array.isArray(query.sort)) return query.sort[0].startsWith("-") ? "desc" : "asc";
+  return defaultSort.sortOrder;
+}
+__name(getSortOrderFromQuery, "getSortOrderFromQuery");
+function applyExplicitSortOrder(sortOrderParam) {
+  if (typeof sortOrderParam !== "string") return null;
+  const order = sortOrderParam.toLowerCase();
+  if (order === "asc" || order === "desc") return order;
+  return null;
+}
+__name(applyExplicitSortOrder, "applyExplicitSortOrder");
+function validateSortField(sortBy, allowedFields, defaultSortBy) {
+  if (allowedFields.length && !allowedFields.includes(sortBy)) return defaultSortBy;
+  return sortBy;
+}
+__name(validateSortField, "validateSortField");
 function extractFilterParams(query, allowedFilters) {
   const filters = {};
   for (const field of allowedFilters) {

package/request/index.d.ts

@@ -1,7 +1,7 @@
 /*
  * The MIT License
  * 
- * Copyright (c) 2025 Catbee Technologies. https://catbee.in/license
+ * Copyright (c) 2026 Catbee Technologies. https://catbee.in/license
  * 
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -22,5 +22,244 @@
  * SOFTWARE.
  */
 
-export * from './request.utils';
-export * from '../types/api-response';
+import { Request } from 'express';
+import { WithPagination as WithPagination$1 } from '@catbee/utils/response';
+
+/**
+ * Options for parsing and validating request parameters.
+ */
+interface ValidationOptions {
+    /** Whether to throw an error on validation failure */
+    throwOnError?: boolean;
+    /** Custom error message for validation failures */
+    errorMessage?: string;
+    /** Default value to use if parameter is missing */
+    defaultValue?: any;
+    /** Whether the parameter is required */
+    required?: boolean;
+}
+/**
+ * Result of a parameter validation operation.
+ */
+interface ValidationResult<T> {
+    /** Whether validation was successful */
+    isValid: boolean;
+    /** The validated and potentially transformed value */
+    value: T | null;
+    /** Error message if validation failed */
+    error?: string;
+}
+/**
+ * Extracts pagination, sorting, and optional search params from a request.
+ *
+ * @param req - Express request
+ * @returns Object containing validated pagination, sorting, and additional query params
+ */
+declare const getPaginationParams: <T = {}>(req: Request) => WithPagination$1<T>;
+/**
+ * Safely parses a string parameter to a number.
+ *
+ * @param value - String value to parse
+ * @param options - Validation options
+ * @returns Validation result containing the parsed number or error
+ */
+declare function parseNumberParam(value: string | undefined, options?: ValidationOptions): ValidationResult<number>;
+/**
+ * Safely parses a string parameter to a boolean.
+ *
+ * @param value - String value to parse
+ * @param options - Validation options
+ * @returns Validation result containing the parsed boolean or error
+ */
+declare function parseBooleanParam(value: string | undefined, options?: ValidationOptions): ValidationResult<boolean>;
+/**
+ * Extracts pagination parameters from request query parameters.
+ *
+ * @param query - Query parameters object
+ * @param defaultPage - Default page number if not specified (defaults to 1)
+ * @param defaultLimit - Default per page size if not specified (defaults to 20)
+ * @param maxLimitSize - Maximum allowed per page size (defaults to 100)
+ * @returns Object containing validated page and limit
+ */
+declare function extractPaginationParams(query: Record<string, string | string[]>, defaultPage?: number, defaultLimit?: number, maxLimitSize?: number): {
+    page: number;
+    limit: number;
+};
+/**
+ * Extracts sorting parameters from request query parameters.
+ *
+ * @param query - Query parameters object
+ * @param allowedFields - Array of field names that are allowed to be sorted
+ * @param defaultSort - Default sort configuration if not specified
+ * @returns Object containing sort field and direction
+ */
+declare function extractSortParams(query: Record<string, string | string[]>, allowedFields: string[], defaultSort?: {
+    sortBy: string;
+    sortOrder: 'asc' | 'desc';
+}): {
+    sortBy: string;
+    sortOrder: 'asc' | 'desc';
+};
+/**
+ * Extracts filter parameters from query parameters based on allowed filter fields.
+ *
+ * @param query - Query parameters object
+ * @param allowedFilters - Array of field names that are allowed to be used as filters
+ * @returns Object containing the filters as key-value pairs
+ */
+declare function extractFilterParams(query: Record<string, string | string[]>, allowedFilters: string[]): Record<string, string | string[]>;
+
+/**
+ * Generic API response format.
+ * Used to wrap any successful or failed response from the server.
+ */
+interface ApiResponse<T = any> {
+    /** Payload returned from the API. Can be any shape depending on the endpoint. */
+    data: T | null;
+    /** Indicates whether an error occurred (true = error, false = success). */
+    error: boolean;
+    /** Success message describing the result of the operation. */
+    message: string;
+    /** Unique request ID for traceability in logs (e.g., from a middleware). */
+    requestId: string;
+    /** ISO timestamp when the response was generated. */
+    timestamp: string;
+}
+/**
+ * Generic pagination structure used for paged lists (e.g., /users?page=1).
+ */
+interface Pagination<T = any> {
+    /** List of records for the current page. */
+    content: T[];
+    /** Metadata about the pagination state. */
+    pagination: {
+        /** Total number of records across all pages. */
+        totalRecords: number;
+        /** Total number of pages available. */
+        totalPages: number;
+        /** Current page number (1-based index). */
+        page: number;
+        /** Number of records per page. */
+        limit: number;
+        /** Field by which the data is sorted. */
+        sortBy: string;
+        /** Sort order: ascending or descending. */
+        sortOrder: 'asc' | 'desc';
+    };
+}
+/**
+ * Alias for paginated API response.
+ * Allows semantic naming like `PaginationResponse<User>` or `PaginationResponse<Post>`.
+ */
+type PaginationResponse<T = any> = Pagination<T>;
+/**
+ * Error response structure with additional metadata.
+ * Used for providing richer error information to clients.
+ */
+interface ApiErrorResponse extends Omit<ApiResponse<never>, 'data'> {
+    /** Error always true for error responses */
+    error: true;
+    /** HTTP status code */
+    status: number;
+    /** Path to the resource that caused the error */
+    path: string;
+    /** Stack trace of the error (if available) */
+    stack?: string[];
+}
+/**
+ * Success response structure with strongly typed data.
+ * Used for providing successful responses to clients.
+ */
+interface ApiSuccessResponse<T = any> extends ApiResponse<T> {
+    /** Error always false for success responses */
+    error: false;
+    /** HTTP status code (usually 200) */
+    status?: number;
+}
+/**
+ * Response structure for batch operations.
+ * Used when multiple operations are performed in a single request.
+ */
+interface BatchResponse<T = any> {
+    /** Overall success/failure indicator */
+    success: boolean;
+    /** Total number of operations */
+    total: number;
+    /** Number of successful operations */
+    successful: number;
+    /** Number of failed operations */
+    failed: number;
+    /** Results of individual operations */
+    results: Array<{
+        /** Identifier for this operation */
+        id: string | number;
+        /** Success/failure indicator for this operation */
+        success: boolean;
+        /** Response data for this operation */
+        data?: T;
+        /** Error information if this operation failed */
+        error?: {
+            message: string;
+            code?: string;
+        };
+    }>;
+}
+/**
+ * Response structure for asynchronous operations.
+ * Used when the operation will complete in the future.
+ */
+interface AsyncOperationResponse {
+    /** Always true for async operations */
+    async: true;
+    /** Job or task ID to check status later */
+    jobId: string;
+    /** Estimated completion time in seconds (if known) */
+    estimatedTime?: number;
+    /** URL to check status */
+    statusUrl: string;
+}
+/**
+ * Response structure for streaming operations.
+ * Used when data is returned as a stream rather than all at once.
+ */
+interface StreamResponse {
+    /** Stream identifier */
+    streamId: string;
+    /** Stream type (e.g., 'json', 'binary') */
+    streamType: string;
+    /** Total size in bytes (if known) */
+    totalSize?: number;
+    /** Chunk size in bytes */
+    chunkSize: number;
+}
+/**
+ * Sort direction enumeration.
+ */
+declare enum SortDirection {
+    /** Ascending sort order */
+    ASC = "asc",
+    /** Descending sort order */
+    DESC = "desc"
+}
+/**
+ * Pagination parameters for API requests.
+ */
+interface PaginationParams {
+    /** Current page number (1-based index) */
+    page: number;
+    /** Number of records per page */
+    limit: number;
+    /** Field by which the data is sorted */
+    sortBy: string;
+    /** Sort order: ascending or descending */
+    sortOrder: SortDirection;
+    /** Optional search query */
+    search?: string;
+}
+/**
+ * Type that combines pagination parameters with additional data.
+ */
+type WithPagination<T = {}> = PaginationParams & T;
+
+export { SortDirection, extractFilterParams, extractPaginationParams, extractSortParams, getPaginationParams, parseBooleanParam, parseNumberParam };
+export type { ApiErrorResponse, ApiResponse, ApiSuccessResponse, AsyncOperationResponse, BatchResponse, Pagination, PaginationParams, PaginationResponse, StreamResponse, ValidationOptions, ValidationResult, WithPagination };

package/request/index.mjs

@@ -1,7 +1,7 @@
 /*
  * The MIT License
  * 
- * Copyright (c) 2025 Catbee Technologies. https://catbee.in/license
+ * Copyright (c) 2026 Catbee Technologies. https://catbee.in/license
  * 
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -59,7 +59,7 @@ function parseNumberParam(value, options = {}) {
     };
   }
   const num = Number(value);
-  if (isNaN(num)) {
+  if (Number.isNaN(num)) {
     if (throwOnError) throw new BadRequestException(errorMessage);
     return {
       isValid: false,
@@ -141,38 +141,50 @@ function extractPaginationParams(query, defaultPage = 1, defaultLimit = 20, maxL
   };
 }
 __name(extractPaginationParams, "extractPaginationParams");
-function extractSortParams(query, allowedFields, defaultSort = {
+var DEFAULT_SORT = {
   sortBy: "createdAt",
   sortOrder: "desc"
-}) {
-  let sortBy = defaultSort.sortBy;
-  let sortOrder = defaultSort.sortOrder;
-  if (typeof query.sortBy === "string") {
-    sortBy = query.sortBy;
-  } else if (Array.isArray(query.sortBy)) {
-    sortBy = query.sortBy[0];
-  } else if (typeof query.sort === "string") {
-    sortBy = query.sort.startsWith("-") ? query.sort.slice(1) : query.sort;
-    sortOrder = query.sort.startsWith("-") ? "desc" : "asc";
-  } else if (Array.isArray(query.sort)) {
-    sortBy = query.sort[0].startsWith("-") ? query.sort[0].slice(1) : query.sort[0];
-    sortOrder = query.sort[0].startsWith("-") ? "desc" : "asc";
-  }
-  if (typeof query.sortOrder === "string") {
-    const order = query.sortOrder.toLowerCase();
-    if (order === "asc" || order === "desc") {
-      sortOrder = order;
-    }
-  }
-  if (allowedFields.length && !allowedFields.includes(sortBy)) {
-    sortBy = defaultSort.sortBy;
+};
+function extractSortParams(query, allowedFields, defaultSort = DEFAULT_SORT) {
+  const inferredSortBy = getSortByFromQuery(query, defaultSort);
+  let sortOrder = getSortOrderFromQuery(query, defaultSort);
+  const explicit = applyExplicitSortOrder(query.sortOrder);
+  if (explicit) {
+    sortOrder = explicit;
   }
+  const sortBy = validateSortField(inferredSortBy, allowedFields, defaultSort.sortBy);
   return {
     sortBy,
     sortOrder
   };
 }
 __name(extractSortParams, "extractSortParams");
+function getSortByFromQuery(query, defaultSort) {
+  if (typeof query.sortBy === "string") return query.sortBy;
+  if (Array.isArray(query.sortBy)) return query.sortBy[0];
+  if (typeof query.sort === "string") return query.sort.startsWith("-") ? query.sort.slice(1) : query.sort;
+  if (Array.isArray(query.sort)) return query.sort[0].startsWith("-") ? query.sort[0].slice(1) : query.sort[0];
+  return defaultSort.sortBy;
+}
+__name(getSortByFromQuery, "getSortByFromQuery");
+function getSortOrderFromQuery(query, defaultSort) {
+  if (typeof query.sort === "string") return query.sort.startsWith("-") ? "desc" : "asc";
+  if (Array.isArray(query.sort)) return query.sort[0].startsWith("-") ? "desc" : "asc";
+  return defaultSort.sortOrder;
+}
+__name(getSortOrderFromQuery, "getSortOrderFromQuery");
+function applyExplicitSortOrder(sortOrderParam) {
+  if (typeof sortOrderParam !== "string") return null;
+  const order = sortOrderParam.toLowerCase();
+  if (order === "asc" || order === "desc") return order;
+  return null;
+}
+__name(applyExplicitSortOrder, "applyExplicitSortOrder");
+function validateSortField(sortBy, allowedFields, defaultSortBy) {
+  if (allowedFields.length && !allowedFields.includes(sortBy)) return defaultSortBy;
+  return sortBy;
+}
+__name(validateSortField, "validateSortField");
 function extractFilterParams(query, allowedFilters) {
   const filters = {};
   for (const field of allowedFilters) {

package/response/index.cjs

@@ -1,7 +1,7 @@
 /*
  * The MIT License
  * 
- * Copyright (c) 2025 Catbee Technologies. https://catbee.in/license
+ * Copyright (c) 2026 Catbee Technologies. https://catbee.in/license
  * 
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal