@scayle/storefront-core 8.60.1 → 8.61.0

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # @scayle/storefront-core
 
+## 8.61.0
+
+### Minor Changes
+
+- **[RPC]** `defineRpcHandler` now accepts an optional `method` option (`'GET' | 'POST' | 'PUT' | 'DELETE'`) to declare the HTTP method for the handler. Defaults to `'POST'`, so existing handlers behave exactly as before. Updated built-in RPC methods to use `GET` for safe, cacheable reads and `PUT`/`POST`/`DELETE` for mutations, enabling CDN and browser caching for public data fetches.
+
+  User- and session-specific RPCs (`getBasket`, `getUser`, `fetchUser`, `getWishlist`, `getAccessToken`, `getCheckoutToken`, `getOrderById`, `getCheckoutDataByCbd`, `getShopUserAddress`) intentionally stay on `POST` so their responses are never eligible for CDN or browser caching.
+
+  ```ts
+  import { defineRpcHandler, type RpcContext } from "@scayle/storefront-core";
+
+  // Safe, public read — eligible for CDN/browser caching
+  export const getNavigation = defineRpcHandler(
+    async (context: RpcContext) => {
+      /* ... */
+    },
+    { method: "GET" }
+  );
+
+  // User-specific / Mutation — uses POST to prevent cache leakage
+  export const getBasket = defineRpcHandler(
+    async (context: RpcContext) => {
+      /* ... */
+    }
+    // method defaults to 'POST'
+  );
+  ```
+
+### Patch Changes
+
+- Updated dependency `@scayle/storefront-api@workspace:*` to `@scayle/storefront-api@catalog:`
+- Updated dependency `@scayle/unstorage-scayle-kv-driver@workspace:*` to `@scayle/unstorage-scayle-kv-driver@catalog:`
+
 ## 8.60.1
 
 ### Patch Changes
@@ -58,33 +91,33 @@
   **Migration:**
 
   ```ts
-  import baseSlugify from 'slugify'
+  import baseSlugify from "slugify";
 
   const slugify = (url: string | undefined): string => {
-    return baseSlugify(url ?? '', {
+    return baseSlugify(url ?? "", {
       lower: true,
       remove: /[*+~.()'"!:@/#?]/g,
-    })
-  }
+    });
+  };
 
-  const localePath = useLocalePath()
+  const localePath = useLocalePath();
 
   const getProductDetailRoute = (
     id: number,
     name?: string,
-    locale?: Locale,
+    locale?: Locale
   ): string => {
     return localePath(
       {
-        name: 'p-productName-id',
+        name: "p-productName-id",
         params: {
           productName: slugify(name),
           id: `${id}`,
         },
       },
-      locale,
-    )
-  }
+      locale
+    );
+  };
   ```
 
 ## 8.59.1
@@ -265,10 +298,10 @@
   Example:
 
   ```ts
-  import { sha256 } from '@scayle/storefront-core'
+  import { sha256 } from "@scayle/storefront-core";
 
-  const hash = await sha256('hello')
-  console.log(hash) // '2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824'
+  const hash = await sha256("hello");
+  console.log(hash); // '2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824'
   ```
 
 ### Patch Changes
@@ -328,8 +361,8 @@
         customer: {
           groups: context.user?.groups,
         },
-      }
-    })
+      };
+    });
   ```
 
   For further information, please refer to the [Overriding Core RPC Methods](https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/technical-foundation/rpc-methods?sourceText=RPC%2520Methods#overriding-core-rpc-methods).
@@ -362,32 +395,32 @@
   #### Looking up by name (existing, now renamed):
 
   ```typescript
-  import { getAttributeValuesByName } from '@scayle/storefront-core'
+  import { getAttributeValuesByName } from "@scayle/storefront-core";
 
   // Single-select attribute
-  const sizes = getAttributeValuesByName(product.attributes, 'size')
+  const sizes = getAttributeValuesByName(product.attributes, "size");
   // Returns: [{ id: 1, label: 'M', value: 'medium' }]
 
   // Multi-select attribute
-  const colors = getAttributeValuesByName(product.attributes, 'color')
+  const colors = getAttributeValuesByName(product.attributes, "color");
   // Returns: [{ id: 1, label: 'Red' }, { id: 2, label: 'Blue' }]
 
   // Non-existent attribute
-  const missing = getAttributeValuesByName(product.attributes, 'doesNotExist')
+  const missing = getAttributeValuesByName(product.attributes, "doesNotExist");
   // Returns: []
   ```
 
   #### Looking up by group ID (new):
 
   ```typescript
-  import { getAttributeValuesByGroupId } from '@scayle/storefront-core'
+  import { getAttributeValuesByGroupId } from "@scayle/storefront-core";
 
   // Look up attribute by its numeric ID from the SCAYLE API
-  const promotionValues = getAttributeValuesByGroupId(product.attributes, 42)
+  const promotionValues = getAttributeValuesByGroupId(product.attributes, 42);
   // Returns: [{ id: 123, label: 'Summer Sale', value: 'summer-2024' }]
 
   // Non-existent attribute group
-  const missing = getAttributeValuesByGroupId(product.attributes, 9999)
+  const missing = getAttributeValuesByGroupId(product.attributes, 9999);
   // Returns: []
   ```
 
@@ -483,10 +516,10 @@
 
   ```ts
   const isComboDealType = (
-    promotion?: Promotion | null,
+    promotion?: Promotion | null
   ): promotion is Promotion<ComboDealEffect> => {
-    return promotion?.effect?.type === PromotionEffectType.COMBO_DEAL
-  }
+    return promotion?.effect?.type === PromotionEffectType.COMBO_DEAL;
+  };
   ```
 
 ### Patch Changes
@@ -758,23 +791,23 @@
 - Added `minReduction` and `maxReduction` filter parameters to `FetchProductsByCategoryParams.where` and `FetchFiltersParams.where` types, and updated the `getProductsByCategory` and `getFilters` RPC methods to accept and handle these new reduction-based filtering conditions.
 
   ```ts
-  const { data } = useRpc('getFilters', 'getFiltersKey', () => ({
+  const { data } = useRpc("getFilters", "getFiltersKey", () => ({
     where: {
       minReduction: 10,
       maxReduction: 20,
     },
-  }))
+  }));
 
   const { data } = useRpc(
-    'getProductsByCategory',
-    'getProductsByCategoryKey',
+    "getProductsByCategory",
+    "getProductsByCategoryKey",
     () => ({
       where: {
         minReduction: 10,
         maxReduction: 20,
       },
-    }),
-  )
+    })
+  );
   ```
 
 ## 8.30.3
@@ -805,28 +838,28 @@ No changes in this release.
 
   ```ts
   export const existingHandlerWithoutParams = async (_context: RpcContext) => {
-    return 'existing handler'
-  }
+    return "existing handler";
+  };
 
   export const existingHandlerWithParams = async (
     { name }: { name: string },
-    _context: RpcContext,
+    _context: RpcContext
   ) => {
-    return name
-  }
+    return name;
+  };
 
   // will become
 
   export const existingHandlerWithoutParams = defineRpcHandler(
     async (_context: RpcContext) => {
-      return 'existing handler'
-    },
-  )
+      return "existing handler";
+    }
+  );
   export const existingHandlerWithParams = defineRpcHandler(
     async ({ name }: { name: string }, _context: RpcContext) => {
-      return name
-    },
-  )
+      return name;
+    }
+  );
   ```
 
 ### Patch Changes
@@ -843,15 +876,15 @@ No changes in this release.
 - Added an optional `hideEmptyCategories` parameter to `getCategoryTree`. When enabled, the product count for each category is retrieved, and categories (including their children) without any products are removed. Enabling this option may increase response times, especially for large category trees.
 
   ```ts
-  import { rpcMethods } from '@scayle/storefront-core'
+  import { rpcMethods } from "@scayle/storefront-core";
 
-  rpcMethods.getCategoryTree({ hideEmptyCategories: true }, rpcContext)
+  rpcMethods.getCategoryTree({ hideEmptyCategories: true }, rpcContext);
   ```
 
   or
 
   ```ts
-  import { useCategoryTree } from '#storefront/composables'
+  import { useCategoryTree } from "#storefront/composables";
 
   const { data: rootCategories, status } = useCategoryTree(
     {
@@ -859,8 +892,8 @@ No changes in this release.
         hideEmptyCategories: true,
       },
     },
-    'category-navigation-tree',
-  )
+    "category-navigation-tree"
+  );
   ```
 
 ### Patch Changes
@@ -1292,12 +1325,12 @@ To get the default campaign key, you can call the RPC method:
 ```typescript
 // Before
 async function rpcMethod(context) {
-  const campaignKey = { context }
+  const campaignKey = { context };
   // ...
 }
 // After
 async function rpcMethod(context) {
-  const campaignKey = await context.callRpc?.('getCampaignKey')
+  const campaignKey = await context.callRpc?.("getCampaignKey");
   // ...
 }
 ```
@@ -1486,43 +1519,43 @@ See [Overriding core RPC Methods](https://scayle.dev/en/core-documentation/store
 
     ```ts
     const BadgeLabel = {
-      NEW: 'new',
-      SOLD_OUT: 'sold_out',
-      ONLINE_EXCLUSIVE: 'online_exclusive',
-      SUSTAINABLE: 'sustainable',
-      PREMIUM: 'premium',
-      DEFAULT: '',
-    } as const
+      NEW: "new",
+      SOLD_OUT: "sold_out",
+      ONLINE_EXCLUSIVE: "online_exclusive",
+      SUSTAINABLE: "sustainable",
+      PREMIUM: "premium",
+      DEFAULT: "",
+    } as const;
 
     type BadgeLabelParamsKeys =
-      | 'isNew'
-      | 'isSoldOut'
-      | 'isOnlineOnly'
-      | 'isSustainable'
-      | 'isPremium'
-    type BadgeLabelParams = Partial<Record<BadgeLabelParamsKeys, boolean>>
+      | "isNew"
+      | "isSoldOut"
+      | "isOnlineOnly"
+      | "isSustainable"
+      | "isPremium";
+    type BadgeLabelParams = Partial<Record<BadgeLabelParamsKeys, boolean>>;
 
     const getBadgeLabel = (params: BadgeLabelParams = {}): string => {
       if (!params) {
-        return BadgeLabel.DEFAULT
+        return BadgeLabel.DEFAULT;
       }
       const { isNew, isSoldOut, isOnlineOnly, isSustainable, isPremium } =
-        params
+        params;
 
       if (isNew) {
-        return BadgeLabel.NEW
+        return BadgeLabel.NEW;
       } else if (isSoldOut) {
-        return BadgeLabel.SOLD_OUT
+        return BadgeLabel.SOLD_OUT;
       } else if (isOnlineOnly) {
-        return BadgeLabel.ONLINE_EXCLUSIVE
+        return BadgeLabel.ONLINE_EXCLUSIVE;
       } else if (isSustainable) {
-        return BadgeLabel.SUSTAINABLE
+        return BadgeLabel.SUSTAINABLE;
       } else if (isPremium) {
-        return BadgeLabel.PREMIUM
+        return BadgeLabel.PREMIUM;
       } else {
-        return BadgeLabel.DEFAULT
+        return BadgeLabel.DEFAULT;
       }
-    }
+    };
     ```
 
 - **\[💥 BREAKING\]** We've standardized our configuration to use `sapi` (Storefront API) throughout the codebase, replacing the deprecated `bapi` keyword. This change improves clarity and consistency by removing the `initBapi` function, replacing the `bapiClient` property with `sapiClient` within the `RPCContext`, and updating all code references accordingly. `BapiConfig` is not exported anymore and has been superseded by `SapiConfig`.
@@ -1538,15 +1571,15 @@ See [Overriding core RPC Methods](https://scayle.dev/en/core-documentation/store
         storefront: {
           // ...
           bapi: {
-            host: '...',
-            token: '...',
+            host: "...",
+            token: "...",
           },
           // ...
         },
         // ...
       },
       // ...
-    }
+    };
     ```
 
   - _Legacy Environment Variables:_
@@ -1566,15 +1599,15 @@ See [Overriding core RPC Methods](https://scayle.dev/en/core-documentation/store
         storefront: {
           // ...
           sapi: {
-            host: '...',
-            token: '...',
+            host: "...",
+            token: "...",
           },
           // ...
         },
         // ...
       },
       // ...
-    }
+    };
     ```
 
   - _New Environment Variables:_
@@ -1592,19 +1625,19 @@ See [Overriding core RPC Methods](https://scayle.dev/en/core-documentation/store
 
     ```ts
     const { data, fetching, fetch, error, status } = useUser(
-      'getUser',
+      "getUser"
       // ...
-    )
-    data.value.user.authentication.storefrontAccessToken
+    );
+    data.value.user.authentication.storefrontAccessToken;
     ```
 
   - _Current Usage of dedicated `getAccessToken` RPC method:_
 
     ```ts
     const { data: accessToken } = useRpc(
-      'getAccessToken',
+      "getAccessToken"
       // ...
-    )
+    );
     ```
 
 - **\[💥 BREAKING\]** We've enhanced security for basket and wishlist keys by switching the default hashing algorithm from MD5 to the more robust SHA256.
@@ -1627,7 +1660,7 @@ See [Overriding core RPC Methods](https://scayle.dev/en/core-documentation/store
         // ...
       },
       // ...
-    })
+    });
     ```
 
 - **\[💥 BREAKING\]** The attribute `loginShopId` is removed from the `ShopUser` interface as the shop now uses session cookies.
@@ -1636,23 +1669,23 @@ See [Overriding core RPC Methods](https://scayle.dev/en/core-documentation/store
   - _Previous Usage of `searchProducts` RPC method:_
 
     ```ts
-    const getSearchSuggestionsRpc = useRpcCall('searchProducts')
+    const getSearchSuggestionsRpc = useRpcCall("searchProducts");
 
     data.value = await searchProducts({
       term: String(searchQuery.value),
       ...params,
-    })
+    });
     ```
 
   - _Current Usage of `getSearchSuggestions` RPC method:_
 
     ```ts
-    const getSearchSuggestionsRpc = useRpcCall('getSearchSuggestions')
+    const getSearchSuggestionsRpc = useRpcCall("getSearchSuggestions");
 
     data.value = await getSearchSuggestionsRpc({
       term: String(searchQuery.value),
       ...params,
-    })
+    });
     ```
 
 - **\[💥 BREAKING\]** Improved basket updating: Adding an item to your basket with a reduced quantity will now correctly update the basket contents.

package/dist/api/INFO.md

@@ -4,4 +4,4 @@
 
 This directory is the home of "mini" API clients. While some SCAYLE APIs provide a TypeScript SDK as an npm package (e.g. SAPI) others do not. When the API is simple enough, we may create a "mini" SDK within `storefront-core`. This way we can provide a TypeScript native abstraction over the API but not suffer the overhead of an additional package to maintain.
 
-The SDKs created here should generally be a single file. The goal should be to make them as self-contained as possible, but it is ok if they need to pull a type or utility function from elsewhere in `storefront-core`.
+The SDKs created here should generally be a single file. The goal should be to make them as self-contained as possible, but it is ok if they need to pull a type or utility function from elsewhere in `storefront-core`.

package/dist/cache/providers/unstorage.mjs

@@ -53,7 +53,9 @@ export class UnstorageCache {
    * @param tag The tag to purge.
    */
   async purgeTag(tag) {
-    const keys = await this.storage.getItem(this.getKey(`tag:${tag}`));
+    const keys = await this.storage.getItem(
+      this.getKey(`tag:${tag}`)
+    );
     await this.purgeKeys(keys ?? []);
     await this.storage.removeItem(this.getKey(`tag:${tag}`));
   }

package/dist/constants/withParameters.mjs

@@ -67,7 +67,14 @@ const MIN_WITH_PARAMS_BASKET = {
       },
       variants: {
         attributes: {
-          withKey: ["brand", "name", "price", "size", "shopSize", "vendorSize"]
+          withKey: [
+            "brand",
+            "name",
+            "price",
+            "size",
+            "shopSize",
+            "vendorSize"
+          ]
         }
       },
       images: {
@@ -96,7 +103,14 @@ const MIN_WITH_PARAMS_WISHLIST = {
       },
       variants: {
         attributes: {
-          withKey: ["brand", "name", "price", "size", "shopSize", "vendorSize"]
+          withKey: [
+            "brand",
+            "name",
+            "price",
+            "size",
+            "shopSize",
+            "vendorSize"
+          ]
         }
       },
       images: {

package/dist/helpers/productHelpers.mjs

@@ -50,7 +50,9 @@ export const getAllSizesFromVariants = (variantsAttributes, attributeName = "sho
   const array = variantsAttributes.map(
     (variant) => getFirstAttributeValue(variant.attributes, attributeName)
   ).filter(Boolean);
-  return [...new Map(array.map((item) => [item?.id ?? item, item])).values()];
+  return [
+    ...new Map(array.map((item) => [item?.id ?? item, item])).values()
+  ];
 };
 export const getProductSiblings = (product, colorAttributeName = "colorDetail") => {
   if (!product) {

package/dist/helpers/sanitizationHelpers.mjs

@@ -15,7 +15,10 @@ export const purifySensitiveData = (data = {}, blacklistedKeys = ["password", "t
         (excludedKey) => key.includes(excludedKey)
       );
       if (isSensitiveData && value) {
-        purifiedPayload[key] = purifySensitiveValue(value, showFirstAndLastChar);
+        purifiedPayload[key] = purifySensitiveValue(
+          value,
+          showFirstAndLastChar
+        );
       } else {
         purifiedPayload[key] = value;
       }

package/dist/rpc/methods/basket/basket.mjs

@@ -95,7 +95,7 @@ export const addItemToBasket = defineRpcHandler(async ({
       }
     );
   }
-});
+}, { method: "PUT" });
 export const addItemsToBasket = defineRpcHandler(async (params, context) => {
   if (!hasSession(context)) {
     return new ErrorResponse(
@@ -162,7 +162,7 @@ export const addItemsToBasket = defineRpcHandler(async (params, context) => {
       }
     );
   }
-});
+}, { method: "PUT" });
 export const getBasket = defineRpcHandler(async (options, context) => {
   if (!hasSession(context)) {
     return new ErrorResponse(
@@ -200,7 +200,7 @@ export const getBasket = defineRpcHandler(async (options, context) => {
     );
   }
   return { basket: response.basket };
-});
+}, { method: "POST" });
 export const removeItemFromBasket = defineRpcHandler(async (options, context) => {
   if (!hasSession(context)) {
     return new ErrorResponse(
@@ -235,7 +235,7 @@ export const removeItemFromBasket = defineRpcHandler(async (options, context) =>
     );
   }
   return { basket: response };
-});
+}, { method: "DELETE" });
 export const clearBasket = defineRpcHandler(
   async (context) => {
     const getBasketResponse = await getBasket({}, context);
@@ -253,7 +253,8 @@ export const clearBasket = defineRpcHandler(
       }
     }
     return true;
-  }
+  },
+  { method: "DELETE" }
 );
 export const mergeBaskets = defineRpcHandler(async ({ fromBasketKey, toBasketKey, with: _with, orderCustomData }, context) => {
   const resolvedWith = getWithParams(
@@ -270,7 +271,7 @@ export const mergeBaskets = defineRpcHandler(async ({ fromBasketKey, toBasketKey
     },
     context
   );
-});
+}, { method: "POST" });
 export const updateBasketItem = defineRpcHandler(async ({ basketItemKey, update, with: _with, orderCustomData }, context) => {
   if (!hasSession(context)) {
     return new ErrorResponse(
@@ -317,7 +318,7 @@ export const updateBasketItem = defineRpcHandler(async ({ basketItemKey, update,
       }
     );
   }
-});
+}, { method: "PUT" });
 export const getApplicablePromotionsByCode = defineRpcHandler(async ({ promotionCode, with: _with }, context) => {
   if (!hasSession(context)) {
     return new ErrorResponse(
@@ -358,7 +359,7 @@ export const getApplicablePromotionsByCode = defineRpcHandler(async ({ promotion
   } else {
     return { basket: result.basket };
   }
-});
+}, { method: "POST" });
 export const updatePromotions = defineRpcHandler(async (params, context) => {
   if (!hasSession(context)) {
     return new ErrorResponse(
@@ -398,7 +399,7 @@ export const updatePromotions = defineRpcHandler(async (params, context) => {
     );
   }
   return { basket: result.basket };
-});
+}, { method: "PUT" });
 function parseBasketError(response) {
   const parsedError = {
     message: "",

package/dist/rpc/methods/brands.mjs

@@ -11,7 +11,7 @@ export const getBrands = defineRpcHandler(async ({ pagination }, context) => {
       perPage: pagination?.perPage ? Math.min(pagination.perPage, MAX_PER_PAGE) : void 0
     }
   });
-});
+}, { method: "GET" });
 export const getBrandById = defineRpcHandler(async ({ brandId }, context) => {
   const { sapiClient, cached } = context;
   return await cached(
@@ -20,4 +20,4 @@ export const getBrandById = defineRpcHandler(async ({ brandId }, context) => {
       cacheKeyPrefix: `getBrandById-${brandId}`
     }
   )(brandId);
-});
+}, { method: "GET" });

package/dist/rpc/methods/campaign.mjs

@@ -22,7 +22,7 @@ const getCampaigns = async (context) => {
 export const getCampaign = defineRpcHandler(async (context) => {
   const campaigns = await getCampaigns(context);
   return campaigns.find(isCampaignActive);
-});
+}, { method: "GET" });
 export const getCampaignKey = defineRpcHandler(async (context) => {
   if (context.campaignKey) {
     return context.campaignKey;
@@ -30,4 +30,4 @@ export const getCampaignKey = defineRpcHandler(async (context) => {
   const campaigns = await getCampaigns(context);
   const campaign = campaigns.find(isCampaignActive);
   return campaign?.key;
-});
+}, { method: "GET" });

package/dist/rpc/methods/categories.mjs

@@ -13,7 +13,7 @@ export const getRootCategories = defineRpcHandler(async ({ children = 1, include
     categories: result,
     activeNode: void 0
   };
-});
+}, { method: "GET" });
 export const getCategoryByPath = defineRpcHandler(async ({ path, children = 1, includeHidden, properties, includeProductSorting }, context) => {
   const { cached, sapiClient } = context;
   const sanitizedPath = splitAndRemoveEmpty(path);
@@ -26,7 +26,7 @@ export const getCategoryByPath = defineRpcHandler(async ({ path, children = 1, i
     with: { children, properties, includeProductSorting },
     includeHidden
   });
-});
+}, { method: "GET" });
 export const getCategoriesByPath = defineRpcHandler(async ({ path, children = 1, includeHidden, properties, includeProductSorting }, context) => {
   const { cached, sapiClient } = context;
   if (path === "/") {
@@ -79,7 +79,7 @@ export const getCategoriesByPath = defineRpcHandler(async ({ path, children = 1,
     lastNode = rootPath[i];
   }
   return { categories: tree, activeNode: result };
-});
+}, { method: "GET" });
 export const getCategoryById = defineRpcHandler(async ({ id, children = 1, includeHidden, properties, includeProductSorting }, context) => {
   const { cached, sapiClient } = context;
   return await cached(
@@ -96,7 +96,7 @@ export const getCategoryById = defineRpcHandler(async ({ id, children = 1, inclu
     },
     includeHidden
   });
-});
+}, { method: "GET" });
 export const getCategoryTree = defineRpcHandler(async ({
   children,
   includeHidden,
@@ -143,4 +143,4 @@ export const getCategoryTree = defineRpcHandler(async ({
   return categoryTree.filter(
     (category) => categoryProductCountTable[category.id] > 0
   );
-});
+}, { method: "GET" });

package/dist/rpc/methods/cbd.mjs

@@ -54,4 +54,4 @@ export const getOrderDataByCbd = defineRpcHandler(async ({ cbdToken }, context)
       detail: `Fetching order failed with status code ${response.status}`
     }
   );
-});
+}, { method: "POST" });