@shopware/cms-base-layer 1.5.1 → 2.1.0

package/app/components/SwProductListingFiltersHorizontal.vue

@@ -0,0 +1,306 @@
+<script setup lang="ts">
+import type {
+  CmsElementProductListing,
+  CmsElementSidebarFilter,
+} from "@shopware/composables";
+import { useCmsTranslations } from "@shopware/composables";
+import { defu } from "defu";
+import { computed, reactive } from "vue";
+import type { ComputedRef, UnwrapNestedRefs } from "vue";
+import { type LocationQueryRaw, useRoute, useRouter } from "vue-router";
+import { useCategoryListing } from "#imports";
+import type { Schemas, operations } from "#shopware";
+
+const props = defineProps<{
+  content: CmsElementProductListing | CmsElementSidebarFilter;
+  listingType?: string;
+}>();
+
+type Translations = {
+  listing: {
+    filters: string;
+    sort: string;
+    resetFilters: string;
+  };
+};
+
+type FilterState = {
+  manufacturer: Set<string>;
+  properties: Set<string>;
+  "min-price": number | undefined;
+  "max-price": number | undefined;
+  rating: number | undefined;
+  "shipping-free": boolean | undefined;
+};
+
+let translations: Translations = {
+  listing: {
+    filters: "Filters",
+    sort: "Sort",
+    resetFilters: "Reset filters",
+  },
+};
+
+translations = defu(useCmsTranslations(), translations) as Translations;
+
+const route = useRoute();
+const router = useRouter();
+
+const {
+  changeCurrentSortingOrder,
+  getCurrentSortingOrder,
+  getInitialFilters,
+  getSortingOrders,
+  search,
+} = useCategoryListing();
+
+const sidebarSelectedFilters: UnwrapNestedRefs<FilterState> =
+  reactive<FilterState>({
+    manufacturer: new Set(),
+    properties: new Set(),
+    "min-price": undefined,
+    "max-price": undefined,
+    rating: undefined,
+    "shipping-free": undefined,
+  });
+
+const showResetFiltersButton = computed<boolean>(() => {
+  if (
+    sidebarSelectedFilters.manufacturer.size !== 0 ||
+    sidebarSelectedFilters.properties.size !== 0 ||
+    sidebarSelectedFilters["max-price"] ||
+    sidebarSelectedFilters["min-price"] ||
+    sidebarSelectedFilters.rating ||
+    sidebarSelectedFilters["shipping-free"]
+  ) {
+    return true;
+  }
+
+  return false;
+});
+
+const searchCriteriaForRequest: ComputedRef<Schemas["ProductListingCriteria"]> =
+  computed(() => ({
+    manufacturer: [
+      ...(sidebarSelectedFilters.manufacturer as Set<string>),
+    ]?.join("|"),
+    properties: [...(sidebarSelectedFilters.properties as Set<string>)]?.join(
+      "|",
+    ),
+    "min-price": sidebarSelectedFilters["min-price"] as number,
+    "max-price": sidebarSelectedFilters["max-price"] as number,
+    order: getCurrentSortingOrder.value as string,
+    "shipping-free": sidebarSelectedFilters["shipping-free"] as boolean,
+    rating: sidebarSelectedFilters.rating as number,
+    search: "",
+    limit: route.query.limit ? Number(route.query.limit) : 15,
+  }));
+
+for (const param in route.query) {
+  if (param in sidebarSelectedFilters) {
+    const queryValue = route.query[param];
+
+    // Skip arrays
+    if (Array.isArray(queryValue)) continue;
+
+    if (["manufacturer", "properties"].includes(param)) {
+      if (typeof queryValue === "string") {
+        const elements = queryValue.split("|");
+        const targetSet = sidebarSelectedFilters[
+          param as keyof FilterState
+        ] as Set<string>;
+        for (const element of elements) {
+          targetSet.add(element);
+        }
+      }
+    } else if (queryValue && typeof queryValue === "string") {
+      // Fix: Use specific property assignments instead of generic keyof
+      if (param === "min-price") {
+        const numValue = Number(queryValue);
+        if (!Number.isNaN(numValue)) {
+          sidebarSelectedFilters["min-price"] = numValue;
+        }
+      } else if (param === "max-price") {
+        const numValue = Number(queryValue);
+        if (!Number.isNaN(numValue)) {
+          sidebarSelectedFilters["max-price"] = numValue;
+        }
+      } else if (param === "rating") {
+        const numValue = Number(queryValue);
+        if (!Number.isNaN(numValue)) {
+          sidebarSelectedFilters.rating = numValue;
+        }
+      } else if (param === "shipping-free") {
+        sidebarSelectedFilters["shipping-free"] = queryValue === "true";
+      }
+    }
+  }
+}
+
+const handleFilterChange = async (event: {
+  code: string;
+  value: string | number | boolean;
+}) => {
+  try {
+    const { code, value } = event;
+
+    if (code === "manufacturer" || code === "properties") {
+      const filterSet = sidebarSelectedFilters[code];
+      const stringValue = String(value);
+
+      if (filterSet.has(stringValue)) {
+        filterSet.delete(stringValue);
+      } else {
+        filterSet.add(stringValue);
+      }
+    } else if (code === "min-price" || code === "max-price") {
+      sidebarSelectedFilters[code] =
+        typeof value === "number" ? value : Number(value);
+    } else if (code === "rating") {
+      sidebarSelectedFilters.rating = Number(value);
+    } else if (code === "shipping-free") {
+      sidebarSelectedFilters["shipping-free"] = Boolean(value);
+    }
+
+    await executeSearch();
+  } catch (error) {
+    console.error("Filter update failed:", error);
+  }
+};
+
+const executeSearch = async () => {
+  try {
+    await search(searchCriteriaForRequest.value);
+
+    // Build query directly from searchCriteriaForRequest which already has pipe-separated strings
+    const criteria = searchCriteriaForRequest.value;
+    const query: Record<string, unknown> = {};
+
+    if (criteria.manufacturer) query.manufacturer = criteria.manufacturer;
+    if (criteria.properties) query.properties = criteria.properties;
+    if (criteria["min-price"]) query["min-price"] = criteria["min-price"];
+    if (criteria["max-price"]) query["max-price"] = criteria["max-price"];
+    if (criteria.rating) query.rating = criteria.rating;
+    if (criteria["shipping-free"])
+      query["shipping-free"] = criteria["shipping-free"];
+    if (criteria.order) query.order = criteria.order;
+
+    await router.push({
+      query: query as LocationQueryRaw,
+    });
+  } catch (error) {
+    console.error("Search execution failed:", error);
+  }
+};
+
+const clearFilters = () => {
+  (sidebarSelectedFilters.manufacturer as Set<string>).clear();
+  (sidebarSelectedFilters.properties as Set<string>).clear();
+  sidebarSelectedFilters["min-price"] = undefined;
+  sidebarSelectedFilters["max-price"] = undefined;
+  sidebarSelectedFilters.rating = undefined;
+  sidebarSelectedFilters["shipping-free"] = undefined;
+};
+
+const currentSortingOrder = computed({
+  get: (): string => getCurrentSortingOrder.value || "",
+  set: async (order: string): Promise<void> => {
+    try {
+      await router.push({
+        query: {
+          ...route.query,
+          order,
+        },
+      });
+
+      await changeCurrentSortingOrder(order, {
+        ...(route.query as unknown as operations["searchPage post /search"]["body"]),
+        limit: route.query.limit ? Number(route.query.limit) : 15,
+      });
+    } catch (error) {
+      console.error("Sorting order change failed:", error);
+    }
+  },
+});
+
+async function invokeCleanFilters() {
+  try {
+    clearFilters();
+    await executeSearch();
+  } catch (error) {
+    console.error("Clear filters failed:", error);
+  }
+}
+
+const handleSortChange = (sortKey: string) => {
+  currentSortingOrder.value = sortKey;
+};
+
+// Helper to check if a filter has active selections
+const hasActiveFilter = (filter: { code: string }) => {
+  if (filter.code === "manufacturer") {
+    return sidebarSelectedFilters.manufacturer.size > 0;
+  }
+  if (filter.code === "price") {
+    return (
+      sidebarSelectedFilters["min-price"] !== undefined ||
+      sidebarSelectedFilters["max-price"] !== undefined
+    );
+  }
+  if (filter.code === "rating") {
+    return sidebarSelectedFilters.rating !== undefined;
+  }
+  if (filter.code === "shipping-free") {
+    return sidebarSelectedFilters["shipping-free"] === true;
+  }
+  // Properties filter - check if any property from this filter group is selected
+  return sidebarSelectedFilters.properties.size > 0;
+};
+</script>
+
+<template>
+  <div>
+    <!-- Horizontal Filters Row -->
+    <div class="flex flex-wrap items-center justify-start gap-4 z-10">
+      <!-- Filter dropdowns -->
+      <SwFilterDropdown
+        v-for="filter in getInitialFilters"
+        :key="filter.id"
+        :label="filter.label"
+        :is-active="hasActiveFilter(filter)"
+      >
+        <SwProductListingFilter
+          :filter="filter"
+          display-mode="dropdown"
+          :selected-manufacturer="sidebarSelectedFilters.manufacturer"
+          :selected-properties="sidebarSelectedFilters.properties"
+          :selected-min-price="sidebarSelectedFilters['min-price']"
+          :selected-max-price="sidebarSelectedFilters['max-price']"
+          :selected-rating="sidebarSelectedFilters.rating"
+          :selected-shipping-free="sidebarSelectedFilters['shipping-free']"
+          @filter-change="handleFilterChange"
+        />
+      </SwFilterDropdown>
+
+      <!-- Sort dropdown -->
+      <SwSortDropdown
+        :sort-options="getSortingOrders ?? []"
+        :current-sort="getCurrentSortingOrder ?? ''"
+        :label="translations.listing.sort"
+        @sort-change="handleSortChange"
+      />
+
+      <!-- Reset filters button -->
+      <SwBaseButton
+        v-if="showResetFiltersButton"
+        variant="ghost"
+        size="medium"
+        @click="invokeCleanFilters"
+        type="button"
+      >
+        {{ translations.listing.resetFilters }}
+        <span class="w-5 h-5 i-carbon-close inline-block align-middle ml-1"></span>
+      </SwBaseButton>
+    </div>
+  </div>
+</template>

package/{components → app/components}/SwProductPrice.vue

@@ -37,7 +37,7 @@ translations = defu(useCmsTranslations(), translations) as Translations;
 
 const { product } = toRefs(props);
 
-const { unitPrice, price, tierPrices, isListPrice } = useProductPrice(product);
+const { unitPrice, price, tierPrices, hasListPrice } = useProductPrice(product);
 const { getFormattedPrice } = usePrice();
 </script>
 
@@ -45,7 +45,7 @@ const { getFormattedPrice } = usePrice();
   <div>
     <div v-if="!tierPrices.length">
       <SwSharedPrice
-        v-if="isListPrice"
+        v-if="hasListPrice"
         class="text-1xl text-gray-900 basis-2/6 justify-end line-through"
         :value="price?.listPrice?.price"
       />
@@ -53,7 +53,7 @@ const { getFormattedPrice } = usePrice();
         v-if="unitPrice"
         class="text-3xl text-gray-900 basis-2/6 justify-end"
         :class="{
-          'text-red': isListPrice,
+          'text-red': hasListPrice,
         }"
         :value="unitPrice"
       />

package/app/components/SwProductRating.vue

@@ -0,0 +1,40 @@
+<script setup lang="ts">
+import { computed } from "vue";
+
+const {
+  rating = 0,
+  reviewCount = 0,
+  starSize = 16,
+  showCount = true,
+} = defineProps<{
+  rating: number;
+  reviewCount?: number;
+  starSize?: number;
+  showCount?: boolean;
+}>();
+
+const filledStars = computed(() => Math.round(rating));
+</script>
+
+<template>
+  <div class="flex items-center">
+    <div
+      class="flex items-center gap-1.5"
+      role="img"
+      :aria-label="`${rating} out of 5 stars`"
+    >
+      <SwStarIcon
+        v-for="i in 5"
+        :key="`star-${i}`"
+        :filled="i <= filledStars"
+        :size="starSize"
+      />
+    </div>
+    <span
+      v-if="showCount && reviewCount > 0"
+      class="ml-1 text-surface-on-surface-variant text-base leading-normal"
+    >
+      ({{ reviewCount }})
+    </span>
+  </div>
+</template>

package/{components → app/components}/SwProductReviews.vue

@@ -17,6 +17,7 @@ type Translations = {
   product: {
     noReviews: string;
     reviewNotAccepted: string;
+    reviewFeedback: string;
   };
 };
 
@@ -24,6 +25,7 @@ let translations: Translations = {
   product: {
     noReviews: "No reviews yet.",
     reviewNotAccepted: "Your review has not been approved yet",
+    reviewFeedback: "Shop feedback",
   },
 };
 
@@ -64,48 +66,48 @@ const formatDate = (date: string) => {
 <template>
   <div
     v-if="loadingReviews"
-    class="absolute inset-0 flex items-center justify-center z-10 bg-white/75"
+    class="absolute inset-0 flex items-center justify-center z-10 bg-surface-surface/75"
   >
     <div
-      class="h-15 w-15 i-carbon-progress-bar-round animate-spin c-gray-500"
+      class="h-15 w-15 i-carbon-progress-bar-round animate-spin text-outline-outline"
     />
   </div>
-  <div v-else-if="reviewsList.length">
-    <div v-for="review in reviews" :key="review.id">
+  <div v-else-if="reviewsList.length" class="flex flex-col gap-6">
+    <div
+      v-for="(review, index) in reviewsList"
+      :key="review.id"
+      class="pb-6"
+      :class="{ 'border-b border-surface-surface-container-highest': index < reviewsList.length - 1 }"
+    >
       <div
         v-if="review.createdAt"
-        class="cms-block-product-description-reviews__reviews-time mt-3 text-gray-600 text-sm"
+        class="cms-block-product-description-reviews__reviews-time text-surface-on-surface-variant text-sm"
       >
+        <span v-if="review.externalUser">{{ review.externalUser }} - </span>
         <span>{{ formatDate(review.createdAt) }}</span>
       </div>
       <div
           v-if="!review.status"
-          class="mt-2 text-3 p-2 bg-[#d4f0f5] flex gap-2 items-center"
+          class="mt-2 text-3 p-2 bg-states-info-container text-states-on-info-container flex gap-2 items-center"
         >
         <div class="w-6 h-6 i-carbon-warning" />
         {{ translations.product.reviewNotAccepted }}
       </div>
-      <div
-        class="cms-block-product-description-reviews__reviews-rating inline-flex items-center mt-2"
-      >
-        <div
-          v-for="_ in review.points"
-          :key="`filled-star-${_}`"
-          class="w-5 h-5 i-carbon-star-filled"
-        ></div>
-        <div
-          v-for="_ in 5 - (review.points || 0)"
-          :key="`empty-star-${_}`"
-          class="w-5 h-5 i-carbon-star"
-        ></div>
-        <div
-          class="cms-block-product-description-reviews__reviews-title font-semibold ml-2"
-        >
+      <div class="cms-block-product-description-reviews__reviews-rating inline-flex items-center mt-2">
+        <SwProductRating
+          :rating="review.points ?? 0"
+          :star-size="20"
+          :show-count="false"
+        />
+        <div class="cms-block-product-description-reviews__reviews-title font-semibold ml-2">
           <p>{{ review.title }}</p>
         </div>
       </div>
       <div class="cms-block-product-description-reviews__reviews-content mt-2">
-        <span>{{ review.content }}</span>
+        <p class="break-words">{{ review.content }}</p>
+        <p v-if="review.comment" class="text-surface-on-surface-variant mt-2">
+          - {{ translations.product.reviewFeedback }}: {{ review.comment }}
+        </p>
       </div>
     </div>
   </div>