@scayle/storefront-nuxt 8.55.0 → 8.56.0

package/CHANGELOG.md

@@ -1,5 +1,73 @@
 # @scayle/storefront-nuxt
 
+## 8.56.0
+
+### Minor Changes
+
+- **\[Session\]** Added support for storing and managing custom data in sessions through the RPC context.
+
+  The `RpcContext` now exposes a `sessionCustomData` property to read custom session data and an `updateSessionCustomData` method to update it.
+  The `sessionCustomData` property may be `undefined` when no session exists or when no custom data has been set.
+  The `SessionCustomData` interface can be augmented with TypeScript module augmentation to provide type safety for custom session properties.
+
+  - **Type Augmentation Example:**
+
+        ```ts
+        // templates/nuxt/types/session.ts
+        import '@scayle/storefront-nuxt'
+
+        declare module '@scayle/storefront-nuxt' {
+          interface SessionCustomData {
+            yourCustomDataKey?: string
+          }
+        }
+        ```
+
+  - **Setting Custom Session Data Example:**
+
+    ```ts
+    // templates/nuxt/server/plugins/session-plugin.ts
+    import { hasSession } from '@scayle/storefront-nuxt'
+    import { defineNitroPlugin } from '#imports'
+
+    export default defineNitroPlugin((nitroApp) => {
+      nitroApp.hooks.hook('storefront:afterLogin', async (_data, context) => {
+        if (!hasSession(context)) {
+          return
+        }
+
+        const sessionCustomData = context.sessionCustomData
+
+        if (!sessionCustomData) {
+          return
+        }
+
+        context.updateSessionCustomData({
+          ...sessionCustomData,
+          yourCustomDataKey: 'Your Session CustomData Value',
+        })
+
+        console.log(context.sessionCustomData?.yourCustomDataKey)
+      })
+    })
+    ```
+
+### Patch Changes
+
+**Dependencies**
+
+- Updated dependency to @scayle/unstorage-compression-driver@1.2.4
+
+**@scayle/storefront-core v8.56.0**
+
+- Minor
+
+  - Added support for custom session data in the RPC context type definitions.
+
+  The `ContextWithSession` interface now includes a `sessionCustomData` property (which may be `undefined`) to read custom session data and an `updateSessionCustomData` method to update it.
+  The `ContextWithoutSession` interface has been updated accordingly to maintain type consistency.
+  The `SessionCustomData` interface can be augmented using TypeScript module augmentation to provide type safety for custom session properties.
+
 ## 8.55.0
 
 ### Patch Changes

package/dist/module.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-nuxt",
-  "version": "8.55.0",
+  "version": "8.56.0",
   "configKey": "storefront",
   "compatibility": {
     "nuxt": "^3.9.0"

package/dist/module.mjs

@@ -54,7 +54,7 @@ export default {
 }`;
 }
 const PACKAGE_NAME = "@scayle/storefront-nuxt";
-const PACKAGE_VERSION = "8.55.0";
+const PACKAGE_VERSION = "8.56.0";
 const logger = createConsola({
   fancy: true,
   formatOptions: {

package/dist/runtime/context.js

@@ -143,6 +143,9 @@ export const buildContext = async (context) => {
     get refreshToken() {
       return session?.data?.refreshToken ?? void 0;
     },
+    get sessionCustomData() {
+      return session?.data?.customData ?? void 0;
+    },
     destroySession: session ? async () => {
       await session.destroy();
     } : void 0,
@@ -153,6 +156,10 @@ export const buildContext = async (context) => {
       session.data = data;
       await session.save();
     } : void 0,
+    updateSessionCustomData: session ? async (customData) => {
+      session.data.customData = customData;
+      await session.save();
+    } : void 0,
     updateUser: session ? async (user) => {
       session.data.user = user;
       await session.save();

package/dist/runtime/server/middleware/bootstrap.d.ts

@@ -1,16 +1,7 @@
-import type { ShopUser } from '@scayle/storefront-core';
-/**
- * Interface for shop session data.
- *
- * user: The shop user.
- * accessToken: The access token.
- * refreshToken: The refresh token.
- * shopId: The shop ID.
- */
+import type { ShopUser, SessionCustomData } from '@scayle/storefront-core';
+/** Interface for shop session data.*/
 export interface ShopSessionData {
-    /**
-     * The shop user object containing detailed information about the current user.
-     */
+    /** The shop user object containing detailed information about the current user. */
     user?: ShopUser;
     /**
      * The OAuth 2.0 access token.
@@ -23,6 +14,8 @@ export interface ShopSessionData {
      */
     refreshToken?: string;
     shopId?: number;
+    /** The session custom data to be stored in the session. */
+    customData?: SessionCustomData;
 }
 declare module '@scayle/h3-session' {
     interface SessionDataT extends ShopSessionData {

package/dist/test/factories.mjs

@@ -87,9 +87,11 @@ const rpcContextFactory = Factory.define(({ transientParams }) => {
       user: void 0,
       accessToken: void 0,
       refreshToken: void 0,
+      sessionCustomData: void 0,
       destroySession: () => Promise.resolve(),
       createUserBoundSession: () => Promise.resolve(),
       updateUser: () => Promise.resolve(),
+      updateSessionCustomData: () => Promise.resolve(),
       updateTokens: () => Promise.resolve()
     } : {
       wishlistKey: "logged-out-wishlist-key",
@@ -98,9 +100,11 @@ const rpcContextFactory = Factory.define(({ transientParams }) => {
       user: void 0,
       accessToken: void 0,
       refreshToken: void 0,
+      sessionCustomData: void 0,
       destroySession: void 0,
       createUserBoundSession: void 0,
       updateUser: void 0,
+      updateSessionCustomData: void 0,
       updateTokens: void 0
     }
   };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "8.55.0",
+  "version": "8.56.0",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -90,7 +90,7 @@
     "utility-types": "^3.11.0",
     "vue-router": "^4.4.0",
     "zod": "^4.0.0",
-    "@scayle/storefront-core": "8.55.0",
+    "@scayle/storefront-core": "8.56.0",
     "@scayle/unstorage-compression-driver": "1.2.4"
   },
   "devDependencies": {
@@ -103,7 +103,7 @@
     "@nuxt/schema": "3.20.0",
     "@nuxt/test-utils": "3.20.1",
     "@types/node": "22.19.1",
-    "@vitest/coverage-v8": "4.0.14",
+    "@vitest/coverage-v8": "4.0.15",
     "dprint": "0.50.2",
     "eslint-formatter-gitlab": "7.0.0",
     "eslint": "9.39.1",
@@ -116,10 +116,10 @@
     "publint": "0.3.15",
     "typescript": "5.9.3",
     "unbuild": "3.6.1",
-    "vitest": "4.0.14",
+    "vitest": "4.0.15",
     "vue-tsc": "3.1.5",
     "happy-dom": "20.0.11",
-    "@scayle/eslint-config-storefront": "4.7.15",
+    "@scayle/eslint-config-storefront": "4.7.16",
     "@scayle/eslint-plugin-vue-composable": "0.2.2",
     "@scayle/vitest-config-storefront": "1.0.0",
     "@scayle/unstorage-scayle-kv-driver": "2.0.9"