@adonisjs/session 6.4.0 → 7.0.0-0

package/build/configure.d.ts

@@ -0,0 +1,5 @@
+import type Configure from '@adonisjs/core/commands/configure';
+/**
+ * Configures the package
+ */
+export declare function configure(command: Configure): Promise<void>;

package/build/configure.js

@@ -0,0 +1,18 @@
+/*
+ * @adonisjs/session
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+/**
+ * Configures the package
+ */
+export async function configure(command) {
+    await command.publishStub('config.stub');
+    await command.defineEnvVariables({ SESSION_DRIVER: 'cookie' });
+    await command.updateRcFile((rcFile) => {
+        rcFile.addProvider('@adonisjs/session/session_provider');
+    });
+}

package/build/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @adonisjs/session
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import './src/bindings/types.js';
+export { defineConfig } from './src/define_config.js';
+export { stubsRoot } from './stubs/main.js';
+export { configure } from './configure.js';

package/build/index.js

@@ -0,0 +1,12 @@
+/**
+ * @adonisjs/session
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import './src/bindings/types.js';
+export { defineConfig } from './src/define_config.js';
+export { stubsRoot } from './stubs/main.js';
+export { configure } from './configure.js';

package/build/providers/session_provider.d.ts

@@ -0,0 +1,13 @@
+import { ApplicationService } from '@adonisjs/core/types';
+export default class SessionProvider {
+    protected app: ApplicationService;
+    constructor(app: ApplicationService);
+    /**
+     * Register Session Manager in the container
+     */
+    register(): Promise<void>;
+    /**
+     * Register bindings
+     */
+    boot(): Promise<void>;
+}

package/build/providers/session_provider.js

@@ -0,0 +1,43 @@
+/*
+ * @adonisjs/session
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { extendHttpContext } from '../src/bindings/http_context.js';
+import { extendApiClient } from '../src/bindings/api_client.js';
+export default class SessionProvider {
+    app;
+    constructor(app) {
+        this.app = app;
+    }
+    /**
+     * Register Session Manager in the container
+     */
+    async register() {
+        this.app.container.singleton('session', async () => {
+            const { SessionManager } = await import('../src/session_manager.js');
+            const encryption = await this.app.container.make('encryption');
+            const redis = await this.app.container.make('redis').catch(() => undefined);
+            const config = this.app.config.get('session', {});
+            return new SessionManager(config, encryption, redis);
+        });
+    }
+    /**
+     * Register bindings
+     */
+    async boot() {
+        const sessionManager = await this.app.container.make('session');
+        /**
+         * Add `session` getter to the HttpContext class
+         */
+        extendHttpContext(sessionManager);
+        /**
+         * Add some macros and getter to japa/api-client classes for
+         * easier testing
+         */
+        extendApiClient(sessionManager);
+    }
+}

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

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

package/build/src/{Bindings/Tests.js → bindings/api_client.js}

@@ -1,4 +1,3 @@
-"use strict";
 /*
  * @adonisjs/session
  *
@@ -7,18 +6,14 @@
  * 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.defineTestsBindings = void 0;
-const util_1 = require("util");
-/**
- * Define test bindings
- */
-function defineTestsBindings(ApiRequest, ApiResponse, ApiClient, SessionManager) {
+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();
+        return sessionManager.client();
     }, true);
     /**
      * Send session values in the request
@@ -95,8 +90,9 @@ function defineTestsBindings(ApiRequest, ApiResponse, ApiClient, SessionManager)
      */
     ApiResponse.macro('dumpSession', function (options) {
         const inspectOptions = { depth: 2, showHidden: false, colors: true, ...options };
-        console.log(`"session"        => ${(0, util_1.inspect)(this.session(), inspectOptions)}`);
-        console.log(`"flashMessages"  => ${(0, util_1.inspect)(this.flashMessages(), inspectOptions)}`);
+        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
@@ -113,7 +109,7 @@ function defineTestsBindings(ApiRequest, ApiResponse, ApiClient, SessionManager)
              * cookie
              */
             const { cookieName, sessionId } = await request.sessionClient.commit();
-            request.cookie(cookieName, sessionId);
+            request.withCookie(cookieName, sessionId);
             /**
              * Cleanup if request has error. Otherwise the teardown
              * hook will clear
@@ -137,4 +133,3 @@ function defineTestsBindings(ApiRequest, ApiResponse, ApiClient, SessionManager)
         });
     });
 }
-exports.defineTestsBindings = defineTestsBindings;

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

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,17 @@
+/*
+ * @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);
+}

package/build/{adonis-typings/tests.d.ts → src/bindings/types.d.ts}

@@ -1,10 +1,31 @@
-/// <reference types="node" />
-import '@japa/api-client';
-import { InspectOptions } from 'util';
-import { AllowedSessionValues, SessionClientContract } from '@ioc:Adonis/Addons/Session';
+/// <reference types="@types/node" resolution-mode="require"/>
+import { InspectOptions } from 'node:util';
+import type { SessionClient } from '../client.js';
+import type { Session } from '../session.js';
+import type { SessionManager } from '../session_manager.js';
+import type { AllowedSessionValues } from '../types.js';
+/**
+ * HttpContext augmentations
+ */
+declare module '@adonisjs/core/http' {
+    interface HttpContext {
+        session: Session;
+    }
+}
+/**
+ * Container augmentations
+ */
+declare module '@adonisjs/core/types' {
+    interface ContainerBindings {
+        session: SessionManager;
+    }
+}
+/**
+ * Japa api client augmentations
+ */
 declare module '@japa/api-client' {
     interface ApiRequest {
-        sessionClient: SessionClientContract;
+        sessionClient: SessionClient;
         /**
          * Send session values in the request
          */

package/build/{adonis-typings/session.js → src/bindings/types.js}

@@ -1,8 +1,9 @@
 /*
  * @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.
  */
+export {};

package/build/src/{Client/index.d.ts → client.d.ts}

@@ -1,30 +1,22 @@
-/// <reference path="../../adonis-typings/index.d.ts" />
-/// <reference types="@adonisjs/http-server/build/adonis-typings" />
-import { SessionConfig, SessionDriverContract, SessionClientContract } from '@ioc:Adonis/Addons/Session';
-import { CookieClientContract } from '@ioc:Adonis/Core/CookieClient';
-import { Store } from '../Store';
+import { Store } from './store.js';
+import type { SessionConfig, SessionDriverContract } from './types.js';
+import type { CookieClient } from '@adonisjs/core/http';
 /**
  * SessionClient exposes the API to set session data as a client
  */
-export declare class SessionClient extends Store implements SessionClientContract {
-    private config;
-    private driver;
-    private cookieClient;
+export declare class SessionClient extends Store {
+    #private;
     /**
      * Each instance of client works on a single session id. Generate
      * multiple client instances for a different session id
      */
-    private sessionId;
-    /**
-     * Session key for setting flash messages
-     */
-    private flashMessagesKey;
+    sessionId: string;
     /**
      * Flash messages store. They are merged with the session data during
      * commit
      */
     flashMessages: Store;
-    constructor(config: SessionConfig, driver: SessionDriverContract, cookieClient: CookieClientContract, values: {
+    constructor(config: SessionConfig, driver: SessionDriverContract, cookieClient: CookieClient, values: {
         [key: string]: any;
     } | null);
     /**

package/build/src/client.js

@@ -0,0 +1,100 @@
+/*
+ * @adonisjs/session
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { cuid } from '@adonisjs/core/helpers';
+import { Store } from './store.js';
+/**
+ * SessionClient exposes the API to set session data as a client
+ */
+export class SessionClient extends Store {
+    /**
+     * Session configuration
+     */
+    #config;
+    /**
+     * The session driver used to read and write session data
+     */
+    #driver;
+    /**
+     * Cookie client contract to sign and unsign cookies
+     */
+    #cookieClient;
+    /**
+     * Each instance of client works on a single session id. Generate
+     * multiple client instances for a different session id
+     */
+    sessionId = cuid();
+    /**
+     * Session key for setting flash messages
+     */
+    #flashMessagesKey = '__flash__';
+    /**
+     * Flash messages store. They are merged with the session data during
+     * commit
+     */
+    flashMessages = new Store({});
+    constructor(config, driver, cookieClient, values) {
+        super(values);
+        this.#config = config;
+        this.#driver = driver;
+        this.#cookieClient = cookieClient;
+    }
+    /**
+     * Find if the sessions are enabled
+     */
+    isEnabled() {
+        return this.#config.enabled;
+    }
+    /**
+     * Load session from the driver
+     */
+    async load(cookies) {
+        const sessionIdCookie = cookies[this.#config.cookieName];
+        const sessionId = sessionIdCookie ? sessionIdCookie.value : this.sessionId;
+        const contents = await this.#driver.read(sessionId);
+        const store = new Store(contents);
+        const flashMessages = store.pull(this.#flashMessagesKey, null);
+        return {
+            session: store.all(),
+            flashMessages,
+        };
+    }
+    /**
+     * Commits the session data to the session store and returns
+     * the session id and cookie name for it to be accessible
+     * by the server
+     */
+    async commit() {
+        this.set(this.#flashMessagesKey, this.flashMessages.all());
+        await this.#driver.write(this.sessionId, this.toJSON());
+        /**
+         * Clear from the session client memory
+         */
+        this.clear();
+        this.flashMessages.clear();
+        return {
+            sessionId: this.sessionId,
+            signedSessionId: this.#cookieClient.sign(this.#config.cookieName, this.sessionId),
+            cookieName: this.#config.cookieName,
+        };
+    }
+    /**
+     * Clear the session store
+     */
+    async forget() {
+        /**
+         * Clear from the session client memory
+         */
+        this.clear();
+        this.flashMessages.clear();
+        /**
+         * Clear with the driver
+         */
+        await this.#driver.destroy(this.sessionId);
+    }
+}

package/build/src/define_config.d.ts

@@ -0,0 +1,5 @@
+import { SessionConfig } from './types.js';
+/**
+ * Helper to define session config
+ */
+export declare function defineConfig(config: SessionConfig): SessionConfig;

package/build/src/define_config.js

@@ -0,0 +1,13 @@
+import { InvalidArgumentsException } from '@poppinss/utils';
+/**
+ * Helper to define session config
+ */
+export function defineConfig(config) {
+    if (!config.cookieName) {
+        throw new InvalidArgumentsException('Missing "cookieName" property inside the session config');
+    }
+    if (!config.driver) {
+        throw new InvalidArgumentsException('Missing "driver" property inside the session config');
+    }
+    return config;
+}

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

@@ -1,13 +1,11 @@
-/// <reference path="../../adonis-typings/session.d.ts" />
-import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext';
-import { SessionDriverContract, SessionConfig } from '@ioc:Adonis/Addons/Session';
+import type { HttpContext } from '@adonisjs/core/http';
+import type { SessionConfig, SessionDriverContract } from '../types.js';
 /**
  * Cookie driver utilizes the encrypted HTTP cookies to write session value.
  */
 export declare class CookieDriver implements SessionDriverContract {
-    private config;
-    private ctx;
-    constructor(config: SessionConfig, ctx: HttpContextContract);
+    #private;
+    constructor(config: SessionConfig, ctx: HttpContext);
     /**
      * Read session value from the cookie
      */

package/build/src/{Drivers/Cookie.js → drivers/cookie.js}

@@ -1,27 +1,26 @@
-"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.CookieDriver = void 0;
 /**
  * Cookie driver utilizes the encrypted HTTP cookies to write session value.
  */
-class CookieDriver {
+export class CookieDriver {
+    #config;
+    #ctx;
     constructor(config, ctx) {
-        this.config = config;
-        this.ctx = ctx;
+        this.#config = config;
+        this.#ctx = ctx;
     }
     /**
      * Read session value from the cookie
      */
     read(sessionId) {
-        const cookieValue = this.ctx.request.encryptedCookie(sessionId);
+        const cookieValue = this.#ctx.request.encryptedCookie(sessionId);
         if (typeof cookieValue !== 'object') {
             return null;
         }
@@ -34,14 +33,14 @@ class CookieDriver {
         if (typeof values !== 'object') {
             throw new Error('Session cookie driver expects an object of values');
         }
-        this.ctx.response.encryptedCookie(sessionId, values, this.config.cookie);
+        this.#ctx.response.encryptedCookie(sessionId, values, this.#config.cookie);
     }
     /**
      * Removes the session cookie
      */
     destroy(sessionId) {
-        if (this.ctx.request.cookiesList()[sessionId]) {
-            this.ctx.response.clearCookie(sessionId);
+        if (this.#ctx.request.cookiesList()[sessionId]) {
+            this.#ctx.response.clearCookie(sessionId);
         }
     }
     /**
@@ -55,4 +54,3 @@ class CookieDriver {
         this.write(sessionId, value);
     }
 }
-exports.CookieDriver = CookieDriver;

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

@@ -1,23 +1,18 @@
 /**
  * @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 { SessionConfig, SessionDriverContract } from '../types.js';
 /**
  * File driver to read/write session to filesystem
  */
 export declare class FileDriver implements SessionDriverContract {
-    private config;
+    #private;
     constructor(config: SessionConfig);
-    /**
-     * Returns complete path to the session file
-     */
-    private getFilePath;
     /**
      * Returns file contents. A new file will be created if it's
      * missing.

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();