@scayle/storefront-core 7.64.4 → 7.65.1

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @scayle/storefront-core
 
+## 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
+
+- Improves the handling of `getOrderDataByCbd` RPC to return descriptive errors in case the validation of the token fails.
+
+  In case the token can't be validated using the Checkout Secret, this is now returned and a warning on the server is logged.
+
+  If the token has expired, this is now also returned and logged on the server.
+
+- Support passing `categoryId` as an alternative to the category path in `getProductsByCategory` and `getFilters`
+
+### Patch Changes
+
+- Fixed cached fallback ttl to be used only if passed `option.ttl` is undefined
+
 ## 7.64.4
 
 ### Patch Changes

package/dist/api/customer.cjs

@@ -15,14 +15,10 @@ class CustomerAPIClient {
     this.context = context;
   }
   get headers() {
-    const accessHeader = this.context.checkout.accessHeader;
     return {
       Authorization: `Bearer ${this.context.accessToken}`,
       Accept: "application/json",
-      "Content-Type": "application/json",
-      ...(accessHeader ? {
-        "X-Access-Header": accessHeader
-      } : {})
+      "Content-Type": "application/json"
     };
   }
   async sendRequest(request, retry = true) {

package/dist/api/customer.mjs

@@ -9,12 +9,10 @@ export class CustomerAPIClient {
     this.context = context;
   }
   get headers() {
-    const accessHeader = this.context.checkout.accessHeader;
     return {
       Authorization: `Bearer ${this.context.accessToken}`,
       Accept: "application/json",
-      "Content-Type": "application/json",
-      ...accessHeader ? { "X-Access-Header": accessHeader } : {}
+      "Content-Type": "application/json"
     };
   }
   async sendRequest(request, retry = true) {

package/dist/cache/cached.cjs

@@ -71,7 +71,7 @@ class Cached {
     if (!this.isCacheEnabled) {
       return;
     }
-    const ttl = options?.ttl || 60 * MINUTE;
+    const ttl = options?.ttl ?? 60 * MINUTE;
     if (ttl) {
       await (0, _utils.timeout)(_constants.CACHE_TIMEOUT, this.cache.set(cacheKey, value, ttl));
     }

package/dist/cache/cached.mjs

@@ -68,7 +68,7 @@ export class Cached {
     if (!this.isCacheEnabled) {
       return;
     }
-    const ttl = options?.ttl || 60 * MINUTE;
+    const ttl = options?.ttl ?? 60 * MINUTE;
     if (ttl) {
       await timeout(CACHE_TIMEOUT, this.cache.set(cacheKey, value, ttl));
     }

package/dist/rpc/methods/cbd.cjs

@@ -4,37 +4,35 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getOrderDataByCbd = void 0;
+var _constants = require("../../constants/index.cjs");
+var _errors = require("../../errors/index.cjs");
 var _hash = require("../../utils/hash.cjs");
 const getOrderDataByCbd = exports.getOrderDataByCbd = async function getOrderDataByCbd2({
   cbdToken
 }, context) {
-  if (!cbdToken) {
-    return;
+  const payload = await (0, _hash.verifyOrderSuccessToken)(cbdToken, context.checkout.secret);
+  if (!payload) {
+    context.log.warn("Unable to verify CBD token. Please check that you configured the correct Checkout Secret");
+    return new _errors.ErrorResponse(_constants.HttpStatusCode.BAD_REQUEST, _constants.HttpStatusMessage.BAD_REQUEST, "Unable to verify CBD token.");
   }
-  const shopId = context.shopId;
-  const accessHeader = context.checkout.accessHeader;
-  const checkoutSecret = context.checkout.secret;
-  const decodedPayload = await (0, _hash.verifyToken)(cbdToken, checkoutSecret);
-  if (decodedPayload) {
-    const payload = JSON.parse(decodedPayload);
-    const checkoutUsername = context.checkout.user;
-    const checkoutToken = context.checkout.token;
-    const checkoutUrl = context.checkout.url;
-    if (context.checkout.cbdExpiration && Math.floor(Date.now() / 1e3) - payload.issued_at > context.checkout.cbdExpiration) {
-      context.log.debug("Attempting to use expired CBD token");
-      return;
+  if (context.checkout.cbdExpiration && Math.floor(Date.now() / 1e3) - payload.issued_at > context.checkout.cbdExpiration) {
+    context.log.warn("Attempting to use expired CBD token");
+    return new _errors.ErrorResponse(_constants.HttpStatusCode.BAD_REQUEST, _constants.HttpStatusMessage.BAD_REQUEST, "The CBD token has expired.");
+  }
+  const checkoutUrl = context.checkout.url;
+  const basicAuth = (0, _hash.encodeBase64)(`${context.checkout.user}:${context.checkout.token}`);
+  const response = await fetch(`${checkoutUrl}/api/v1/orders/${payload.order_id}`, {
+    headers: {
+      Accept: "application/json",
+      Authorization: `Basic ${basicAuth}`,
+      "X-Shop-Id": context.shopId.toString()
     }
-    const accessToken = (0, _hash.encodeBase64)(`${checkoutUsername}:${unescape(checkoutToken)}`);
-    const response = await fetch(`${checkoutUrl}/api/v1/orders/${payload.order_id}`, {
-      headers: {
-        Accept: "application/json",
-        Authorization: `Basic ${accessToken}`,
-        "x-shop-id": shopId.toString(),
-        ...(accessHeader ? {
-          "X-Access-Header": accessHeader
-        } : {})
-      }
-    });
+  });
+  if (response.ok) {
     return await response.json();
   }
+  context.log.error(`Unexpected status code when fetching order from Checkout API: ${response.status}`);
+  return new _errors.ErrorResponse(_constants.HttpStatusCode.INTERNAL_SERVER_ERROR, _constants.HttpStatusMessage.INTERNAL_SERVER_ERROR, "Unknown error", {
+    detail: `Fetching order failed with status code ${response.status}`
+  });
 };

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

@@ -1,4 +1,5 @@
+import { ErrorResponse } from '../../errors';
 import type { Order, RpcContext } from '../../types';
 export declare const getOrderDataByCbd: ({ cbdToken }: {
     cbdToken: string;
-}, context: RpcContext) => Promise<Order | undefined>;
+}, context: RpcContext) => Promise<Order | ErrorResponse>;

package/dist/rpc/methods/cbd.mjs

@@ -1,35 +1,55 @@
-import { encodeBase64, verifyToken } from "../../utils/hash.mjs";
+import { HttpStatusCode, HttpStatusMessage } from "../../constants/index.mjs";
+import { ErrorResponse } from "../../errors/index.mjs";
+import { encodeBase64, verifyOrderSuccessToken } from "../../utils/hash.mjs";
 export const getOrderDataByCbd = async function getOrderDataByCbd2({ cbdToken }, context) {
-  if (!cbdToken) {
-    return;
+  const payload = await verifyOrderSuccessToken(
+    cbdToken,
+    context.checkout.secret
+  );
+  if (!payload) {
+    context.log.warn(
+      "Unable to verify CBD token. Please check that you configured the correct Checkout Secret"
+    );
+    return new ErrorResponse(
+      HttpStatusCode.BAD_REQUEST,
+      HttpStatusMessage.BAD_REQUEST,
+      "Unable to verify CBD token."
+    );
   }
-  const shopId = context.shopId;
-  const accessHeader = context.checkout.accessHeader;
-  const checkoutSecret = context.checkout.secret;
-  const decodedPayload = await verifyToken(cbdToken, checkoutSecret);
-  if (decodedPayload) {
-    const payload = JSON.parse(decodedPayload);
-    const checkoutUsername = context.checkout.user;
-    const checkoutToken = context.checkout.token;
-    const checkoutUrl = context.checkout.url;
-    if (context.checkout.cbdExpiration && Math.floor(Date.now() / 1e3) - payload.issued_at > context.checkout.cbdExpiration) {
-      context.log.debug("Attempting to use expired CBD token");
-      return;
-    }
-    const accessToken = encodeBase64(
-      `${checkoutUsername}:${unescape(checkoutToken)}`
+  if (context.checkout.cbdExpiration && Math.floor(Date.now() / 1e3) - payload.issued_at > context.checkout.cbdExpiration) {
+    context.log.warn("Attempting to use expired CBD token");
+    return new ErrorResponse(
+      HttpStatusCode.BAD_REQUEST,
+      HttpStatusMessage.BAD_REQUEST,
+      "The CBD token has expired."
     );
-    const response = await fetch(
-      `${checkoutUrl}/api/v1/orders/${payload.order_id}`,
-      {
-        headers: {
-          Accept: "application/json",
-          Authorization: `Basic ${accessToken}`,
-          "x-shop-id": shopId.toString(),
-          ...accessHeader ? { "X-Access-Header": accessHeader } : {}
-        }
+  }
+  const checkoutUrl = context.checkout.url;
+  const basicAuth = encodeBase64(
+    `${context.checkout.user}:${context.checkout.token}`
+  );
+  const response = await fetch(
+    `${checkoutUrl}/api/v1/orders/${payload.order_id}`,
+    {
+      headers: {
+        Accept: "application/json",
+        Authorization: `Basic ${basicAuth}`,
+        "X-Shop-Id": context.shopId.toString()
       }
-    );
+    }
+  );
+  if (response.ok) {
     return await response.json();
   }
+  context.log.error(
+    `Unexpected status code when fetching order from Checkout API: ${response.status}`
+  );
+  return new ErrorResponse(
+    HttpStatusCode.INTERNAL_SERVER_ERROR,
+    HttpStatusMessage.INTERNAL_SERVER_ERROR,
+    "Unknown error",
+    {
+      detail: `Fetching order failed with status code ${response.status}`
+    }
+  );
 };

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

@@ -5,10 +5,14 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getCheckoutToken = void 0;
 var _jose = require("jose");
+var _types = require("../../../types/index.cjs");
 var _errors = require("../../../errors/index.cjs");
 var _constants = require("../../../constants/index.cjs");
 var _user = require("../user.cjs");
 const getCheckoutToken = exports.getCheckoutToken = async function getCheckoutToken2(jwtPayload = {}, context) {
+  if (!(0, _types.hasSession)(context)) {
+    return new _errors.ErrorResponse(_constants.HttpStatusCode.BAD_REQUEST, _constants.HttpStatusMessage.BAD_REQUEST, "No Session found");
+  }
   if (!context.accessToken) {
     return new _errors.ErrorResponse(_constants.HttpStatusCode.UNAUTHORIZED, _constants.HttpStatusMessage.UNAUTHORIZED, "No access token present");
   }
@@ -33,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.64.4"}`).setProtectedHeader({
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"7.65.1"}`).setProtectedHeader({
     alg: "HS256",
     typ: "JWT"
   }).sign(secret);

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

@@ -1,8 +1,16 @@
 import { SignJWT } from "jose";
+import { hasSession } from "../../../types/index.mjs";
 import { ErrorResponse } from "../../../errors/index.mjs";
 import { HttpStatusCode, HttpStatusMessage } from "../../../constants/index.mjs";
 import { getAccessToken } from "../user.mjs";
 export const getCheckoutToken = async function getCheckoutToken2(jwtPayload = {}, context) {
+  if (!hasSession(context)) {
+    return new ErrorResponse(
+      HttpStatusCode.BAD_REQUEST,
+      HttpStatusMessage.BAD_REQUEST,
+      "No Session found"
+    );
+  }
   if (!context.accessToken) {
     return new ErrorResponse(
       HttpStatusCode.UNAUTHORIZED,
@@ -27,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.64.4"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"7.65.1"}`).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,31 +88,27 @@ const getProductsByReferenceKeys = exports.getProductsByReferenceKeys = async fu
     pricePromotionKey: options.pricePromotionKey
   });
 };
-const getProductsCount = exports.getProductsCount = async function getProductsCount2({
-  category = "/",
-  categoryId = void 0,
-  where = void 0,
-  includeSoldOut = false,
-  includeSellableForFree = false,
-  orFiltersOperator = void 0
-}, {
-  cached,
-  bapiClient,
-  campaignKey
-}) {
-  let result;
-  if (category !== "/") {
-    const sanitizedPath = (0, _helpers.splitAndRemoveEmpty)(category);
-    result = await cached(bapiClient.categories.getByPath, {
-      cacheKeyPrefix: `getByPath-categories-${sanitizedPath}`
-    })(sanitizedPath);
-  }
+const getProductsCount = exports.getProductsCount = async function getProductsCount2(params, context) {
+  const {
+    where = void 0,
+    includeSoldOut = false,
+    includeSellableForFree = false,
+    orFiltersOperator = void 0
+  } = params;
+  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"
   })({
     where: {
-      categoryId: categoryId ?? result?.id,
+      categoryId,
       minPrice: where?.minPrice,
       maxPrice: where?.maxPrice,
       attributes: where?.attributes,
@@ -131,32 +147,29 @@ const fetchAllFiltersForCategory = exports.fetchAllFiltersForCategory = async fu
   return await cached(fetchAndMapFiltersToSlugs, {
     ttl: 4 * 60 * 60,
     // cached for 4 hours
-    cacheKey: `filters-for-category-${category.slug}`
+    cacheKey: `filters-for-category-${category.id}`
   })();
 };
-const getFilters = exports.getFilters = async function getFilters2({
-  category = "/",
-  includedFilters,
-  where = void 0,
-  includeSoldOut = false,
-  includeSellableForFree = false,
-  orFiltersOperator
-}, context) {
-  let result;
+const getFilters = exports.getFilters = async function getFilters2(params, context) {
+  const {
+    includedFilters,
+    where = void 0,
+    includeSoldOut = false,
+    includeSellableForFree = false,
+    orFiltersOperator
+  } = params;
   const {
     cached,
     bapiClient,
     campaignKey
   } = context;
-  if (category !== "/") {
-    result = await cached(bapiClient.categories.getByPath, {
-      cacheKeyPrefix: `getByPath-categories-${category}`
-    })((0, _helpers.splitAndRemoveEmpty)(category));
-  }
+  const {
+    category,
+    categoryId
+  } = await resolveCategoryIdFromParams(context, params);
   const response = await fetchAllFiltersForCategory({
     category: {
-      id: result?.id,
-      slug: category
+      id: categoryId
     },
     includedFilters
   }, context);
@@ -170,10 +183,10 @@ const getFilters = exports.getFilters = async function getFilters2({
     includedFilters
   });
   const [filters, productCount] = await Promise.all([cached(bapiClient.filters.get, {
-    cacheKeyPrefix: `get-filters-${category}`
+    cacheKeyPrefix: `get-filters-${categoryId}`
   })({
     where: {
-      categoryId: result?.id,
+      categoryId,
       minPrice: where?.minPrice,
       maxPrice: where?.maxPrice,
       term: where?.term,
@@ -186,10 +199,10 @@ const getFilters = exports.getFilters = async function getFilters2({
     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: result?.id,
+      categoryId,
       minPrice: where?.minPrice,
       maxPrice: where?.maxPrice,
       term: where?.term,
@@ -207,34 +220,31 @@ const getFilters = exports.getFilters = async function getFilters2({
     unfilteredCount: productCount?.pagination.total
   };
 };
-const getProductsByCategory = exports.getProductsByCategory = async function getProductsByCategory2({
-  category = "/",
-  cache,
-  with: _with,
-  perPage = 20,
-  page = 1,
-  where = void 0,
-  sort = void 0,
-  pricePromotionKey = "",
-  includeSellableForFree = void 0,
-  includeSoldOut = void 0,
-  orFiltersOperator = void 0
-}, context) {
-  let result;
+const getProductsByCategory = exports.getProductsByCategory = async function getProductsByCategory2(params, context) {
+  const {
+    cache,
+    with: _with,
+    perPage = 20,
+    page = 1,
+    where = void 0,
+    sort = void 0,
+    pricePromotionKey = "",
+    includeSellableForFree = void 0,
+    includeSoldOut = void 0,
+    orFiltersOperator = void 0
+  } = params;
   const {
     cached,
     bapiClient,
     campaignKey
   } = context;
-  if (category !== "/") {
-    result = await cached(bapiClient.categories.getByPath, {
-      cacheKeyPrefix: `getByPath-categories-${category}`
-    })((0, _helpers.splitAndRemoveEmpty)(category));
-  }
+  const {
+    category,
+    categoryId
+  } = await resolveCategoryIdFromParams(context, params);
   const response = await fetchAllFiltersForCategory({
     category: {
-      id: result?.id,
-      slug: category
+      id: categoryId
     }
   }, context);
   if (response instanceof _errors.ErrorResponse) {
@@ -251,11 +261,11 @@ 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,
-      categoryId: result?.id,
+      categoryId,
       minPrice: where?.minPrice,
       maxPrice: where?.maxPrice,
       attributes: [...sanitizedAttributes, ...(where?.whitelistAttributes || [])],

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

@@ -1,24 +1,42 @@
 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: ({ category, categoryId, where, includeSoldOut, includeSellableForFree, orFiltersOperator, }: FetchProductsCountParams, { cached, bapiClient, campaignKey }: RpcContext) => Promise<{
+export declare const getProductsCount: (params: FetchProductsCountParams, context: RpcContext) => Promise<{
     count: number;
 }>;
 export declare const fetchAllFiltersForCategory: ({ includedFilters, category }: {
     includedFilters?: string[];
     category: {
-        slug: string;
         id?: number;
     };
 }, { cached, bapiClient, campaignKey }: RpcContext) => Promise<string[]>;
-export declare const getFilters: ({ category, includedFilters, where, includeSoldOut, includeSellableForFree, orFiltersOperator, }: FetchFiltersParams, context: RpcContext) => Promise<(string[] & ErrorResponse) | {
+export declare const getFilters: (params: FetchFiltersParams, context: RpcContext) => Promise<(string[] & ErrorResponse) | {
     filters: FiltersEndpointResponseData;
     unfilteredCount: number;
 }>;
-export declare const getProductsByCategory: ({ category, cache, with: _with, perPage, page, where, sort, pricePromotionKey, includeSellableForFree, includeSoldOut, orFiltersOperator, }: FetchProductsByCategoryParams, context: RpcContext) => Promise<(string[] & ErrorResponse) | {
+export declare const getProductsByCategory: (params: FetchProductsByCategoryParams, context: RpcContext) => Promise<(string[] & ErrorResponse) | {
     products: Product[];
     pagination: {
         current: number;

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,27 +64,21 @@ export const getProductsByReferenceKeys = async function getProductsByReferenceK
     pricePromotionKey: options.pricePromotionKey
   });
 };
-export const getProductsCount = async function getProductsCount2({
-  category = "/",
-  categoryId = void 0,
-  where = void 0,
-  includeSoldOut = false,
-  includeSellableForFree = false,
-  orFiltersOperator = void 0
-}, { cached, bapiClient, campaignKey }) {
-  let result;
-  if (category !== "/") {
-    const sanitizedPath = splitAndRemoveEmpty(category);
-    result = await cached(bapiClient.categories.getByPath, {
-      cacheKeyPrefix: `getByPath-categories-${sanitizedPath}`
-    })(sanitizedPath);
-  }
+export const getProductsCount = async function getProductsCount2(params, context) {
+  const {
+    where = void 0,
+    includeSoldOut = false,
+    includeSellableForFree = false,
+    orFiltersOperator = void 0
+  } = params;
+  const { cached, bapiClient, campaignKey } = context;
+  const { categoryId } = await resolveCategoryIdFromParams(context, params);
   const productCount = await cached(bapiClient.products.query, {
     ttl: 15 * MINUTE,
     cacheKeyPrefix: "products-query"
   })({
     where: {
-      categoryId: categoryId ?? result?.id,
+      categoryId,
       minPrice: where?.minPrice,
       maxPrice: where?.maxPrice,
       attributes: where?.attributes,
@@ -95,26 +108,27 @@ export const fetchAllFiltersForCategory = async function fetchAllFiltersForCateg
   return await cached(fetchAndMapFiltersToSlugs, {
     ttl: 4 * 60 * 60,
     // cached for 4 hours
-    cacheKey: `filters-for-category-${category.slug}`
+    cacheKey: `filters-for-category-${category.id}`
   })();
 };
-export const getFilters = async function getFilters2({
-  category = "/",
-  includedFilters,
-  where = void 0,
-  includeSoldOut = false,
-  includeSellableForFree = false,
-  orFiltersOperator
-}, context) {
-  let result;
+export const getFilters = async function getFilters2(params, context) {
+  const {
+    includedFilters,
+    where = void 0,
+    includeSoldOut = false,
+    includeSellableForFree = false,
+    orFiltersOperator
+  } = params;
   const { cached, bapiClient, campaignKey } = context;
-  if (category !== "/") {
-    result = await cached(bapiClient.categories.getByPath, {
-      cacheKeyPrefix: `getByPath-categories-${category}`
-    })(splitAndRemoveEmpty(category));
-  }
+  const { category, categoryId } = await resolveCategoryIdFromParams(
+    context,
+    params
+  );
   const response = await fetchAllFiltersForCategory(
-    { category: { id: result?.id, slug: category }, includedFilters },
+    {
+      category: { id: categoryId },
+      includedFilters
+    },
     context
   );
   if (response instanceof ErrorResponse) {
@@ -128,10 +142,10 @@ export const getFilters = async function getFilters2({
   });
   const [filters, productCount] = await Promise.all([
     cached(bapiClient.filters.get, {
-      cacheKeyPrefix: `get-filters-${category}`
+      cacheKeyPrefix: `get-filters-${categoryId}`
     })({
       where: {
-        categoryId: result?.id,
+        categoryId,
         minPrice: where?.minPrice,
         maxPrice: where?.maxPrice,
         term: where?.term,
@@ -148,10 +162,10 @@ export const getFilters = async function getFilters2({
     }),
     cached(bapiClient.products.query, {
       ttl: 15 * MINUTE,
-      cacheKeyPrefix: `products-query-category-${category === "/" ? "root" : category}`
+      cacheKeyPrefix: `products-query-category-${category === "/" ? "root" : categoryId}`
     })({
       where: {
-        categoryId: result?.id,
+        categoryId,
         minPrice: where?.minPrice,
         maxPrice: where?.maxPrice,
         term: where?.term,
@@ -173,28 +187,30 @@ export const getFilters = async function getFilters2({
     unfilteredCount: productCount?.pagination.total
   };
 };
-export const getProductsByCategory = async function getProductsByCategory2({
-  category = "/",
-  cache,
-  with: _with,
-  perPage = 20,
-  page = 1,
-  where = void 0,
-  sort = void 0,
-  pricePromotionKey = "",
-  includeSellableForFree = void 0,
-  includeSoldOut = void 0,
-  orFiltersOperator = void 0
-}, context) {
-  let result;
+export const getProductsByCategory = async function getProductsByCategory2(params, context) {
+  const {
+    cache,
+    with: _with,
+    perPage = 20,
+    page = 1,
+    where = void 0,
+    sort = void 0,
+    pricePromotionKey = "",
+    includeSellableForFree = void 0,
+    includeSoldOut = void 0,
+    orFiltersOperator = void 0
+  } = params;
   const { cached, bapiClient, campaignKey } = context;
-  if (category !== "/") {
-    result = await cached(bapiClient.categories.getByPath, {
-      cacheKeyPrefix: `getByPath-categories-${category}`
-    })(splitAndRemoveEmpty(category));
-  }
+  const { category, categoryId } = await resolveCategoryIdFromParams(
+    context,
+    params
+  );
   const response = await fetchAllFiltersForCategory(
-    { category: { id: result?.id, slug: category } },
+    {
+      category: {
+        id: categoryId
+      }
+    },
     context
   );
   if (response instanceof ErrorResponse) {
@@ -210,12 +226,12 @@ export const getProductsByCategory = async function getProductsByCategory2({
     {
       ...cache,
       ttl: 15 * MINUTE,
-      cacheKeyPrefix: `products-query-category-${category === "/" ? "root" : category}`
+      cacheKeyPrefix: `products-query-category-${category === "/" ? "root" : categoryId}`
     }
   )({
     where: {
       term: where?.term,
-      categoryId: result?.id,
+      categoryId,
       minPrice: where?.minPrice,
       maxPrice: where?.maxPrice,
       attributes: [

package/dist/types/bapi/filter.d.ts

@@ -15,8 +15,7 @@ export interface FilterParams {
     sort?: ProductSortConfig;
     orFiltersOperator?: ProductsSearchEndpointParameters['orFiltersOperator'];
 }
-export interface FetchFiltersParams {
-    category: string;
+export type FetchFiltersParams = {
     includedFilters?: Array<string>;
     where?: {
         term?: ProductSearchQuery['term'];
@@ -28,7 +27,13 @@ export interface FetchFiltersParams {
     includeSoldOut?: boolean;
     includeSellableForFree?: boolean;
     orFiltersOperator?: ProductsSearchEndpointParameters['orFiltersOperator'];
-}
+} & ({
+    category?: string;
+    categoryId?: undefined;
+} | {
+    categoryId: number;
+    category?: undefined;
+});
 export interface FetchFiltersResponse {
     filters: FiltersEndpointResponseData;
     unfilteredCount: number;

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

@@ -43,8 +43,7 @@ export interface FetchProductsByReferenceKeysParams {
     with?: ProductWith;
     pricePromotionKey?: string;
 }
-export interface FetchProductsByCategoryParams {
-    category: string;
+export type FetchProductsByCategoryParams = {
     with?: ProductWith;
     cache?: CacheOptions;
     includedFilters?: Array<string>;
@@ -63,14 +62,18 @@ export interface FetchProductsByCategoryParams {
     includeSellableForFree?: boolean;
     includeSoldOut?: boolean;
     orFiltersOperator?: ProductsSearchEndpointParameters['orFiltersOperator'];
-}
+} & ({
+    category?: string;
+    categoryId?: undefined;
+} | {
+    categoryId: number;
+    category?: undefined;
+});
 export interface FetchProductsByCategoryResponse {
     products: Product[];
     pagination: ProductsByIdsEndpointResponseData['pagination'];
 }
-export interface FetchProductsCountParams {
-    category?: string;
-    categoryId?: number;
+export type FetchProductsCountParams = {
     where?: {
         term?: ProductSearchQuery['term'];
         minPrice?: ProductSearchQuery['minPrice'];
@@ -80,7 +83,13 @@ export interface FetchProductsCountParams {
     includeSoldOut?: boolean;
     includeSellableForFree?: boolean;
     orFiltersOperator?: ProductsSearchEndpointParameters['orFiltersOperator'];
-}
+} & ({
+    category?: string;
+    categoryId?: undefined;
+} | {
+    categoryId: number;
+    category?: undefined;
+});
 export interface FetchProductsCountResponse {
     count: number;
 }

package/dist/utils/hash.cjs

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.verifyToken = exports.sha256 = exports.md5 = exports.hmac = exports.encodeBase64 = exports.decodeBase64 = exports.buildSignature = exports.buildHashPayload = void 0;
+exports.verifyOrderSuccessToken = exports.sha256 = exports.md5 = exports.hmac = exports.encodeBase64 = exports.decodeBase64 = exports.buildSignature = exports.buildHashPayload = void 0;
 var _uncrypto = require("uncrypto");
 const md5 = async value => {
   if (!process.env.SFC_OMIT_MD5) {
@@ -54,14 +54,15 @@ const decodeBase64 = string => {
   return new TextDecoder().decode(base64ToBytes(string));
 };
 exports.decodeBase64 = decodeBase64;
-const verifyToken = async (token, secret) => {
+const verifyOrderSuccessToken = async (token, secret) => {
   const [encodedPayload, signature] = token.split(".", 2);
   const expectedSignature = encodeBase64(await hmac(encodedPayload, secret));
   if (expectedSignature === signature) {
-    return decodeBase64(encodedPayload);
+    return JSON.parse(decodeBase64(encodedPayload));
   }
+  return void 0;
 };
-exports.verifyToken = verifyToken;
+exports.verifyOrderSuccessToken = verifyOrderSuccessToken;
 const buildHashPayload = payload => encodeBase64(JSON.stringify(payload));
 exports.buildHashPayload = buildHashPayload;
 const buildSignature = async (payloadHash, secret) => encodeBase64(await hmac(payloadHash, secret));

package/dist/utils/hash.d.ts

@@ -3,6 +3,6 @@ export declare const sha256: (value: string) => Promise<string>;
 export declare const hmac: (value: string, secret: string, algorithm?: string) => Promise<string>;
 export declare const encodeBase64: (string: string) => string;
 export declare const decodeBase64: (string: string) => string;
-export declare const verifyToken: (token: string, secret: string) => Promise<string | undefined>;
+export declare const verifyOrderSuccessToken: <T = unknown>(token: string, secret: string) => Promise<T | undefined>;
 export declare const buildHashPayload: (payload: unknown) => string;
 export declare const buildSignature: (payloadHash: string, secret: string) => Promise<string>;

package/dist/utils/hash.mjs

@@ -50,12 +50,13 @@ export const decodeBase64 = (string) => {
   }
   return new TextDecoder().decode(base64ToBytes(string));
 };
-export const verifyToken = async (token, secret) => {
+export const verifyOrderSuccessToken = async (token, secret) => {
   const [encodedPayload, signature] = token.split(".", 2);
   const expectedSignature = encodeBase64(await hmac(encodedPayload, secret));
   if (expectedSignature === signature) {
-    return decodeBase64(encodedPayload);
+    return JSON.parse(decodeBase64(encodedPayload));
   }
+  return void 0;
 };
 export const buildHashPayload = (payload) => encodeBase64(JSON.stringify(payload));
 export const buildSignature = async (payloadHash, secret) => encodeBase64(await hmac(payloadHash, secret));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "7.64.4",
+  "version": "7.65.1",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -73,7 +73,7 @@
     "@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",
@@ -83,7 +83,7 @@
     "typescript": "5.6.2",
     "unbuild": "2.0.0",
     "unstorage": "1.12.0",
-    "vitest": "2.0.5"
+    "vitest": "2.1.1"
   },
   "optionalDependencies": {
     "redis": "4"