@adonisjs/session 7.0.0-11 → 7.0.0-13

package/build/src/{types/main.d.ts → types.d.ts}

@@ -1,19 +1,15 @@
-import type { HttpContext } from '@adonisjs/core/http';
+import { 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.
+ * Session stores must implement the session store contract.
  */
-export interface SessionDriverContract {
+export interface SessionStoreContract {
     /**
      * The read method is used to read the data from the persistence
      * store and return it back as an object
@@ -36,17 +32,14 @@ export interface SessionDriverContract {
     touch(sessionId: string): Promise<void> | void;
 }
 /**
- * Shape of session config.
+ * Base configuration for managing sessions without
+ * stores.
  */
 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.
      */
@@ -76,31 +69,18 @@ export interface SessionConfig {
     cookie: Omit<Partial<CookieOptions>, 'maxAge' | 'expires'>;
 }
 /**
- * Configuration used by the file driver.
+ * Configuration used by the file store.
  */
-export type FileDriverConfig = {
+export type FileStoreConfig = {
     location: string;
 };
 /**
- * Configuration used by the redis driver.
+ * Configuration used by the redis store.
  */
-export type RedisDriverConfig = {
+export type RedisStoreConfig = {
     connection: keyof RedisConnections;
 };
 /**
- * Extending session config with the drivers config
+ * Factory function to instantiate session store
  */
-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;
-}
+export type SessionStoreFactory = (ctx: HttpContext, sessionConfig: SessionConfig) => SessionStoreContract;

package/build/src/{store.d.ts → values_store.d.ts}

@@ -1,8 +1,8 @@
-import type { AllowedSessionValues, SessionData } from './types/main.js';
+import type { AllowedSessionValues, SessionData } from './types.js';
 /**
  * Readonly session store
  */
-export declare class ReadOnlyStore {
+export declare class ReadOnlyValuesStore {
     /**
      * Underlying store values
      */
@@ -42,7 +42,7 @@ export declare class ReadOnlyStore {
  * Session store encapsulates the session data and offers a
  * declarative API to mutate it.
  */
-export declare class Store extends ReadOnlyStore {
+export declare class ValuesStore extends ReadOnlyValuesStore {
     #private;
     constructor(values: SessionData | null);
     /**

package/build/src/{store.js → values_store.js}

@@ -11,7 +11,7 @@ import { RuntimeException } from '@poppinss/utils';
 /**
  * Readonly session store
  */
-export class ReadOnlyStore {
+export class ReadOnlyValuesStore {
     /**
      * Underlying store values
      */
@@ -75,7 +75,7 @@ export class ReadOnlyStore {
  * Session store encapsulates the session data and offers a
  * declarative API to mutate it.
  */
-export class Store extends ReadOnlyStore {
+export class ValuesStore extends ReadOnlyValuesStore {
     /**
      * A boolean to know if store has been
      * modified

package/build/stubs/config.stub

@@ -1,8 +1,9 @@
----
-to: {{ app.configPath('session.ts') }}
----
+{{{
+  exports({ to: app.configPath('session.ts') })
+}}}
 import env from '#start/env'
-import { defineConfig } from '@adonisjs/session'
+import app from '@adonisjs/core/services/app'
+import { defineConfig, stores } from '@adonisjs/session'
 
 export default defineConfig({
   enabled: true,
@@ -21,29 +22,28 @@ export default defineConfig({
   age: '2h',
 
   /**
-   * The driver to use. Make sure to validate the environment
-   * variable in order to infer the driver name without any
-   * errors.
+   * Configuration for session cookie and the
+   * cookie store
    */
-  driver: env.get('SESSION_DRIVER'),
-
   cookie: {
     path: '/',
     httpOnly: true,
-    sameSite: false,
+    secure: app.inProduction,
+    sameSite: 'lax',
   },
 
   /**
-   * Settings for the file driver
+   * The store to use. Make sure to validate the environment
+   * variable in order to infer the store name without any
+   * errors.
    */
-  // file: {
-  //   location: app.tmpPath('sessions'),
-  // },
+  store: env.get('SESSION_DRIVER'),
 
   /**
-   * Settings for the redis driver
+   * List of configured stores. Refer documentation to see
+   * list of available stores and their config.
    */
-  // redis: {
-  //   connection: 'main'
-  // },
+  stores: {
+    cookie: stores.cookie(),
+  }
 })

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@adonisjs/session",
   "description": "Session provider for AdonisJS",
-  "version": "7.0.0-11",
+  "version": "7.0.0-13",
   "engines": {
     "node": ">=18.16.0"
   },
@@ -45,30 +45,30 @@
     "quick:test": "node --enable-source-maps --loader=ts-node/esm bin/test.ts"
   },
   "devDependencies": {
-    "@adonisjs/assembler": "^6.1.3-18",
-    "@adonisjs/core": "^6.1.5-24",
+    "@adonisjs/assembler": "^6.1.3-25",
+    "@adonisjs/core": "^6.1.5-28",
     "@adonisjs/eslint-config": "^1.1.8",
     "@adonisjs/prettier-config": "^1.1.8",
-    "@adonisjs/redis": "^8.0.0-10",
+    "@adonisjs/redis": "^8.0.0-11",
     "@adonisjs/tsconfig": "^1.1.8",
-    "@japa/api-client": "^2.0.0-0",
-    "@japa/assert": "^2.0.0-1",
-    "@japa/browser-client": "^2.0.0-3",
-    "@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",
+    "@japa/api-client": "^2.0.0",
+    "@japa/assert": "^2.0.0",
+    "@japa/browser-client": "^2.0.0",
+    "@japa/file-system": "^2.0.0",
+    "@japa/plugin-adonisjs": "^2.0.0",
+    "@japa/runner": "^3.0.4",
+    "@japa/snapshot": "^2.0.0",
     "@swc/core": "1.3.82",
-    "@types/node": "^20.6.0",
-    "@types/set-cookie-parser": "^2.4.3",
-    "@types/supertest": "^2.0.12",
+    "@types/node": "^20.8.7",
+    "@types/set-cookie-parser": "^2.4.4",
+    "@types/supertest": "^2.0.14",
     "@vinejs/vine": "^1.6.0",
     "c8": "^8.0.0",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
     "del-cli": "^5.0.0",
     "edge.js": "^6.0.0-8",
-    "eslint": "^8.49.0",
+    "eslint": "^8.51.0",
     "get-port": "^7.0.0",
     "github-label-sync": "^2.3.1",
     "husky": "^8.0.3",
@@ -81,13 +81,13 @@
     "typescript": "^5.1.6"
   },
   "dependencies": {
-    "@poppinss/utils": "^6.5.0-5"
+    "@poppinss/utils": "^6.5.0"
   },
   "peerDependencies": {
-    "@adonisjs/core": "^6.1.5-22",
-    "@adonisjs/redis": "^8.0.0-10",
-    "@japa/api-client": "^2.0.0-0",
-    "@japa/browser-client": "^2.0.0-3",
+    "@adonisjs/core": "^6.1.5-28",
+    "@adonisjs/redis": "^8.0.0-11",
+    "@japa/api-client": "^2.0.0",
+    "@japa/browser-client": "^2.0.0",
     "edge.js": "^6.0.0-8"
   },
   "peerDependenciesMeta": {

package/build/src/drivers_collection.d.ts

@@ -1,21 +0,0 @@
-import type { SessionDriversList } from './types/main.js';
-/**
- * A global collection of session drivers
- */
-declare class SessionDriversCollection {
-    /**
-     * List of registered drivers
-     */
-    list: Partial<SessionDriversList>;
-    /**
-     * Extend drivers collection and add a custom
-     * driver to it.
-     */
-    extend<Name extends keyof SessionDriversList>(driverName: Name, factoryCallback: SessionDriversList[Name]): this;
-    /**
-     * Creates the driver instance with config
-     */
-    create<Name extends keyof SessionDriversList>(name: Name, ...args: Parameters<SessionDriversList[Name]>): ReturnType<SessionDriversList[Name]>;
-}
-declare const sessionDriversList: SessionDriversCollection;
-export default sessionDriversList;

package/build/src/drivers_collection.js

@@ -1,38 +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 { RuntimeException } from '@poppinss/utils';
-/**
- * A global collection of session drivers
- */
-class SessionDriversCollection {
-    /**
-     * List of registered drivers
-     */
-    list = {};
-    /**
-     * Extend drivers collection and add a custom
-     * driver to it.
-     */
-    extend(driverName, factoryCallback) {
-        this.list[driverName] = factoryCallback;
-        return this;
-    }
-    /**
-     * Creates the driver instance with config
-     */
-    create(name, ...args) {
-        const driverFactory = this.list[name];
-        if (!driverFactory) {
-            throw new RuntimeException(`Unknown session driver "${String(name)}". Make sure the driver is registered`);
-        }
-        return driverFactory(args[0], args[1]);
-    }
-}
-const sessionDriversList = new SessionDriversCollection();
-export default sessionDriversList;

package/build/src/helpers.d.ts

@@ -1,6 +0,0 @@
-import type { ApplicationService } from '@adonisjs/core/types';
-import type { SessionDriversList } from './types/main.js';
-/**
- * Lazily imports and registers a driver with the sessionDriversList
- */
-export declare function registerSessionDriver(app: ApplicationService, driverInUse: keyof SessionDriversList): Promise<void>;

package/build/src/helpers.js

@@ -1,43 +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';
-import sessionDriversList from './drivers_collection.js';
-/**
- * Lazily imports and registers a driver with the sessionDriversList
- */
-export async function registerSessionDriver(app, driverInUse) {
-    /**
-     * Noop when the driver is already registered
-     */
-    if (sessionDriversList.list[driverInUse]) {
-        return;
-    }
-    debug('registering %s driver', driverInUse);
-    if (driverInUse === 'cookie') {
-        const { CookieDriver } = await import('../src/drivers/cookie.js');
-        sessionDriversList.extend('cookie', (config, ctx) => new CookieDriver(config.cookie, ctx));
-        return;
-    }
-    if (driverInUse === 'memory') {
-        const { MemoryDriver } = await import('../src/drivers/memory.js');
-        sessionDriversList.extend('memory', () => new MemoryDriver());
-        return;
-    }
-    if (driverInUse === 'file') {
-        const { FileDriver } = await import('../src/drivers/file.js');
-        sessionDriversList.extend('file', (config) => new FileDriver(config.file, config.age));
-        return;
-    }
-    if (driverInUse === 'redis') {
-        const { RedisDriver } = await import('../src/drivers/redis.js');
-        const redis = await app.container.make('redis');
-        sessionDriversList.extend('redis', (config) => new RedisDriver(redis, config.redis, config.age));
-        return;
-    }
-}

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

@@ -1,19 +0,0 @@
-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.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 {};