@scayle/storefront-nuxt 7.51.1 → 7.52.0

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @scayle/storefront-nuxt
 
+## 7.52.0
+
+### Minor Changes
+
+- Allow the session of an `RpcContext` to be undefined
+
+  BREAKING: This changes the structure of the `RpcContext`, so it may be a breaking change if you have written custom RPC methods.
+
+  The affected properties on the `RpcContext` are `sessionId`, `wishlistKey` and `basketKey` and the affected methods are `destroySession`, `createUserBoundSession`, `updateUser`, and `updateTokens`. If you use these methods or properties in a custom RPC method, make sure that you handle the case where they might be undefined. TypeScript will also catch these cases if you have `strictNullChecks` enabled.
+
+  You can check `context.sessionId` (or another session-dependent property) to determine if the session is present. If one of these properties is present, all will be. Alternatively, you can call `assertSession(context)` before referencing any properties on the context. If the session is not present, an error will be thrown. For any usage of `context` after `assertSession` is called, TypeScript will understand that the session properties are present.
+
+- Do not attach session for cached request
+
+### Patch Changes
+
+- Updated dependencies
+  - @scayle/storefront-core@7.38.0
+
+## 7.51.2
+
+### Patch Changes
+
+- Updated to `nuxt@3.9.3` and `vue@3.4.15` (\__For more details check the [Nuxt 3.9.3 Release Notes](https://github.com/nuxt/nuxt/releases/tag/v3.9.3) and [Vue 3.4.15 Changelogs](https://github.com/vuejs/core/blob/main/CHANGELOG.md#3415-2024-01-18)_)
+
+  **NOTE: The minimum supported versions of the `@scayle/storefront-nuxt` package are `nuxt >=3.9.0` and `vue >=3.4.0`. Please update your application stack accordingly.**
+
+- useRpc - clear error state when re-fetching
+
 ## 7.51.1
 
 ### Patch Changes

package/dist/module.json

@@ -4,5 +4,5 @@
   "compatibility": {
     "nuxt": "^3.9.0"
   },
-  "version": "7.51.0"
+  "version": "7.51.2"
 }

package/dist/runtime/composables/core/useRpc.mjs

@@ -32,6 +32,7 @@ export const useRpc = async (method, key, params, options = { autoFetch: true, l
     try {
       status.value = "pending";
       fetching.value = true;
+      error.value = void 0;
       const apiBasePath = currentShop.value?.apiBasePath ?? "/api";
       const fetch2 = getFetch(nuxtApp, log);
       data.value = await unwrap(

package/dist/runtime/composables/storefront/useBasket.d.ts

@@ -44,7 +44,7 @@ export declare function useBasket({ params, options, key, }?: UseBasketOptions):
         shopId: string;
         userId: string;
         log?: import("@scayle/storefront-core").Log | undefined;
-    }) => Promise<any>;
+    }) => Promise<string>;
     mergeBaskets: (args: {
         fromBasketKey: string;
         toBasketKey: string;

package/dist/runtime/context.d.ts

@@ -7,8 +7,8 @@ export interface ContextBuilderOptions {
     $shopConfig: ShopConfig;
     $storefront: StorefrontConfig;
     $log: Log;
-    sessionId: string;
-    session: Session;
+    sessionId?: string;
+    session?: Session;
     config: RuntimeConfig;
 }
 export declare const buildContext: (context: ContextBuilderOptions) => Promise<RpcContext>;

package/dist/runtime/context.mjs

@@ -4,8 +4,72 @@ import {
   generateBasketKey,
   generateWishlistKey
 } from "@scayle/storefront-core/dist/utils/keys";
+async function getWishlistKey(appKeys, session, $log, $shopConfig) {
+  return session.data.user ? await generateWishlistKey({
+    keyTemplate: appKeys.wishlistKey,
+    userId: String(session.data.user.id),
+    shopId: String($shopConfig.shopId),
+    hashAlgorithm: appKeys.hashAlgorithm,
+    log: $log
+  }) : session.id;
+}
+async function getBasketKey(appKeys, session, $log, $shopConfig) {
+  return session.data.user ? await generateBasketKey({
+    keyTemplate: appKeys.basketKey,
+    userId: String(session.data.user.id),
+    shopId: String($shopConfig.shopId),
+    hashAlgorithm: appKeys.hashAlgorithm,
+    log: $log
+  }) : session?.id;
+}
+async function sessionProperties(context) {
+  const { $shopConfig, $storefront, $log, session } = context;
+  const appKeys = $shopConfig.appKeys ?? $storefront.appKeys;
+  if (session) {
+    return {
+      wishlistKey: await getWishlistKey(appKeys, session, $log, $shopConfig),
+      basketKey: await getBasketKey(appKeys, session, $log, $shopConfig),
+      sessionId: session.id,
+      get user() {
+        return session.data?.user ?? void 0;
+      },
+      get accessToken() {
+        return session.data?.accessToken ?? void 0;
+      },
+      destroySession: async () => {
+        await session.destroy();
+      },
+      createUserBoundSession: async () => {
+        $log.debug("creating user bound session");
+        const data = session.data;
+        await session.regenerate();
+        session.data = data;
+        await session.save();
+      },
+      updateUser: async (user) => {
+        session.data.user = user;
+        await session.save();
+      },
+      updateTokens: async (tokens) => {
+        Object.assign(session.data, tokens);
+        await session.save();
+      }
+    };
+  }
+  return {
+    wishlistKey: void 0,
+    basketKey: void 0,
+    sessionId: void 0,
+    user: void 0,
+    accessToken: void 0,
+    destroySession: void 0,
+    createUserBoundSession: void 0,
+    updateUser: void 0,
+    updateTokens: void 0
+  };
+}
 export const buildContext = async (context) => {
-  const { $cache, $shopConfig, $storefront, $log, session, config } = context;
+  const { $cache, $shopConfig, $storefront, $log, config } = context;
   const bapiConfig = $shopConfig.bapi ?? $storefront.bapi;
   const appKeys = $shopConfig.appKeys ?? $storefront.appKeys;
   const idpConfig = $shopConfig.idp ?? $storefront.idp;
@@ -17,20 +81,7 @@ export const buildContext = async (context) => {
       authentication: "token",
       token: bapiConfig.token
     }),
-    wishlistKey: session.data.user ? await generateWishlistKey({
-      keyTemplate: appKeys.wishlistKey,
-      userId: String(session.data.user.id),
-      shopId: String($shopConfig.shopId),
-      hashAlgorithm: appKeys.hashAlgorithm,
-      log: $log
-    }) : session.id,
-    basketKey: session.data.user ? await generateBasketKey({
-      keyTemplate: appKeys.basketKey,
-      userId: String(session.data.user.id),
-      shopId: String($shopConfig.shopId),
-      hashAlgorithm: appKeys.hashAlgorithm,
-      log: $log
-    }) : session.id,
+    ...await sessionProperties(context),
     auth: {
       resetPasswordUrl: $shopConfig.auth?.resetPasswordUrl
     },
@@ -48,21 +99,8 @@ export const buildContext = async (context) => {
     },
     idp: idpConfig,
     log: $log,
-    get user() {
-      return session.data?.user ?? void 0;
-    },
-    destroySession: async () => {
-      await session.destroy();
-    },
     destroySessionsForUserId: async () => {
     },
-    createUserBoundSession: async () => {
-      $log.debug("creating user bound session");
-      const data = session.data;
-      await session.regenerate();
-      session.data = data;
-      await session.save();
-    },
     generateBasketKeyForUserId: (userId) => generateBasketKey({
       keyTemplate: appKeys.basketKey,
       userId,
@@ -83,18 +121,6 @@ export const buildContext = async (context) => {
     domain: $shopConfig.domain,
     withParams: $storefront.withParams,
     campaignKey: $shopConfig.storeCampaignKeyword,
-    updateUser: async (user) => {
-      session.data.user = user;
-      await session.save();
-    },
-    sessionId: context.sessionId,
-    get accessToken() {
-      return session.data?.accessToken ?? void 0;
-    },
-    updateTokens: async (tokens) => {
-      Object.assign(session.data, tokens);
-      await session.save();
-    },
     runtimeConfiguration: config
   };
 };

package/dist/runtime/server/middleware/bootstrap.mjs

@@ -85,13 +85,17 @@ async function bootstrap(event, url, $shopConfig, $storefrontConfig, apiBasePath
   );
   event.context.$cache = $cache;
   bootstrapLog.debug("Building context for request");
+  const cacheableRoute = !!event.context._nitro.routeRules.cache;
+  if (cacheableRoute) {
+    bootstrapLog.debug("Skipping session for cached request");
+  }
   event.context.$rpcContext = await buildContext({
     $cache,
     $shopConfig,
     $storefront: $storefrontConfig,
     $log: log,
-    sessionId: event.context.sessionId,
-    session: event.context.session,
+    sessionId: cacheableRoute ? void 0 : event.context.sessionId,
+    session: cacheableRoute ? void 0 : event.context.session,
     config
   });
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "7.51.1",
+  "version": "7.52.0",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -60,13 +60,13 @@
     "test:watch": "vitest watch"
   },
   "dependencies": {
-    "@nuxt/kit": "3.9.2",
+    "@nuxt/kit": "3.9.3",
     "@scayle/h3-session": "0.3.5",
-    "@scayle/storefront-core": "7.37.0",
+    "@scayle/storefront-core": "7.38.0",
     "@scayle/unstorage-compression-driver": "0.1.1",
     "@vueuse/core": "10.7.2",
     "consola": "3.2.3",
-    "core-js": "3.35.0",
+    "core-js": "3.35.1",
     "defu": "6.1.4",
     "h3": "1.10.0",
     "jose": "^5.2.0",
@@ -81,7 +81,7 @@
   },
   "devDependencies": {
     "@nuxt/module-builder": "0.5.5",
-    "@nuxt/schema": "3.9.2",
+    "@nuxt/schema": "3.9.3",
     "@nuxt/test-utils": "3.10.0",
     "@scayle/eslint-config-storefront": "3.2.6",
     "@scayle/prettier-config-storefront": "2.0.2",
@@ -89,7 +89,7 @@
     "eslint": "8.56.0",
     "eslint-formatter-gitlab": "5.1.0",
     "node-mocks-http": "1.14.1",
-    "nuxt": "3.9.2",
+    "nuxt": "3.9.3",
     "prettier": "3.0.0",
     "publint": "0.2.7",
     "vitest": "1.2.1",
@@ -102,17 +102,17 @@
   },
   "resolutions": {
     "h3": "1.10.1",
-    "@vue/compiler-core": "3.4.14",
-    "@vue/shared": "3.4.14",
-    "@vue/compiler-dom": "3.4.14",
-    "@vue/compiler-sfc": "3.4.14",
-    "@vue/compiler-ssr": "3.4.14",
-    "@vue/reactivity": "3.4.14",
-    "@vue/runtime-core": "3.4.14",
-    "@vue/runtime-dom": "3.4.14",
-    "@vue/server-renderer": "3.4.14",
-    "@nuxt/kit": "3.9.2",
-    "@nuxt/schema": "3.9.2"
+    "@vue/compiler-core": "3.4.15",
+    "@vue/shared": "3.4.15",
+    "@vue/compiler-dom": "3.4.15",
+    "@vue/compiler-sfc": "3.4.15",
+    "@vue/compiler-ssr": "3.4.15",
+    "@vue/reactivity": "3.4.15",
+    "@vue/runtime-core": "3.4.15",
+    "@vue/runtime-dom": "3.4.15",
+    "@vue/server-renderer": "3.4.15",
+    "@nuxt/kit": "3.9.3",
+    "@nuxt/schema": "3.9.3"
   },
   "volta": {
     "node": "20.11.0"