@foal/core/lib/sessions/core/session-store.d.ts

Full-featured Node.js framework, with no complexity

import { SessionState } from './session-state.interface';
export declare class SessionAlreadyExists extends Error {
    readonly name = "SessionAlreadyExists";
}
/**
 * Store used to create, read, update and delete sessions.
 *
 * All session stores must inherit this abstract class.
 *
 * When this class is used with the `@dependency` decorator,
 * it returns the `ConcreteSessionStore` class from the file or the package specified
 * with the configuration key "settings.session.store".
 *
 * @export
 * @abstract
 * @class Store
 */
export declare abstract class Store {
    static readonly concreteClassConfigPath = "settings.session.store";
    static readonly concreteClassName = "ConcreteSessionStore";
    /**
     * Saves the session for the first time.
     *
     * If a session already exists with the given ID, a SessionAlreadyExists error MUST be thrown.
     *
     * @abstract
     * @param {SessionState} state - The state of the session.
     * @param {number} maxInactivity - The maximum idle activity of the session (useful for cache stores).
     * @returns {Promise<void>}
     * @memberof Store
     */
    abstract save(state: SessionState, maxInactivity: number): Promise<void>;
    /**
     * Reads a session.
     *
     * If the session does not exist, the value `null` MUST be returned.
     *
     * @abstract
     * @param {string} id - The ID of the session.
     * @returns {(Promise<SessionState|null>)} The state of the session.
     * @memberof Store
     */
    abstract read(id: string): Promise<SessionState | null>;
    /**
     * Updates and extends the lifetime of a session.
     *
     * If the session no longer exists (i.e. has expired or been destroyed), the session MUST still be saved.
     *
     * @abstract
     * @param {SessionState} state - The state of the session.
     * @param {number} maxInactivity - The maximum idle activity of the session (useful for cache stores).
     * @returns {Promise<void>}
     * @memberof Store
     */
    abstract update(state: SessionState, maxInactivity: number): Promise<void>;
    /**
     * Deletes a session.
     *
     * If the session does not exist, NO error MUST be thrown.
     *
     * @abstract
     * @param {string} id - The ID of the session.
     * @returns {Promise<void>}
     * @memberof Store
     */
    abstract destroy(id: string): Promise<void>;
    /**
     * Clears all sessions.
     *
     * @abstract
     * @returns {Promise<void>}
     * @memberof Store
     */
    abstract clear(): Promise<void>;
    /**
     * Some session stores may need to run periodically background jobs to cleanup expired sessions.
     *
     * This method deletes all expired sessions.
     *
     * If the store manages a cache database, then this method can remain empty but it must NOT throw an error.
     *
     * @abstract
     * @param {number} maxInactivity - The maximum idle activity of a session.
     * @param {number} maxLifeTime - The maximum absolute life time of a session.
     * @returns {Promise<void>}
     * @memberof Store
     */
    abstract cleanUpExpiredSessions(maxInactivity: number, maxLifeTime: number): Promise<void>;
    boot(): void | Promise<void>;
}
export { Store as SessionStore };