hono-sessions 0.6.1 → 0.7.1

package/README.md

@@ -13,14 +13,9 @@ Hono Sessions is currently tested on these runtimes:
 
 Other runtimes may work, but are untested. In addition to Hono's requirements, the [Web Crypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API) is required for this library.
 
-If you want to use a backend storage driver (instead of just storing session data in an encrypted cookie), you'll need to use a storage engine provided by Hono Sessions. Right now, those include:
-
-- Deno KV
-- Bun SQLite
-
 ### 🛠️ Features
 - 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)
+- Built-in Memory and Cookie storage drivers, as well as [community-supported drivers](https://github.com/jcs224/hono_sessions/wiki/Community-adapters) and the ability to [create your own storage driver](https://github.com/jcs224/hono_sessions/wiki/Creating-a-custom-storage-driver)
 - Encrypted cookies thanks to [iron-webcrypto](https://github.com/brc-dd/iron-webcrypto)
 - Session expiration after inactivity
 - Session key rotation* 
@@ -32,12 +27,18 @@ If you want to use a backend storage driver (instead of just storing session dat
 
 ### Deno
 
-Simply include the package from `deno.land/x`
+Simply include the package from [JSR](https://jsr.io/@jcs224/hono-sessions) or [NPM](https://www.npmjs.com/package/hono-sessions)
 
 ```ts
-import { sessionMiddleware } from 'https://deno.land/x/hono_sessions/mod.ts'
+// JSR
+import { sessionMiddleware } from 'jsr:@jcs224/hono-sessions'
+
+// NPM
+import { sessionMiddleware } from 'npm:hono-sessions'
 ```
 
+You can also use `deno add` and not need the `jsr:` specifier. 
+
 ### Node, Bun, Cloudflare Workers, etc.
 
 Install the NPM package
@@ -49,19 +50,19 @@ npm install hono-sessions
 
 ### Deno
 ```ts
-import { Hono } from 'https://deno.land/x/hono/mod.ts'
+import { Hono } from 'npm:hono'
 import { 
   Session,
   sessionMiddleware, 
   CookieStore 
-} from 'https://deno.land/x/hono_sessions/mod.ts'
+} from 'jsr:@jcs224/hono-sessions'
 
 // Add types to your session data (optional)
 type SessionDataTypes = {
   'counter': number
 }
 
-// Set up your Hono instance, using your 
+// Set up your Hono instance, using your types
 const app = new Hono<{
   Variables: {
     session: Session<SessionDataTypes>,
@@ -93,29 +94,6 @@ app.get('/', async (c, next) => {
 Deno.serve(app.fetch)
 ```
 
-#### Using Deno KV storage driver
-
-```ts
-import { Hono } from 'https://deno.land/x/hono/mod.ts'
-import { sessionMiddleware } from 'https://deno.land/x/hono_sessions/mod.ts'
-import { DenoKvStore } from 'https://deno.land/x/hono_sessions/src/store/deno/DenoKvStore.ts'
-
-const app = new Hono()
-
-const kv = await Deno.openKv()
-const store = new DenoKvStore(kv)
-
-app.use('*', sessionMiddleware({
-  store,
-  // ... other session options
-}))
-
-// Other app code
-
-Deno.serve(app.fetch)
-
-```
-
 ### Bun
 
 ```ts

package/esm/src/Session.d.ts

@@ -20,6 +20,7 @@ export declare class Session<T = any> {
     updateAccess(): void;
     get<K extends keyof T>(key: K): T[K] | null;
     set<K extends keyof T>(key: K, value: T[K]): void;
+    forget<K extends keyof T>(key: K): void;
     flash<K extends keyof T>(key: K, value: T[K]): void;
 }
 export {};

package/esm/src/Session.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Session.d.ts","sourceRoot":"","sources":["../../src/src/Session.ts"],"names":[],"mappings":"AAAA,UAAU,gBAAgB,CAAC,CAAC;IAC1B,KAAK,EAAE,CAAC,CAAC;IACT,KAAK,EAAE,OAAO,CAAA;CACf;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,GAAG;IAClC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,qBAAa,OAAO,CAAC,CAAC,GAAG,GAAG;IAE1B,OAAO,CAAC,KAAK,CAAgB;;IAW7B,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;IAInC,QAAQ,IAAI,WAAW,CAAC,CAAC,CAAC;IAI1B,aAAa,CAAC,UAAU,EAAE,MAAM;IAIhC,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAMjD,aAAa;IAIb,YAAY,IAAI,OAAO;IAIvB,YAAY;IAIZ,GAAG,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI;IAe3C,GAAG,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;IAS1C,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;CAQ7C"}
+{"version":3,"file":"Session.d.ts","sourceRoot":"","sources":["../../src/src/Session.ts"],"names":[],"mappings":"AAAA,UAAU,gBAAgB,CAAC,CAAC;IAC1B,KAAK,EAAE,CAAC,CAAC;IACT,KAAK,EAAE,OAAO,CAAA;CACf;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,GAAG;IAClC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,qBAAa,OAAO,CAAC,CAAC,GAAG,GAAG;IAE1B,OAAO,CAAC,KAAK,CAAgB;;IAW7B,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;IAInC,QAAQ,IAAI,WAAW,CAAC,CAAC,CAAC;IAI1B,aAAa,CAAC,UAAU,EAAE,MAAM;IAIhC,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAMjD,aAAa;IAIb,YAAY,IAAI,OAAO;IAIvB,YAAY;IAIZ,GAAG,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI;IAe3C,GAAG,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;IAS1C,MAAM,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;IAMhC,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;CAQ7C"}

package/esm/src/Session.js

@@ -56,6 +56,12 @@ export class Session {
         };
         this.cache._data[key] = entry;
     }
+    forget(key) {
+        const entry = this.cache._data[key];
+        if (!entry)
+            return;
+        delete this.cache._data[key];
+    }
     flash(key, value) {
         const entry = {
             value: value,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hono-sessions",
-  "version": "0.6.1",
+  "version": "0.7.1",
   "description": "Cookie-based sessions for Hono web framework",
   "repository": {
     "type": "git",
@@ -20,10 +20,6 @@
     "./bun-sqlite-store": {
       "import": "./esm/src/store/bun/BunSqliteStore.js",
       "require": "./script/src/store/bun/BunSqliteStore.js"
-    },
-    "./cloudflare-d1-store": {
-      "import": "./esm/src/store/cloudflare/CloudflareD1Store.js",
-      "require": "./script/src/store/cloudflare/CloudflareD1Store.js"
     }
   },
   "dependencies": {

package/script/src/Session.d.ts

@@ -20,6 +20,7 @@ export declare class Session<T = any> {
     updateAccess(): void;
     get<K extends keyof T>(key: K): T[K] | null;
     set<K extends keyof T>(key: K, value: T[K]): void;
+    forget<K extends keyof T>(key: K): void;
     flash<K extends keyof T>(key: K, value: T[K]): void;
 }
 export {};

package/script/src/Session.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Session.d.ts","sourceRoot":"","sources":["../../src/src/Session.ts"],"names":[],"mappings":"AAAA,UAAU,gBAAgB,CAAC,CAAC;IAC1B,KAAK,EAAE,CAAC,CAAC;IACT,KAAK,EAAE,OAAO,CAAA;CACf;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,GAAG;IAClC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,qBAAa,OAAO,CAAC,CAAC,GAAG,GAAG;IAE1B,OAAO,CAAC,KAAK,CAAgB;;IAW7B,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;IAInC,QAAQ,IAAI,WAAW,CAAC,CAAC,CAAC;IAI1B,aAAa,CAAC,UAAU,EAAE,MAAM;IAIhC,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAMjD,aAAa;IAIb,YAAY,IAAI,OAAO;IAIvB,YAAY;IAIZ,GAAG,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI;IAe3C,GAAG,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;IAS1C,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;CAQ7C"}
+{"version":3,"file":"Session.d.ts","sourceRoot":"","sources":["../../src/src/Session.ts"],"names":[],"mappings":"AAAA,UAAU,gBAAgB,CAAC,CAAC;IAC1B,KAAK,EAAE,CAAC,CAAC;IACT,KAAK,EAAE,OAAO,CAAA;CACf;AAED,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,GAAG;IAClC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,qBAAa,OAAO,CAAC,CAAC,GAAG,GAAG;IAE1B,OAAO,CAAC,KAAK,CAAgB;;IAW7B,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;IAInC,QAAQ,IAAI,WAAW,CAAC,CAAC,CAAC;IAI1B,aAAa,CAAC,UAAU,EAAE,MAAM;IAIhC,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAMjD,aAAa;IAIb,YAAY,IAAI,OAAO;IAIvB,YAAY;IAIZ,GAAG,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI;IAe3C,GAAG,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;IAS1C,MAAM,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;IAMhC,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;CAQ7C"}

package/script/src/Session.js

@@ -59,6 +59,12 @@ class Session {
         };
         this.cache._data[key] = entry;
     }
+    forget(key) {
+        const entry = this.cache._data[key];
+        if (!entry)
+            return;
+        delete this.cache._data[key];
+    }
     flash(key, value) {
         const entry = {
             value: value,

package/esm/src/store/cloudflare/CloudflareD1Store.d.ts

@@ -1,12 +0,0 @@
-import Store from '../Store.js';
-import { SessionData } from '../../Session.js';
-export declare class CloudflareD1Store implements Store {
-    db: any;
-    tableName: string;
-    constructor(tableName?: string);
-    getSessionById(sessionId?: string | undefined): Promise<any>;
-    createSession(sessionId: string, initialData: SessionData): Promise<void>;
-    deleteSession(sessionId: string): Promise<void>;
-    persistSessionData(sessionId: string, sessionData: SessionData): Promise<void>;
-}
-//# sourceMappingURL=CloudflareD1Store.d.ts.map

package/esm/src/store/cloudflare/CloudflareD1Store.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"CloudflareD1Store.d.ts","sourceRoot":"","sources":["../../../../src/src/store/cloudflare/CloudflareD1Store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,aAAa,CAAA;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAE9C,qBAAa,iBAAkB,YAAW,KAAK;IAC7C,EAAE,EAAE,GAAG,CAAA;IACP,SAAS,EAAE,MAAM,CAAA;gBAEL,SAAS,GAAE,MAAmB;IAIpC,cAAc,CAAC,SAAS,CAAC,EAAE,MAAM,GAAC,SAAS;IAY3C,aAAa,CAAC,SAAS,EAAE,MAAM,EAAC,WAAW,EAAE,WAAW;IAIxD,aAAa,CAAC,SAAS,EAAE,MAAM;IAI/B,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW;CAGrE"}

package/esm/src/store/cloudflare/CloudflareD1Store.js

@@ -1,37 +0,0 @@
-export class CloudflareD1Store {
-    constructor(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.tableName = tableName;
-    }
-    async getSessionById(sessionId) {
-        const session = await this.db.prepare(`SELECT data FROM ${this.tableName} WHERE id = ?`)
-            .bind(sessionId)
-            .first('data');
-        if (session) {
-            return JSON.parse(session);
-        }
-        else {
-            return null;
-        }
-    }
-    async createSession(sessionId, initialData) {
-        await this.db.prepare(`INSERT INTO ${this.tableName} (id, data) VALUES (?, ?)`).bind(sessionId, JSON.stringify(initialData)).run();
-    }
-    async deleteSession(sessionId) {
-        await this.db.prepare(`DELETE FROM ${this.tableName} WHERE id = ?`).bind(sessionId).run();
-    }
-    async persistSessionData(sessionId, sessionData) {
-        await this.db.prepare(`UPDATE ${this.tableName} SET data = ? WHERE id = ?`).bind(JSON.stringify(sessionData), sessionId).run();
-    }
-}

package/script/src/store/cloudflare/CloudflareD1Store.d.ts

@@ -1,12 +0,0 @@
-import Store from '../Store.js';
-import { SessionData } from '../../Session.js';
-export declare class CloudflareD1Store implements Store {
-    db: any;
-    tableName: string;
-    constructor(tableName?: string);
-    getSessionById(sessionId?: string | undefined): Promise<any>;
-    createSession(sessionId: string, initialData: SessionData): Promise<void>;
-    deleteSession(sessionId: string): Promise<void>;
-    persistSessionData(sessionId: string, sessionData: SessionData): Promise<void>;
-}
-//# sourceMappingURL=CloudflareD1Store.d.ts.map

package/script/src/store/cloudflare/CloudflareD1Store.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"CloudflareD1Store.d.ts","sourceRoot":"","sources":["../../../../src/src/store/cloudflare/CloudflareD1Store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,aAAa,CAAA;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAE9C,qBAAa,iBAAkB,YAAW,KAAK;IAC7C,EAAE,EAAE,GAAG,CAAA;IACP,SAAS,EAAE,MAAM,CAAA;gBAEL,SAAS,GAAE,MAAmB;IAIpC,cAAc,CAAC,SAAS,CAAC,EAAE,MAAM,GAAC,SAAS;IAY3C,aAAa,CAAC,SAAS,EAAE,MAAM,EAAC,WAAW,EAAE,WAAW;IAIxD,aAAa,CAAC,SAAS,EAAE,MAAM;IAI/B,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW;CAGrE"}

package/script/src/store/cloudflare/CloudflareD1Store.js

@@ -1,41 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CloudflareD1Store = void 0;
-class CloudflareD1Store {
-    constructor(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.tableName = tableName;
-    }
-    async getSessionById(sessionId) {
-        const session = await this.db.prepare(`SELECT data FROM ${this.tableName} WHERE id = ?`)
-            .bind(sessionId)
-            .first('data');
-        if (session) {
-            return JSON.parse(session);
-        }
-        else {
-            return null;
-        }
-    }
-    async createSession(sessionId, initialData) {
-        await this.db.prepare(`INSERT INTO ${this.tableName} (id, data) VALUES (?, ?)`).bind(sessionId, JSON.stringify(initialData)).run();
-    }
-    async deleteSession(sessionId) {
-        await this.db.prepare(`DELETE FROM ${this.tableName} WHERE id = ?`).bind(sessionId).run();
-    }
-    async persistSessionData(sessionId, sessionData) {
-        await this.db.prepare(`UPDATE ${this.tableName} SET data = ? WHERE id = ?`).bind(JSON.stringify(sessionData), sessionId).run();
-    }
-}
-exports.CloudflareD1Store = CloudflareD1Store;