@scayle/storefront-core 7.69.0 → 7.69.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @scayle/storefront-core
 
+## 7.69.1
+
+### Patch Changes
+
+- Extend `FetchProductsByCategoryParams` type to support `trackSearchAnalyticsEvent?: boolean`
+- Allow passing of the `trackSearchAnalyticsEvent` parameter into the `getProductsByCategory` RPC method.
+  **NOTE**: To prevent logging the search term on every page request when when paginating with the `page` parameter, the `trackSearchAnalyticsEvent` parameter is only passed on the first page (`page === 1`).
+  For more details on how to utilize this, check the [SCAYLE Search Analytics section](https://scayle.dev/en/developer-guide/products/search#scayle-search-analytics) in the SCAYLE Resource Center.
+
 ## 7.69.0
 
 ### Minor Changes

package/dist/rpc/methods/checkout/checkout.cjs

@@ -37,7 +37,7 @@ const getCheckoutToken = exports.getCheckoutToken = async function getCheckoutTo
     carrier,
     basketId: context.basketKey,
     campaignKey: context.campaignKey
-  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"7.69.0"}`).setProtectedHeader({
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"7.69.1"}`).setProtectedHeader({
     alg: "HS256",
     typ: "JWT"
   }).sign(secret);

package/dist/rpc/methods/checkout/checkout.mjs

@@ -35,7 +35,7 @@ export const getCheckoutToken = async function getCheckoutToken2(jwtPayload = {}
     carrier,
     basketId: context.basketKey,
     campaignKey: context.campaignKey
-  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"7.69.0"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"7.69.1"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
   return {
     accessToken: refreshedAccessToken,
     checkoutJwt

package/dist/rpc/methods/products.cjs

@@ -248,7 +248,8 @@ const getProductsByCategory = exports.getProductsByCategory = async function get
     pricePromotionKey = "",
     includeSellableForFree = void 0,
     includeSoldOut = void 0,
-    orFiltersOperator = void 0
+    orFiltersOperator = void 0,
+    trackSearchAnalyticsEvent = void 0
   } = params;
   const {
     cached,
@@ -290,7 +291,13 @@ const getProductsByCategory = exports.getProductsByCategory = async function get
     orFiltersOperator,
     pricePromotionKey,
     with: _with ?? context.withParams?.product ?? _constants.MIN_WITH_PARAMS_PRODUCT,
-    sort
+    sort,
+    // NOTE: We only pass the parameter value through and don't implement a custom check.
+    // The consuming project should not include trackSearchAnalyticsEvent parameter when paginating through
+    // results with the page parameter, as this logs the search term on every page request.
+    // Instead, log the term only once, when the search is first performed.
+    // https://scayle.dev/en/developer-guide/products/search#scayle-search-analytics
+    trackSearchAnalyticsEvent
   });
   return {
     products,

package/dist/rpc/methods/products.mjs

@@ -228,7 +228,8 @@ export const getProductsByCategory = async function getProductsByCategory2(param
     pricePromotionKey = "",
     includeSellableForFree = void 0,
     includeSoldOut = void 0,
-    orFiltersOperator = void 0
+    orFiltersOperator = void 0,
+    trackSearchAnalyticsEvent = void 0
   } = params;
   const { cached, sapiClient, campaignKey } = context;
   const { category, categoryId } = await resolveCategoryIdFromParams(
@@ -274,7 +275,13 @@ export const getProductsByCategory = async function getProductsByCategory2(param
     orFiltersOperator,
     pricePromotionKey,
     with: _with ?? context.withParams?.product ?? MIN_WITH_PARAMS_PRODUCT,
-    sort
+    sort,
+    // NOTE: We only pass the parameter value through and don't implement a custom check.
+    // The consuming project should not include trackSearchAnalyticsEvent parameter when paginating through
+    // results with the page parameter, as this logs the search term on every page request.
+    // Instead, log the term only once, when the search is first performed.
+    // https://scayle.dev/en/developer-guide/products/search#scayle-search-analytics
+    trackSearchAnalyticsEvent
   });
   return {
     products,

package/dist/types/sapi/product.d.ts

@@ -62,6 +62,7 @@ export type FetchProductsByCategoryParams = {
     includeSellableForFree?: boolean;
     includeSoldOut?: boolean;
     orFiltersOperator?: ProductsSearchEndpointParameters['orFiltersOperator'];
+    trackSearchAnalyticsEvent?: boolean;
 } & ({
     category?: string;
     categoryId?: undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "7.69.0",
+  "version": "7.69.1",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -85,7 +85,7 @@
     "@types/crypto-js": "4.2.2",
     "@types/node": "22.9.0",
     "@types/webpack-env": "1.18.5",
-    "@vitest/coverage-v8": "2.1.4",
+    "@vitest/coverage-v8": "2.1.5",
     "dprint": "0.47.5",
     "eslint": "9.14.0",
     "eslint-formatter-gitlab": "5.1.0",
@@ -95,7 +95,7 @@
     "typescript": "5.6.3",
     "unbuild": "2.0.0",
     "unstorage": "1.13.1",
-    "vitest": "2.1.4"
+    "vitest": "2.1.5"
   },
   "optionalDependencies": {
     "redis": "4"