@adonisjs/session 7.0.0-6 → 7.0.0-7

package/build/providers/session_provider.d.ts

@@ -1,3 +1,4 @@
+import type { Edge } from 'edge.js';
 import type { ApplicationService } from '@adonisjs/core/types';
 /**
  * Session provider configures the session management inside an
@@ -6,6 +7,18 @@ import type { ApplicationService } from '@adonisjs/core/types';
 export default class SessionProvider {
     protected app: ApplicationService;
     constructor(app: ApplicationService);
+    /**
+     * Returns edge when it's installed
+     */
+    protected getEdge(): Promise<Edge | null>;
+    /**
+     * Registering muddleware
+     */
     register(): void;
+    /**
+     * Registering the active driver when middleware is used
+     * +
+     * Adding edge tags (if edge is installed)
+     */
     boot(): Promise<void>;
 }

package/build/providers/session_provider.js

@@ -6,6 +6,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+import debug from '../src/debug.js';
 import { registerSessionDriver } from '../src/helpers.js';
 import SessionMiddleware from '../src/session_middleware.js';
 /**
@@ -17,6 +18,22 @@ export default class SessionProvider {
     constructor(app) {
         this.app = app;
     }
+    /**
+     * Returns edge when it's installed
+     */
+    async getEdge() {
+        try {
+            const { default: edge } = await import('edge.js');
+            debug('Detected edge.js package. Adding session primitives to it');
+            return edge;
+        }
+        catch {
+            return null;
+        }
+    }
+    /**
+     * Registering muddleware
+     */
     register() {
         this.app.container.singleton(SessionMiddleware, async (resolver) => {
             const config = this.app.config.get('session', {});
@@ -24,10 +41,20 @@ export default class SessionProvider {
             return new SessionMiddleware(config, emitter);
         });
     }
+    /**
+     * Registering the active driver when middleware is used
+     * +
+     * Adding edge tags (if edge is installed)
+     */
     async boot() {
         this.app.container.resolving(SessionMiddleware, async () => {
             const config = this.app.config.get('session');
             await registerSessionDriver(this.app, config.driver);
         });
+        const edge = await this.getEdge();
+        if (edge) {
+            const { edgePluginAdonisJSSession } = await import('../src/edge_plugin_adonisjs_session.js');
+            edge.use(edgePluginAdonisJSSession);
+        }
     }
 }

package/build/src/edge_plugin_adonisjs_session.d.ts

@@ -0,0 +1,6 @@
+import type { PluginFn } from 'edge.js/types';
+/**
+ * The edge plugin for AdonisJS Session adds tags to read
+ * flash messages
+ */
+export declare const edgePluginAdonisJSSession: PluginFn<undefined>;

package/build/src/edge_plugin_adonisjs_session.js

@@ -0,0 +1,92 @@
+/*
+ * @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';
+/**
+ * The edge plugin for AdonisJS Session adds tags to read
+ * flash messages
+ */
+export const edgePluginAdonisJSSession = (edge) => {
+    debug('registering session tags with edge');
+    edge.registerTag({
+        tagName: 'flashMessage',
+        seekable: true,
+        block: true,
+        compile(parser, buffer, token) {
+            const expression = parser.utils.transformAst(parser.utils.generateAST(token.properties.jsArg, token.loc, token.filename), token.filename, parser);
+            const key = parser.utils.stringify(expression);
+            /**
+             * Write an if statement
+             */
+            buffer.writeStatement(`if (state.flashMessages.has(${key})) {`, token.filename, token.loc.start.line);
+            /**
+             * Define a local variable
+             */
+            buffer.writeExpression(`let message = state.flashMessages.get(${key})`, token.filename, token.loc.start.line);
+            /**
+             * Create a local variables scope and tell the parser about
+             * the existence of the "message" variable
+             */
+            parser.stack.defineScope();
+            parser.stack.defineVariable('message');
+            /**
+             * Process component children using the parser
+             */
+            token.children.forEach((child) => {
+                parser.processToken(child, buffer);
+            });
+            /**
+             * Clear the scope of the local variables before we
+             * close the if statement
+             */
+            parser.stack.clearScope();
+            /**
+             * Close if statement
+             */
+            buffer.writeStatement(`}`, token.filename, token.loc.start.line);
+        },
+    });
+    edge.registerTag({
+        tagName: 'error',
+        seekable: true,
+        block: true,
+        compile(parser, buffer, token) {
+            const expression = parser.utils.transformAst(parser.utils.generateAST(token.properties.jsArg, token.loc, token.filename), token.filename, parser);
+            const key = parser.utils.stringify(expression);
+            /**
+             * Write an if statement
+             */
+            buffer.writeStatement(`if (!!state.flashMessages.get('errors')[${key}]) {`, token.filename, token.loc.start.line);
+            /**
+             * Define a local variable
+             */
+            buffer.writeExpression(`let messages = state.flashMessages.get('errors')[${key}]`, token.filename, token.loc.start.line);
+            /**
+             * Create a local variables scope and tell the parser about
+             * the existence of the "messages" variable
+             */
+            parser.stack.defineScope();
+            parser.stack.defineVariable('messages');
+            /**
+             * Process component children using the parser
+             */
+            token.children.forEach((child) => {
+                parser.processToken(child, buffer);
+            });
+            /**
+             * Clear the scope of the local variables before we
+             * close the if statement
+             */
+            parser.stack.clearScope();
+            /**
+             * Close if statement
+             */
+            buffer.writeStatement(`}`, token.filename, token.loc.start.line);
+        },
+    });
+};

package/build/src/session.js

@@ -8,7 +8,7 @@
  */
 import lodash from '@poppinss/utils/lodash';
 import { cuid } from '@adonisjs/core/helpers';
-import { Store } from './store.js';
+import { ReadOnlyStore, Store } from './store.js';
 import * as errors from './errors.js';
 import debug from './debug.js';
 /**
@@ -157,6 +157,19 @@ export class Session {
                 this.flashMessages.update(this.pull(this.flashKey, null));
             }
         }
+        /**
+         * Share session with the templates. We assume the view property
+         * is a reference to edge templates
+         */
+        if ('view' in this.#ctx) {
+            this.#ctx.view.share({
+                session: new ReadOnlyStore(this.#store.all()),
+                flashMessages: new ReadOnlyStore(this.flashMessages.all()),
+                old: function (key, defaultValue) {
+                    return this.flashMessages.get(key, defaultValue);
+                },
+            });
+        }
         this.#emitter.emit('session:initiated', { session: this });
     }
     /**

package/build/src/store.d.ts

@@ -1,15 +1,50 @@
 import type { AllowedSessionValues, SessionData } from './types/main.js';
 /**
- * Session store encapsulates the session data and offers a
- * declarative API to mutate it.
+ * Readonly session store
  */
-export declare class Store {
-    #private;
-    constructor(values: SessionData | null);
+export declare class ReadOnlyStore {
+    /**
+     * Underlying store values
+     */
+    protected values: SessionData;
     /**
      * Find if store is empty or not
      */
     get isEmpty(): boolean;
+    constructor(values: SessionData | null);
+    /**
+     * Get value for a given key
+     */
+    get(key: string, defaultValue?: any): any;
+    /**
+     * A boolean to know if value exists. Extra guards to check
+     * arrays for it's length as well.
+     */
+    has(key: string, checkForArraysLength?: boolean): boolean;
+    /**
+     * Get all values
+     */
+    all(): any;
+    /**
+     * Returns object representation of values
+     */
+    toObject(): any;
+    /**
+     * Returns the store values
+     */
+    toJSON(): any;
+    /**
+     * Returns string representation of the store
+     */
+    toString(): string;
+}
+/**
+ * Session store encapsulates the session data and offers a
+ * declarative API to mutate it.
+ */
+export declare class Store extends ReadOnlyStore {
+    #private;
+    constructor(values: SessionData | null);
     /**
      * Find if the store has been modified.
      */
@@ -53,29 +88,4 @@ export declare class Store {
      * Reset store by clearing it's values.
      */
     clear(): void;
-    /**
-     * Get value for a given key
-     */
-    get(key: string, defaultValue?: any): any;
-    /**
-     * A boolean to know if value exists. Extra guards to check
-     * arrays for it's length as well.
-     */
-    has(key: string, checkForArraysLength?: boolean): boolean;
-    /**
-     * Get all values
-     */
-    all(): any;
-    /**
-     * Returns object representation of values
-     */
-    toObject(): any;
-    /**
-     * Returns the store values
-     */
-    toJSON(): any;
-    /**
-     * Returns string representation of the store
-     */
-    toString(): string;
 }

package/build/src/store.js

@@ -9,27 +9,76 @@
 import lodash from '@poppinss/utils/lodash';
 import { RuntimeException } from '@poppinss/utils';
 /**
- * Session store encapsulates the session data and offers a
- * declarative API to mutate it.
+ * Readonly session store
  */
-export class Store {
+export class ReadOnlyStore {
     /**
      * Underlying store values
      */
-    #values;
+    values;
     /**
-     * A boolean to know if store has been
-     * modified
+     * Find if store is empty or not
      */
-    #modified = false;
+    get isEmpty() {
+        return !this.values || Object.keys(this.values).length === 0;
+    }
     constructor(values) {
-        this.#values = values || {};
+        this.values = values || {};
     }
     /**
-     * Find if store is empty or not
+     * Get value for a given key
      */
-    get isEmpty() {
-        return !this.#values || Object.keys(this.#values).length === 0;
+    get(key, defaultValue) {
+        return lodash.get(this.values, key, defaultValue);
+    }
+    /**
+     * A boolean to know if value exists. Extra guards to check
+     * arrays for it's length as well.
+     */
+    has(key, checkForArraysLength = true) {
+        const value = this.get(key);
+        if (!Array.isArray(value)) {
+            return !!value;
+        }
+        return checkForArraysLength ? value.length > 0 : !!value;
+    }
+    /**
+     * Get all values
+     */
+    all() {
+        return this.values;
+    }
+    /**
+     * Returns object representation of values
+     */
+    toObject() {
+        return this.all();
+    }
+    /**
+     * Returns the store values
+     */
+    toJSON() {
+        return this.all();
+    }
+    /**
+     * Returns string representation of the store
+     */
+    toString() {
+        return JSON.stringify(this.all());
+    }
+}
+/**
+ * Session store encapsulates the session data and offers a
+ * declarative API to mutate it.
+ */
+export class Store extends ReadOnlyStore {
+    /**
+     * A boolean to know if store has been
+     * modified
+     */
+    #modified = false;
+    constructor(values) {
+        super(values);
     }
     /**
      * Find if the store has been modified.
@@ -42,14 +91,14 @@ export class Store {
      */
     set(key, value) {
         this.#modified = true;
-        lodash.set(this.#values, key, value);
+        lodash.set(this.values, key, value);
     }
     /**
      * Remove key
      */
     unset(key) {
         this.#modified = true;
-        lodash.unset(this.#values, key);
+        lodash.unset(this.values, key);
     }
     /**
      * Pull value from the store. It is same as calling
@@ -88,14 +137,14 @@ export class Store {
      */
     update(values) {
         this.#modified = true;
-        this.#values = values;
+        this.values = values;
     }
     /**
      * Update to merge values
      */
     merge(values) {
         this.#modified = true;
-        lodash.merge(this.#values, values);
+        lodash.merge(this.values, values);
     }
     /**
      * Reset store by clearing it's values.
@@ -103,45 +152,4 @@ export class Store {
     clear() {
         this.update({});
     }
-    /**
-     * Get value for a given key
-     */
-    get(key, defaultValue) {
-        return lodash.get(this.#values, key, defaultValue);
-    }
-    /**
-     * A boolean to know if value exists. Extra guards to check
-     * arrays for it's length as well.
-     */
-    has(key, checkForArraysLength = true) {
-        const value = this.get(key);
-        if (!Array.isArray(value)) {
-            return !!value;
-        }
-        return checkForArraysLength ? value.length > 0 : !!value;
-    }
-    /**
-     * Get all values
-     */
-    all() {
-        return this.#values;
-    }
-    /**
-     * Returns object representation of values
-     */
-    toObject() {
-        return this.all();
-    }
-    /**
-     * Returns the store values
-     */
-    toJSON() {
-        return this.all();
-    }
-    /**
-     * Returns string representation of the store
-     */
-    toString() {
-        return JSON.stringify(this.all());
-    }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@adonisjs/session",
   "description": "Session provider for AdonisJS",
-  "version": "7.0.0-6",
+  "version": "7.0.0-7",
   "engines": {
     "node": ">=18.16.0"
   },
@@ -41,7 +41,7 @@
   },
   "devDependencies": {
     "@adonisjs/assembler": "^6.1.3-18",
-    "@adonisjs/core": "^6.1.5-19",
+    "@adonisjs/core": "^6.1.5-22",
     "@adonisjs/eslint-config": "^1.1.8",
     "@adonisjs/prettier-config": "^1.1.8",
     "@adonisjs/redis": "^8.0.0-10",
@@ -60,6 +60,7 @@
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
     "del-cli": "^5.0.0",
+    "edge.js": "^6.0.0-8",
     "eslint": "^8.47.0",
     "github-label-sync": "^2.3.1",
     "husky": "^8.0.3",
@@ -74,14 +75,15 @@
     "@poppinss/utils": "^6.5.0-5"
   },
   "peerDependencies": {
-    "@adonisjs/core": "^6.1.5-19",
-    "@adonisjs/redis": "^8.0.0-10"
+    "@adonisjs/core": "^6.1.5-22",
+    "@adonisjs/redis": "^8.0.0-10",
+    "edge.js": "^6.0.0-8"
   },
   "peerDependenciesMeta": {
     "@adonisjs/redis": {
       "optional": true
     },
-    "@japa/api-client": {
+    "edge.js": {
       "optional": true
     }
   },