@adonisjs/session 6.3.0 → 7.0.0-0

package/build/providers/SessionProvider.js

@@ -1,56 +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 });
-/**
- * Session provider for AdonisJS
- */
-class SessionProvider {
-    constructor(app) {
-        this.app = app;
-    }
-    /**
-     * Register Session Manager
-     */
-    register() {
-        this.app.container.singleton('Adonis/Addons/Session', () => {
-            const { SessionManager } = require('../src/SessionManager');
-            return new SessionManager(this.app, this.app.config.get('session', {}));
-        });
-    }
-    /**
-     * Register bindings for tests
-     */
-    registerTestsBindings() {
-        this.app.container.withBindings([
-            'Japa/Preset/ApiRequest',
-            'Japa/Preset/ApiResponse',
-            'Japa/Preset/ApiClient',
-            'Adonis/Addons/Session',
-        ], (ApiRequest, ApiResponse, ApiClient, Session) => {
-            const { defineTestsBindings } = require('../src/Bindings/Tests');
-            defineTestsBindings(ApiRequest, ApiResponse, ApiClient, Session);
-        });
-    }
-    /**
-     * Register server bindings
-     */
-    registerServerBindings() {
-        this.app.container.withBindings(['Adonis/Core/Server', 'Adonis/Core/HttpContext', 'Adonis/Addons/Session'], (Server, HttpContext, Session) => {
-            const { defineServerBindings } = require('../src/Bindings/Server');
-            defineServerBindings(HttpContext, Server, Session);
-        });
-    }
-    boot() {
-        this.registerServerBindings();
-        this.registerTestsBindings();
-    }
-}
-exports.default = SessionProvider;
-SessionProvider.needsApplication = true;

package/build/src/Bindings/Server.d.ts

@@ -1,10 +0,0 @@
-/// <reference path="../../adonis-typings/index.d.ts" />
-/// <reference types="@adonisjs/http-server/build/adonis-typings" />
-import { ServerContract } from '@ioc:Adonis/Core/Server';
-import { SessionManagerContract } from '@ioc:Adonis/Addons/Session';
-import { HttpContextConstructorContract } from '@ioc:Adonis/Core/HttpContext';
-/**
- * Share "session" with the HTTP context. Define hooks to initiate and
- * commit session when sessions are enabled.
- */
-export declare function defineServerBindings(HttpContext: HttpContextConstructorContract, Server: ServerContract, Session: SessionManagerContract): void;

package/build/src/Bindings/Server.js

@@ -1,42 +0,0 @@
-"use strict";
-/*
- * @adonisjs/session
- *
- * (c) AdonisJS
- *
- * 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.defineServerBindings = void 0;
-/**
- * Share "session" with the HTTP context. Define hooks to initiate and
- * commit session when sessions are enabled.
- */
-function defineServerBindings(HttpContext, Server, Session) {
-    /**
-     * Sharing session with the context
-     */
-    HttpContext.getter('session', function session() {
-        return Session.create(this);
-    }, true);
-    /**
-     * Do not register hooks when sessions are disabled
-     */
-    if (!Session.isEnabled()) {
-        return;
-    }
-    /**
-     * Initiate session store
-     */
-    Server.hooks.before(async (ctx) => {
-        await ctx.session.initiate(false);
-    });
-    /**
-     * Commit store mutations
-     */
-    Server.hooks.after(async (ctx) => {
-        await ctx.session.commit();
-    });
-}
-exports.defineServerBindings = defineServerBindings;

package/build/src/Bindings/Tests.d.ts

@@ -1,7 +0,0 @@
-/// <reference path="../../adonis-typings/index.d.ts" />
-import { ContainerBindings } from '@ioc:Adonis/Core/Application';
-import { SessionManagerContract } from '@ioc:Adonis/Addons/Session';
-/**
- * Define test bindings
- */
-export declare function defineTestsBindings(ApiRequest: ContainerBindings['Japa/Preset/ApiRequest'], ApiResponse: ContainerBindings['Japa/Preset/ApiResponse'], ApiClient: ContainerBindings['Japa/Preset/ApiClient'], SessionManager: SessionManagerContract): void;

package/build/src/Client/index.js

@@ -1,93 +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.SessionClient = void 0;
-/// <reference path="../../adonis-typings/index.ts" />
-const helpers_1 = require("@poppinss/utils/build/helpers");
-const Store_1 = require("../Store");
-/**
- * SessionClient exposes the API to set session data as a client
- */
-class SessionClient extends Store_1.Store {
-    constructor(config, driver, cookieClient, values) {
-        super(values);
-        this.config = config;
-        this.driver = driver;
-        this.cookieClient = cookieClient;
-        /**
-         * Each instance of client works on a single session id. Generate
-         * multiple client instances for a different session id
-         */
-        this.sessionId = (0, helpers_1.cuid)();
-        /**
-         * Session key for setting flash messages
-         */
-        this.flashMessagesKey = '__flash__';
-        /**
-         * Flash messages store. They are merged with the session data during
-         * commit
-         */
-        this.flashMessages = new Store_1.Store({});
-    }
-    /**
-     * Find if the sessions are enabled
-     */
-    isEnabled() {
-        return this.config.enabled;
-    }
-    /**
-     * Load session from the driver
-     */
-    async load(cookies) {
-        const sessionIdCookie = cookies[this.config.cookieName];
-        const sessionId = sessionIdCookie ? sessionIdCookie.value : this.sessionId;
-        const contents = await this.driver.read(sessionId);
-        const store = new Store_1.Store(contents);
-        const flashMessages = store.pull(this.flashMessagesKey, null);
-        return {
-            session: store.all(),
-            flashMessages,
-        };
-    }
-    /**
-     * Commits the session data to the session store and returns
-     * the session id and cookie name for it to be accessible
-     * by the server
-     */
-    async commit() {
-        this.set(this.flashMessagesKey, this.flashMessages.all());
-        await this.driver.write(this.sessionId, this.toJSON());
-        /**
-         * Clear from the session client memory
-         */
-        this.clear();
-        this.flashMessages.clear();
-        return {
-            sessionId: this.sessionId,
-            signedSessionId: this.cookieClient.sign(this.config.cookieName, this.sessionId),
-            cookieName: this.config.cookieName,
-        };
-    }
-    /**
-     * Clear the session store
-     */
-    async forget() {
-        /**
-         * Clear from the session client memory
-         */
-        this.clear();
-        this.flashMessages.clear();
-        /**
-         * Clear with the driver
-         */
-        await this.driver.destroy(this.sessionId);
-    }
-}
-exports.SessionClient = SessionClient;

package/build/src/Drivers/Redis.js

@@ -1,73 +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.RedisDriver = void 0;
-/// <reference path="../../adonis-typings/index.ts" />
-const utils_1 = require("@poppinss/utils");
-const helpers_1 = require("@poppinss/utils/build/helpers");
-/**
- * File driver to read/write session to filesystem
- */
-class RedisDriver {
-    constructor(config, redis) {
-        this.config = config;
-        this.redis = redis;
-        /**
-         * Convert milliseconds to seconds
-         */
-        this.ttl = Math.round((typeof this.config.age === 'string' ? helpers_1.string.toMs(this.config.age) : this.config.age) / 1000);
-        if (!this.config.redisConnection) {
-            throw new utils_1.Exception('Missing redisConnection for session redis driver inside "config/session" file', 500, 'E_INVALID_SESSION_DRIVER_CONFIG');
-        }
-    }
-    /**
-     * Returns instance of the redis connection
-     */
-    getRedisConnection() {
-        return this.redis.connection(this.config.redisConnection);
-    }
-    /**
-     * Returns file contents. A new file will be created if it's
-     * missing.
-     */
-    async read(sessionId) {
-        const contents = await this.getRedisConnection().get(sessionId);
-        if (!contents) {
-            return null;
-        }
-        const verifiedContents = new helpers_1.MessageBuilder().verify(contents, sessionId);
-        if (typeof verifiedContents !== 'object') {
-            return null;
-        }
-        return verifiedContents;
-    }
-    /**
-     * Write session values to a file
-     */
-    async write(sessionId, values) {
-        if (typeof values !== 'object') {
-            throw new Error('Session file driver expects an object of values');
-        }
-        await this.getRedisConnection().setex(sessionId, this.ttl, new helpers_1.MessageBuilder().build(values, undefined, sessionId));
-    }
-    /**
-     * Cleanup session file by removing it
-     */
-    async destroy(sessionId) {
-        await this.getRedisConnection().del(sessionId);
-    }
-    /**
-     * Updates the value expiry
-     */
-    async touch(sessionId) {
-        await this.getRedisConnection().expire(sessionId, this.ttl);
-    }
-}
-exports.RedisDriver = RedisDriver;

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;