@scayle/storefront-product-listing 0.4.0 → 0.4.2

package/dist/runtime/composables/useProductsByCategory.d.ts

@@ -10,14 +10,14 @@ export type UseProductsByCategoryReturn = Pick<Awaited<ReturnType<typeof useProd
     paginationOffset: ComputedRef<number>;
 };
 export interface ProductsByCategoryOptions {
-    params: Omit<Partial<FetchProductsByCategoryParams>, 'category' | 'categoryId'>;
-    fetchingOptions: Partial<{
+    params?: Omit<Partial<FetchProductsByCategoryParams>, 'category' | 'categoryId'>;
+    fetchingOptions?: Partial<{
         lazy: boolean;
         immediate: boolean;
     }>;
-    productsPerPage: number;
-    fetchProductsCacheTtl: number;
-    cacheKeyPrefix: string;
+    productsPerPage?: number;
+    fetchProductsCacheTtl?: number;
+    cacheKeyPrefix?: string;
     fetchingKey?: string;
     withParams?: ProductWith;
 }

package/dist/runtime/composables/useProductsByCategory.js

@@ -9,24 +9,18 @@ const PRODUCTS_PER_PAGE = 24;
 const DEFAULT_CACHE_TTL = 1e3;
 const DEFAULT_CACHE_KEY_PREFIX = "PLP";
 export function useProductsByCategory(categoryId, route, {
-  params,
-  withParams,
-  cacheKeyPrefix,
-  fetchingKey,
-  fetchingOptions,
-  fetchProductsCacheTtl,
-  productsPerPage
-} = {
-  params: {
+  params = {
     includeSoldOut: false,
     includeSellableForFree: false,
     pricePromotionKey: ""
   },
-  fetchingOptions: {},
-  productsPerPage: PRODUCTS_PER_PAGE,
-  fetchProductsCacheTtl: DEFAULT_CACHE_TTL,
-  cacheKeyPrefix: DEFAULT_CACHE_KEY_PREFIX
-}) {
+  withParams,
+  cacheKeyPrefix = DEFAULT_CACHE_KEY_PREFIX,
+  fetchingKey,
+  fetchingOptions = {},
+  fetchProductsCacheTtl = DEFAULT_CACHE_TTL,
+  productsPerPage = PRODUCTS_PER_PAGE
+} = {}) {
   const { selectedSort } = useProductListSort(route);
   const { appliedFilter } = useAppliedFilters(route);
   const productsData = useProducts({
@@ -45,6 +39,11 @@ export function useProductsByCategory(categoryId, route, {
         cacheKeyPrefix: cacheKeyPrefix || `PLP:${toValue(categoryId)}`
       },
       where: appliedFilter.value,
+      // NOTE: We don't want to include trackSearchAnalyticsEvent parameter when paginating,
+      // as this logs the search term on every page request.
+      // Instead, we log the term only once, when the search is first performed.
+      // See: https://scayle.dev/en/developer-guide/products/search#scayle-search-analytics
+      trackSearchAnalyticsEvent: !!(params?.page === 1 && appliedFilter.value.term),
       ...params
     }),
     key: fetchingKey || `${toValue(categoryId)}-products`,
@@ -57,7 +56,7 @@ export function useProductsByCategory(categoryId, route, {
     return productsData.data.value?.pagination;
   });
   const totalProductsCount = computed(() => {
-    return productsData.data.value?.pagination.total ?? 0;
+    return productsData.data.value?.pagination?.total ?? 0;
   });
   const paginationOffset = computed(() => {
     const page = pagination.value?.page ?? 1;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-product-listing",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "Collection of essential composables and utilities to work with product listing",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -57,12 +57,12 @@
     "@nuxt/schema": "3.13.2",
     "@nuxt/test-utils": "3.14.4",
     "@scayle/eslint-config-storefront": "4.3.2",
-    "@scayle/storefront-nuxt": "7.95.0",
-    "@types/node": "22.9.0",
+    "@scayle/storefront-nuxt": "7.95.1",
+    "@types/node": "22.9.1",
     "@vue/test-utils": "2.4.6",
     "@vueuse/core": "11.2.0",
     "dprint": "0.47.5",
-    "eslint": "9.14.0",
+    "eslint": "9.15.0",
     "happy-dom": "15.11.6",
     "eslint-formatter-gitlab": "5.1.0",
     "nuxt": "3.13.2",