@dexyn/common-library 1.1.1 → 1.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dexyn/common-library",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "main": "index.js",
   "repository": {
     "type": "git",

package/result/resultUtils.d.ts

@@ -1,6 +1,9 @@
 type SuccessResult<T> = {
     success: true;
     data: T;
+    page?: number;
+    pageSize?: number;
+    totalCount?: number;
 };
 export type ErrorResult = {
     success: false;
@@ -23,9 +26,16 @@ export type Result<T> = SuccessResult<T> | ErrorResult;
  * @returns A ResultUtils<T, E> representing the outcome of the promise.
  */
 export declare function toResult<T>(data: T): Result<T>;
+/**
+ * Converts an error into a ResultUtils type, wrapping its error outcome.
+ *
+ * @param error - Error to be wrapped in ResultUtils type
+ * @returns A ResultUtils<T, E> representing the error outcome.
+ */
 export declare function errorToErrorResult(error: Error): ErrorResult;
 export type ErrorName = "UnhandledError" | "BadRequest" | "NotFound" | "ValidationError" | "NotAuthorized";
 export declare function toErrorResult(name: ErrorName, message: string, details?: Record<string, unknown>, code?: string, statusCode?: number): ErrorResult;
+export declare function toPagedResult<T>(data: T, page: number, pageSize: number, totalCount: number): Result<T>;
 declare const ResultUtils: {
     toResult: typeof toResult;
     errorToErrorResult: typeof errorToErrorResult;

package/result/resultUtils.js

@@ -5,6 +5,7 @@ exports.ResultUtils = void 0;
 exports.toResult = toResult;
 exports.errorToErrorResult = errorToErrorResult;
 exports.toErrorResult = toErrorResult;
+exports.toPagedResult = toPagedResult;
 const dateUtils_1 = require("../date/dateUtils");
 /**
  * Converts a promise into a ResultUtils type, wrapping its success and error outcomes.
@@ -15,6 +16,12 @@ const dateUtils_1 = require("../date/dateUtils");
 function toResult(data) {
     return { success: true, data: data };
 }
+/**
+ * Converts an error into a ResultUtils type, wrapping its error outcome.
+ *
+ * @param error - Error to be wrapped in ResultUtils type
+ * @returns A ResultUtils<T, E> representing the error outcome.
+ */
 function errorToErrorResult(error) {
     return { success: false, error: error };
 }
@@ -28,6 +35,9 @@ function toErrorResult(name, message, details, code, statusCode) {
             timestamp: dateUtils_1.DateUtils.formatDateTime(new Date())
         } };
 }
+function toPagedResult(data, page, pageSize, totalCount) {
+    return { success: true, data: data, page: page, pageSize: pageSize, totalCount: totalCount };
+}
 // Export everything as a single constant object
 const ResultUtils = {
     toResult,