@adonisjs/session 7.0.0-2 → 7.0.0-4

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

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

@@ -1,77 +0,0 @@
-/// <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: SessionClient;
-        /**
-         * Send session values in the request
-         */
-        session(session: Record<string, AllowedSessionValues>): this;
-        /**
-         * Send flash messages in the request
-         */
-        flashMessages(messages: Record<string, AllowedSessionValues>): this;
-    }
-    interface ApiResponse {
-        /**
-         * A copy of session data loaded from the driver
-         */
-        sessionJar: {
-            session: Record<string, any>;
-            flashMessages: Record<string, any> | null;
-        };
-        /**
-         * Get session data
-         */
-        session(): Record<string, any>;
-        /**
-         * Dump session
-         */
-        dumpSession(options?: InspectOptions): this;
-        /**
-         * Get flash messages set by the server
-         */
-        flashMessages(): Record<string, any>;
-        /**
-         * Assert response to contain a given session and optionally
-         * has the expected value
-         */
-        assertSession(key: string, value?: any): void;
-        /**
-         * Assert response to not contain a given session
-         */
-        assertSessionMissing(key: string): void;
-        /**
-         * Assert response to contain a given flash message and optionally
-         * has the expected value
-         */
-        assertFlashMessage(key: string, value?: any): void;
-        /**
-         * Assert response to not contain a given session
-         */
-        assertFlashMissing(key: string): void;
-    }
-}

package/build/src/session_manager.d.ts

@@ -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 { Session } from './session.js';
-import { HttpContext } from '@adonisjs/core/http';
-import { ExtendCallback, SessionConfig } from './types.js';
-import { RedisManagerContract } from '@adonisjs/redis/types';
-import { Encryption } from '@adonisjs/core/encryption';
-import { SessionClient } from './client.js';
-/**
- * Session manager exposes the API to create session instance for a given
- * request and also add new drivers.
- */
-export declare class SessionManager {
-    #private;
-    constructor(config: SessionConfig, encryption: Encryption, redis?: RedisManagerContract<any>);
-    /**
-     * Find if the sessions are enabled
-     */
-    isEnabled(): boolean;
-    /**
-     * Creates an instance of the session client
-     */
-    client(): SessionClient;
-    /**
-     * Creates a new session instance for a given HTTP request
-     */
-    create(ctx: HttpContext): Session;
-    /**
-     * Extend the drivers list by adding a new one.
-     */
-    extend(driver: string, callback: ExtendCallback): void;
-}

package/build/src/session_manager.js

@@ -1,149 +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 string from '@poppinss/utils/string';
-import { Exception } from '@poppinss/utils';
-import { Session } from './session.js';
-import { CookieClient } from '@adonisjs/core/http';
-import { CookieDriver } from './drivers/cookie.js';
-import { MemoryDriver } from './drivers/memory.js';
-import { FileDriver } from './drivers/file.js';
-import { RedisDriver } from './drivers/redis.js';
-import { SessionClient } from './client.js';
-/**
- * Session manager exposes the API to create session instance for a given
- * request and also add new drivers.
- */
-export class SessionManager {
-    /**
-     * A private map of drivers added from outside in.
-     */
-    #extendedDrivers = new Map();
-    /**
-     * Reference to session config
-     */
-    #config;
-    /**
-     * Reference to the encryption instance
-     */
-    #encryption;
-    /**
-     * Reference to the redis manager
-     */
-    #redis;
-    constructor(config, encryption, redis) {
-        this.#encryption = encryption;
-        this.#redis = redis;
-        this.#processConfig(config);
-    }
-    /**
-     * Processes the config and decides the `expires` option for the cookie
-     */
-    #processConfig(config) {
-        /**
-         * Explicitly overwriting `cookie.expires` and `cookie.maxAge` from
-         * the user defined config
-         */
-        const processedConfig = Object.assign({ enabled: true }, config, {
-            cookie: {
-                ...config.cookie,
-                expires: undefined,
-                maxAge: undefined,
-            },
-        });
-        /**
-         * Set the max age when `clearWithBrowser = false`. Otherwise cookie
-         * is a session cookie
-         */
-        if (!processedConfig.clearWithBrowser) {
-            const age = typeof processedConfig.age === 'string'
-                ? Math.round(string.milliseconds.parse(processedConfig.age) / 1000)
-                : processedConfig.age;
-            processedConfig.cookie.maxAge = age;
-        }
-        this.#config = processedConfig;
-    }
-    /**
-     * Returns an instance of cookie driver
-     */
-    #createCookieDriver(ctx) {
-        return new CookieDriver(this.#config, ctx);
-    }
-    /**
-     * Returns an instance of the memory driver
-     */
-    #createMemoryDriver() {
-        return new MemoryDriver();
-    }
-    /**
-     * Returns an instance of file driver
-     */
-    #createFileDriver() {
-        return new FileDriver(this.#config);
-    }
-    /**
-     * Returns an instance of redis driver
-     */
-    #createRedisDriver() {
-        if (!this.#redis) {
-            throw new Error('Install "@adonisjs/redis" in order to use the redis driver for storing sessions');
-        }
-        return new RedisDriver(this.#config, this.#redis);
-    }
-    /**
-     * Creates an instance of extended driver
-     */
-    #createExtendedDriver(ctx) {
-        if (!this.#extendedDrivers.has(this.#config.driver)) {
-            throw new Exception(`"${this.#config.driver}" is not a valid session driver`, {
-                code: 'E_INVALID_SESSION_DRIVER',
-                status: 500,
-            });
-        }
-        return this.#extendedDrivers.get(this.#config.driver)(this, this.#config, ctx);
-    }
-    #createDriver(ctx) {
-        switch (this.#config.driver) {
-            case 'cookie':
-                return this.#createCookieDriver(ctx);
-            case 'file':
-                return this.#createFileDriver();
-            case 'redis':
-                return this.#createRedisDriver();
-            case 'memory':
-                return this.#createMemoryDriver();
-            default:
-                return this.#createExtendedDriver(ctx);
-        }
-    }
-    /**
-     * Find if the sessions are enabled
-     */
-    isEnabled() {
-        return this.#config.enabled;
-    }
-    /**
-     * Creates an instance of the session client
-     */
-    client() {
-        const cookieClient = new CookieClient(this.#encryption);
-        return new SessionClient(this.#config, this.#createMemoryDriver(), cookieClient, {});
-    }
-    /**
-     * Creates a new session instance for a given HTTP request
-     */
-    create(ctx) {
-        return new Session(ctx, this.#config, this.#createDriver(ctx));
-    }
-    /**
-     * Extend the drivers list by adding a new one.
-     */
-    extend(driver, callback) {
-        this.#extendedDrivers.set(driver, callback);
-    }
-}

package/build/src/types.d.ts

@@ -1,61 +0,0 @@
-import type { CookieOptions } from '@adonisjs/core/types/http';
-import type { SessionManager } from './session_manager.js';
-import type { HttpContext } from '@adonisjs/core/http';
-/**
- * The callback to be passed to the `extend` method. It is invoked
- * for each request (if extended driver is in use).
- */
-export type ExtendCallback = (manager: SessionManager, config: SessionConfig, ctx: HttpContext) => SessionDriverContract;
-/**
- * Shape of a driver that every session driver must have
- */
-export interface SessionDriverContract {
-    read(sessionId: string): Promise<Record<string, any> | null> | Record<string, any> | null;
-    write(sessionId: string, values: Record<string, any>): Promise<void> | void;
-    destroy(sessionId: string): Promise<void> | void;
-    touch(sessionId: string): Promise<void> | void;
-}
-/**
- * Shape of session config.
- */
-export interface SessionConfig {
-    /**
-     * Enable/disable session for the entire application lifecycle
-     */
-    enabled: boolean;
-    /**
-     * The driver in play
-     */
-    driver: string;
-    /**
-     * Cookie name.
-     */
-    cookieName: string;
-    /**
-     * Clear session when browser closes
-     */
-    clearWithBrowser: boolean;
-    /**
-     * Age of session cookie
-     */
-    age: string | number;
-    /**
-     * Config for the cookie driver and also the session id
-     * cookie
-     */
-    cookie: Omit<Partial<CookieOptions>, 'maxAge' | 'expires'>;
-    /**
-     * Config for the file driver
-     */
-    file?: {
-        location: string;
-    };
-    /**
-     * The redis connection to use from the `config/redis` file
-     */
-    redisConnection?: string;
-}
-/**
- * The values allowed by the `session.put` method
- */
-export type AllowedSessionValues = string | boolean | number | object | Date | Array<any>;

package/build/src/types.js

@@ -1 +0,0 @@
-export {};