@adonisjs/session 6.3.0 → 7.0.0-0

package/package.json

@@ -1,165 +1,129 @@
 {
   "name": "@adonisjs/session",
-  "version": "6.3.0",
   "description": "Session provider for AdonisJS",
-  "typings": "./build/adonis-typings/index.d.ts",
-  "main": "build/providers/SessionProvider.js",
+  "version": "7.0.0-0",
+  "engines": {
+    "node": ">=18.16.0"
+  },
+  "main": "build/index.js",
+  "type": "module",
   "files": [
-    "build/adonis-typings",
-    "build/providers",
     "build/src",
-    "build/templates",
-    "build/instructions.md"
+    "build/stubs",
+    "build/providers",
+    "build/index.d.ts",
+    "build/index.js",
+    "build/configure.d.ts",
+    "build/configure.js"
   ],
-  "dependencies": {
-    "@poppinss/utils": "^4.0.4",
-    "fs-extra": "^10.1.0"
-  },
-  "peerDependencies": {
-    "@adonisjs/core": "^5.5.0"
-  },
-  "devDependencies": {
-    "@adonisjs/core": "^5.8.2",
-    "@adonisjs/mrm-preset": "^5.0.3",
-    "@adonisjs/redis": "^7.2.0",
-    "@adonisjs/require-ts": "^2.0.11",
-    "@japa/assert": "^1.3.4",
-    "@japa/preset-adonis": "^1.0.15",
-    "@japa/run-failed-tests": "^1.0.7",
-    "@japa/runner": "^2.0.8",
-    "@japa/spec-reporter": "^1.1.12",
-    "@poppinss/dev-utils": "^2.0.3",
-    "@types/node": "^17.0.34",
-    "@types/supertest": "^2.0.12",
-    "commitizen": "^4.2.4",
-    "copyfiles": "^2.4.1",
-    "cz-conventional-changelog": "^3.3.0",
-    "del-cli": "^4.0.1",
-    "eslint": "^8.15.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-adonis": "^2.1.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "github-label-sync": "^2.2.0",
-    "husky": "^8.0.1",
-    "mrm": "^4.0.0",
-    "np": "^7.6.1",
-    "prettier": "^2.6.2",
-    "set-cookie-parser": "^2.4.8",
-    "supertest": "^6.2.3",
-    "typescript": "^4.6.4"
+  "exports": {
+    ".": "./build/index.js",
+    "./session_provider": "./build/providers/session_provider.js",
+    "./session_middleware": "./build/src/session_middleware.js",
+    "./types": "./build/src/types.js"
   },
   "scripts": {
-    "mrm": "mrm --preset=@adonisjs/mrm-preset",
     "pretest": "npm run lint",
-    "test": "node -r @adonisjs/require-ts/build/register ./bin/test.ts",
-    "clean": "del build",
+    "test": "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",
-    "copyfiles": "copyfiles \"templates/**/*.txt\" \"instructions.md\" build",
-    "build": "npm run compile && npm run copyfiles",
-    "commit": "git-cz",
-    "release": "np --message=\"chore(release): %s\"",
-    "version": "npm run build",
+    "build": "npm run compile && npm run copy:templates",
     "prepublishOnly": "npm run build",
     "lint": "eslint . --ext=.ts",
     "format": "prettier --write .",
-    "sync-labels": "github-label-sync --labels ./node_modules/@adonisjs/mrm-preset/gh-labels.json adonisjs/session"
+    "release": "np",
+    "version": "npm run build",
+    "sync-labels": "github-label-sync --labels .github/labels.json adonisjs/ally",
+    "quick:test": "node --enable-source-maps --loader=ts-node/esm bin/test.ts"
+  },
+  "devDependencies": {
+    "@adonisjs/application": "7.1.2-8",
+    "@adonisjs/core": "6.1.5-8",
+    "@adonisjs/eslint-config": "^1.1.8",
+    "@adonisjs/prettier-config": "^1.1.8",
+    "@adonisjs/redis": "8.0.0-1",
+    "@adonisjs/tsconfig": "^1.1.8",
+    "@adonisjs/view": "7.0.0-4",
+    "@japa/api-client": "2.0.0-0",
+    "@japa/assert": "2.0.0-1",
+    "@japa/file-system": "2.0.0-1",
+    "@japa/plugin-adonisjs": "2.0.0-1",
+    "@japa/runner": "3.0.0-6",
+    "@poppinss/dev-utils": "^2.0.3",
+    "@swc/core": "^1.3.70",
+    "@types/fs-extra": "^11.0.1",
+    "@types/node": "^20.4.2",
+    "@types/set-cookie-parser": "^2.4.3",
+    "@types/supertest": "^2.0.12",
+    "c8": "^8.0.0",
+    "copyfiles": "^2.4.1",
+    "del-cli": "^5.0.0",
+    "eslint": "^8.45.0",
+    "github-label-sync": "^2.3.1",
+    "husky": "^8.0.3",
+    "np": "^8.0.4",
+    "prettier": "^3.0.0",
+    "set-cookie-parser": "^2.6.0",
+    "supertest": "^6.3.3",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.1.6"
+  },
+  "dependencies": {
+    "@poppinss/utils": "6.5.0-3",
+    "fs-extra": "^11.1.1"
+  },
+  "peerDependencies": {
+    "@adonisjs/core": "6.1.5-8",
+    "@adonisjs/redis": "8.0.0-1"
+  },
+  "peerDependenciesMeta": {
+    "@adonisjs/redis": {
+      "optional": true
+    }
   },
+  "author": "virk,adonisjs",
+  "license": "MIT",
+  "homepage": "https://github.com/adonisjs/adonis-session#readme",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/adonisjs/adonis-session.git"
   },
+  "bugs": {
+    "url": "https://github.com/adonisjs/adonis-session/issues"
+  },
   "keywords": [
     "session",
     "adonisjs"
   ],
-  "author": "virk,adonisjs",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/adonisjs/adonis-session/issues"
+  "eslintConfig": {
+    "extends": "@adonisjs/eslint-config/package"
   },
-  "homepage": "https://github.com/adonisjs/adonis-session#readme",
-  "nyc": {
-    "exclude": [
-      "test"
-    ],
-    "extension": [
-      ".ts"
+  "prettier": "@adonisjs/prettier-config",
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
     ]
   },
-  "husky": {
-    "hooks": {
-      "commit-msg": "node ./node_modules/@adonisjs/mrm-preset/validateCommit/conventional/validate.js"
-    }
-  },
-  "config": {
-    "commitizen": {
-      "path": "cz-conventional-changelog"
-    }
-  },
   "publishConfig": {
-    "tag": "latest",
-    "access": "public"
-  },
-  "adonisjs": {
-    "instructionsMd": "./build/instructions.md",
-    "templates": {
-      "config": [
-        "session.txt"
-      ]
-    },
-    "env": {
-      "SESSION_DRIVER": "cookie"
-    },
-    "types": "@adonisjs/session",
-    "providers": [
-      "@adonisjs/session"
-    ]
+    "access": "public",
+    "tag": "next"
   },
   "np": {
-    "contents": ".",
+    "message": "chore(release): %s",
+    "tag": "next",
+    "branch": "main",
     "anyBranch": false
   },
-  "mrmConfig": {
-    "core": true,
-    "license": "MIT",
-    "services": [
-      "github-actions"
-    ],
-    "minNodeVersion": "14.15.4",
-    "probotApps": [
-      "stale",
-      "lock"
-    ],
-    "runGhActionsOnWindows": false
-  },
-  "eslintConfig": {
-    "extends": [
-      "plugin:adonis/typescriptPackage",
-      "prettier"
-    ],
-    "plugins": [
-      "prettier"
+  "c8": {
+    "reporter": [
+      "text",
+      "html"
     ],
-    "rules": {
-      "prettier/prettier": [
-        "error",
-        {
-          "endOfLine": "auto"
-        }
-      ]
-    }
-  },
-  "eslintIgnore": [
-    "build"
-  ],
-  "prettier": {
-    "trailingComma": "es5",
-    "semi": false,
-    "singleQuote": true,
-    "useTabs": false,
-    "quoteProps": "consistent",
-    "bracketSpacing": true,
-    "arrowParens": "always",
-    "printWidth": 100
+    "exclude": [
+      "tests/**",
+      "stubs/**"
+    ]
   }
 }

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

@@ -1,14 +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.
- */
-declare module '@ioc:Adonis/Core/Application' {
-    import { SessionManagerContract } from '@ioc:Adonis/Addons/Session';
-    interface ContainerBindings {
-        'Adonis/Addons/Session': SessionManagerContract;
-    }
-}

package/build/adonis-typings/container.js

@@ -1,8 +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.
- */

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

@@ -1,14 +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.
- */
-declare module '@ioc:Adonis/Core/HttpContext' {
-    import { SessionContract } from '@ioc:Adonis/Addons/Session';
-    interface HttpContextContract {
-        session: SessionContract;
-    }
-}

package/build/adonis-typings/context.js

@@ -1,8 +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.
- */

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

@@ -1,4 +0,0 @@
-/// <reference path="session.d.ts" />
-/// <reference path="context.d.ts" />
-/// <reference path="container.d.ts" />
-/// <reference path="tests.d.ts" />

package/build/adonis-typings/index.js

@@ -1,12 +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 path="./session.ts" />
-/// <reference path="./context.ts" />
-/// <reference path="./container.ts" />
-/// <reference path="./tests.ts" />

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