@adonisjs/session 7.0.0-13 → 7.0.0-15

package/build/src/session.js

@@ -1,387 +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 debug from './debug.js';
-import * as errors from './errors.js';
-import { ReadOnlyValuesStore, ValuesStore } from './values_store.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;
-    #store;
-    #emitter;
-    #ctx;
-    #readonly = false;
-    /**
-     * Session values store
-     */
-    #valuesStore;
-    /**
-     * 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 ValuesStore({});
-    /**
-     * Store of flash messages for the current HTTP request.
-     */
-    flashMessages = new ValuesStore({});
-    /**
-     * 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.#valuesStore;
-    }
-    /**
-     * 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.#valuesStore?.isEmpty ?? true;
-    }
-    /**
-     * A boolean to know if the session store has been
-     * modified
-     */
-    get hasBeenModified() {
-        return this.#valuesStore?.hasBeenModified ?? false;
-    }
-    constructor(config, storeFactory, emitter, ctx) {
-        this.#ctx = ctx;
-        this.#config = config;
-        this.#emitter = emitter;
-        this.#store = storeFactory(ctx, config);
-        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.#valuesStore) {
-            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
-     */
-    #getValuesStore(mode) {
-        if (!this.#valuesStore) {
-            throw new errors.E_SESSION_NOT_READY();
-        }
-        if (mode === 'write' && this.readonly) {
-            throw new errors.E_SESSION_NOT_MUTABLE();
-        }
-        return this.#valuesStore;
-    }
-    /**
-     * Initiates the session store. The method results in a noop
-     * when called multiple times
-     */
-    async initiate(readonly) {
-        if (this.#valuesStore) {
-            return;
-        }
-        debug('initiating session (readonly: %s)', readonly);
-        this.#readonly = readonly;
-        const contents = await this.#store.read(this.#sessionId);
-        this.#valuesStore = new ValuesStore(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 ReadOnlyValuesStore(this.#valuesStore.all()),
-                flashMessages: new ReadOnlyValuesStore(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.#getValuesStore('write').set(key, value);
-    }
-    /**
-     * Check if a key exists inside the datastore
-     */
-    has(key) {
-        return this.#getValuesStore('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.#getValuesStore('read').get(key, defaultValue);
-    }
-    /**
-     * Get everything from the session store
-     */
-    all() {
-        return this.#getValuesStore('read').all();
-    }
-    /**
-     * Remove a key from the session datastore
-     */
-    forget(key) {
-        return this.#getValuesStore('write').unset(key);
-    }
-    /**
-     * Read value for a key from the session datastore
-     * and remove it simultaneously.
-     */
-    pull(key, defaultValue) {
-        return this.#getValuesStore('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.#getValuesStore('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.#getValuesStore('write').decrement(key, steps);
-    }
-    /**
-     * Empty the session store
-     */
-    clear() {
-        return this.#getValuesStore('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.#valuesStore || 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.#store.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.#store.destroy(this.#sessionIdFromCookie);
-                await this.#store.write(this.#sessionId, this.#valuesStore.toJSON());
-                this.#emitter.emit('session:migrated', {
-                    fromSessionId: this.#sessionIdFromCookie,
-                    toSessionId: this.sessionId,
-                    session: this,
-                });
-            }
-            else {
-                await this.#store.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.#store.destroy(this.#sessionIdFromCookie);
-            await this.#store.write(this.#sessionId, this.#valuesStore.toJSON());
-            this.#emitter.emit('session:migrated', {
-                fromSessionId: this.#sessionIdFromCookie,
-                toSessionId: this.sessionId,
-                session: this,
-            });
-        }
-        else {
-            await this.#store.write(this.#sessionId, this.#valuesStore.toJSON());
-        }
-        this.#emitter.emit('session:committed', { session: this });
-    }
-}

package/build/src/stores/cookie.js

@@ -1,60 +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';
-/**
- * Cookie store stores the session data inside an encrypted
- * cookie.
- */
-export class CookieStore {
-    #ctx;
-    #config;
-    constructor(config, ctx) {
-        this.#config = config;
-        this.#ctx = ctx;
-        debug('initiating cookie store %O', this.#config);
-    }
-    /**
-     * Read session value from the cookie
-     */
-    read(sessionId) {
-        debug('cookie store: reading session data %s', sessionId);
-        const cookieValue = this.#ctx.request.encryptedCookie(sessionId);
-        if (typeof cookieValue !== 'object') {
-            return null;
-        }
-        return cookieValue;
-    }
-    /**
-     * Write session values to the cookie
-     */
-    write(sessionId, values) {
-        debug('cookie store: writing session data %s: %O', sessionId, values);
-        this.#ctx.response.encryptedCookie(sessionId, values, this.#config);
-    }
-    /**
-     * Removes the session cookie
-     */
-    destroy(sessionId) {
-        debug('cookie store: destroying session data %s', sessionId);
-        if (this.#ctx.request.cookiesList()[sessionId]) {
-            this.#ctx.response.clearCookie(sessionId);
-        }
-    }
-    /**
-     * Updates the cookie with existing cookie values
-     */
-    touch(sessionId) {
-        const value = this.read(sessionId);
-        debug('cookie store: touching session data %s', sessionId);
-        if (!value) {
-            return;
-        }
-        this.write(sessionId, value);
-    }
-}

package/build/src/stores/file.js

@@ -1,133 +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 { dirname, join } from 'node:path';
-import string from '@poppinss/utils/string';
-import { MessageBuilder } from '@adonisjs/core/helpers';
-import { access, mkdir, readFile, rm, writeFile, utimes, stat } from 'node:fs/promises';
-import debug from '../debug.js';
-/**
- * File store writes the session data on the file system as. Each session
- * id gets its own file.
- */
-export class FileStore {
-    #config;
-    #age;
-    constructor(config, age) {
-        this.#config = config;
-        this.#age = age;
-        debug('initiating file store %O', this.#config);
-    }
-    /**
-     * Returns an absolute path to the session id file
-     */
-    #getFilePath(sessionId) {
-        return join(this.#config.location, `${sessionId}.txt`);
-    }
-    /**
-     * Check if a file exists at a given path or not
-     */
-    async #pathExists(path) {
-        try {
-            await access(path);
-            return true;
-        }
-        catch {
-            return false;
-        }
-    }
-    /**
-     * Returns stats for a file and ignoring missing
-     * files.
-     */
-    async #stats(path) {
-        try {
-            const stats = await stat(path);
-            return stats;
-        }
-        catch {
-            return null;
-        }
-    }
-    /**
-     * Output file with contents to the given path
-     */
-    async #outputFile(path, contents) {
-        const pathDirname = dirname(path);
-        const dirExists = await this.#pathExists(pathDirname);
-        if (!dirExists) {
-            await mkdir(pathDirname, { recursive: true });
-        }
-        await writeFile(path, contents, 'utf-8');
-    }
-    /**
-     * Reads the session data from the disk.
-     */
-    async read(sessionId) {
-        const filePath = this.#getFilePath(sessionId);
-        debug('file store: reading session data %', sessionId);
-        /**
-         * Return null when no session id file exists in first
-         * place
-         */
-        const stats = await this.#stats(filePath);
-        if (!stats) {
-            return null;
-        }
-        /**
-         * Check if the file has been expired and return null (if expired)
-         */
-        const sessionWillExpireAt = stats.mtimeMs + string.milliseconds.parse(this.#age);
-        if (Date.now() > sessionWillExpireAt) {
-            debug('file store: expired session data %s', sessionId);
-            return null;
-        }
-        /**
-         * Reading the file contents if the file exists
-         */
-        let contents = await readFile(filePath, 'utf-8');
-        contents = contents.trim();
-        if (!contents) {
-            return null;
-        }
-        /**
-         * Verify contents with the session id and return them as an object. The verify
-         * method can fail when the contents is not JSON>
-         */
-        try {
-            return new MessageBuilder().verify(contents, sessionId);
-        }
-        catch {
-            return null;
-        }
-    }
-    /**
-     * Writes the session data to the disk as a string
-     */
-    async write(sessionId, values) {
-        debug('file store: writing session data %s: %O', sessionId, values);
-        const filePath = this.#getFilePath(sessionId);
-        const message = new MessageBuilder().build(values, undefined, sessionId);
-        await this.#outputFile(filePath, message);
-    }
-    /**
-     * Removes the session file from the disk
-     */
-    async destroy(sessionId) {
-        debug('file store: destroying session data %s', sessionId);
-        await rm(this.#getFilePath(sessionId), { force: true });
-    }
-    /**
-     * Updates the session expiry by rewriting it to the
-     * persistence store
-     */
-    async touch(sessionId) {
-        debug('file store: touching session data %s', sessionId);
-        await utimes(this.#getFilePath(sessionId), new Date(), new Date());
-    }
-}

package/build/src/stores/memory.js

@@ -1,33 +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.
- */
-/**
- * Memory store is meant to be used for writing tests.
- */
-export class MemoryStore {
-    static sessions = new Map();
-    /**
-     * Read session id value from the memory
-     */
-    read(sessionId) {
-        return MemoryStore.sessions.get(sessionId) || null;
-    }
-    /**
-     * Save in memory value for a given session id
-     */
-    write(sessionId, values) {
-        MemoryStore.sessions.set(sessionId, values);
-    }
-    /**
-     * Cleanup for a single session
-     */
-    destroy(sessionId) {
-        MemoryStore.sessions.delete(sessionId);
-    }
-    touch() { }
-}

package/build/src/stores/redis.js

@@ -1,66 +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 string from '@poppinss/utils/string';
-import { MessageBuilder } from '@adonisjs/core/helpers';
-import debug from '../debug.js';
-/**
- * File store to read/write session to filesystem
- */
-export class RedisStore {
-    #connection;
-    #ttlSeconds;
-    constructor(connection, age) {
-        this.#connection = connection;
-        this.#ttlSeconds = string.seconds.parse(age);
-        debug('initiating redis store');
-    }
-    /**
-     * Returns file contents. A new file will be created if it's
-     * missing.
-     */
-    async read(sessionId) {
-        debug('redis store: reading session data %s', sessionId);
-        const contents = await this.#connection.get(sessionId);
-        if (!contents) {
-            return null;
-        }
-        /**
-         * Verify contents with the session id and return them as an object. The verify
-         * method can fail when the contents is not JSON>
-         */
-        try {
-            return new MessageBuilder().verify(contents, sessionId);
-        }
-        catch {
-            return null;
-        }
-    }
-    /**
-     * Write session values to a file
-     */
-    async write(sessionId, values) {
-        debug('redis store: writing session data %s, %O', sessionId, values);
-        const message = new MessageBuilder().build(values, undefined, sessionId);
-        await this.#connection.setex(sessionId, this.#ttlSeconds, message);
-    }
-    /**
-     * Cleanup session file by removing it
-     */
-    async destroy(sessionId) {
-        debug('redis store: destroying session data %s', sessionId);
-        await this.#connection.del(sessionId);
-    }
-    /**
-     * Updates the value expiry
-     */
-    async touch(sessionId) {
-        debug('redis store: touching session data %s', sessionId);
-        await this.#connection.expire(sessionId, this.#ttlSeconds);
-    }
-}

package/build/src/types.js

@@ -1,9 +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.
- */
-export {};