@adonisjs/session 7.0.0-11 → 7.0.0-13

package/build/src/session.js

@@ -8,9 +8,9 @@
  */
 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';
+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.
@@ -20,11 +20,14 @@ import debug from './debug.js';
  */
 export class Session {
     #config;
-    #driver;
+    #store;
     #emitter;
     #ctx;
     #readonly = false;
-    #store;
+    /**
+     * Session values store
+     */
+    #valuesStore;
     /**
      * Session id refers to the session id that will be committed
      * as a cookie during the response.
@@ -43,11 +46,11 @@ export class Session {
      * Store of flash messages that be written during the
      * HTTP request
      */
-    responseFlashMessages = new Store({});
+    responseFlashMessages = new ValuesStore({});
     /**
      * Store of flash messages for the current HTTP request.
      */
-    flashMessages = new Store({});
+    flashMessages = new ValuesStore({});
     /**
      * The key to use for storing flash messages inside
      * the session store.
@@ -77,7 +80,7 @@ export class Session {
      * A boolean to know if session store has been initiated
      */
     get initiated() {
-        return !!this.#store;
+        return !!this.#valuesStore;
     }
     /**
      * A boolean to know if the session id has been re-generated
@@ -90,20 +93,20 @@ export class Session {
      * A boolean to know if the session store is empty
      */
     get isEmpty() {
-        return this.#store?.isEmpty ?? true;
+        return this.#valuesStore?.isEmpty ?? true;
     }
     /**
      * A boolean to know if the session store has been
      * modified
      */
     get hasBeenModified() {
-        return this.#store?.hasBeenModified ?? false;
+        return this.#valuesStore?.hasBeenModified ?? false;
     }
-    constructor(config, driver, emitter, ctx) {
+    constructor(config, storeFactory, emitter, ctx) {
         this.#ctx = ctx;
         this.#config = config;
-        this.#driver = driver;
         this.#emitter = emitter;
+        this.#store = storeFactory(ctx, config);
         this.#sessionIdFromCookie = ctx.request.cookie(config.cookieName, undefined);
         this.#sessionId = this.#sessionIdFromCookie || cuid();
     }
@@ -112,7 +115,7 @@ export class Session {
      * mode
      */
     #getFlashStore(mode) {
-        if (!this.#store) {
+        if (!this.#valuesStore) {
             throw new errors.E_SESSION_NOT_READY();
         }
         if (mode === 'write' && this.readonly) {
@@ -123,27 +126,27 @@ export class Session {
     /**
      * Returns the store instance for a given mode
      */
-    #getStore(mode) {
-        if (!this.#store) {
+    #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.#store;
+        return this.#valuesStore;
     }
     /**
      * Initiates the session store. The method results in a noop
      * when called multiple times
      */
     async initiate(readonly) {
-        if (this.#store) {
+        if (this.#valuesStore) {
             return;
         }
         debug('initiating session (readonly: %s)', readonly);
         this.#readonly = readonly;
-        const contents = await this.#driver.read(this.#sessionId);
-        this.#store = new Store(contents);
+        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.
@@ -163,8 +166,8 @@ export class Session {
          */
         if ('view' in this.#ctx) {
             this.#ctx.view.share({
-                session: new ReadOnlyStore(this.#store.all()),
-                flashMessages: new ReadOnlyStore(this.flashMessages.all()),
+                session: new ReadOnlyValuesStore(this.#valuesStore.all()),
+                flashMessages: new ReadOnlyValuesStore(this.flashMessages.all()),
                 old: function (key, defaultValue) {
                     return this.flashMessages.get(key, defaultValue);
                 },
@@ -176,13 +179,13 @@ export class Session {
      * Put a key-value pair to the session data store
      */
     put(key, value) {
-        this.#getStore('write').set(key, value);
+        this.#getValuesStore('write').set(key, value);
     }
     /**
      * Check if a key exists inside the datastore
      */
     has(key) {
-        return this.#getStore('read').has(key);
+        return this.#getValuesStore('read').has(key);
     }
     /**
      * Get the value of a key from the session datastore.
@@ -190,26 +193,26 @@ export class Session {
      * does not exists or has undefined value.
      */
     get(key, defaultValue) {
-        return this.#getStore('read').get(key, defaultValue);
+        return this.#getValuesStore('read').get(key, defaultValue);
     }
     /**
      * Get everything from the session store
      */
     all() {
-        return this.#getStore('read').all();
+        return this.#getValuesStore('read').all();
     }
     /**
      * Remove a key from the session datastore
      */
     forget(key) {
-        return this.#getStore('write').unset(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.#getStore('write').pull(key, defaultValue);
+        return this.#getValuesStore('write').pull(key, defaultValue);
     }
     /**
      * Increment the value of a key inside the session
@@ -219,7 +222,7 @@ export class Session {
      * The value of a new key will be 1
      */
     increment(key, steps = 1) {
-        return this.#getStore('write').increment(key, steps);
+        return this.#getValuesStore('write').increment(key, steps);
     }
     /**
      * Increment the value of a key inside the session
@@ -229,13 +232,13 @@ export class Session {
      * The value of a new key will be -1
      */
     decrement(key, steps = 1) {
-        return this.#getStore('write').decrement(key, steps);
+        return this.#getValuesStore('write').decrement(key, steps);
     }
     /**
      * Empty the session store
      */
     clear() {
-        return this.#getStore('write').clear();
+        return this.#getValuesStore('write').clear();
     }
     /**
      * Flash validation error messages. Make sure the error
@@ -313,7 +316,7 @@ export class Session {
      * allowed after commit.
      */
     async commit() {
-        if (!this.#store || this.readonly) {
+        if (!this.#valuesStore || this.readonly) {
             return;
         }
         /**
@@ -339,7 +342,7 @@ export class Session {
          */
         if (this.isEmpty) {
             if (this.#sessionIdFromCookie) {
-                await this.#driver.destroy(this.#sessionIdFromCookie);
+                await this.#store.destroy(this.#sessionIdFromCookie);
             }
             this.#emitter.emit('session:committed', { session: this });
             return;
@@ -350,8 +353,8 @@ export class Session {
          */
         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());
+                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,
@@ -359,7 +362,7 @@ export class Session {
                 });
             }
             else {
-                await this.#driver.touch(this.#sessionId);
+                await this.#store.touch(this.#sessionId);
             }
             this.#emitter.emit('session:committed', { session: this });
             return;
@@ -368,8 +371,8 @@ export class Session {
          * 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());
+            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,
@@ -377,7 +380,7 @@ export class Session {
             });
         }
         else {
-            await this.#driver.write(this.#sessionId, this.#store.toJSON());
+            await this.#store.write(this.#sessionId, this.#valuesStore.toJSON());
         }
         this.#emitter.emit('session:committed', { session: this });
     }

package/build/src/session_middleware.d.ts

@@ -2,11 +2,11 @@ import { EmitterService } from '@adonisjs/core/types';
 import type { NextFn } from '@adonisjs/core/types/http';
 import { HttpContext } from '@adonisjs/core/http';
 import { Session } from './session.js';
-import type { SessionConfig } from './types/main.js';
+import type { SessionConfig, SessionStoreFactory } from './types.js';
 /**
  * HttpContext augmentations
  */
-declare module '@adonisjs/http-server' {
+declare module '@adonisjs/core/http' {
     interface HttpContext {
         session: Session;
     }
@@ -15,8 +15,11 @@ declare module '@adonisjs/http-server' {
  * Session middleware is used to initiate the session store
  * and commit its values during an HTTP request
  */
-export default class SessionMiddleware {
+export default class SessionMiddleware<KnownStores extends Record<string, SessionStoreFactory>> {
     #private;
-    constructor(config: SessionConfig, emitter: EmitterService);
+    constructor(config: SessionConfig & {
+        store: keyof KnownStores;
+        stores: KnownStores;
+    }, emitter: EmitterService);
     handle(ctx: HttpContext, next: NextFn): Promise<any>;
 }

package/build/src/session_middleware.js

@@ -8,7 +8,6 @@
  */
 import { ExceptionHandler } from '@adonisjs/core/http';
 import { Session } from './session.js';
-import sessionDriversList from './drivers_collection.js';
 /**
  * Overwriting validation exception renderer
  */
@@ -37,8 +36,8 @@ export default class SessionMiddleware {
         if (!this.#config.enabled) {
             return next();
         }
-        const driver = sessionDriversList.create(this.#config.driver, this.#config, ctx);
-        ctx.session = new Session(this.#config, driver, this.#emitter, ctx);
+        ctx.session = new Session(this.#config, this.#config.stores[this.#config.store], // reference to store factory
+        this.#emitter, ctx);
         /**
          * Initiate session store
          */

package/build/src/{drivers → stores}/cookie.d.ts

@@ -1,11 +1,11 @@
 import type { HttpContext } from '@adonisjs/core/http';
-import { CookieOptions } from '@adonisjs/core/types/http';
-import type { SessionData, SessionDriverContract } from '../types/main.js';
+import type { CookieOptions } from '@adonisjs/core/types/http';
+import type { SessionData, SessionStoreContract } from '../types.js';
 /**
- * Cookie driver stores the session data inside an encrypted
+ * Cookie store stores the session data inside an encrypted
  * cookie.
  */
-export declare class CookieDriver implements SessionDriverContract {
+export declare class CookieStore implements SessionStoreContract {
     #private;
     constructor(config: Partial<CookieOptions>, ctx: HttpContext);
     /**

package/build/src/{drivers → stores}/cookie.js

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

package/build/src/{drivers → stores}/file.d.ts

@@ -6,14 +6,14 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import type { FileDriverConfig, SessionData, SessionDriverContract } from '../types/main.js';
+import type { FileStoreConfig, SessionData, SessionStoreContract } from '../types.js';
 /**
- * File driver writes the session data on the file system as. Each session
+ * File store writes the session data on the file system as. Each session
  * id gets its own file.
  */
-export declare class FileDriver implements SessionDriverContract {
+export declare class FileStore implements SessionStoreContract {
     #private;
-    constructor(config: FileDriverConfig, age: string | number);
+    constructor(config: FileStoreConfig, age: string | number);
     /**
      * Reads the session data from the disk.
      */

package/build/src/{drivers → stores}/file.js

@@ -12,16 +12,16 @@ import { MessageBuilder } from '@adonisjs/core/helpers';
 import { access, mkdir, readFile, rm, writeFile, utimes, stat } from 'node:fs/promises';
 import debug from '../debug.js';
 /**
- * File driver writes the session data on the file system as. Each session
+ * File store writes the session data on the file system as. Each session
  * id gets its own file.
  */
-export class FileDriver {
+export class FileStore {
     #config;
     #age;
     constructor(config, age) {
         this.#config = config;
         this.#age = age;
-        debug('initiating file driver %O', this.#config);
+        debug('initiating file store %O', this.#config);
     }
     /**
      * Returns an absolute path to the session id file
@@ -70,7 +70,7 @@ export class FileDriver {
      */
     async read(sessionId) {
         const filePath = this.#getFilePath(sessionId);
-        debug('file driver: reading session data %', sessionId);
+        debug('file store: reading session data %', sessionId);
         /**
          * Return null when no session id file exists in first
          * place
@@ -84,7 +84,7 @@ export class FileDriver {
          */
         const sessionWillExpireAt = stats.mtimeMs + string.milliseconds.parse(this.#age);
         if (Date.now() > sessionWillExpireAt) {
-            debug('file driver: expired session data %s', sessionId);
+            debug('file store: expired session data %s', sessionId);
             return null;
         }
         /**
@@ -110,7 +110,7 @@ export class FileDriver {
      * Writes the session data to the disk as a string
      */
     async write(sessionId, values) {
-        debug('file driver: writing session data %s: %O', 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);
@@ -119,7 +119,7 @@ export class FileDriver {
      * Removes the session file from the disk
      */
     async destroy(sessionId) {
-        debug('file driver: destroying session data %s', sessionId);
+        debug('file store: destroying session data %s', sessionId);
         await rm(this.#getFilePath(sessionId), { force: true });
     }
     /**
@@ -127,7 +127,7 @@ export class FileDriver {
      * persistence store
      */
     async touch(sessionId) {
-        debug('file driver: touching session data %s', sessionId);
+        debug('file store: touching session data %s', sessionId);
         await utimes(this.#getFilePath(sessionId), new Date(), new Date());
     }
 }

package/build/src/{drivers → stores}/memory.d.ts

@@ -6,11 +6,11 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import type { SessionData, SessionDriverContract } from '../types/main.js';
+import type { SessionData, SessionStoreContract } from '../types.js';
 /**
- * Memory driver is meant to be used for writing tests.
+ * Memory store is meant to be used for writing tests.
  */
-export declare class MemoryDriver implements SessionDriverContract {
+export declare class MemoryStore implements SessionStoreContract {
     static sessions: Map<string, SessionData>;
     /**
      * Read session id value from the memory

package/build/src/{drivers → stores}/memory.js

@@ -7,27 +7,27 @@
  * file that was distributed with this source code.
  */
 /**
- * Memory driver is meant to be used for writing tests.
+ * Memory store is meant to be used for writing tests.
  */
-export class MemoryDriver {
+export class MemoryStore {
     static sessions = new Map();
     /**
      * Read session id value from the memory
      */
     read(sessionId) {
-        return MemoryDriver.sessions.get(sessionId) || null;
+        return MemoryStore.sessions.get(sessionId) || null;
     }
     /**
      * Save in memory value for a given session id
      */
     write(sessionId, values) {
-        MemoryDriver.sessions.set(sessionId, values);
+        MemoryStore.sessions.set(sessionId, values);
     }
     /**
      * Cleanup for a single session
      */
     destroy(sessionId) {
-        MemoryDriver.sessions.delete(sessionId);
+        MemoryStore.sessions.delete(sessionId);
     }
     touch() { }
 }

package/build/src/{drivers → stores}/redis.d.ts

@@ -6,14 +6,14 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import type { RedisService } from '@adonisjs/redis/types';
-import type { SessionDriverContract, RedisDriverConfig, SessionData } from '../types/main.js';
+import type { Connection } from '@adonisjs/redis/types';
+import type { SessionStoreContract, SessionData } from '../types.js';
 /**
- * File driver to read/write session to filesystem
+ * File store to read/write session to filesystem
  */
-export declare class RedisDriver implements SessionDriverContract {
+export declare class RedisStore implements SessionStoreContract {
     #private;
-    constructor(redis: RedisService, config: RedisDriverConfig, age: string | number);
+    constructor(connection: Connection, age: string | number);
     /**
      * Returns file contents. A new file will be created if it's
      * missing.

package/build/src/{drivers → stores}/redis.js

@@ -10,25 +10,23 @@ import string from '@poppinss/utils/string';
 import { MessageBuilder } from '@adonisjs/core/helpers';
 import debug from '../debug.js';
 /**
- * File driver to read/write session to filesystem
+ * File store to read/write session to filesystem
  */
-export class RedisDriver {
-    #config;
-    #redis;
+export class RedisStore {
+    #connection;
     #ttlSeconds;
-    constructor(redis, config, age) {
-        this.#config = config;
-        this.#redis = redis;
+    constructor(connection, age) {
+        this.#connection = connection;
         this.#ttlSeconds = string.seconds.parse(age);
-        debug('initiating redis driver %O', this.#config);
+        debug('initiating redis store');
     }
     /**
      * Returns file contents. A new file will be created if it's
      * missing.
      */
     async read(sessionId) {
-        debug('redis driver: reading session data %s', sessionId);
-        const contents = await this.#redis.connection(this.#config.connection).get(sessionId);
+        debug('redis store: reading session data %s', sessionId);
+        const contents = await this.#connection.get(sessionId);
         if (!contents) {
             return null;
         }
@@ -47,24 +45,22 @@ export class RedisDriver {
      * Write session values to a file
      */
     async write(sessionId, values) {
-        debug('redis driver: writing session data %s, %O', sessionId, values);
+        debug('redis store: writing session data %s, %O', sessionId, values);
         const message = new MessageBuilder().build(values, undefined, sessionId);
-        await this.#redis
-            .connection(this.#config.connection)
-            .setex(sessionId, this.#ttlSeconds, message);
+        await this.#connection.setex(sessionId, this.#ttlSeconds, message);
     }
     /**
      * Cleanup session file by removing it
      */
     async destroy(sessionId) {
-        debug('redis driver: destroying session data %s', sessionId);
-        await this.#redis.connection(this.#config.connection).del(sessionId);
+        debug('redis store: destroying session data %s', sessionId);
+        await this.#connection.del(sessionId);
     }
     /**
      * Updates the value expiry
      */
     async touch(sessionId) {
-        debug('redis driver: touching session data %s', sessionId);
-        await this.#redis.connection(this.#config.connection).expire(sessionId, this.#ttlSeconds);
+        debug('redis store: touching session data %s', sessionId);
+        await this.#connection.expire(sessionId, this.#ttlSeconds);
     }
 }