@scayle/storefront-nuxt 8.0.1 → 8.1.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @scayle/storefront-nuxt
 
+## 8.1.0
+
+### Minor Changes
+
+- **Breaking:** `useBasket` no longer accepts `orderCustomData` in its parameters. This functionality was unintentionally added and was never officially supported. Now it has been removed.
+
 ## 8.0.1
 
 ### Patch Changes

package/dist/module.json

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

package/dist/module.mjs

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

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

@@ -4,7 +4,7 @@ import { type NormalizedRpcResponse, type UseRpcReturn } from '../core/useRpc.js
 import { type MaybeRefOrGetter, type ComputedRef, type Ref } from 'vue';
 import type { BasketKey, BasketPackageInformation } from '@scayle/storefront-api';
 type UseBasketOptions = Partial<{
-    params: MaybeRefOrGetter<RpcMethodParameters<'getBasket'>>;
+    params: MaybeRefOrGetter<Omit<RpcMethodParameters<'getBasket'>, 'orderCustomData'>>;
     key: string;
 }>;
 type UseBasketBaseReturn = Omit<Awaited<UseRpcReturn<'getBasket'>>, 'data'> & {

package/dist/runtime/composables/storefront/useBasket.js

@@ -14,7 +14,6 @@ import {
 import { useRpcCall } from "../core/useRpcCall.js";
 import {
   toValue,
-  toRef,
   computed
 } from "vue";
 import { FetchError } from "ofetch";
@@ -26,10 +25,18 @@ export function useBasket({
   const mergeBasketsRpc = useRpcCall("mergeBaskets");
   const clearBasketRpc = useRpcCall("clearBasket");
   const removeItemFromBasketRpc = useRpcCall("removeItemFromBasket");
-  const asyncData = useRpc("getBasket", key, params, {
+  const sanitizedParams = computed(() => {
+    const rawParams = toValue(params);
+    if (rawParams && "orderCustomData" in rawParams) {
+      const { orderCustomData, ...sanitized } = rawParams;
+      return sanitized;
+    }
+    return rawParams;
+  });
+  const asyncData = useRpc("getBasket", key, sanitizedParams, {
     server: false,
     // NOTE: In some cases it might be ok to fetch on server
-    watch: [toRef(params)],
+    watch: [sanitizedParams],
     dedupe: "defer",
     transform: (basketResponse) => basketResponse.basket,
     getCachedData: (key2, nuxtApp) => {
@@ -60,7 +67,7 @@ export function useBasket({
         displayData,
         customData,
         itemGroup,
-        with: toValue(params)
+        with: toValue(sanitizedParams)
       });
       data.value = basket;
       handleBasketError(basketErrors);
@@ -73,7 +80,7 @@ export function useBasket({
       const { basket, errors: basketErrors } = await addItemsToBasketRpc({
         items: items2,
         existingItemHandling,
-        with: toValue(params)
+        with: toValue(sanitizedParams)
       });
       data.value = basket;
       handleBasketError(basketErrors);
@@ -104,7 +111,7 @@ export function useBasket({
   const mergeBaskets = async (args) => {
     return await mergeBasketsRpc({
       ...args,
-      with: toValue(params)
+      with: toValue(sanitizedParams)
     });
   };
   const findItem = (item) => {
@@ -127,14 +134,14 @@ export function useBasket({
     }
     const { basket } = await removeItemFromBasketRpc({
       itemKey: element.key,
-      with: toValue(params)
+      with: toValue(sanitizedParams)
     });
     data.value = basket;
   };
   const removeItemByKey = async (itemKey) => {
     const { basket } = await removeItemFromBasketRpc({
       itemKey,
-      with: toValue(params)
+      with: toValue(sanitizedParams)
     });
     data.value = basket;
   };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "8.0.1",
+  "version": "8.1.0",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",