@adonisjs/session 7.0.0-9 → 7.0.0

package/build/src/edge_plugin_adonisjs_session.js

@@ -1,92 +0,0 @@
-/*
- * @adonisjs/session
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import debug from './debug.js';
-/**
- * The edge plugin for AdonisJS Session adds tags to read
- * flash messages
- */
-export const edgePluginAdonisJSSession = (edge) => {
-    debug('registering session tags with edge');
-    edge.registerTag({
-        tagName: 'flashMessage',
-        seekable: true,
-        block: true,
-        compile(parser, buffer, token) {
-            const expression = parser.utils.transformAst(parser.utils.generateAST(token.properties.jsArg, token.loc, token.filename), token.filename, parser);
-            const key = parser.utils.stringify(expression);
-            /**
-             * Write an if statement
-             */
-            buffer.writeStatement(`if (state.flashMessages.has(${key})) {`, token.filename, token.loc.start.line);
-            /**
-             * Define a local variable
-             */
-            buffer.writeExpression(`let message = state.flashMessages.get(${key})`, token.filename, token.loc.start.line);
-            /**
-             * Create a local variables scope and tell the parser about
-             * the existence of the "message" variable
-             */
-            parser.stack.defineScope();
-            parser.stack.defineVariable('message');
-            /**
-             * Process component children using the parser
-             */
-            token.children.forEach((child) => {
-                parser.processToken(child, buffer);
-            });
-            /**
-             * Clear the scope of the local variables before we
-             * close the if statement
-             */
-            parser.stack.clearScope();
-            /**
-             * Close if statement
-             */
-            buffer.writeStatement(`}`, token.filename, token.loc.start.line);
-        },
-    });
-    edge.registerTag({
-        tagName: 'error',
-        seekable: true,
-        block: true,
-        compile(parser, buffer, token) {
-            const expression = parser.utils.transformAst(parser.utils.generateAST(token.properties.jsArg, token.loc, token.filename), token.filename, parser);
-            const key = parser.utils.stringify(expression);
-            /**
-             * Write an if statement
-             */
-            buffer.writeStatement(`if (!!state.flashMessages.get('errors', {})[${key}]) {`, token.filename, token.loc.start.line);
-            /**
-             * Define a local variable
-             */
-            buffer.writeExpression(`let messages = state.flashMessages.get('errors', {})[${key}]`, token.filename, token.loc.start.line);
-            /**
-             * Create a local variables scope and tell the parser about
-             * the existence of the "messages" variable
-             */
-            parser.stack.defineScope();
-            parser.stack.defineVariable('messages');
-            /**
-             * Process component children using the parser
-             */
-            token.children.forEach((child) => {
-                parser.processToken(child, buffer);
-            });
-            /**
-             * Clear the scope of the local variables before we
-             * close the if statement
-             */
-            parser.stack.clearScope();
-            /**
-             * Close if statement
-             */
-            buffer.writeStatement(`}`, token.filename, token.loc.start.line);
-        },
-    });
-};

package/build/src/errors.js

@@ -1,17 +0,0 @@
-/*
- * @adonisjs/session
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { createError } from '@poppinss/utils';
-/**
- * Raised when session store is not mutable
- */
-export const E_SESSION_NOT_MUTABLE = createError('Session store is in readonly mode and cannot be mutated', 'E_SESSION_NOT_MUTABLE', 500);
-/**
- * Raised when session store has been initiated
- */
-export const E_SESSION_NOT_READY = createError('Session store has not been initiated. Make sure you have registered the session middleware', 'E_SESSION_NOT_READY', 500);

package/build/src/helpers.d.ts

@@ -1,6 +0,0 @@
-import type { ApplicationService } from '@adonisjs/core/types';
-import type { SessionDriversList } from './types/main.js';
-/**
- * Lazily imports and registers a driver with the sessionDriversList
- */
-export declare function registerSessionDriver(app: ApplicationService, driverInUse: keyof SessionDriversList): Promise<void>;

package/build/src/helpers.js

@@ -1,43 +0,0 @@
-/*
- * @adonisjs/session
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import debug from './debug.js';
-import sessionDriversList from './drivers_collection.js';
-/**
- * Lazily imports and registers a driver with the sessionDriversList
- */
-export async function registerSessionDriver(app, driverInUse) {
-    /**
-     * Noop when the driver is already registered
-     */
-    if (sessionDriversList.list[driverInUse]) {
-        return;
-    }
-    debug('registering %s driver', driverInUse);
-    if (driverInUse === 'cookie') {
-        const { CookieDriver } = await import('../src/drivers/cookie.js');
-        sessionDriversList.extend('cookie', (config, ctx) => new CookieDriver(config.cookie, ctx));
-        return;
-    }
-    if (driverInUse === 'memory') {
-        const { MemoryDriver } = await import('../src/drivers/memory.js');
-        sessionDriversList.extend('memory', () => new MemoryDriver());
-        return;
-    }
-    if (driverInUse === 'file') {
-        const { FileDriver } = await import('../src/drivers/file.js');
-        sessionDriversList.extend('file', (config) => new FileDriver(config.file, config.age));
-        return;
-    }
-    if (driverInUse === 'redis') {
-        const { RedisDriver } = await import('../src/drivers/redis.js');
-        const redis = await app.container.make('redis');
-        sessionDriversList.extend('redis', (config) => new RedisDriver(redis, config.redis, config.age));
-        return;
-    }
-}

package/build/src/session.js

@@ -1,384 +0,0 @@
-/*
- * @adonisjs/session
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import lodash from '@poppinss/utils/lodash';
-import { cuid } from '@adonisjs/core/helpers';
-import { ReadOnlyStore, Store } from './store.js';
-import * as errors from './errors.js';
-import debug from './debug.js';
-/**
- * The session class exposes the API to read and write values to
- * the session store.
- *
- * A session instance is isolated between requests but
- * uses a centralized persistence store and
- */
-export class Session {
-    #config;
-    #driver;
-    #emitter;
-    #ctx;
-    #readonly = false;
-    #store;
-    /**
-     * Session id refers to the session id that will be committed
-     * as a cookie during the response.
-     */
-    #sessionId;
-    /**
-     * Session id from cookie refers to the value we read from the
-     * cookie during the HTTP request.
-     *
-     * This only might not exist during the first request. Also during
-     * session id re-generation, this value will be different from
-     * the session id.
-     */
-    #sessionIdFromCookie;
-    /**
-     * Store of flash messages that be written during the
-     * HTTP request
-     */
-    responseFlashMessages = new Store({});
-    /**
-     * Store of flash messages for the current HTTP request.
-     */
-    flashMessages = new Store({});
-    /**
-     * The key to use for storing flash messages inside
-     * the session store.
-     */
-    flashKey = '__flash__';
-    /**
-     * Session id for the current HTTP request
-     */
-    get sessionId() {
-        return this.#sessionId;
-    }
-    /**
-     * A boolean to know if a fresh session is created during
-     * the request
-     */
-    get fresh() {
-        return this.#sessionIdFromCookie === undefined;
-    }
-    /**
-     * A boolean to know if session is in readonly
-     * state
-     */
-    get readonly() {
-        return this.#readonly;
-    }
-    /**
-     * A boolean to know if session store has been initiated
-     */
-    get initiated() {
-        return !!this.#store;
-    }
-    /**
-     * A boolean to know if the session id has been re-generated
-     * during the current request
-     */
-    get hasRegeneratedSession() {
-        return !!(this.#sessionIdFromCookie && this.#sessionIdFromCookie !== this.#sessionId);
-    }
-    /**
-     * A boolean to know if the session store is empty
-     */
-    get isEmpty() {
-        return this.#store?.isEmpty ?? true;
-    }
-    /**
-     * A boolean to know if the session store has been
-     * modified
-     */
-    get hasBeenModified() {
-        return this.#store?.hasBeenModified ?? false;
-    }
-    constructor(config, driver, emitter, ctx) {
-        this.#ctx = ctx;
-        this.#config = config;
-        this.#driver = driver;
-        this.#emitter = emitter;
-        this.#sessionIdFromCookie = ctx.request.cookie(config.cookieName, undefined);
-        this.#sessionId = this.#sessionIdFromCookie || cuid();
-    }
-    /**
-     * Returns the flash messages store for a given
-     * mode
-     */
-    #getFlashStore(mode) {
-        if (!this.#store) {
-            throw new errors.E_SESSION_NOT_READY();
-        }
-        if (mode === 'write' && this.readonly) {
-            throw new errors.E_SESSION_NOT_MUTABLE();
-        }
-        return this.responseFlashMessages;
-    }
-    /**
-     * Returns the store instance for a given mode
-     */
-    #getStore(mode) {
-        if (!this.#store) {
-            throw new errors.E_SESSION_NOT_READY();
-        }
-        if (mode === 'write' && this.readonly) {
-            throw new errors.E_SESSION_NOT_MUTABLE();
-        }
-        return this.#store;
-    }
-    /**
-     * Initiates the session store. The method results in a noop
-     * when called multiple times
-     */
-    async initiate(readonly) {
-        if (this.#store) {
-            return;
-        }
-        debug('initiating session (readonly: %s)', readonly);
-        this.#readonly = readonly;
-        const contents = await this.#driver.read(this.#sessionId);
-        this.#store = new Store(contents);
-        /**
-         * Extract flash messages from the store and keep a local
-         * copy of it.
-         */
-        if (this.has(this.flashKey)) {
-            debug('reading flash data');
-            if (this.#readonly) {
-                this.flashMessages.update(this.get(this.flashKey, null));
-            }
-            else {
-                this.flashMessages.update(this.pull(this.flashKey, null));
-            }
-        }
-        /**
-         * Share session with the templates. We assume the view property
-         * is a reference to edge templates
-         */
-        if ('view' in this.#ctx) {
-            this.#ctx.view.share({
-                session: new ReadOnlyStore(this.#store.all()),
-                flashMessages: new ReadOnlyStore(this.flashMessages.all()),
-                old: function (key, defaultValue) {
-                    return this.flashMessages.get(key, defaultValue);
-                },
-            });
-        }
-        this.#emitter.emit('session:initiated', { session: this });
-    }
-    /**
-     * Put a key-value pair to the session data store
-     */
-    put(key, value) {
-        this.#getStore('write').set(key, value);
-    }
-    /**
-     * Check if a key exists inside the datastore
-     */
-    has(key) {
-        return this.#getStore('read').has(key);
-    }
-    /**
-     * Get the value of a key from the session datastore.
-     * You can specify a default value to use, when key
-     * does not exists or has undefined value.
-     */
-    get(key, defaultValue) {
-        return this.#getStore('read').get(key, defaultValue);
-    }
-    /**
-     * Get everything from the session store
-     */
-    all() {
-        return this.#getStore('read').all();
-    }
-    /**
-     * Remove a key from the session datastore
-     */
-    forget(key) {
-        return this.#getStore('write').unset(key);
-    }
-    /**
-     * Read value for a key from the session datastore
-     * and remove it simultaneously.
-     */
-    pull(key, defaultValue) {
-        return this.#getStore('write').pull(key, defaultValue);
-    }
-    /**
-     * Increment the value of a key inside the session
-     * store.
-     *
-     * A new key will be defined if does not exists already.
-     * The value of a new key will be 1
-     */
-    increment(key, steps = 1) {
-        return this.#getStore('write').increment(key, steps);
-    }
-    /**
-     * Increment the value of a key inside the session
-     * store.
-     *
-     * A new key will be defined if does not exists already.
-     * The value of a new key will be -1
-     */
-    decrement(key, steps = 1) {
-        return this.#getStore('write').decrement(key, steps);
-    }
-    /**
-     * Empty the session store
-     */
-    clear() {
-        return this.#getStore('write').clear();
-    }
-    /**
-     * Flash validation error messages. Make sure the error
-     * is an instance of VineJS ValidationException
-     */
-    flashValidationErrors(error) {
-        const errorsBag = error.messages.reduce((result, message) => {
-            if (result[message.field]) {
-                result[message.field].push(message.message);
-            }
-            else {
-                result[message.field] = [message.message];
-            }
-            return result;
-        }, {});
-        this.flashExcept(['_csrf', '_method']);
-        this.flash('errors', errorsBag);
-    }
-    flash(key, value) {
-        if (typeof key === 'string') {
-            if (value) {
-                this.#getFlashStore('write').set(key, value);
-            }
-        }
-        else {
-            this.#getFlashStore('write').merge(key);
-        }
-    }
-    /**
-     * Flash form input data to the flash messages store
-     */
-    flashAll() {
-        return this.#getFlashStore('write').set('input', this.#ctx.request.original());
-    }
-    /**
-     * Flash form input data (except some keys) to the flash messages store
-     */
-    flashExcept(keys) {
-        this.#getFlashStore('write').set('input', lodash.omit(this.#ctx.request.original(), keys));
-    }
-    /**
-     * Flash form input data (only some keys) to the flash messages store
-     */
-    flashOnly(keys) {
-        this.#getFlashStore('write').set('input', lodash.pick(this.#ctx.request.original(), keys));
-    }
-    /**
-     * Reflash messages from the last request in the current response
-     */
-    reflash() {
-        this.#getFlashStore('write').set('reflashed', this.flashMessages.all());
-    }
-    /**
-     * Reflash messages (only some keys) from the last
-     * request in the current response
-     */
-    reflashOnly(keys) {
-        this.#getFlashStore('write').set('reflashed', lodash.pick(this.flashMessages.all(), keys));
-    }
-    /**
-     * Reflash messages (except some keys) from the last
-     * request in the current response
-     */
-    reflashExcept(keys) {
-        this.#getFlashStore('write').set('reflashed', lodash.omit(this.flashMessages.all(), keys));
-    }
-    /**
-     * Re-generate the session id and migrate data to it.
-     */
-    regenerate() {
-        this.#sessionId = cuid();
-    }
-    /**
-     * Commit session changes. No more mutations will be
-     * allowed after commit.
-     */
-    async commit() {
-        if (!this.#store || this.readonly) {
-            return;
-        }
-        /**
-         * If the flash messages store is not empty, we should put
-         * its messages inside main session store.
-         */
-        if (!this.responseFlashMessages.isEmpty) {
-            const { input, reflashed, ...others } = this.responseFlashMessages.all();
-            this.put(this.flashKey, { ...reflashed, ...input, ...others });
-        }
-        debug('committing session data');
-        /**
-         * Touch the session id cookie to stay alive
-         */
-        this.#ctx.response.cookie(this.#config.cookieName, this.#sessionId, this.#config.cookie);
-        /**
-         * Delete the session data when the session store
-         * is empty.
-         *
-         * Also we only destroy the session id we read from the cookie.
-         * If there was no session id in the cookie, there won't be
-         * any data inside the store either.
-         */
-        if (this.isEmpty) {
-            if (this.#sessionIdFromCookie) {
-                await this.#driver.destroy(this.#sessionIdFromCookie);
-            }
-            this.#emitter.emit('session:committed', { session: this });
-            return;
-        }
-        /**
-         * Touch the store expiry when the session store was
-         * not modified.
-         */
-        if (!this.hasBeenModified) {
-            if (this.#sessionIdFromCookie && this.#sessionIdFromCookie !== this.#sessionId) {
-                await this.#driver.destroy(this.#sessionIdFromCookie);
-                await this.#driver.write(this.#sessionId, this.#store.toJSON());
-                this.#emitter.emit('session:migrated', {
-                    fromSessionId: this.#sessionIdFromCookie,
-                    toSessionId: this.sessionId,
-                    session: this,
-                });
-            }
-            else {
-                await this.#driver.touch(this.#sessionId);
-            }
-            this.#emitter.emit('session:committed', { session: this });
-            return;
-        }
-        /**
-         * Otherwise commit to the session store
-         */
-        if (this.#sessionIdFromCookie && this.#sessionIdFromCookie !== this.#sessionId) {
-            await this.#driver.destroy(this.#sessionIdFromCookie);
-            await this.#driver.write(this.#sessionId, this.#store.toJSON());
-            this.#emitter.emit('session:migrated', {
-                fromSessionId: this.#sessionIdFromCookie,
-                toSessionId: this.sessionId,
-                session: this,
-            });
-        }
-        else {
-            await this.#driver.write(this.#sessionId, this.#store.toJSON());
-        }
-        this.#emitter.emit('session:committed', { session: this });
-    }
-}

package/build/src/store.js

@@ -1,159 +0,0 @@
-/*
- * @adonisjs/redis
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import lodash from '@poppinss/utils/lodash';
-import { RuntimeException } from '@poppinss/utils';
-/**
- * Readonly session store
- */
-export class ReadOnlyStore {
-    /**
-     * Underlying store values
-     */
-    values;
-    /**
-     * Find if store is empty or not
-     */
-    get isEmpty() {
-        return !this.values || Object.keys(this.values).length === 0;
-    }
-    constructor(values) {
-        this.values = values || {};
-    }
-    /**
-     * Get value for a given key
-     */
-    get(key, defaultValue) {
-        const value = lodash.get(this.values, key);
-        if (defaultValue !== undefined && (value === null || value === undefined)) {
-            return defaultValue;
-        }
-        return value;
-    }
-    /**
-     * A boolean to know if value exists. Extra guards to check
-     * arrays for it's length as well.
-     */
-    has(key, checkForArraysLength = true) {
-        const value = this.get(key);
-        if (!Array.isArray(value)) {
-            return !!value;
-        }
-        return checkForArraysLength ? value.length > 0 : !!value;
-    }
-    /**
-     * Get all values
-     */
-    all() {
-        return this.values;
-    }
-    /**
-     * Returns object representation of values
-     */
-    toObject() {
-        return this.all();
-    }
-    /**
-     * Returns the store values
-     */
-    toJSON() {
-        return this.all();
-    }
-    /**
-     * Returns string representation of the store
-     */
-    toString() {
-        return JSON.stringify(this.all());
-    }
-}
-/**
- * Session store encapsulates the session data and offers a
- * declarative API to mutate it.
- */
-export class Store extends ReadOnlyStore {
-    /**
-     * A boolean to know if store has been
-     * modified
-     */
-    #modified = false;
-    constructor(values) {
-        super(values);
-    }
-    /**
-     * Find if the store has been modified.
-     */
-    get hasBeenModified() {
-        return this.#modified;
-    }
-    /**
-     * Set key/value pair
-     */
-    set(key, value) {
-        this.#modified = true;
-        lodash.set(this.values, key, value);
-    }
-    /**
-     * Remove key
-     */
-    unset(key) {
-        this.#modified = true;
-        lodash.unset(this.values, key);
-    }
-    /**
-     * Pull value from the store. It is same as calling
-     * store.get and then store.unset
-     */
-    pull(key, defaultValue) {
-        return ((value) => {
-            this.unset(key);
-            return value;
-        })(this.get(key, defaultValue));
-    }
-    /**
-     * Increment number. The method raises an error when
-     * nderlying value is not a number
-     */
-    increment(key, steps = 1) {
-        const value = this.get(key, 0);
-        if (typeof value !== 'number') {
-            throw new RuntimeException(`Cannot increment "${key}". Existing value is not a number`);
-        }
-        this.set(key, value + steps);
-    }
-    /**
-     * Increment number. The method raises an error when
-     * nderlying value is not a number
-     */
-    decrement(key, steps = 1) {
-        const value = this.get(key, 0);
-        if (typeof value !== 'number') {
-            throw new RuntimeException(`Cannot decrement "${key}". Existing value is not a number`);
-        }
-        this.set(key, value - steps);
-    }
-    /**
-     * Overwrite existing store data with new values.
-     */
-    update(values) {
-        this.#modified = true;
-        this.values = values;
-    }
-    /**
-     * Update to merge values
-     */
-    merge(values) {
-        this.#modified = true;
-        lodash.merge(this.values, values);
-    }
-    /**
-     * Reset store by clearing it's values.
-     */
-    clear() {
-        this.update({});
-    }
-}