@scayle/storefront-product-listing 1.6.3 → 1.7.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @scayle/storefront-product-listing
 
+## 1.7.0
+
+### Minor Changes
+
+- Export `defaultSortingOptions` and `DEFAULT_SORTING_KEY` from the `useProductListSort` composable.
+  This change enhances consumer flexibility, allowing for more granular adjustments to custom sorting options.
+
 ## 1.6.3
 
 ### Patch Changes

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-product-listing",
   "configKey": "product-listing",
-  "version": "1.6.3",
+  "version": "1.7.0",
   "compatibility": {
     "bridge": false,
     "nuxt": ">=3.13"

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 = "1.6.3";
+const PACKAGE_VERSION = "1.7.0";
 const module = defineNuxtModule({
   meta: {
     name: PACKAGE_NAME,

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

@@ -20,6 +20,38 @@ export interface ProductListSortOptions {
     sortingOptions?: SelectedSort[];
     defaultSortingKey?: string;
 }
+export declare const defaultSortingOptions: ({
+    key: string;
+    sortingKey: string;
+    direction: "desc";
+    label: string;
+    by?: undefined;
+} | {
+    key: string;
+    by: "new";
+    direction: "desc";
+    label: string;
+    sortingKey?: undefined;
+} | {
+    key: string;
+    by: "price";
+    direction: "desc";
+    label: string;
+    sortingKey?: undefined;
+} | {
+    key: string;
+    by: "price";
+    direction: "asc";
+    label: string;
+    sortingKey?: undefined;
+} | {
+    key: string;
+    by: "reduction";
+    direction: "desc";
+    label: string;
+    sortingKey?: undefined;
+})[];
+export declare const DEFAULT_SORTING_KEY = "top_seller";
 /**
  * Custom composable to handle product list sorting.
  *
@@ -30,5 +62,5 @@ export interface ProductListSortOptions {
  *
  * @returns Computed properties and methods related to sorting
  */
-export declare function useProductListSort(route: RouteLocationNormalizedLoadedGeneric, { sortingOptions, defaultSortingKey }?: ProductListSortOptions): UseProductListSortReturn;
+export declare function useProductListSort(route: RouteLocationNormalizedLoadedGeneric, { sortingOptions, defaultSortingKey, }?: ProductListSortOptions): UseProductListSortReturn;
 export {};

package/dist/runtime/composables/useProductListSort.js

@@ -1,44 +1,46 @@
 import { APISortOption, APISortOrder } from "@scayle/storefront-nuxt";
 import { computed } from "vue";
-export function useProductListSort(route, { sortingOptions, defaultSortingKey } = {
-  sortingOptions: [
-    {
-      key: "top_seller",
-      sortingKey: "scayle:v1:recommended",
-      direction: APISortOrder.DESCENDING,
-      label: "sorting_select.top_seller"
-    },
-    {
-      key: "date_newest",
-      by: APISortOption.DATE_ADDED,
-      direction: APISortOrder.DESCENDING,
-      label: "sorting_select.date_newest"
-    },
-    {
-      key: "price_desc",
-      by: APISortOption.PRICE,
-      direction: APISortOrder.DESCENDING,
-      label: "sorting_select.price_desc"
-    },
-    {
-      key: "price_asc",
-      by: APISortOption.PRICE,
-      direction: APISortOrder.ASCENDING,
-      label: "sorting_select.price_asc"
-    },
-    {
-      key: "reduction_desc",
-      by: APISortOption.REDUCTION,
-      direction: APISortOrder.DESCENDING,
-      label: "sorting_select.reduction_desc"
-    }
-  ],
-  defaultSortingKey: "top_seller"
-}) {
+export const defaultSortingOptions = [
+  {
+    key: "top_seller",
+    sortingKey: "scayle:v1:recommended",
+    direction: APISortOrder.DESCENDING,
+    label: "sorting_select.top_seller"
+  },
+  {
+    key: "date_newest",
+    by: APISortOption.DATE_ADDED,
+    direction: APISortOrder.DESCENDING,
+    label: "sorting_select.date_newest"
+  },
+  {
+    key: "price_desc",
+    by: APISortOption.PRICE,
+    direction: APISortOrder.DESCENDING,
+    label: "sorting_select.price_desc"
+  },
+  {
+    key: "price_asc",
+    by: APISortOption.PRICE,
+    direction: APISortOrder.ASCENDING,
+    label: "sorting_select.price_asc"
+  },
+  {
+    key: "reduction_desc",
+    by: APISortOption.REDUCTION,
+    direction: APISortOrder.DESCENDING,
+    label: "sorting_select.reduction_desc"
+  }
+];
+export const DEFAULT_SORTING_KEY = "top_seller";
+export function useProductListSort(route, {
+  sortingOptions = defaultSortingOptions,
+  defaultSortingKey = DEFAULT_SORTING_KEY
+} = {}) {
   const selectedSort = computed(() => {
-    const sort = route.query.sort && sortingOptions?.find((option) => option.key === route.query.sort);
+    const sort = sortingOptions.find(({ key }) => key === route.query.sort);
     if (!sort) {
-      return sortingOptions?.find((option) => option.key === defaultSortingKey);
+      return sortingOptions?.find(({ key }) => key === defaultSortingKey);
     }
     return sort;
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-product-listing",
-  "version": "1.6.3",
+  "version": "1.7.0",
   "description": "Collection of essential composables and utilities to work with product listing",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -65,15 +65,15 @@
     "@nuxt/schema": "3.16.2",
     "@nuxt/test-utils": "3.18.0",
     "@scayle/eslint-config-storefront": "4.5.5",
-    "@scayle/storefront-api": "18.8.0",
-    "@scayle/storefront-nuxt": "8.28.7",
-    "@types/node": "22.15.31",
+    "@scayle/storefront-api": "18.9.0",
+    "@scayle/storefront-nuxt": "8.29.0",
+    "@types/node": "22.15.32",
     "@vitest/coverage-v8": "3.2.3",
     "@vue/test-utils": "2.4.6",
     "@vueuse/core": "13.3.0",
     "dprint": "0.50.0",
     "eslint-formatter-gitlab": "6.0.1",
-    "eslint": "9.28.0",
+    "eslint": "9.29.0",
     "fishery": "2.3.1",
     "happy-dom": "18.0.1",
     "nuxt": "3.16.2",