@adonisjs/session 7.0.0-0 → 7.0.0-2

package/README.md

@@ -1,53 +1,36 @@
-<div align="center">
-  <img src="https://res.cloudinary.com/adonisjs/image/upload/q_100/v1558612869/adonis-readme_zscycu.jpg" width="600px">
-</div>
+# @adonisjs/session
 
 <br />
 
-<div align="center">
-  <h3>Sessions</h3>
-  <p>This package adds support for sessions to AdonisJS</p>
-</div>
+[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url] [![snyk-image]][snyk-url]
 
-<br />
+## Introduction
+Add sessions to your AdonisJS application. Cookie, Redis, and File drivers are included out of the box.
 
-<div align="center">
-
-[![gh-workflow-image]][gh-workflow-url] [![typescript-image]][typescript-url] [![npm-image]][npm-url] [![license-image]][license-url] [![synk-image]][synk-url]
-
-</div>
-
-<div align="center">
-  <h3>
-    <a href="https://adonisjs.com">
-      Website
-    </a>
-    <span> | </span>
-    <a href="https://docs.adonisjs.com/guides/session">
-      Guides
-    </a>
-    <span> | </span>
-    <a href="CONTRIBUTING.md">
-      Contributing
-    </a>
-  </h3>
-</div>
-
-<div align="center">
-  <sub>Built with ❤︎ by <a href="https://twitter.com/AmanVirk1">Harminder Virk</a>
-</div>
-
-[gh-workflow-image]: https://img.shields.io/github/workflow/status/adonisjs/session/test?style=for-the-badge
-[gh-workflow-url]: https://github.com/adonisjs/session/actions/workflows/test.yml "Github action"
+## Official Documentation
+The documentation is available on the [AdonisJS website](https://docs.adonisjs.com/guides/sessions)
 
-[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
-[typescript-url]:  "typescript"
+## Contributing
+One of the primary goals of AdonisJS is to have a vibrant community of users and contributors who believes in the principles of the framework.
+
+We encourage you to read the [contribution guide](https://github.com/adonisjs/.github/blob/main/docs/CONTRIBUTING.md) before contributing to the framework.
+
+## Code of Conduct
+In order to ensure that the AdonisJS community is welcoming to all, please review and abide by the [Code of Conduct](https://github.com/adonisjs/.github/blob/main/docs/CODE_OF_CONDUCT.md).
+
+## License
+AdonisJS ally is open-sourced software licensed under the [MIT license](LICENSE.md).
+
+[gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/adonisjs/session/test.yml?style=for-the-badge
+[gh-workflow-url]: https://github.com/adonisjs/session/actions/workflows/test.yml "Github action"
 
 [npm-image]: https://img.shields.io/npm/v/@adonisjs/session/latest.svg?style=for-the-badge&logo=npm
 [npm-url]: https://www.npmjs.com/package/@adonisjs/session/v/latest "npm"
 
-[license-image]: https://img.shields.io/npm/l/@adonisjs/session?color=blueviolet&style=for-the-badge
-[license-url]: LICENSE.md "license"
+[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
+
+[license-url]: LICENSE.md
+[license-image]: https://img.shields.io/github/license/adonisjs/session?style=for-the-badge
 
-[synk-image]: https://img.shields.io/snyk/vulnerabilities/github/adonisjs/session?label=Synk%20Vulnerabilities&style=for-the-badge
-[synk-url]: https://snyk.io/test/github/adonisjs/session?targetFile=package.json "synk"
+[snyk-image]: https://img.shields.io/snyk/vulnerabilities/github/adonisjs/session?label=Snyk%20Vulnerabilities&style=for-the-badge
+[snyk-url]: https://snyk.io/test/github/adonisjs/session?targetFile=package.json "snyk"

package/build/providers/session_provider.d.ts

@@ -1,5 +1,6 @@
-import { ApplicationService } from '@adonisjs/core/types';
+import type { ApplicationService } from '@adonisjs/core/types';
 export default class SessionProvider {
+    #private;
     protected app: ApplicationService;
     constructor(app: ApplicationService);
     /**

package/build/providers/session_provider.js

@@ -7,7 +7,7 @@
  * file that was distributed with this source code.
  */
 import { extendHttpContext } from '../src/bindings/http_context.js';
-import { extendApiClient } from '../src/bindings/api_client.js';
+import SessionMiddleware from '../src/session_middleware.js';
 export default class SessionProvider {
     app;
     constructor(app) {
@@ -24,20 +24,32 @@ export default class SessionProvider {
             const config = this.app.config.get('session', {});
             return new SessionManager(config, encryption, redis);
         });
+        this.app.container.bind(SessionMiddleware, async () => {
+            const session = await this.app.container.make('session');
+            return new SessionMiddleware(session);
+        });
+    }
+    /**
+     * Register Japa API Client bindings
+     */
+    async #registerApiClientBindings(session) {
+        if (this.app.getEnvironment() === 'test') {
+            const { extendApiClient } = await import('../src/bindings/api_client.js');
+            extendApiClient(session);
+        }
     }
     /**
      * Register bindings
      */
     async boot() {
-        const sessionManager = await this.app.container.make('session');
+        const session = await this.app.container.make('session');
         /**
          * Add `session` getter to the HttpContext class
          */
-        extendHttpContext(sessionManager);
+        extendHttpContext(session);
         /**
-         * Add some macros and getter to japa/api-client classes for
-         * easier testing
+         * Extend Japa API Client
          */
-        extendApiClient(sessionManager);
+        await this.#registerApiClientBindings(session);
     }
 }

package/build/src/drivers/file.js

@@ -6,11 +6,10 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-import { join } from 'node:path';
+import { dirname, join } from 'node:path';
+import { access, mkdir, readFile, rm, writeFile } from 'node:fs/promises';
 import { Exception } from '@poppinss/utils';
 import { MessageBuilder } from '@poppinss/utils';
-import { ensureFile, outputFile, remove } from 'fs-extra/esm';
-import { readFile } from 'node:fs/promises';
 /**
  * File driver to read/write session to filesystem
  */
@@ -28,13 +27,47 @@ export class FileDriver {
     #getFilePath(sessionId) {
         return join(this.#config.file.location, `${sessionId}.txt`);
     }
+    /**
+     * Check if the given path exists or not
+     */
+    async #pathExists(path) {
+        try {
+            await access(path);
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+    /**
+     * Output file with contents to the given path
+     */
+    async #outputFile(path, content) {
+        const pathDirname = dirname(path);
+        const dirExists = await this.#pathExists(pathDirname);
+        if (!dirExists) {
+            await mkdir(pathDirname, { recursive: true });
+        }
+        await writeFile(path, content, 'utf-8');
+    }
+    /**
+     * Ensure the file exists. Create it if missing
+     */
+    async #ensureFile(path) {
+        const pathDirname = dirname(path);
+        const dirExists = await this.#pathExists(pathDirname);
+        if (!dirExists) {
+            await mkdir(pathDirname, { recursive: true });
+            await writeFile(path, '', 'utf-8');
+        }
+    }
     /**
      * Returns file contents. A new file will be created if it's
      * missing.
      */
     async read(sessionId) {
         const filePath = this.#getFilePath(sessionId);
-        await ensureFile(filePath);
+        await this.#ensureFile(filePath);
         const contents = await readFile(filePath, 'utf-8');
         if (!contents.trim()) {
             return null;
@@ -56,13 +89,13 @@ export class FileDriver {
             throw new Error('Session file driver expects an object of values');
         }
         const message = new MessageBuilder().build(values, undefined, sessionId);
-        await outputFile(this.#getFilePath(sessionId), message);
+        await this.#outputFile(this.#getFilePath(sessionId), message);
     }
     /**
      * Cleanup session file by removing it
      */
     async destroy(sessionId) {
-        await remove(this.#getFilePath(sessionId));
+        await rm(this.#getFilePath(sessionId), { force: true });
     }
     /**
      * Writes the value by reading it from the store

package/build/src/session.js

@@ -162,11 +162,9 @@ export class Session {
      * (only when view property exists)
      */
     #shareLocalsWithView() {
-        // @ts-ignore may need to expose ./types/extended from adonisjs/view
         if (!this.#ctx['view'] || typeof this.#ctx['view'].share !== 'function') {
             return;
         }
-        // @ts-ignore may need to expose ./types/extended from adonisjs/view
         this.#ctx['view'].share({
             flashMessages: this.flashMessages,
             session: {

package/build/src/session_middleware.d.ts

@@ -1,5 +1,8 @@
 import type { HttpContext } from '@adonisjs/core/http';
 import type { NextFn } from '@adonisjs/core/types/http';
+import { SessionManager } from './session_manager.js';
 export default class SessionMiddleware {
+    protected session: SessionManager;
+    constructor(session: SessionManager);
     handle(ctx: HttpContext, next: NextFn): Promise<void>;
 }

package/build/src/session_middleware.js

@@ -1,7 +1,10 @@
 export default class SessionMiddleware {
+    session;
+    constructor(session) {
+        this.session = session;
+    }
     async handle(ctx, next) {
-        const sessionManager = (await ctx.containerResolver.make('session'));
-        if (!sessionManager.isEnabled()) {
+        if (!this.session.isEnabled()) {
             return;
         }
         /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@adonisjs/session",
   "description": "Session provider for AdonisJS",
-  "version": "7.0.0-0",
+  "version": "7.0.0-2",
   "engines": {
     "node": ">=18.16.0"
   },
@@ -40,10 +40,10 @@
   },
   "devDependencies": {
     "@adonisjs/application": "7.1.2-8",
-    "@adonisjs/core": "6.1.5-8",
+    "@adonisjs/core": "6.1.5-10",
     "@adonisjs/eslint-config": "^1.1.8",
     "@adonisjs/prettier-config": "^1.1.8",
-    "@adonisjs/redis": "8.0.0-1",
+    "@adonisjs/redis": "8.0.0-3",
     "@adonisjs/tsconfig": "^1.1.8",
     "@adonisjs/view": "7.0.0-4",
     "@japa/api-client": "2.0.0-0",
@@ -53,7 +53,6 @@
     "@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",
@@ -71,16 +70,18 @@
     "typescript": "^5.1.6"
   },
   "dependencies": {
-    "@poppinss/utils": "6.5.0-3",
-    "fs-extra": "^11.1.1"
+    "@poppinss/utils": "6.5.0-3"
   },
   "peerDependencies": {
-    "@adonisjs/core": "6.1.5-8",
-    "@adonisjs/redis": "8.0.0-1"
+    "@adonisjs/core": "6.1.5-10",
+    "@adonisjs/redis": "8.0.0-3"
   },
   "peerDependenciesMeta": {
     "@adonisjs/redis": {
       "optional": true
+    },
+    "@japa/api-client": {
+      "optional": true
     }
   },
   "author": "virk,adonisjs",