hono-sessions 0.2.4 → 0.3.0

package/README.md

@@ -1,8 +1,8 @@
 # Hono Sessions Middleware
-Use cookie-based sessions with the [Hono](https://hono.dev/) framework. Currently tested to work with Cloudflare Workers and Deno.
+Use cookie-based sessions with the [Hono](https://hono.dev/) framework. Currently tested to work with Deno, Cloudflare Workers, and Bun.
 
 ### 🛠️ Features
-- Runs in Deno and Cloudflare Workers (possibly others, currently untested)
+- Runs in Deno, Cloudflare Workers, and Bun (possibly others, currently untested)
 - Flash messages — data that is deleted once it's read (one-off error messages, etc.)
 - Built-in Memory and Cookie storage drivers (more coming soon)
 - Encrypted cookies thanks to [iron-webcrypto](https://github.com/brc-dd/iron-webcrypto)
@@ -125,6 +125,21 @@ import { sessionMiddleware, CookieStore, Session } from 'https://deno.land/x/hon
 Deno.serve(app.fetch)
 ```
 
+### Bun
+```ts
+import { Hono } from 'hono'
+import { sessionMiddleware, CookieStore, Session } from 'hono-sessions'
+
+// Same as CF Workers, however instead of:
+// export default app
+// use:
+
+export default {
+  port: 3000,
+  fetch: app.fetch
+}
+```
+
 ## Contributing
 
 This package is built Deno-first, so you'll need to have Deno installed in your development environment. See their [website](https://deno.com/) for installation instructions specific to your platform.

package/esm/src/Middleware.js

@@ -31,8 +31,13 @@ export function sessionMiddleware(options) {
                 session_data = await store.getSession(c);
             }
             else {
-                sid = (encryptionKey ? await decrypt(encryptionKey, sessionCookie) : sessionCookie);
-                session_data = await store.getSessionById(sid);
+                try {
+                    sid = (encryptionKey ? await decrypt(encryptionKey, sessionCookie) : sessionCookie);
+                    session_data = await store.getSessionById(sid);
+                }
+                catch {
+                    createNewSession = true;
+                }
             }
             if (session_data) {
                 session.setCache(session_data);

package/esm/src/store/CookieStore.d.ts

@@ -10,7 +10,7 @@ declare class CookieStore {
     cookieOptions: CookieOptions | undefined;
     sessionCookieName: string;
     constructor(options?: CookieStoreOptions);
-    getSession(c: Context): Promise<any>;
+    getSession(c: Context): Promise<SessionData | null>;
     createSession(c: Context, initial_data: SessionData): Promise<void>;
     deleteSession(c: Context): Promise<void>;
     persistSessionData(c: Context, session_data: SessionData): Promise<void>;

package/esm/src/store/CookieStore.js

@@ -25,12 +25,23 @@ class CookieStore {
         this.sessionCookieName = options?.sessionCookieName || 'session';
     }
     async getSession(c) {
-        let session_data;
+        let session_data_raw;
         const sessionCookie = getCookie(c, this.sessionCookieName);
         if (this.encryptionKey && sessionCookie) {
-            session_data = (await decrypt(this.encryptionKey, sessionCookie));
-            if (session_data) {
-                return JSON.parse(session_data);
+            // Decrypt cookie string. If decryption fails, return null
+            try {
+                session_data_raw = (await decrypt(this.encryptionKey, sessionCookie));
+            }
+            catch {
+                return null;
+            }
+            // Parse session object from cookie string and return result. If fails, return null
+            try {
+                const session_data = JSON.parse(session_data_raw);
+                return session_data;
+            }
+            catch {
+                return null;
             }
         }
         else {

package/esm/src/store/bun/BunSqliteStore.d.ts

@@ -0,0 +1,11 @@
+import Store from '../Store.js';
+import { SessionData } from '../../Session.js';
+export declare class BunSqliteStore implements Store {
+    db: any;
+    tableName: string;
+    constructor(db: any, tableName?: string);
+    getSessionById(sessionId: string): any;
+    createSession(sessionId: string, initialData: SessionData): void;
+    deleteSession(sessionId: string): void;
+    persistSessionData(sessionId: string, sessionData: SessionData): void;
+}

package/esm/src/store/bun/BunSqliteStore.js

@@ -0,0 +1,42 @@
+export class BunSqliteStore {
+    constructor(db, tableName = 'sessions') {
+        Object.defineProperty(this, "db", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "tableName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.db = db;
+        this.tableName = tableName;
+        const query = db.query(`CREATE TABLE IF NOT EXISTS ${tableName} (id TEXT PRIMARY KEY, data TEXT)`);
+        query.run();
+    }
+    getSessionById(sessionId) {
+        const query = this.db.query(`SELECT data FROM ${this.tableName} WHERE id = $id`);
+        const result = query.get({ $id: sessionId });
+        if (result) {
+            return JSON.parse(result.data);
+        }
+        else {
+            return null;
+        }
+    }
+    createSession(sessionId, initialData) {
+        const query = this.db.query(`INSERT INTO ${this.tableName} (id, data) VALUES ($id, $data)`);
+        query.run({ $id: sessionId, $data: JSON.stringify(initialData) });
+    }
+    deleteSession(sessionId) {
+        const query = this.db.query(`DELETE FROM ${this.tableName} WHERE id = $id`);
+        query.run({ $id: sessionId });
+    }
+    persistSessionData(sessionId, sessionData) {
+        const query = this.db.query(`UPDATE ${this.tableName} SET data = $data WHERE id = $id`);
+        query.run({ $id: sessionId, $data: JSON.stringify(sessionData) });
+    }
+}

package/package.json

@@ -2,7 +2,7 @@
   "module": "./esm/mod.js",
   "main": "./script/mod.js",
   "name": "hono-sessions",
-  "version": "0.2.4",
+  "version": "0.3.0",
   "description": "Cookie-based sessions for Hono web framework",
   "license": "MIT",
   "repository": {
@@ -16,6 +16,10 @@
     ".": {
       "import": "./esm/mod.js",
       "require": "./script/mod.js"
+    },
+    "./bun-sqlite-store": {
+      "import": "./esm/src/store/bun/BunSqliteStore.js",
+      "require": "./script/src/store/bun/BunSqliteStore.js"
     }
   },
   "dependencies": {

package/script/src/Middleware.js

@@ -37,8 +37,13 @@ function sessionMiddleware(options) {
                 session_data = await store.getSession(c);
             }
             else {
-                sid = (encryptionKey ? await (0, mod_js_1.decrypt)(encryptionKey, sessionCookie) : sessionCookie);
-                session_data = await store.getSessionById(sid);
+                try {
+                    sid = (encryptionKey ? await (0, mod_js_1.decrypt)(encryptionKey, sessionCookie) : sessionCookie);
+                    session_data = await store.getSessionById(sid);
+                }
+                catch {
+                    createNewSession = true;
+                }
             }
             if (session_data) {
                 session.setCache(session_data);

package/script/src/store/CookieStore.d.ts

@@ -10,7 +10,7 @@ declare class CookieStore {
     cookieOptions: CookieOptions | undefined;
     sessionCookieName: string;
     constructor(options?: CookieStoreOptions);
-    getSession(c: Context): Promise<any>;
+    getSession(c: Context): Promise<SessionData | null>;
     createSession(c: Context, initial_data: SessionData): Promise<void>;
     deleteSession(c: Context): Promise<void>;
     persistSessionData(c: Context, session_data: SessionData): Promise<void>;

package/script/src/store/CookieStore.js

@@ -27,12 +27,23 @@ class CookieStore {
         this.sessionCookieName = options?.sessionCookieName || 'session';
     }
     async getSession(c) {
-        let session_data;
+        let session_data_raw;
         const sessionCookie = (0, deps_js_1.getCookie)(c, this.sessionCookieName);
         if (this.encryptionKey && sessionCookie) {
-            session_data = (await (0, mod_js_1.decrypt)(this.encryptionKey, sessionCookie));
-            if (session_data) {
-                return JSON.parse(session_data);
+            // Decrypt cookie string. If decryption fails, return null
+            try {
+                session_data_raw = (await (0, mod_js_1.decrypt)(this.encryptionKey, sessionCookie));
+            }
+            catch {
+                return null;
+            }
+            // Parse session object from cookie string and return result. If fails, return null
+            try {
+                const session_data = JSON.parse(session_data_raw);
+                return session_data;
+            }
+            catch {
+                return null;
             }
         }
         else {

package/script/src/store/bun/BunSqliteStore.d.ts

@@ -0,0 +1,11 @@
+import Store from '../Store.js';
+import { SessionData } from '../../Session.js';
+export declare class BunSqliteStore implements Store {
+    db: any;
+    tableName: string;
+    constructor(db: any, tableName?: string);
+    getSessionById(sessionId: string): any;
+    createSession(sessionId: string, initialData: SessionData): void;
+    deleteSession(sessionId: string): void;
+    persistSessionData(sessionId: string, sessionData: SessionData): void;
+}

package/script/src/store/bun/BunSqliteStore.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BunSqliteStore = void 0;
+class BunSqliteStore {
+    constructor(db, tableName = 'sessions') {
+        Object.defineProperty(this, "db", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "tableName", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.db = db;
+        this.tableName = tableName;
+        const query = db.query(`CREATE TABLE IF NOT EXISTS ${tableName} (id TEXT PRIMARY KEY, data TEXT)`);
+        query.run();
+    }
+    getSessionById(sessionId) {
+        const query = this.db.query(`SELECT data FROM ${this.tableName} WHERE id = $id`);
+        const result = query.get({ $id: sessionId });
+        if (result) {
+            return JSON.parse(result.data);
+        }
+        else {
+            return null;
+        }
+    }
+    createSession(sessionId, initialData) {
+        const query = this.db.query(`INSERT INTO ${this.tableName} (id, data) VALUES ($id, $data)`);
+        query.run({ $id: sessionId, $data: JSON.stringify(initialData) });
+    }
+    deleteSession(sessionId) {
+        const query = this.db.query(`DELETE FROM ${this.tableName} WHERE id = $id`);
+        query.run({ $id: sessionId });
+    }
+    persistSessionData(sessionId, sessionData) {
+        const query = this.db.query(`UPDATE ${this.tableName} SET data = $data WHERE id = $id`);
+        query.run({ $id: sessionId, $data: JSON.stringify(sessionData) });
+    }
+}
+exports.BunSqliteStore = BunSqliteStore;