@logto/node 3.0.3 → 3.1.1

package/lib/src/utils/cookie-storage.d.ts

@@ -3,18 +3,28 @@ import { type CookieSerializeOptions } from 'cookie';
 import { PromiseQueue } from './promise-queue.js';
 import { type SessionData } from './session.js';
 type Nullable<T> = T | null;
-export type CookieConfig = {
-    /** The encryption key to encrypt the session data. It should be a random string. */
-    encryptionKey: string;
-    /** The name of the cookie key. Default to `logtoCookies`. */
+export type CookieConfigBase = {
     cookieKey?: string;
-    /** Set to true in https */
     isSecure?: boolean;
-    getCookie: (name: string) => string | undefined;
+    getCookie: (name: string) => Promise<string | undefined> | string | undefined;
     setCookie: (name: string, value: string, options: CookieSerializeOptions & {
         path: string;
-    }) => void;
+    }) => Promise<void> | void;
+};
+export type SessionWrapper = {
+    wrap: (data: SessionData, key: string) => Promise<string>;
+    unwrap: (value: string, key: string) => Promise<SessionData>;
 };
+export type CookieConfig = CookieConfigBase & ({
+    /** Required when using default session wrapper */
+    encryptionKey: string;
+    sessionWrapper?: never;
+} | {
+    /** Optional when custom sessionWrapper is provided */
+    encryptionKey?: string;
+    /** Custom session wrapper can be used to implement external storage solutions */
+    sessionWrapper: SessionWrapper;
+});
 /**
  * A storage that persists data in cookies with encryption.
  */
@@ -31,6 +41,12 @@ export declare class CookieStorage implements Storage<PersistKey> {
     get data(): SessionData;
     protected sessionData: SessionData;
     protected saveQueue: PromiseQueue;
+    /**
+     * Handles the wrapping and unwrapping of session data.
+     * Can be provided via config or defaults to using wrapSession/unwrapSession functions.
+     * Users can implement custom storage solutions by providing their own sessionWrapper.
+     */
+    protected sessionWrapper: SessionWrapper;
     constructor(config: CookieConfig);
     init(): Promise<void>;
     getItem(key: PersistKey): Promise<Nullable<string>>;

package/lib/src/utils/cookie-storage.js

@@ -1,5 +1,5 @@
 import { PromiseQueue } from './promise-queue.js';
-import { unwrapSession, wrapSession } from './session.js';
+import { wrapSession, unwrapSession } from './session.js';
 
 /**
  * A storage that persists data in cookies with encryption.
@@ -24,13 +24,17 @@ class CookieStorage {
         this.config = config;
         this.sessionData = {};
         this.saveQueue = new PromiseQueue();
-        if (!config.encryptionKey) {
-            throw new TypeError('The `encryptionKey` string is required for `CookieStorage`');
+        if (!config.sessionWrapper && !config.encryptionKey) {
+            throw new TypeError('Either `sessionWrapper` or `encryptionKey` must be provided for `CookieStorage`');
         }
+        this.sessionWrapper = config.sessionWrapper ?? {
+            wrap: wrapSession,
+            unwrap: unwrapSession,
+        };
     }
     async init() {
-        const { encryptionKey } = this.config;
-        this.sessionData = await unwrapSession(this.config.getCookie(this.cookieKey) ?? '', encryptionKey);
+        const { encryptionKey = '' } = this.config;
+        this.sessionData = await this.sessionWrapper.unwrap((await this.config.getCookie(this.cookieKey)) ?? '', encryptionKey);
     }
     async getItem(key) {
         return this.sessionData[key] ?? null;
@@ -52,9 +56,9 @@ class CookieStorage {
         return this.saveQueue.enqueue(async () => this.write());
     }
     async write(data = this.sessionData) {
-        const { encryptionKey } = this.config;
-        const value = await wrapSession(data, encryptionKey);
-        this.config.setCookie(this.cookieKey, value, this.cookieOptions);
+        const { encryptionKey = '' } = this.config;
+        const value = await this.sessionWrapper.wrap(data, encryptionKey);
+        await this.config.setCookie(this.cookieKey, value, this.cookieOptions);
     }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/node",
-  "version": "3.0.3",
+  "version": "3.1.1",
   "type": "module",
   "module": "./lib/src/index.js",
   "types": "./lib/src/index.d.ts",
@@ -30,19 +30,19 @@
   "dependencies": {
     "@silverhand/essentials": "^2.9.2",
     "js-base64": "^3.7.4",
-    "@logto/client": "^3.0.3"
+    "@logto/client": "^3.0.4"
   },
   "devDependencies": {
     "@silverhand/eslint-config": "^6.0.1",
     "@silverhand/ts-config": "^6.0.0",
     "@types/cookie": "^0.6.0",
     "@types/node": "^22.0.0",
-    "@vitest/coverage-v8": "^1.6.0",
+    "@vitest/coverage-v8": "^2.1.9",
     "eslint": "^8.57.0",
     "lint-staged": "^15.0.0",
     "prettier": "^3.0.0",
     "typescript": "^5.3.3",
-    "vitest": "^1.6.0"
+    "vitest": "^2.1.9"
   },
   "eslintConfig": {
     "extends": "@silverhand"