@scayle/storefront-nuxt 8.25.5 → 8.26.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @scayle/storefront-nuxt
 
+## 8.26.0
+
+### Minor Changes
+
+- **\[Utilities\]** Added `useProductPrice` composable to simplify accessing price data like total price, strike-through prices, and applied reductions.
+
+### Patch Changes
+
+**Dependencies**
+
+**@scayle/storefront-core v8.26.0**
+
+- No changes in this release.
+
+## 8.25.6
+
+### Patch Changes
+
+**Dependencies**
+
+**@scayle/storefront-core v8.25.6**
+
+- No changes in this release.
+
 ## 8.25.5
 
 ### Patch Changes

package/dist/module.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-nuxt",
-  "version": "8.25.5",
+  "version": "8.26.0",
   "configKey": "storefront",
   "compatibility": {
     "nuxt": "^3.9.0"

package/dist/module.mjs

@@ -54,7 +54,7 @@ export default {
 }`;
 }
 const PACKAGE_NAME = "@scayle/storefront-nuxt";
-const PACKAGE_VERSION = "8.25.5";
+const PACKAGE_VERSION = "8.26.0";
 const logger = createConsola({
   fancy: true,
   formatOptions: {
@@ -387,6 +387,7 @@ const module = defineNuxtModule({
     });
     addImportsDir(resolve("runtime/composables/storefront"));
     addImportsDir(resolve("runtime/composables/core"));
+    addImportsDir(resolve("runtime/composables"));
     addImportsDir(resolve("runtime/utils"));
     const keyedComposables = [
       "useBrand",

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

@@ -31,3 +31,4 @@ export * from './storefront/useStorefrontSearch.js';
 export * from './storefront/useUserAddresses.js';
 export * from './storefront/useVariant.js';
 export * from './storefront/useWishlist.js';
+export * from './useProductPrice.js';

package/dist/runtime/composables/index.js

@@ -31,3 +31,4 @@ export * from "./storefront/useStorefrontSearch.js";
 export * from "./storefront/useUserAddresses.js";
 export * from "./storefront/useVariant.js";
 export * from "./storefront/useWishlist.js";
+export * from "./useProductPrice.js";

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

@@ -0,0 +1,26 @@
+import type { ComputedRef, MaybeRefOrGetter } from 'vue';
+import type { AppliedReduction, BasketItem, CentAmount, OrderItem, Price } from '@scayle/storefront-core';
+type RelativeReductions = {
+    value: number;
+    category: 'promotion' | 'sale' | 'campaign' | 'voucher';
+};
+export type BasketItemPrice = BasketItem['price']['total'];
+export type OrderPrice = OrderItem['price'];
+export interface UseProductPriceReturn {
+    /** Ordered applied reductions. The first applied reduction will be in the first position of the array. */
+    appliedReductions: ComputedRef<AppliedReduction[]>;
+    /** Strike through prices, calculated by adding the reduction prices to the original price. */
+    strikeThroughPrices: ComputedRef<CentAmount[]>;
+    /** Reductions representing the relative amount and their respective categories. */
+    relativeReductions: ComputedRef<RelativeReductions[]>;
+    /** Total price with tax. */
+    totalPrice: ComputedRef<CentAmount>;
+}
+/**
+ * Composable for extracted product price data.
+ *
+ * @param price - Product or basket item price object containing all price relevant data.
+ * @returns An {@link UseProductPriceReturn} object containing product price reactive data.
+ */
+export declare function useProductPrice(price: MaybeRefOrGetter<Price | BasketItemPrice | OrderPrice>): UseProductPriceReturn;
+export {};

package/dist/runtime/composables/useProductPrice.js

@@ -0,0 +1,36 @@
+import { computed, toValue } from "vue";
+export function useProductPrice(price) {
+  const appliedReductions = computed(() => {
+    const reductions = toValue(price).appliedReductions ?? [];
+    return reductions.toReversed();
+  });
+  const strikeThroughPrices = computed(() => {
+    return appliedReductions.value.reduce(
+      ({ prices, currentPrice }, { amount }) => {
+        currentPrice += amount.absoluteWithTax;
+        return {
+          currentPrice,
+          prices: [...prices, currentPrice]
+        };
+      },
+      {
+        prices: [],
+        currentPrice: toValue(price).withTax
+      }
+    ).prices;
+  });
+  const relativeReductions = computed(
+    () => appliedReductions.value.map(({ amount, category }) => {
+      return { value: Math.round(amount.relative * 100), category };
+    })
+  );
+  const totalPrice = computed(() => {
+    return toValue(price).withTax;
+  });
+  return {
+    appliedReductions,
+    strikeThroughPrices,
+    relativeReductions,
+    totalPrice
+  };
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "8.25.5",
+  "version": "8.26.0",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -81,7 +81,7 @@
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
     "@scayle/h3-session": "0.6.1",
-    "@scayle/storefront-core": "8.25.5",
+    "@scayle/storefront-core": "8.26.0",
     "@scayle/unstorage-compression-driver": "^0.2.7",
     "@vercel/nft": "0.29.3",
     "@vueuse/core": "13.2.0",
@@ -102,18 +102,18 @@
   "devDependencies": {
     "@arethetypeswrong/cli": "0.18.1",
     "@eslint/eslintrc": "3.3.1",
-    "@nuxt/eslint": "1.3.1",
+    "@nuxt/eslint": "1.4.0",
     "@nuxt/kit": "3.16.2",
     "@nuxt/module-builder": "1.0.1",
     "@nuxt/schema": "3.16.2",
-    "@nuxt/test-utils": "3.18.0",
+    "@nuxt/test-utils": "3.19.0",
     "@scayle/eslint-config-storefront": "4.5.2",
     "@scayle/eslint-plugin-vue-composable": "0.2.1",
     "@scayle/unstorage-scayle-kv-driver": "0.1.2",
     "@types/node": "22.15.18",
     "dprint": "0.49.1",
     "eslint-formatter-gitlab": "6.0.0",
-    "eslint": "9.26.0",
+    "eslint": "9.27.0",
     "fishery": "2.3.1",
     "h3": "1.15.3",
     "nitropack": "2.11.12",