@catbee/utils 0.0.5 → 0.0.7

package/build/esm/utils/response.utils.js

@@ -1,3 +1,26 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2025 Catbee Technologies
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
 var __extends = (this && this.__extends) || (function () {
     var extendStatics = function (d, b) {
         extendStatics = Object.setPrototypeOf ||
@@ -14,6 +37,7 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 import { getRequestId } from './context-store.utils';
+import { Env } from './env.utils';
 import { uuid } from './id.utils';
 /**
  * Standard HTTP response wrapper for successful responses.
@@ -172,6 +196,33 @@ export function createErrorResponse(message, statusCode) {
     if (statusCode === void 0) { statusCode = 500; }
     return new ErrorResponse(message, statusCode);
 }
+/**
+ * Creates a final error response with request information.
+ *
+ * @param req - The original request object.
+ * @param status - The HTTP status code.
+ * @param message - The error message.
+ * @param error - The original error object (optional).
+ * @param options - Additional options for the response (optional).
+ * @returns A properly formatted final error response.
+ */
+export function createFinalErrorResponse(req, status, message, error, options) {
+    var isDev = Env.isDev();
+    var includeDetails = (options === null || options === void 0 ? void 0 : options.includeDetails) && isDev;
+    var response = {
+        error: true,
+        message: message,
+        timestamp: new Date().toISOString(),
+        requestId: (error === null || error === void 0 ? void 0 : error.requestId) || (req === null || req === void 0 ? void 0 : req.id) || uuid(),
+        status: status,
+        path: req.originalUrl || req.url
+    };
+    // Include stack trace in development mode if requested
+    if (includeDetails && (error === null || error === void 0 ? void 0 : error.stack)) {
+        response.stack = error.stack.split('\n').map(function (line) { return line.trim(); });
+    }
+    return response;
+}
 /**
  * Creates a paginated response from array data.
  *

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

@@ -1 +1 @@
-{"version":3,"file":"response.utils.js","sourceRoot":"","sources":["../../../src/utils/response.utils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAElC;;;;;GAKG;AACH;IAgBE;;;;;OAKG;IACH,yBAAY,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,YAAY,EAAE,mCAAI,IAAI,EAAE,CAAC;QAS3C,IAAI,OAAO;YAAE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACpC,IAAI,CAAC,IAAI,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,IAAI,CAAC;IAC3B,CAAC;IACH,sBAAC;AAAD,CAAC,AA1BD,IA0BC;;AAED;;;GAGG;AACH;IAAmC,iCAAK;IAatC;;;;;OAKG;IACH,uBAAY,OAAe,EAAE,MAAoB;QAApB,uBAAA,EAAA,YAAoB;;QAC/C,YAAA,MAAK,YAAC,OAAO,CAAC,SAAC;QAhBjB,oDAAoD;QACpD,WAAK,GAAY,IAAI,CAAC;QAEtB,wDAAwD;QACxD,eAAS,GAAW,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAE7C,iDAAiD;QACjD,eAAS,GAAW,MAAA,YAAY,EAAE,mCAAI,IAAI,EAAE,CAAC;QAU3C,KAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,KAAI,CAAC,IAAI,GAAG,KAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAClC,KAAK,CAAC,iBAAiB,CAAC,KAAI,EAAE,KAAI,CAAC,WAAW,CAAC,CAAC;;IAClD,CAAC;IACH,oBAAC;AAAD,CAAC,AAzBD,CAAmC,KAAK,GAyBvC;;AAED;;;;;GAKG;AACH;IAA0C,qCAAoB;IAmB5D;;;;;;;;;OASG;IACH,2BAAY,KAAU,EAAE,UAA6D,EAAE,OAA2B;QAA3B,wBAAA,EAAA,mBAA2B;QAChH,YAAA,MAAK,YAAC,OAAO,EAAE,KAAK,CAAC,SAAC;QAEtB,KAAI,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;QAC9B,KAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC5B,KAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QAEpC,KAAI,CAAC,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,KAAI,CAAC,KAAK,GAAG,KAAI,CAAC,QAAQ,CAAC,CAAC;QACxD,KAAI,CAAC,OAAO,GAAG,KAAI,CAAC,IAAI,GAAG,KAAI,CAAC,UAAU,CAAC;QAC3C,KAAI,CAAC,WAAW,GAAG,KAAI,CAAC,IAAI,GAAG,CAAC,CAAC;;IACnC,CAAC;IACH,wBAAC;AAAD,CAAC,AAxCD,CAA0C,eAAe,GAwCxD;;AAED;;GAEG;AACH;IAAuC,qCAAqB;IAC1D;;;;OAIG;IACH,2BAAY,OAAoD;QAApD,wBAAA,EAAA,4CAAoD;QAC9D,OAAA,MAAK,YAAC,OAAO,EAAE,IAAI,CAAC,SAAC;IACvB,CAAC;IACH,wBAAC;AAAD,CAAC,AATD,CAAuC,eAAe,GASrD;;AAED;;GAEG;AACH;IAaE;;;;;OAKG;IACH,0BAAY,GAAW,EAAE,UAAwB;QAAxB,2BAAA,EAAA,gBAAwB;;QAZjD,yCAAyC;QACzC,eAAU,GAAY,IAAI,CAAC;QAE3B,0CAA0C;QAC1C,cAAS,GAAW,MAAA,YAAY,EAAE,mCAAI,IAAI,EAAE,CAAC;QAS3C,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IACH,uBAAC;AAAD,CAAC,AAvBD,IAuBC;;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,qBAAqB,CAAI,IAAO,EAAE,OAA2B;IAA3B,wBAAA,EAAA,mBAA2B;IAC3E,OAAO,IAAI,eAAe,CAAI,OAAO,EAAE,IAAI,CAAC,CAAC;AAC/C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAe,EAAE,UAAwB;IAAxB,2BAAA,EAAA,gBAAwB;IAC3E,OAAO,IAAI,aAAa,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,uBAAuB,CACrC,QAAa,EACb,IAAY,EACZ,QAAgB,EAChB,OAA2B;IAA3B,wBAAA,EAAA,mBAA2B;IAE3B,qCAAqC;IACrC,IAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACpC,IAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IAE5C,0BAA0B;IAC1B,IAAM,UAAU,GAAG,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,aAAa,CAAC;IACnD,IAAM,QAAQ,GAAG,UAAU,GAAG,aAAa,CAAC;IAE5C,yBAAyB;IACzB,IAAM,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,MAAM,UAAU,YAAY,CAAC,GAAQ,EAAE,WAAoE;IACzG,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,IAAM,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,IAAM,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 { ApiResponse } from '../types/api-response';\nimport { getRequestId } from './context-store.utils';\nimport { uuid } from './id.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() ?? uuid();\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 extends Error implements Omit<ApiResponse<never>, 'data'> {\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() ?? uuid();\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(items: T[], pagination: { total: number; page: number; pageSize: number }, message: string = 'Success') {\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() ?? uuid();\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>(data: T, message: string = 'Success'): 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(message: string, statusCode: number = 500): 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(res: any, apiResponse: SuccessResponse<any> | ErrorResponse | RedirectResponse): 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"]}
+{"version":3,"file":"response.utils.js","sourceRoot":"","sources":["../../../src/utils/response.utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;;;;;;;;;;;;;;;AAIH,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAClC,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAElC;;;;;GAKG;AACH;IAgBE;;;;;OAKG;IACH,yBAAY,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,YAAY,EAAE,mCAAI,IAAI,EAAE,CAAC;QAS3C,IAAI,OAAO;YAAE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACpC,IAAI,CAAC,IAAI,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,IAAI,CAAC;IAC3B,CAAC;IACH,sBAAC;AAAD,CAAC,AA1BD,IA0BC;;AAED;;;GAGG;AACH;IAAmC,iCAAK;IAatC;;;;;OAKG;IACH,uBAAY,OAAe,EAAE,MAAoB;QAApB,uBAAA,EAAA,YAAoB;;QAC/C,YAAA,MAAK,YAAC,OAAO,CAAC,SAAC;QAhBjB,oDAAoD;QACpD,WAAK,GAAY,IAAI,CAAC;QAEtB,wDAAwD;QACxD,eAAS,GAAW,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAE7C,iDAAiD;QACjD,eAAS,GAAW,MAAA,YAAY,EAAE,mCAAI,IAAI,EAAE,CAAC;QAU3C,KAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,KAAI,CAAC,IAAI,GAAG,KAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAClC,KAAK,CAAC,iBAAiB,CAAC,KAAI,EAAE,KAAI,CAAC,WAAW,CAAC,CAAC;;IAClD,CAAC;IACH,oBAAC;AAAD,CAAC,AAzBD,CAAmC,KAAK,GAyBvC;;AAED;;;;;GAKG;AACH;IAA0C,qCAAoB;IAmB5D;;;;;;;;;OASG;IACH,2BAAY,KAAU,EAAE,UAA6D,EAAE,OAA2B;QAA3B,wBAAA,EAAA,mBAA2B;QAChH,YAAA,MAAK,YAAC,OAAO,EAAE,KAAK,CAAC,SAAC;QAEtB,KAAI,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;QAC9B,KAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC5B,KAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QAEpC,KAAI,CAAC,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,KAAI,CAAC,KAAK,GAAG,KAAI,CAAC,QAAQ,CAAC,CAAC;QACxD,KAAI,CAAC,OAAO,GAAG,KAAI,CAAC,IAAI,GAAG,KAAI,CAAC,UAAU,CAAC;QAC3C,KAAI,CAAC,WAAW,GAAG,KAAI,CAAC,IAAI,GAAG,CAAC,CAAC;;IACnC,CAAC;IACH,wBAAC;AAAD,CAAC,AAxCD,CAA0C,eAAe,GAwCxD;;AAED;;GAEG;AACH;IAAuC,qCAAqB;IAC1D;;;;OAIG;IACH,2BAAY,OAAoD;QAApD,wBAAA,EAAA,4CAAoD;QAC9D,OAAA,MAAK,YAAC,OAAO,EAAE,IAAI,CAAC,SAAC;IACvB,CAAC;IACH,wBAAC;AAAD,CAAC,AATD,CAAuC,eAAe,GASrD;;AAED;;GAEG;AACH;IAaE;;;;;OAKG;IACH,0BAAY,GAAW,EAAE,UAAwB;QAAxB,2BAAA,EAAA,gBAAwB;;QAZjD,yCAAyC;QACzC,eAAU,GAAY,IAAI,CAAC;QAE3B,0CAA0C;QAC1C,cAAS,GAAW,MAAA,YAAY,EAAE,mCAAI,IAAI,EAAE,CAAC;QAS3C,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IACH,uBAAC;AAAD,CAAC,AAvBD,IAuBC;;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,qBAAqB,CAAI,IAAO,EAAE,OAA2B;IAA3B,wBAAA,EAAA,mBAA2B;IAC3E,OAAO,IAAI,eAAe,CAAI,OAAO,EAAE,IAAI,CAAC,CAAC;AAC/C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAe,EAAE,UAAwB;IAAxB,2BAAA,EAAA,gBAAwB;IAC3E,OAAO,IAAI,aAAa,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,wBAAwB,CACtC,GAAY,EACZ,MAAc,EACd,OAAe,EACf,KAAW,EACX,OAAsC;IAEtC,IAAM,KAAK,GAAG,GAAG,CAAC,KAAK,EAAE,CAAC;IAC1B,IAAM,cAAc,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,KAAI,KAAK,CAAC;IAExD,IAAM,QAAQ,GAAqB;QACjC,KAAK,EAAE,IAAI;QACX,OAAO,SAAA;QACP,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACnC,SAAS,EAAE,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,SAAS,MAAI,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,EAAE,CAAA,IAAI,IAAI,EAAE;QAChD,MAAM,QAAA;QACN,IAAI,EAAE,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,GAAG;KACjC,CAAC;IAEF,uDAAuD;IACvD,IAAI,cAAc,KAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,CAAA,EAAE,CAAC;QACnC,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,UAAC,IAAY,IAAK,OAAA,IAAI,CAAC,IAAI,EAAE,EAAX,CAAW,CAAC,CAAC;IAC9E,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,uBAAuB,CACrC,QAAa,EACb,IAAY,EACZ,QAAgB,EAChB,OAA2B;IAA3B,wBAAA,EAAA,mBAA2B;IAE3B,qCAAqC;IACrC,IAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACpC,IAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IAE5C,0BAA0B;IAC1B,IAAM,UAAU,GAAG,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,aAAa,CAAC;IACnD,IAAM,QAAQ,GAAG,UAAU,GAAG,aAAa,CAAC;IAE5C,yBAAyB;IACzB,IAAM,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,MAAM,UAAU,YAAY,CAAC,GAAQ,EAAE,WAAoE;IACzG,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,IAAM,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,IAAM,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":["/*\n * The MIT License\n *\n * Copyright (c) 2025 Catbee Technologies\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Request } from 'express';\nimport { ApiErrorResponse, ApiResponse } from '../types/api-response';\nimport { getRequestId } from './context-store.utils';\nimport { Env } from './env.utils';\nimport { uuid } from './id.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() ?? uuid();\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 extends Error implements Omit<ApiResponse<never>, 'data'> {\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() ?? uuid();\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(items: T[], pagination: { total: number; page: number; pageSize: number }, message: string = 'Success') {\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() ?? uuid();\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>(data: T, message: string = 'Success'): 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(message: string, statusCode: number = 500): ErrorResponse {\n  return new ErrorResponse(message, statusCode);\n}\n\n/**\n * Creates a final error response with request information.\n *\n * @param req - The original request object.\n * @param status - The HTTP status code.\n * @param message - The error message.\n * @param error - The original error object (optional).\n * @param options - Additional options for the response (optional).\n * @returns A properly formatted final error response.\n */\nexport function createFinalErrorResponse(\n  req: Request,\n  status: number,\n  message: string,\n  error?: any,\n  options?: { includeDetails?: boolean }\n) {\n  const isDev = Env.isDev();\n  const includeDetails = options?.includeDetails && isDev;\n\n  const response: ApiErrorResponse = {\n    error: true,\n    message,\n    timestamp: new Date().toISOString(),\n    requestId: error?.requestId || req?.id || uuid(),\n    status,\n    path: req.originalUrl || req.url\n  };\n\n  // Include stack trace in development mode if requested\n  if (includeDetails && error?.stack) {\n    response.stack = error.stack.split('\\n').map((line: string) => line.trim());\n  }\n\n  return response;\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(res: any, apiResponse: SuccessResponse<any> | ErrorResponse | RedirectResponse): 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/esm/utils/stream.utils.d.ts

@@ -0,0 +1,88 @@
+import { Readable, Transform } from 'stream';
+import { BufferEncoding } from './crypto.utils';
+/**
+ * Convert a buffer or string to a readable stream.
+ *
+ * @param data - Buffer or string to convert
+ * @returns Readable stream containing the data
+ *
+ * @example
+ * ```typescript
+ * const stream = bufferToStream(Buffer.from('Hello world'));
+ * // or
+ * const stream = bufferToStream('Hello world');
+ * ```
+ */
+export declare function bufferToStream(data: Buffer | string): Readable;
+/**
+ * Convert a readable stream to a buffer.
+ *
+ * @param stream - Readable stream to convert
+ * @returns Promise resolving to a buffer containing all stream data
+ *
+ * @example
+ * ```typescript
+ * const buffer = await streamToBuffer(fs.createReadStream('file.txt'));
+ * console.log(buffer.toString()); // Contents of file.txt
+ * ```
+ */
+export declare function streamToBuffer(stream: Readable): Promise<Buffer>;
+/**
+ * Convert a readable stream to a string.
+ *
+ * @param stream - Readable stream to convert
+ * @param encoding - Character encoding (default: 'utf8')
+ * @returns Promise resolving to a string containing all stream data
+ *
+ * @example
+ * ```typescript
+ * const content = await streamToString(fs.createReadStream('file.txt'));
+ * console.log(content); // Contents of file.txt as string
+ * ```
+ */
+export declare function streamToString(stream: Readable, encoding?: BufferEncoding): Promise<string>;
+/**
+ * Create a transform stream that limits the rate of data flow.
+ *
+ * @param bytesPerSecond - Maximum bytes per second
+ * @returns Transform stream that throttles data flow
+ */
+export declare function createThrottleStream(bytesPerSecond: number): Transform;
+/**
+ * Create a transform stream that batches data into chunks of specified size.
+ *
+ * @param size - Size of each batch (items for object mode, bytes for binary mode)
+ * @param options - Stream options
+ * @returns Transform stream that batches data
+ *
+ * @example
+ * ```typescript
+ * // Batch lines from a file into arrays of 100 lines each
+ * createReadStream('large-file.txt')
+ *   .pipe(createLineStream())
+ *   .pipe(createBatchStream(100))
+ *   .on('data', batch => console.log(`Processing batch of ${batch.length} lines`));
+ * ```
+ */
+export declare function createBatchStream(size: number, options?: {
+    objectMode?: boolean;
+}): Transform;
+/**
+ * Create a transform stream that splits text data by newlines.
+ *
+ * @param options - Options for the line stream
+ * @returns Transform stream that emits lines
+ *
+ * @example
+ * ```typescript
+ * // Process a file line by line
+ * createReadStream('file.txt')
+ *   .pipe(createLineStream())
+ *   .on('data', line => console.log(`Line: ${line}`));
+ * ```
+ */
+export declare function createLineStream(options?: {
+    encoding?: BufferEncoding;
+    includeNewlines?: boolean;
+}): Transform;
+//# sourceMappingURL=stream.utils.d.ts.map

package/build/esm/utils/stream.utils.js

@@ -0,0 +1,284 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2025 Catbee Technologies
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+import { Readable, Transform } from 'stream';
+/**
+ * Convert a buffer or string to a readable stream.
+ *
+ * @param data - Buffer or string to convert
+ * @returns Readable stream containing the data
+ *
+ * @example
+ * ```typescript
+ * const stream = bufferToStream(Buffer.from('Hello world'));
+ * // or
+ * const stream = bufferToStream('Hello world');
+ * ```
+ */
+export function bufferToStream(data) {
+    var readable = new Readable();
+    readable.push(data);
+    readable.push(null); // End of stream
+    return readable;
+}
+/**
+ * Convert a readable stream to a buffer.
+ *
+ * @param stream - Readable stream to convert
+ * @returns Promise resolving to a buffer containing all stream data
+ *
+ * @example
+ * ```typescript
+ * const buffer = await streamToBuffer(fs.createReadStream('file.txt'));
+ * console.log(buffer.toString()); // Contents of file.txt
+ * ```
+ */
+export function streamToBuffer(stream) {
+    return __awaiter(this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            return [2 /*return*/, new Promise(function (resolve, reject) {
+                    var chunks = [];
+                    stream.on('data', function (chunk) { return chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk)); });
+                    stream.on('end', function () { return resolve(Buffer.concat(chunks)); });
+                    stream.on('error', reject);
+                })];
+        });
+    });
+}
+/**
+ * Convert a readable stream to a string.
+ *
+ * @param stream - Readable stream to convert
+ * @param encoding - Character encoding (default: 'utf8')
+ * @returns Promise resolving to a string containing all stream data
+ *
+ * @example
+ * ```typescript
+ * const content = await streamToString(fs.createReadStream('file.txt'));
+ * console.log(content); // Contents of file.txt as string
+ * ```
+ */
+export function streamToString(stream_1) {
+    return __awaiter(this, arguments, void 0, function (stream, encoding) {
+        var buffer;
+        if (encoding === void 0) { encoding = 'utf8'; }
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, streamToBuffer(stream)];
+                case 1:
+                    buffer = _a.sent();
+                    return [2 /*return*/, buffer.toString(encoding)];
+            }
+        });
+    });
+}
+/**
+ * Create a transform stream that limits the rate of data flow.
+ *
+ * @param bytesPerSecond - Maximum bytes per second
+ * @returns Transform stream that throttles data flow
+ */
+export function createThrottleStream(bytesPerSecond) {
+    var bytesSent = 0;
+    var startTime = Date.now();
+    return new Transform({
+        transform: function (chunk, _encoding, callback) {
+            var elapsedSeconds = (Date.now() - startTime) / 1000;
+            var targetBytes = bytesPerSecond * elapsedSeconds;
+            var chunkSize = chunk.length;
+            // If we've sent fewer bytes than our target, just send the chunk
+            if (bytesSent + chunkSize <= targetBytes) {
+                bytesSent += chunkSize;
+                callback(null, chunk);
+                return;
+            }
+            // Otherwise we need to throttle
+            var delay = ((bytesSent + chunkSize) / bytesPerSecond - elapsedSeconds) * 1000;
+            setTimeout(function () {
+                bytesSent += chunkSize;
+                callback(null, chunk);
+            }, delay);
+        }
+    });
+}
+/**
+ * Create a transform stream that batches data into chunks of specified size.
+ *
+ * @param size - Size of each batch (items for object mode, bytes for binary mode)
+ * @param options - Stream options
+ * @returns Transform stream that batches data
+ *
+ * @example
+ * ```typescript
+ * // Batch lines from a file into arrays of 100 lines each
+ * createReadStream('large-file.txt')
+ *   .pipe(createLineStream())
+ *   .pipe(createBatchStream(100))
+ *   .on('data', batch => console.log(`Processing batch of ${batch.length} lines`));
+ * ```
+ */
+export function createBatchStream(size, options) {
+    if (options === void 0) { options = {}; }
+    var objectMode = options.objectMode !== false;
+    var batch = [];
+    var buffers = [];
+    var bufferSize = 0;
+    return new Transform({
+        objectMode: objectMode,
+        transform: function (chunk, _encoding, callback) {
+            if (objectMode) {
+                batch.push(chunk);
+                if (batch.length >= size) {
+                    this.push(batch);
+                    batch = [];
+                }
+            }
+            else {
+                var buffer = Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk);
+                buffers.push(buffer);
+                bufferSize += buffer.length;
+                // Emit batches of exact size
+                var combined = Buffer.concat(buffers, bufferSize);
+                while (combined.length >= size) {
+                    this.push(combined.slice(0, size));
+                    combined = combined.slice(size);
+                }
+                buffers = combined.length > 0 ? [combined] : [];
+                bufferSize = combined.length;
+            }
+            callback();
+        },
+        flush: function (callback) {
+            if (objectMode && batch.length > 0) {
+                this.push(batch);
+            }
+            else if (!objectMode && buffers.length > 0 && bufferSize > 0) {
+                var combined = Buffer.concat(buffers, bufferSize);
+                while (combined.length >= size) {
+                    this.push(combined.slice(0, size));
+                    combined = combined.slice(size);
+                }
+                if (combined.length > 0) {
+                    this.push(combined);
+                }
+            }
+            callback();
+        }
+    });
+}
+/**
+ * Create a transform stream that splits text data by newlines.
+ *
+ * @param options - Options for the line stream
+ * @returns Transform stream that emits lines
+ *
+ * @example
+ * ```typescript
+ * // Process a file line by line
+ * createReadStream('file.txt')
+ *   .pipe(createLineStream())
+ *   .on('data', line => console.log(`Line: ${line}`));
+ * ```
+ */
+export function createLineStream(options) {
+    if (options === void 0) { options = {}; }
+    var _a = options.encoding, encoding = _a === void 0 ? 'utf8' : _a, _b = options.includeNewlines, includeNewlines = _b === void 0 ? false : _b;
+    var buffer = '';
+    return new Transform({
+        objectMode: true,
+        transform: function (chunk, _encoding, callback) {
+            var e_1, _a;
+            var str = buffer + (Buffer.isBuffer(chunk) ? chunk.toString(encoding) : chunk);
+            var lines = str.split(/\r?\n/);
+            buffer = lines.pop() || '';
+            try {
+                for (var lines_1 = __values(lines), lines_1_1 = lines_1.next(); !lines_1_1.done; lines_1_1 = lines_1.next()) {
+                    var line = lines_1_1.value;
+                    this.push(includeNewlines ? line + '\n' : line);
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (lines_1_1 && !lines_1_1.done && (_a = lines_1.return)) _a.call(lines_1);
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+            callback();
+        },
+        flush: function (callback) {
+            if (buffer) {
+                this.push(buffer);
+            }
+            callback();
+        }
+    });
+}
+//# sourceMappingURL=stream.utils.js.map

package/build/esm/utils/stream.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream.utils.js","sourceRoot":"","sources":["../../../src/utils/stream.utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAqB,MAAM,QAAQ,CAAC;AAGhE;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,cAAc,CAAC,IAAqB;IAClD,IAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;IAChC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,gBAAgB;IACrC,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAgB,cAAc,CAAC,MAAgB;;;YACnD,sBAAO,IAAI,OAAO,CAAS,UAAC,OAAO,EAAE,MAAM;oBACzC,IAAM,MAAM,GAAa,EAAE,CAAC;oBAC5B,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,UAAA,KAAK,IAAI,OAAA,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAhE,CAAgE,CAAC,CAAC;oBAC7F,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,cAAM,OAAA,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAA9B,CAA8B,CAAC,CAAC;oBACvD,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;gBAC7B,CAAC,CAAC,EAAC;;;CACJ;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAgB,cAAc;wDAAC,MAAgB,EAAE,QAAiC;;QAAjC,yBAAA,EAAA,iBAAiC;;;wBACvE,qBAAM,cAAc,CAAC,MAAM,CAAC,EAAA;;oBAArC,MAAM,GAAG,SAA4B;oBAC3C,sBAAO,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAC;;;;CAClC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,cAAsB;IACzD,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,IAAI,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAE3B,OAAO,IAAI,SAAS,CAAC;QACnB,SAAS,YAAC,KAAa,EAAE,SAAyB,EAAE,QAA2B;YAC7E,IAAM,cAAc,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC;YACvD,IAAM,WAAW,GAAG,cAAc,GAAG,cAAc,CAAC;YACpD,IAAM,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC;YAE/B,iEAAiE;YACjE,IAAI,SAAS,GAAG,SAAS,IAAI,WAAW,EAAE,CAAC;gBACzC,SAAS,IAAI,SAAS,CAAC;gBACvB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBACtB,OAAO;YACT,CAAC;YAED,gCAAgC;YAChC,IAAM,KAAK,GAAG,CAAC,CAAC,SAAS,GAAG,SAAS,CAAC,GAAG,cAAc,GAAG,cAAc,CAAC,GAAG,IAAI,CAAC;YAEjF,UAAU,CAAC;gBACT,SAAS,IAAI,SAAS,CAAC;gBACvB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YACxB,CAAC,EAAE,KAAK,CAAC,CAAC;QACZ,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAY,EAAE,OAAsC;IAAtC,wBAAA,EAAA,YAAsC;IACpF,IAAM,UAAU,GAAG,OAAO,CAAC,UAAU,KAAK,KAAK,CAAC;IAChD,IAAI,KAAK,GAAU,EAAE,CAAC;IACtB,IAAI,OAAO,GAAa,EAAE,CAAC;IAC3B,IAAI,UAAU,GAAG,CAAC,CAAC;IAEnB,OAAO,IAAI,SAAS,CAAC;QACnB,UAAU,YAAA;QACV,SAAS,YAAC,KAAK,EAAE,SAAS,EAAE,QAAQ;YAClC,IAAI,UAAU,EAAE,CAAC;gBACf,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAClB,IAAI,KAAK,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;oBACzB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBACjB,KAAK,GAAG,EAAE,CAAC;gBACb,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,IAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACnE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACrB,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC;gBAE5B,6BAA6B;gBAC7B,IAAI,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;gBAClD,OAAO,QAAQ,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;oBAC/B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;oBACnC,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAClC,CAAC;gBACD,OAAO,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAChD,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC;YAC/B,CAAC;YAED,QAAQ,EAAE,CAAC;QACb,CAAC;QAED,KAAK,YAAC,QAAQ;YACZ,IAAI,UAAU,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACnC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACnB,CAAC;iBAAM,IAAI,CAAC,UAAU,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;gBAC/D,IAAI,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;gBAClD,OAAO,QAAQ,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;oBAC/B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;oBACnC,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAClC,CAAC;gBACD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACxB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACtB,CAAC;YACH,CAAC;YACD,QAAQ,EAAE,CAAC;QACb,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,gBAAgB,CAC9B,OAGM;IAHN,wBAAA,EAAA,YAGM;IAEE,IAAA,KAA+C,OAAO,SAArC,EAAjB,QAAQ,mBAAG,MAAM,KAAA,EAAE,KAA4B,OAAO,gBAAZ,EAAvB,eAAe,mBAAG,KAAK,KAAA,CAAa;IAC/D,IAAI,MAAM,GAAG,EAAE,CAAC;IAEhB,OAAO,IAAI,SAAS,CAAC;QACnB,UAAU,EAAE,IAAI;QAChB,SAAS,YAAC,KAAK,EAAE,SAAS,EAAE,QAAQ;;YAClC,IAAM,GAAG,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YACjF,IAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACjC,MAAM,GAAG,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;;gBAE3B,KAAmB,IAAA,UAAA,SAAA,KAAK,CAAA,4BAAA,+CAAE,CAAC;oBAAtB,IAAM,IAAI,kBAAA;oBACb,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;gBAClD,CAAC;;;;;;;;;YAED,QAAQ,EAAE,CAAC;QACb,CAAC;QAED,KAAK,YAAC,QAAQ;YACZ,IAAI,MAAM,EAAE,CAAC;gBACX,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACpB,CAAC;YACD,QAAQ,EAAE,CAAC;QACb,CAAC;KACF,CAAC,CAAC;AACL,CAAC","sourcesContent":["/*\n * The MIT License\n *\n * Copyright (c) 2025 Catbee Technologies\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Readable, Transform, TransformCallback } from 'stream';\nimport { BufferEncoding } from './crypto.utils';\n\n/**\n * Convert a buffer or string to a readable stream.\n *\n * @param data - Buffer or string to convert\n * @returns Readable stream containing the data\n *\n * @example\n * ```typescript\n * const stream = bufferToStream(Buffer.from('Hello world'));\n * // or\n * const stream = bufferToStream('Hello world');\n * ```\n */\nexport function bufferToStream(data: Buffer | string): Readable {\n  const readable = new Readable();\n  readable.push(data);\n  readable.push(null); // End of stream\n  return readable;\n}\n\n/**\n * Convert a readable stream to a buffer.\n *\n * @param stream - Readable stream to convert\n * @returns Promise resolving to a buffer containing all stream data\n *\n * @example\n * ```typescript\n * const buffer = await streamToBuffer(fs.createReadStream('file.txt'));\n * console.log(buffer.toString()); // Contents of file.txt\n * ```\n */\nexport async function streamToBuffer(stream: Readable): Promise<Buffer> {\n  return new Promise<Buffer>((resolve, reject) => {\n    const chunks: Buffer[] = [];\n    stream.on('data', chunk => chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk)));\n    stream.on('end', () => resolve(Buffer.concat(chunks)));\n    stream.on('error', reject);\n  });\n}\n\n/**\n * Convert a readable stream to a string.\n *\n * @param stream - Readable stream to convert\n * @param encoding - Character encoding (default: 'utf8')\n * @returns Promise resolving to a string containing all stream data\n *\n * @example\n * ```typescript\n * const content = await streamToString(fs.createReadStream('file.txt'));\n * console.log(content); // Contents of file.txt as string\n * ```\n */\nexport async function streamToString(stream: Readable, encoding: BufferEncoding = 'utf8'): Promise<string> {\n  const buffer = await streamToBuffer(stream);\n  return buffer.toString(encoding);\n}\n\n/**\n * Create a transform stream that limits the rate of data flow.\n *\n * @param bytesPerSecond - Maximum bytes per second\n * @returns Transform stream that throttles data flow\n */\nexport function createThrottleStream(bytesPerSecond: number): Transform {\n  let bytesSent = 0;\n  let startTime = Date.now();\n\n  return new Transform({\n    transform(chunk: Buffer, _encoding: BufferEncoding, callback: TransformCallback) {\n      const elapsedSeconds = (Date.now() - startTime) / 1000;\n      const targetBytes = bytesPerSecond * elapsedSeconds;\n      const chunkSize = chunk.length;\n\n      // If we've sent fewer bytes than our target, just send the chunk\n      if (bytesSent + chunkSize <= targetBytes) {\n        bytesSent += chunkSize;\n        callback(null, chunk);\n        return;\n      }\n\n      // Otherwise we need to throttle\n      const delay = ((bytesSent + chunkSize) / bytesPerSecond - elapsedSeconds) * 1000;\n\n      setTimeout(() => {\n        bytesSent += chunkSize;\n        callback(null, chunk);\n      }, delay);\n    }\n  });\n}\n\n/**\n * Create a transform stream that batches data into chunks of specified size.\n *\n * @param size - Size of each batch (items for object mode, bytes for binary mode)\n * @param options - Stream options\n * @returns Transform stream that batches data\n *\n * @example\n * ```typescript\n * // Batch lines from a file into arrays of 100 lines each\n * createReadStream('large-file.txt')\n *   .pipe(createLineStream())\n *   .pipe(createBatchStream(100))\n *   .on('data', batch => console.log(`Processing batch of ${batch.length} lines`));\n * ```\n */\nexport function createBatchStream(size: number, options: { objectMode?: boolean } = {}): Transform {\n  const objectMode = options.objectMode !== false;\n  let batch: any[] = [];\n  let buffers: Buffer[] = [];\n  let bufferSize = 0;\n\n  return new Transform({\n    objectMode,\n    transform(chunk, _encoding, callback) {\n      if (objectMode) {\n        batch.push(chunk);\n        if (batch.length >= size) {\n          this.push(batch);\n          batch = [];\n        }\n      } else {\n        const buffer = Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk);\n        buffers.push(buffer);\n        bufferSize += buffer.length;\n\n        // Emit batches of exact size\n        let combined = Buffer.concat(buffers, bufferSize);\n        while (combined.length >= size) {\n          this.push(combined.slice(0, size));\n          combined = combined.slice(size);\n        }\n        buffers = combined.length > 0 ? [combined] : [];\n        bufferSize = combined.length;\n      }\n\n      callback();\n    },\n\n    flush(callback) {\n      if (objectMode && batch.length > 0) {\n        this.push(batch);\n      } else if (!objectMode && buffers.length > 0 && bufferSize > 0) {\n        let combined = Buffer.concat(buffers, bufferSize);\n        while (combined.length >= size) {\n          this.push(combined.slice(0, size));\n          combined = combined.slice(size);\n        }\n        if (combined.length > 0) {\n          this.push(combined);\n        }\n      }\n      callback();\n    }\n  });\n}\n\n/**\n * Create a transform stream that splits text data by newlines.\n *\n * @param options - Options for the line stream\n * @returns Transform stream that emits lines\n *\n * @example\n * ```typescript\n * // Process a file line by line\n * createReadStream('file.txt')\n *   .pipe(createLineStream())\n *   .on('data', line => console.log(`Line: ${line}`));\n * ```\n */\nexport function createLineStream(\n  options: {\n    encoding?: BufferEncoding;\n    includeNewlines?: boolean;\n  } = {}\n): Transform {\n  const { encoding = 'utf8', includeNewlines = false } = options;\n  let buffer = '';\n\n  return new Transform({\n    objectMode: true,\n    transform(chunk, _encoding, callback) {\n      const str = buffer + (Buffer.isBuffer(chunk) ? chunk.toString(encoding) : chunk);\n      const lines = str.split(/\\r?\\n/);\n      buffer = lines.pop() || '';\n\n      for (const line of lines) {\n        this.push(includeNewlines ? line + '\\n' : line);\n      }\n\n      callback();\n    },\n\n    flush(callback) {\n      if (buffer) {\n        this.push(buffer);\n      }\n      callback();\n    }\n  });\n}\n"]}

package/build/esm/utils/string.utils.js

@@ -1,3 +1,26 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2025 Catbee Technologies
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
 /**
  * Capitalizes the first character of a string.
  *

package/build/esm/utils/string.utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"string.utils.js","sourceRoot":"","sources":["../../../src/utils/string.utils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,GAAW;IACpC,OAAO,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAC5E,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,GAAW;IACrC,OAAO,GAAG;SACP,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC,0BAA0B;SAC9D,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,iBAAiB;SACtC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,sBAAsB;SAC1C,WAAW,EAAE,CAAC;AACnB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,GAAW;IACrC,OAAO,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,UAAC,CAAC,EAAE,CAAS,IAAK,OAAA,CAAC,CAAC,WAAW,EAAE,EAAf,CAAe,CAAC,CAAC;AACpE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,GAAW;IACjC,OAAO,GAAG;SACP,WAAW,EAAE;SACb,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,kBAAkB;SAC3C,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,iBAAiB;SACtC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,yBAAyB;SAC7C,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC,+BAA+B;AAC7D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAW,EAAE,GAAW;IAC/C,OAAO,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;AAC5D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,GAAW;IACtC,OAAO,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;AACtC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,GAAW;IACrC,OAAO,GAAG;SACP,IAAI,EAAE;SACN,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC,0BAA0B;SAC9D,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,uBAAuB;SAC5C,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,uBAAuB;SAC3C,WAAW,EAAE,CAAC;AACnB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,IAAI,CAAC,GAAW,EAAE,YAAwB,EAAE,UAAsB,EAAE,QAAsB;IAAxE,6BAAA,EAAA,gBAAwB;IAAE,2BAAA,EAAA,cAAsB;IAAE,yBAAA,EAAA,cAAsB;IACxG,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACxC,IAAI,YAAY,IAAI,GAAG,CAAC,MAAM;QAAE,OAAO,GAAG,CAAC;IAE3C,IAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;IACzC,IAAM,GAAG,GAAG,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACzD,IAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,GAAG,YAAY,GAAG,UAAU,CAAC,CAAC,CAAC;IAEpF,OAAO,KAAK,GAAG,MAAM,GAAG,GAAG,CAAC;AAC9B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAC,GAAW;IACnC,OAAO,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,CAAS,EAAE,CAAS;IACnD,OAAO,CAAC,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;AAC7C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,GAAW;IACjC,OAAO,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC1C,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAW,EAAE,SAAiB,EAAE,aAA6B;IAA7B,8BAAA,EAAA,oBAA6B;IAC5F,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,GAAG,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;QACxB,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IACtC,CAAC;IAED,OAAO,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;AACzC,CAAC","sourcesContent":["/**\n * Capitalizes the first character of a string.\n *\n * @param {string} str - The input string.\n * @returns {string} The string with the first character in uppercase.\n */\nexport function capitalize(str: string): string {\n  return str.length === 0 ? '' : str.charAt(0).toUpperCase() + str.slice(1);\n}\n\n/**\n * Converts a string to kebab-case (e.g., \"FooBar test\" → \"foo-bar-test\").\n *\n * @param {string} str - The input string.\n * @returns {string} The kebab-cased string.\n */\nexport function toKebabCase(str: string): string {\n  return str\n    .replace(/([a-z])([A-Z])/g, '$1-$2') // camelCase -> camel-Case\n    .replace(/\\s+/g, '-') // spaces to dash\n    .replace(/_+/g, '-') // underscores to dash\n    .toLowerCase();\n}\n\n/**\n * Converts a kebab-case or snake_case string to camelCase.\n *\n * @param {string} str - The input string.\n * @returns {string} The camelCased string.\n */\nexport function toCamelCase(str: string): string {\n  return str.replace(/[-_](.)/g, (_, c: string) => c.toUpperCase());\n}\n\n/**\n * Converts a string to a URL-friendly slug (lowercase, dashes, alphanumeric).\n *\n * @param {string} str - The input string.\n * @returns {string} The slugified string.\n */\nexport function slugify(str: string): string {\n  return str\n    .toLowerCase()\n    .replace(/[^\\w\\s-]/g, '') // remove non-word\n    .replace(/\\s+/g, '-') // spaces to dash\n    .replace(/-+/g, '-') // multiple dashes to one\n    .replace(/^-+|-+$/g, ''); // trim leading/trailing dashes\n}\n\n/**\n * Truncates a string to a specific length, appending '...' if truncated.\n *\n * @param {string} str - The input string.\n * @param {number} len - The maximum length.\n * @returns {string} The truncated string.\n */\nexport function truncate(str: string, len: number): string {\n  return str.length > len ? str.slice(0, len) + '...' : str;\n}\n\n/**\n * Converts a string to PascalCase (e.g., \"foo-bar\" → \"FooBar\").\n *\n * @param {string} str - The input string.\n * @returns {string} The PascalCased string.\n */\nexport function toPascalCase(str: string): string {\n  return capitalize(toCamelCase(str));\n}\n\n/**\n * Converts a string to snake_case (e.g., \"FooBar test\" → \"foo_bar_test\").\n *\n * @param {string} str - The input string.\n * @returns {string} The snake_cased string.\n */\nexport function toSnakeCase(str: string): string {\n  return str\n    .trim()\n    .replace(/([a-z])([A-Z])/g, '$1_$2') // camelCase -> camel_Case\n    .replace(/\\s+/g, '_') // spaces to underscore\n    .replace(/-+/g, '_') // dashes to underscore\n    .toLowerCase();\n}\n\n/**\n * Masks a string by replacing characters with a mask character.\n * Useful for hiding sensitive information like credit cards or passwords.\n *\n * @param {string} str - The string to mask.\n * @param {number} [visibleStart=0] - Number of characters to show at start.\n * @param {number} [visibleEnd=0] - Number of characters to show at end.\n * @param {string} [maskChar=\"*\"] - Character to use for masking.\n * @returns {string} The masked string.\n */\nexport function mask(str: string, visibleStart: number = 0, visibleEnd: number = 0, maskChar: string = '*'): string {\n  if (!str || str.length === 0) return '';\n  if (visibleStart >= str.length) return str;\n\n  const start = str.slice(0, visibleStart);\n  const end = visibleEnd > 0 ? str.slice(-visibleEnd) : '';\n  const masked = maskChar.repeat(Math.max(0, str.length - visibleStart - visibleEnd));\n\n  return start + masked + end;\n}\n\n/**\n * Removes all HTML tags from a string.\n *\n * @param {string} str - The HTML string to process.\n * @returns {string} The string with HTML tags removed.\n */\nexport function stripHtml(str: string): string {\n  return str.replace(/<[^>]*>/g, '');\n}\n\n/**\n * Performs case-insensitive string comparison.\n *\n * @param {string} a - First string.\n * @param {string} b - Second string.\n * @returns {boolean} True if the strings are equal ignoring case.\n */\nexport function equalsIgnoreCase(a: string, b: string): boolean {\n  return a.toLowerCase() === b.toLowerCase();\n}\n\n/**\n * Reverses a string.\n *\n * @param {string} str - The string to reverse.\n * @returns {string} The reversed string.\n */\nexport function reverse(str: string): string {\n  return str.split('').reverse().join('');\n}\n\n/**\n * Counts occurrences of a substring within a string.\n *\n * @param {string} str - The source string.\n * @param {string} substring - The substring to count.\n * @param {boolean} [caseSensitive=true] - Whether to perform case-sensitive counting.\n * @returns {number} Number of occurrences.\n */\nexport function countOccurrences(str: string, substring: string, caseSensitive: boolean = true): number {\n  if (!caseSensitive) {\n    str = str.toLowerCase();\n    substring = substring.toLowerCase();\n  }\n\n  return str.split(substring).length - 1;\n}\n"]}
+{"version":3,"file":"string.utils.js","sourceRoot":"","sources":["../../../src/utils/string.utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,GAAW;IACpC,OAAO,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAC5E,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,GAAW;IACrC,OAAO,GAAG;SACP,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC,0BAA0B;SAC9D,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,iBAAiB;SACtC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,sBAAsB;SAC1C,WAAW,EAAE,CAAC;AACnB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,GAAW;IACrC,OAAO,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,UAAC,CAAC,EAAE,CAAS,IAAK,OAAA,CAAC,CAAC,WAAW,EAAE,EAAf,CAAe,CAAC,CAAC;AACpE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,GAAW;IACjC,OAAO,GAAG;SACP,WAAW,EAAE;SACb,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,kBAAkB;SAC3C,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,iBAAiB;SACtC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,yBAAyB;SAC7C,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC,+BAA+B;AAC7D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAW,EAAE,GAAW;IAC/C,OAAO,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;AAC5D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,GAAW;IACtC,OAAO,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;AACtC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,GAAW;IACrC,OAAO,GAAG;SACP,IAAI,EAAE;SACN,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC,0BAA0B;SAC9D,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,uBAAuB;SAC5C,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,uBAAuB;SAC3C,WAAW,EAAE,CAAC;AACnB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,IAAI,CAAC,GAAW,EAAE,YAAwB,EAAE,UAAsB,EAAE,QAAsB;IAAxE,6BAAA,EAAA,gBAAwB;IAAE,2BAAA,EAAA,cAAsB;IAAE,yBAAA,EAAA,cAAsB;IACxG,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACxC,IAAI,YAAY,IAAI,GAAG,CAAC,MAAM;QAAE,OAAO,GAAG,CAAC;IAE3C,IAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;IACzC,IAAM,GAAG,GAAG,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACzD,IAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,GAAG,YAAY,GAAG,UAAU,CAAC,CAAC,CAAC;IAEpF,OAAO,KAAK,GAAG,MAAM,GAAG,GAAG,CAAC;AAC9B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAC,GAAW;IACnC,OAAO,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,CAAS,EAAE,CAAS;IACnD,OAAO,CAAC,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;AAC7C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,GAAW;IACjC,OAAO,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC1C,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAW,EAAE,SAAiB,EAAE,aAA6B;IAA7B,8BAAA,EAAA,oBAA6B;IAC5F,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,GAAG,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;QACxB,SAAS,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC;IACtC,CAAC;IAED,OAAO,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;AACzC,CAAC","sourcesContent":["/*\n * The MIT License\n *\n * Copyright (c) 2025 Catbee Technologies\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\n/**\n * Capitalizes the first character of a string.\n *\n * @param {string} str - The input string.\n * @returns {string} The string with the first character in uppercase.\n */\nexport function capitalize(str: string): string {\n  return str.length === 0 ? '' : str.charAt(0).toUpperCase() + str.slice(1);\n}\n\n/**\n * Converts a string to kebab-case (e.g., \"FooBar test\" → \"foo-bar-test\").\n *\n * @param {string} str - The input string.\n * @returns {string} The kebab-cased string.\n */\nexport function toKebabCase(str: string): string {\n  return str\n    .replace(/([a-z])([A-Z])/g, '$1-$2') // camelCase -> camel-Case\n    .replace(/\\s+/g, '-') // spaces to dash\n    .replace(/_+/g, '-') // underscores to dash\n    .toLowerCase();\n}\n\n/**\n * Converts a kebab-case or snake_case string to camelCase.\n *\n * @param {string} str - The input string.\n * @returns {string} The camelCased string.\n */\nexport function toCamelCase(str: string): string {\n  return str.replace(/[-_](.)/g, (_, c: string) => c.toUpperCase());\n}\n\n/**\n * Converts a string to a URL-friendly slug (lowercase, dashes, alphanumeric).\n *\n * @param {string} str - The input string.\n * @returns {string} The slugified string.\n */\nexport function slugify(str: string): string {\n  return str\n    .toLowerCase()\n    .replace(/[^\\w\\s-]/g, '') // remove non-word\n    .replace(/\\s+/g, '-') // spaces to dash\n    .replace(/-+/g, '-') // multiple dashes to one\n    .replace(/^-+|-+$/g, ''); // trim leading/trailing dashes\n}\n\n/**\n * Truncates a string to a specific length, appending '...' if truncated.\n *\n * @param {string} str - The input string.\n * @param {number} len - The maximum length.\n * @returns {string} The truncated string.\n */\nexport function truncate(str: string, len: number): string {\n  return str.length > len ? str.slice(0, len) + '...' : str;\n}\n\n/**\n * Converts a string to PascalCase (e.g., \"foo-bar\" → \"FooBar\").\n *\n * @param {string} str - The input string.\n * @returns {string} The PascalCased string.\n */\nexport function toPascalCase(str: string): string {\n  return capitalize(toCamelCase(str));\n}\n\n/**\n * Converts a string to snake_case (e.g., \"FooBar test\" → \"foo_bar_test\").\n *\n * @param {string} str - The input string.\n * @returns {string} The snake_cased string.\n */\nexport function toSnakeCase(str: string): string {\n  return str\n    .trim()\n    .replace(/([a-z])([A-Z])/g, '$1_$2') // camelCase -> camel_Case\n    .replace(/\\s+/g, '_') // spaces to underscore\n    .replace(/-+/g, '_') // dashes to underscore\n    .toLowerCase();\n}\n\n/**\n * Masks a string by replacing characters with a mask character.\n * Useful for hiding sensitive information like credit cards or passwords.\n *\n * @param {string} str - The string to mask.\n * @param {number} [visibleStart=0] - Number of characters to show at start.\n * @param {number} [visibleEnd=0] - Number of characters to show at end.\n * @param {string} [maskChar=\"*\"] - Character to use for masking.\n * @returns {string} The masked string.\n */\nexport function mask(str: string, visibleStart: number = 0, visibleEnd: number = 0, maskChar: string = '*'): string {\n  if (!str || str.length === 0) return '';\n  if (visibleStart >= str.length) return str;\n\n  const start = str.slice(0, visibleStart);\n  const end = visibleEnd > 0 ? str.slice(-visibleEnd) : '';\n  const masked = maskChar.repeat(Math.max(0, str.length - visibleStart - visibleEnd));\n\n  return start + masked + end;\n}\n\n/**\n * Removes all HTML tags from a string.\n *\n * @param {string} str - The HTML string to process.\n * @returns {string} The string with HTML tags removed.\n */\nexport function stripHtml(str: string): string {\n  return str.replace(/<[^>]*>/g, '');\n}\n\n/**\n * Performs case-insensitive string comparison.\n *\n * @param {string} a - First string.\n * @param {string} b - Second string.\n * @returns {boolean} True if the strings are equal ignoring case.\n */\nexport function equalsIgnoreCase(a: string, b: string): boolean {\n  return a.toLowerCase() === b.toLowerCase();\n}\n\n/**\n * Reverses a string.\n *\n * @param {string} str - The string to reverse.\n * @returns {string} The reversed string.\n */\nexport function reverse(str: string): string {\n  return str.split('').reverse().join('');\n}\n\n/**\n * Counts occurrences of a substring within a string.\n *\n * @param {string} str - The source string.\n * @param {string} substring - The substring to count.\n * @param {boolean} [caseSensitive=true] - Whether to perform case-sensitive counting.\n * @returns {number} Number of occurrences.\n */\nexport function countOccurrences(str: string, substring: string, caseSensitive: boolean = true): number {\n  if (!caseSensitive) {\n    str = str.toLowerCase();\n    substring = substring.toLowerCase();\n  }\n\n  return str.split(substring).length - 1;\n}\n"]}