@nhost/nhost-js/dist/src/session/storageBackend.js

Nhost JavaScript SDK

/**
 * Storage implementations for session persistence in different environments.
 *
 * This module provides different storage adapters for persisting authentication sessions
 * across page reloads and browser sessions.
 */
/**
 * Default storage key used for storing the Nhost session
 */
export const DEFAULT_SESSION_KEY = 'nhostSession';
/**
 * Browser localStorage implementation of StorageInterface.
 * Persists the session across page reloads and browser restarts.
 */
export class LocalStorage {
    storageKey;
    /**
     * Creates a new LocalStorage instance
     * @param options - Configuration options
     * @param options.storageKey - The key to use in localStorage (defaults to "nhostSession")
     */
    constructor(options) {
        this.storageKey = options?.storageKey || DEFAULT_SESSION_KEY;
    }
    /**
     * Gets the session from localStorage
     * @returns The stored session or null if not found
     */
    get() {
        try {
            const value = window.localStorage.getItem(this.storageKey);
            return value ? JSON.parse(value) : null;
        }
        catch {
            this.remove();
            return null;
        }
    }
    /**
     * Sets the session in localStorage
     * @param value - The session to store
     */
    set(value) {
        window.localStorage.setItem(this.storageKey, JSON.stringify(value));
    }
    /**
     * Removes the session from localStorage
     */
    remove() {
        window.localStorage.removeItem(this.storageKey);
    }
}
/**
 * In-memory storage implementation for non-browser environments or when
 * persistent storage is not available or desirable.
 */
export class MemoryStorage {
    session = null;
    /**
     * Gets the session from memory
     * @returns The stored session or null if not set
     */
    get() {
        return this.session;
    }
    /**
     * Sets the session in memory
     * @param value - The session to store
     */
    set(value) {
        this.session = value;
    }
    /**
     * Clears the session from memory
     */
    remove() {
        this.session = null;
    }
}
/**
 * Cookie-based storage implementation.
 * This storage uses web browser cookies to store the session so it's not
 * available in server-side environments. It is useful though for synchronizing
 * sessions between client and server environments.
 */
export class CookieStorage {
    cookieName;
    expirationDays;
    secure;
    sameSite;
    /**
     * Creates a new CookieStorage instance
     * @param options - Configuration options
     * @param options.cookieName - Name of the cookie to use (defaults to "nhostSession")
     * @param options.expirationDays - Number of days until the cookie expires (defaults to 30)
     * @param options.secure - Whether to set the Secure flag on the cookie (defaults to true)
     * @param options.sameSite - SameSite policy for the cookie (defaults to "lax")
     */
    constructor(options) {
        this.cookieName = options?.cookieName || DEFAULT_SESSION_KEY;
        this.expirationDays = options?.expirationDays ?? 30;
        this.secure = options?.secure ?? true;
        this.sameSite = options?.sameSite || 'lax';
    }
    /**
     * Gets the session from cookies
     * @returns The stored session or null if not found
     */
    get() {
        const cookies = document.cookie.split(';');
        for (const cookie of cookies) {
            const [name, value] = cookie.trim().split('=');
            if (name === this.cookieName) {
                try {
                    return JSON.parse(decodeURIComponent(value || ''));
                }
                catch {
                    this.remove();
                    return null;
                }
            }
        }
        return null;
    }
    /**
     * Sets the session in a cookie
     * @param value - The session to store
     */
    set(value) {
        const expires = new Date();
        expires.setTime(expires.getTime() + this.expirationDays * 24 * 60 * 60 * 1000);
        const cookieValue = encodeURIComponent(JSON.stringify(value));
        const cookieString = `${this.cookieName}=${cookieValue}; expires=${expires.toUTCString()}; path=/; ${this.secure ? 'secure; ' : ''}SameSite=${this.sameSite}`;
        // biome-ignore lint/suspicious/noDocumentCookie: this is unnecessary
        document.cookie = cookieString;
    }
    /**
     * Removes the session cookie
     */
    remove() {
        // biome-ignore lint/suspicious/noDocumentCookie: this is unnecessary
        document.cookie = `${this.cookieName}=; expires=Thu, 01 Jan 1970 00:00:00 UTC; path=/; ${this.secure ? 'secure; ' : ''}SameSite=${this.sameSite}`;
    }
}
//# sourceMappingURL=storageBackend.js.map