@adonisjs/session 7.0.0-2 → 7.0.0-3

package/build/src/session_middleware.js

@@ -1,12 +1,44 @@
+/*
+ * @adonisjs/session
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { ExceptionHandler } from '@adonisjs/core/http';
+import { Session } from './session.js';
+import sessionDriversList from './drivers_collection.js';
+/**
+ * Overwriting validation exception renderer
+ */
+const originalErrorHandler = ExceptionHandler.prototype.renderValidationErrorAsHTML;
+ExceptionHandler.macro('renderValidationErrorAsHTML', async function (error, ctx) {
+    if (ctx.session) {
+        ctx.session.flashValidationErrors(error);
+        ctx.response.redirect('back', true);
+    }
+    else {
+        return originalErrorHandler(error, ctx);
+    }
+});
+/**
+ * Session middleware is used to initiate the session store
+ * and commit its values during an HTTP request
+ */
 export default class SessionMiddleware {
-    session;
-    constructor(session) {
-        this.session = session;
+    #config;
+    #emitter;
+    constructor(config, emitter) {
+        this.#config = config;
+        this.#emitter = emitter;
     }
     async handle(ctx, next) {
-        if (!this.session.isEnabled()) {
-            return;
+        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);
         /**
          * Initiate session store
          */
@@ -14,10 +46,14 @@ export default class SessionMiddleware {
         /**
          * Call next middlewares or route handler
          */
-        await next();
+        const response = await next();
         /**
          * Commit store mutations
          */
         await ctx.session.commit();
+        /**
+         * Return response
+         */
+        return response;
     }
 }

package/build/src/store.d.ts

@@ -1,32 +1,27 @@
-import type { AllowedSessionValues } from './types.js';
+import type { AllowedSessionValues, SessionData } from './types/main.js';
 /**
- * Session store to mutate and access values from the session object
+ * Session store encapsulates the session data and offers a
+ * declarative API to mutate it.
  */
 export declare class Store {
     #private;
-    constructor(values: {
-        [key: string]: any;
-    } | null);
+    constructor(values: SessionData | null);
     /**
      * Find if store is empty or not
      */
     get isEmpty(): boolean;
     /**
-     * Set key/value pair
+     * Find if the store has been modified.
      */
-    set(key: string, value: AllowedSessionValues): void;
+    get hasBeenModified(): boolean;
     /**
-     * Get value for a given key
+     * Set key/value pair
      */
-    get(key: string, defaultValue?: any): any;
+    set(key: string, value: AllowedSessionValues): void;
     /**
      * Remove key
      */
     unset(key: string): void;
-    /**
-     * Reset store by clearing it's values.
-     */
-    clear(): void;
     /**
      * Pull value from the store. It is same as calling
      * store.get and then store.unset
@@ -43,7 +38,7 @@ export declare class Store {
      */
     decrement(key: string, steps?: number): void;
     /**
-     * Overwrite the underlying values object
+     * Overwrite existing store data with new values.
      */
     update(values: {
         [key: string]: any;
@@ -54,6 +49,14 @@ export declare class Store {
     merge(values: {
         [key: string]: any;
     }): any;
+    /**
+     * Reset store by clearing it's values.
+     */
+    clear(): void;
+    /**
+     * Get value for a given key
+     */
+    get(key: string, defaultValue?: any): any;
     /**
      * A boolean to know if value exists. Extra guards to check
      * arrays for it's length as well.

package/build/src/store.js

@@ -6,16 +6,22 @@
  * 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 lodash from '@poppinss/utils/lodash';
+import { RuntimeException } from '@poppinss/utils';
 /**
- * Session store to mutate and access values from the session object
+ * Session store encapsulates the session data and offers a
+ * declarative API to mutate it.
  */
 export class Store {
     /**
      * Underlying store values
      */
     #values;
+    /**
+     * A boolean to know if store has been
+     * modified
+     */
+    #modified = false;
     constructor(values) {
         this.#values = values || {};
     }
@@ -26,29 +32,25 @@ export class Store {
         return !this.#values || Object.keys(this.#values).length === 0;
     }
     /**
-     * Set key/value pair
+     * Find if the store has been modified.
      */
-    set(key, value) {
-        lodash.set(this.#values, key, value);
+    get hasBeenModified() {
+        return this.#modified;
     }
     /**
-     * Get value for a given key
+     * Set key/value pair
      */
-    get(key, defaultValue) {
-        return lodash.get(this.#values, key, defaultValue);
+    set(key, value) {
+        this.#modified = true;
+        lodash.set(this.#values, key, value);
     }
     /**
      * Remove key
      */
     unset(key) {
+        this.#modified = true;
         lodash.unset(this.#values, key);
     }
-    /**
-     * Reset store by clearing it's values.
-     */
-    clear() {
-        this.update({});
-    }
     /**
      * Pull value from the store. It is same as calling
      * store.get and then store.unset
@@ -66,7 +68,7 @@ export class Store {
     increment(key, steps = 1) {
         const value = this.get(key, 0);
         if (typeof value !== 'number') {
-            throw new Exception(`Cannot increment "${key}", since original value is not a number`);
+            throw new RuntimeException(`Cannot increment "${key}". Existing value is not a number`);
         }
         this.set(key, value + steps);
     }
@@ -77,22 +79,36 @@ export class Store {
     decrement(key, steps = 1) {
         const value = this.get(key, 0);
         if (typeof value !== 'number') {
-            throw new Exception(`Cannot increment "${key}", since original value is not a number`);
+            throw new RuntimeException(`Cannot decrement "${key}". Existing value is not a number`);
         }
         this.set(key, value - steps);
     }
     /**
-     * Overwrite the underlying values object
+     * 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({});
+    }
+    /**
+     * Get value for a given key
+     */
+    get(key, defaultValue) {
+        return lodash.get(this.#values, key, defaultValue);
+    }
     /**
      * A boolean to know if value exists. Extra guards to check
      * arrays for it's length as well.

package/build/src/types/extended.d.ts

@@ -0,0 +1,19 @@
+import type { Session } from '../session.js';
+/**
+ * Events emitted by the session class
+ */
+declare module '@adonisjs/core/types' {
+    interface EventsList {
+        'session:initiated': {
+            session: Session;
+        };
+        'session:committed': {
+            session: Session;
+        };
+        'session:migrated': {
+            fromSessionId: string;
+            toSessionId: string;
+            session: Session;
+        };
+    }
+}

package/build/src/types/main.d.ts

@@ -0,0 +1,106 @@
+import type { HttpContext } from '@adonisjs/core/http';
+import { RedisConnections } from '@adonisjs/redis/types';
+import type { CookieOptions } from '@adonisjs/core/types/http';
+import type { FileDriver } from '../drivers/file.js';
+import type { RedisDriver } from '../drivers/redis.js';
+import type { MemoryDriver } from '../drivers/memory.js';
+import type { CookieDriver } from '../drivers/cookie.js';
+/**
+ * The values allowed by the `session.put` method
+ */
+export type AllowedSessionValues = string | boolean | number | object | Date | Array<any>;
+export type SessionData = Record<string, AllowedSessionValues>;
+/**
+ * Session drivers must implement the session driver contract.
+ */
+export interface SessionDriverContract {
+    /**
+     * The read method is used to read the data from the persistence
+     * store and return it back as an object
+     */
+    read(sessionId: string): Promise<SessionData | null> | SessionData | null;
+    /**
+     * The write method is used to write the session data into the
+     * persistence store.
+     */
+    write(sessionId: string, data: SessionData): Promise<void> | void;
+    /**
+     * The destroy method is used to destroy the session by removing
+     * its data from the persistence store
+     */
+    destroy(sessionId: string): Promise<void> | void;
+    /**
+     * The touch method should update the lifetime of session id without
+     * making changes to the session data.
+     */
+    touch(sessionId: string): Promise<void> | void;
+}
+/**
+ * Shape of session config.
+ */
+export interface SessionConfig {
+    /**
+     * Enable/disable sessions temporarily
+     */
+    enabled: boolean;
+    /**
+     * The drivers to use
+     */
+    driver: keyof SessionDriversList;
+    /**
+     * The name of the cookie for storing the session id.
+     */
+    cookieName: string;
+    /**
+     * When set to true, the session id cookie will be removed
+     * when the user closes the browser.
+     *
+     * However, the persisted data will continue to exist until
+     * it gets expired.
+     */
+    clearWithBrowser: boolean;
+    /**
+     * How long the session data should be kept alive without any
+     * activity.
+     *
+     * The session id cookie will also live for the same duration, unless
+     * "clearWithBrowser" is enabled
+     *
+     * The value should be a time expression or a number in seconds
+     */
+    age: string | number;
+    /**
+     * Configuration used by the cookie driver and for storing the
+     * session id cookie.
+     */
+    cookie: Omit<Partial<CookieOptions>, 'maxAge' | 'expires'>;
+}
+/**
+ * Configuration used by the file driver.
+ */
+export type FileDriverConfig = {
+    location: string;
+};
+/**
+ * Configuration used by the redis driver.
+ */
+export type RedisDriverConfig = {
+    connection: keyof RedisConnections;
+};
+/**
+ * Extending session config with the drivers config
+ */
+export interface SessionConfig {
+    file?: FileDriverConfig;
+    redis?: RedisDriverConfig;
+}
+/**
+ * List of the session drivers. The list can be extended using
+ * declaration merging
+ */
+export interface SessionDriversList {
+    file: (config: SessionConfig, ctx: HttpContext) => FileDriver;
+    cookie: (config: SessionConfig, ctx: HttpContext) => CookieDriver;
+    redis: (config: SessionConfig, ctx: HttpContext) => RedisDriver;
+    memory: (config: SessionConfig, ctx: HttpContext) => MemoryDriver;
+}

package/build/src/types/main.js

@@ -0,0 +1,9 @@
+/*
+ * @adonisjs/session
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@adonisjs/session",
   "description": "Session provider for AdonisJS",
-  "version": "7.0.0-2",
+  "version": "7.0.0-3",
   "engines": {
     "node": ">=18.16.0"
   },
@@ -11,20 +11,21 @@
     "build/src",
     "build/stubs",
     "build/providers",
-    "build/index.d.ts",
-    "build/index.js",
     "build/configure.d.ts",
-    "build/configure.js"
+    "build/configure.js",
+    "build/index.d.ts",
+    "build/index.js"
   ],
   "exports": {
     ".": "./build/index.js",
     "./session_provider": "./build/providers/session_provider.js",
     "./session_middleware": "./build/src/session_middleware.js",
+    "./client": "./build/src/client.js",
     "./types": "./build/src/types.js"
   },
   "scripts": {
     "pretest": "npm run lint",
-    "test": "c8 npm run quick:test",
+    "test": "cross-env NODE_DEBUG=adonisjs:session c8 npm run quick:test",
     "clean": "del-cli build",
     "typecheck": "tsc --noEmit",
     "copy:templates": "copyfiles \"stubs/**/*.stub\" build",
@@ -35,29 +36,29 @@
     "format": "prettier --write .",
     "release": "np",
     "version": "npm run build",
-    "sync-labels": "github-label-sync --labels .github/labels.json adonisjs/ally",
+    "sync-labels": "github-label-sync --labels .github/labels.json adonisjs/session",
     "quick:test": "node --enable-source-maps --loader=ts-node/esm bin/test.ts"
   },
   "devDependencies": {
-    "@adonisjs/application": "7.1.2-8",
-    "@adonisjs/core": "6.1.5-10",
+    "@adonisjs/core": "^6.1.5-14",
     "@adonisjs/eslint-config": "^1.1.8",
     "@adonisjs/prettier-config": "^1.1.8",
-    "@adonisjs/redis": "8.0.0-3",
+    "@adonisjs/redis": "^8.0.0-8",
     "@adonisjs/tsconfig": "^1.1.8",
-    "@adonisjs/view": "7.0.0-4",
-    "@japa/api-client": "2.0.0-0",
-    "@japa/assert": "2.0.0-1",
-    "@japa/file-system": "2.0.0-1",
-    "@japa/plugin-adonisjs": "2.0.0-1",
-    "@japa/runner": "3.0.0-6",
-    "@poppinss/dev-utils": "^2.0.3",
+    "@japa/api-client": "^2.0.0-0",
+    "@japa/assert": "^2.0.0-1",
+    "@japa/file-system": "^2.0.0-1",
+    "@japa/plugin-adonisjs": "^2.0.0-1",
+    "@japa/runner": "^3.0.0-6",
+    "@japa/snapshot": "^2.0.0-1",
     "@swc/core": "^1.3.70",
     "@types/node": "^20.4.2",
     "@types/set-cookie-parser": "^2.4.3",
     "@types/supertest": "^2.0.12",
+    "@vinejs/vine": "^1.6.0",
     "c8": "^8.0.0",
     "copyfiles": "^2.4.1",
+    "cross-env": "^7.0.3",
     "del-cli": "^5.0.0",
     "eslint": "^8.45.0",
     "github-label-sync": "^2.3.1",
@@ -70,11 +71,11 @@
     "typescript": "^5.1.6"
   },
   "dependencies": {
-    "@poppinss/utils": "6.5.0-3"
+    "@poppinss/utils": "^6.5.0-5"
   },
   "peerDependencies": {
-    "@adonisjs/core": "6.1.5-10",
-    "@adonisjs/redis": "8.0.0-3"
+    "@adonisjs/core": "^6.1.5-12",
+    "@adonisjs/redis": "^8.0.0-7"
   },
   "peerDependenciesMeta": {
     "@adonisjs/redis": {
@@ -124,7 +125,9 @@
     ],
     "exclude": [
       "tests/**",
-      "stubs/**"
+      "stubs/**",
+      "factories/**",
+      "bin/**"
     ]
   }
 }

package/build/src/bindings/api_client.d.ts

@@ -1,2 +0,0 @@
-import { SessionManager } from '../session_manager.js';
-export declare function extendApiClient(sessionManager: SessionManager): void;

package/build/src/bindings/api_client.js

@@ -1,135 +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 { ApiRequest, ApiResponse, ApiClient } from '@japa/api-client';
-import { inspect } from 'node:util';
-export function extendApiClient(sessionManager) {
-    /**
-     * Set "sessionClient" on the api request
-     */
-    ApiRequest.getter('sessionClient', function () {
-        return sessionManager.client();
-    }, true);
-    /**
-     * Send session values in the request
-     */
-    ApiRequest.macro('session', function (session) {
-        if (!this.sessionClient.isEnabled()) {
-            throw new Error('Cannot set session. Make sure to enable it inside "config/session" file');
-        }
-        this.sessionClient.merge(session);
-        return this;
-    });
-    /**
-     * Send flash messages in the request
-     */
-    ApiRequest.macro('flashMessages', function (messages) {
-        if (!this.sessionClient.isEnabled()) {
-            throw new Error('Cannot set flash messages. Make sure to enable the session inside "config/session" file');
-        }
-        this.sessionClient.flashMessages.merge(messages);
-        return this;
-    });
-    /**
-     * Returns reference to the session data from the session
-     * jar
-     */
-    ApiResponse.macro('session', function () {
-        return this.sessionJar.session;
-    });
-    /**
-     * Returns reference to the flash messages from the session
-     * jar
-     */
-    ApiResponse.macro('flashMessages', function () {
-        return this.sessionJar.flashMessages || {};
-    });
-    /**
-     * Assert response to contain a given session and optionally
-     * has the expected value
-     */
-    ApiResponse.macro('assertSession', function (name, value) {
-        this.ensureHasAssert();
-        this.assert.property(this.session(), name);
-        if (value !== undefined) {
-            this.assert.deepEqual(this.session()[name], value);
-        }
-    });
-    /**
-     * Assert response to not contain a given session
-     */
-    ApiResponse.macro('assertSessionMissing', function (name) {
-        this.ensureHasAssert();
-        this.assert.notProperty(this.session(), name);
-    });
-    /**
-     * Assert response to contain a given flash message and optionally
-     * has the expected value
-     */
-    ApiResponse.macro('assertFlashMessage', function (name, value) {
-        this.ensureHasAssert();
-        this.assert.property(this.flashMessages(), name);
-        if (value !== undefined) {
-            this.assert.deepEqual(this.flashMessages()[name], value);
-        }
-    });
-    /**
-     * Assert response to not contain a given session
-     */
-    ApiResponse.macro('assertFlashMissing', function (name) {
-        this.ensureHasAssert();
-        this.assert.notProperty(this.flashMessages(), name);
-    });
-    /**
-     * Dump session to the console
-     */
-    ApiResponse.macro('dumpSession', function (options) {
-        const inspectOptions = { depth: 2, showHidden: false, colors: true, ...options };
-        console.log(`"session"        => ${inspect(this.session(), inspectOptions)}`);
-        console.log(`"flashMessages"  => ${inspect(this.flashMessages(), inspectOptions)}`);
-        return this;
-    });
-    /**
-     * Adding hooks directly on the request object moves the hooks to
-     * the end of the queue (basically after the globally hooks)
-     */
-    ApiClient.onRequest((req) => {
-        /**
-         * Hook into request and persist session data to be available
-         * on the server during the request.
-         */
-        req.setup(async (request) => {
-            /**
-             * Persist session data and set the session id within the
-             * cookie
-             */
-            const { cookieName, sessionId } = await request.sessionClient.commit();
-            request.withCookie(cookieName, sessionId);
-            /**
-             * Cleanup if request has error. Otherwise the teardown
-             * hook will clear
-             */
-            return async (error) => {
-                if (error) {
-                    await request.sessionClient.forget();
-                }
-            };
-        });
-        /**
-         * Load messages from the session store and keep a reference to it
-         * inside the response object.
-         *
-         * We also destroy the session after getting a copy of the session
-         * data
-         */
-        req.teardown(async (response) => {
-            response.sessionJar = await response.request.sessionClient.load(response.cookies());
-            await response.request.sessionClient.forget();
-        });
-    });
-}

package/build/src/bindings/http_context.d.ts

@@ -1,5 +0,0 @@
-import { SessionManager } from '../session_manager.js';
-/**
- * Extends HttpContext class with the ally getter
- */
-export declare function extendHttpContext(session: SessionManager): void;

package/build/src/bindings/http_context.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 { HttpContext } from '@adonisjs/core/http';
-/**
- * Extends HttpContext class with the ally getter
- */
-export function extendHttpContext(session) {
-    HttpContext.getter('session', function () {
-        return session.create(this);
-    }, true);
-}