@adonisjs/session 6.4.0 → 7.0.0-1

package/build/adonis-typings/session.d.ts

@@ -1,265 +0,0 @@
-/// <reference types="@adonisjs/http-server/build/adonis-typings" />
-/// <reference types="@adonisjs/application/build/adonis-typings" />
-declare module '@ioc:Adonis/Addons/Session' {
-    import { CookieOptions } from '@ioc:Adonis/Core/Response';
-    import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext';
-    import { ApplicationContract } from '@ioc:Adonis/Core/Application';
-    /**
-     * 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;
-    }
-    /**
-     * 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;
-    }
-    /**
-     * 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: SessionManagerContract, config: SessionConfig, ctx: HttpContextContract) => SessionDriverContract;
-    /**
-     * The values allowed by the `session.put` method
-     */
-    export type AllowedSessionValues = string | boolean | number | object | Date | Array<any>;
-    /**
-     * Store used for storing session values + flash messages
-     */
-    export interface StoreContract {
-        /**
-         * A boolean to know if store is empty
-         */
-        isEmpty: boolean;
-        /**
-         * Set value for a key
-         */
-        set(key: string, value: AllowedSessionValues): void;
-        /**
-         * Increment value for a key. An exception is raised when existing
-         * value is not a number
-         */
-        increment(key: string, steps?: number): void;
-        /**
-         * Decrement value for a key. An exception is raised when existing
-         * value is not a number
-         */
-        decrement(key: string, steps?: number): void;
-        /**
-         * Replace existing values with new ones
-         */
-        update(values: Record<string, any>): void;
-        /**
-         * Merge values with existing ones
-         */
-        merge(values: Record<string, any>): any;
-        /**
-         * Get all values
-         */
-        all(): any;
-        /**
-         * Get value for a given key or use the default value
-         */
-        get(key: string, defaultValue?: any): any;
-        /**
-         * Find if a value exists. Optionally you can also check arrays
-         * to have length too
-         */
-        has(key: string, checkForArraysLength?: boolean): boolean;
-        /**
-         * Unset value
-         */
-        unset(key: string): void;
-        /**
-         * Clear all values
-         */
-        clear(): void;
-        /**
-         * Read value and then unset it at the same time
-         */
-        pull(key: string, defaultValue?: any): any;
-        /**
-         * Convert store values toObject
-         */
-        toObject(): any;
-        /**
-         * Convert store values to toJSON
-         */
-        toJSON(): any;
-    }
-    /**
-     * Shape of the actual session store
-     */
-    export interface SessionContract {
-        /**
-         * Has the store being initiated
-         */
-        initiated: boolean;
-        /**
-         * Is session store readonly. Will be during Websockets
-         * request
-         */
-        readonly: boolean;
-        /**
-         * Is session just created or we read received the
-         * session id from the request
-         */
-        fresh: boolean;
-        /**
-         * Session id
-         */
-        sessionId: string;
-        /**
-         * Previous request flash messages
-         */
-        flashMessages: StoreContract;
-        /**
-         * Flash messages that will be sent in the current
-         * request response
-         */
-        responseFlashMessages: StoreContract;
-        /**
-         * Initiate session store
-         */
-        initiate(readonly: boolean): Promise<void>;
-        /**
-         * Commit session mutations
-         */
-        commit(): Promise<void>;
-        /**
-         * Re-generate session id. This help avoid session
-         * replay attacks.
-         */
-        regenerate(): void;
-        /**
-         * Store API
-         */
-        has(key: string): boolean;
-        put(key: string, value: AllowedSessionValues): void;
-        get(key: string, defaultValue?: any): any;
-        all(): any;
-        forget(key: string): void;
-        pull(key: string, defaultValue?: any): any;
-        increment(key: string, steps?: number): any;
-        decrement(key: string, steps?: number): any;
-        clear(): void;
-        /**
-         * Flash a key-value pair
-         */
-        flash(values: {
-            [key: string]: AllowedSessionValues;
-        }): void;
-        flash(key: string, value: AllowedSessionValues): void;
-        /**
-         * Flash request body
-         */
-        flashAll(): void;
-        /**
-         * Flash selected keys from the request body
-         */
-        flashOnly(keys: string[]): void;
-        /**
-         * Omit selected keys from the request data and flash
-         * the rest of values
-         */
-        flashExcept(keys: string[]): void;
-        /**
-         * Reflash existing flash messages
-         */
-        reflash(): void;
-        /**
-         * Reflash selected keys from the existing flash messages
-         */
-        reflashOnly(keys: string[]): void;
-        /**
-         * Omit selected keys from the existing flash messages
-         * and flash the rest of values
-         */
-        reflashExcept(keys: string[]): void;
-    }
-    /**
-     * SessionClient exposes the API to set session data as a client
-     */
-    export interface SessionClientContract extends StoreContract {
-        /**
-         * Find if the sessions are enabled
-         */
-        isEnabled(): boolean;
-        /**
-         * Flash messages store to set flash messages
-         */
-        flashMessages: StoreContract;
-        /**
-         * Load session data from the driver
-         */
-        load(cookies: Record<string, any>): Promise<{
-            session: Record<string, any>;
-            flashMessages: Record<string, any> | null;
-        }>;
-        /**
-         * Commits the session data to the session store and returns
-         * the session id and cookie name for it to be accessible
-         * by the server
-         */
-        commit(): Promise<{
-            cookieName: string;
-            sessionId: string;
-            signedSessionId: string;
-        }>;
-        /**
-         * Forget the session data.
-         */
-        forget(): Promise<void>;
-    }
-    /**
-     * Session manager shape
-     */
-    export interface SessionManagerContract {
-        isEnabled(): boolean;
-        application: ApplicationContract;
-        client(): SessionClientContract;
-        create(ctx: HttpContextContract): SessionContract;
-        extend(driver: string, callback: ExtendCallback): void;
-    }
-    const Session: SessionManagerContract;
-    export default Session;
-}

package/build/config.d.ts

@@ -1,13 +0,0 @@
-/**
- * @adonisjs/session
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { SessionConfig } from '@ioc:Adonis/Addons/Session';
-/**
- * Helper to define session config
- */
-export declare function sessionConfig<Config extends SessionConfig>(config: Config): Config;

package/build/config.js

@@ -1,18 +0,0 @@
-"use strict";
-/**
- * @adonisjs/session
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * 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.sessionConfig = void 0;
-/**
- * Helper to define session config
- */
-function sessionConfig(config) {
-    return config;
-}
-exports.sessionConfig = sessionConfig;

package/build/instructions.md

@@ -1,10 +0,0 @@
-The package has been configured successfully. The session configuration stored inside `config/session.ts` file relies on the following environment variables and hence we recommend validating them.
-
-Open the `env.ts` file and paste the following code inside the `Env.rules` object.
-
-```ts
-SESSION_DRIVER: Env.schema.string()
-```
-
-- Here we expect the `SESSION_DRIVER` environment variable to be always present
-- And should be a valid string

package/build/providers/SessionProvider.d.ts

@@ -1,31 +0,0 @@
-/**
- * @adonisjs/session
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-/// <reference types="@adonisjs/application/build/adonis-typings" />
-import { ApplicationContract } from '@ioc:Adonis/Core/Application';
-/**
- * Session provider for AdonisJS
- */
-export default class SessionProvider {
-    protected app: ApplicationContract;
-    constructor(app: ApplicationContract);
-    static needsApplication: boolean;
-    /**
-     * Register Session Manager
-     */
-    register(): void;
-    /**
-     * Register bindings for tests
-     */
-    protected registerTestsBindings(): void;
-    /**
-     * Register server bindings
-     */
-    protected registerServerBindings(): void;
-    boot(): void;
-}

package/build/providers/SessionProvider.js

@@ -1,56 +0,0 @@
-"use strict";
-/**
- * @adonisjs/session
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * 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 });
-/**
- * Session provider for AdonisJS
- */
-class SessionProvider {
-    constructor(app) {
-        this.app = app;
-    }
-    /**
-     * Register Session Manager
-     */
-    register() {
-        this.app.container.singleton('Adonis/Addons/Session', () => {
-            const { SessionManager } = require('../src/SessionManager');
-            return new SessionManager(this.app, this.app.config.get('session', {}));
-        });
-    }
-    /**
-     * Register bindings for tests
-     */
-    registerTestsBindings() {
-        this.app.container.withBindings([
-            'Japa/Preset/ApiRequest',
-            'Japa/Preset/ApiResponse',
-            'Japa/Preset/ApiClient',
-            'Adonis/Addons/Session',
-        ], (ApiRequest, ApiResponse, ApiClient, Session) => {
-            const { defineTestsBindings } = require('../src/Bindings/Tests');
-            defineTestsBindings(ApiRequest, ApiResponse, ApiClient, Session);
-        });
-    }
-    /**
-     * Register server bindings
-     */
-    registerServerBindings() {
-        this.app.container.withBindings(['Adonis/Core/Server', 'Adonis/Core/HttpContext', 'Adonis/Addons/Session'], (Server, HttpContext, Session) => {
-            const { defineServerBindings } = require('../src/Bindings/Server');
-            defineServerBindings(HttpContext, Server, Session);
-        });
-    }
-    boot() {
-        this.registerServerBindings();
-        this.registerTestsBindings();
-    }
-}
-exports.default = SessionProvider;
-SessionProvider.needsApplication = true;

package/build/src/Bindings/Server.d.ts

@@ -1,10 +0,0 @@
-/// <reference path="../../adonis-typings/index.d.ts" />
-/// <reference types="@adonisjs/http-server/build/adonis-typings" />
-import { ServerContract } from '@ioc:Adonis/Core/Server';
-import { SessionManagerContract } from '@ioc:Adonis/Addons/Session';
-import { HttpContextConstructorContract } from '@ioc:Adonis/Core/HttpContext';
-/**
- * Share "session" with the HTTP context. Define hooks to initiate and
- * commit session when sessions are enabled.
- */
-export declare function defineServerBindings(HttpContext: HttpContextConstructorContract, Server: ServerContract, Session: SessionManagerContract): void;

package/build/src/Bindings/Server.js

@@ -1,42 +0,0 @@
-"use strict";
-/*
- * @adonisjs/session
- *
- * (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.defineServerBindings = void 0;
-/**
- * Share "session" with the HTTP context. Define hooks to initiate and
- * commit session when sessions are enabled.
- */
-function defineServerBindings(HttpContext, Server, Session) {
-    /**
-     * Sharing session with the context
-     */
-    HttpContext.getter('session', function session() {
-        return Session.create(this);
-    }, true);
-    /**
-     * Do not register hooks when sessions are disabled
-     */
-    if (!Session.isEnabled()) {
-        return;
-    }
-    /**
-     * Initiate session store
-     */
-    Server.hooks.before(async (ctx) => {
-        await ctx.session.initiate(false);
-    });
-    /**
-     * Commit store mutations
-     */
-    Server.hooks.after(async (ctx) => {
-        await ctx.session.commit();
-    });
-}
-exports.defineServerBindings = defineServerBindings;

package/build/src/Bindings/Tests.d.ts

@@ -1,7 +0,0 @@
-/// <reference path="../../adonis-typings/index.d.ts" />
-import { ContainerBindings } from '@ioc:Adonis/Core/Application';
-import { SessionManagerContract } from '@ioc:Adonis/Addons/Session';
-/**
- * Define test bindings
- */
-export declare function defineTestsBindings(ApiRequest: ContainerBindings['Japa/Preset/ApiRequest'], ApiResponse: ContainerBindings['Japa/Preset/ApiResponse'], ApiClient: ContainerBindings['Japa/Preset/ApiClient'], SessionManager: SessionManagerContract): void;

package/build/src/Client/index.js

@@ -1,93 +0,0 @@
-"use strict";
-/*
- * @adonisjs/session
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * 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.SessionClient = void 0;
-/// <reference path="../../adonis-typings/index.ts" />
-const helpers_1 = require("@poppinss/utils/build/helpers");
-const Store_1 = require("../Store");
-/**
- * SessionClient exposes the API to set session data as a client
- */
-class SessionClient extends Store_1.Store {
-    constructor(config, driver, cookieClient, values) {
-        super(values);
-        this.config = config;
-        this.driver = driver;
-        this.cookieClient = cookieClient;
-        /**
-         * Each instance of client works on a single session id. Generate
-         * multiple client instances for a different session id
-         */
-        this.sessionId = (0, helpers_1.cuid)();
-        /**
-         * Session key for setting flash messages
-         */
-        this.flashMessagesKey = '__flash__';
-        /**
-         * Flash messages store. They are merged with the session data during
-         * commit
-         */
-        this.flashMessages = new Store_1.Store({});
-    }
-    /**
-     * 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_1.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);
-    }
-}
-exports.SessionClient = SessionClient;

package/build/src/Drivers/Redis.js

@@ -1,73 +0,0 @@
-"use strict";
-/**
- * @adonisjs/session
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * 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.RedisDriver = void 0;
-/// <reference path="../../adonis-typings/index.ts" />
-const utils_1 = require("@poppinss/utils");
-const helpers_1 = require("@poppinss/utils/build/helpers");
-/**
- * File driver to read/write session to filesystem
- */
-class RedisDriver {
-    constructor(config, redis) {
-        this.config = config;
-        this.redis = redis;
-        /**
-         * Convert milliseconds to seconds
-         */
-        this.ttl = Math.round((typeof this.config.age === 'string' ? helpers_1.string.toMs(this.config.age) : this.config.age) / 1000);
-        if (!this.config.redisConnection) {
-            throw new utils_1.Exception('Missing redisConnection for session redis driver inside "config/session" file', 500, 'E_INVALID_SESSION_DRIVER_CONFIG');
-        }
-    }
-    /**
-     * Returns instance of the redis connection
-     */
-    getRedisConnection() {
-        return this.redis.connection(this.config.redisConnection);
-    }
-    /**
-     * Returns file contents. A new file will be created if it's
-     * missing.
-     */
-    async read(sessionId) {
-        const contents = await this.getRedisConnection().get(sessionId);
-        if (!contents) {
-            return null;
-        }
-        const verifiedContents = new helpers_1.MessageBuilder().verify(contents, sessionId);
-        if (typeof verifiedContents !== 'object') {
-            return null;
-        }
-        return verifiedContents;
-    }
-    /**
-     * Write session values to a file
-     */
-    async write(sessionId, values) {
-        if (typeof values !== 'object') {
-            throw new Error('Session file driver expects an object of values');
-        }
-        await this.getRedisConnection().setex(sessionId, this.ttl, new helpers_1.MessageBuilder().build(values, undefined, sessionId));
-    }
-    /**
-     * Cleanup session file by removing it
-     */
-    async destroy(sessionId) {
-        await this.getRedisConnection().del(sessionId);
-    }
-    /**
-     * Updates the value expiry
-     */
-    async touch(sessionId) {
-        await this.getRedisConnection().expire(sessionId, this.ttl);
-    }
-}
-exports.RedisDriver = RedisDriver;