@adonisjs/session 6.4.0 → 7.0.0-1

package/build/src/Session/index.js

@@ -1,352 +0,0 @@
-"use strict";
-/*
- * @adonisjs/session
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Session = void 0;
-/// <reference path="../../adonis-typings/session.ts" />
-const utils_1 = require("@poppinss/utils");
-const helpers_1 = require("@poppinss/utils/build/helpers");
-const Store_1 = require("../Store");
-/**
- * Session class exposes the API to read/write values to the session for
- * a given request.
- */
-class Session {
-    constructor(ctx, config, driver) {
-        this.ctx = ctx;
-        this.config = config;
-        this.driver = driver;
-        /**
-         * Set to true inside the `initiate` method
-         */
-        this.initiated = false;
-        /**
-         * A boolean to know if it's a fresh session or not. Fresh
-         * sessions are those, whose session id is not present
-         * in cookie
-         */
-        this.fresh = false;
-        /**
-         * A boolean to know if store is initiated in readonly mode
-         * or not. This is done during Websocket requests
-         */
-        this.readonly = false;
-        /**
-         * Session id for the given request. A new session id is only
-         * generated when the cookie for the session id is missing
-         */
-        this.sessionId = this.getSessionId();
-        /**
-         * A copy of previously set flash messages
-         */
-        this.flashMessages = new Store_1.Store({});
-        /**
-         * Session id for the current request. It will be different
-         * from the "this.sessionId" when regenerate is called.
-         */
-        this.currentSessionId = this.sessionId;
-        /**
-         * Whether or not to re-generate the session id before comitting
-         * session values.
-         */
-        this.regeneratedSessionId = false;
-        /**
-         * A copy of flash messages. The `input` messages
-         * are overwritten when any of the input related
-         * methods are used.
-         *
-         * The `others` object is expanded with each call.
-         */
-        this.responseFlashMessages = new Store_1.Store({});
-        /**
-         * Session key for setting flash messages
-         */
-        this.flashMessagesKey = '__flash__';
-    }
-    /**
-     * Returns a merged copy of flash messages or null
-     * when nothing is set
-     */
-    setFlashMessages() {
-        if (this.responseFlashMessages.isEmpty) {
-            return;
-        }
-        const { input, ...others } = this.responseFlashMessages.all();
-        this.put(this.flashMessagesKey, { ...input, ...others });
-    }
-    /**
-     * Returns the existing session id or creates one.
-     */
-    getSessionId() {
-        const sessionId = this.ctx.request.cookie(this.config.cookieName);
-        if (sessionId) {
-            this.ctx.logger.trace('existing session found');
-            return sessionId;
-        }
-        this.fresh = true;
-        this.ctx.logger.trace('generating new session id');
-        return (0, helpers_1.cuid)();
-    }
-    /**
-     * Ensures the session store is initialized
-     */
-    ensureIsReady() {
-        if (!this.initiated) {
-            throw new utils_1.Exception('Session store is not initiated yet. Make sure you are using the session hook', 500, 'E_RUNTIME_EXCEPTION');
-        }
-    }
-    /**
-     * Raises exception when session store is in readonly mode
-     */
-    ensureIsMutable() {
-        if (this.readonly) {
-            throw new utils_1.Exception('Session store is in readonly mode and cannot be mutated', 500, 'E_RUNTIME_EXCEPTION');
-        }
-    }
-    /**
-     * Touches the session cookie
-     */
-    touchSessionCookie() {
-        this.ctx.logger.trace('touching session cookie');
-        this.ctx.response.cookie(this.config.cookieName, this.sessionId, this.config.cookie);
-    }
-    /**
-     * Commits the session value to the store
-     */
-    async commitValuesToStore() {
-        this.ctx.logger.trace('persist session store with driver');
-        await this.driver.write(this.sessionId, this.store.toJSON());
-    }
-    /**
-     * Touches the driver to make sure the session values doesn't expire
-     */
-    async touchDriver() {
-        this.ctx.logger.trace('touch driver for liveliness');
-        await this.driver.touch(this.sessionId);
-    }
-    /**
-     * Reading flash messages from the last HTTP request and
-     * updating the flash messages bag
-     */
-    readLastRequestFlashMessage() {
-        if (this.readonly) {
-            return;
-        }
-        this.flashMessages.update(this.pull(this.flashMessagesKey, null));
-    }
-    /**
-     * Share flash messages & read only session's functions with views
-     * (only when view property exists)
-     */
-    shareLocalsWithView() {
-        if (!this.ctx['view'] || typeof this.ctx['view'].share !== 'function') {
-            return;
-        }
-        this.ctx['view'].share({
-            flashMessages: this.flashMessages,
-            session: {
-                get: this.get.bind(this),
-                has: this.has.bind(this),
-                all: this.all.bind(this),
-            },
-        });
-    }
-    /**
-     * Initiating the session by reading it's value from the
-     * driver and feeding it to a store.
-     *
-     * Multiple calls to `initiate` results in a noop.
-     */
-    async initiate(readonly) {
-        if (this.initiated) {
-            return;
-        }
-        this.readonly = readonly;
-        /**
-         * Profiling the driver read method
-         */
-        await this.ctx.profiler.profileAsync('session:initiate', { driver: this.config.driver }, async () => {
-            const contents = await this.driver.read(this.sessionId);
-            this.store = new Store_1.Store(contents);
-        });
-        this.initiated = true;
-        this.readLastRequestFlashMessage();
-        this.shareLocalsWithView();
-    }
-    /**
-     * Re-generates the session id. This can is used to avoid
-     * session fixation attacks.
-     */
-    regenerate() {
-        this.ctx.logger.trace('explicitly re-generating session id');
-        this.sessionId = (0, helpers_1.cuid)();
-        this.regeneratedSessionId = true;
-    }
-    /**
-     * Set/update session value
-     */
-    put(key, value) {
-        this.ensureIsReady();
-        this.ensureIsMutable();
-        this.store.set(key, value);
-    }
-    /**
-     * Find if the value exists in the session
-     */
-    has(key) {
-        this.ensureIsReady();
-        return this.store.has(key);
-    }
-    /**
-     * Get value from the session. The default value is returned
-     * when actual value is `undefined`
-     */
-    get(key, defaultValue) {
-        this.ensureIsReady();
-        return this.store.get(key, defaultValue);
-    }
-    /**
-     * Returns everything from the session
-     */
-    all() {
-        this.ensureIsReady();
-        return this.store.all();
-    }
-    /**
-     * Remove value for a given key from the session
-     */
-    forget(key) {
-        this.ensureIsReady();
-        this.ensureIsMutable();
-        this.store.unset(key);
-    }
-    /**
-     * The method is equivalent to calling `session.get` followed
-     * by `session.forget`
-     */
-    pull(key, defaultValue) {
-        this.ensureIsReady();
-        this.ensureIsMutable();
-        return this.store.pull(key, defaultValue);
-    }
-    /**
-     * Increment value for a number inside the session store. The
-     * method raises an error when underlying value is not
-     * a number
-     */
-    increment(key, steps = 1) {
-        this.ensureIsReady();
-        this.ensureIsMutable();
-        this.store.increment(key, steps);
-    }
-    /**
-     * Decrement value for a number inside the session store. The
-     * method raises an error when underlying value is not
-     * a number
-     */
-    decrement(key, steps = 1) {
-        this.ensureIsReady();
-        this.ensureIsMutable();
-        this.store.decrement(key, steps);
-    }
-    /**
-     * Remove everything from the session
-     */
-    clear() {
-        this.ensureIsReady();
-        this.ensureIsMutable();
-        this.store.clear();
-    }
-    /**
-     * Add a new flash message
-     */
-    flash(key, value) {
-        this.ensureIsReady();
-        this.ensureIsMutable();
-        /**
-         * Update value
-         */
-        if (typeof key === 'string') {
-            if (value) {
-                this.responseFlashMessages.set(key, value);
-            }
-        }
-        else {
-            this.responseFlashMessages.merge(key);
-        }
-    }
-    /**
-     * Flash all form values
-     */
-    flashAll() {
-        this.ensureIsReady();
-        this.ensureIsMutable();
-        this.responseFlashMessages.set('input', this.ctx.request.original());
-    }
-    /**
-     * Flash all form values except mentioned keys
-     */
-    flashExcept(keys) {
-        this.ensureIsReady();
-        this.ensureIsMutable();
-        this.responseFlashMessages.set('input', utils_1.lodash.omit(this.ctx.request.original(), keys));
-    }
-    /**
-     * Flash only defined keys from the form values
-     */
-    flashOnly(keys) {
-        this.ensureIsReady();
-        this.ensureIsMutable();
-        this.responseFlashMessages.set('input', utils_1.lodash.pick(this.ctx.request.original(), keys));
-    }
-    /**
-     * Reflash existing flash messages
-     */
-    reflash() {
-        this.flash(this.flashMessages.all());
-    }
-    /**
-     * Reflash selected keys from the existing flash messages
-     */
-    reflashOnly(keys) {
-        this.flash(utils_1.lodash.pick(this.flashMessages.all(), keys));
-    }
-    /**
-     * Omit selected keys from the existing flash messages
-     * and flash the rest of values
-     */
-    reflashExcept(keys) {
-        this.flash(utils_1.lodash.omit(this.flashMessages.all(), keys));
-    }
-    /**
-     * Writes value to the underlying session driver.
-     */
-    async commit() {
-        await this.ctx.profiler.profileAsync('session:commit', { driver: this.config.driver }, async () => {
-            if (!this.initiated) {
-                this.touchSessionCookie();
-                await this.touchDriver();
-                return;
-            }
-            /**
-             * Cleanup old session and re-generate new session
-             */
-            if (this.regeneratedSessionId) {
-                await this.driver.destroy(this.currentSessionId);
-            }
-            /**
-             * Touch the session cookie to keep it alive.
-             */
-            this.touchSessionCookie();
-            this.setFlashMessages();
-            await this.commitValuesToStore();
-        });
-    }
-}
-exports.Session = Session;

package/build/src/SessionManager/index.d.ts

@@ -1,78 +0,0 @@
-/**
- * @adonisjs/session
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-/// <reference types="@adonisjs/application/build/adonis-typings" />
-import { ApplicationContract } from '@ioc:Adonis/Core/Application';
-import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext';
-import { SessionConfig, ExtendCallback, SessionManagerContract, SessionClientContract } from '@ioc:Adonis/Addons/Session';
-import { Session } from '../Session';
-/**
- * Session manager exposes the API to create session instance for a given
- * request and also add new drivers.
- */
-export declare class SessionManager implements SessionManagerContract {
-    application: ApplicationContract;
-    /**
-     * A private map of drivers added from outside in.
-     */
-    private extendedDrivers;
-    /**
-     * Reference to session config
-     */
-    private config;
-    constructor(application: ApplicationContract, config: SessionConfig);
-    /**
-     * Validates the config
-     */
-    private validateConfig;
-    /**
-     * Processes the config and decides the `expires` option for the cookie
-     */
-    private processConfig;
-    /**
-     * Returns an instance of cookie driver
-     */
-    private createCookieDriver;
-    /**
-     * Returns an instance of the memory driver
-     */
-    private createMemoryDriver;
-    /**
-     * Returns an instance of file driver
-     */
-    private createFileDriver;
-    /**
-     * Returns an instance of redis driver
-     */
-    private createRedisDriver;
-    /**
-     * Creates an instance of extended driver
-     */
-    private createExtendedDriver;
-    /**
-     * Creates an instance of driver by looking at the config value `driver`.
-     * An hard exception is raised in case of invalid driver name
-     */
-    private createDriver;
-    /**
-     * Find if the sessions are enabled
-     */
-    isEnabled(): boolean;
-    /**
-     * Creates an instance of the session client
-     */
-    client(): SessionClientContract;
-    /**
-     * Creates a new session instance for a given HTTP request
-     */
-    create(ctx: HttpContextContract): Session;
-    /**
-     * Extend the drivers list by adding a new one.
-     */
-    extend(driver: string, callback: ExtendCallback): void;
-}

package/build/src/SessionManager/index.js

@@ -1,148 +0,0 @@
-"use strict";
-/**
- * @adonisjs/session
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SessionManager = void 0;
-const helpers_1 = require("@poppinss/utils/build/helpers");
-const utils_1 = require("@poppinss/utils");
-const Session_1 = require("../Session");
-/**
- * Session manager exposes the API to create session instance for a given
- * request and also add new drivers.
- */
-class SessionManager {
-    constructor(application, config) {
-        this.application = application;
-        /**
-         * A private map of drivers added from outside in.
-         */
-        this.extendedDrivers = new Map();
-        this.validateConfig(config);
-        this.processConfig(config);
-    }
-    /**
-     * Validates the config
-     */
-    validateConfig(config) {
-        const validator = new utils_1.ManagerConfigValidator(config, 'session', 'config/session');
-        validator.validateDefault('driver');
-    }
-    /**
-     * Processes the config and decides the `expires` option for the cookie
-     */
-    processConfig(config) {
-        /**
-         * Explicitly overwriting `cookie.expires` and `cookie.maxAge` from
-         * the user defined config
-         */
-        const processedConfig = Object.assign({ enabled: true }, config, {
-            cookie: {
-                ...config.cookie,
-                expires: undefined,
-                maxAge: undefined,
-            },
-        });
-        /**
-         * Set the max age when `clearWithBrowser = false`. Otherwise cookie
-         * is a session cookie
-         */
-        if (!processedConfig.clearWithBrowser) {
-            const age = typeof processedConfig.age === 'string'
-                ? Math.round(helpers_1.string.toMs(processedConfig.age) / 1000)
-                : processedConfig.age;
-            processedConfig.cookie.maxAge = age;
-        }
-        this.config = processedConfig;
-    }
-    /**
-     * Returns an instance of cookie driver
-     */
-    createCookieDriver(ctx) {
-        const { CookieDriver } = require('../Drivers/Cookie');
-        return new CookieDriver(this.config, ctx);
-    }
-    /**
-     * Returns an instance of the memory driver
-     */
-    createMemoryDriver() {
-        const { MemoryDriver } = require('../Drivers/Memory');
-        return new MemoryDriver();
-    }
-    /**
-     * Returns an instance of file driver
-     */
-    createFileDriver() {
-        const { FileDriver } = require('../Drivers/File');
-        return new FileDriver(this.config);
-    }
-    /**
-     * Returns an instance of redis driver
-     */
-    createRedisDriver() {
-        const { RedisDriver } = require('../Drivers/Redis');
-        if (!this.application.container.hasBinding('Adonis/Addons/Redis')) {
-            throw new Error('Install "@adonisjs/redis" in order to use the redis driver for storing sessions');
-        }
-        return new RedisDriver(this.config, this.application.container.use('Adonis/Addons/Redis'));
-    }
-    /**
-     * Creates an instance of extended driver
-     */
-    createExtendedDriver(ctx) {
-        if (!this.extendedDrivers.has(this.config.driver)) {
-            throw new utils_1.Exception(`"${this.config.driver}" is not a valid session driver`, 500, 'E_INVALID_SESSION_DRIVER');
-        }
-        return this.extendedDrivers.get(this.config.driver)(this, this.config, ctx);
-    }
-    /**
-     * Creates an instance of driver by looking at the config value `driver`.
-     * An hard exception is raised in case of invalid driver name
-     */
-    createDriver(ctx) {
-        switch (this.config.driver) {
-            case 'cookie':
-                return this.createCookieDriver(ctx);
-            case 'file':
-                return this.createFileDriver();
-            case 'redis':
-                return this.createRedisDriver();
-            case 'memory':
-                return this.createMemoryDriver();
-            default:
-                return this.createExtendedDriver(ctx);
-        }
-    }
-    /**
-     * Find if the sessions are enabled
-     */
-    isEnabled() {
-        return this.config.enabled;
-    }
-    /**
-     * Creates an instance of the session client
-     */
-    client() {
-        const { SessionClient } = require('../Client');
-        const CookieClient = this.application.container.resolveBinding('Adonis/Core/CookieClient');
-        return new SessionClient(this.config, this.createMemoryDriver(), CookieClient, {});
-    }
-    /**
-     * Creates a new session instance for a given HTTP request
-     */
-    create(ctx) {
-        return new Session_1.Session(ctx, this.config, this.createDriver(ctx));
-    }
-    /**
-     * Extend the drivers list by adding a new one.
-     */
-    extend(driver, callback) {
-        this.extendedDrivers.set(driver, callback);
-    }
-}
-exports.SessionManager = SessionManager;