digitaltwin-core/dist/auth/auth_config.d.ts

Minimalist framework to collect and handle data in a Digital Twin project

/**
 * Authentication configuration for Digital Twin framework.
 *
 * Controls whether authentication is required for components that support it.
 * When authentication is disabled, all requests are treated as authenticated
 * with a default anonymous user.
 *
 * Environment variables:
 * - DIGITALTWIN_DISABLE_AUTH: Set to "true" or "1" to disable authentication (default: false)
 * - DIGITALTWIN_ANONYMOUS_USER_ID: User ID to use when auth is disabled (default: "anonymous")
 * - DIGITALTWIN_ADMIN_ROLE_NAME: Name of the admin role in Keycloak (default: "admin")
 *
 * @example
 * ```bash
 * # Disable authentication for development
 * export DIGITALTWIN_DISABLE_AUTH=true
 * export DIGITALTWIN_ANONYMOUS_USER_ID=dev-user-123
 *
 * # Configure admin role name
 * export DIGITALTWIN_ADMIN_ROLE_NAME=administrator
 *
 * # Enable authentication (default)
 * export DIGITALTWIN_DISABLE_AUTH=false
 * ```
 *
 * @example
 * ```typescript
 * import { AuthConfig } from './auth_config.js'
 *
 * if (AuthConfig.isAuthDisabled()) {
 *   console.log('Authentication is disabled')
 *   const anonymousUser = AuthConfig.getAnonymousUser()
 *   console.log(`Using anonymous user: ${anonymousUser.id}`)
 * }
 *
 * const adminRole = AuthConfig.getAdminRoleName()
 * console.log(`Admin role is: ${adminRole}`)
 * ```
 */
export declare class AuthConfig {
    private static _config;
    /**
     * Loads and validates authentication configuration from environment variables.
     * This is called automatically the first time any method is used.
     */
    private static loadConfig;
    /**
     * Gets the loaded configuration, ensuring it's initialized.
     * @private
     */
    private static getConfig;
    /**
     * Checks if authentication is disabled via environment variables.
     *
     * @returns true if DIGITALTWIN_DISABLE_AUTH is set to "true" or "1", false otherwise
     *
     * @example
     * ```typescript
     * if (AuthConfig.isAuthDisabled()) {
     *   console.log('Running in no-auth mode')
     * }
     * ```
     */
    static isAuthDisabled(): boolean;
    /**
     * Checks if authentication is enabled (opposite of isAuthDisabled).
     *
     * @returns true if authentication should be enforced, false otherwise
     */
    static isAuthEnabled(): boolean;
    /**
     * Gets the anonymous user ID to use when authentication is disabled.
     *
     * @returns The user ID configured for anonymous access
     *
     * @example
     * ```typescript
     * const userId = AuthConfig.getAnonymousUserId()
     * console.log(`Anonymous user ID: ${userId}`) // "anonymous" by default
     * ```
     */
    static getAnonymousUserId(): string;
    /**
     * Gets a fake authenticated user object for anonymous access.
     *
     * @returns An AuthenticatedUser object representing the anonymous user
     *
     * @example
     * ```typescript
     * import type { AuthenticatedUser } from './types.js'
     *
     * const anonymousUser: AuthenticatedUser = AuthConfig.getAnonymousUser()
     * console.log(anonymousUser) // { id: "anonymous", roles: ["anonymous"] }
     * ```
     */
    static getAnonymousUser(): {
        id: string;
        roles: string[];
    };
    /**
     * Gets the name of the admin role configured for the system.
     *
     * This role name is used to determine if a user has full administrative
     * access to all resources, including private assets owned by other users.
     *
     * @returns The admin role name (default: "admin")
     *
     * @example
     * ```typescript
     * const adminRole = AuthConfig.getAdminRoleName()
     * console.log(`Admin role: ${adminRole}`) // "admin" by default
     *
     * // Check if user has admin role
     * const userRoles = ['user', 'admin', 'moderator']
     * const isAdmin = userRoles.includes(adminRole)
     * ```
     */
    static getAdminRoleName(): string;
    /**
     * Resets the cached configuration (useful for testing).
     *
     * @private
     */
    static _resetConfig(): void;
}
//# sourceMappingURL=auth_config.d.ts.map