@adonisjs/session 6.4.0 → 7.0.0-1

package/build/src/{Drivers/File.js → drivers/file.js}

@@ -1,50 +1,48 @@
-"use strict";
 /**
  * @adonisjs/session
  *
- * (c) Harminder Virk <virk@adonisjs.com>
+ * (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.FileDriver = void 0;
-/// <reference path="../../adonis-typings/index.ts" />
-const path_1 = require("path");
-const utils_1 = require("@poppinss/utils");
-const helpers_1 = require("@poppinss/utils/build/helpers");
-const fs_extra_1 = require("fs-extra");
+import { join } from 'node:path';
+import { Exception } from '@poppinss/utils';
+import { MessageBuilder } from '@poppinss/utils';
+import { ensureFile, outputFile, remove } from 'fs-extra/esm';
+import { readFile } from 'node:fs/promises';
 /**
  * File driver to read/write session to filesystem
  */
-class FileDriver {
+export class FileDriver {
+    #config;
     constructor(config) {
-        this.config = config;
-        if (!this.config.file || !this.config.file.location) {
-            throw new utils_1.Exception('Missing "file.location" for session file driver inside "config/session" file', 500, 'E_INVALID_SESSION_DRIVER_CONFIG');
+        this.#config = config;
+        if (!this.#config.file || !this.#config.file.location) {
+            throw new Exception('Missing "file.location" for session file driver inside "config/session" file', { code: 'E_INVALID_SESSION_DRIVER_CONFIG', status: 500 });
         }
     }
     /**
      * Returns complete path to the session file
      */
-    getFilePath(sessionId) {
-        return (0, path_1.join)(this.config.file.location, `${sessionId}.txt`);
+    #getFilePath(sessionId) {
+        return join(this.#config.file.location, `${sessionId}.txt`);
     }
     /**
      * Returns file contents. A new file will be created if it's
      * missing.
      */
     async read(sessionId) {
-        const filePath = this.getFilePath(sessionId);
-        await (0, fs_extra_1.ensureFile)(filePath);
-        const contents = await (0, fs_extra_1.readFile)(filePath, 'utf-8');
+        const filePath = this.#getFilePath(sessionId);
+        await ensureFile(filePath);
+        const contents = await readFile(filePath, 'utf-8');
         if (!contents.trim()) {
             return null;
         }
         /**
          * Verify contents with the session id and return them as an object.
          */
-        const verifiedContents = new helpers_1.MessageBuilder().verify(contents.trim(), sessionId);
+        const verifiedContents = new MessageBuilder().verify(contents.trim(), sessionId);
         if (typeof verifiedContents !== 'object') {
             return null;
         }
@@ -57,14 +55,14 @@ class FileDriver {
         if (typeof values !== 'object') {
             throw new Error('Session file driver expects an object of values');
         }
-        const message = new helpers_1.MessageBuilder().build(values, undefined, sessionId);
-        await (0, fs_extra_1.outputFile)(this.getFilePath(sessionId), message);
+        const message = new MessageBuilder().build(values, undefined, sessionId);
+        await outputFile(this.#getFilePath(sessionId), message);
     }
     /**
      * Cleanup session file by removing it
      */
     async destroy(sessionId) {
-        await (0, fs_extra_1.remove)(this.getFilePath(sessionId));
+        await remove(this.#getFilePath(sessionId));
     }
     /**
      * Writes the value by reading it from the store
@@ -77,4 +75,3 @@ class FileDriver {
         await this.write(sessionId, value);
     }
 }
-exports.FileDriver = FileDriver;

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

@@ -1,13 +1,12 @@
 /**
  * @adonisjs/session
  *
- * (c) Harminder Virk <virk@adonisjs.com>
+ * (c) AdonisJS
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-/// <reference path="../../adonis-typings/index.d.ts" />
-import { SessionDriverContract } from '@ioc:Adonis/Addons/Session';
+import { SessionDriverContract } from '../types.js';
 /**
  * Memory driver is meant to be used for writing tests.
  */

package/build/src/{Drivers/Memory.js → drivers/memory.js}

@@ -1,18 +1,16 @@
-"use strict";
 /**
  * @adonisjs/session
  *
- * (c) Harminder Virk <virk@adonisjs.com>
+ * (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.MemoryDriver = void 0;
 /**
  * Memory driver is meant to be used for writing tests.
  */
-class MemoryDriver {
+export class MemoryDriver {
+    static sessions = new Map();
     /**
      * Read session id value from the memory
      */
@@ -36,5 +34,3 @@ class MemoryDriver {
     }
     touch() { }
 }
-exports.MemoryDriver = MemoryDriver;
-MemoryDriver.sessions = new Map();

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

@@ -1,29 +1,19 @@
 /**
  * @adonisjs/session
  *
- * (c) Harminder Virk <virk@adonisjs.com>
+ * (c) AdonisJS
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-/// <reference path="../../adonis-typings/index.d.ts" />
-import { SessionDriverContract, SessionConfig } from '@ioc:Adonis/Addons/Session';
-import { RedisManagerContract } from '@ioc:Adonis/Addons/Redis';
+import type { RedisManagerContract } from '@adonisjs/redis/types';
+import type { SessionDriverContract, SessionConfig } from '../types.js';
 /**
  * File driver to read/write session to filesystem
  */
 export declare class RedisDriver implements SessionDriverContract {
-    private config;
-    private redis;
-    /**
-     * Convert milliseconds to seconds
-     */
-    private ttl;
-    constructor(config: SessionConfig, redis: RedisManagerContract);
-    /**
-     * Returns instance of the redis connection
-     */
-    private getRedisConnection;
+    #private;
+    constructor(config: SessionConfig, redis: RedisManagerContract<any>);
     /**
      * Returns file contents. A new file will be created if it's
      * missing.

package/build/src/drivers/redis.js

@@ -0,0 +1,74 @@
+/**
+ * @adonisjs/session
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { Exception } from '@poppinss/utils';
+import string from '@poppinss/utils/string';
+import { MessageBuilder } from '@poppinss/utils';
+/**
+ * File driver to read/write session to filesystem
+ */
+export class RedisDriver {
+    #config;
+    #redis;
+    #ttl;
+    constructor(config, redis) {
+        this.#config = config;
+        this.#redis = redis;
+        /**
+         * Convert milliseconds to seconds
+         */
+        this.#ttl = Math.round((typeof this.#config.age === 'string'
+            ? string.milliseconds.parse(this.#config.age)
+            : this.#config.age) / 1000);
+        if (!this.#config.redisConnection) {
+            throw new Exception('Missing redisConnection for session redis driver inside "config/session" file', { code: 'E_INVALID_SESSION_DRIVER_CONFIG', status: 500 });
+        }
+    }
+    /**
+     * 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 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 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);
+    }
+}

package/build/src/{Session/index.d.ts → session.d.ts}

@@ -1,15 +1,12 @@
-/// <reference path="../../adonis-typings/session.d.ts" />
-import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext';
-import { SessionConfig, SessionContract, AllowedSessionValues, SessionDriverContract } from '@ioc:Adonis/Addons/Session';
-import { Store } from '../Store';
+import type { SessionConfig, SessionDriverContract, AllowedSessionValues } from './types.js';
+import type { HttpContext } from '@adonisjs/core/http';
+import { Store } from './store.js';
 /**
  * Session class exposes the API to read/write values to the session for
  * a given request.
  */
-export declare class Session implements SessionContract {
-    private ctx;
-    private config;
-    private driver;
+export declare class Session {
+    #private;
     /**
      * Set to true inside the `initiate` method
      */
@@ -34,21 +31,6 @@ export declare class Session implements SessionContract {
      * A copy of previously set flash messages
      */
     flashMessages: Store;
-    /**
-     * Session id for the current request. It will be different
-     * from the "this.sessionId" when regenerate is called.
-     */
-    private currentSessionId;
-    /**
-     * A instance of store with values read from the driver. The store
-     * in initiated inside the [[initiate]] method
-     */
-    private store;
-    /**
-     * Whether or not to re-generate the session id before comitting
-     * session values.
-     */
-    private regeneratedSessionId;
     /**
      * A copy of flash messages. The `input` messages
      * are overwritten when any of the input related
@@ -57,50 +39,7 @@ export declare class Session implements SessionContract {
      * The `others` object is expanded with each call.
      */
     responseFlashMessages: Store;
-    /**
-     * Session key for setting flash messages
-     */
-    private flashMessagesKey;
-    constructor(ctx: HttpContextContract, config: SessionConfig, driver: SessionDriverContract);
-    /**
-     * Returns a merged copy of flash messages or null
-     * when nothing is set
-     */
-    private setFlashMessages;
-    /**
-     * Returns the existing session id or creates one.
-     */
-    private getSessionId;
-    /**
-     * Ensures the session store is initialized
-     */
-    private ensureIsReady;
-    /**
-     * Raises exception when session store is in readonly mode
-     */
-    private ensureIsMutable;
-    /**
-     * Touches the session cookie
-     */
-    private touchSessionCookie;
-    /**
-     * Commits the session value to the store
-     */
-    private commitValuesToStore;
-    /**
-     * Touches the driver to make sure the session values doesn't expire
-     */
-    private touchDriver;
-    /**
-     * Reading flash messages from the last HTTP request and
-     * updating the flash messages bag
-     */
-    private readLastRequestFlashMessage;
-    /**
-     * Share flash messages & read only session's functions with views
-     * (only when view property exists)
-     */
-    private shareLocalsWithView;
+    constructor(ctx: HttpContext, config: SessionConfig, driver: SessionDriverContract);
     /**
      * Initiating the session by reading it's value from the
      * driver and feeding it to a store.