Merge pull request #29 from escendit/28-expose-store-hasher-and-generator-in-middleware-pipeline

Expose store, hasher, and generator in middleware pipeline

Author: snovak7

README.md

@@ -53,24 +53,49 @@ Access the session in your endpoints or load functions via `event.locals`:
 
 ```ts
 // src/routes/+page.server.ts
-import type { Actions, PageServerLoad } from './$types';
+import type { PageServerLoad } from './$types';
 
 export const load: PageServerLoad = async ({ locals }) => {
-  // locals.sessionId: string
-  // locals.session: { identity: unknown | null; created: string | null }
+  // Available on locals:
+  // - locals.store: ISessionStore
+  // - locals.hasher: ISessionHasher
+  // - locals.generator: ISessionGenerator
+  // - locals.sessionId: string (present once a session exists)
+  // - locals.session: { identity: unknown | null; created: string | null }
   return {
     sessionId: locals.sessionId,
     session: locals.session
   };
 };
 ```
 
+Locals interface (for reference):
+
+```ts
+// src/app.d.ts
+import type { ISessionGenerator, ISessionHasher, ISessionStore } from '@escendit/sveltekit-session';
+
+declare global {
+  namespace App {
+    interface Locals {
+      store: ISessionStore;
+      hasher: ISessionHasher;
+      generator: ISessionGenerator;
+      sessionId: string;
+      session: any;
+    }
+  }
+}
+export {};
+```
+
 ## How it works
 
 - On each request the middleware checks for the configured session cookie.
 - If a valid session exists in the store, it populates:
   - `event.locals.sessionId`
   - `event.locals.session = { identity: any | null, created: string | null }`
+  - Always available: `event.locals.store`, `event.locals.hasher`, `event.locals.generator` (from middleware config)
 - If there is no valid session yet:
   - It generates a new random ID, stores minimal fields (`identity=null`, `created=timestamp`) and sets an expiry on the store entry.
   - It sets a secure cookie and `Cache-Control: no-store` header.

src/app.d.ts

@@ -1,9 +1,14 @@
 // See https://svelte.dev/docs/kit/types#app.d.ts
 // for information about these interfaces
+import type { ISessionGenerator, ISessionHasher, ISessionStore } from '$lib';
+
 declare global {
 	namespace App {
 		// interface Error {}
 		interface Locals {
+			store: ISessionStore;
+			hasher: ISessionHasher;
+			generator: ISessionGenerator;
 			sessionId: string;
 			session: any;
 		}

src/lib/session.ts

@@ -4,6 +4,7 @@ import { Defaults } from '$lib/config.js';
 import type { ISessionStore } from '$lib/ISessionStore.js';
 import type { ISessionHasher } from '$lib/ISessionHasher.js';
 import type { ISessionGenerator } from '$lib/ISessionGenerator.js';
+import { sequence } from '@sveltejs/kit/hooks';
 
 /**
  * Session middleware.
@@ -26,9 +27,21 @@ const SessionMiddleware = (sessionConfig?: SessionConfig) => {
 	const handleSessionMiddleware: Handle = async (request) => {
 		return handleSessionMiddlewareInternal(request, configuredSessionConfig);
 	};
-	return handleSessionMiddleware;
+
+	const prepareSessionMiddleware: Handle = async (request) => {
+		return handlePrepareSessionMiddleware(request, configuredSessionConfig);
+	}
+	return sequence(prepareSessionMiddleware, handleSessionMiddleware);
 };
 
+const handlePrepareSessionMiddleware: InternalMiddlewareHandle = async (
+	{ event, resolve },
+	options) => {
+	event.locals.store = options.sessionStore;
+	event.locals.hasher = options.sessionHasher;
+	event.locals.generator = options.sessionGenerator;
+	return resolve(event);
+};
 /**
  * Handle session middleware.
  * @param event
@@ -39,9 +52,9 @@ const handleSessionMiddlewareInternal: InternalMiddlewareHandle = async (
 	{ event, resolve },
 	options
 ) => {
-	const store: ISessionStore = options.sessionStore;
-	const hasher: ISessionHasher = options.sessionHasher;
-	const generator: ISessionGenerator = options.sessionGenerator;
+	const store: ISessionStore = event.locals.store;
+	const hasher: ISessionHasher = event.locals.hasher;
+	const generator: ISessionGenerator = event.locals.generator;
 
 	// Skip favicon requests
 	if (event.url.pathname === '/favicon.ico') {