@adonisjs/session 6.4.0 → 7.0.0-1

package/build/src/types.d.ts

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

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

package/build/{templates/session.txt → stubs/config.stub}

@@ -1,15 +1,12 @@
-/**
- * Config source: https://git.io/JeYHp
- *
- * Feel free to let us know via PR, if you find something broken in this config
- * file.
- */
+---
+to: {{ app.configPath('session.ts') }}
+---
 
-import Env from '@ioc:Adonis/Core/Env'
-import Application from '@ioc:Adonis/Core/Application'
-import { sessionConfig } from '@adonisjs/session/build/config'
+import env from '#start/env'
+import app from '@adonisjs/core/services/app'
+import { defineConfig } from '@adonisjs/session'
 
-export default sessionConfig({
+export default defineConfig({
   /*
   |--------------------------------------------------------------------------
   | Enable/Disable sessions
@@ -36,7 +33,7 @@ export default sessionConfig({
   | Note: Switching drivers will make existing sessions invalid.
   |
   */
-  driver: Env.get('SESSION_DRIVER'),
+  driver: env.get('SESSION_DRIVER'),
 
   /*
   |--------------------------------------------------------------------------
@@ -54,7 +51,7 @@ export default sessionConfig({
   |--------------------------------------------------------------------------
   |
   | Whether or not you want to destroy the session when browser closes. Setting
-  | this value to `true` will ignore the `age`.
+  | this value to "true" will ignore the "age".
   |
   */
   clearWithBrowser: false,
@@ -70,7 +67,7 @@ export default sessionConfig({
   | The value can be a number in milliseconds or a string that must be valid
   | as per https://npmjs.org/package/ms package.
   |
-  | Example: `2 days`, `2.5 hrs`, `1y`, `5s` and so on.
+  | Example: "2 days", "2.5 hrs", "1y", "5s" and so on.
   |
   */
   age: '2h',
@@ -100,7 +97,7 @@ export default sessionConfig({
   |
   */
   file: {
-    location: Application.tmpPath('sessions'),
+    location: app.tmpPath('sessions'),
   },
 
   /*
@@ -109,7 +106,7 @@ export default sessionConfig({
   |--------------------------------------------------------------------------
   |
   | The redis connection you want session driver to use. The same connection
-  | must be defined inside `config/redis.ts` file as well.
+  | must be defined inside "config/redis.ts" file as well.
   |
   */
   redisConnection: 'local',

package/build/stubs/main.d.ts

@@ -0,0 +1 @@
+export declare const stubsRoot: string;

package/build/{adonis-typings/tests.js → stubs/main.js}

@@ -1,4 +1,3 @@
-"use strict";
 /*
  * @adonisjs/session
  *
@@ -7,5 +6,5 @@
  * 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 });
-require("@japa/api-client");
+import { getDirname } from '@poppinss/utils';
+export const stubsRoot = getDirname(import.meta.url);

package/package.json

@@ -1,167 +1,129 @@
 {
   "name": "@adonisjs/session",
-  "version": "6.4.0",
   "description": "Session provider for AdonisJS",
-  "typings": "./build/adonis-typings/index.d.ts",
-  "main": "build/providers/SessionProvider.js",
+  "version": "7.0.0-1",
+  "engines": {
+    "node": ">=18.16.0"
+  },
+  "main": "build/index.js",
+  "type": "module",
   "files": [
-    "build/adonis-typings",
-    "build/providers",
     "build/src",
-    "build/config.js",
-    "build/config.d.ts",
-    "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.8.0"
-  },
-  "devDependencies": {
-    "@adonisjs/core": "^5.8.2",
-    "@adonisjs/mrm-preset": "^5.0.3",
-    "@adonisjs/redis": "^7.3.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-10",
+    "@adonisjs/eslint-config": "^1.1.8",
+    "@adonisjs/prettier-config": "^1.1.8",
+    "@adonisjs/redis": "8.0.0-3",
+    "@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-10",
+    "@adonisjs/redis": "8.0.0-3"
+  },
+  "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" />