@catbee/utils 0.0.1 → 0.0.2

package/build/src/utils/obj.utils.js

@@ -1,17 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.omit = exports.pick = exports.isObjEmpty = void 0;
+exports.isObjEmpty = isObjEmpty;
+exports.pick = pick;
+exports.omit = omit;
 exports.deepObjMerge = deepObjMerge;
 exports.flattenObject = flattenObject;
 exports.getValueByPath = getValueByPath;
+exports.setValueByPath = setValueByPath;
+exports.isEqual = isEqual;
+exports.filterObject = filterObject;
+exports.mapObject = mapObject;
+exports.deepFreeze = deepFreeze;
+exports.isObject = isObject;
+exports.getAllPaths = getAllPaths;
 /**
  * Checks whether the object has no own enumerable properties.
  *
  * @param {Record<any, any>} obj - The object to check.
  * @returns {boolean} True if the object is empty, false otherwise.
  */
-const isObjEmpty = (obj) => !!obj && typeof obj === "object" && Object.keys(obj).length === 0;
-exports.isObjEmpty = isObjEmpty;
+function isObjEmpty(obj) {
+    return !!obj && typeof obj === "object" && Object.keys(obj).length === 0;
+}
 /**
  * Returns a new object with only the specified keys picked.
  *
@@ -21,8 +31,9 @@ exports.isObjEmpty = isObjEmpty;
  * @param {K[]} keys - Keys to pick from the object.
  * @returns {Pick<T, K>} New object with picked keys.
  */
-const pick = (obj, keys) => Object.fromEntries(keys.map((key) => [key, obj[key]]));
-exports.pick = pick;
+function pick(obj, keys) {
+    return Object.fromEntries(keys.map((key) => [key, obj[key]]));
+}
 /**
  * Returns a new object with the specified keys omitted.
  *
@@ -32,8 +43,9 @@ exports.pick = pick;
  * @param {K[]} keys - Keys to omit from the object.
  * @returns {Omit<T, K>} New object without omitted keys.
  */
-const omit = (obj, keys) => Object.fromEntries(Object.entries(obj).filter(([key]) => !keys.includes(key)));
-exports.omit = omit;
+function omit(obj, keys) {
+    return Object.fromEntries(Object.entries(obj).filter(([key]) => !keys.includes(key)));
+}
 /**
  * Deeply merges two objects (mutates and returns the target object, not pure).
  *
@@ -100,4 +112,162 @@ function getValueByPath(obj, path) {
         .filter(Boolean); // remove empty strings
     return parts.reduce((acc, key) => acc === null || acc === void 0 ? void 0 : acc[key], obj);
 }
+/**
+ * Sets a value at a deeply nested key in an object using dot/bracket notation path.
+ * Creates intermediate objects and arrays as needed.
+ *
+ * @template T
+ * @param {T} obj - The object to modify.
+ * @param {string} path - String path using dot and/or bracket notation (e.g., 'user.friends[0].name').
+ * @param {any} value - The value to set at the path.
+ * @returns {T} The modified object.
+ */
+function setValueByPath(obj, path, value) {
+    if (!obj || typeof obj !== "object")
+        return obj;
+    // Convert path like "a.b[0].c" into ["a", "b", "0", "c"]
+    const parts = path
+        .replace(/\[(\d+)\]/g, ".$1") // convert [0] to .0
+        .split(".")
+        .filter(Boolean); // remove empty strings
+    // Handle empty path
+    if (parts.length === 0)
+        return obj;
+    let current = obj;
+    // Navigate to the parent of the target property
+    for (let i = 0; i < parts.length - 1; i++) {
+        const key = parts[i];
+        const isArrayIndex = !isNaN(Number(parts[i + 1]));
+        if (current[key] === undefined) {
+            // Create intermediate object or array based on next key type
+            current[key] = isArrayIndex ? [] : {};
+        }
+        current = current[key];
+    }
+    // Set the value at the final key
+    const finalKey = parts[parts.length - 1];
+    current[finalKey] = value;
+    return obj;
+}
+/**
+ * Performs a deep equality check between two objects.
+ *
+ * @param {any} a - First value to compare.
+ * @param {any} b - Second value to compare.
+ * @returns {boolean} True if values are deeply equal.
+ */
+function isEqual(a, b) {
+    // Check if primitives or references to the same object
+    if (a === b)
+        return true;
+    // Check if either is null/undefined or not an object
+    if (a == null ||
+        b == null ||
+        typeof a !== "object" ||
+        typeof b !== "object") {
+        return false;
+    }
+    // Handle Date objects
+    if (a instanceof Date && b instanceof Date) {
+        return a.getTime() === b.getTime();
+    }
+    // If one is Date but the other isn't
+    if (a instanceof Date || b instanceof Date) {
+        return false;
+    }
+    // Handle arrays
+    if (Array.isArray(a) && Array.isArray(b)) {
+        if (a.length !== b.length)
+            return false;
+        // Check each element
+        for (let i = 0; i < a.length; i++) {
+            if (!isEqual(a[i], b[i]))
+                return false;
+        }
+        return true;
+    }
+    // If one is Array but the other isn't
+    if (Array.isArray(a) || Array.isArray(b)) {
+        return false;
+    }
+    // Compare object keys
+    const keysA = Object.keys(a);
+    const keysB = Object.keys(b);
+    if (keysA.length !== keysB.length)
+        return false;
+    // Check if every key in A exists in B and has the same value
+    return keysA.every((key) => Object.prototype.hasOwnProperty.call(b, key) && isEqual(a[key], b[key]));
+}
+/**
+ * Filters object properties based on a predicate function.
+ *
+ * @template T
+ * @param {T} obj - The source object.
+ * @param {(value: any, key: string, obj: T) => boolean} predicate - Filter function.
+ * @returns {Partial<T>} New object with filtered properties.
+ */
+function filterObject(obj, predicate) {
+    return Object.fromEntries(Object.entries(obj).filter(([key, value]) => predicate(value, key, obj)));
+}
+/**
+ * Maps object values to new values using a mapping function.
+ *
+ * @template T
+ * @template U
+ * @param {T} obj - The source object.
+ * @param {(value: any, key: string, obj: T) => U} mapFn - Mapping function.
+ * @returns {Record<keyof T, U>} New object with mapped values.
+ */
+function mapObject(obj, mapFn) {
+    return Object.fromEntries(Object.entries(obj).map(([key, value]) => [key, mapFn(value, key, obj)]));
+}
+/**
+ * Recursively freezes an object and all its properties.
+ * Makes an object immutable.
+ *
+ * @template T
+ * @param {T} obj - The object to freeze.
+ * @returns {Readonly<T>} The frozen object.
+ */
+function deepFreeze(obj) {
+    // Freeze primitive properties
+    Object.freeze(obj);
+    // Recursively freeze nested objects
+    for (const prop of Object.getOwnPropertyNames(obj)) {
+        const value = obj[prop];
+        if (value !== null &&
+            typeof value === "object" &&
+            !Object.isFrozen(value)) {
+            deepFreeze(value);
+        }
+    }
+    return obj;
+}
+/**
+ * Safely checks if a value is an object (not null, not array).
+ *
+ * @param {unknown} value - Value to check.
+ * @returns {boolean} True if value is a non-null, non-array object.
+ */
+function isObject(value) {
+    return value !== null && typeof value === "object" && !Array.isArray(value);
+}
+/**
+ * Gets all paths in an object using dot notation.
+ *
+ * @param {Record<string, any>} obj - Object to analyze.
+ * @param {string} [parentPath=""] - Internal param for recursion.
+ * @returns {string[]} Array of all paths in dot notation.
+ */
+function getAllPaths(obj, parentPath = "") {
+    if (!isObject(obj))
+        return [];
+    return Object.entries(obj).flatMap(([key, value]) => {
+        const currentPath = parentPath ? `${parentPath}.${key}` : key;
+        if (isObject(value)) {
+            return [currentPath, ...getAllPaths(value, currentPath)];
+        }
+        return [currentPath];
+    });
+}
 //# sourceMappingURL=obj.utils.js.map

package/build/src/utils/obj.utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"obj.utils.js","sourceRoot":"","sources":["../../../src/utils/obj.utils.ts"],"names":[],"mappings":";;;AAiDA,oCA0BC;AAUD,sCAkBC;AAUD,wCAUC;AA3HD;;;;;GAKG;AACI,MAAM,UAAU,GAAG,CAAC,GAAqB,EAAW,EAAE,CAC3D,CAAC,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;AADvD,QAAA,UAAU,cAC6C;AAEpE;;;;;;;;GAQG;AACI,MAAM,IAAI,GAAG,CAClB,GAAM,EACN,IAAS,EACG,EAAE,CACd,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAe,CAAC;AAJ1D,QAAA,IAAI,QAIsD;AAEvE;;;;;;;;GAQG;AACI,MAAM,IAAI,GAAG,CAClB,GAAM,EACN,IAAS,EACG,EAAE,CACd,MAAM,CAAC,WAAW,CAChB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAQ,CAAC,CAAC,CAClD,CAAC;AANL,QAAA,IAAI,QAMC;AAElB;;;;;;;GAOG;AACH,SAAgB,YAAY,CAC1B,MAAS,EACT,MAAkB;IAElB,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;QACzB,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC9B,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAE9B,IACE,SAAS;YACT,OAAO,SAAS,KAAK,QAAQ;YAC7B,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EACzB,CAAC;YACD,IACE,CAAC,SAAS;gBACV,OAAO,SAAS,KAAK,QAAQ;gBAC7B,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EACxB,CAAC;gBACD,MAAM,CAAC,GAAG,CAAC,GAAG,EAAS,CAAC;YAC1B,CAAC;YACD,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,SAAgB,CAAC,CAAC;QAC9C,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,GAAG,CAAC,GAAG,SAAwC,CAAC;QACzD,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,aAAa,CAC3B,GAAM,EACN,MAAM,GAAG,EAAE;IAEX,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAC/B,CAAC,GAAwB,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACzC,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;QAEjD,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAChE,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;QACnD,CAAC;aAAM,CAAC;YACN,GAAG,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;QACtB,CAAC;QAED,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAE,CACH,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAmB,GAAM,EAAE,IAAY;IACnE,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IAEtD,yDAAyD;IACzD,MAAM,KAAK,GAAG,IAAI;SACf,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC,oBAAoB;SACjD,KAAK,CAAC,GAAG,CAAC;SACV,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,uBAAuB;IAE3C,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,GAAQ,EAAE,GAAW,EAAE,EAAE,CAAC,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAG,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;AAClE,CAAC","sourcesContent":["/**\n * Checks whether the object has no own enumerable properties.\n *\n * @param {Record<any, any>} obj - The object to check.\n * @returns {boolean} True if the object is empty, false otherwise.\n */\nexport const isObjEmpty = (obj: Record<any, any>): boolean =>\n  !!obj && typeof obj === \"object\" && Object.keys(obj).length === 0;\n\n/**\n * Returns a new object with only the specified keys picked.\n *\n * @template T\n * @template K\n * @param {T} obj - The source object.\n * @param {K[]} keys - Keys to pick from the object.\n * @returns {Pick<T, K>} New object with picked keys.\n */\nexport const pick = <T extends object, K extends keyof T>(\n  obj: T,\n  keys: K[],\n): Pick<T, K> =>\n  Object.fromEntries(keys.map((key) => [key, obj[key]])) as Pick<T, K>;\n\n/**\n * Returns a new object with the specified keys omitted.\n *\n * @template T\n * @template K\n * @param {T} obj - The source object.\n * @param {K[]} keys - Keys to omit from the object.\n * @returns {Omit<T, K>} New object without omitted keys.\n */\nexport const omit = <T extends object, K extends keyof T>(\n  obj: T,\n  keys: K[],\n): Omit<T, K> =>\n  Object.fromEntries(\n    Object.entries(obj).filter(([key]) => !keys.includes(key as K)),\n  ) as Omit<T, K>;\n\n/**\n * Deeply merges two objects (mutates and returns the target object, not pure).\n *\n * @template T\n * @param {T} target - The object to merge into (will be mutated).\n * @param {Partial<T>} source - The object to merge from.\n * @returns {T} The merged object (same as target).\n */\nexport function deepObjMerge<T extends Record<string, any>>(\n  target: T,\n  source: Partial<T>,\n): T {\n  for (const key in source) {\n    const sourceVal = source[key];\n    const targetVal = target[key];\n\n    if (\n      sourceVal &&\n      typeof sourceVal === \"object\" &&\n      !Array.isArray(sourceVal)\n    ) {\n      if (\n        !targetVal ||\n        typeof targetVal !== \"object\" ||\n        Array.isArray(targetVal)\n      ) {\n        target[key] = {} as any;\n      }\n      deepObjMerge(target[key], sourceVal as any);\n    } else {\n      target[key] = sourceVal as T[Extract<keyof T, string>];\n    }\n  }\n  return target;\n}\n\n/**\n * Flattens a nested object using dot notation for keys (e.g., `{a: {b: 1}}` → `{ \"a.b\": 1 }`).\n *\n * @template T\n * @param {T} obj - The object to flatten.\n * @param {string} [prefix=\"\"] - Optional prefix for nested keys (used internally).\n * @returns {Record<string, any>} A new object with flattened keys.\n */\nexport function flattenObject<T extends Record<string, any>>(\n  obj: T,\n  prefix = \"\",\n): Record<string, any> {\n  return Object.entries(obj).reduce(\n    (acc: Record<string, any>, [key, value]) => {\n      const newKey = prefix ? `${prefix}.${key}` : key;\n\n      if (value && typeof value === \"object\" && !Array.isArray(value)) {\n        Object.assign(acc, flattenObject(value, newKey));\n      } else {\n        acc[newKey] = value;\n      }\n\n      return acc;\n    },\n    {},\n  );\n}\n\n/**\n * Safely gets the value of a deeply nested key in an object using dot/bracket notation path.\n *\n * @template T\n * @param {T} obj - The object to extract from.\n * @param {string} path - String path using dot and/or bracket notation (e.g., 'user.friends[0].name').\n * @returns {any} The value at the given path, or undefined if not found.\n */\nexport function getValueByPath<T extends object>(obj: T, path: string) {\n  if (!obj || typeof obj !== \"object\") return undefined;\n\n  // Convert path like \"a.b[0].c\" into [\"a\", \"b\", \"0\", \"c\"]\n  const parts = path\n    .replace(/\\[(\\d+)\\]/g, \".$1\") // convert [0] to .0\n    .split(\".\")\n    .filter(Boolean); // remove empty strings\n\n  return parts.reduce((acc: any, key: string) => acc?.[key], obj);\n}\n"]}
+{"version":3,"file":"obj.utils.js","sourceRoot":"","sources":["../../../src/utils/obj.utils.ts"],"names":[],"mappings":";;AAMA,gCAEC;AAWD,oBAKC;AAWD,oBAOC;AAUD,oCA0BC;AAUD,sCAkBC;AAUD,wCAUC;AAYD,wCAoCC;AASD,0BAoDC;AAUD,oCAOC;AAWD,8BAOC;AAUD,gCAiBC;AAQD,4BAEC;AASD,kCAeC;AA3UD;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,GAAqB;IAC9C,OAAO,CAAC,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;AAC3E,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,IAAI,CAClB,GAAM,EACN,IAAS;IAET,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAe,CAAC;AAC9E,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,IAAI,CAClB,GAAM,EACN,IAAS;IAET,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAQ,CAAC,CAAC,CAClD,CAAC;AAClB,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,YAAY,CAC1B,MAAS,EACT,MAAkB;IAElB,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;QACzB,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC9B,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAE9B,IACE,SAAS;YACT,OAAO,SAAS,KAAK,QAAQ;YAC7B,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EACzB,CAAC;YACD,IACE,CAAC,SAAS;gBACV,OAAO,SAAS,KAAK,QAAQ;gBAC7B,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EACxB,CAAC;gBACD,MAAM,CAAC,GAAG,CAAC,GAAG,EAAS,CAAC;YAC1B,CAAC;YACD,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,SAAgB,CAAC,CAAC;QAC9C,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,GAAG,CAAC,GAAG,SAAwC,CAAC;QACzD,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,aAAa,CAC3B,GAAM,EACN,MAAM,GAAG,EAAE;IAEX,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAC/B,CAAC,GAAwB,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACzC,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;QAEjD,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAChE,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;QACnD,CAAC;aAAM,CAAC;YACN,GAAG,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;QACtB,CAAC;QAED,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAE,CACH,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAmB,GAAM,EAAE,IAAY;IACnE,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IAEtD,yDAAyD;IACzD,MAAM,KAAK,GAAG,IAAI;SACf,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC,oBAAoB;SACjD,KAAK,CAAC,GAAG,CAAC;SACV,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,uBAAuB;IAE3C,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,GAAQ,EAAE,GAAW,EAAE,EAAE,CAAC,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAG,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;AAClE,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,cAAc,CAC5B,GAAM,EACN,IAAY,EACZ,KAAU;IAEV,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,GAAG,CAAC;IAEhD,yDAAyD;IACzD,MAAM,KAAK,GAAG,IAAI;SACf,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC,oBAAoB;SACjD,KAAK,CAAC,GAAG,CAAC;SACV,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,uBAAuB;IAE3C,oBAAoB;IACpB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,GAAG,CAAC;IAEnC,IAAI,OAAO,GAAQ,GAAG,CAAC;IAEvB,gDAAgD;IAChD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1C,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACrB,MAAM,YAAY,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAElD,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;YAC/B,6DAA6D;YAC7D,OAAO,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACxC,CAAC;QAED,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAED,iCAAiC;IACjC,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACzC,OAAO,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;IAE1B,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,OAAO,CAAC,CAAM,EAAE,CAAM;IACpC,uDAAuD;IACvD,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAEzB,qDAAqD;IACrD,IACE,CAAC,IAAI,IAAI;QACT,CAAC,IAAI,IAAI;QACT,OAAO,CAAC,KAAK,QAAQ;QACrB,OAAO,CAAC,KAAK,QAAQ,EACrB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,sBAAsB;IACtB,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,IAAI,EAAE,CAAC;QAC3C,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC;IACrC,CAAC;IAED,qCAAqC;IACrC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,IAAI,EAAE,CAAC;QAC3C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IAChB,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QACzC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAExC,qBAAqB;QACrB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAClC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;gBAAE,OAAO,KAAK,CAAC;QACzC,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,sCAAsC;IACtC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QACzC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,sBAAsB;IACtB,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC7B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAE7B,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IAEhD,6DAA6D;IAC7D,OAAO,KAAK,CAAC,KAAK,CAChB,CAAC,GAAG,EAAE,EAAE,CACN,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAC1E,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,YAAY,CAC1B,GAAM,EACN,SAAuD;IAEvD,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAC3D,CAAC;AAClB,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,SAAS,CACvB,GAAM,EACN,KAA6C;IAE7C,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CACnD,CAAC;AAC1B,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,UAAU,CAAmB,GAAM;IACjD,8BAA8B;IAC9B,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAEnB,oCAAoC;IACpC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC;QACnD,MAAM,KAAK,GAAI,GAAW,CAAC,IAAI,CAAC,CAAC;QACjC,IACE,KAAK,KAAK,IAAI;YACd,OAAO,KAAK,KAAK,QAAQ;YACzB,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EACvB,CAAC;YACD,UAAU,CAAC,KAAK,CAAC,CAAC;QACpB,CAAC;IACH,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;GAKG;AACH,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,WAAW,CACzB,GAAwB,EACxB,aAAqB,EAAE;IAEvB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,EAAE,CAAC;IAE9B,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAClD,MAAM,WAAW,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;QAE9D,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACpB,OAAO,CAAC,WAAW,EAAE,GAAG,WAAW,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC;QAC3D,CAAC;QAED,OAAO,CAAC,WAAW,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["/**\n * Checks whether the object has no own enumerable properties.\n *\n * @param {Record<any, any>} obj - The object to check.\n * @returns {boolean} True if the object is empty, false otherwise.\n */\nexport function isObjEmpty(obj: Record<any, any>): boolean {\n  return !!obj && typeof obj === \"object\" && Object.keys(obj).length === 0;\n}\n\n/**\n * Returns a new object with only the specified keys picked.\n *\n * @template T\n * @template K\n * @param {T} obj - The source object.\n * @param {K[]} keys - Keys to pick from the object.\n * @returns {Pick<T, K>} New object with picked keys.\n */\nexport function pick<T extends object, K extends keyof T>(\n  obj: T,\n  keys: K[],\n): Pick<T, K> {\n  return Object.fromEntries(keys.map((key) => [key, obj[key]])) as Pick<T, K>;\n}\n\n/**\n * Returns a new object with the specified keys omitted.\n *\n * @template T\n * @template K\n * @param {T} obj - The source object.\n * @param {K[]} keys - Keys to omit from the object.\n * @returns {Omit<T, K>} New object without omitted keys.\n */\nexport function omit<T extends object, K extends keyof T>(\n  obj: T,\n  keys: K[],\n): Omit<T, K> {\n  return Object.fromEntries(\n    Object.entries(obj).filter(([key]) => !keys.includes(key as K)),\n  ) as Omit<T, K>;\n}\n\n/**\n * Deeply merges two objects (mutates and returns the target object, not pure).\n *\n * @template T\n * @param {T} target - The object to merge into (will be mutated).\n * @param {Partial<T>} source - The object to merge from.\n * @returns {T} The merged object (same as target).\n */\nexport function deepObjMerge<T extends Record<string, any>>(\n  target: T,\n  source: Partial<T>,\n): T {\n  for (const key in source) {\n    const sourceVal = source[key];\n    const targetVal = target[key];\n\n    if (\n      sourceVal &&\n      typeof sourceVal === \"object\" &&\n      !Array.isArray(sourceVal)\n    ) {\n      if (\n        !targetVal ||\n        typeof targetVal !== \"object\" ||\n        Array.isArray(targetVal)\n      ) {\n        target[key] = {} as any;\n      }\n      deepObjMerge(target[key], sourceVal as any);\n    } else {\n      target[key] = sourceVal as T[Extract<keyof T, string>];\n    }\n  }\n  return target;\n}\n\n/**\n * Flattens a nested object using dot notation for keys (e.g., `{a: {b: 1}}` → `{ \"a.b\": 1 }`).\n *\n * @template T\n * @param {T} obj - The object to flatten.\n * @param {string} [prefix=\"\"] - Optional prefix for nested keys (used internally).\n * @returns {Record<string, any>} A new object with flattened keys.\n */\nexport function flattenObject<T extends Record<string, any>>(\n  obj: T,\n  prefix = \"\",\n): Record<string, any> {\n  return Object.entries(obj).reduce(\n    (acc: Record<string, any>, [key, value]) => {\n      const newKey = prefix ? `${prefix}.${key}` : key;\n\n      if (value && typeof value === \"object\" && !Array.isArray(value)) {\n        Object.assign(acc, flattenObject(value, newKey));\n      } else {\n        acc[newKey] = value;\n      }\n\n      return acc;\n    },\n    {},\n  );\n}\n\n/**\n * Safely gets the value of a deeply nested key in an object using dot/bracket notation path.\n *\n * @template T\n * @param {T} obj - The object to extract from.\n * @param {string} path - String path using dot and/or bracket notation (e.g., 'user.friends[0].name').\n * @returns {any} The value at the given path, or undefined if not found.\n */\nexport function getValueByPath<T extends object>(obj: T, path: string) {\n  if (!obj || typeof obj !== \"object\") return undefined;\n\n  // Convert path like \"a.b[0].c\" into [\"a\", \"b\", \"0\", \"c\"]\n  const parts = path\n    .replace(/\\[(\\d+)\\]/g, \".$1\") // convert [0] to .0\n    .split(\".\")\n    .filter(Boolean); // remove empty strings\n\n  return parts.reduce((acc: any, key: string) => acc?.[key], obj);\n}\n\n/**\n * Sets a value at a deeply nested key in an object using dot/bracket notation path.\n * Creates intermediate objects and arrays as needed.\n *\n * @template T\n * @param {T} obj - The object to modify.\n * @param {string} path - String path using dot and/or bracket notation (e.g., 'user.friends[0].name').\n * @param {any} value - The value to set at the path.\n * @returns {T} The modified object.\n */\nexport function setValueByPath<T extends object>(\n  obj: T,\n  path: string,\n  value: any,\n): T {\n  if (!obj || typeof obj !== \"object\") return obj;\n\n  // Convert path like \"a.b[0].c\" into [\"a\", \"b\", \"0\", \"c\"]\n  const parts = path\n    .replace(/\\[(\\d+)\\]/g, \".$1\") // convert [0] to .0\n    .split(\".\")\n    .filter(Boolean); // remove empty strings\n\n  // Handle empty path\n  if (parts.length === 0) return obj;\n\n  let current: any = obj;\n\n  // Navigate to the parent of the target property\n  for (let i = 0; i < parts.length - 1; i++) {\n    const key = parts[i];\n    const isArrayIndex = !isNaN(Number(parts[i + 1]));\n\n    if (current[key] === undefined) {\n      // Create intermediate object or array based on next key type\n      current[key] = isArrayIndex ? [] : {};\n    }\n\n    current = current[key];\n  }\n\n  // Set the value at the final key\n  const finalKey = parts[parts.length - 1];\n  current[finalKey] = value;\n\n  return obj;\n}\n\n/**\n * Performs a deep equality check between two objects.\n *\n * @param {any} a - First value to compare.\n * @param {any} b - Second value to compare.\n * @returns {boolean} True if values are deeply equal.\n */\nexport function isEqual(a: any, b: any): boolean {\n  // Check if primitives or references to the same object\n  if (a === b) return true;\n\n  // Check if either is null/undefined or not an object\n  if (\n    a == null ||\n    b == null ||\n    typeof a !== \"object\" ||\n    typeof b !== \"object\"\n  ) {\n    return false;\n  }\n\n  // Handle Date objects\n  if (a instanceof Date && b instanceof Date) {\n    return a.getTime() === b.getTime();\n  }\n\n  // If one is Date but the other isn't\n  if (a instanceof Date || b instanceof Date) {\n    return false;\n  }\n\n  // Handle arrays\n  if (Array.isArray(a) && Array.isArray(b)) {\n    if (a.length !== b.length) return false;\n\n    // Check each element\n    for (let i = 0; i < a.length; i++) {\n      if (!isEqual(a[i], b[i])) return false;\n    }\n\n    return true;\n  }\n\n  // If one is Array but the other isn't\n  if (Array.isArray(a) || Array.isArray(b)) {\n    return false;\n  }\n\n  // Compare object keys\n  const keysA = Object.keys(a);\n  const keysB = Object.keys(b);\n\n  if (keysA.length !== keysB.length) return false;\n\n  // Check if every key in A exists in B and has the same value\n  return keysA.every(\n    (key) =>\n      Object.prototype.hasOwnProperty.call(b, key) && isEqual(a[key], b[key]),\n  );\n}\n\n/**\n * Filters object properties based on a predicate function.\n *\n * @template T\n * @param {T} obj - The source object.\n * @param {(value: any, key: string, obj: T) => boolean} predicate - Filter function.\n * @returns {Partial<T>} New object with filtered properties.\n */\nexport function filterObject<T extends object>(\n  obj: T,\n  predicate: (value: any, key: string, obj: T) => boolean,\n): Partial<T> {\n  return Object.fromEntries(\n    Object.entries(obj).filter(([key, value]) => predicate(value, key, obj)),\n  ) as Partial<T>;\n}\n\n/**\n * Maps object values to new values using a mapping function.\n *\n * @template T\n * @template U\n * @param {T} obj - The source object.\n * @param {(value: any, key: string, obj: T) => U} mapFn - Mapping function.\n * @returns {Record<keyof T, U>} New object with mapped values.\n */\nexport function mapObject<T extends object, U>(\n  obj: T,\n  mapFn: (value: any, key: string, obj: T) => U,\n): Record<keyof T, U> {\n  return Object.fromEntries(\n    Object.entries(obj).map(([key, value]) => [key, mapFn(value, key, obj)]),\n  ) as Record<keyof T, U>;\n}\n\n/**\n * Recursively freezes an object and all its properties.\n * Makes an object immutable.\n *\n * @template T\n * @param {T} obj - The object to freeze.\n * @returns {Readonly<T>} The frozen object.\n */\nexport function deepFreeze<T extends object>(obj: T): Readonly<T> {\n  // Freeze primitive properties\n  Object.freeze(obj);\n\n  // Recursively freeze nested objects\n  for (const prop of Object.getOwnPropertyNames(obj)) {\n    const value = (obj as any)[prop];\n    if (\n      value !== null &&\n      typeof value === \"object\" &&\n      !Object.isFrozen(value)\n    ) {\n      deepFreeze(value);\n    }\n  }\n\n  return obj;\n}\n\n/**\n * Safely checks if a value is an object (not null, not array).\n *\n * @param {unknown} value - Value to check.\n * @returns {boolean} True if value is a non-null, non-array object.\n */\nexport function isObject(value: unknown): value is Record<string, any> {\n  return value !== null && typeof value === \"object\" && !Array.isArray(value);\n}\n\n/**\n * Gets all paths in an object using dot notation.\n *\n * @param {Record<string, any>} obj - Object to analyze.\n * @param {string} [parentPath=\"\"] - Internal param for recursion.\n * @returns {string[]} Array of all paths in dot notation.\n */\nexport function getAllPaths(\n  obj: Record<string, any>,\n  parentPath: string = \"\",\n): string[] {\n  if (!isObject(obj)) return [];\n\n  return Object.entries(obj).flatMap(([key, value]) => {\n    const currentPath = parentPath ? `${parentPath}.${key}` : key;\n\n    if (isObject(value)) {\n      return [currentPath, ...getAllPaths(value, currentPath)];\n    }\n\n    return [currentPath];\n  });\n}\n"]}

package/build/src/utils/response.utils.d.ts

@@ -45,4 +45,105 @@ export declare class ErrorResponse extends Error implements Omit<ApiResponse<nev
      */
     constructor(message: string, status?: number);
 }
+/**
+ * Response with paginated data extending the standard success response.
+ * Useful for APIs that return large collections of data.
+ *
+ * @typeParam T - The shape of each item in the paginated collection.
+ */
+export declare class PaginatedResponse<T> extends SuccessResponse<T[]> {
+    /** Total number of items across all pages */
+    total: number;
+    /** Current page number (1-based) */
+    page: number;
+    /** Number of items per page */
+    pageSize: number;
+    /** Total number of pages */
+    totalPages: number;
+    /** Whether there's a next page available */
+    hasNext: boolean;
+    /** Whether there's a previous page available */
+    hasPrevious: boolean;
+    /**
+     * Constructs a new paginated response.
+     *
+     * @param {T[]} items - The current page of items.
+     * @param {Object} pagination - Pagination information.
+     * @param {number} pagination.total - Total number of items across all pages.
+     * @param {number} pagination.page - Current page number (1-based).
+     * @param {number} pagination.pageSize - Number of items per page.
+     * @param {string} [message="Success"] - Optional custom message.
+     */
+    constructor(items: T[], pagination: {
+        total: number;
+        page: number;
+        pageSize: number;
+    }, message?: string);
+}
+/**
+ * Specialized response for operations that don't return data (HTTP 204).
+ */
+export declare class NoContentResponse extends SuccessResponse<null> {
+    /**
+     * Constructs a new no-content response.
+     *
+     * @param {string} [message="Operation completed successfully"] - Optional custom message.
+     */
+    constructor(message?: string);
+}
+/**
+ * Specialized response for redirects.
+ */
+export declare class RedirectResponse {
+    /** The URL to redirect to */
+    redirectUrl: string;
+    /** HTTP status code for the redirect (301, 302, 303, 307, 308) */
+    statusCode: number;
+    /** Whether the response is a redirect */
+    isRedirect: boolean;
+    /** Unique identifier for this response */
+    requestId: string;
+    /**
+     * Constructs a new redirect response.
+     *
+     * @param {string} url - The URL to redirect to.
+     * @param {number} [statusCode=302] - HTTP status code for the redirect.
+     */
+    constructor(url: string, statusCode?: number);
+}
+/**
+ * Creates a standard success response.
+ *
+ * @typeParam T - The shape of the data returned in the response.
+ * @param {T} data - The data to include in the response.
+ * @param {string} [message="Success"] - Optional custom message.
+ * @returns {SuccessResponse<T>} A properly formatted success response.
+ */
+export declare function createSuccessResponse<T>(data: T, message?: string): SuccessResponse<T>;
+/**
+ * Creates a standard error response.
+ *
+ * @param {string} message - The error message.
+ * @param {number} [statusCode=500] - HTTP status code for the error.
+ * @returns {ErrorResponse} A properly formatted error response.
+ */
+export declare function createErrorResponse(message: string, statusCode?: number): ErrorResponse;
+/**
+ * Creates a paginated response from array data.
+ *
+ * @typeParam T - The shape of each item in the collection.
+ * @param {T[]} allItems - The complete array of items to paginate.
+ * @param {number} page - The requested page (1-based).
+ * @param {number} pageSize - The number of items per page.
+ * @param {string} [message="Success"] - Optional custom message.
+ * @returns {PaginatedResponse<T>} A properly formatted paginated response.
+ */
+export declare function createPaginatedResponse<T>(allItems: T[], page: number, pageSize: number, message?: string): PaginatedResponse<T>;
+/**
+ * Adapter to convert API responses to Express.js response format.
+ *
+ * @param {any} res - Express response object.
+ * @param {SuccessResponse<any> | ErrorResponse | RedirectResponse} apiResponse - API response instance.
+ */
+export declare function sendResponse(res: any, apiResponse: SuccessResponse<any> | ErrorResponse | RedirectResponse): void;
 //# sourceMappingURL=response.utils.d.ts.map

package/build/src/utils/response.utils.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ErrorResponse = exports.SuccessResponse = void 0;
+exports.RedirectResponse = exports.NoContentResponse = exports.PaginatedResponse = exports.ErrorResponse = exports.SuccessResponse = void 0;
+exports.createSuccessResponse = createSuccessResponse;
+exports.createErrorResponse = createErrorResponse;
+exports.createPaginatedResponse = createPaginatedResponse;
+exports.sendResponse = sendResponse;
 const crypto_1 = require("crypto");
 const context_store_utils_1 = require("./context-store.utils");
 /**
@@ -60,4 +64,145 @@ class ErrorResponse extends Error {
     }
 }
 exports.ErrorResponse = ErrorResponse;
+/**
+ * Response with paginated data extending the standard success response.
+ * Useful for APIs that return large collections of data.
+ *
+ * @typeParam T - The shape of each item in the paginated collection.
+ */
+class PaginatedResponse extends SuccessResponse {
+    /**
+     * Constructs a new paginated response.
+     *
+     * @param {T[]} items - The current page of items.
+     * @param {Object} pagination - Pagination information.
+     * @param {number} pagination.total - Total number of items across all pages.
+     * @param {number} pagination.page - Current page number (1-based).
+     * @param {number} pagination.pageSize - Number of items per page.
+     * @param {string} [message="Success"] - Optional custom message.
+     */
+    constructor(items, pagination, message = "Success") {
+        super(message, items);
+        this.total = pagination.total;
+        this.page = pagination.page;
+        this.pageSize = pagination.pageSize;
+        this.totalPages = Math.ceil(this.total / this.pageSize);
+        this.hasNext = this.page < this.totalPages;
+        this.hasPrevious = this.page > 1;
+    }
+}
+exports.PaginatedResponse = PaginatedResponse;
+/**
+ * Specialized response for operations that don't return data (HTTP 204).
+ */
+class NoContentResponse extends SuccessResponse {
+    /**
+     * Constructs a new no-content response.
+     *
+     * @param {string} [message="Operation completed successfully"] - Optional custom message.
+     */
+    constructor(message = "Operation completed successfully") {
+        super(message, null);
+    }
+}
+exports.NoContentResponse = NoContentResponse;
+/**
+ * Specialized response for redirects.
+ */
+class RedirectResponse {
+    /**
+     * Constructs a new redirect response.
+     *
+     * @param {string} url - The URL to redirect to.
+     * @param {number} [statusCode=302] - HTTP status code for the redirect.
+     */
+    constructor(url, statusCode = 302) {
+        var _a;
+        /** Whether the response is a redirect */
+        this.isRedirect = true;
+        /** Unique identifier for this response */
+        this.requestId = (_a = (0, context_store_utils_1.getRequestId)()) !== null && _a !== void 0 ? _a : (0, crypto_1.randomUUID)();
+        this.redirectUrl = url;
+        this.statusCode = statusCode;
+    }
+}
+exports.RedirectResponse = RedirectResponse;
+/**
+ * Creates a standard success response.
+ *
+ * @typeParam T - The shape of the data returned in the response.
+ * @param {T} data - The data to include in the response.
+ * @param {string} [message="Success"] - Optional custom message.
+ * @returns {SuccessResponse<T>} A properly formatted success response.
+ */
+function createSuccessResponse(data, message = "Success") {
+    return new SuccessResponse(message, data);
+}
+/**
+ * Creates a standard error response.
+ *
+ * @param {string} message - The error message.
+ * @param {number} [statusCode=500] - HTTP status code for the error.
+ * @returns {ErrorResponse} A properly formatted error response.
+ */
+function createErrorResponse(message, statusCode = 500) {
+    return new ErrorResponse(message, statusCode);
+}
+/**
+ * Creates a paginated response from array data.
+ *
+ * @typeParam T - The shape of each item in the collection.
+ * @param {T[]} allItems - The complete array of items to paginate.
+ * @param {number} page - The requested page (1-based).
+ * @param {number} pageSize - The number of items per page.
+ * @param {string} [message="Success"] - Optional custom message.
+ * @returns {PaginatedResponse<T>} A properly formatted paginated response.
+ */
+function createPaginatedResponse(allItems, page, pageSize, message = "Success") {
+    // Ensure valid pagination parameters
+    const validPage = Math.max(1, page);
+    const validPageSize = Math.max(1, pageSize);
+    // Calculate slice indices
+    const startIndex = (validPage - 1) * validPageSize;
+    const endIndex = startIndex + validPageSize;
+    // Get current page items
+    const pageItems = allItems.slice(startIndex, endIndex);
+    return new PaginatedResponse(pageItems, {
+        total: allItems.length,
+        page: validPage,
+        pageSize: validPageSize,
+    }, message);
+}
+/**
+ * Adapter to convert API responses to Express.js response format.
+ *
+ * @param {any} res - Express response object.
+ * @param {SuccessResponse<any> | ErrorResponse | RedirectResponse} apiResponse - API response instance.
+ */
+function sendResponse(res, apiResponse) {
+    // Handle redirects
+    if ("redirectUrl" in apiResponse) {
+        res.redirect(apiResponse.statusCode, apiResponse.redirectUrl);
+        return;
+    }
+    // Handle errors
+    if ("error" in apiResponse && apiResponse.error) {
+        const errorResponse = apiResponse;
+        res.status(errorResponse.status).json({
+            error: true,
+            message: errorResponse.message,
+            timestamp: errorResponse.timestamp,
+            requestId: errorResponse.requestId,
+        });
+        return;
+    }
+    // Handle success responses
+    const successResponse = apiResponse;
+    // No content (204) shouldn't return a body
+    if (successResponse instanceof NoContentResponse) {
+        res.status(204).end();
+        return;
+    }
+    res.status(200).json(successResponse);
+}
 //# sourceMappingURL=response.utils.js.map

package/build/src/utils/response.utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"response.utils.js","sourceRoot":"","sources":["../../../src/utils/response.utils.ts"],"names":[],"mappings":";;;AAAA,mCAAoC;AAEpC,+DAAqD;AAErD;;;;;GAKG;AACH,MAAa,eAAe;IAgB1B;;;;;OAKG;IACH,YAAY,OAAe,EAAE,IAAQ;;QArBrC,sDAAsD;QACtD,YAAO,GAAW,SAAS,CAAC;QAE5B,2EAA2E;QAC3E,UAAK,GAAY,KAAK,CAAC;QAEvB,yCAAyC;QACzC,SAAI,GAAa,IAAI,CAAC;QAEtB,gEAAgE;QAChE,cAAS,GAAW,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAE7C,uEAAuE;QACvE,cAAS,GAAW,MAAA,IAAA,kCAAY,GAAE,mCAAI,IAAA,mBAAU,GAAE,CAAC;QASjD,IAAI,OAAO;YAAE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACpC,IAAI,CAAC,IAAI,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,IAAI,CAAC;IAC3B,CAAC;CACF;AA1BD,0CA0BC;AAED;;;GAGG;AACH,MAAa,aACX,SAAQ,KAAK;IAeb;;;;;OAKG;IACH,YAAY,OAAe,EAAE,SAAiB,GAAG;;QAC/C,KAAK,CAAC,OAAO,CAAC,CAAC;QAhBjB,oDAAoD;QACpD,UAAK,GAAY,IAAI,CAAC;QAEtB,wDAAwD;QACxD,cAAS,GAAW,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAE7C,iDAAiD;QACjD,cAAS,GAAW,MAAA,IAAA,kCAAY,GAAE,mCAAI,IAAA,mBAAU,GAAE,CAAC;QAUjD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAClC,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;CACF;AA5BD,sCA4BC","sourcesContent":["import { randomUUID } from \"crypto\";\nimport { ApiResponse } from \"../types/api-response\";\nimport { getRequestId } from \"./context-store.utils\";\n\n/**\n * Standard HTTP response wrapper for successful responses.\n * Implements the `ApiResponse<T>` interface and sets default values.\n *\n * @typeParam T - The shape of the data returned in the response.\n */\nexport class SuccessResponse<T> implements ApiResponse<T> {\n  /** Message describing the result of the operation. */\n  message: string = \"Success\";\n\n  /** Whether the response is an error. Always false in success responses. */\n  error: boolean = false;\n\n  /** The payload returned from the API. */\n  data: T | null = null;\n\n  /** Timestamp when the response was generated, in ISO format. */\n  timestamp: string = new Date().toISOString();\n\n  /** Unique identifier for this response, useful for request tracing. */\n  requestId: string = getRequestId() ?? randomUUID();\n\n  /**\n   * Constructs a new success response.\n   *\n   * @param {string} message - Optional message to override the default.\n   * @param {T} [data] - Optional data payload.\n   */\n  constructor(message: string, data?: T) {\n    if (message) this.message = message;\n    this.data = data ?? null;\n  }\n}\n\n/**\n * Wrapper for error responses that extends the native `Error` object.\n * Implements `ApiResponse` but omits the `data` field (which should not be present in errors).\n */\nexport class ErrorResponse\n  extends Error\n  implements Omit<ApiResponse<never>, \"data\">\n{\n  /** HTTP status code associated with the error (e.g., 404, 500). */\n  status: number;\n\n  /** Indicates that this is an error. Always true. */\n  error: boolean = true;\n\n  /** Timestamp when the error occurred, in ISO format. */\n  timestamp: string = new Date().toISOString();\n\n  /** Unique identifier for this error instance. */\n  requestId: string = getRequestId() ?? randomUUID();\n\n  /**\n   * Constructs a new error response.\n   *\n   * @param {string} message - The error message to display or log.\n   * @param {number} [status=500] - Optional HTTP status code (defaults to 500).\n   */\n  constructor(message: string, status: number = 500) {\n    super(message);\n    this.status = status;\n    this.name = this.constructor.name;\n    Error.captureStackTrace(this, this.constructor);\n  }\n}\n"]}
+{"version":3,"file":"response.utils.js","sourceRoot":"","sources":["../../../src/utils/response.utils.ts"],"names":[],"mappings":";;;AA8KA,sDAKC;AASD,kDAKC;AAYD,0DA0BC;AAQD,oCAgCC;AA/QD,mCAAoC;AAEpC,+DAAqD;AAErD;;;;;GAKG;AACH,MAAa,eAAe;IAgB1B;;;;;OAKG;IACH,YAAY,OAAe,EAAE,IAAQ;;QArBrC,sDAAsD;QACtD,YAAO,GAAW,SAAS,CAAC;QAE5B,2EAA2E;QAC3E,UAAK,GAAY,KAAK,CAAC;QAEvB,yCAAyC;QACzC,SAAI,GAAa,IAAI,CAAC;QAEtB,gEAAgE;QAChE,cAAS,GAAW,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAE7C,uEAAuE;QACvE,cAAS,GAAW,MAAA,IAAA,kCAAY,GAAE,mCAAI,IAAA,mBAAU,GAAE,CAAC;QASjD,IAAI,OAAO;YAAE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACpC,IAAI,CAAC,IAAI,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,IAAI,CAAC;IAC3B,CAAC;CACF;AA1BD,0CA0BC;AAED;;;GAGG;AACH,MAAa,aACX,SAAQ,KAAK;IAeb;;;;;OAKG;IACH,YAAY,OAAe,EAAE,SAAiB,GAAG;;QAC/C,KAAK,CAAC,OAAO,CAAC,CAAC;QAhBjB,oDAAoD;QACpD,UAAK,GAAY,IAAI,CAAC;QAEtB,wDAAwD;QACxD,cAAS,GAAW,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAE7C,iDAAiD;QACjD,cAAS,GAAW,MAAA,IAAA,kCAAY,GAAE,mCAAI,IAAA,mBAAU,GAAE,CAAC;QAUjD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAClC,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;CACF;AA5BD,sCA4BC;AAED;;;;;GAKG;AACH,MAAa,iBAAqB,SAAQ,eAAoB;IAmB5D;;;;;;;;;OASG;IACH,YACE,KAAU,EACV,UAA6D,EAC7D,UAAkB,SAAS;QAE3B,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAEtB,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;QAC9B,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QAEpC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QACxD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC;QAC3C,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;IACnC,CAAC;CACF;AA5CD,8CA4CC;AAED;;GAEG;AACH,MAAa,iBAAkB,SAAQ,eAAqB;IAC1D;;;;OAIG;IACH,YAAY,UAAkB,kCAAkC;QAC9D,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACvB,CAAC;CACF;AATD,8CASC;AAED;;GAEG;AACH,MAAa,gBAAgB;IAa3B;;;;;OAKG;IACH,YAAY,GAAW,EAAE,aAAqB,GAAG;;QAZjD,yCAAyC;QACzC,eAAU,GAAY,IAAI,CAAC;QAE3B,0CAA0C;QAC1C,cAAS,GAAW,MAAA,IAAA,kCAAY,GAAE,mCAAI,IAAA,mBAAU,GAAE,CAAC;QASjD,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;CACF;AAvBD,4CAuBC;AAED;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CACnC,IAAO,EACP,UAAkB,SAAS;IAE3B,OAAO,IAAI,eAAe,CAAI,OAAO,EAAE,IAAI,CAAC,CAAC;AAC/C,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CACjC,OAAe,EACf,aAAqB,GAAG;IAExB,OAAO,IAAI,aAAa,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,uBAAuB,CACrC,QAAa,EACb,IAAY,EACZ,QAAgB,EAChB,UAAkB,SAAS;IAE3B,qCAAqC;IACrC,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACpC,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IAE5C,0BAA0B;IAC1B,MAAM,UAAU,GAAG,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,aAAa,CAAC;IACnD,MAAM,QAAQ,GAAG,UAAU,GAAG,aAAa,CAAC;IAE5C,yBAAyB;IACzB,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAEvD,OAAO,IAAI,iBAAiB,CAC1B,SAAS,EACT;QACE,KAAK,EAAE,QAAQ,CAAC,MAAM;QACtB,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,aAAa;KACxB,EACD,OAAO,CACR,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,YAAY,CAC1B,GAAQ,EACR,WAAoE;IAEpE,mBAAmB;IACnB,IAAI,aAAa,IAAI,WAAW,EAAE,CAAC;QACjC,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,UAAU,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;QAC9D,OAAO;IACT,CAAC;IAED,gBAAgB;IAChB,IAAI,OAAO,IAAI,WAAW,IAAI,WAAW,CAAC,KAAK,EAAE,CAAC;QAChD,MAAM,aAAa,GAAG,WAA4B,CAAC;QACnD,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC;YACpC,KAAK,EAAE,IAAI;YACX,OAAO,EAAE,aAAa,CAAC,OAAO;YAC9B,SAAS,EAAE,aAAa,CAAC,SAAS;YAClC,SAAS,EAAE,aAAa,CAAC,SAAS;SACnC,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IAED,2BAA2B;IAC3B,MAAM,eAAe,GAAG,WAAmC,CAAC;IAE5D,2CAA2C;IAC3C,IAAI,eAAe,YAAY,iBAAiB,EAAE,CAAC;QACjD,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;QACtB,OAAO;IACT,CAAC;IAED,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;AACxC,CAAC","sourcesContent":["import { randomUUID } from \"crypto\";\nimport { ApiResponse } from \"../types/api-response\";\nimport { getRequestId } from \"./context-store.utils\";\n\n/**\n * Standard HTTP response wrapper for successful responses.\n * Implements the `ApiResponse<T>` interface and sets default values.\n *\n * @typeParam T - The shape of the data returned in the response.\n */\nexport class SuccessResponse<T> implements ApiResponse<T> {\n  /** Message describing the result of the operation. */\n  message: string = \"Success\";\n\n  /** Whether the response is an error. Always false in success responses. */\n  error: boolean = false;\n\n  /** The payload returned from the API. */\n  data: T | null = null;\n\n  /** Timestamp when the response was generated, in ISO format. */\n  timestamp: string = new Date().toISOString();\n\n  /** Unique identifier for this response, useful for request tracing. */\n  requestId: string = getRequestId() ?? randomUUID();\n\n  /**\n   * Constructs a new success response.\n   *\n   * @param {string} message - Optional message to override the default.\n   * @param {T} [data] - Optional data payload.\n   */\n  constructor(message: string, data?: T) {\n    if (message) this.message = message;\n    this.data = data ?? null;\n  }\n}\n\n/**\n * Wrapper for error responses that extends the native `Error` object.\n * Implements `ApiResponse` but omits the `data` field (which should not be present in errors).\n */\nexport class ErrorResponse\n  extends Error\n  implements Omit<ApiResponse<never>, \"data\">\n{\n  /** HTTP status code associated with the error (e.g., 404, 500). */\n  status: number;\n\n  /** Indicates that this is an error. Always true. */\n  error: boolean = true;\n\n  /** Timestamp when the error occurred, in ISO format. */\n  timestamp: string = new Date().toISOString();\n\n  /** Unique identifier for this error instance. */\n  requestId: string = getRequestId() ?? randomUUID();\n\n  /**\n   * Constructs a new error response.\n   *\n   * @param {string} message - The error message to display or log.\n   * @param {number} [status=500] - Optional HTTP status code (defaults to 500).\n   */\n  constructor(message: string, status: number = 500) {\n    super(message);\n    this.status = status;\n    this.name = this.constructor.name;\n    Error.captureStackTrace(this, this.constructor);\n  }\n}\n\n/**\n * Response with paginated data extending the standard success response.\n * Useful for APIs that return large collections of data.\n *\n * @typeParam T - The shape of each item in the paginated collection.\n */\nexport class PaginatedResponse<T> extends SuccessResponse<T[]> {\n  /** Total number of items across all pages */\n  total: number;\n\n  /** Current page number (1-based) */\n  page: number;\n\n  /** Number of items per page */\n  pageSize: number;\n\n  /** Total number of pages */\n  totalPages: number;\n\n  /** Whether there's a next page available */\n  hasNext: boolean;\n\n  /** Whether there's a previous page available */\n  hasPrevious: boolean;\n\n  /**\n   * Constructs a new paginated response.\n   *\n   * @param {T[]} items - The current page of items.\n   * @param {Object} pagination - Pagination information.\n   * @param {number} pagination.total - Total number of items across all pages.\n   * @param {number} pagination.page - Current page number (1-based).\n   * @param {number} pagination.pageSize - Number of items per page.\n   * @param {string} [message=\"Success\"] - Optional custom message.\n   */\n  constructor(\n    items: T[],\n    pagination: { total: number; page: number; pageSize: number },\n    message: string = \"Success\",\n  ) {\n    super(message, items);\n\n    this.total = pagination.total;\n    this.page = pagination.page;\n    this.pageSize = pagination.pageSize;\n\n    this.totalPages = Math.ceil(this.total / this.pageSize);\n    this.hasNext = this.page < this.totalPages;\n    this.hasPrevious = this.page > 1;\n  }\n}\n\n/**\n * Specialized response for operations that don't return data (HTTP 204).\n */\nexport class NoContentResponse extends SuccessResponse<null> {\n  /**\n   * Constructs a new no-content response.\n   *\n   * @param {string} [message=\"Operation completed successfully\"] - Optional custom message.\n   */\n  constructor(message: string = \"Operation completed successfully\") {\n    super(message, null);\n  }\n}\n\n/**\n * Specialized response for redirects.\n */\nexport class RedirectResponse {\n  /** The URL to redirect to */\n  redirectUrl: string;\n\n  /** HTTP status code for the redirect (301, 302, 303, 307, 308) */\n  statusCode: number;\n\n  /** Whether the response is a redirect */\n  isRedirect: boolean = true;\n\n  /** Unique identifier for this response */\n  requestId: string = getRequestId() ?? randomUUID();\n\n  /**\n   * Constructs a new redirect response.\n   *\n   * @param {string} url - The URL to redirect to.\n   * @param {number} [statusCode=302] - HTTP status code for the redirect.\n   */\n  constructor(url: string, statusCode: number = 302) {\n    this.redirectUrl = url;\n    this.statusCode = statusCode;\n  }\n}\n\n/**\n * Creates a standard success response.\n *\n * @typeParam T - The shape of the data returned in the response.\n * @param {T} data - The data to include in the response.\n * @param {string} [message=\"Success\"] - Optional custom message.\n * @returns {SuccessResponse<T>} A properly formatted success response.\n */\nexport function createSuccessResponse<T>(\n  data: T,\n  message: string = \"Success\",\n): SuccessResponse<T> {\n  return new SuccessResponse<T>(message, data);\n}\n\n/**\n * Creates a standard error response.\n *\n * @param {string} message - The error message.\n * @param {number} [statusCode=500] - HTTP status code for the error.\n * @returns {ErrorResponse} A properly formatted error response.\n */\nexport function createErrorResponse(\n  message: string,\n  statusCode: number = 500,\n): ErrorResponse {\n  return new ErrorResponse(message, statusCode);\n}\n\n/**\n * Creates a paginated response from array data.\n *\n * @typeParam T - The shape of each item in the collection.\n * @param {T[]} allItems - The complete array of items to paginate.\n * @param {number} page - The requested page (1-based).\n * @param {number} pageSize - The number of items per page.\n * @param {string} [message=\"Success\"] - Optional custom message.\n * @returns {PaginatedResponse<T>} A properly formatted paginated response.\n */\nexport function createPaginatedResponse<T>(\n  allItems: T[],\n  page: number,\n  pageSize: number,\n  message: string = \"Success\",\n): PaginatedResponse<T> {\n  // Ensure valid pagination parameters\n  const validPage = Math.max(1, page);\n  const validPageSize = Math.max(1, pageSize);\n\n  // Calculate slice indices\n  const startIndex = (validPage - 1) * validPageSize;\n  const endIndex = startIndex + validPageSize;\n\n  // Get current page items\n  const pageItems = allItems.slice(startIndex, endIndex);\n\n  return new PaginatedResponse<T>(\n    pageItems,\n    {\n      total: allItems.length,\n      page: validPage,\n      pageSize: validPageSize,\n    },\n    message,\n  );\n}\n\n/**\n * Adapter to convert API responses to Express.js response format.\n *\n * @param {any} res - Express response object.\n * @param {SuccessResponse<any> | ErrorResponse | RedirectResponse} apiResponse - API response instance.\n */\nexport function sendResponse(\n  res: any,\n  apiResponse: SuccessResponse<any> | ErrorResponse | RedirectResponse,\n): void {\n  // Handle redirects\n  if (\"redirectUrl\" in apiResponse) {\n    res.redirect(apiResponse.statusCode, apiResponse.redirectUrl);\n    return;\n  }\n\n  // Handle errors\n  if (\"error\" in apiResponse && apiResponse.error) {\n    const errorResponse = apiResponse as ErrorResponse;\n    res.status(errorResponse.status).json({\n      error: true,\n      message: errorResponse.message,\n      timestamp: errorResponse.timestamp,\n      requestId: errorResponse.requestId,\n    });\n    return;\n  }\n\n  // Handle success responses\n  const successResponse = apiResponse as SuccessResponse<any>;\n\n  // No content (204) shouldn't return a body\n  if (successResponse instanceof NoContentResponse) {\n    res.status(204).end();\n    return;\n  }\n\n  res.status(200).json(successResponse);\n}\n"]}

package/build/src/utils/string.utils.d.ts

@@ -4,28 +4,28 @@
  * @param {string} str - The input string.
  * @returns {string} The string with the first character in uppercase.
  */
-export declare const capitalize: (str: string) => string;
+export declare function capitalize(str: string): string;
 /**
  * Converts a string to kebab-case (e.g., "FooBar test" → "foo-bar-test").
  *
  * @param {string} str - The input string.
  * @returns {string} The kebab-cased string.
  */
-export declare const toKebabCase: (str: string) => string;
+export declare function toKebabCase(str: string): string;
 /**
  * Converts a kebab-case or snake_case string to camelCase.
  *
  * @param {string} str - The input string.
  * @returns {string} The camelCased string.
  */
-export declare const toCamelCase: (str: string) => string;
+export declare function toCamelCase(str: string): string;
 /**
  * Converts a string to a URL-friendly slug (lowercase, dashes, alphanumeric).
  *
  * @param {string} str - The input string.
  * @returns {string} The slugified string.
  */
-export declare const slugify: (str: string) => string;
+export declare function slugify(str: string): string;
 /**
  * Truncates a string to a specific length, appending '...' if truncated.
  *
@@ -33,5 +33,61 @@ export declare const slugify: (str: string) => string;
  * @param {number} len - The maximum length.
  * @returns {string} The truncated string.
  */
-export declare const truncate: (str: string, len: number) => string;
+export declare function truncate(str: string, len: number): string;
+/**
+ * Converts a string to PascalCase (e.g., "foo-bar" → "FooBar").
+ *
+ * @param {string} str - The input string.
+ * @returns {string} The PascalCased string.
+ */
+export declare function toPascalCase(str: string): string;
+/**
+ * Converts a string to snake_case (e.g., "FooBar test" → "foo_bar_test").
+ *
+ * @param {string} str - The input string.
+ * @returns {string} The snake_cased string.
+ */
+export declare function toSnakeCase(str: string): string;
+/**
+ * Masks a string by replacing characters with a mask character.
+ * Useful for hiding sensitive information like credit cards or passwords.
+ *
+ * @param {string} str - The string to mask.
+ * @param {number} [visibleStart=0] - Number of characters to show at start.
+ * @param {number} [visibleEnd=0] - Number of characters to show at end.
+ * @param {string} [maskChar="*"] - Character to use for masking.
+ * @returns {string} The masked string.
+ */
+export declare function mask(str: string, visibleStart?: number, visibleEnd?: number, maskChar?: string): string;
+/**
+ * Removes all HTML tags from a string.
+ *
+ * @param {string} str - The HTML string to process.
+ * @returns {string} The string with HTML tags removed.
+ */
+export declare function stripHtml(str: string): string;
+/**
+ * Performs case-insensitive string comparison.
+ *
+ * @param {string} a - First string.
+ * @param {string} b - Second string.
+ * @returns {boolean} True if the strings are equal ignoring case.
+ */
+export declare function equalsIgnoreCase(a: string, b: string): boolean;
+/**
+ * Reverses a string.
+ *
+ * @param {string} str - The string to reverse.
+ * @returns {string} The reversed string.
+ */
+export declare function reverse(str: string): string;
+/**
+ * Counts occurrences of a substring within a string.
+ *
+ * @param {string} str - The source string.
+ * @param {string} substring - The substring to count.
+ * @param {boolean} [caseSensitive=true] - Whether to perform case-sensitive counting.
+ * @returns {number} Number of occurrences.
+ */
+export declare function countOccurrences(str: string, substring: string, caseSensitive?: boolean): number;
 //# sourceMappingURL=string.utils.d.ts.map