@scayle/storefront-core 7.68.0 → 7.69.1

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @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
+
+- Move test factories to separate entry point. They are now available via `@scayle/storefront-core/dist/test/factories` (or `@scayle/storefront-core/test/factories` when `moduleResolution` is set to `Bundler`.
+
+### Patch Changes
+
+**Dependencies**
+
+- Updated dependency to @scayle/storefront-api@17.11.0
+
 ## 7.68.0
 
 ### Minor Changes

package/dist/index.cjs

@@ -6,13 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 var _exportNames = {
   rpcMethods: true,
   APISortOption: true,
-  APISortOrder: true,
-  attributeGroupFactory: true,
-  advancedAttributeFactory: true,
-  categoryFactory: true,
-  productFactory: true,
-  priceFactory: true,
-  variantFactory: true
+  APISortOrder: true
 };
 Object.defineProperty(exports, "APISortOption", {
   enumerable: true,
@@ -26,43 +20,7 @@ Object.defineProperty(exports, "APISortOrder", {
     return _storefrontApi.APISortOrder;
   }
 });
-Object.defineProperty(exports, "advancedAttributeFactory", {
-  enumerable: true,
-  get: function () {
-    return _storefrontApi.advancedAttributeFactory;
-  }
-});
-Object.defineProperty(exports, "attributeGroupFactory", {
-  enumerable: true,
-  get: function () {
-    return _storefrontApi.attributeGroupFactory;
-  }
-});
-Object.defineProperty(exports, "categoryFactory", {
-  enumerable: true,
-  get: function () {
-    return _storefrontApi.categoryFactory;
-  }
-});
-Object.defineProperty(exports, "priceFactory", {
-  enumerable: true,
-  get: function () {
-    return _storefrontApi.priceFactory;
-  }
-});
-Object.defineProperty(exports, "productFactory", {
-  enumerable: true,
-  get: function () {
-    return _storefrontApi.productFactory;
-  }
-});
 exports.rpcMethods = void 0;
-Object.defineProperty(exports, "variantFactory", {
-  enumerable: true,
-  get: function () {
-    return _storefrontApi.variantFactory;
-  }
-});
 var rpcMethods = _interopRequireWildcard(require("./rpc/methods/index.cjs"));
 exports.rpcMethods = rpcMethods;
 var _errors = require("./errors/index.cjs");

package/dist/index.d.ts

@@ -17,4 +17,4 @@ export type RpcMethodName = Resolve<keyof RpcMethods>;
 export type RpcMethod<N extends RpcMethodName> = RpcMethods[N];
 export type RpcMethodParameters<N extends RpcMethodName> = Parameters<RpcMethod<N>>[0];
 export type RpcMethodReturnType<N extends RpcMethodName> = ReturnType<RpcMethod<N>>;
-export { APISortOption, APISortOrder, type ProductSortConfig, attributeGroupFactory, advancedAttributeFactory, categoryFactory, productFactory, priceFactory, variantFactory, } from '@scayle/storefront-api';
+export { APISortOption, APISortOrder, type ProductSortConfig, } from '@scayle/storefront-api';

package/dist/index.mjs

@@ -8,11 +8,5 @@ export * from "./helpers/index.mjs";
 export * from "./types/index.mjs";
 export {
   APISortOption,
-  APISortOrder,
-  attributeGroupFactory,
-  advancedAttributeFactory,
-  categoryFactory,
-  productFactory,
-  priceFactory,
-  variantFactory
+  APISortOrder
 } from "@scayle/storefront-api";

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.68.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.68.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

@@ -11,7 +11,7 @@ var _cache = require("../../cache/index.cjs");
 var _response = require("../../utils/response.cjs");
 var _errors = require("../../errors/index.cjs");
 const MAX_PER_PAGE = 100;
-const sanitizeAttributesForBAPI = ({
+const sanitizeAttributesForSAPI = ({
   attributes,
   filterKeys,
   includedFilters = []
@@ -142,14 +142,14 @@ const fetchAllFiltersForCategory = exports.fetchAllFiltersForCategory = async fu
   campaignKey
 }) {
   const fetchAndMapFiltersToSlugs = async () => {
-    const filtersFromBAPI = await cached(sapiClient.filters.get)({
+    const filtersFromSAPI = await cached(sapiClient.filters.get)({
       where: {
         categoryId: category.id
       },
       campaignKey,
       including: includedFilters
     });
-    return mapFiltersToSlugs(filtersFromBAPI);
+    return mapFiltersToSlugs(filtersFromSAPI);
   };
   return await cached(fetchAndMapFiltersToSlugs, {
     ttl: 4 * 60 * 60,
@@ -168,7 +168,7 @@ async function getSanitizedAttributes(context, categoryId, attributes, includedF
     return response;
   }
   const allFiltersForCategory = await (0, _response.unwrap)(response);
-  return sanitizeAttributesForBAPI({
+  return sanitizeAttributesForSAPI({
     attributes: attributes || [],
     filterKeys: allFiltersForCategory,
     includedFilters
@@ -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

@@ -4,7 +4,7 @@ import { MINUTE } from "../../cache/index.mjs";
 import { unwrap } from "../../utils/response.mjs";
 import { ErrorResponse } from "../../errors/index.mjs";
 const MAX_PER_PAGE = 100;
-const sanitizeAttributesForBAPI = ({
+const sanitizeAttributesForSAPI = ({
   attributes,
   filterKeys,
   includedFilters = []
@@ -113,12 +113,12 @@ export const getProductsCount = async function getProductsCount2(params, context
 };
 export const fetchAllFiltersForCategory = async function fetchAllFiltersForCategory2({ includedFilters = [], category }, { cached, sapiClient, campaignKey }) {
   const fetchAndMapFiltersToSlugs = async () => {
-    const filtersFromBAPI = await cached(sapiClient.filters.get)({
+    const filtersFromSAPI = await cached(sapiClient.filters.get)({
       where: { categoryId: category.id },
       campaignKey,
       including: includedFilters
     });
-    return mapFiltersToSlugs(filtersFromBAPI);
+    return mapFiltersToSlugs(filtersFromSAPI);
   };
   return await cached(fetchAndMapFiltersToSlugs, {
     ttl: 4 * 60 * 60,
@@ -138,7 +138,7 @@ async function getSanitizedAttributes(context, categoryId, attributes, includedF
     return response;
   }
   const allFiltersForCategory = await unwrap(response);
-  return sanitizeAttributesForBAPI({
+  return sanitizeAttributesForSAPI({
     attributes: attributes || [],
     filterKeys: allFiltersForCategory,
     includedFilters
@@ -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/test/factories/index.cjs

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _factories = require("@scayle/storefront-api/dist/test/factories");
+Object.keys(_factories).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _factories[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _factories[key];
+    }
+  });
+});

package/dist/test/factories/index.d.ts

@@ -0,0 +1 @@
+export * from '@scayle/storefront-api/dist/test/factories';

package/dist/test/factories/index.mjs

@@ -0,0 +1 @@
+export * from "@scayle/storefront-api/dist/test/factories";

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/dist/utils/user.d.ts

@@ -4,13 +4,13 @@ export declare const mergeBaskets: (fromBasketKey: string, toBasketKey: string,
 }, context: RpcContext) => Promise<{
     type: "failure";
     statusCode: number;
-    basket: import("@scayle/storefront-api").BasketResponseData<import("@scayle/storefront-api").Product, import("@scayle/storefront-api").Variant>;
+    basket: import("@scayle/storefront-api").BasketResponseData<import("@scayle/storefront-api/dist/shared/storefront-api.02fa829c").P, import("@scayle/storefront-api/dist/shared/storefront-api.02fa829c").a>;
 } | {
     readonly type: "success";
-    readonly basket: import("@scayle/storefront-api").BasketResponseData<import("@scayle/storefront-api").Product, import("@scayle/storefront-api").Variant>;
+    readonly basket: import("@scayle/storefront-api").BasketResponseData<import("@scayle/storefront-api/dist/shared/storefront-api.02fa829c").P, import("@scayle/storefront-api/dist/shared/storefront-api.02fa829c").a>;
 } | {
     readonly type: "failure";
-    readonly basket: import("@scayle/storefront-api").BasketResponseData<import("@scayle/storefront-api").Product, import("@scayle/storefront-api").Variant>;
+    readonly basket: import("@scayle/storefront-api").BasketResponseData<import("@scayle/storefront-api/dist/shared/storefront-api.02fa829c").P, import("@scayle/storefront-api/dist/shared/storefront-api.02fa829c").a>;
     readonly errors: import("@scayle/storefront-api").AddOrUpdateItemError[];
 } | undefined>;
 export declare const mergeWishlists: (fromWishlistKey: string, toWishlistKey: string, withOptions: BasketWithOptions, context: RpcContext) => Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "7.68.0",
+  "version": "7.69.1",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -24,6 +24,18 @@
       "require": "./dist/server.cjs",
       "default": "./dist/server.cjs"
     },
+    "./dist/test/factories": {
+      "types": "./dist/test/factories/index.d.ts",
+      "import": "./dist/test/factories/index.mjs",
+      "require": "./dist/test/factories/index.cjs",
+      "default": "./dist/test/factories/index.cjs"
+    },
+    "./test/factories": {
+      "types": "./dist/test/factories/index.d.ts",
+      "import": "./dist/test/factories/index.mjs",
+      "require": "./dist/test/factories/index.cjs",
+      "default": "./dist/test/factories/index.cjs"
+    },
     "./dist/*": {
       "types": "./dist/*.d.ts",
       "import": "./dist/*.mjs",
@@ -59,7 +71,7 @@
     "test:ci": "vitest --run --passWithNoTests --coverage --reporter=default --reporter=junit --outputFile=./junit.xml"
   },
   "dependencies": {
-    "@scayle/storefront-api": "17.10.1",
+    "@scayle/storefront-api": "17.11.0",
     "crypto-js": "^4.2.0",
     "hookable": "^5.5.3",
     "jose": "^5.6.3",
@@ -73,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",
@@ -83,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"