@scayle/storefront-core 8.61.0 → 8.61.2

package/dist/rpc/methods/products.mjs

@@ -33,52 +33,61 @@ export async function resolveCategoryIdFromParams(context, params) {
   }
   return { category, categoryId };
 }
-export const getProductById = defineRpcHandler(async (options, context) => {
-  const { sapiClient, cached, withParams } = context;
-  const campaignKey = await context.callRpc?.("getCampaignKey");
-  return await cached(
-    mapSAPIFetchErrorToResponse(sapiClient.products.getById),
-    {
-      cacheKeyPrefix: `getById-product-${options.id}`,
-      ttl: 5 * MINUTE
-    }
-  )(options.id, {
-    with: options.with ?? withParams?.product ?? MIN_WITH_PARAMS_PRODUCT,
-    campaignKey,
-    pricePromotionKey: options.pricePromotionKey,
-    includeSellableForFree: options.includeSellableForFree
-  });
-}, { method: "GET" });
-export const getProductsByIds = defineRpcHandler(async (options, context) => {
-  const { sapiClient, cached, withParams } = context;
-  const campaignKey = await context.callRpc?.("getCampaignKey");
-  return await cached(
-    mapSAPIFetchErrorToResponse(sapiClient.products.getByIds),
-    {
-      cacheKeyPrefix: "getByIds-products",
-      ttl: 5 * MINUTE
-    }
-  )(options.ids, {
-    with: options.with ?? withParams?.product ?? MIN_WITH_PARAMS_PRODUCT,
-    campaignKey,
-    pricePromotionKey: options.pricePromotionKey
-  });
-}, { method: "GET" });
-export const getProductsByReferenceKeys = defineRpcHandler(async (options, context) => {
-  const { sapiClient, cached, withParams } = context;
-  const campaignKey = await context.callRpc?.("getCampaignKey");
-  return await cached(
-    mapSAPIFetchErrorToResponse(sapiClient.products.getByReferenceKeys),
-    {
-      cacheKeyPrefix: "getByReferenceKeys-products",
-      ttl: 5 * MINUTE
-    }
-  )(options.referenceKeys, {
-    with: options.with ?? withParams?.product ?? MIN_WITH_PARAMS_PRODUCT,
-    campaignKey,
-    pricePromotionKey: options.pricePromotionKey
-  });
-}, { method: "GET" });
+export const getProductById = defineRpcHandler(
+  async (options, context) => {
+    const { sapiClient, cached, withParams } = context;
+    const campaignKey = await context.callRpc?.("getCampaignKey");
+    return await cached(
+      mapSAPIFetchErrorToResponse(sapiClient.products.getById),
+      {
+        cacheKeyPrefix: `getById-product-${options.id}`,
+        ttl: 5 * MINUTE
+      }
+    )(options.id, {
+      with: options.with ?? withParams?.product ?? MIN_WITH_PARAMS_PRODUCT,
+      campaignKey,
+      pricePromotionKey: options.pricePromotionKey,
+      includeSellableForFree: options.includeSellableForFree
+    });
+  },
+  { method: "GET" }
+);
+export const getProductsByIds = defineRpcHandler(
+  async (options, context) => {
+    const { sapiClient, cached, withParams } = context;
+    const campaignKey = await context.callRpc?.("getCampaignKey");
+    return await cached(
+      mapSAPIFetchErrorToResponse(sapiClient.products.getByIds),
+      {
+        cacheKeyPrefix: "getByIds-products",
+        ttl: 5 * MINUTE
+      }
+    )(options.ids, {
+      with: options.with ?? withParams?.product ?? MIN_WITH_PARAMS_PRODUCT,
+      campaignKey,
+      pricePromotionKey: options.pricePromotionKey
+    });
+  },
+  { method: "GET" }
+);
+export const getProductsByReferenceKeys = defineRpcHandler(
+  async (options, context) => {
+    const { sapiClient, cached, withParams } = context;
+    const campaignKey = await context.callRpc?.("getCampaignKey");
+    return await cached(
+      mapSAPIFetchErrorToResponse(sapiClient.products.getByReferenceKeys),
+      {
+        cacheKeyPrefix: "getByReferenceKeys-products",
+        ttl: 5 * MINUTE
+      }
+    )(options.referenceKeys, {
+      with: options.with ?? withParams?.product ?? MIN_WITH_PARAMS_PRODUCT,
+      campaignKey,
+      pricePromotionKey: options.pricePromotionKey
+    });
+  },
+  { method: "GET" }
+);
 export const getProductsCount = defineRpcHandler(
   async (params, context) => {
     const {
@@ -112,10 +121,7 @@ export const getProductsCount = defineRpcHandler(
       where: {
         ...filter,
         categoryId,
-        attributes: [
-          ...sanitizedAttributes,
-          ...whitelistAttributes || []
-        ]
+        attributes: [...sanitizedAttributes, ...whitelistAttributes || []]
       },
       pagination: {
         perPage: 1
@@ -131,32 +137,35 @@ export const getProductsCount = defineRpcHandler(
   },
   { method: "GET" }
 );
-export const fetchAllFiltersForCategory = defineRpcHandler(async ({
-  includedFilters = [],
-  category,
-  includeSoldOut,
-  includeSellableForFree,
-  orFiltersOperator
-}, context) => {
-  const { cached, sapiClient } = context;
-  const campaignKey = await context.callRpc?.("getCampaignKey");
-  const fetchAndMapFiltersToSlugs = async () => {
-    const filtersFromSAPI = await cached(sapiClient.filters.get)({
-      where: { categoryId: category.id },
-      campaignKey,
-      including: includedFilters,
-      includeSoldOut,
-      includeSellableForFree,
-      orFiltersOperator
-    });
-    return mapFiltersToSlugs(filtersFromSAPI);
-  };
-  return await cached(fetchAndMapFiltersToSlugs, {
-    ttl: 4 * 60 * 60,
-    // cached for 4 hours
-    cacheKey: `filters-for-category-${category.id}`
-  })();
-}, { method: "GET" });
+export const fetchAllFiltersForCategory = defineRpcHandler(
+  async ({
+    includedFilters = [],
+    category,
+    includeSoldOut,
+    includeSellableForFree,
+    orFiltersOperator
+  }, context) => {
+    const { cached, sapiClient } = context;
+    const campaignKey = await context.callRpc?.("getCampaignKey");
+    const fetchAndMapFiltersToSlugs = async () => {
+      const filtersFromSAPI = await cached(sapiClient.filters.get)({
+        where: { categoryId: category.id },
+        campaignKey,
+        including: includedFilters,
+        includeSoldOut,
+        includeSellableForFree,
+        orFiltersOperator
+      });
+      return mapFiltersToSlugs(filtersFromSAPI);
+    };
+    return await cached(fetchAndMapFiltersToSlugs, {
+      ttl: 4 * 60 * 60,
+      // cached for 4 hours
+      cacheKey: `filters-for-category-${category.id}`
+    })();
+  },
+  { method: "GET" }
+);
 async function getSanitizedAttributes(context, categoryId, attributes, includedFilters, includeSoldOut, includeSellableForFree, orFiltersOperator) {
   const response = await fetchAllFiltersForCategory(
     {
@@ -178,151 +187,154 @@ async function getSanitizedAttributes(context, categoryId, attributes, includedF
     includedFilters
   });
 }
-export const getFilters = defineRpcHandler(async (params, context) => {
-  const {
-    includedFilters,
-    where = void 0,
-    includeSoldOut = false,
-    includeSellableForFree = false,
-    orFiltersOperator
-  } = params;
-  const { cached, sapiClient } = context;
-  const campaignKey = await context.callRpc?.("getCampaignKey");
-  const { category, categoryId } = await resolveCategoryIdFromParams(
-    context,
-    params
-  );
-  const { attributes, whitelistAttributes, ...filter } = where || {};
-  const response = await getSanitizedAttributes(
-    context,
-    categoryId,
-    attributes || [],
-    includedFilters,
-    includeSoldOut,
-    includeSellableForFree,
-    orFiltersOperator
-  );
-  if (response instanceof ErrorResponse) {
-    return response;
-  }
-  const sanitizedAttributes = response;
-  const [filters, productCount] = await Promise.all([
-    cached(sapiClient.filters.get, {
-      cacheKeyPrefix: `get-filters-${categoryId}`
-    })({
-      where: {
-        ...filter,
-        categoryId,
-        attributes: [
-          ...sanitizedAttributes,
-          ...whitelistAttributes || []
-        ]
-      },
+export const getFilters = defineRpcHandler(
+  async (params, context) => {
+    const {
+      includedFilters,
+      where = void 0,
+      includeSoldOut = false,
+      includeSellableForFree = false,
+      orFiltersOperator
+    } = params;
+    const { cached, sapiClient } = context;
+    const campaignKey = await context.callRpc?.("getCampaignKey");
+    const { category, categoryId } = await resolveCategoryIdFromParams(
+      context,
+      params
+    );
+    const { attributes, whitelistAttributes, ...filter } = where || {};
+    const response = await getSanitizedAttributes(
+      context,
+      categoryId,
+      attributes || [],
+      includedFilters,
       includeSoldOut,
       includeSellableForFree,
-      campaignKey,
-      including: includedFilters,
       orFiltersOperator
-    }),
-    cached(sapiClient.products.query, {
-      ttl: 15 * MINUTE,
-      cacheKeyPrefix: `products-query-category-${category === "/" ? "root" : categoryId}`
-    })({
+    );
+    if (response instanceof ErrorResponse) {
+      return response;
+    }
+    const sanitizedAttributes = response;
+    const [filters, productCount] = await Promise.all([
+      cached(sapiClient.filters.get, {
+        cacheKeyPrefix: `get-filters-${categoryId}`
+      })({
+        where: {
+          ...filter,
+          categoryId,
+          attributes: [
+            ...sanitizedAttributes,
+            ...whitelistAttributes || []
+          ]
+        },
+        includeSoldOut,
+        includeSellableForFree,
+        campaignKey,
+        including: includedFilters,
+        orFiltersOperator
+      }),
+      cached(sapiClient.products.query, {
+        ttl: 15 * MINUTE,
+        cacheKeyPrefix: `products-query-category-${category === "/" ? "root" : categoryId}`
+      })({
+        where: {
+          ...filter,
+          categoryId,
+          attributes: [
+            ...sanitizedAttributes,
+            ...whitelistAttributes || []
+          ]
+        },
+        pagination: {
+          perPage: 1
+        },
+        campaignKey,
+        includeSellableForFree,
+        includeSoldOut,
+        orFiltersOperator
+      })
+    ]);
+    return {
+      filters,
+      unfilteredCount: productCount?.pagination.total
+    };
+  },
+  { method: "GET" }
+);
+export const getProductsByCategory = defineRpcHandler(
+  async (params, context) => {
+    const {
+      includedFilters,
+      cache,
+      with: _with,
+      perPage = 20,
+      page = 1,
+      where = void 0,
+      sort = void 0,
+      pricePromotionKey = "",
+      includeSellableForFree = void 0,
+      includeSoldOut = void 0,
+      orFiltersOperator = void 0,
+      trackSearchAnalyticsEvent = void 0
+    } = params;
+    const { cached, sapiClient } = context;
+    const campaignKey = await context.callRpc?.("getCampaignKey");
+    const { category, categoryId } = await resolveCategoryIdFromParams(
+      context,
+      params
+    );
+    const { attributes, whitelistAttributes, ...filter } = where || {};
+    const response = await getSanitizedAttributes(
+      context,
+      categoryId,
+      attributes || [],
+      includedFilters,
+      includeSoldOut,
+      includeSellableForFree,
+      orFiltersOperator
+    );
+    if (response instanceof ErrorResponse) {
+      return response;
+    }
+    const sanitizedAttributes = response;
+    const { entities: products, pagination } = await cached(
+      sapiClient.products.query,
+      {
+        ...cache,
+        ttl: cache?.ttl ?? 15 * MINUTE,
+        cacheKeyPrefix: cache?.cacheKeyPrefix || `products-query-category-${category === "/" ? "root" : categoryId}`
+      }
+    )({
       where: {
         ...filter,
         categoryId,
-        attributes: [
-          ...sanitizedAttributes,
-          ...whitelistAttributes || []
-        ]
+        attributes: [...sanitizedAttributes, ...whitelistAttributes || []]
       },
       pagination: {
-        perPage: 1
+        perPage: Math.min(perPage, MAX_PER_PAGE),
+        page
       },
       campaignKey,
       includeSellableForFree,
       includeSoldOut,
-      orFiltersOperator
-    })
-  ]);
-  return {
-    filters,
-    unfilteredCount: productCount?.pagination.total
-  };
-}, { method: "GET" });
-export const getProductsByCategory = defineRpcHandler(async (params, context) => {
-  const {
-    includedFilters,
-    cache,
-    with: _with,
-    perPage = 20,
-    page = 1,
-    where = void 0,
-    sort = void 0,
-    pricePromotionKey = "",
-    includeSellableForFree = void 0,
-    includeSoldOut = void 0,
-    orFiltersOperator = void 0,
-    trackSearchAnalyticsEvent = void 0
-  } = params;
-  const { cached, sapiClient } = context;
-  const campaignKey = await context.callRpc?.("getCampaignKey");
-  const { category, categoryId } = await resolveCategoryIdFromParams(
-    context,
-    params
-  );
-  const { attributes, whitelistAttributes, ...filter } = where || {};
-  const response = await getSanitizedAttributes(
-    context,
-    categoryId,
-    attributes || [],
-    includedFilters,
-    includeSoldOut,
-    includeSellableForFree,
-    orFiltersOperator
-  );
-  if (response instanceof ErrorResponse) {
-    return response;
-  }
-  const sanitizedAttributes = response;
-  const { entities: products, pagination } = await cached(
-    sapiClient.products.query,
-    {
-      ...cache,
-      ttl: cache?.ttl ?? 15 * MINUTE,
-      cacheKeyPrefix: cache?.cacheKeyPrefix || `products-query-category-${category === "/" ? "root" : categoryId}`
-    }
-  )({
-    where: {
-      ...filter,
-      categoryId,
-      attributes: [
-        ...sanitizedAttributes,
-        ...whitelistAttributes || []
-      ]
-    },
-    pagination: {
-      perPage: Math.min(perPage, MAX_PER_PAGE),
-      page
-    },
-    campaignKey,
-    includeSellableForFree,
-    includeSoldOut,
-    orFiltersOperator,
-    pricePromotionKey,
-    with: _with ?? context.withParams?.product ?? MIN_WITH_PARAMS_PRODUCT,
-    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/core-documentation/the-basics/shops/search#scayle-search-analytics
-    trackSearchAnalyticsEvent
-  });
-  return {
-    products,
-    pagination: {
-      ...pagination
-    }
-  };
-}, { method: "GET" });
+      orFiltersOperator,
+      pricePromotionKey,
+      with: _with ?? context.withParams?.product ?? MIN_WITH_PARAMS_PRODUCT,
+      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/core-documentation/the-basics/shops/search#scayle-search-analytics
+      trackSearchAnalyticsEvent
+    });
+    return {
+      products,
+      pagination: {
+        ...pagination
+      }
+    };
+  },
+  { method: "GET" }
+);

package/dist/rpc/methods/promotion.mjs

@@ -10,34 +10,49 @@ const setPaginationDefault = (pagination) => {
     perPage: pagination?.perPage || PROMOTION_PER_PAGE_DEFAULT
   };
 };
-export const getPromotions = defineRpcHandler(async (params = {}, context) => {
-  const { sapiClient, cached } = context;
-  return await cached(mapSAPIFetchErrorToResponse(sapiClient.promotions.get), {
-    cacheKeyPrefix: "getPromotions"
-  })({
-    ...params,
-    pagination: setPaginationDefault(params.pagination)
-  });
-}, { method: "GET" });
-export const getCurrentPromotions = defineRpcHandler(async (params = {}, context) => {
-  const { sapiClient, cached } = context;
-  const now = /* @__PURE__ */ new Date();
-  now.setSeconds(0, 0);
-  const activeAt = now.toISOString();
-  return await cached(mapSAPIFetchErrorToResponse(sapiClient.promotions.get), {
-    cacheKeyPrefix: "getPromotions"
-  })({
-    ...params,
-    activeAt,
-    pagination: setPaginationDefault(params.pagination)
-  });
-}, { method: "GET" });
-export const getPromotionsByIds = defineRpcHandler(async (ids, context) => {
-  const { sapiClient, cached } = context;
-  return await cached(
-    mapSAPIFetchErrorToResponse(sapiClient.promotions.getByIds),
-    {
-      cacheKeyPrefix: "getByIds-promotions"
-    }
-  )(ids);
-}, { method: "GET" });
+export const getPromotions = defineRpcHandler(
+  async (params = {}, context) => {
+    const { sapiClient, cached } = context;
+    return await cached(
+      mapSAPIFetchErrorToResponse(sapiClient.promotions.get),
+      {
+        cacheKeyPrefix: "getPromotions"
+      }
+    )({
+      ...params,
+      pagination: setPaginationDefault(params.pagination)
+    });
+  },
+  { method: "GET" }
+);
+export const getCurrentPromotions = defineRpcHandler(
+  async (params = {}, context) => {
+    const { sapiClient, cached } = context;
+    const now = /* @__PURE__ */ new Date();
+    now.setSeconds(0, 0);
+    const activeAt = now.toISOString();
+    return await cached(
+      mapSAPIFetchErrorToResponse(sapiClient.promotions.get),
+      {
+        cacheKeyPrefix: "getPromotions"
+      }
+    )({
+      ...params,
+      activeAt,
+      pagination: setPaginationDefault(params.pagination)
+    });
+  },
+  { method: "GET" }
+);
+export const getPromotionsByIds = defineRpcHandler(
+  async (ids, context) => {
+    const { sapiClient, cached } = context;
+    return await cached(
+      mapSAPIFetchErrorToResponse(sapiClient.promotions.getByIds),
+      {
+        cacheKeyPrefix: "getByIds-promotions"
+      }
+    )(ids);
+  },
+  { method: "GET" }
+);

package/dist/rpc/methods/search.mjs

@@ -1,25 +1,31 @@
 import { mapSAPIFetchErrorToResponse } from "../../utils/sapi.mjs";
 import { defineRpcHandler } from "../../utils/index.mjs";
-export const getSearchSuggestions = defineRpcHandler(async ({ term, with: _with, categoryId }, context) => {
-  const { sapiClient, withParams } = context;
-  return await mapSAPIFetchErrorToResponse(sapiClient.searchv2.suggestions)(
-    term,
-    {
+export const getSearchSuggestions = defineRpcHandler(
+  async ({ term, with: _with, categoryId }, context) => {
+    const { sapiClient, withParams } = context;
+    return await mapSAPIFetchErrorToResponse(sapiClient.searchv2.suggestions)(
+      term,
+      {
+        categoryId,
+        with: _with ?? withParams?.searchV2
+      }
+    );
+  },
+  { method: "GET" }
+);
+export const resolveSearch = defineRpcHandler(
+  async ({ term, with: _with, categoryId }, context) => {
+    const { cached, sapiClient, withParams } = context;
+    const resolvedEntity = await cached(sapiClient.searchv2.resolve, {
+      cacheKeyPrefix: `resolve-${term}`
+    })(term, {
       categoryId,
       with: _with ?? withParams?.searchV2
+    });
+    if (!resolvedEntity) {
+      return null;
     }
-  );
-}, { method: "GET" });
-export const resolveSearch = defineRpcHandler(async ({ term, with: _with, categoryId }, context) => {
-  const { cached, sapiClient, withParams } = context;
-  const resolvedEntity = await cached(sapiClient.searchv2.resolve, {
-    cacheKeyPrefix: `resolve-${term}`
-  })(term, {
-    categoryId,
-    with: _with ?? withParams?.searchV2
-  });
-  if (!resolvedEntity) {
-    return null;
-  }
-  return resolvedEntity;
-}, { method: "GET" });
+    return resolvedEntity;
+  },
+  { method: "GET" }
+);