@scayle/storefront-product-listing 2.0.2 → 2.1.1

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @scayle/storefront-product-listing
 
+## 2.1.1
+
+### Patch Changes
+
+- Use latest `nuxt@3.19.2` for build. Compatibility with previous version has not changed and is specified via package `peerDependencies` and Nuxt `compatibility` flag.
+
+## 2.1.0
+
+### Minor Changes
+
+- Added support for custom filter prefix for filter utility functions.
+
+  Following functions now accept a `filterPrefix` parameter that can be used to customize the filter prefix.
+
+  - `parseFilterDataFromRoute`
+  - `createNewAttributeQuery`
+  - `createNewPriceQuery`
+  - `createNewReductionQuery`
+  - `createNewBoolAttributeQuery`
+  - `getClearedPriceQuery`
+  - `getClearedReductionQuery`
+  - `getClearedFilterQueryByKey`
+  - `buildQueryFromCategoryFilters`
+
 ## 2.0.2
 
 ### Patch Changes

package/dist/module.json

@@ -1,13 +1,13 @@
 {
   "name": "@scayle/storefront-product-listing",
   "configKey": "product-listing",
-  "version": "2.0.2",
+  "version": "2.1.1",
   "compatibility": {
     "bridge": false,
     "nuxt": ">=3.13"
   },
   "builder": {
-    "@nuxt/module-builder": "1.0.1",
-    "unbuild": "3.5.0"
+    "@nuxt/module-builder": "1.0.2",
+    "unbuild": "3.6.1"
   }
 }

package/dist/module.mjs

@@ -1,7 +1,7 @@
 import { defineNuxtModule, createResolver, addImportsDir } from '@nuxt/kit';
 
 const PACKAGE_NAME = "@scayle/storefront-product-listing";
-const PACKAGE_VERSION = "2.0.2";
+const PACKAGE_VERSION = "2.1.1";
 const module = defineNuxtModule({
   meta: {
     name: PACKAGE_NAME,

package/dist/runtime/utils/filters.d.ts

@@ -18,33 +18,36 @@ export declare const parseFilterDataFromRoute: (query: LocationQuery, filtersPre
  * @param param An object containing the slug and ID of the attribute.
  * @param param.slug The slug of the attribute.
  * @param param.id The ID of the attribute.
+ * @param filterPrefix The prefix used for filter query parameters.
  *
  * @returns A new query object with the updated attribute filter.
  */
 export declare const createNewAttributeQuery: (route: RouteLocationNormalizedLoadedGeneric, appliedFilter: ProductSearchQuery, { slug, id }: {
     slug: string;
     id: number;
-}) => LocationQuery;
+}, filterPrefix?: string) => LocationQuery;
 /**
  * Creates a new price filter query object.
  *
  * @param {RouteLocationNormalizedLoadedGeneric} route - The Vue Router route object.
  * @param {ProductSearchQuery} appliedFilter - The currently applied filter.
  * @param {RangeTuple} prices - The new price range.
+ * @param filterPrefix The prefix used for filter query parameters.
  *
  * @returns {LocationQuery} A new query object with the updated price filter.
  */
-export declare const createNewPriceQuery: (route: RouteLocationNormalizedLoadedGeneric, appliedFilter: ProductSearchQuery, prices: RangeTuple) => LocationQuery;
+export declare const createNewPriceQuery: (route: RouteLocationNormalizedLoadedGeneric, appliedFilter: ProductSearchQuery, prices: RangeTuple, filterPrefix?: string) => LocationQuery;
 /**
  * Creates a new reduction filter query object.
  *
  * @param route - The Vue Router route object.
  * @param appliedFilter - The currently applied filter.
  * @param reductions - The new reduction range.
+ * @param filterPrefix The prefix used for filter query parameters.
  *
  * @returns A new query object with the updated reduction filter.
  */
-export declare const createNewReductionQuery: (route: RouteLocationNormalizedLoadedGeneric, appliedFilter: ProductSearchQuery, reductions: RangeTuple) => LocationQuery;
+export declare const createNewReductionQuery: (route: RouteLocationNormalizedLoadedGeneric, appliedFilter: ProductSearchQuery, reductions: RangeTuple, filterPrefix?: string) => LocationQuery;
 /**
  * Creates a new boolean attribute filter query object.
  *
@@ -53,27 +56,30 @@ export declare const createNewReductionQuery: (route: RouteLocationNormalizedLoa
  * @param param - An object containing the slug and value of the boolean attribute.
  * @param param.slug - The slug of the attribute.
  * @param param.value - The value of the attribute.
+ * @param filterPrefix The prefix used for filter query parameters.
  *
  * @returns A new query object with the updated boolean attribute filter.
  */
 export declare const createNewBoolAttributeQuery: (route: RouteLocationNormalizedLoadedGeneric, appliedFilter: ProductSearchQuery, { slug, value }: {
     slug: string;
     value: boolean;
-}) => LocationQuery;
+}, filterPrefix?: string) => LocationQuery;
 /**
  * Returns a new query object with the filter for the specified key cleared.
  *
  * @param route - The Vue Router route object.
  * @param key - The key of the filter to clear.
+ * @param filterPrefix The prefix used for filter query parameters.
  *
  * @returns A new query object with the filter cleared.
  */
-export declare const getClearedFilterQueryByKey: (route: RouteLocationNormalizedLoadedGeneric, key: string) => LocationQuery;
+export declare const getClearedFilterQueryByKey: (route: RouteLocationNormalizedLoadedGeneric, key: string, filterPrefix?: string) => LocationQuery;
 /**
  * Builds a new query object from category filters.
  *
  * @param filters - Category filters.
+ * @param filterPrefix The prefix used for filter query parameters.
  *
  * @returns A new query object from Category filters.
  */
-export declare const buildQueryFromCategoryFilters: (filters: CategoryFilter[]) => LocationQuery;
+export declare const buildQueryFromCategoryFilters: (filters: CategoryFilter[], filterPrefix?: string) => LocationQuery;

package/dist/runtime/utils/filters.js

@@ -50,11 +50,11 @@ export const parseFilterDataFromRoute = (query, filtersPrefix) => {
   });
   return productSearchQuery;
 };
-export const createNewAttributeQuery = (route, appliedFilter, { slug, id }) => {
+export const createNewAttributeQuery = (route, appliedFilter, { slug, id }, filterPrefix = "filters") => {
   const attributeFilterQuery = {};
   const query = { ...route.query };
   const attribute = appliedFilter.attributes?.find(({ key: key2 }) => key2 === slug);
-  const key = `filters[${slug}]`;
+  const key = `${filterPrefix}[${slug}]`;
   if (!attribute) {
     attributeFilterQuery[key] = `${id}`;
     return { ...query, ...attributeFilterQuery };
@@ -76,32 +76,32 @@ export const createNewAttributeQuery = (route, appliedFilter, { slug, id }) => {
   attributeFilterQuery[key] = values.join(",");
   return { ...query, ...attributeFilterQuery };
 };
-export const createNewPriceQuery = (route, appliedFilter, prices) => {
+export const createNewPriceQuery = (route, appliedFilter, prices, filterPrefix = "filters") => {
   const priceFilterQuery = {};
   const query = { ...route.query };
   if (appliedFilter.minPrice !== prices[0]) {
-    priceFilterQuery["filters[minPrice]"] = prices[0].toString();
+    priceFilterQuery[`${filterPrefix}[minPrice]`] = prices[0].toString();
   }
   if (appliedFilter.maxPrice !== prices[1]) {
-    priceFilterQuery["filters[maxPrice]"] = prices[1].toString();
+    priceFilterQuery[`${filterPrefix}[maxPrice]`] = prices[1].toString();
   }
   return { ...query, ...priceFilterQuery };
 };
-export const createNewReductionQuery = (route, appliedFilter, reductions) => {
+export const createNewReductionQuery = (route, appliedFilter, reductions, filterPrefix = "filters") => {
   const priceFilterQuery = {};
   if (appliedFilter.minReduction !== reductions[0]) {
-    priceFilterQuery["filters[minReduction]"] = reductions[0].toString();
+    priceFilterQuery[`${filterPrefix}[minReduction]`] = reductions[0].toString();
   }
   if (appliedFilter.maxReduction !== reductions[1]) {
-    priceFilterQuery["filters[maxReduction]"] = reductions[1].toString();
+    priceFilterQuery[`${filterPrefix}[maxReduction]`] = reductions[1].toString();
   }
   return { ...route.query, ...priceFilterQuery };
 };
-export const createNewBoolAttributeQuery = (route, appliedFilter, { slug, value }) => {
+export const createNewBoolAttributeQuery = (route, appliedFilter, { slug, value }, filterPrefix = "filters") => {
   const booleanFilterQuery = {};
   const query = { ...route.query };
   const attribute = appliedFilter.attributes?.find(({ key: key2 }) => key2 === slug);
-  const key = `filters[${slug}]`;
+  const key = `${filterPrefix}[${slug}]`;
   if (!attribute) {
     booleanFilterQuery[key] = String(value);
     return { ...query, ...booleanFilterQuery };
@@ -116,52 +116,52 @@ export const createNewBoolAttributeQuery = (route, appliedFilter, { slug, value
   booleanFilterQuery[key] = String(value);
   return { ...query, ...booleanFilterQuery };
 };
-const getClearedPriceQuery = (route) => {
+const getClearedPriceQuery = (route, filterPrefix = "filters") => {
   const query = { ...route.query };
-  if (query["filters[maxPrice]"]) {
-    delete query["filters[maxPrice]"];
+  if (query[`${filterPrefix}[maxPrice]`]) {
+    delete query[`${filterPrefix}[maxPrice]`];
   }
-  if (query["filters[minPrice]"]) {
-    delete query["filters[minPrice]"];
+  if (query[`${filterPrefix}[minPrice]`]) {
+    delete query[`${filterPrefix}[minPrice]`];
   }
   return query;
 };
-const getClearedReductionQuery = (route) => {
+const getClearedReductionQuery = (route, filterPrefix = "filters") => {
   const query = { ...route.query };
-  if (query["filters[maxReduction]"]) {
-    delete query["filters[maxReduction]"];
+  if (query[`${filterPrefix}[maxReduction]`]) {
+    delete query[`${filterPrefix}[maxReduction]`];
   }
-  if (query["filters[minReduction]"]) {
-    delete query["filters[minReduction]"];
+  if (query[`${filterPrefix}[minReduction]`]) {
+    delete query[`${filterPrefix}[minReduction]`];
   }
   return query;
 };
-export const getClearedFilterQueryByKey = (route, key) => {
+export const getClearedFilterQueryByKey = (route, key, filterPrefix = "filters") => {
   if (key === "prices") {
-    return getClearedPriceQuery(route);
+    return getClearedPriceQuery(route, filterPrefix);
   }
   if (key === "reductions") {
-    return getClearedReductionQuery(route);
+    return getClearedReductionQuery(route, filterPrefix);
   }
   const query = { ...route.query };
-  const filterKey = `filters[${key}]`;
+  const filterKey = `${filterPrefix}[${key}]`;
   if (query[filterKey]) {
     delete query[filterKey];
   }
   return query;
 };
-export const buildQueryFromCategoryFilters = (filters) => {
+export const buildQueryFromCategoryFilters = (filters, filterPrefix = "filters") => {
   return filters.reduce((query, filter) => {
     switch (filter.type) {
       case "attribute":
         return {
           ...query,
-          [`filters[${filter.attributeFilter.group.key}]`]: filter.attributeFilter.values.map(({ id }) => id).join(",")
+          [`${filterPrefix}[${filter.attributeFilter.group.key}]`]: filter.attributeFilter.values.map(({ id }) => id).join(",")
         };
       case "boolean":
         return {
           ...query,
-          [`filters[${filter.booleanFilter.slug}]`]: "true"
+          [`${filterPrefix}[${filter.booleanFilter.slug}]`]: "true"
         };
     }
     return query;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-product-listing",
-  "version": "2.0.2",
+  "version": "2.1.1",
   "description": "Collection of essential composables and utilities to work with product listing",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -41,29 +41,30 @@
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.18.2",
-    "@nuxt/kit": "3.17.7",
-    "@nuxt/module-builder": "1.0.1",
-    "@nuxt/schema": "3.17.7",
+    "@nuxt/kit": "3.19.2",
+    "@nuxt/module-builder": "1.0.2",
+    "@nuxt/schema": "3.19.2",
     "@nuxt/test-utils": "3.19.2",
-    "@types/node": "22.16.5",
+    "@types/node": "22.18.3",
     "@vitest/coverage-v8": "3.2.4",
-    "@vueuse/core": "13.5.0",
-    "dprint": "0.50.1",
+    "@vueuse/core": "13.9.0",
+    "dprint": "0.50.2",
     "eslint-formatter-gitlab": "6.0.1",
-    "eslint": "9.31.0",
+    "eslint": "9.35.0",
     "fishery": "2.3.1",
     "happy-dom": "18.0.1",
-    "nuxt": "3.17.7",
+    "nuxt": "3.19.2",
     "publint": "0.3.12",
     "schema-dts": "1.1.5",
-    "typescript": "5.8.3",
-    "unbuild": "3.5.0",
+    "typescript": "5.9.2",
+    "unbuild": "3.6.1",
     "vitest": "3.2.4",
     "vue-router": "4.5.1",
-    "vue-tsc": "3.0.3",
-    "vue": "3.5.17",
-    "@scayle/storefront-nuxt": "8.37.0",
-    "@scayle/eslint-config-storefront": "4.7.0"
+    "vue-tsc": "3.0.7",
+    "vue": "3.5.21",
+    "@scayle/eslint-config-storefront": "4.7.8",
+    "@scayle/storefront-nuxt": "8.44.1",
+    "@scayle/vitest-config-storefront": "1.0.0"
   },
   "scripts": {
     "build": "nuxt-module-build build",