hono-sessions 0.3.6 → 0.4.0

package/README.md

@@ -7,6 +7,7 @@ Hono Sessions is currently tested on these runtimes:
 
 - Deno
 - Cloudflare Workers
+- Cloudflare Pages
 - Bun
 - Node (v20+)
 
@@ -156,7 +157,7 @@ export default {
 }
 ```
 
-### Cloudflare Workers
+### Cloudflare Workers / Pages
 
 ```ts
 import { Hono } from 'hono'

package/esm/deps.d.ts

@@ -1,4 +1,3 @@
-export { nanoid } from 'nanoid/async';
 export type { Context, MiddlewareHandler } from 'hono';
 export { createMiddleware } from 'hono/factory';
 export { getCookie, setCookie } from 'hono/cookie';

package/esm/deps.js

@@ -1,4 +1,3 @@
-export { nanoid } from 'nanoid/async';
 export { createMiddleware } from 'hono/factory';
 export { getCookie, setCookie } from 'hono/cookie';
 export * as Iron from 'iron-webcrypto';

package/esm/src/Crypto.d.ts

@@ -1,2 +1,16 @@
+/**
+ * Encrypt a string or object value
+ *
+ * @param password Random string at least 32 characters long
+ * @param payload String or object to encrypt
+ * @returns A promise of the encrypted string
+ */
 export declare function encrypt(password: string, payload: object | string): Promise<string>;
+/**
+ * Decrypt an encrypted payload
+ *
+ * @param password Random string at least 32 characters long
+ * @param encrypted Encrypted string
+ * @returns Promise of the unencrypted value (string or object in most cases)
+ */
 export declare function decrypt(password: string, encrypted: string): Promise<unknown>;

package/esm/src/Crypto.js

@@ -1,7 +1,21 @@
 import { Iron } from '../deps.js';
+/**
+ * Encrypt a string or object value
+ *
+ * @param password Random string at least 32 characters long
+ * @param payload String or object to encrypt
+ * @returns A promise of the encrypted string
+ */
 export async function encrypt(password, payload) {
     return await Iron.seal(globalThis.crypto, payload, password, Iron.defaults);
 }
+/**
+ * Decrypt an encrypted payload
+ *
+ * @param password Random string at least 32 characters long
+ * @param encrypted Encrypted string
+ * @returns Promise of the unencrypted value (string or object in most cases)
+ */
 export async function decrypt(password, encrypted) {
     return await Iron.unseal(globalThis.crypto, encrypted, { default: password }, Iron.defaults);
 }

package/esm/src/Middleware.d.ts

@@ -9,5 +9,6 @@ interface SessionOptions {
     cookieOptions?: CookieOptions;
     sessionCookieName?: string;
 }
+/** Function that returns a Hono-compatible session middleware */
 export declare function sessionMiddleware(options: SessionOptions): MiddlewareHandler<any, any, {}>;
 export {};

package/esm/src/Middleware.js

@@ -1,7 +1,7 @@
-import { nanoid } from '../deps.js';
 import { getCookie, setCookie, createMiddleware } from '../deps.js';
 import CookieStore from './store/CookieStore.js';
 import { Session, encrypt, decrypt } from '../mod.js';
+/** Function that returns a Hono-compatible session middleware */
 export function sessionMiddleware(options) {
     const store = options.store;
     const encryptionKey = options.encryptionKey;
@@ -67,7 +67,7 @@ export function sessionMiddleware(options) {
                 await store.createSession(c, defaultData);
             }
             else {
-                sid = await nanoid(21);
+                sid = globalThis.crypto.randomUUID();
                 await store.createSession(sid, defaultData);
             }
             session.setCache(defaultData);
@@ -96,7 +96,7 @@ export function sessionMiddleware(options) {
             shouldRotateSessionKey;
         if (shouldRecreateSessionForNonCookieStore) {
             await store.deleteSession(sid);
-            sid = await nanoid(21);
+            sid = globalThis.crypto.randomUUID();
             await store.createSession(sid, session.getCache());
             setCookie(c, sessionCookieName, encryptionKey ? await encrypt(encryptionKey, sid) : sid, cookieOptions);
         }

package/esm/src/Session.d.ts

@@ -2,12 +2,18 @@ interface SessionDataEntry {
     value: unknown;
     flash: boolean;
 }
+/**
+ * Interface for specifying the necessary data for a session entry
+ */
 export interface SessionData {
     _data: Record<string, SessionDataEntry>;
     _expire: string | null;
     _delete: boolean;
     _accessed: string | null;
 }
+/**
+ * Session class with methods for interacting with the session
+ */
 export declare class Session {
     private cache;
     constructor();

package/esm/src/Session.js

@@ -1,3 +1,6 @@
+/**
+ * Session class with methods for interacting with the session
+ */
 export class Session {
     constructor() {
         Object.defineProperty(this, "cache", {

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

@@ -5,6 +5,9 @@ interface CookieStoreOptions {
     cookieOptions?: CookieOptions;
     sessionCookieName: string;
 }
+/**
+ * Cookie storage driver class
+ */
 declare class CookieStore {
     encryptionKey: string | null | undefined;
     cookieOptions: CookieOptions | undefined;

package/esm/src/store/CookieStore.js

@@ -1,5 +1,8 @@
 import { getCookie, setCookie } from '../../deps.js';
 import { encrypt, decrypt } from '../../mod.js';
+/**
+ * Cookie storage driver class
+ */
 class CookieStore {
     constructor(options) {
         Object.defineProperty(this, "encryptionKey", {

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

@@ -1,5 +1,8 @@
 import Store from './Store.js';
 import { SessionData } from '../../mod.js';
+/**
+ * Memory storage driver class
+ */
 declare class MemoryStore implements Store {
     private data;
     constructor();

package/esm/src/store/MemoryStore.js

@@ -1,3 +1,6 @@
+/**
+ * Memory storage driver class
+ */
 class MemoryStore {
     constructor() {
         Object.defineProperty(this, "data", {

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

@@ -1,4 +1,7 @@
 import { SessionData } from "../../mod.js";
+/**
+ * Interface for required methods in session storage drivers
+ */
 export default interface Store {
     getSessionById(sessionId?: string): SessionData | null | undefined | Promise<SessionData | null | undefined>;
     createSession(sessionId: string, initialData: SessionData): Promise<void> | void;

package/package.json

@@ -2,7 +2,7 @@
   "module": "./esm/mod.js",
   "main": "./script/mod.js",
   "name": "hono-sessions",
-  "version": "0.3.6",
+  "version": "0.4.0",
   "description": "Cookie-based sessions for Hono web framework",
   "license": "MIT",
   "repository": {
@@ -28,7 +28,6 @@
   },
   "dependencies": {
     "hono": "3.12.8",
-    "iron-webcrypto": "0.10.1",
-    "nanoid": "4.0.0"
+    "iron-webcrypto": "0.10.1"
   }
 }

package/script/deps.d.ts

@@ -1,4 +1,3 @@
-export { nanoid } from 'nanoid/async';
 export type { Context, MiddlewareHandler } from 'hono';
 export { createMiddleware } from 'hono/factory';
 export { getCookie, setCookie } from 'hono/cookie';

package/script/deps.js

@@ -23,9 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Iron = exports.setCookie = exports.getCookie = exports.createMiddleware = exports.nanoid = void 0;
-var async_1 = require("nanoid/async");
-Object.defineProperty(exports, "nanoid", { enumerable: true, get: function () { return async_1.nanoid; } });
+exports.Iron = exports.setCookie = exports.getCookie = exports.createMiddleware = void 0;
 var factory_1 = require("hono/factory");
 Object.defineProperty(exports, "createMiddleware", { enumerable: true, get: function () { return factory_1.createMiddleware; } });
 var cookie_1 = require("hono/cookie");

package/script/src/Crypto.d.ts

@@ -1,2 +1,16 @@
+/**
+ * Encrypt a string or object value
+ *
+ * @param password Random string at least 32 characters long
+ * @param payload String or object to encrypt
+ * @returns A promise of the encrypted string
+ */
 export declare function encrypt(password: string, payload: object | string): Promise<string>;
+/**
+ * Decrypt an encrypted payload
+ *
+ * @param password Random string at least 32 characters long
+ * @param encrypted Encrypted string
+ * @returns Promise of the unencrypted value (string or object in most cases)
+ */
 export declare function decrypt(password: string, encrypted: string): Promise<unknown>;

package/script/src/Crypto.js

@@ -2,10 +2,24 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.decrypt = exports.encrypt = void 0;
 const deps_js_1 = require("../deps.js");
+/**
+ * Encrypt a string or object value
+ *
+ * @param password Random string at least 32 characters long
+ * @param payload String or object to encrypt
+ * @returns A promise of the encrypted string
+ */
 async function encrypt(password, payload) {
     return await deps_js_1.Iron.seal(globalThis.crypto, payload, password, deps_js_1.Iron.defaults);
 }
 exports.encrypt = encrypt;
+/**
+ * Decrypt an encrypted payload
+ *
+ * @param password Random string at least 32 characters long
+ * @param encrypted Encrypted string
+ * @returns Promise of the unencrypted value (string or object in most cases)
+ */
 async function decrypt(password, encrypted) {
     return await deps_js_1.Iron.unseal(globalThis.crypto, encrypted, { default: password }, deps_js_1.Iron.defaults);
 }

package/script/src/Middleware.d.ts

@@ -9,5 +9,6 @@ interface SessionOptions {
     cookieOptions?: CookieOptions;
     sessionCookieName?: string;
 }
+/** Function that returns a Hono-compatible session middleware */
 export declare function sessionMiddleware(options: SessionOptions): MiddlewareHandler<any, any, {}>;
 export {};

package/script/src/Middleware.js

@@ -5,9 +5,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sessionMiddleware = void 0;
 const deps_js_1 = require("../deps.js");
-const deps_js_2 = require("../deps.js");
 const CookieStore_js_1 = __importDefault(require("./store/CookieStore.js"));
 const mod_js_1 = require("../mod.js");
+/** Function that returns a Hono-compatible session middleware */
 function sessionMiddleware(options) {
     const store = options.store;
     const encryptionKey = options.encryptionKey;
@@ -26,12 +26,12 @@ function sessionMiddleware(options) {
             store.cookieOptions = cookieOptions;
         }
     }
-    const middleware = (0, deps_js_2.createMiddleware)(async (c, next) => {
+    const middleware = (0, deps_js_1.createMiddleware)(async (c, next) => {
         const session = new mod_js_1.Session;
         let sid = '';
         let session_data;
         let createNewSession = false;
-        const sessionCookie = (0, deps_js_2.getCookie)(c, sessionCookieName);
+        const sessionCookie = (0, deps_js_1.getCookie)(c, sessionCookieName);
         if (sessionCookie) { // If there is a session cookie present...
             if (store instanceof CookieStore_js_1.default) {
                 session_data = await store.getSession(c);
@@ -73,13 +73,13 @@ function sessionMiddleware(options) {
                 await store.createSession(c, defaultData);
             }
             else {
-                sid = await (0, deps_js_1.nanoid)(21);
+                sid = globalThis.crypto.randomUUID();
                 await store.createSession(sid, defaultData);
             }
             session.setCache(defaultData);
         }
         if (!(store instanceof CookieStore_js_1.default)) {
-            (0, deps_js_2.setCookie)(c, sessionCookieName, encryptionKey ? await (0, mod_js_1.encrypt)(encryptionKey, sid) : sid, cookieOptions);
+            (0, deps_js_1.setCookie)(c, sessionCookieName, encryptionKey ? await (0, mod_js_1.encrypt)(encryptionKey, sid) : sid, cookieOptions);
         }
         session.updateAccess();
         c.set('session', session);
@@ -102,9 +102,9 @@ function sessionMiddleware(options) {
             shouldRotateSessionKey;
         if (shouldRecreateSessionForNonCookieStore) {
             await store.deleteSession(sid);
-            sid = await (0, deps_js_1.nanoid)(21);
+            sid = globalThis.crypto.randomUUID();
             await store.createSession(sid, session.getCache());
-            (0, deps_js_2.setCookie)(c, sessionCookieName, encryptionKey ? await (0, mod_js_1.encrypt)(encryptionKey, sid) : sid, cookieOptions);
+            (0, deps_js_1.setCookie)(c, sessionCookieName, encryptionKey ? await (0, mod_js_1.encrypt)(encryptionKey, sid) : sid, cookieOptions);
         }
         /*
          * We skip session data persistence if it was just deleted.

package/script/src/Session.d.ts

@@ -2,12 +2,18 @@ interface SessionDataEntry {
     value: unknown;
     flash: boolean;
 }
+/**
+ * Interface for specifying the necessary data for a session entry
+ */
 export interface SessionData {
     _data: Record<string, SessionDataEntry>;
     _expire: string | null;
     _delete: boolean;
     _accessed: string | null;
 }
+/**
+ * Session class with methods for interacting with the session
+ */
 export declare class Session {
     private cache;
     constructor();

package/script/src/Session.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Session = void 0;
+/**
+ * Session class with methods for interacting with the session
+ */
 class Session {
     constructor() {
         Object.defineProperty(this, "cache", {

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

@@ -5,6 +5,9 @@ interface CookieStoreOptions {
     cookieOptions?: CookieOptions;
     sessionCookieName: string;
 }
+/**
+ * Cookie storage driver class
+ */
 declare class CookieStore {
     encryptionKey: string | null | undefined;
     cookieOptions: CookieOptions | undefined;

package/script/src/store/CookieStore.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const deps_js_1 = require("../../deps.js");
 const mod_js_1 = require("../../mod.js");
+/**
+ * Cookie storage driver class
+ */
 class CookieStore {
     constructor(options) {
         Object.defineProperty(this, "encryptionKey", {

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

@@ -1,5 +1,8 @@
 import Store from './Store.js';
 import { SessionData } from '../../mod.js';
+/**
+ * Memory storage driver class
+ */
 declare class MemoryStore implements Store {
     private data;
     constructor();

package/script/src/store/MemoryStore.js

@@ -1,5 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Memory storage driver class
+ */
 class MemoryStore {
     constructor() {
         Object.defineProperty(this, "data", {

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

@@ -1,4 +1,7 @@
 import { SessionData } from "../../mod.js";
+/**
+ * Interface for required methods in session storage drivers
+ */
 export default interface Store {
     getSessionById(sessionId?: string): SessionData | null | undefined | Promise<SessionData | null | undefined>;
     createSession(sessionId: string, initialData: SessionData): Promise<void> | void;