@scayle/h3-session 0.4.2 → 0.5.1

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @scayle/h3-session
 
+## 0.5.1
+
+### Patch Changes
+
+- When a sessionID exists, but there is no session data, re-use the sessionID instead of generating both new data and a new ID. This enables proper functioning of the `saveUnitialized` configuration.
+- Fix the `clear()` method on `UnstorageSessionStore` not clearing sessions
+
+## 0.5.0
+
+### Minor Changes
+
+- Cookie metadata is no longer saved in the session store. Previously, `h3-session` stored a copy of the cookie settings in the session store alongside the session data. This has been changed and now only the session data itself is stored. The cookie settings can still be read and manipulated from the `Session` object.
+
+### Patch Changes
+
+- Removed dependency `zod@^3.23.8`
+- Replace regex used for cookie parsing
+
 ## 0.4.2
 
 ### Patch Changes

package/dist/index.d.mts

@@ -41,7 +41,7 @@ declare class UnstorageSessionStore implements SessionStore {
      * Get the session with the specified session ID
      * @param sid the un-prefixed session ID
      */
-    get(sid: string): Promise<RawSession | undefined>;
+    get(sid: string): Promise<SessionDataT | undefined>;
     /**
      * Save the session with the specified session ID
      * If the session has expired (has a TTL <= 0) it is deleted.
@@ -62,7 +62,7 @@ declare class UnstorageSessionStore implements SessionStore {
     /**
      * Fetch all saved sessions.
      */
-    all(): Promise<RawSession[]>;
+    all(): Promise<SessionDataT[]>;
     /**
      * Returns the number of saved sessions
      */
@@ -84,9 +84,7 @@ type SessionCookie = SessionCookieOptions & {
 };
 interface SessionDataT {
 }
-type RawSession = SessionDataT & {
-    cookie?: SessionCookieOptions;
-};
+type RawSession = SessionDataT;
 interface SessionStore {
     all?: () => Promise<RawSession[]>;
     destroy: (sid: string) => Promise<void>;
@@ -128,6 +126,13 @@ declare module 'h3' {
  * @param secrets an array of secret strings to verify with
  */
 declare function unsignCookie(value: string, secrets: string[]): Promise<string | false>;
+/**
+ * Creates a signed cookie value in the format `s:[value].[signature]`
+ * @param value
+ * @param secret
+ */
+declare function signCookie(value: string, secret: string): Promise<string>;
+declare function validateConfig(config: H3SessionOptions): void;
 /**
  * Attach a session to an H3Event
  * @param event
@@ -135,4 +140,4 @@ declare function unsignCookie(value: string, secrets: string[]): Promise<string
  */
 declare function useSession(event: H3Event, config: H3SessionOptions): Promise<void>;
 
-export { type RawSession, Session, type SessionCookie, type SessionCookieOptions, type SessionDataT, type SessionMethods, type SessionStore, UnstorageSessionStore, unsignCookie, useSession };
+export { type H3SessionOptions, type RawSession, Session, type SessionCookie, type SessionCookieOptions, type SessionDataT, type SessionMethods, type SessionStore, UnstorageSessionStore, signCookie, unsignCookie, useSession, validateConfig };

package/dist/index.d.ts

@@ -41,7 +41,7 @@ declare class UnstorageSessionStore implements SessionStore {
      * Get the session with the specified session ID
      * @param sid the un-prefixed session ID
      */
-    get(sid: string): Promise<RawSession | undefined>;
+    get(sid: string): Promise<SessionDataT | undefined>;
     /**
      * Save the session with the specified session ID
      * If the session has expired (has a TTL <= 0) it is deleted.
@@ -62,7 +62,7 @@ declare class UnstorageSessionStore implements SessionStore {
     /**
      * Fetch all saved sessions.
      */
-    all(): Promise<RawSession[]>;
+    all(): Promise<SessionDataT[]>;
     /**
      * Returns the number of saved sessions
      */
@@ -84,9 +84,7 @@ type SessionCookie = SessionCookieOptions & {
 };
 interface SessionDataT {
 }
-type RawSession = SessionDataT & {
-    cookie?: SessionCookieOptions;
-};
+type RawSession = SessionDataT;
 interface SessionStore {
     all?: () => Promise<RawSession[]>;
     destroy: (sid: string) => Promise<void>;
@@ -128,6 +126,13 @@ declare module 'h3' {
  * @param secrets an array of secret strings to verify with
  */
 declare function unsignCookie(value: string, secrets: string[]): Promise<string | false>;
+/**
+ * Creates a signed cookie value in the format `s:[value].[signature]`
+ * @param value
+ * @param secret
+ */
+declare function signCookie(value: string, secret: string): Promise<string>;
+declare function validateConfig(config: H3SessionOptions): void;
 /**
  * Attach a session to an H3Event
  * @param event
@@ -135,4 +140,4 @@ declare function unsignCookie(value: string, secrets: string[]): Promise<string
  */
 declare function useSession(event: H3Event, config: H3SessionOptions): Promise<void>;
 
-export { type RawSession, Session, type SessionCookie, type SessionCookieOptions, type SessionDataT, type SessionMethods, type SessionStore, UnstorageSessionStore, unsignCookie, useSession };
+export { type H3SessionOptions, type RawSession, Session, type SessionCookie, type SessionCookieOptions, type SessionDataT, type SessionMethods, type SessionStore, UnstorageSessionStore, signCookie, unsignCookie, useSession, validateConfig };

package/dist/index.mjs

@@ -2,7 +2,6 @@ import { Buffer } from 'node:buffer';
 import { getCookie, setCookie } from 'h3';
 import { defu } from 'defu';
 import { subtle, randomUUID } from 'uncrypto';
-import { z } from 'zod';
 
 class Session {
   #id;
@@ -21,7 +20,7 @@ class Session {
     return this.#id;
   }
   async save() {
-    await this.#store.set(this.#id, { ...this.data, cookie: this.cookie });
+    await this.#store.set(this.#id, this.data);
   }
   async reload() {
     this.data = await this.#store.get(this.#id) ?? (await this.#generate()).data;
@@ -39,15 +38,6 @@ class Session {
   }
 }
 
-const CookieSchema = z.object({
-  domain: z.string().optional(),
-  expires: z.coerce.date().optional(),
-  httpOnly: z.boolean().optional(),
-  maxAge: z.number().optional(),
-  path: z.string().optional(),
-  sameSite: z.enum(["lax", "none", "strict"]).or(z.boolean()).optional(),
-  secure: z.boolean().optional()
-});
 class UnstorageSessionStore {
   storage;
   prefix;
@@ -70,13 +60,6 @@ class UnstorageSessionStore {
    */
   async get(sid) {
     const item = await this.storage.getItem(this.getKey(sid));
-    if (item && item.cookie) {
-      try {
-        item.cookie = CookieSchema.parse(item.cookie);
-      } catch {
-        delete item.cookie;
-      }
-    }
     return item ?? void 0;
   }
   /**
@@ -105,7 +88,8 @@ class UnstorageSessionStore {
    * Remove all saved sessions
    */
   async clear() {
-    return await this.storage.clear(this.prefix);
+    const keys = await this.getAllKeys();
+    await Promise.all(keys.map((k) => this.storage.removeItem(k)));
   }
   /**
    * Fetch all saved sessions.
@@ -144,12 +128,26 @@ class UnstorageSessionStore {
   }
 }
 
+const signatureLength = 43;
+function parseCookieValue(value) {
+  if (value.length < signatureLength + 3) {
+    return void 0;
+  }
+  const separatorIndex = value.length - signatureLength - 1;
+  if (value.charAt(0) !== "s" || value.charAt(1) !== ":" || value.charAt(separatorIndex) !== ".") {
+    return void 0;
+  }
+  return [
+    value.substring(2, separatorIndex),
+    value.substring(separatorIndex + 1)
+  ];
+}
 async function unsignCookie(value, secrets) {
-  const matches = /s:([^.]*)\.(.*)/.exec(value);
+  const matches = parseCookieValue(value);
   if (!matches) {
     return false;
   }
-  const [, message, signature] = matches;
+  const [message, signature] = matches;
   const encoder = new TextEncoder();
   const messageUint8Array = encoder.encode(message);
   const signatureUint8Array = Uint8Array.from(Buffer.from(signature, "base64"));
@@ -175,6 +173,12 @@ async function unsignCookie(value, secrets) {
   return false;
 }
 async function signCookie(value, secret) {
+  if (!value) {
+    throw new Error("[h3-session] No value was provided!");
+  }
+  if (!secret) {
+    throw new Error("[h3-session] No secret was provided!");
+  }
   const encoder = new TextEncoder();
   const messageUint8Array = encoder.encode(value);
   const keyUint8Array = encoder.encode(secret);
@@ -259,18 +263,26 @@ async function useSession(event, config) {
   }
   async function createExistingSession(id, data) {
     const cookie = await createSessionCookie(id);
-    if (store.touch) {
+    if (store.touch && data) {
       await store.touch(id, data);
     }
-    event.context.session = new Session(id, data, store, generate, cookie);
+    event.context.session = new Session(
+      id,
+      data ?? sessionConfig.generate(),
+      store,
+      generate,
+      cookie
+    );
     event.context.sessionId = id;
   }
-  if (!sessionId || !sessionData) {
+  if (!sessionId) {
     await createNewSession();
+  } else if (!sessionData) {
+    await createExistingSession(sessionId);
   } else {
     await createExistingSession(sessionId, sessionData);
   }
   event.context.sessionStore = store;
 }
 
-export { Session, UnstorageSessionStore, unsignCookie, useSession };
+export { Session, UnstorageSessionStore, signCookie, unsignCookie, useSession, validateConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/h3-session",
-  "version": "0.4.2",
+  "version": "0.5.1",
   "description": "Persistent sessions for h3",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -22,7 +22,11 @@
     "format": "dprint check",
     "format:fix": "dprint fmt",
     "lint": "eslint . --format gitlab",
-    "lint:fix": "eslint . --fix"
+    "lint:fix": "eslint . --fix",
+    "test": "vitest run",
+    "test:ci": "vitest --run --coverage --reporter=default --reporter=junit --outputFile=./junit.xml",
+    "test:watch": "vitest watch",
+    "typecheck": "tsc --noEmit -p tsconfig.json"
   },
   "peerDependencies": {
     "h3": "^1.10.0"
@@ -30,18 +34,19 @@
   "dependencies": {
     "defu": "^6.1.4",
     "uncrypto": "^0.1.3",
-    "unstorage": "^1.10.2",
-    "zod": "^3.23.8"
+    "unstorage": "^1.10.2"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "0.17.1",
+    "@arethetypeswrong/cli": "0.17.2",
     "@scayle/eslint-config-storefront": "4.4.0",
-    "dprint": "0.47.6",
+    "cookie-es": "1.2.2",
+    "dprint": "0.48.0",
     "eslint": "9.17.0",
     "eslint-formatter-gitlab": "5.1.0",
     "h3": "1.13.0",
-    "typescript": "5.6.3",
-    "unbuild": "3.0.1"
+    "typescript": "5.7.2",
+    "unbuild": "3.2.0",
+    "vitest": "2.1.8"
   },
   "volta": {
     "node": "22.12.0"