@arcraz/common 1.0.0

package/dist/database/helpers/paged-response-helper.d.ts

@@ -0,0 +1,33 @@
+import type { PagedResponse } from '../types.js';
+/**
+ * Helper class for handling paginated database queries
+ */
+export declare class PagedResponseHelper<T = unknown> {
+    readonly pageNumber: number;
+    readonly pageSize: number;
+    constructor(page?: number, size?: number);
+    /**
+     * Get LIMIT value for SQL query
+     */
+    get limit(): number;
+    /**
+     * Get OFFSET value for SQL query
+     */
+    get offset(): number;
+    /**
+     * Calculate total page count from total results
+     * @param totalResults Total number of results
+     * @returns Number of pages
+     */
+    pageCount(totalResults: number): number;
+    /**
+     * Build a PagedResponse from query results
+     * Expects results to have a `fullCount` property from COUNT(*) OVER()
+     * @param results Query results with optional fullCount property
+     * @returns Formatted PagedResponse
+     */
+    result(results?: (T & {
+        fullCount?: string | number;
+    })[] | null | undefined): PagedResponse<T>;
+}
+//# sourceMappingURL=paged-response-helper.d.ts.map

package/dist/database/helpers/paged-response-helper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paged-response-helper.d.ts","sourceRoot":"","sources":["../../../src/database/helpers/paged-response-helper.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAGjD;;GAEG;AACH,qBAAa,mBAAmB,CAAC,CAAC,GAAG,OAAO;IAC1C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;gBAEd,IAAI,GAAE,MAAyC,EAAE,IAAI,GAAE,MAAsC;IAKzG;;OAEG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;;;OAIG;IACH,SAAS,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM;IAOvC;;;;;OAKG;IACH,MAAM,CAAC,OAAO,GAAE,CAAC,CAAC,GAAG;QAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC,EAAE,GAAG,IAAI,GAAG,SAAc,GAAG,aAAa,CAAC,CAAC,CAAC;CA2BnG"}

package/dist/database/helpers/paged-response-helper.js

@@ -0,0 +1,64 @@
+import { PAGINATION_DEFAULTS } from '../../constants/defaults.js';
+/**
+ * Helper class for handling paginated database queries
+ */
+export class PagedResponseHelper {
+    pageNumber;
+    pageSize;
+    constructor(page = PAGINATION_DEFAULTS.DEFAULT_PAGE, size = PAGINATION_DEFAULTS.PAGE_SIZE) {
+        this.pageNumber = Math.max(1, page);
+        this.pageSize = Math.min(Math.max(1, size), PAGINATION_DEFAULTS.MAX_PAGE_SIZE);
+    }
+    /**
+     * Get LIMIT value for SQL query
+     */
+    get limit() {
+        return this.pageSize;
+    }
+    /**
+     * Get OFFSET value for SQL query
+     */
+    get offset() {
+        return (this.pageNumber - 1) * this.pageSize;
+    }
+    /**
+     * Calculate total page count from total results
+     * @param totalResults Total number of results
+     * @returns Number of pages
+     */
+    pageCount(totalResults) {
+        if (totalResults <= 0 || this.pageSize <= 0) {
+            return 0;
+        }
+        return Math.ceil(totalResults / this.pageSize);
+    }
+    /**
+     * Build a PagedResponse from query results
+     * Expects results to have a `fullCount` property from COUNT(*) OVER()
+     * @param results Query results with optional fullCount property
+     * @returns Formatted PagedResponse
+     */
+    result(results = []) {
+        let count = 0;
+        let processedResults = results ? [...results] : [];
+        if (processedResults.length > 0) {
+            const firstResult = processedResults[0];
+            if (firstResult?.fullCount !== undefined) {
+                const parsedCount = parseInt(String(firstResult.fullCount), 10);
+                count = isNaN(parsedCount) ? 0 : parsedCount;
+                // Remove fullCount from all results
+                processedResults = processedResults.map((result) => {
+                    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+                    const { fullCount: _fullCount, ...rest } = result;
+                    return rest;
+                });
+            }
+        }
+        return {
+            pageNumber: this.pageNumber,
+            pageCount: this.pageCount(count),
+            totalCount: count,
+            results: processedResults
+        };
+    }
+}

package/dist/database/index.d.ts

@@ -0,0 +1,6 @@
+export { createDatabasePool, queryWithCamelCase, queryOneWithCamelCase } from './pool-factory.js';
+export { BaseRepository } from './base-repository.js';
+export { camelCaseRows, camelCaseRow, snakeCaseKeys, setupTypeParsers, parsePostgresArray, toPostgresArray } from './query-helpers.js';
+export { ConverterHelper, PagedResponseHelper } from './helpers/index.js';
+export type { DatabasePool, DatabasePoolConfig, QueryOptions, PagedResponse } from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/database/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/database/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACvI,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC1E,YAAY,EAAE,YAAY,EAAE,kBAAkB,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC"}

package/dist/database/index.js

@@ -0,0 +1,4 @@
+export { createDatabasePool, queryWithCamelCase, queryOneWithCamelCase } from './pool-factory.js';
+export { BaseRepository } from './base-repository.js';
+export { camelCaseRows, camelCaseRow, snakeCaseKeys, setupTypeParsers, parsePostgresArray, toPostgresArray } from './query-helpers.js';
+export { ConverterHelper, PagedResponseHelper } from './helpers/index.js';

package/dist/database/pool-factory.d.ts

@@ -0,0 +1,24 @@
+import type { DatabasePool, DatabasePoolConfig } from './types.js';
+/**
+ * Creates a new database pool instance
+ * @param config Database configuration
+ * @returns DatabasePool instance with query methods
+ */
+export declare function createDatabasePool(config: DatabasePoolConfig): DatabasePool;
+/**
+ * Executes a query and returns camelCased results
+ * @param dbPool Database pool instance
+ * @param text SQL query text
+ * @param values Query parameter values
+ * @returns Array of camelCased result rows
+ */
+export declare function queryWithCamelCase<T>(dbPool: DatabasePool, text: string, values?: unknown[]): Promise<T[]>;
+/**
+ * Executes a query and returns a single camelCased result
+ * @param dbPool Database pool instance
+ * @param text SQL query text
+ * @param values Query parameter values
+ * @returns Single camelCased result or null
+ */
+export declare function queryOneWithCamelCase<T>(dbPool: DatabasePool, text: string, values?: unknown[]): Promise<T | null>;
+//# sourceMappingURL=pool-factory.d.ts.map

package/dist/database/pool-factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pool-factory.d.ts","sourceRoot":"","sources":["../../src/database/pool-factory.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAMnE;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,kBAAkB,GAAG,YAAY,CAkE3E;AAED;;;;;;GAMG;AACH,wBAAsB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAGhH;AAED;;;;;;GAMG;AACH,wBAAsB,qBAAqB,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAGxH"}

package/dist/database/pool-factory.js

@@ -0,0 +1,91 @@
+import pg from 'pg';
+import { DATABASE_DEFAULTS } from '../constants/defaults.js';
+import { camelCaseRows } from './query-helpers.js';
+const { Pool } = pg;
+/**
+ * Creates a new database pool instance
+ * @param config Database configuration
+ * @returns DatabasePool instance with query methods
+ */
+export function createDatabasePool(config) {
+    const pool = new Pool({
+        host: config.host,
+        port: config.port ?? 5432,
+        database: config.database,
+        user: config.user,
+        password: config.password,
+        ssl: config.ssl ?? false,
+        max: config.maxConnections ?? DATABASE_DEFAULTS.MAX_CONNECTIONS,
+        idleTimeoutMillis: config.idleTimeoutMs ?? DATABASE_DEFAULTS.IDLE_TIMEOUT_MS,
+        connectionTimeoutMillis: config.connectionTimeoutMs ?? DATABASE_DEFAULTS.CONNECTION_TIMEOUT_MS,
+        statement_timeout: config.statementTimeoutMs ?? DATABASE_DEFAULTS.STATEMENT_TIMEOUT_MS
+    });
+    let connected = false;
+    pool.on('connect', () => {
+        connected = true;
+    });
+    pool.on('error', (err) => {
+        console.error('Unexpected database pool error:', err);
+        connected = false;
+    });
+    async function query(text, values) {
+        const result = await pool.query(text, values);
+        return result;
+    }
+    async function getClient() {
+        return pool.connect();
+    }
+    async function transaction(fn) {
+        const client = await pool.connect();
+        try {
+            await client.query('BEGIN');
+            const result = await fn(client);
+            await client.query('COMMIT');
+            return result;
+        }
+        catch (error) {
+            await client.query('ROLLBACK');
+            throw error;
+        }
+        finally {
+            client.release();
+        }
+    }
+    async function close() {
+        await pool.end();
+        connected = false;
+    }
+    function isConnected() {
+        return connected && pool.totalCount > 0;
+    }
+    return {
+        pool,
+        query,
+        getClient,
+        transaction,
+        close,
+        isConnected
+    };
+}
+/**
+ * Executes a query and returns camelCased results
+ * @param dbPool Database pool instance
+ * @param text SQL query text
+ * @param values Query parameter values
+ * @returns Array of camelCased result rows
+ */
+export async function queryWithCamelCase(dbPool, text, values) {
+    const result = await dbPool.query(text, values);
+    return camelCaseRows(result.rows);
+}
+/**
+ * Executes a query and returns a single camelCased result
+ * @param dbPool Database pool instance
+ * @param text SQL query text
+ * @param values Query parameter values
+ * @returns Single camelCased result or null
+ */
+export async function queryOneWithCamelCase(dbPool, text, values) {
+    const results = await queryWithCamelCase(dbPool, text, values);
+    return results[0] ?? null;
+}

package/dist/database/query-helpers.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Converts query result rows from snake_case to camelCase
+ * @param rows Array of row objects to convert
+ * @returns Array with camelCase keys
+ */
+export declare function camelCaseRows<T>(rows: Record<string, unknown>[]): T[];
+/**
+ * Converts a single row from snake_case to camelCase
+ * @param row Row object to convert
+ * @returns Object with camelCase keys
+ */
+export declare function camelCaseRow<T>(row: Record<string, unknown> | null | undefined): T | null;
+/**
+ * Converts object keys from camelCase to snake_case for database insertion
+ * @param obj Object with camelCase keys
+ * @returns Object with snake_case keys
+ */
+export declare function snakeCaseKeys<T extends Record<string, unknown>>(obj: T): Record<string, unknown>;
+/**
+ * Sets up custom type parsers for PostgreSQL
+ * Call this once at application startup
+ */
+export declare function setupTypeParsers(): void;
+/**
+ * Converts a PostgreSQL array string to a TypeScript array
+ * @param value PostgreSQL array string like "{a,b,c}"
+ * @returns Parsed array
+ */
+export declare function parsePostgresArray<T = string>(value: string | null | undefined): T[];
+/**
+ * Formats a TypeScript array as a PostgreSQL array literal
+ * @param arr Array to format
+ * @returns PostgreSQL array literal string
+ */
+export declare function toPostgresArray(arr: (string | number)[]): string;
+//# sourceMappingURL=query-helpers.d.ts.map

package/dist/database/query-helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-helpers.d.ts","sourceRoot":"","sources":["../../src/database/query-helpers.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,CAAC,EAAE,CAErE;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,CAAC,GAAG,IAAI,CAGzF;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEhG;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAevC;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,GAAG,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,CAAC,EAAE,CAOpF;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,MAAM,CAEhE"}

package/dist/database/query-helpers.js

@@ -0,0 +1,68 @@
+import * as humps from 'humps';
+import pg from 'pg';
+/**
+ * Converts query result rows from snake_case to camelCase
+ * @param rows Array of row objects to convert
+ * @returns Array with camelCase keys
+ */
+export function camelCaseRows(rows) {
+    return rows.map((row) => humps.camelizeKeys(row));
+}
+/**
+ * Converts a single row from snake_case to camelCase
+ * @param row Row object to convert
+ * @returns Object with camelCase keys
+ */
+export function camelCaseRow(row) {
+    if (!row)
+        return null;
+    return humps.camelizeKeys(row);
+}
+/**
+ * Converts object keys from camelCase to snake_case for database insertion
+ * @param obj Object with camelCase keys
+ * @returns Object with snake_case keys
+ */
+export function snakeCaseKeys(obj) {
+    return humps.decamelizeKeys(obj);
+}
+/**
+ * Sets up custom type parsers for PostgreSQL
+ * Call this once at application startup
+ */
+export function setupTypeParsers() {
+    // Parse NUMERIC as float instead of string
+    pg.types.setTypeParser(1700, (val) => parseFloat(val));
+    // Keep DATE as string instead of converting to Date object
+    pg.types.setTypeParser(1082, (val) => val);
+    // Parse BIGINT as number (be careful with very large numbers)
+    pg.types.setTypeParser(20, (val) => {
+        const num = parseInt(val, 10);
+        if (num > Number.MAX_SAFE_INTEGER || num < Number.MIN_SAFE_INTEGER) {
+            return BigInt(val);
+        }
+        return num;
+    });
+}
+/**
+ * Converts a PostgreSQL array string to a TypeScript array
+ * @param value PostgreSQL array string like "{a,b,c}"
+ * @returns Parsed array
+ */
+export function parsePostgresArray(value) {
+    if (!value)
+        return [];
+    return value
+        .replace(/^\{/, '')
+        .replace(/\}$/, '')
+        .split(',')
+        .filter((item) => item.length > 0);
+}
+/**
+ * Formats a TypeScript array as a PostgreSQL array literal
+ * @param arr Array to format
+ * @returns PostgreSQL array literal string
+ */
+export function toPostgresArray(arr) {
+    return `{${arr.join(',')}}`;
+}

package/dist/database/types.d.ts

@@ -0,0 +1,55 @@
+import type { Pool, PoolClient, QueryResult, QueryResultRow } from 'pg';
+/**
+ * Database pool instance interface
+ */
+export interface DatabasePool {
+    /** The underlying pg Pool */
+    pool: Pool;
+    /** Execute a query with automatic connection handling */
+    query<T extends QueryResultRow = QueryResultRow>(text: string, values?: unknown[]): Promise<QueryResult<T>>;
+    /** Get a client from the pool for transactions */
+    getClient(): Promise<PoolClient>;
+    /** Execute a transaction with automatic commit/rollback */
+    transaction<T>(fn: (client: PoolClient) => Promise<T>): Promise<T>;
+    /** Close the pool */
+    close(): Promise<void>;
+    /** Check if pool is connected */
+    isConnected(): boolean;
+}
+/**
+ * Database configuration for pool creation
+ */
+export interface DatabasePoolConfig {
+    name?: string;
+    host: string;
+    port?: number;
+    database: string;
+    user: string;
+    password: string;
+    ssl?: boolean | {
+        rejectUnauthorized: boolean;
+    };
+    maxConnections?: number;
+    idleTimeoutMs?: number;
+    connectionTimeoutMs?: number;
+    statementTimeoutMs?: number;
+}
+/**
+ * Query options for executing statements
+ */
+export interface QueryOptions {
+    /** Statement timeout in milliseconds */
+    timeout?: number;
+    /** Whether to camelCase result column names */
+    camelCase?: boolean;
+}
+/**
+ * Paged response wrapper for paginated queries
+ */
+export interface PagedResponse<T> {
+    pageNumber: number;
+    pageCount: number;
+    totalCount: number;
+    results: T[];
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/database/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/database/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,IAAI,CAAC;AAExE;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,6BAA6B;IAC7B,IAAI,EAAE,IAAI,CAAC;IACX,yDAAyD;IACzD,KAAK,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5G,kDAAkD;IAClD,SAAS,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC;IACjC,2DAA2D;IAC3D,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACnE,qBAAqB;IACrB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB,iCAAiC;IACjC,WAAW,IAAI,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,OAAO,GAAG;QAAE,kBAAkB,EAAE,OAAO,CAAA;KAAE,CAAC;IAChD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,wCAAwC;IACxC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+CAA+C;IAC/C,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,CAAC,EAAE,CAAC;CACd"}

package/dist/database/types.js

@@ -0,0 +1 @@
+export {};

package/dist/helpers/data-obscurer.d.ts

@@ -0,0 +1,18 @@
+export interface DataObscurerOptions {
+    placeholder?: string;
+    showLeft?: number;
+    showRight?: number;
+    trim?: number;
+}
+/**
+ * Obscures sensitive data by replacing middle characters with placeholders
+ * @param toObscure String to obscure
+ * @param options Obscuring options
+ * @returns Obscured string
+ */
+export declare function obscureData(toObscure: string, options?: DataObscurerOptions): string;
+/**
+ * @deprecated Use obscureData instead
+ */
+export default function (toObscure: string, options?: DataObscurerOptions): string;
+//# sourceMappingURL=data-obscurer.d.ts.map

package/dist/helpers/data-obscurer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-obscurer.d.ts","sourceRoot":"","sources":["../../src/helpers/data-obscurer.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,mBAAmB;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AASD;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB,GAAG,MAAM,CAYxF;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,SAAS,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB,GAAG,MAAM,CAErF"}

package/dist/helpers/data-obscurer.js

@@ -0,0 +1,29 @@
+import hideText from 'hide-text';
+const defaultOptions = {
+    placeholder: '#',
+    showLeft: 4,
+    showRight: 4,
+    trim: 0
+};
+/**
+ * Obscures sensitive data by replacing middle characters with placeholders
+ * @param toObscure String to obscure
+ * @param options Obscuring options
+ * @returns Obscured string
+ */
+export function obscureData(toObscure, options = {}) {
+    if (!toObscure) {
+        return '';
+    }
+    const mergedOptions = { ...defaultOptions, ...options };
+    if (toObscure.length <= (mergedOptions.showLeft || 0) + (mergedOptions.showRight || 0)) {
+        return toObscure;
+    }
+    return hideText(toObscure, mergedOptions);
+}
+/**
+ * @deprecated Use obscureData instead
+ */
+export default function (toObscure, options = {}) {
+    return obscureData(toObscure, options);
+}

package/dist/helpers/enum-converters.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Safely converts a value to an enum type
+ * @param value Value to convert
+ * @param enumType Enum object to validate against
+ * @returns The value as enum type or null if invalid
+ */
+export declare function convertToEnum<ET>(value: unknown, enumType: Record<string, unknown>): ET | null;
+/**
+ * Checks if a value is a valid enum member
+ * @param value Value to check
+ * @param enumType Enum object to validate against
+ * @returns True if value is a valid enum member
+ */
+export declare function isValidEnumValue<ET>(value: unknown, enumType: Record<string, unknown>): value is ET;
+/**
+ * Gets all values of an enum
+ * @param enumType Enum object
+ * @returns Array of enum values
+ */
+export declare function getEnumValues<T>(enumType: Record<string, T>): T[];
+/**
+ * Gets all keys of an enum
+ * @param enumType Enum object
+ * @returns Array of enum keys
+ */
+export declare function getEnumKeys(enumType: Record<string, unknown>): string[];
+//# sourceMappingURL=enum-converters.d.ts.map

package/dist/helpers/enum-converters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enum-converters.d.ts","sourceRoot":"","sources":["../../src/helpers/enum-converters.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,IAAI,CAK9F;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,KAAK,IAAI,EAAE,CAEnG;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAEjE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,EAAE,CAEvE"}

package/dist/helpers/enum-converters.js

@@ -0,0 +1,37 @@
+/**
+ * Safely converts a value to an enum type
+ * @param value Value to convert
+ * @param enumType Enum object to validate against
+ * @returns The value as enum type or null if invalid
+ */
+export function convertToEnum(value, enumType) {
+    if (Object.values(enumType).includes(value)) {
+        return value;
+    }
+    return null;
+}
+/**
+ * Checks if a value is a valid enum member
+ * @param value Value to check
+ * @param enumType Enum object to validate against
+ * @returns True if value is a valid enum member
+ */
+export function isValidEnumValue(value, enumType) {
+    return Object.values(enumType).includes(value);
+}
+/**
+ * Gets all values of an enum
+ * @param enumType Enum object
+ * @returns Array of enum values
+ */
+export function getEnumValues(enumType) {
+    return Object.values(enumType);
+}
+/**
+ * Gets all keys of an enum
+ * @param enumType Enum object
+ * @returns Array of enum keys
+ */
+export function getEnumKeys(enumType) {
+    return Object.keys(enumType).filter((key) => isNaN(Number(key)));
+}

package/dist/helpers/index.d.ts

@@ -0,0 +1,5 @@
+export { obscureData } from './data-obscurer.js';
+export type { DataObscurerOptions } from './data-obscurer.js';
+export { convertToEnum, isValidEnumValue, getEnumValues, getEnumKeys } from './enum-converters.js';
+export { removeSensitiveValues, redactSensitiveValues, DEFAULT_SENSITIVE_KEYS } from './remove-sensitive-values.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/helpers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,YAAY,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAE9D,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnG,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC"}

package/dist/helpers/index.js

@@ -0,0 +1,3 @@
+export { obscureData } from './data-obscurer.js';
+export { convertToEnum, isValidEnumValue, getEnumValues, getEnumKeys } from './enum-converters.js';
+export { removeSensitiveValues, redactSensitiveValues, DEFAULT_SENSITIVE_KEYS } from './remove-sensitive-values.js';

package/dist/helpers/remove-sensitive-values.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Recursively removes specified keys from an object
+ * @param obj Object to process
+ * @param keysToRemove Keys to remove
+ * @returns New object with keys removed
+ */
+export declare function removeSensitiveValues<T>(obj: T, keysToRemove: string[]): T;
+/**
+ * Redacts specified keys by replacing their values with a placeholder
+ * @param obj Object to process
+ * @param keysToRedact Keys to redact
+ * @param placeholder Replacement value (default: '[REDACTED]')
+ * @returns New object with keys redacted
+ */
+export declare function redactSensitiveValues<T>(obj: T, keysToRedact: string[], placeholder?: string): T;
+/**
+ * Default sensitive keys commonly found in applications
+ */
+export declare const DEFAULT_SENSITIVE_KEYS: readonly ["password", "secret", "token", "apiKey", "api_key", "accessToken", "access_token", "refreshToken", "refresh_token", "privateKey", "private_key", "ssn", "creditCard", "credit_card", "cardNumber", "card_number", "cvv", "authorization"];
+//# sourceMappingURL=remove-sensitive-values.d.ts.map

package/dist/helpers/remove-sensitive-values.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remove-sensitive-values.d.ts","sourceRoot":"","sources":["../../src/helpers/remove-sensitive-values.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,CAAC,CAoB1E;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,WAAW,GAAE,MAAqB,GAAG,CAAC,CAoB9G;AAED;;GAEG;AACH,eAAO,MAAM,sBAAsB,qPAmBzB,CAAC"}

package/dist/helpers/remove-sensitive-values.js

@@ -0,0 +1,72 @@
+/**
+ * Recursively removes specified keys from an object
+ * @param obj Object to process
+ * @param keysToRemove Keys to remove
+ * @returns New object with keys removed
+ */
+export function removeSensitiveValues(obj, keysToRemove) {
+    if (obj === null || typeof obj !== 'object') {
+        return obj;
+    }
+    if (Array.isArray(obj)) {
+        return obj.map((item) => removeSensitiveValues(item, keysToRemove));
+    }
+    const objCopy = { ...obj };
+    for (const key of Object.keys(objCopy)) {
+        if (keysToRemove.includes(key)) {
+            delete objCopy[key];
+        }
+        else if (typeof objCopy[key] === 'object' && objCopy[key] !== null) {
+            objCopy[key] = removeSensitiveValues(objCopy[key], keysToRemove);
+        }
+    }
+    return objCopy;
+}
+/**
+ * Redacts specified keys by replacing their values with a placeholder
+ * @param obj Object to process
+ * @param keysToRedact Keys to redact
+ * @param placeholder Replacement value (default: '[REDACTED]')
+ * @returns New object with keys redacted
+ */
+export function redactSensitiveValues(obj, keysToRedact, placeholder = '[REDACTED]') {
+    if (obj === null || typeof obj !== 'object') {
+        return obj;
+    }
+    if (Array.isArray(obj)) {
+        return obj.map((item) => redactSensitiveValues(item, keysToRedact, placeholder));
+    }
+    const objCopy = { ...obj };
+    for (const key of Object.keys(objCopy)) {
+        if (keysToRedact.includes(key)) {
+            objCopy[key] = placeholder;
+        }
+        else if (typeof objCopy[key] === 'object' && objCopy[key] !== null) {
+            objCopy[key] = redactSensitiveValues(objCopy[key], keysToRedact, placeholder);
+        }
+    }
+    return objCopy;
+}
+/**
+ * Default sensitive keys commonly found in applications
+ */
+export const DEFAULT_SENSITIVE_KEYS = [
+    'password',
+    'secret',
+    'token',
+    'apiKey',
+    'api_key',
+    'accessToken',
+    'access_token',
+    'refreshToken',
+    'refresh_token',
+    'privateKey',
+    'private_key',
+    'ssn',
+    'creditCard',
+    'credit_card',
+    'cardNumber',
+    'card_number',
+    'cvv',
+    'authorization'
+];

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+export * from './config/index.js';
+export * from './constants/index.js';
+export * from './database/index.js';
+export * from './redis/index.js';
+export * from './rabbitmq/index.js';
+export * from './caches/index.js';
+export * from './logging/index.js';
+export * from './security/index.js';
+export * from './helpers/index.js';
+export * from './types/index.js';
+//# sourceMappingURL=index.d.ts.map