@scayle/storefront-product-listing 0.4.1 → 0.5.0

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

@@ -6,7 +6,7 @@ export type ProductListFilterOptions = Partial<{
     immediate: boolean;
     keyPrefix: string;
 }>;
-export type UseProductListFilterReturn = Pick<Awaited<ReturnType<typeof useFilters>>, 'error' | 'status' | 'fetch' | 'fetching'> & {
+export type UseProductListFilterReturn = Pick<Awaited<ReturnType<typeof useFilters>>, 'error' | 'status' | 'refresh'> & {
     availableFilters: ComputedRef<FilterItemWithValues[]>;
     clearedPriceQuery: ComputedRef<LocationQuery | undefined>;
     unfilteredCount: ComputedRef<number>;

package/dist/runtime/composables/useProductListFilter.js

@@ -16,13 +16,11 @@ export function useProductListFilter(route, currentCategoryId, options = {}) {
       includeSellableForFree: true,
       includeSoldOut: false
     })),
-    options: { immediate },
-    key: `${toValue(currentCategoryId) ?? keyPrefix}-filters`
-  });
+    options: { immediate }
+  }, `${toValue(currentCategoryId) ?? keyPrefix}-filters`);
   const {
     data,
-    fetch,
-    fetching,
+    refresh,
     status,
     error
   } = filterData;
@@ -47,9 +45,8 @@ export function useProductListFilter(route, currentCategoryId, options = {}) {
     return getClearedPriceQuery(route);
   });
   return extendPromise(filterData.then(() => ({})), {
-    fetch,
+    refresh,
     status,
-    fetching,
     error,
     availableFilters,
     unfilteredCount,

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

@@ -3,7 +3,7 @@ import { type MaybeRefOrGetter, type ComputedRef } from 'vue';
 import { useProducts } from '@scayle/storefront-nuxt/composables';
 import type { Pagination } from '@scayle/storefront-api';
 import type { RouteLocationNormalizedLoadedGeneric } from 'vue-router';
-export type UseProductsByCategoryReturn = Pick<Awaited<ReturnType<typeof useProducts>>, 'error' | 'fetching'> & {
+export type UseProductsByCategoryReturn = Pick<Awaited<ReturnType<typeof useProducts>>, 'error' | 'status'> & {
     products: ComputedRef<Product[]>;
     pagination: ComputedRef<Pagination | undefined>;
     totalProductsCount: ComputedRef<number>;

package/dist/runtime/composables/useProductsByCategory.js

@@ -39,11 +39,15 @@ 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`,
     options: fetchingOptions
-  });
+  }, fetchingKey || `${toValue(categoryId)}-products`);
   const products = computed(() => {
     return productsData.data.value?.products ?? [];
   });
@@ -62,7 +66,7 @@ export function useProductsByCategory(categoryId, route, {
     productsData.then(() => ({})),
     {
       error: productsData.error,
-      fetching: productsData.fetching,
+      status: productsData.status,
       products,
       pagination,
       totalProductsCount,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-product-listing",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "Collection of essential composables and utilities to work with product listing",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -45,11 +45,11 @@
   },
   "peerDependencies": {
     "@nuxt/kit": "^3.13.0",
-    "@scayle/storefront-nuxt": "^7.93.0",
+    "@scayle/storefront-nuxt": "^7.93.0 || ^8.0.0",
     "@vue/test-utils": "2.4.6",
-    "@vueuse/core": "11.2.0",
+    "@vueuse/core": "12.0.0",
     "fishery": "2.2.2",
-    "vue-router": "4.4.5"
+    "vue-router": "4.5.0"
   },
   "devDependencies": {
     "@nuxt/kit": "3.13.2",
@@ -57,20 +57,20 @@
     "@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": "8.0.0",
+    "@types/node": "22.10.1",
     "@vue/test-utils": "2.4.6",
-    "@vueuse/core": "11.2.0",
-    "dprint": "0.47.5",
-    "eslint": "9.14.0",
-    "happy-dom": "15.11.6",
+    "@vueuse/core": "12.0.0",
+    "dprint": "0.47.6",
+    "eslint": "9.16.0",
+    "happy-dom": "15.11.7",
     "eslint-formatter-gitlab": "5.1.0",
     "nuxt": "3.13.2",
     "publint": "0.2.12",
     "typescript": "5.6.3",
-    "vitest": "2.1.5",
+    "vitest": "2.1.8",
     "schema-dts": "1.1.2",
-    "vue-router": "4.4.5",
+    "vue-router": "4.5.0",
     "fishery": "2.2.2",
     "vue-tsc": "2.1.10"
   }