@adonisjs/session 8.0.0-next.4 → 8.0.0-next.6

package/build/{session-C9ZmQmpM.js → define_config-BPZ6wVlF.js}

@@ -88,7 +88,7 @@ function defineConfig(config) {
 const stores = {
 	file: (config) => {
 		return configProvider.create(async () => {
-			const { FileStore } = await import("./file-BBU02j4z.js");
+			const { FileStore } = await import("./file-DwH574p2.js");
 			return (_, sessionConfig) => {
 				return new FileStore(config, sessionConfig.age);
 			};
@@ -96,7 +96,7 @@ const stores = {
 	},
 	redis: (config) => {
 		return configProvider.create(async (app) => {
-			const { RedisStore } = await import("./redis-rAHxNQ_8.js");
+			const { RedisStore } = await import("./redis-BQfYPsiI.js");
 			const redis = await app.container.make("redis");
 			return (_, sessionConfig) => {
 				return new RedisStore(redis.connection(config.connection), sessionConfig.age);
@@ -105,7 +105,7 @@ const stores = {
 	},
 	cookie: () => {
 		return configProvider.create(async () => {
-			const { CookieStore } = await import("./cookie--JOJxrtW.js");
+			const { CookieStore } = await import("./cookie-DLgizSjS.js");
 			return (ctx, sessionConfig) => {
 				return new CookieStore(sessionConfig.cookie, ctx);
 			};
@@ -113,7 +113,7 @@ const stores = {
 	},
 	dynamodb: (config) => {
 		return configProvider.create(async () => {
-			const { DynamoDBStore } = await import("./dynamodb-BFVgTQSf.js");
+			const { DynamoDBStore } = await import("./dynamodb-DaEv8Jfq.js");
 			const { DynamoDBClient } = await import("@aws-sdk/client-dynamodb");
 			const client = "clientConfig" in config ? new DynamoDBClient(config.clientConfig) : config.client;
 			return (_, sessionConfig) => {
@@ -126,7 +126,7 @@ const stores = {
 	},
 	database: (config) => {
 		return configProvider.create(async (app) => {
-			const { DatabaseStore } = await import("./database-JbWAJqhn.js");
+			const { DatabaseStore } = await import("./database-CAwFE3R1.js");
 			const db = await app.container.make("lucid.db");
 			const connectionName = config?.connectionName || db.primaryConnectionName;
 			if (!db.manager.has(connectionName)) throw new RuntimeException(`Invalid database connection "${connectionName}" referenced in session config`);

package/build/factories/main.js

@@ -1,10 +1,11 @@
-import "../session-Dd5u7w5Y.js";
+import "../session-DI1JHv1F.js";
 import "../main-kn40V-hF.js";
-import { t as defineConfig } from "../session-C9ZmQmpM.js";
+import { t as defineConfig } from "../define_config-BPZ6wVlF.js";
 import "../debug-BZVg83L1.js";
 import "../values_store-CvR1Sn37.js";
-import "../session_collection-D9JQJjpq.js";
-import { t as SessionMiddleware } from "../session_middleware-BoOMxNVH.js";
+import "../session_collection-SLmMBYfP.js";
+import "../index.js";
+import SessionMiddleware from "../src/session_middleware.js";
 import { Emitter } from "@adonisjs/core/events";
 import { AppFactory } from "@adonisjs/core/factories/app";
 var SessionMiddlewareFactory = class {

package/build/index.js

@@ -1,7 +1,7 @@
-import { r as errors_exports, t as Session } from "./session-Dd5u7w5Y.js";
+import { r as errors_exports, t as Session } from "./session-DI1JHv1F.js";
 import { t as stubsRoot } from "./main-kn40V-hF.js";
-import { n as stores, r as configure, t as defineConfig } from "./session-C9ZmQmpM.js";
+import { n as stores, r as configure, t as defineConfig } from "./define_config-BPZ6wVlF.js";
 import "./debug-BZVg83L1.js";
 import { n as ValuesStore, t as ReadOnlyValuesStore } from "./values_store-CvR1Sn37.js";
-import { t as SessionCollection } from "./session_collection-D9JQJjpq.js";
+import { t as SessionCollection } from "./session_collection-SLmMBYfP.js";
 export { ReadOnlyValuesStore, Session, SessionCollection, ValuesStore, configure, defineConfig, errors_exports as errors, stores, stubsRoot };

package/build/providers/session_provider.js

@@ -1,8 +1,8 @@
-import "../session-Dd5u7w5Y.js";
+import "../session-DI1JHv1F.js";
 import "../debug-BZVg83L1.js";
 import "../values_store-CvR1Sn37.js";
-import { t as SessionCollection } from "../session_collection-D9JQJjpq.js";
-import { t as SessionMiddleware } from "../session_middleware-BoOMxNVH.js";
+import { t as SessionCollection } from "../session_collection-SLmMBYfP.js";
+import SessionMiddleware from "../src/session_middleware.js";
 import { RuntimeException } from "@adonisjs/core/exceptions";
 import { configProvider } from "@adonisjs/core";
 var SessionProvider = class {

package/build/{session-Dd5u7w5Y.js → session-DI1JHv1F.js}

@@ -7,13 +7,13 @@ import Macroable from "@poppinss/macroable";
 import lodash from "@poppinss/utils/lodash";
 import is from "@adonisjs/core/helpers/is";
 var __defProp = Object.defineProperty;
-var __exportAll = (all, symbols) => {
+var __exportAll = (all, no_symbols) => {
 	let target = {};
 	for (var name in all) __defProp(target, name, {
 		get: all[name],
 		enumerable: true
 	});
-	if (symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
+	if (!no_symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
 	return target;
 };
 var errors_exports = /* @__PURE__ */ __exportAll({
@@ -184,10 +184,17 @@ var Session = class extends Macroable {
 	reflashExcept(keys) {
 		this.#getFlashStore("write").set("reflashed", lodash.omit(this.flashMessages.all(), keys));
 	}
+	supportsTagging() {
+		return "tag" in this.#store && "tagged" in this.#store;
+	}
 	async tag(userId) {
 		if (!("tag" in this.#store)) throw new E_SESSION_TAGGING_NOT_SUPPORTED();
 		await this.#store.tag(this.#sessionId, userId);
 	}
+	async untag(userId) {
+		if (!("tag" in this.#store)) throw new E_SESSION_TAGGING_NOT_SUPPORTED();
+		await this.#store.untag(this.#sessionId, userId);
+	}
 	regenerate() {
 		this.#sessionId = randomUUID();
 	}

package/build/{session_collection-D9JQJjpq.js → session_collection-SLmMBYfP.js}

@@ -1,4 +1,4 @@
-import { n as E_SESSION_TAGGING_NOT_SUPPORTED } from "./session-Dd5u7w5Y.js";
+import { n as E_SESSION_TAGGING_NOT_SUPPORTED } from "./session-DI1JHv1F.js";
 import { t as debug_default } from "./debug-BZVg83L1.js";
 var SessionCollection = class {
 	#store;

package/build/src/debug.d.ts

@@ -1,2 +1,13 @@
+/**
+ * Debug logger instance for AdonisJS session module.
+ * Logs debug information when NODE_DEBUG environment variable includes 'adonisjs:session'.
+ *
+ * @example
+ * // Enable debug logging by setting NODE_DEBUG environment variable
+ * // NODE_DEBUG=adonisjs:session node app.js
+ *
+ * debug('session initiated')
+ * debug('writing session data: %O', sessionData)
+ */
 declare const _default: import("node:util").DebugLogger;
 export default _default;

package/build/src/session.d.ts

@@ -73,7 +73,19 @@ export declare class Session extends Macroable {
      * @param ctx - HTTP context
      */
     constructor(config: SessionConfig, storeFactory: SessionStoreFactory, emitter: EmitterService, ctx: HttpContext);
+    /**
+     * Determines whether a value should be stored in flash messages.
+     * Objects can opt out by setting a STORE_IN_FLASH symbol property to false.
+     *
+     * @param value - Value to check for flash storage eligibility
+     */
     protected shouldFlashValue(value: unknown): unknown;
+    /**
+     * Filters flash data to only include values that should be flashed.
+     * Removes values that have opted out of flash storage.
+     *
+     * @param data - Flash data to filter
+     */
     protected cleanupFlashData<T>(data: T): T | Record<string, any>;
     /**
      * Initiates the session store. The method results in a noop when called multiple times.
@@ -268,6 +280,16 @@ export declare class Session extends Macroable {
      * session.reflashExcept(['error', 'warning'])
      */
     reflashExcept(keys: string[]): void;
+    /**
+     * Checks if the current store supports session tagging.
+     * Only Memory, Redis, and Database stores support tagging.
+     *
+     * @example
+     * if (session.supportsTagging()) {
+     *   await session.tag(String(user.id))
+     * }
+     */
+    supportsTagging(): boolean;
     /**
      * Tag the current session with a user ID.
      * Only supported by Memory, Redis, and Database stores.
@@ -280,6 +302,17 @@ export declare class Session extends Macroable {
      * await session.tag(String(user.id))
      */
     tag(userId: string): Promise<void>;
+    /**
+     * Removes the tag association between this session and a user ID.
+     * Only supported by Memory, Redis, and Database stores.
+     *
+     * @param userId - The user ID to untag this session from
+     *
+     * @example
+     * // During logout, untag the session
+     * await session.untag(String(user.id))
+     */
+    untag(userId: string): Promise<void>;
     /**
      * Re-generates the session id and migrates data to it
      *

package/build/src/session_collection.d.ts

@@ -6,7 +6,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import type { ResolvedSessionConfig, SessionData, TaggedSession } from './types.ts';
+import type { SessionData, TaggedSession, ResolvedSessionConfig } from './types.ts';
 /**
  * SessionCollection provides APIs for programmatic session
  * management. It allows reading, destroying, and tagging
@@ -35,7 +35,14 @@ export declare class SessionCollection {
      */
     constructor(config: ResolvedSessionConfig);
     /**
-     * Check if the current store supports tagging
+     * Checks if the current store supports session tagging.
+     * Only Memory, Redis, and Database stores support tagging.
+     *
+     * @example
+     * const collection = await app.container.make(SessionCollection)
+     * if (collection.supportsTagging()) {
+     *   await collection.tag(sessionId, userId)
+     * }
      */
     supportsTagging(): boolean;
     /**

package/build/src/session_middleware.js

@@ -1,5 +1,29 @@
-import "../session-Dd5u7w5Y.js";
+import { t as Session } from "../session-DI1JHv1F.js";
 import "../debug-BZVg83L1.js";
 import "../values_store-CvR1Sn37.js";
-import { t as SessionMiddleware } from "../session_middleware-BoOMxNVH.js";
+import { ExceptionHandler } from "@adonisjs/core/http";
+const originalErrorHandler = ExceptionHandler.prototype.renderValidationErrorAsHTML;
+ExceptionHandler.macro("renderValidationErrorAsHTML", async function(error, ctx) {
+	if (ctx.session) {
+		const withInput = ctx.request.header("X-Inertia") ? false : true;
+		ctx.session.flashValidationErrors(error, withInput);
+		ctx.response.redirect("back", true);
+	} else return originalErrorHandler(error, ctx);
+});
+var SessionMiddleware = class {
+	#config;
+	#emitter;
+	constructor(config, emitter) {
+		this.#config = config;
+		this.#emitter = emitter;
+	}
+	async handle(ctx, next) {
+		if (!this.#config.enabled) return next();
+		ctx.session = new Session(this.#config, this.#config.stores[this.#config.store], this.#emitter, ctx);
+		await ctx.session.initiate(false);
+		const response = await next();
+		await ctx.session.commit();
+		return response;
+	}
+};
 export { SessionMiddleware as default };

package/build/src/stores/database.d.ts

@@ -9,10 +9,27 @@
 import type { QueryClientContract } from '@adonisjs/lucid/types/database';
 import type { SessionStoreWithTaggingContract, SessionData, TaggedSession } from '../types.ts';
 /**
- * Database store to read/write session to SQL databases using Lucid
+ * Database store to read/write session data to SQL databases using Lucid.
+ * Supports PostgreSQL, MySQL, SQLite, and other Lucid-compatible databases.
+ * Includes automatic garbage collection of expired sessions.
+ *
+ * @example
+ * const dbStore = new DatabaseStore(db.connection(), '2 hours', {
+ *   tableName: 'sessions',
+ *   gcProbability: 2
+ * })
  */
 export declare class DatabaseStore implements SessionStoreWithTaggingContract {
     #private;
+    /**
+     * Creates a new database store instance
+     *
+     * @param client - Lucid query client instance
+     * @param age - Session age in seconds or time expression (e.g. '2 hours')
+     * @param options - Configuration options
+     * @param options.tableName - Database table name (defaults to "sessions")
+     * @param options.gcProbability - Garbage collection probability in percent (defaults to 2)
+     */
     constructor(client: QueryClientContract, age: string | number, options?: {
         /**
          * Defaults to "sessions"
@@ -29,43 +46,73 @@ export declare class DatabaseStore implements SessionStoreWithTaggingContract {
         gcProbability?: number;
     });
     /**
-     * Returns session data
+     * Reads session data from the database
      *
      * @param sessionId - Session identifier
+     *
+     * @example
+     * const data = await store.read('sess_abc123')
      */
     read(sessionId: string): Promise<SessionData | null>;
     /**
-     * Write session values to the database
+     * Writes session values to the database with expiry.
+     * Uses UPSERT to handle both new and existing sessions.
      *
      * @param sessionId - Session identifier
      * @param values - Session data to store
+     *
+     * @example
+     * await store.write('sess_abc123', { userId: 123 })
      */
     write(sessionId: string, values: Object): Promise<void>;
     /**
-     * Cleanup session by removing it
+     * Removes session data from the database
      *
-     * @param sessionId - Session identifier
+     * @param sessionId - Session identifier to remove
+     *
+     * @example
+     * await store.destroy('sess_abc123')
      */
     destroy(sessionId: string): Promise<void>;
     /**
-     * Updates the session expiry
+     * Updates the session expiry time in the database
      *
      * @param sessionId - Session identifier
+     *
+     * @example
+     * await store.touch('sess_abc123')
      */
     touch(sessionId: string): Promise<void>;
     /**
-     * Tag a session with a user ID.
+     * Tags a session with a user ID for tracking user sessions.
      * Uses UPSERT to handle both existing and new sessions.
      *
      * @param sessionId - Session identifier
      * @param userId - User identifier to tag the session with
+     *
+     * @example
+     * await store.tag('sess_abc123', 'user_456')
      */
     tag(sessionId: string, userId: string | number): Promise<void>;
+    /**
+     * Removes the tag association between a session and a user ID.
+     * Sets the user_id column to null for the given session.
+     *
+     * @param sessionId - Session identifier
+     * @param userId - User identifier (for logging purposes)
+     *
+     * @example
+     * await store.untag('sess_abc123', 'user_456')
+     */
     untag(sessionId: string, userId: string | number): Promise<void>;
     /**
-     * Get all sessions for a given user ID (tag)
+     * Returns all active sessions for a given user ID (tag).
+     * Only returns non-expired sessions.
      *
      * @param userId - User identifier to get sessions for
+     *
+     * @example
+     * const sessions = await store.tagged('user_456')
      */
     tagged(userId: string): Promise<TaggedSession[]>;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@adonisjs/session",
   "description": "Session provider for AdonisJS",
-  "version": "8.0.0-next.4",
+  "version": "8.0.0-next.6",
   "engines": {
     "node": ">=24.0.0"
   },
@@ -44,16 +44,16 @@
     "quick:test": "node --import=@poppinss/ts-exec --enable-source-maps bin/test.ts"
   },
   "devDependencies": {
-    "@adonisjs/assembler": "^8.0.0-next.31",
-    "@adonisjs/core": "^7.0.0-next.27",
+    "@adonisjs/assembler": "^8.0.0-next.33",
+    "@adonisjs/core": "^7.0.0-next.29",
     "@adonisjs/eslint-config": "^3.0.0-next.9",
     "@adonisjs/i18n": "^3.0.0-next.2",
-    "@adonisjs/lucid": "^22.0.0-next.7",
+    "@adonisjs/lucid": "^22.0.0-next.9",
     "@adonisjs/prettier-config": "^1.4.5",
     "@adonisjs/redis": "^10.0.0-next.2",
     "@adonisjs/tsconfig": "^2.0.0-next.3",
-    "@aws-sdk/client-dynamodb": "^3.980.0",
-    "@aws-sdk/util-dynamodb": "^3.980.0",
+    "@aws-sdk/client-dynamodb": "^3.992.0",
+    "@aws-sdk/util-dynamodb": "^3.992.0",
     "@japa/api-client": "^3.2.1",
     "@japa/assert": "^4.2.0",
     "@japa/browser-client": "^2.3.0",
@@ -61,12 +61,12 @@
     "@japa/plugin-adonisjs": "^5.1.0-next.1",
     "@japa/runner": "^5.3.0",
     "@japa/snapshot": "^2.0.10",
-    "@poppinss/ts-exec": "^1.4.3",
-    "@release-it/conventional-changelog": "^10.0.4",
-    "@types/node": "^25.1.0",
+    "@poppinss/ts-exec": "^1.4.4",
+    "@release-it/conventional-changelog": "^10.0.5",
+    "@types/node": "^25.2.3",
     "@types/set-cookie-parser": "^2.4.10",
     "@types/supertest": "^6.0.3",
-    "@vinejs/vine": "^4.2.0",
+    "@vinejs/vine": "^4.3.0",
     "better-sqlite3": "^12.6.2",
     "c8": "^10.1.3",
     "copyfiles": "^2.4.1",
@@ -74,20 +74,20 @@
     "edge.js": "^6.4.0",
     "eslint": "^9.39.2",
     "get-port": "^7.1.0",
-    "mysql2": "^3.16.2",
+    "mysql2": "^3.17.2",
     "pg": "^8.18.0",
-    "playwright": "^1.58.1",
+    "playwright": "^1.58.2",
     "prettier": "^3.8.1",
     "release-it": "^19.2.4",
     "set-cookie-parser": "^3.0.1",
     "supertest": "^7.2.2",
-    "tsdown": "^0.20.1",
-    "typedoc": "^0.28.16",
+    "tsdown": "^0.20.3",
+    "typedoc": "^0.28.17",
     "typescript": "^5.9.3"
   },
   "dependencies": {
     "@poppinss/macroable": "^1.1.0",
-    "@poppinss/utils": "^7.0.0-next.6"
+    "@poppinss/utils": "^7.0.0-next.7"
   },
   "peerDependencies": {
     "@adonisjs/assembler": "^8.0.0-next.26",

package/build/session_middleware-BoOMxNVH.js

@@ -1,27 +0,0 @@
-import { t as Session } from "./session-Dd5u7w5Y.js";
-import { ExceptionHandler } from "@adonisjs/core/http";
-const originalErrorHandler = ExceptionHandler.prototype.renderValidationErrorAsHTML;
-ExceptionHandler.macro("renderValidationErrorAsHTML", async function(error, ctx) {
-	if (ctx.session) {
-		const withInput = ctx.request.header("X-Inertia") ? false : true;
-		ctx.session.flashValidationErrors(error, withInput);
-		ctx.response.redirect("back", true);
-	} else return originalErrorHandler(error, ctx);
-});
-var SessionMiddleware = class {
-	#config;
-	#emitter;
-	constructor(config, emitter) {
-		this.#config = config;
-		this.#emitter = emitter;
-	}
-	async handle(ctx, next) {
-		if (!this.#config.enabled) return next();
-		ctx.session = new Session(this.#config, this.#config.stores[this.#config.store], this.#emitter, ctx);
-		await ctx.session.initiate(false);
-		const response = await next();
-		await ctx.session.commit();
-		return response;
-	}
-};
-export { SessionMiddleware as t };