@scayle/storefront-core 7.65.0 → 7.65.2

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @scayle/storefront-core
 
+## 7.65.2
+
+### Patch Changes
+
+**Dependencies**
+
+- Updated dependency to @scayle/storefront-api@17.7.0
+
+## 7.65.1
+
+### Patch Changes
+
+- Fix regresion in product RPC methods where the categoryId may not be resolved from the category path
+
 ## 7.65.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.65.0"}`).setProtectedHeader({
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"7.65.2"}`).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.65.0"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"7.65.2"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
   return {
     accessToken: refreshedAccessToken,
     checkoutJwt

package/dist/rpc/methods/products.cjs

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getProductsCount = exports.getProductsByReferenceKeys = exports.getProductsByIds = exports.getProductsByCategory = exports.getProductById = exports.getFilters = exports.fetchAllFiltersForCategory = void 0;
+exports.resolveCategoryIdFromParams = resolveCategoryIdFromParams;
 var _helpers = require("../../helpers/index.cjs");
 var _constants = require("../../constants/index.cjs");
 var _cache = require("../../cache/index.cjs");
@@ -22,6 +23,25 @@ const sanitizeAttributesForBAPI = ({
 const mapFiltersToSlugs = (filters = []) => filters.map(({
   slug
 }) => slug.toLowerCase());
+async function resolveCategoryIdFromParams(context, params) {
+  let category;
+  let categoryId;
+  if ("categoryId" in params) {
+    categoryId = params.categoryId;
+  } else if (params.category && params.category !== "/") {
+    category = params.category;
+    const result = await context.cached(context.bapiClient.categories.getByPath, {
+      cacheKeyPrefix: `getByPath-categories-${category}`
+    })((0, _helpers.splitAndRemoveEmpty)(category));
+    categoryId = result.id;
+  } else {
+    category = "/";
+  }
+  return {
+    category,
+    categoryId
+  };
+}
 const getProductById = exports.getProductById = async function getProductById2(options, {
   bapiClient,
   cached,
@@ -68,30 +88,21 @@ const getProductsByReferenceKeys = exports.getProductsByReferenceKeys = async fu
     pricePromotionKey: options.pricePromotionKey
   });
 };
-const getProductsCount = exports.getProductsCount = async function getProductsCount2(params, {
-  cached,
-  bapiClient,
-  campaignKey
-}) {
+const getProductsCount = exports.getProductsCount = async function getProductsCount2(params, context) {
   const {
     where = void 0,
     includeSoldOut = false,
     includeSellableForFree = false,
     orFiltersOperator = void 0
   } = params;
-  let category;
-  let categoryId;
-  if ("category" in params && !params.category) {
-    category = "/";
-  }
-  if ("categoryId" in params) {
-    categoryId = params.categoryId;
-  } else if (category && category !== "/") {
-    const result = await cached(bapiClient.categories.getByPath, {
-      cacheKeyPrefix: `getByPath-categories-${category}`
-    })((0, _helpers.splitAndRemoveEmpty)(category));
-    categoryId = result.id;
-  }
+  const {
+    cached,
+    bapiClient,
+    campaignKey
+  } = context;
+  const {
+    categoryId
+  } = await resolveCategoryIdFromParams(context, params);
   const productCount = await cached(bapiClient.products.query, {
     ttl: 15 * _cache.MINUTE,
     cacheKeyPrefix: "products-query"
@@ -147,24 +158,15 @@ const getFilters = exports.getFilters = async function getFilters2(params, conte
     includeSellableForFree = false,
     orFiltersOperator
   } = params;
-  let category;
-  let categoryId;
   const {
     cached,
     bapiClient,
     campaignKey
   } = context;
-  if ("category" in params && !params.category) {
-    category = "/";
-  }
-  if ("categoryId" in params) {
-    categoryId = params.categoryId;
-  } else if (category && category !== "/") {
-    const result = await cached(bapiClient.categories.getByPath, {
-      cacheKeyPrefix: `getByPath-categories-${category}`
-    })((0, _helpers.splitAndRemoveEmpty)(category));
-    categoryId = result.id;
-  }
+  const {
+    category,
+    categoryId
+  } = await resolveCategoryIdFromParams(context, params);
   const response = await fetchAllFiltersForCategory({
     category: {
       id: categoryId
@@ -181,7 +183,7 @@ const getFilters = exports.getFilters = async function getFilters2(params, conte
     includedFilters
   });
   const [filters, productCount] = await Promise.all([cached(bapiClient.filters.get, {
-    cacheKeyPrefix: `get-filters-${category}`
+    cacheKeyPrefix: `get-filters-${categoryId}`
   })({
     where: {
       categoryId,
@@ -197,7 +199,7 @@ const getFilters = exports.getFilters = async function getFilters2(params, conte
     orFiltersOperator
   }), cached(bapiClient.products.query, {
     ttl: 15 * _cache.MINUTE,
-    cacheKeyPrefix: `products-query-category-${category === "/" ? "root" : category}`
+    cacheKeyPrefix: `products-query-category-${category === "/" ? "root" : categoryId}`
   })({
     where: {
       categoryId,
@@ -236,19 +238,10 @@ const getProductsByCategory = exports.getProductsByCategory = async function get
     bapiClient,
     campaignKey
   } = context;
-  let category;
-  let categoryId;
-  if ("category" in params && !params.category) {
-    category = "/";
-  }
-  if ("categoryId" in params) {
-    categoryId = params.categoryId;
-  } else if (category && category !== "/") {
-    const result = await cached(bapiClient.categories.getByPath, {
-      cacheKeyPrefix: `getByPath-categories-${category}`
-    })((0, _helpers.splitAndRemoveEmpty)(category));
-    categoryId = result.id;
-  }
+  const {
+    category,
+    categoryId
+  } = await resolveCategoryIdFromParams(context, params);
   const response = await fetchAllFiltersForCategory({
     category: {
       id: categoryId
@@ -268,7 +261,7 @@ const getProductsByCategory = exports.getProductsByCategory = async function get
   } = await cached(bapiClient.products.query, {
     ...cache,
     ttl: 15 * _cache.MINUTE,
-    cacheKeyPrefix: `products-query-category-${category === "/" ? "root" : category}`
+    cacheKeyPrefix: `products-query-category-${category === "/" ? "root" : categoryId}`
   })({
     where: {
       term: where?.term,

package/dist/rpc/methods/products.d.ts

@@ -1,10 +1,29 @@
 import type { FiltersEndpointResponseData } from '@scayle/storefront-api';
 import type { FetchFiltersParams, FetchProductParams, FetchProductsByCategoryParams, FetchProductsByIdsParams, FetchProductsByReferenceKeysParams, FetchProductsCountParams, Product, RpcContext } from '../../types';
 import { ErrorResponse } from '../../errors';
+/**
+ * For functions which accept either a category path or category ID,
+ * this function can resolve the ID which is necessary for the calling
+ * the Storefront APIs.
+ * @param context
+ * @param params
+ * @returns A object with `category` and `categoryId` properties.
+ *  If no `category` was provided in the params, it will be undefined or '/'
+ */
+export declare function resolveCategoryIdFromParams(context: RpcContext, params: {
+    category?: string;
+    categoryId?: undefined;
+} | {
+    categoryId: number;
+    category?: undefined;
+}): Promise<{
+    category: string | undefined;
+    categoryId: number | undefined;
+}>;
 export declare const getProductById: (options: FetchProductParams, { bapiClient, cached, campaignKey, withParams }: RpcContext) => Promise<Product>;
 export declare const getProductsByIds: (options: FetchProductsByIdsParams, { bapiClient, cached, campaignKey, withParams }: RpcContext) => Promise<Product[]>;
 export declare const getProductsByReferenceKeys: (options: FetchProductsByReferenceKeysParams, { bapiClient, cached, campaignKey, withParams }: RpcContext) => Promise<Product[]>;
-export declare const getProductsCount: (params: FetchProductsCountParams, { cached, bapiClient, campaignKey }: RpcContext) => Promise<{
+export declare const getProductsCount: (params: FetchProductsCountParams, context: RpcContext) => Promise<{
     count: number;
 }>;
 export declare const fetchAllFiltersForCategory: ({ includedFilters, category }: {

package/dist/rpc/methods/products.mjs

@@ -14,6 +14,25 @@ const sanitizeAttributesForBAPI = ({
   );
 };
 const mapFiltersToSlugs = (filters = []) => filters.map(({ slug }) => slug.toLowerCase());
+export async function resolveCategoryIdFromParams(context, params) {
+  let category;
+  let categoryId;
+  if ("categoryId" in params) {
+    categoryId = params.categoryId;
+  } else if (params.category && params.category !== "/") {
+    category = params.category;
+    const result = await context.cached(
+      context.bapiClient.categories.getByPath,
+      {
+        cacheKeyPrefix: `getByPath-categories-${category}`
+      }
+    )(splitAndRemoveEmpty(category));
+    categoryId = result.id;
+  } else {
+    category = "/";
+  }
+  return { category, categoryId };
+}
 export const getProductById = async function getProductById2(options, { bapiClient, cached, campaignKey, withParams }) {
   return await cached(bapiClient.products.getById, {
     cacheKeyPrefix: `getById-product-${options.id}`,
@@ -45,26 +64,15 @@ export const getProductsByReferenceKeys = async function getProductsByReferenceK
     pricePromotionKey: options.pricePromotionKey
   });
 };
-export const getProductsCount = async function getProductsCount2(params, { cached, bapiClient, campaignKey }) {
+export const getProductsCount = async function getProductsCount2(params, context) {
   const {
     where = void 0,
     includeSoldOut = false,
     includeSellableForFree = false,
     orFiltersOperator = void 0
   } = params;
-  let category;
-  let categoryId;
-  if ("category" in params && !params.category) {
-    category = "/";
-  }
-  if ("categoryId" in params) {
-    categoryId = params.categoryId;
-  } else if (category && category !== "/") {
-    const result = await cached(bapiClient.categories.getByPath, {
-      cacheKeyPrefix: `getByPath-categories-${category}`
-    })(splitAndRemoveEmpty(category));
-    categoryId = result.id;
-  }
+  const { cached, bapiClient, campaignKey } = context;
+  const { categoryId } = await resolveCategoryIdFromParams(context, params);
   const productCount = await cached(bapiClient.products.query, {
     ttl: 15 * MINUTE,
     cacheKeyPrefix: "products-query"
@@ -111,20 +119,11 @@ export const getFilters = async function getFilters2(params, context) {
     includeSellableForFree = false,
     orFiltersOperator
   } = params;
-  let category;
-  let categoryId;
   const { cached, bapiClient, campaignKey } = context;
-  if ("category" in params && !params.category) {
-    category = "/";
-  }
-  if ("categoryId" in params) {
-    categoryId = params.categoryId;
-  } else if (category && category !== "/") {
-    const result = await cached(bapiClient.categories.getByPath, {
-      cacheKeyPrefix: `getByPath-categories-${category}`
-    })(splitAndRemoveEmpty(category));
-    categoryId = result.id;
-  }
+  const { category, categoryId } = await resolveCategoryIdFromParams(
+    context,
+    params
+  );
   const response = await fetchAllFiltersForCategory(
     {
       category: { id: categoryId },
@@ -143,7 +142,7 @@ export const getFilters = async function getFilters2(params, context) {
   });
   const [filters, productCount] = await Promise.all([
     cached(bapiClient.filters.get, {
-      cacheKeyPrefix: `get-filters-${category}`
+      cacheKeyPrefix: `get-filters-${categoryId}`
     })({
       where: {
         categoryId,
@@ -163,7 +162,7 @@ export const getFilters = async function getFilters2(params, context) {
     }),
     cached(bapiClient.products.query, {
       ttl: 15 * MINUTE,
-      cacheKeyPrefix: `products-query-category-${category === "/" ? "root" : category}`
+      cacheKeyPrefix: `products-query-category-${category === "/" ? "root" : categoryId}`
     })({
       where: {
         categoryId,
@@ -202,19 +201,10 @@ export const getProductsByCategory = async function getProductsByCategory2(param
     orFiltersOperator = void 0
   } = params;
   const { cached, bapiClient, campaignKey } = context;
-  let category;
-  let categoryId;
-  if ("category" in params && !params.category) {
-    category = "/";
-  }
-  if ("categoryId" in params) {
-    categoryId = params.categoryId;
-  } else if (category && category !== "/") {
-    const result = await cached(bapiClient.categories.getByPath, {
-      cacheKeyPrefix: `getByPath-categories-${category}`
-    })(splitAndRemoveEmpty(category));
-    categoryId = result.id;
-  }
+  const { category, categoryId } = await resolveCategoryIdFromParams(
+    context,
+    params
+  );
   const response = await fetchAllFiltersForCategory(
     {
       category: {
@@ -236,7 +226,7 @@ export const getProductsByCategory = async function getProductsByCategory2(param
     {
       ...cache,
       ttl: 15 * MINUTE,
-      cacheKeyPrefix: `products-query-category-${category === "/" ? "root" : category}`
+      cacheKeyPrefix: `products-query-category-${category === "/" ? "root" : categoryId}`
     }
   )({
     where: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "7.65.0",
+  "version": "7.65.2",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -59,7 +59,7 @@
     "test:ci": "vitest --run --passWithNoTests --coverage --reporter=default --reporter=junit"
   },
   "dependencies": {
-    "@scayle/storefront-api": "17.6.0",
+    "@scayle/storefront-api": "17.7.0",
     "crypto-js": "^4.2.0",
     "hookable": "^5.5.3",
     "jose": "^5.6.3",
@@ -73,17 +73,17 @@
     "@types/crypto-js": "4.2.2",
     "@types/node": "20.16.5",
     "@types/webpack-env": "1.18.5",
-    "@vitest/coverage-v8": "2.0.5",
+    "@vitest/coverage-v8": "2.1.1",
     "dprint": "0.47.2",
     "eslint": "9.10.0",
     "eslint-formatter-gitlab": "5.1.0",
-    "publint": "0.2.10",
+    "publint": "0.2.11",
     "rimraf": "6.0.1",
     "ts-node": "10.9.2",
     "typescript": "5.6.2",
     "unbuild": "2.0.0",
     "unstorage": "1.12.0",
-    "vitest": "2.0.5"
+    "vitest": "2.1.1"
   },
   "optionalDependencies": {
     "redis": "4"