add sample

Author: Octo8080X

README.md

@@ -26,6 +26,11 @@ import {
 
 ## Quick Start
 
+Sample app notes:
+- `sample/session.ts` uses `MemorySessionStore`
+- `sample/session_cookie.ts` shows the cookie store pattern
+- `sample/session_kv.ts` shows the Deno KV store pattern
+
 ### 1. Create a session middleware
 
 ```ts

deno.json

@@ -5,6 +5,9 @@
   "tasks": {
     "dev": "deno test -E --watch",
     "sample": "deno run -EN --watch sample/main.ts",
+    "sample:memory": "deno run -EN --watch sample/main.ts memory",
+    "sample:cookie": "deno run -EN --watch sample/main.ts cookie",
+    "sample:kv": "deno run -EN --watch sample/main.ts kv",
     "test": "deno test -E",
     "test:doc": "deno test --doc -E"
   },

sample/main.ts

@@ -1,5 +1,7 @@
 import { App, createDefine, staticFiles } from "@fresh/core";
-import { sessionMiddleware } from "./session.ts";
+import { memorySessionMiddleware } from "./session_memory.ts";
+import { cookieSessionMiddleware } from "./session_cookie.ts";
+import { kvSessionMiddleware } from "./session_kv.ts";
 import { registerSessionDemoRoutes } from "./session_demo.tsx";
 import type { SessionState } from "../src/session.ts";
 
@@ -21,8 +23,29 @@ app.all("/.well-known/*", () => {
   });
 });
 
+let storeType = "memory";
+
 // Add session middleware
-app.use(sessionMiddleware);
+switch(Deno.args[0]){
+  case("cookie"): {
+    app.use(cookieSessionMiddleware);
+    storeType = "cookie";
+    break;
+  }
+  case("memory"): {
+    app.use(memorySessionMiddleware);
+    storeType = "memory";
+    break;
+  }
+  case("kv"): {
+    app.use(kvSessionMiddleware);
+    storeType = "kv";
+    break;
+  }
+  default: {
+    app.use(memorySessionMiddleware);
+  }
+}
 
 const exampleLoggerMiddleware = define.middleware((ctx) => {
   console.log(`${ctx.req.method} ${ctx.req.url}`);
@@ -31,7 +54,7 @@ const exampleLoggerMiddleware = define.middleware((ctx) => {
 app.use(exampleLoggerMiddleware);
 
 // Register session demo routes
-registerSessionDemoRoutes(app);
+registerSessionDemoRoutes(app, storeType);
 
 // When no route matches, redirect to top page
 app.use((ctx) => {

sample/session_cookie.ts

@@ -0,0 +1,24 @@
+import { CookieSessionStore, session } from "../../fresh-session/mod.ts";
+import type { State } from "./main.ts";
+
+// CookieSessionStore (session data stored in encrypted cookie; ~4KB limit)
+const cookieSessionStore = new CookieSessionStore();
+
+/**
+ * Session middleware (cookie store)
+ * Stores session data in the cookie itself
+ */
+export const cookieSessionMiddleware = session<State>(
+  cookieSessionStore,
+  "your-secret-key-at-least-32-characters-long", // In production, get from environment variable
+  {
+    cookieName: "session",
+    cookieOptions: {
+      httpOnly: true,
+      secure: false,
+      sameSite: "Lax",
+      path: "/",
+      maxAge: 60 * 60 * 24,
+    },
+  },
+);

sample/session_demo.tsx

@@ -4,7 +4,7 @@ import type { State } from "./main.ts";
 /**
  * Register session demo page routes
  */
-export function registerSessionDemoRoutes(app: App<State>) {
+export function registerSessionDemoRoutes(app: App<State>, storeType: string) {
   // GET / - Display demo page
   app.get("/", (ctx) => {
     // Get visit count from session
@@ -94,6 +94,23 @@ export function registerSessionDemoRoutes(app: App<State>) {
                   {sessionId}
                 </td>
               </tr>
+              <tr>
+                <td
+                  style={{ padding: "0.5rem", borderBottom: "1px solid #ccc" }}
+                >
+                  Store Type:
+                </td>
+                <td
+                  style={{
+                    padding: "0.5rem",
+                    borderBottom: "1px solid #ccc",
+                    fontWeight: "bold",
+                    textTransform: "capitalize",
+                  }}
+                >
+                  {storeType}
+                </td>
+              </tr>
               <tr>
                 <td
                   style={{ padding: "0.5rem", borderBottom: "1px solid #ccc" }}

sample/session_kv.ts

@@ -0,0 +1,24 @@
+import { KvSessionStore, session } from "@octo8080x/fresh-session";
+import type { State } from "./main.ts";
+
+// KvSessionStore (persistent storage via Deno KV)
+const kvSessionStore = new KvSessionStore();
+
+/**
+ * Session middleware (KV store)
+ * Stores session data in Deno KV
+ */
+export const kvSessionMiddleware = session<State>(
+  kvSessionStore,
+  "your-secret-key-at-least-32-characters-long", // In production, get from environment variable
+  {
+    cookieName: "session",
+    cookieOptions: {
+      httpOnly: true,
+      secure: false,
+      sameSite: "Lax",
+      path: "/",
+      maxAge: 60 * 60 * 24,
+    },
+  },
+);

sample/session.ts sample/session_memory.tssample/session.ts renamed to sample/session_memory.ts

@@ -1,15 +1,15 @@
-import { MemorySessionStore, session } from "../../fresh-session/mod.ts";
+import { MemorySessionStore, session } from "@octo8080x/fresh-session";
 import type { State } from "./main.ts";
 
-// Session store instance (persists while server is running)
-const sessionStore = new MemorySessionStore();
+// MemorySessionStore (data lives in memory while server is running)
+const memorySessionStore = new MemorySessionStore();
 
 /**
  * Session middleware
  * Manages sessions using MemorySessionStore
  */
-export const sessionMiddleware = session<State>(
-  sessionStore,
+export const memorySessionMiddleware = session<State>(
+  memorySessionStore,
   "your-secret-key-at-least-32-characters-long", // In production, get from environment variable
   {
     cookieName: "session",