@scayle/storefront-core 8.30.3 → 8.32.0

package/CHANGELOG.md

@@ -1,5 +1,41 @@
 # @scayle/storefront-core
 
+## 8.32.0
+
+### Minor Changes
+
+- Added `minReduction` and `maxReduction` filter parameters to the `FetchProductsCountParams.where` type and updated the `getProductsCount` RPC method to accept and handle these new reduction-based filtering conditions.
+
+### Patch Changes
+
+- Fixed the `getFilters` RPC method to properly apply `minReduction` and `maxReduction` filter parameters when fetching product counts.
+
+## 8.31.0
+
+### Minor Changes
+
+- Added `minReduction` and `maxReduction` filter parameters to `FetchProductsByCategoryParams.where` and `FetchFiltersParams.where` types, and updated the `getProductsByCategory` and `getFilters` RPC methods to accept and handle these new reduction-based filtering conditions.
+
+  ```ts
+  const { data } = useRpc("getFilters", "getFiltersKey", () => ({
+    where: {
+      minReduction: 10,
+      maxReduction: 20,
+    },
+  }));
+
+  const { data } = useRpc(
+    "getProductsByCategory",
+    "getProductsByCategoryKey",
+    () => ({
+      where: {
+        minReduction: 10,
+        maxReduction: 20,
+      },
+    }),
+  );
+  ```
+
 ## 8.30.3
 
 No changes in this release.
@@ -28,28 +64,28 @@ No changes in this release.
 
   ```ts
   export const existingHandlerWithoutParams = async (_context: RpcContext) => {
-    return 'existing handler'
-  }
+    return "existing handler";
+  };
 
   export const existingHandlerWithParams = async (
     { name }: { name: string },
     _context: RpcContext,
   ) => {
-    return name
-  }
+    return name;
+  };
 
   // will become
 
   export const existingHandlerWithoutParams = defineRpcHandler(
     async (_context: RpcContext) => {
-      return 'existing handler'
+      return "existing handler";
     },
-  )
+  );
   export const existingHandlerWithParams = defineRpcHandler(
     async ({ name }: { name: string }, _context: RpcContext) => {
-      return name
+      return name;
     },
-  )
+  );
   ```
 
 ### Patch Changes
@@ -66,15 +102,15 @@ No changes in this release.
 - Added an optional `hideEmptyCategories` parameter to `getCategoryTree`. When enabled, the product count for each category is retrieved, and categories (including their children) without any products are removed. Enabling this option may increase response times, especially for large category trees.
 
   ```ts
-  import { rpcMethods } from '@scayle/storefront-core'
+  import { rpcMethods } from "@scayle/storefront-core";
 
-  rpcMethods.getCategoryTree({ hideEmptyCategories: true }, rpcContext)
+  rpcMethods.getCategoryTree({ hideEmptyCategories: true }, rpcContext);
   ```
 
   or
 
   ```ts
-  import { useCategoryTree } from '#storefront/composables'
+  import { useCategoryTree } from "#storefront/composables";
 
   const { data: rootCategories, status } = useCategoryTree(
     {
@@ -82,8 +118,8 @@ No changes in this release.
         hideEmptyCategories: true,
       },
     },
-    'category-navigation-tree',
-  )
+    "category-navigation-tree",
+  );
   ```
 
 ### Patch Changes
@@ -515,12 +551,12 @@ To get the default campaign key, you can call the RPC method:
 ```typescript
 // Before
 async function rpcMethod(context) {
-  const campaignKey = { context }
+  const campaignKey = { context };
   // ...
 }
 // After
 async function rpcMethod(context) {
-  const campaignKey = await context.callRpc?.('getCampaignKey')
+  const campaignKey = await context.callRpc?.("getCampaignKey");
   // ...
 }
 ```
@@ -709,43 +745,43 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
 
     ```ts
     const BadgeLabel = {
-      NEW: 'new',
-      SOLD_OUT: 'sold_out',
-      ONLINE_EXCLUSIVE: 'online_exclusive',
-      SUSTAINABLE: 'sustainable',
-      PREMIUM: 'premium',
-      DEFAULT: '',
-    } as const
+      NEW: "new",
+      SOLD_OUT: "sold_out",
+      ONLINE_EXCLUSIVE: "online_exclusive",
+      SUSTAINABLE: "sustainable",
+      PREMIUM: "premium",
+      DEFAULT: "",
+    } as const;
 
     type BadgeLabelParamsKeys =
-      | 'isNew'
-      | 'isSoldOut'
-      | 'isOnlineOnly'
-      | 'isSustainable'
-      | 'isPremium'
-    type BadgeLabelParams = Partial<Record<BadgeLabelParamsKeys, boolean>>
+      | "isNew"
+      | "isSoldOut"
+      | "isOnlineOnly"
+      | "isSustainable"
+      | "isPremium";
+    type BadgeLabelParams = Partial<Record<BadgeLabelParamsKeys, boolean>>;
 
     const getBadgeLabel = (params: BadgeLabelParams = {}): string => {
       if (!params) {
-        return BadgeLabel.DEFAULT
+        return BadgeLabel.DEFAULT;
       }
       const { isNew, isSoldOut, isOnlineOnly, isSustainable, isPremium } =
-        params
+        params;
 
       if (isNew) {
-        return BadgeLabel.NEW
+        return BadgeLabel.NEW;
       } else if (isSoldOut) {
-        return BadgeLabel.SOLD_OUT
+        return BadgeLabel.SOLD_OUT;
       } else if (isOnlineOnly) {
-        return BadgeLabel.ONLINE_EXCLUSIVE
+        return BadgeLabel.ONLINE_EXCLUSIVE;
       } else if (isSustainable) {
-        return BadgeLabel.SUSTAINABLE
+        return BadgeLabel.SUSTAINABLE;
       } else if (isPremium) {
-        return BadgeLabel.PREMIUM
+        return BadgeLabel.PREMIUM;
       } else {
-        return BadgeLabel.DEFAULT
+        return BadgeLabel.DEFAULT;
       }
-    }
+    };
     ```
 
 - **\[💥 BREAKING\]** We've standardized our configuration to use `sapi` (Storefront API) throughout the codebase, replacing the deprecated `bapi` keyword. This change improves clarity and consistency by removing the `initBapi` function, replacing the `bapiClient` property with `sapiClient` within the `RPCContext`, and updating all code references accordingly. `BapiConfig` is not exported anymore and has been superseded by `SapiConfig`.
@@ -761,15 +797,15 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
         storefront: {
           // ...
           bapi: {
-            host: '...',
-            token: '...',
+            host: "...",
+            token: "...",
           },
           // ...
         },
         // ...
       },
       // ...
-    }
+    };
     ```
 
   - _Legacy Environment Variables:_
@@ -789,15 +825,15 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
         storefront: {
           // ...
           sapi: {
-            host: '...',
-            token: '...',
+            host: "...",
+            token: "...",
           },
           // ...
         },
         // ...
       },
       // ...
-    }
+    };
     ```
 
   - _New Environment Variables:_
@@ -815,19 +851,19 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
 
     ```ts
     const { data, fetching, fetch, error, status } = useUser(
-      'getUser',
+      "getUser",
       // ...
-    )
-    data.value.user.authentication.storefrontAccessToken
+    );
+    data.value.user.authentication.storefrontAccessToken;
     ```
 
   - _Current Usage of dedicated `getAccessToken` RPC method:_
 
     ```ts
     const { data: accessToken } = useRpc(
-      'getAccessToken',
+      "getAccessToken",
       // ...
-    )
+    );
     ```
 
 - **\[💥 BREAKING\]** We've enhanced security for basket and wishlist keys by switching the default hashing algorithm from MD5 to the more robust SHA256.
@@ -850,7 +886,7 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
         // ...
       },
       // ...
-    })
+    });
     ```
 
 - **\[💥 BREAKING\]** The attribute `loginShopId` is removed from the `ShopUser` interface as the shop now uses session cookies.
@@ -859,23 +895,23 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
   - _Previous Usage of `searchProducts` RPC method:_
 
     ```ts
-    const getSearchSuggestionsRpc = useRpcCall('searchProducts')
+    const getSearchSuggestionsRpc = useRpcCall("searchProducts");
 
     data.value = await searchProducts({
       term: String(searchQuery.value),
       ...params,
-    })
+    });
     ```
 
   - _Current Usage of `getSearchSuggestions` RPC method:_
 
     ```ts
-    const getSearchSuggestionsRpc = useRpcCall('getSearchSuggestions')
+    const getSearchSuggestionsRpc = useRpcCall("getSearchSuggestions");
 
     data.value = await getSearchSuggestionsRpc({
       term: String(searchQuery.value),
       ...params,
-    })
+    });
     ```
 
 - **\[💥 BREAKING\]** Improved basket updating: Adding an item to your basket with a reduced quantity will now correctly update the basket contents.

package/dist/rpc/methods/checkout/checkout.mjs

@@ -36,7 +36,7 @@ export const getCheckoutToken = async function getCheckoutToken2(jwtPayload = {}
     carrier,
     basketId: context.basketKey,
     campaignKey
-  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.30.3"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.32.0"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
   return {
     accessToken: refreshedAccessToken,
     checkoutJwt

package/dist/rpc/methods/products.d.ts

@@ -129,6 +129,8 @@ export declare const fetchAllFiltersForCategory: RpcHandler<{
  * @param params.where The where clause for filtering.
  * @param params.where.minPrice Minimum price.
  * @param params.where.maxPrice Maximum price.
+ * @param params.where.minReduction Minimum reduction.
+ * @param params.where.maxReduction Maximum reduction.
  * @param params.where.term Search term.
  * @param params.where.attributes Attributes for filtering.
  * @param params.where.whitelistAttributes Whitelisted attributes.
@@ -158,6 +160,8 @@ export declare const getFilters: RpcHandler<FetchFiltersParams, FetchFiltersResp
  * @param params.where The where clause for filtering.
  * @param params.where.minPrice Minimum price.
  * @param params.where.maxPrice Maximum price.
+ * @param params.where.minReduction Minimum reduction.
+ * @param params.where.maxReduction Maximum reduction.
  * @param params.where.term Search term.
  * @param params.where.attributes Attributes for filtering.
  * @param params.where.whitelistAttributes Whitelisted attributes.

package/dist/rpc/methods/products.mjs

@@ -107,6 +107,8 @@ export const getProductsCount = async function getProductsCount2(params, context
       categoryId,
       minPrice: where?.minPrice,
       maxPrice: where?.maxPrice,
+      minReduction: where?.minReduction,
+      maxReduction: where?.maxReduction,
       term: where?.term,
       attributes: [
         ...sanitizedAttributes,
@@ -193,6 +195,8 @@ export const getFilters = async function getFilters2(params, context) {
         categoryId,
         minPrice: where?.minPrice,
         maxPrice: where?.maxPrice,
+        minReduction: where?.minReduction,
+        maxReduction: where?.maxReduction,
         term: where?.term,
         attributes: [
           ...sanitizedAttributes,
@@ -213,6 +217,8 @@ export const getFilters = async function getFilters2(params, context) {
         categoryId,
         minPrice: where?.minPrice,
         maxPrice: where?.maxPrice,
+        minReduction: where?.minReduction,
+        maxReduction: where?.maxReduction,
         term: where?.term,
         attributes: [
           ...sanitizedAttributes,
@@ -277,6 +283,8 @@ export const getProductsByCategory = async function getProductsByCategory2(param
       categoryId,
       minPrice: where?.minPrice,
       maxPrice: where?.maxPrice,
+      minReduction: where?.minReduction,
+      maxReduction: where?.maxReduction,
       term: where?.term,
       attributes: [
         ...sanitizedAttributes,

package/dist/types/sapi/filter.d.ts

@@ -38,6 +38,10 @@ export type FetchFiltersParams = {
         minPrice?: ProductSearchQuery['minPrice'];
         /** The maximum price. */
         maxPrice?: ProductSearchQuery['maxPrice'];
+        /** The minimum reduction. */
+        minReduction?: ProductSearchQuery['minReduction'];
+        /** The maximum reduction. */
+        maxReduction?: ProductSearchQuery['maxReduction'];
         /** The attributes filter. */
         attributes?: ProductSearchQuery['attributes'];
         /** wether to disable fuzziness on term */

package/dist/types/sapi/product.d.ts

@@ -105,6 +105,8 @@ export type FetchProductsByCategoryParams = {
         term?: ProductSearchQuery['term'];
         minPrice?: ProductSearchQuery['minPrice'];
         maxPrice?: ProductSearchQuery['maxPrice'];
+        minReduction?: ProductSearchQuery['minReduction'];
+        maxReduction?: ProductSearchQuery['maxReduction'];
         attributes?: ProductSearchQuery['attributes'];
         disableFuzziness?: ProductSearchQuery['disableFuzziness'];
         whitelistAttributes?: ProductSearchQuery['attributes'];
@@ -147,6 +149,8 @@ export type FetchProductsCountParams = {
         term?: ProductSearchQuery['term'];
         minPrice?: ProductSearchQuery['minPrice'];
         maxPrice?: ProductSearchQuery['maxPrice'];
+        minReduction?: ProductSearchQuery['minReduction'];
+        maxReduction?: ProductSearchQuery['maxReduction'];
         attributes?: ProductSearchQuery['attributes'];
         disableFuzziness?: ProductSearchQuery['disableFuzziness'];
         whitelistAttributes?: ProductSearchQuery['attributes'];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "8.30.3",
+  "version": "8.32.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -45,21 +45,6 @@
   "engines": {
     "node": ">= 18.15.0"
   },
-  "scripts": {
-    "clean": "rimraf ./dist",
-    "build:legacy": "tsc -p tsconfig.legacy.json",
-    "build": "unbuild",
-    "typecheck": "tsc --noEmit -p tsconfig.json",
-    "format": "dprint check",
-    "format:fix": "dprint fmt",
-    "lint": "eslint .",
-    "lint:ci": "eslint . --format gitlab",
-    "lint:fix": "eslint . --fix",
-    "package:lint": "publint",
-    "test:watch": "vitest",
-    "test": "vitest --run",
-    "test:ci": "vitest --run --coverage --reporter=default --reporter=junit --outputFile=./coverage/junit.xml"
-  },
   "peerDependencies": {
     "fishery": "^2.2.3"
   },
@@ -75,16 +60,16 @@
     "utility-types": "^3.11.0"
   },
   "devDependencies": {
-    "@scayle/eslint-config-storefront": "4.5.10",
+    "@scayle/eslint-config-storefront": "4.5.12",
     "@types/crypto-js": "4.2.2",
-    "@types/node": "22.15.32",
+    "@types/node": "22.15.34",
     "@types/webpack-env": "1.18.8",
     "@vitest/coverage-v8": "3.2.4",
-    "dprint": "0.50.0",
+    "dprint": "0.50.1",
     "eslint-formatter-gitlab": "6.0.1",
-    "eslint": "9.29.0",
+    "eslint": "9.30.0",
     "fishery": "2.3.1",
-    "publint": "0.2.12",
+    "publint": "0.3.12",
     "rimraf": "6.0.1",
     "typescript": "5.8.3",
     "unbuild": "3.5.0",
@@ -92,6 +77,21 @@
     "vitest": "3.2.4"
   },
   "volta": {
-    "node": "22.16.0"
+    "node": "22.17.0"
+  },
+  "scripts": {
+    "clean": "rimraf ./dist",
+    "build:legacy": "tsc -p tsconfig.legacy.json",
+    "build": "unbuild",
+    "typecheck": "tsc --noEmit -p tsconfig.json",
+    "format": "dprint check",
+    "format:fix": "dprint fmt",
+    "lint": "eslint .",
+    "lint:ci": "eslint . --format gitlab",
+    "lint:fix": "eslint . --fix",
+    "package:lint": "publint",
+    "test:watch": "vitest",
+    "test": "vitest --run",
+    "test:ci": "vitest --run --coverage --reporter=default --reporter=junit --outputFile=./coverage/junit.xml"
   }
-}
+}