@xeno-js/shared 0.1.0

package/dist/shared/constants/log-level.constants.js

@@ -0,0 +1,89 @@
+/**
+ *  Log levels for the logger.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export const LOG_LEVEL = Object.freeze({
+    /** * Debug level for detailed debugging information. This level is typically used during development and should be turned off in production to avoid verbose logging.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    DEBUG: 0,
+    /** * Info level for general informational messages that highlight the progress of the application at a coarse-grained level. This level is suitable for production environments to track the normal operation of the application.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    INFO: 1,
+    /** * Warn level for potentially harmful situations that are not necessarily errors but may require attention. This level is useful for identifying issues that could lead to errors if not addressed.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    WARN: 2,
+    /** * Error level for serious issues that have caused or are likely to cause the application to fail. This level is critical for identifying and addressing problems that need immediate attention.
+    
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    ERROR: 3,
+});
+/** @description Mapping of log level values to their corresponding string representations for easier readability in log outputs.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+export const LOG_LEVEL_NAMES = {
+    /** Debug level for detailed debugging information. This level is typically used during development and should be turned off in production to avoid verbose logging.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    [LOG_LEVEL.DEBUG]: 'DEBUG',
+    /** Info level for general informational messages that highlight the progress of the application at a coarse-grained level. This level is suitable for production environments to track the normal operation of the application.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    [LOG_LEVEL.INFO]: 'INFO',
+    /** Warn level for potentially harmful situations that are not necessarily errors but may require attention. This level is useful for identifying issues that could lead to errors if not addressed.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    [LOG_LEVEL.WARN]: 'WARN',
+    /** Error level for serious issues that have caused or are likely to cause the application to fail. This level is critical for identifying and addressing problems that need immediate attention.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    [LOG_LEVEL.ERROR]: 'ERROR',
+};
+//# sourceMappingURL=log-level.constants.js.map

package/dist/shared/constants/log-level.constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log-level.constants.js","sourceRoot":"","sources":["../../../src/shared/constants/log-level.constants.ts"],"names":[],"mappings":"AAAA;;;;;;;;KAQK;AACL,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC;IACrC;;;;;;;OAOG;IACH,KAAK,EAAE,CAAC;IACR;;;;;;;OAOG;IACH,IAAI,EAAE,CAAC;IACP;;;;;;;OAOG;IACH,IAAI,EAAE,CAAC;IACP;;;;;;;OAOG;IACH,KAAK,EAAE,CAAC;CACA,CAAC,CAAA;AAWX;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,eAAe,GAA6B;IACvD;;;;;;OAMG;IACH,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO;IAC1B;;;;;;OAMG;IACH,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM;IACxB;;;;;;OAMG;IACH,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM;IACxB;;;;;;OAMG;IACH,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO;CAC3B,CAAA"}

package/dist/shared/constants/pagination.constants.d.ts

@@ -0,0 +1,70 @@
+/** @description Canonical pagination defaults.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+export declare const PAGINATION_DEFAULTS: Readonly<{
+    /** @description Default page index (1-based).
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly PAGE: 1;
+    /** @description Default maximum items per page.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly PAGE_SIZE: 20;
+    /** @description Hard ceiling on page size accepted by the system.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly MAX_PAGE_SIZE: 100;
+}>;
+/**
+ * @description Canonical sort direction values.
+ * Used by IPaginationParams.sortDirection to avoid string magic.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export declare const SORT_DIRECTION: Readonly<{
+    /** @description Ascending order (A → Z, 0 → 9, oldest → newest).
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly ASC: "asc";
+    /** @description Descending order (Z → A, 9 → 0, newest → oldest).
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly DESC: "desc";
+}>;
+/** @description Inferred union of valid sort direction values.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+export type SortDirection = (typeof SORT_DIRECTION)[keyof typeof SORT_DIRECTION];
+//# sourceMappingURL=pagination.constants.d.ts.map

package/dist/shared/constants/pagination.constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.constants.d.ts","sourceRoot":"","sources":["../../../src/shared/constants/pagination.constants.ts"],"names":[],"mappings":"AA6BA;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB;IAC9B;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;EAEM,CAAA;AAIX;;;;;;;;;KASK;AACL,eAAO,MAAM,cAAc;IACzB;;;;;;OAMG;;IAGH;;;;;;OAMG;;EAEM,CAAA;AAEX;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAA"}

package/dist/shared/constants/pagination.constants.js

@@ -0,0 +1,88 @@
+// ─── Constants ────────────────────────────────────────────────────────────────
+/** @description Default page index when no page is supplied by the caller.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+const DEFAULT_PAGE = 1;
+/** @description Default maximum number of items per page.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+const DEFAULT_PAGE_SIZE = 20;
+/** @description Absolute maximum allowed page size to prevent resource exhaustion.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+const MAX_PAGE_SIZE = 100;
+/** @description Canonical pagination defaults.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+export const PAGINATION_DEFAULTS = Object.freeze({
+    /** @description Default page index (1-based).
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    PAGE: DEFAULT_PAGE,
+    /** @description Default maximum items per page.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    PAGE_SIZE: DEFAULT_PAGE_SIZE,
+    /** @description Hard ceiling on page size accepted by the system.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    MAX_PAGE_SIZE,
+});
+// ─── Sort Direction ───────────────────────────────────────────────────────────
+/**
+ * @description Canonical sort direction values.
+ * Used by IPaginationParams.sortDirection to avoid string magic.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export const SORT_DIRECTION = Object.freeze({
+    /** @description Ascending order (A → Z, 0 → 9, oldest → newest).
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    ASC: 'asc',
+    /** @description Descending order (Z → A, 9 → 0, newest → oldest).
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    DESC: 'desc',
+});
+//# sourceMappingURL=pagination.constants.js.map

package/dist/shared/constants/pagination.constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.constants.js","sourceRoot":"","sources":["../../../src/shared/constants/pagination.constants.ts"],"names":[],"mappings":"AAAA,iFAAiF;AAEjF;;;;;;GAMG;AACH,MAAM,YAAY,GAAG,CAAC,CAAA;AAEtB;;;;;;GAMG;AACH,MAAM,iBAAiB,GAAG,EAAE,CAAA;AAE5B;;;;;;GAMG;AACH,MAAM,aAAa,GAAG,GAAG,CAAA;AAEzB;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC/C;;;;;;OAMG;IACH,IAAI,EAAE,YAAY;IAElB;;;;;;OAMG;IACH,SAAS,EAAE,iBAAiB;IAE5B;;;;;;OAMG;IACH,aAAa;CACL,CAAC,CAAA;AAEX,iFAAiF;AAEjF;;;;;;;;;KASK;AACL,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC;IAC1C;;;;;;OAMG;IACH,GAAG,EAAE,KAAK;IAEV;;;;;;OAMG;IACH,IAAI,EAAE,MAAM;CACJ,CAAC,CAAA"}

package/dist/shared/constants/request.constants.d.ts

@@ -0,0 +1,34 @@
+/** @description Constants related to request handling in the application.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+export declare const REQUEST_TYPE: Readonly<{
+    /** @description A request that intends to modify state (e.g. create, update, delete).
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly COMMAND: "COMMAND";
+    /** @description A request that intends to retrieve data without modifying state.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly QUERY: "QUERY";
+}>;
+/** @description Inferred union of every valid REQUEST_TYPE value.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+export type RequestType = (typeof REQUEST_TYPE)[keyof typeof REQUEST_TYPE];
+//# sourceMappingURL=request.constants.d.ts.map

package/dist/shared/constants/request.constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.constants.d.ts","sourceRoot":"","sources":["../../../src/shared/constants/request.constants.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,YAAY;IACvB;;;;;;OAMG;;IAEH;;;;;;OAMG;;EAEM,CAAA;AAEX;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAA"}

package/dist/shared/constants/request.constants.js

@@ -0,0 +1,26 @@
+/** @description Constants related to request handling in the application.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+export const REQUEST_TYPE = Object.freeze({
+    /** @description A request that intends to modify state (e.g. create, update, delete).
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    COMMAND: 'COMMAND',
+    /** @description A request that intends to retrieve data without modifying state.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    QUERY: 'QUERY',
+});
+//# sourceMappingURL=request.constants.js.map

package/dist/shared/constants/request.constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.constants.js","sourceRoot":"","sources":["../../../src/shared/constants/request.constants.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC;IACxC;;;;;;OAMG;IACH,OAAO,EAAE,SAAS;IAClB;;;;;;OAMG;IACH,KAAK,EAAE,OAAO;CACN,CAAC,CAAA"}

package/dist/shared/constants/resilience.constants.d.ts

@@ -0,0 +1,89 @@
+/**
+ * @description Canonical default values for resilience policy configuration.
+ * Used by the resilience factory as the baseline for retry, circuit breaker,
+ * and bulkhead settings.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export declare const RESILIENCE_DEFAULTS: Readonly<{
+    /** @description Default retry policy values.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly RETRY: Readonly<{
+        /** @description Default number of retry attempts.
+         *
+         * @author Xeno
+         * @version 1.0.0
+         * @since 2025-09-30
+         * @link https://github.com/xeno-js/xeno-js
+         */
+        ATTEMPTS: 3;
+        /** @description Default base delay in milliseconds for retry backoff.
+         *
+         * @author Xeno
+         * @version 1.0.0
+         * @since 2025-09-30
+         * @link https://github.com/xeno-js/xeno-js
+         */
+        BASE_DELAY_MS: 100;
+        /** @description Default maximum delay in milliseconds for retry backoff.
+         *
+         * @author Xeno
+         * @version 1.0.0
+         * @since 2025-09-30
+         * @link https://github.com/xeno-js/xeno-js
+         */
+        MAX_DELAY_MS: 1000;
+    }>;
+    /** @description Default circuit breaker policy values.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly CIRCUIT_BREAKER: Readonly<{
+        /** @description Default number of consecutive failures before opening the circuit.
+         *
+         * @author Xeno
+         * @version 1.0.0
+         * @since 2025-09-30
+         * @link https://github.com/xeno-js/xeno-js
+         */
+        CONSECUTIVE_FAILURES: 5;
+        /** @description Default half-open timeout in milliseconds.
+         *
+         * @author Xeno
+         * @version 1.0.0
+         * @since 2025-09-30
+         * @link https://github.com/xeno-js/xeno-js
+         */
+        HALF_OPEN_TIMEOUT_MS: 30000;
+    }>;
+    /** @description Default bulkhead policy values.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly BULKHEAD: Readonly<{
+        /** @description Default maximum number of concurrent operations.
+         *
+         * @author Xeno
+         * @version 1.0.0
+         * @since 2025-09-30
+         * @link https://github.com/xeno-js/xeno-js
+         */
+        MAX_CONCURRENT: 10;
+    }>;
+}>;
+//# sourceMappingURL=resilience.constants.d.ts.map

package/dist/shared/constants/resilience.constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resilience.constants.d.ts","sourceRoot":"","sources":["../../../src/shared/constants/resilience.constants.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;KAUK;AACL,eAAO,MAAM,mBAAmB;IAC9B;;;;;;OAMG;;QAED;;;;;;WAMG;;QAGH;;;;;;WAMG;;QAGH;;;;;;WAMG;;;IAIL;;;;;;OAMG;;QAED;;;;;;WAMG;;QAGH;;;;;;WAMG;;;IAIL;;;;;;OAMG;;QAED;;;;;;WAMG;;;EAGI,CAAA"}

package/dist/shared/constants/resilience.constants.js

@@ -0,0 +1,89 @@
+/**
+ * @description Canonical default values for resilience policy configuration.
+ * Used by the resilience factory as the baseline for retry, circuit breaker,
+ * and bulkhead settings.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+export const RESILIENCE_DEFAULTS = Object.freeze({
+    /** @description Default retry policy values.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    RETRY: Object.freeze({
+        /** @description Default number of retry attempts.
+         *
+         * @author Xeno
+         * @version 1.0.0
+         * @since 2025-09-30
+         * @link https://github.com/xeno-js/xeno-js
+         */
+        ATTEMPTS: 3,
+        /** @description Default base delay in milliseconds for retry backoff.
+         *
+         * @author Xeno
+         * @version 1.0.0
+         * @since 2025-09-30
+         * @link https://github.com/xeno-js/xeno-js
+         */
+        BASE_DELAY_MS: 100,
+        /** @description Default maximum delay in milliseconds for retry backoff.
+         *
+         * @author Xeno
+         * @version 1.0.0
+         * @since 2025-09-30
+         * @link https://github.com/xeno-js/xeno-js
+         */
+        MAX_DELAY_MS: 1000,
+    }),
+    /** @description Default circuit breaker policy values.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    CIRCUIT_BREAKER: Object.freeze({
+        /** @description Default number of consecutive failures before opening the circuit.
+         *
+         * @author Xeno
+         * @version 1.0.0
+         * @since 2025-09-30
+         * @link https://github.com/xeno-js/xeno-js
+         */
+        CONSECUTIVE_FAILURES: 5,
+        /** @description Default half-open timeout in milliseconds.
+         *
+         * @author Xeno
+         * @version 1.0.0
+         * @since 2025-09-30
+         * @link https://github.com/xeno-js/xeno-js
+         */
+        HALF_OPEN_TIMEOUT_MS: 30_000,
+    }),
+    /** @description Default bulkhead policy values.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    BULKHEAD: Object.freeze({
+        /** @description Default maximum number of concurrent operations.
+         *
+         * @author Xeno
+         * @version 1.0.0
+         * @since 2025-09-30
+         * @link https://github.com/xeno-js/xeno-js
+         */
+        MAX_CONCURRENT: 10,
+    }),
+});
+//# sourceMappingURL=resilience.constants.js.map

package/dist/shared/constants/resilience.constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resilience.constants.js","sourceRoot":"","sources":["../../../src/shared/constants/resilience.constants.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;KAUK;AACL,MAAM,CAAC,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC/C;;;;;;OAMG;IACH,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;QACnB;;;;;;WAMG;QACH,QAAQ,EAAE,CAAC;QAEX;;;;;;WAMG;QACH,aAAa,EAAE,GAAG;QAElB;;;;;;WAMG;QACH,YAAY,EAAE,IAAI;KACnB,CAAC;IAEF;;;;;;OAMG;IACH,eAAe,EAAE,MAAM,CAAC,MAAM,CAAC;QAC7B;;;;;;WAMG;QACH,oBAAoB,EAAE,CAAC;QAEvB;;;;;;WAMG;QACH,oBAAoB,EAAE,MAAM;KAC7B,CAAC;IAEF;;;;;;OAMG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC;QACtB;;;;;;WAMG;QACH,cAAc,EAAE,EAAE;KACnB,CAAC;CACM,CAAC,CAAA"}

package/dist/shared/constants/roles.constants.d.ts

@@ -0,0 +1,84 @@
+/**
+ * @fileoverview This file defines the roles used within the application. The ROLES constant is an object that contains the different roles available, such as SUPER_ADMIN, ADMIN, USER, and GUEST. Each role is represented as a string value. The Role type is defined as a union of the values of the ROLES object, allowing for type safety when working with roles throughout the application.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+/** @description An object containing the different roles available within the application. Each role is represented as a string value.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+export declare const ROLES: Readonly<{
+    /** @description The SUPER_ADMIN role, which typically has the highest level of permissions and access within the application.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly SUPER_ADMIN: "super_admin";
+    /** @description The ADMIN role, which typically has elevated permissions and access within the application, but may have some restrictions compared to the SUPER_ADMIN role.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly ADMIN: "admin";
+    /** @description The USER role, which typically has standard permissions and access within the application, allowing them to perform regular user actions but with limited administrative capabilities.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly USER: "user";
+    /** @description The GUEST role, which typically has the most limited permissions and access within the application, often used for unauthenticated users or users with very restricted access.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly GUEST: "guest";
+}>;
+/** @description A type representing the different roles available within the application. It is defined as a union of the values of the ROLES object, allowing for type safety when working with roles throughout the application.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+export type Role = (typeof ROLES)[keyof typeof ROLES];
+/** @description An object containing the different permissions available within the application. Each permission is represented as a string value.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+export declare const PERMISSIONS: Readonly<{
+    /** @description The READ permission, which typically allows access to resources or actions within the application that require read-only access.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    readonly READ: "read";
+}>;
+/** @description A type representing the different permissions available within the application. It is defined as a union of the values of the PERMISSIONS object, allowing for type safety when working with permissions throughout the application.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+export type Permission = (typeof PERMISSIONS)[keyof typeof PERMISSIONS];
+//# sourceMappingURL=roles.constants.d.ts.map

package/dist/shared/constants/roles.constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"roles.constants.d.ts","sourceRoot":"","sources":["../../../src/shared/constants/roles.constants.ts"],"names":[],"mappings":"AAAA;;;;;;;;KAQK;AAEL;;;;;;GAMG;AACH,eAAO,MAAM,KAAK;IAChB;;;;;;OAMG;;IAEH;;;;;;OAMG;;IAEH;;;;;;OAMG;;IAEH;;;;;;OAMG;;EAEM,CAAA;AAEX;;;;;;GAMG;AACH,MAAM,MAAM,IAAI,GAAG,CAAC,OAAO,KAAK,CAAC,CAAC,MAAM,OAAO,KAAK,CAAC,CAAA;AAErD;;;;;;GAMG;AACH,eAAO,MAAM,WAAW;IACtB;;;;;;OAMG;;EAEM,CAAA;AAEX;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,WAAW,CAAC,CAAA"}

package/dist/shared/constants/roles.constants.js

@@ -0,0 +1,68 @@
+/**
+ * @fileoverview This file defines the roles used within the application. The ROLES constant is an object that contains the different roles available, such as SUPER_ADMIN, ADMIN, USER, and GUEST. Each role is represented as a string value. The Role type is defined as a union of the values of the ROLES object, allowing for type safety when working with roles throughout the application.
+
+   *
+   * @author Xeno
+   * @version 1.0.0
+   * @since 2025-09-30
+   * @link https://github.com/xeno-js/xeno-js
+   */
+/** @description An object containing the different roles available within the application. Each role is represented as a string value.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+export const ROLES = Object.freeze({
+    /** @description The SUPER_ADMIN role, which typically has the highest level of permissions and access within the application.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    SUPER_ADMIN: 'super_admin',
+    /** @description The ADMIN role, which typically has elevated permissions and access within the application, but may have some restrictions compared to the SUPER_ADMIN role.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    ADMIN: 'admin',
+    /** @description The USER role, which typically has standard permissions and access within the application, allowing them to perform regular user actions but with limited administrative capabilities.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    USER: 'user',
+    /** @description The GUEST role, which typically has the most limited permissions and access within the application, often used for unauthenticated users or users with very restricted access.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    GUEST: 'guest',
+});
+/** @description An object containing the different permissions available within the application. Each permission is represented as a string value.
+ *
+ * @author Xeno
+ * @version 1.0.0
+ * @since 2025-09-30
+ * @link https://github.com/xeno-js/xeno-js
+ */
+export const PERMISSIONS = Object.freeze({
+    /** @description The READ permission, which typically allows access to resources or actions within the application that require read-only access.
+     *
+     * @author Xeno
+     * @version 1.0.0
+     * @since 2025-09-30
+     * @link https://github.com/xeno-js/xeno-js
+     */
+    READ: 'read',
+});
+//# sourceMappingURL=roles.constants.js.map

package/dist/shared/constants/roles.constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"roles.constants.js","sourceRoot":"","sources":["../../../src/shared/constants/roles.constants.ts"],"names":[],"mappings":"AAAA;;;;;;;;KAQK;AAEL;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;IACjC;;;;;;OAMG;IACH,WAAW,EAAE,aAAa;IAC1B;;;;;;OAMG;IACH,KAAK,EAAE,OAAO;IACd;;;;;;OAMG;IACH,IAAI,EAAE,MAAM;IACZ;;;;;;OAMG;IACH,KAAK,EAAE,OAAO;CACN,CAAC,CAAA;AAWX;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC;IACvC;;;;;;OAMG;IACH,IAAI,EAAE,MAAM;CACJ,CAAC,CAAA"}