@adonisjs/session 7.0.0-9 → 7.1.0

package/package.json

@@ -1,26 +1,26 @@
 {
   "name": "@adonisjs/session",
   "description": "Session provider for AdonisJS",
-  "version": "7.0.0-9",
+  "version": "7.1.0",
   "engines": {
     "node": ">=18.16.0"
   },
   "main": "build/index.js",
   "type": "module",
   "files": [
-    "build/src",
-    "build/stubs",
-    "build/providers",
-    "build/configure.d.ts",
-    "build/configure.js",
-    "build/index.d.ts",
-    "build/index.js"
+    "build",
+    "!build/bin",
+    "!build/tests",
+    "!build/tests_helpers"
   ],
   "exports": {
     ".": "./build/index.js",
     "./factories": "./build/factories/main.js",
     "./session_provider": "./build/providers/session_provider.js",
     "./session_middleware": "./build/src/session_middleware.js",
+    "./plugins/edge": "./build/src/plugins/edge.js",
+    "./plugins/api_client": "./build/src/plugins/japa/api_client.js",
+    "./plugins/browser_client": "./build/src/plugins/japa/browser_client.js",
     "./client": "./build/src/client.js",
     "./types": "./build/src/types.js"
   },
@@ -29,9 +29,11 @@
     "test": "cross-env NODE_DEBUG=adonisjs:session c8 npm run quick:test",
     "clean": "del-cli build",
     "typecheck": "tsc --noEmit",
-    "copy:templates": "copyfiles \"stubs/**/*.stub\" build",
-    "compile": "npm run lint && npm run clean && tsc",
-    "build": "npm run compile && npm run copy:templates",
+    "copy:templates": "copyfiles \"stubs/**/*.stub\" --up=\"1\" build",
+    "precompile": "npm run lint && npm run clean",
+    "compile": "tsup-node && tsc --emitDeclarationOnly --declaration",
+    "postcompile": "npm run copy:templates",
+    "build": "npm run compile",
     "prepublishOnly": "npm run build",
     "lint": "eslint . --ext=.ts",
     "format": "prettier --write .",
@@ -41,47 +43,51 @@
     "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/eslint-config": "^1.1.8",
-    "@adonisjs/prettier-config": "^1.1.8",
-    "@adonisjs/redis": "^8.0.0-10",
-    "@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",
-    "@swc/core": "^1.3.78",
-    "@types/node": "^20.5.1",
-    "@types/set-cookie-parser": "^2.4.3",
-    "@types/supertest": "^2.0.12",
-    "@vinejs/vine": "^1.6.0",
-    "c8": "^8.0.0",
+    "@adonisjs/assembler": "^7.1.0",
+    "@adonisjs/core": "^6.2.1",
+    "@adonisjs/eslint-config": "^1.2.1",
+    "@adonisjs/prettier-config": "^1.2.1",
+    "@adonisjs/redis": "^8.0.0",
+    "@adonisjs/tsconfig": "^1.2.1",
+    "@japa/api-client": "^2.0.2",
+    "@japa/assert": "^2.1.0",
+    "@japa/browser-client": "^2.0.2",
+    "@japa/file-system": "^2.2.0",
+    "@japa/plugin-adonisjs": "^3.0.0",
+    "@japa/runner": "^3.1.1",
+    "@japa/snapshot": "^2.0.4",
+    "@swc/core": "^1.3.105",
+    "@types/node": "^20.11.5",
+    "@types/set-cookie-parser": "^2.4.7",
+    "@types/supertest": "^6.0.2",
+    "@vinejs/vine": "^1.7.0",
+    "c8": "^9.1.0",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
     "del-cli": "^5.0.0",
-    "edge.js": "^6.0.0-8",
-    "eslint": "^8.47.0",
+    "edge.js": "^6.0.1",
+    "eslint": "^8.56.0",
+    "get-port": "^7.0.0",
     "github-label-sync": "^2.3.1",
     "husky": "^8.0.3",
-    "np": "^8.0.4",
-    "playwright": "^1.37.1",
-    "prettier": "^3.0.2",
+    "np": "^9.2.0",
+    "playwright": "^1.41.1",
+    "prettier": "^3.2.4",
     "set-cookie-parser": "^2.6.0",
-    "supertest": "^6.3.3",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.1.6"
+    "supertest": "^6.3.4",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.3"
   },
   "dependencies": {
-    "@poppinss/utils": "^6.5.0-5"
+    "@poppinss/utils": "^6.7.1"
   },
   "peerDependencies": {
-    "@adonisjs/core": "^6.1.5-22",
-    "@adonisjs/redis": "^8.0.0-10",
-    "edge.js": "^6.0.0-8"
+    "@adonisjs/core": "^6.2.0",
+    "@adonisjs/redis": "^8.0.0",
+    "@japa/api-client": "^2.0.2",
+    "@japa/browser-client": "^2.0.2",
+    "edge.js": "^6.0.1"
   },
   "peerDependenciesMeta": {
     "@adonisjs/redis": {
@@ -89,6 +95,12 @@
     },
     "edge.js": {
       "optional": true
+    },
+    "@japa/api-client": {
+      "optional": true
+    },
+    "@japa/browser-client": {
+      "optional": true
     }
   },
   "author": "virk,adonisjs",
@@ -116,11 +128,11 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "next"
+    "tag": "latest"
   },
   "np": {
     "message": "chore(release): %s",
-    "tag": "next",
+    "tag": "latest",
     "branch": "main",
     "anyBranch": false
   },
@@ -135,5 +147,24 @@
       "factories/**",
       "bin/**"
     ]
+  },
+  "tsup": {
+    "entry": [
+      "./index.ts",
+      "./factories/main.ts",
+      "./providers/session_provider.ts",
+      "./src/session_middleware.ts",
+      "./src/types.ts",
+      "./src/plugins/edge.ts",
+      "./src/plugins/japa/api_client.ts",
+      "./src/plugins/japa/browser_client.ts",
+      "./src/client.ts"
+    ],
+    "outDir": "./build",
+    "clean": true,
+    "format": "esm",
+    "dts": false,
+    "sourcemap": true,
+    "target": "esnext"
   }
 }

package/build/configure.js

@@ -1,45 +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.
- */
-/**
- * Configures the package
- */
-export async function configure(command) {
-    /**
-     * Publish config file
-     */
-    await command.publishStub('config.stub');
-    const codemods = await command.createCodemods();
-    /**
-     * Define environment variables
-     */
-    await codemods.defineEnvVariables({ SESSION_DRIVER: 'cookie' });
-    /**
-     * Define environment variables validations
-     */
-    await codemods.defineEnvValidations({
-        variables: {
-            SESSION_DRIVER: `Env.schema.enum(['cookie', 'redis', 'file', 'memory'] as const)`,
-        },
-        leadingComment: 'Variables for configuring session package',
-    });
-    /**
-     * Register middleware
-     */
-    await codemods.registerMiddleware('router', [
-        {
-            path: '@adonisjs/session/session_middleware',
-        },
-    ]);
-    /**
-     * Register provider
-     */
-    await codemods.updateRcFile((rcFile) => {
-        rcFile.addProvider('@adonisjs/session/session_provider');
-    });
-}

package/build/src/debug.js

@@ -1,10 +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 { debuglog } from 'node:util';
-export default debuglog('adonisjs:session');

package/build/src/define_config.js

@@ -1,42 +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 { InvalidArgumentsException } from '@poppinss/utils';
-import debug from './debug.js';
-/**
- * Helper to normalize session config
- */
-export function defineConfig(config) {
-    /**
-     * Make sure a driver is defined
-     */
-    if (!config.driver) {
-        throw new InvalidArgumentsException('Missing "driver" property inside the session config');
-    }
-    const age = config.age || '2h';
-    const clearWithBrowser = config.clearWithBrowser ?? false;
-    const cookieOptions = { ...config.cookie };
-    /**
-     * Define maxAge property when session id cookie is
-     * not a session cookie.
-     */
-    if (!clearWithBrowser) {
-        debug('computing maxAge for session id cookie');
-        cookieOptions.maxAge = string.seconds.parse(config.age || age);
-    }
-    return {
-        enabled: true,
-        age,
-        clearWithBrowser,
-        cookieName: 'adonis_session',
-        cookie: cookieOptions,
-        driver: config.driver,
-        ...config,
-    };
-}

package/build/src/drivers/cookie.js

@@ -1,60 +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';
-/**
- * Cookie driver stores the session data inside an encrypted
- * cookie.
- */
-export class CookieDriver {
-    #ctx;
-    #config;
-    constructor(config, ctx) {
-        this.#config = config;
-        this.#ctx = ctx;
-        debug('initiating cookie driver %O', this.#config);
-    }
-    /**
-     * Read session value from the cookie
-     */
-    read(sessionId) {
-        debug('cookie driver: reading session data %s', sessionId);
-        const cookieValue = this.#ctx.request.encryptedCookie(sessionId);
-        if (typeof cookieValue !== 'object') {
-            return null;
-        }
-        return cookieValue;
-    }
-    /**
-     * Write session values to the cookie
-     */
-    write(sessionId, values) {
-        debug('cookie driver: writing session data %s: %O', sessionId, values);
-        this.#ctx.response.encryptedCookie(sessionId, values, this.#config);
-    }
-    /**
-     * Removes the session cookie
-     */
-    destroy(sessionId) {
-        debug('cookie driver: destroying session data %s', sessionId);
-        if (this.#ctx.request.cookiesList()[sessionId]) {
-            this.#ctx.response.clearCookie(sessionId);
-        }
-    }
-    /**
-     * Updates the cookie with existing cookie values
-     */
-    touch(sessionId) {
-        const value = this.read(sessionId);
-        debug('cookie driver: touching session data %s', sessionId);
-        if (!value) {
-            return;
-        }
-        this.write(sessionId, value);
-    }
-}

package/build/src/drivers/file.js

@@ -1,133 +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 { dirname, join } from 'node:path';
-import string from '@poppinss/utils/string';
-import { MessageBuilder } from '@adonisjs/core/helpers';
-import { access, mkdir, readFile, rm, writeFile, utimes, stat } from 'node:fs/promises';
-import debug from '../debug.js';
-/**
- * File driver writes the session data on the file system as. Each session
- * id gets its own file.
- */
-export class FileDriver {
-    #config;
-    #age;
-    constructor(config, age) {
-        this.#config = config;
-        this.#age = age;
-        debug('initiating file driver %O', this.#config);
-    }
-    /**
-     * Returns an absolute path to the session id file
-     */
-    #getFilePath(sessionId) {
-        return join(this.#config.location, `${sessionId}.txt`);
-    }
-    /**
-     * Check if a file exists at a given path or not
-     */
-    async #pathExists(path) {
-        try {
-            await access(path);
-            return true;
-        }
-        catch {
-            return false;
-        }
-    }
-    /**
-     * Returns stats for a file and ignoring missing
-     * files.
-     */
-    async #stats(path) {
-        try {
-            const stats = await stat(path);
-            return stats;
-        }
-        catch {
-            return null;
-        }
-    }
-    /**
-     * Output file with contents to the given path
-     */
-    async #outputFile(path, contents) {
-        const pathDirname = dirname(path);
-        const dirExists = await this.#pathExists(pathDirname);
-        if (!dirExists) {
-            await mkdir(pathDirname, { recursive: true });
-        }
-        await writeFile(path, contents, 'utf-8');
-    }
-    /**
-     * Reads the session data from the disk.
-     */
-    async read(sessionId) {
-        const filePath = this.#getFilePath(sessionId);
-        debug('file driver: reading session data %', sessionId);
-        /**
-         * Return null when no session id file exists in first
-         * place
-         */
-        const stats = await this.#stats(filePath);
-        if (!stats) {
-            return null;
-        }
-        /**
-         * Check if the file has been expired and return null (if expired)
-         */
-        const sessionWillExpireAt = stats.mtimeMs + string.milliseconds.parse(this.#age);
-        if (Date.now() > sessionWillExpireAt) {
-            debug('file driver: expired session data %s', sessionId);
-            return null;
-        }
-        /**
-         * Reading the file contents if the file exists
-         */
-        let contents = await readFile(filePath, 'utf-8');
-        contents = contents.trim();
-        if (!contents) {
-            return null;
-        }
-        /**
-         * Verify contents with the session id and return them as an object. The verify
-         * method can fail when the contents is not JSON>
-         */
-        try {
-            return new MessageBuilder().verify(contents, sessionId);
-        }
-        catch {
-            return null;
-        }
-    }
-    /**
-     * Writes the session data to the disk as a string
-     */
-    async write(sessionId, values) {
-        debug('file driver: writing session data %s: %O', sessionId, values);
-        const filePath = this.#getFilePath(sessionId);
-        const message = new MessageBuilder().build(values, undefined, sessionId);
-        await this.#outputFile(filePath, message);
-    }
-    /**
-     * Removes the session file from the disk
-     */
-    async destroy(sessionId) {
-        debug('file driver: destroying session data %s', sessionId);
-        await rm(this.#getFilePath(sessionId), { force: true });
-    }
-    /**
-     * Updates the session expiry by rewriting it to the
-     * persistence store
-     */
-    async touch(sessionId) {
-        debug('file driver: touching session data %s', sessionId);
-        await utimes(this.#getFilePath(sessionId), new Date(), new Date());
-    }
-}

package/build/src/drivers/memory.js

@@ -1,33 +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.
- */
-/**
- * Memory driver is meant to be used for writing tests.
- */
-export class MemoryDriver {
-    static sessions = new Map();
-    /**
-     * Read session id value from the memory
-     */
-    read(sessionId) {
-        return MemoryDriver.sessions.get(sessionId) || null;
-    }
-    /**
-     * Save in memory value for a given session id
-     */
-    write(sessionId, values) {
-        MemoryDriver.sessions.set(sessionId, values);
-    }
-    /**
-     * Cleanup for a single session
-     */
-    destroy(sessionId) {
-        MemoryDriver.sessions.delete(sessionId);
-    }
-    touch() { }
-}

package/build/src/drivers/redis.js

@@ -1,70 +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 { MessageBuilder } from '@adonisjs/core/helpers';
-import debug from '../debug.js';
-/**
- * File driver to read/write session to filesystem
- */
-export class RedisDriver {
-    #config;
-    #redis;
-    #ttlSeconds;
-    constructor(redis, config, age) {
-        this.#config = config;
-        this.#redis = redis;
-        this.#ttlSeconds = string.seconds.parse(age);
-        debug('initiating redis driver %O', this.#config);
-    }
-    /**
-     * Returns file contents. A new file will be created if it's
-     * missing.
-     */
-    async read(sessionId) {
-        debug('redis driver: reading session data %s', sessionId);
-        const contents = await this.#redis.connection(this.#config.connection).get(sessionId);
-        if (!contents) {
-            return null;
-        }
-        /**
-         * Verify contents with the session id and return them as an object. The verify
-         * method can fail when the contents is not JSON>
-         */
-        try {
-            return new MessageBuilder().verify(contents, sessionId);
-        }
-        catch {
-            return null;
-        }
-    }
-    /**
-     * Write session values to a file
-     */
-    async write(sessionId, values) {
-        debug('redis driver: writing session data %s, %O', sessionId, values);
-        const message = new MessageBuilder().build(values, undefined, sessionId);
-        await this.#redis
-            .connection(this.#config.connection)
-            .setex(sessionId, this.#ttlSeconds, message);
-    }
-    /**
-     * Cleanup session file by removing it
-     */
-    async destroy(sessionId) {
-        debug('redis driver: destroying session data %s', sessionId);
-        await this.#redis.connection(this.#config.connection).del(sessionId);
-    }
-    /**
-     * Updates the value expiry
-     */
-    async touch(sessionId) {
-        debug('redis driver: touching session data %s', sessionId);
-        await this.#redis.connection(this.#config.connection).expire(sessionId, this.#ttlSeconds);
-    }
-}

package/build/src/drivers_collection.d.ts

@@ -1,22 +0,0 @@
-import type { HttpContext } from '@adonisjs/core/http';
-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, config: Parameters<SessionDriversList[Name]>[0], ctx: HttpContext): 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, config, ctx) {
-        const driverFactory = this.list[name];
-        if (!driverFactory) {
-            throw new RuntimeException(`Unknown session driver "${String(name)}". Make sure the driver is registered`);
-        }
-        return driverFactory(config, ctx);
-    }
-}
-const sessionDriversList = new SessionDriversCollection();
-export default sessionDriversList;