structured-fw 1.7.2 → 1.7.3

package/README.md

@@ -142,6 +142,13 @@ new Application(config);
     - `beforeAssetAccess` - runs when assets are being accessed, before response is sent. Callback receives `RequestContext` as the first argument
     - `afterAssetAccess` - runs when assets are being accessed, after response is sent. Callback receives `RequestContext` as the first argument
     - `pageNotFound` - runs when a request is received for which there is no registered request handler (route), and the requested URL is not an asset. Callback's result is sent as a response - a good use case is showing a 404 page. Callback receives `RequestContext` as the first argument
+    - `sessionsStart` - runs after session handling is enabled, payload is instance of `Session`
+    - `sessionsStop` - runs after session handling is disabled, payload is instance of `Session`
+    - `sessionCreated` - runs after a new session is created, payload is `SessionEntry`
+    - `sessionExpired` - runs after a session expires, payload is `sessionId`
+    - `sessionValueSet` - runs after a value is set in session, payload is `[sessionId, key, value]`
+    - `sessionValueRemove` - runs after a value is removed from session, payload is `[sessionId, key]`
+    - `sessionClear` - runs after session data is cleared, payload is `string` (sessionId)
     - **Callback to any of the `ApplicationEvents` is expected to be an async function**
 - `importEnv<T extends LooseObject>(smartPrimitives: boolean = true): T` - import ENV variables that start with `StructuredConfig.envPrefix`_ (if envPrefix is omitted from config, all ENV variables are returned). It is a generic method so that you can specify the expected return type. If `smartPrimitives = true` importEnv will convert the ENV values to type it feels is appropriate:
     - numeric values -> `number`

package/build/system/server/Application.d.ts

@@ -9,6 +9,7 @@ import { Request } from './Request.js';
 import { Handlebars } from './Handlebars.js';
 import { Cookies } from './Cookies.js';
 import { RequestContext } from './RequestContext.js';
+import { SessionEntry } from '../Types.js';
 export declare class Application {
     readonly config: StructuredConfig;
     initialized: boolean;
@@ -25,7 +26,7 @@ export declare class Application {
     constructor(config: StructuredConfig);
     init(): Promise<void>;
     private start;
-    on<E extends ApplicationEvents>(evt: E, callback: (payload: E extends 'beforeRequestHandler' | 'afterRequestHandler' | 'beforeAssetAccess' | 'afterAssetAccess' | 'pageNotFound' | 'requestHandleError' ? RequestContext<RequestContextData> : E extends 'documentCreated' ? Document : E extends 'afterComponentsLoaded' ? Components : E extends 'serverStarted' ? Server : undefined) => void): void;
+    on<E extends ApplicationEvents>(evt: E, callback: (payload: E extends 'beforeRequestHandler' | 'afterRequestHandler' | 'beforeAssetAccess' | 'afterAssetAccess' | 'pageNotFound' | 'requestHandleError' ? RequestContext<RequestContextData> : E extends 'documentCreated' ? Document : E extends 'afterComponentsLoaded' ? Components : E extends 'serverStarted' ? Server : E extends 'sessionsStart' ? Session : E extends 'sessionsStop' ? Session : E extends 'sessionCreated' ? SessionEntry : E extends 'sessionExpired' ? string : E extends 'sessionValueSet' ? [string, string, any] : E extends 'sessionValueRemove' ? [string, string] : E extends 'sessionClear' ? string : undefined) => void): void;
     emit(eventName: ApplicationEvents, payload?: any): Promise<Array<any>>;
     importEnv<T extends LooseObject>(smartPrimitives?: boolean): T;
     exportContextFields(...fields: Array<keyof RequestContextData>): void;

package/build/system/server/Application.js

@@ -29,7 +29,6 @@ export class Application {
         this.session = new Session(this);
         this.request = new Request(this);
         this.components = new Components(this);
-        this.session.start();
         if (this.config.autoInit) {
             this.init();
         }
@@ -73,6 +72,7 @@ export class Application {
             return '';
         }, this, true);
         await this.start();
+        this.session.start();
         this.initialized = true;
     }
     start() {

package/build/system/server/Session.d.ts

@@ -10,6 +10,7 @@ export declare class Session {
     constructor(app: Application);
     start(): void;
     stop(): void;
+    load(sessions: Record<string, SessionEntry>): void;
     private sessionInit;
     private generateId;
     private garbageCollect;

package/build/system/server/Session.js

@@ -25,9 +25,14 @@ export class Session {
     }
     start() {
         this.enabled = true;
+        this.application.emit('sessionsStart', this);
     }
     stop() {
         this.enabled = false;
+        this.application.emit('sessionsStop', this);
+    }
+    load(sessions) {
+        this.sessions = sessions;
     }
     sessionInit(ctx) {
         ctx.sessionId = this.generateId();
@@ -38,6 +43,7 @@ export class Session {
             data: {}
         };
         this.sessions[ctx.sessionId] = sessionEntry;
+        this.application.emit('sessionCreated', sessionEntry);
     }
     generateId() {
         return randomString(this.application.config.session.keyLength);
@@ -49,6 +55,7 @@ export class Session {
             const sess = this.sessions[sessionId];
             if (time - sess.lastRequest > sessDurationMilliseconds) {
                 delete this.sessions[sessionId];
+                this.application.emit('sessionExpired', sessionId);
             }
         }
         setTimeout(() => {
@@ -62,6 +69,7 @@ export class Session {
         if (this.sessions[sessionId]) {
             const session = this.sessions[sessionId];
             session.data[key] = value;
+            this.application.emit('sessionValueSet', [sessionId, key, value]);
         }
     }
     getValue(sessionId, key) {
@@ -85,6 +93,7 @@ export class Session {
         }
         if (this.sessions[sessionId] && this.sessions[sessionId].data[key]) {
             delete this.sessions[sessionId].data[key];
+            this.application.emit('sessionValueRemove', [sessionId, key]);
         }
     }
     clear(sessionId) {
@@ -93,6 +102,7 @@ export class Session {
         }
         if (this.sessions[sessionId]) {
             this.sessions[sessionId].data = {};
+            this.application.emit('sessionClear', sessionId);
         }
     }
     extract(sessionId, keys) {

package/build/system/types/application.types.d.ts

@@ -1 +1 @@
-export type ApplicationEvents = 'serverStarted' | 'beforeRequestHandler' | 'afterRequestHandler' | 'requestHandleError' | 'beforeRoutes' | 'afterRoutes' | 'beforeComponentsLoad' | 'afterComponentsLoaded' | 'documentCreated' | 'beforeAssetAccess' | 'afterAssetAccess' | 'pageNotFound';
+export type ApplicationEvents = 'serverStarted' | 'beforeRequestHandler' | 'afterRequestHandler' | 'requestHandleError' | 'beforeRoutes' | 'afterRoutes' | 'beforeComponentsLoad' | 'afterComponentsLoaded' | 'documentCreated' | 'beforeAssetAccess' | 'afterAssetAccess' | 'pageNotFound' | 'sessionsStart' | 'sessionsStop' | 'sessionCreated' | 'sessionExpired' | 'sessionValueSet' | 'sessionValueRemove' | 'sessionClear';

package/package.json

@@ -19,7 +19,7 @@
   "license": "MIT",
   "type": "module",
   "main": "build/index",
-  "version": "1.7.2",
+  "version": "1.7.3",
   "scripts": {
     "develop": "tsc --watch",
     "startDev": "cd build && nodemon --watch '../app/**/*' --watch '../build/**/*' -e js,html,hbs,css index.js",