@xeno-js/shared 0.1.0

package/dist/shared/utils/guards.utils.js

@@ -0,0 +1,308 @@
+const OBJECT_TAG = '[object Object]';
+const DATE_TAG = '[object Date]';
+/**
+ * @description Centralized type guards and runtime predicates.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export const Guards = Object.freeze({
+    /**
+     * @description Checks value is neither null nor undefined.
+     * @param value Candidate value.
+     * @returns True when value is defined.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    isDefined(value) {
+        return value !== null && value !== undefined && value !== '' && !Number.isNaN(value);
+    },
+    /**
+     * @description Checks value is null, undefined, empty string, or false.
+     * @param value Candidate value.
+     * @returns True when value is null, undefined, empty string, or false.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    isNullOrEmpty(value) {
+        return (!Guards.isDefined(value) ||
+            (Guards.isString(value) && value.trim() === '') ||
+            (Guards.isArray(value) && value.length === 0));
+    },
+    /**
+     * @description Throws an error if the value is null, undefined, empty string, or false.
+     * @param value Candidate value.
+     * @param errorMessage Error message to throw if the check fails.
+     * @throws Error with the provided message if the value is null, undefined, empty string, or false.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    throwIfNullOrEmpty(value, errorMessage) {
+        if (Guards.isNullOrEmpty(value)) {
+            throw new Error(errorMessage);
+        }
+    },
+    /**
+     * @description Throws an error if the value is not a positive integer.
+     * @param value Candidate value.
+     * @param errorMessage Error message to throw if the check fails.
+     * @throws Error with the provided message if the value is not a positive integer.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    throwIfNegative(value, errorMessage) {
+        if (Guards.isInteger(value) && value < 0) {
+            throw new Error(errorMessage);
+        }
+    },
+    /**
+     * @description Throws an error if the value is not an integer.
+     * @param value Candidate value.
+     * @param errorMessage Error message to throw if the check fails.
+     * @throws Error with the provided message if the value is not an integer.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    throwIfNotInteger(value, errorMessage) {
+        if (!Guards.isInteger(value)) {
+            throw new Error(errorMessage);
+        }
+    },
+    /**
+     * @description Checks if an object has a method with the given name.
+     * @param obj Object to check.
+     * @param methodName Name of the method to look for.
+     * @returns True when obj has a function property named methodName.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    hasMethod(obj, methodName) {
+        if (!this.isDefined(obj))
+            return false;
+        // Essendo all'interno del namespace di utilità, l'uso di typeof qui è consentito
+        return Guards.isFunction(obj[methodName]);
+    },
+    /**
+     * @description Checks value is a string.
+     * @param value Candidate value.
+     * @returns True when value is string.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    isString(value) {
+        return typeof value === 'string';
+    },
+    /**
+     * @description Checks value is a finite number.
+     * @param value Candidate value.
+     * @returns True when value is finite number.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    isNumber(value) {
+        return typeof value === 'number' && Number.isFinite(value);
+    },
+    /**
+     * @description Checks value is an integer number.
+     * @param value Candidate value.
+     * @returns True when value is integer number.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    isInteger(value) {
+        return Guards.isNumber(value) && Number.isInteger(value);
+    },
+    /**
+     * @description Checks value is boolean.
+     * @param value Candidate value.
+     * @returns True when value is boolean.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    isBoolean(value) {
+        return typeof value === 'boolean';
+    },
+    /**
+     * @description Checks value is bigint.
+     * @param value Candidate value.
+     * @returns True when value is bigint.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    isBigInt(value) {
+        return typeof value === 'bigint';
+    },
+    /**
+     * @description Checks value is symbol.
+     * @param value Candidate value.
+     * @returns True when value is symbol.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    isSymbol(value) {
+        return typeof value === 'symbol';
+    },
+    /**
+     * @description Checks value is a function.
+     * @param value Candidate value.
+     * @returns True when value is function.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    isFunction(value) {
+        return typeof value === 'function';
+    },
+    /**
+     * @description Checks value is an array.
+     * @param value Candidate value.
+     * @returns True when value is array.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    isArray(value) {
+        return Array.isArray(value);
+    },
+    /**
+     * @description Checks value is a Date instance with valid timestamp.
+     * @param value Candidate value.
+     * @returns True when value is valid Date.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    isDate(value) {
+        if (Object.prototype.toString.call(value) !== DATE_TAG) {
+            return false;
+        }
+        return Number.isFinite(value.getTime());
+    },
+    /**
+     * @description Checks value is an Error instance.
+     * @param value Candidate value.
+     * @returns True when value is Error.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    isError(value) {
+        return value instanceof Error;
+    },
+    /**
+     * @description Checks value is a plain object record.
+     * @param value Candidate value.
+     * @returns True when value is object record.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    isObjectRecord(value) {
+        if (!Guards.isDefined(value)) {
+            return false;
+        }
+        return Object.prototype.toString.call(value) === OBJECT_TAG;
+    },
+    /**
+     * @description Checks value is an object (not null).
+     * @param value Candidate value.
+     * @returns True when value is object.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    isObject(value) {
+        return typeof value === 'object' && Guards.isDefined(value);
+    },
+    /**
+     * @description Checks value is PromiseLike.
+     * @param value Candidate value.
+     * @returns True when value has then function.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    isPromiseLike(value) {
+        if (!Guards.isDefined(value)) {
+            return false;
+        }
+        if (!Guards.isObject(value) && !Guards.isFunction(value)) {
+            return false;
+        }
+        const thenMember = value['then'];
+        return Guards.isFunction(thenMember);
+    },
+});
+//# sourceMappingURL=guards.utils.js.map

package/dist/shared/utils/guards.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"guards.utils.js","sourceRoot":"","sources":["../../../src/shared/utils/guards.utils.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,GAAG,iBAAiB,CAAA;AACpC,MAAM,QAAQ,GAAG,eAAe,CAAA;AAEhC;;;;;;;;KAQK;AACL,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAClC;;;;;;;;;;OAUG;IACH,SAAS,CAAS,KAAoB;QACpC,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IACtF,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa,CAAS,KAAoB;QACxC,OAAO,CACL,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC;YACxB,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;YAC/C,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAC9C,CAAA;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAS,KAAoB,EAAE,YAAoB;QACnE,IAAI,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAA;QAC/B,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,eAAe,CAAC,KAAa,EAAE,YAAoB;QACjD,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAA;QAC/B,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,iBAAiB,CAAC,KAAa,EAAE,YAAoB;QACnD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAA;QAC/B,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,GAAY,EAAE,UAAkB;QACxC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;YAAE,OAAO,KAAK,CAAA;QAEtC,iFAAiF;QACjF,OAAO,MAAM,CAAC,UAAU,CAAE,GAA2B,CAAC,UAAU,CAAC,CAAC,CAAA;IACpE,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,KAAc;QACrB,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAA;IAClC,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,KAAc;QACrB,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;IAC5D,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CAAC,KAAc;QACtB,OAAO,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;IAC1D,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CAAC,KAAc;QACtB,OAAO,OAAO,KAAK,KAAK,SAAS,CAAA;IACnC,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,KAAc;QACrB,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAA;IAClC,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,KAAc;QACrB,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAA;IAClC,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU,CAAC,KAAc;QACvB,OAAO,OAAO,KAAK,KAAK,UAAU,CAAA;IACpC,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAS,KAAc;QAC5B,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;IAC7B,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,KAAc;QACnB,IAAI,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,CAAC;YACvD,OAAO,KAAK,CAAA;QACd,CAAC;QAED,OAAO,MAAM,CAAC,QAAQ,CAAE,KAAc,CAAC,OAAO,EAAE,CAAC,CAAA;IACnD,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,KAAc;QACpB,OAAO,KAAK,YAAY,KAAK,CAAA;IAC/B,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc,CAAC,KAAc;QAC3B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,OAAO,KAAK,CAAA;QACd,CAAC;QAED,OAAO,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,UAAU,CAAA;IAC7D,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,KAAc;QACrB,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;IAC7D,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa,CAAS,KAAc;QAClC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,OAAO,KAAK,CAAA;QACd,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YACzD,OAAO,KAAK,CAAA;QACd,CAAC;QAED,MAAM,UAAU,GAAI,KAA6B,CAAC,MAAM,CAAC,CAAA;QACzD,OAAO,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;IACtC,CAAC;CACO,CAAC,CAAA"}

package/dist/shared/utils/guid.utils.d.ts

@@ -0,0 +1,73 @@
+import type { Guid, Optional } from '../types/common.types';
+/**
+ * @fileoverview Utility functions for generating and validating GUIDs (UUID v4).
+ * This module provides a simple interface for working with GUIDs, including generation and validation.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export declare const GuidHelper: Readonly<{
+    /**
+     * @description Generates a cryptographically-random UUID v4.
+     * @returns Lowercase UUID v4 string.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly generate: () => Guid;
+    /**
+     * @description Validates if a value is a valid GUID (UUID v4) and not empty.
+     * @param value The value to validate.
+     * @returns True if the value is a valid and non-empty GUID, false otherwise.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly isValidGuid: (value: Guid) => boolean;
+    /**
+     * @description Validates if a string is a valid UUID v4.
+     * @param value Candidate string to validate.
+     * @returns True if the string is a valid UUID v4, false otherwise.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly isValid: (value: string) => value is Guid;
+    /**
+     * @description Converts a string to a GUID if it's valid.
+     * @param value The string to convert.
+     * @returns The GUID if the string is valid, otherwise undefined.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly parse: (value: Optional<string>) => Optional<Guid>;
+    /**
+     * @description Checks if a GUID is the empty GUID (all zeros).
+     * @param value The GUID to check.
+     * @returns True if the GUID is the empty GUID, false otherwise.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly isEmpty: (value: string) => boolean;
+}>;
+//# sourceMappingURL=guid.utils.d.ts.map

package/dist/shared/utils/guid.utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guid.utils.d.ts","sourceRoot":"","sources":["../../../src/shared/utils/guid.utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAG3D;;;;;;;;;KASK;AACL,eAAO,MAAM,UAAU;IACrB;;;;;;;;;OASG;6BACS,IAAI;IAIhB;;;;;;;;;;OAUG;kCACgB,IAAI,KAAG,OAAO;IAKjC;;;;;;;;;;OAUG;8BACY,MAAM,KAAG,KAAK,IAAI,IAAI;IAKrC;;;;;;;;;;OAUG;4BACU,QAAQ,CAAC,MAAM,CAAC,KAAG,QAAQ,CAAC,IAAI,CAAC;IAO9C;;;;;;;;;;OAUG;8BACY,MAAM,KAAG,OAAO;EAItB,CAAA"}

package/dist/shared/utils/guid.utils.js

@@ -0,0 +1,89 @@
+import { Guards } from './guards.utils';
+/**
+ * @fileoverview Utility functions for generating and validating GUIDs (UUID v4).
+ * This module provides a simple interface for working with GUIDs, including generation and validation.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export const GuidHelper = Object.freeze({
+    /**
+     * @description Generates a cryptographically-random UUID v4.
+     * @returns Lowercase UUID v4 string.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    generate() {
+        return crypto.randomUUID();
+    },
+    /**
+     * @description Validates if a value is a valid GUID (UUID v4) and not empty.
+     * @param value The value to validate.
+     * @returns True if the value is a valid and non-empty GUID, false otherwise.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    isValidGuid(value) {
+        const guid = value.toString();
+        return GuidHelper.isValid(guid) && !GuidHelper.isEmpty(guid);
+    },
+    /**
+     * @description Validates if a string is a valid UUID v4.
+     * @param value Candidate string to validate.
+     * @returns True if the string is a valid UUID v4, false otherwise.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    isValid(value) {
+        const uuidRegex = /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
+        return uuidRegex.test(value);
+    },
+    /**
+     * @description Converts a string to a GUID if it's valid.
+     * @param value The string to convert.
+     * @returns The GUID if the string is valid, otherwise undefined.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    parse(value) {
+        if (!Guards.isNullOrEmpty(value) && this.isValid(value) && !this.isEmpty(value)) {
+            return value;
+        }
+        return undefined;
+    },
+    /**
+     * @description Checks if a GUID is the empty GUID (all zeros).
+     * @param value The GUID to check.
+     * @returns True if the GUID is the empty GUID, false otherwise.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    isEmpty(value) {
+        const emptyGuid = '00000000-0000-0000-0000-000000000000';
+        return value === emptyGuid;
+    },
+});
+//# sourceMappingURL=guid.utils.js.map

package/dist/shared/utils/guid.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"guid.utils.js","sourceRoot":"","sources":["../../../src/shared/utils/guid.utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAEvC;;;;;;;;;KASK;AACL,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC;IACtC;;;;;;;;;OASG;IACH,QAAQ;QACN,OAAO,MAAM,CAAC,UAAU,EAAE,CAAA;IAC5B,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CAAC,KAAW;QACrB,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAA;QAC7B,OAAO,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IAC9D,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,KAAa;QACnB,MAAM,SAAS,GAAG,wEAAwE,CAAA;QAC1F,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC9B,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,KAAuB;QAC3B,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAChF,OAAO,KAAK,CAAA;QACd,CAAC;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO,CAAC,KAAa;QACnB,MAAM,SAAS,GAAG,sCAAsC,CAAA;QACxD,OAAO,KAAK,KAAK,SAAS,CAAA;IAC5B,CAAC;CACO,CAAC,CAAA"}

package/dist/shared/utils/http.utils.d.ts

@@ -0,0 +1,75 @@
+import type { Dictionary, ErrorResponseDto, HttpHeaders, IPaginatedResult, Optional, ResponseDto } from '../types/index';
+/**
+ * @description This module provides utility functions for handling HTTP-related tasks, such as normalizing HTTP headers. It includes a single function, `normalizeHeaders`, which takes an input of unknown type and returns an object with normalized header values. The function ensures that all header values are converted to strings, and if a header value is an array, it joins the elements into a single string separated by commas. This utility is useful for ensuring consistent header formats when working with various HTTP client libraries.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+/**
+ * @description A helper object that provides utility functions for HTTP-related tasks. Currently, it includes a method for normalizing HTTP headers, which ensures that all header values are strings and handles cases where header values may be arrays. This helper can be extended in the future to include additional HTTP-related utilities as needed.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export declare const HttpHelper: Readonly<{
+    /**
+     * @description Normalizes HTTP headers by converting all header values to strings. If a header value is an array, it joins the array elements into a single string separated by commas. This method ensures that the headers are in a consistent format, which can be particularly useful when working with different HTTP client libraries that may represent headers in various ways. If the input headers are not defined or not an object, it returns an empty object.
+     * @param headers The input headers to be normalized, which can be of any type. The method checks if the headers are defined and are an object before processing them.
+     * @returns An object containing the normalized headers, where each header value is a string. If the input headers were not valid, it returns an empty object.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly normalizeHeaders: (headers: unknown) => HttpHeaders;
+    /**
+     * @description Sanitizes the origin URL by parsing it and extracting the origin part. If the URL is not valid or cannot be parsed or does not contain an origin, it returns undefined.
+     * @param url The URL to be sanitized.
+     * @returns The sanitized origin URL or undefined if the URL is not valid or cannot be parsed or does not contain an origin.
+     *
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly sanitizeOriginUrl: (url: Optional<string>) => Optional<string>;
+    /**
+     * @description Generates a standardized successful HTTP response with the provided data, status code, metadata, and custom headers. The response includes a success flag set to true, the data payload, and any additional metadata. The headers include a default 'Content-Type' of 'application/json' along with any custom headers provided.
+     * @param data The actual data payload to be included in the successful response. This can be of any type and will be wrapped in a SuccessResponseDto structure.
+     * @param status The HTTP status code for the response, defaulting to 200 (OK) if not provided. This allows for flexibility in indicating different types of successful responses (e.g., 201 for created, 204 for no content).
+     * @param meta Optional metadata to be included in the response. This can contain additional information relevant to the response, such as pagination details, rate limit information, or any other contextual data that may be useful for clients consuming the API.
+     * @param customHeaders Optional custom HTTP headers to be included in the response. This allows for adding any additional headers that may be necessary for specific responses, such as caching directives, custom authentication headers, or other relevant information.
+     * @returns A ResponseDto object representing the successful HTTP response, containing the status code, success flag, headers, and data payload structured as a SuccessResponseDto.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly success: <T>(data: T | IPaginatedResult<T>, status?: number, meta?: Dictionary, customHeaders?: HttpHeaders) => ResponseDto<T>;
+    /**
+     * @description Generates a standardized error HTTP response with the provided error details, status code, correlation ID, request ID, timestamp, and custom headers. The response includes a success flag set to false, an error object containing the error code, message, and optional details, as well as metadata such as correlation ID and request ID for tracking purposes. The headers include a default 'Content-Type' of 'application/json' along with any custom headers provided.
+     * @param dto An object containing the error details, including the error code, message, optional details, and optional path. This information is structured as an ErrorResponseDto and provides context about the error that occurred.
+     * @param status The HTTP status code for the response, defaulting to 500 (Internal Server Error) if not provided. This allows for flexibility in indicating different types of error responses (e.g., 400 for bad request, 404 for not found).
+     * @param customHeaders Optional custom HTTP headers to be included in the response. This allows for adding any additional headers that may be necessary for specific error responses, such as caching directives, custom authentication headers, or other relevant information.
+     * @returns A ResponseDto object representing the error HTTP response, containing the status code, success flag, headers, and data payload structured as an ErrorResponseDto.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly error: <T>(dto: ErrorResponseDto, status?: Optional<number>, customHeaders?: Optional<HttpHeaders>) => ResponseDto<T>;
+}>;
+//# sourceMappingURL=http.utils.d.ts.map

package/dist/shared/utils/http.utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.utils.d.ts","sourceRoot":"","sources":["../../../src/shared/utils/http.utils.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,UAAU,EACV,gBAAgB,EAChB,WAAW,EACX,gBAAgB,EAChB,QAAQ,EACR,WAAW,EAEZ,MAAM,gBAAgB,CAAA;AAIvB;;;;;;;;KAQK;AAEL;;;;;;;;KAQK;AACL,eAAO,MAAM,UAAU;IACrB;;;;;;;;;;OAUG;yCACuB,OAAO,KAAG,WAAW;IAgB/C;;;;;;;;;;OAUG;sCACoB,QAAQ,CAAC,MAAM,CAAC,KAAG,QAAQ,CAAC,MAAM,CAAC;IAS1D;;;;;;;;;;;;;OAaG;uBACK,CAAC,QACD,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,0BAEvB,UAAU,kBACD,WAAW,KACzB,WAAW,CAAC,CAAC,CAAC;IAkBjB;;;;;;;;;;;;OAYG;qBACG,CAAC,OACA,gBAAgB,WACb,QAAQ,CAAC,MAAM,CAAC,kBACT,QAAQ,CAAC,WAAW,CAAC,KACnC,WAAW,CAAC,CAAC,CAAC;EA+BR,CAAA"}