Skip to content
This repository has been archived by the owner on Oct 31, 2024. It is now read-only.

feat: show proper product names, add product reviews #302

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion packages/composables/src/hooks/useProductListing.ts
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,18 @@ export const useProductListing = (
const searchCriteria: SearchCriteria = {
pagination: selectedCriteria.pagination,
filters: getFilterSearchCriteria(selectedCriteria.filters),
sort: getSortingSearchCriteria(selectedCriteria.sorting)
sort: getSortingSearchCriteria(selectedCriteria.sorting),
configuration: {
// get product variant options
associations: [
{
name: "options"
},
{
name: "productReviews"
}
]
}
};

const search = exportUrlQuery(searchCriteria);
Expand Down
16 changes: 12 additions & 4 deletions packages/default-theme/components/SwProductCard.vue
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
<template>
<SfProductCard
:title="product.name || ''"
:title="getName"
:image="getImageUrl"
:special-price="getSpecialPrice"
:regular-price="getRegularPrice"
:max-rating="5"
:score-rating="getProductRating"
:image-width="216"
:image-height="326"
:regular-price="getRegularPrice"
:isOnWishlist="false"
:link="getRouterLink"
@click:wishlist="toggleWishlist"
Expand All @@ -31,7 +33,8 @@ import {
getProductMainImageUrl,
getProductRegularPrice,
getProductUrl,
getProductSpecialPrice
getProductSpecialPrice,
getProductName
} from '@shopware-pwa/helpers'

export default {
Expand All @@ -41,7 +44,6 @@ export default {
},
setup({ product }) {
const { addToCart, quantity, getStock, isInCart } = useAddToCart(product)

return {
quantity,
addToCart,
Expand All @@ -59,6 +61,12 @@ export default {
}
},
computed: {
getName() {
mkucmus marked this conversation as resolved.
Show resolved Hide resolved
return getProductName({product: this.product});
},
getProductRating() {
return this.product && this.product.ratingAverage
},
// should be replaced with prettyUrl attribute when pretty urls are included in product entity
getRouterLink() {
return getProductUrl(this.product)
Expand Down
5 changes: 2 additions & 3 deletions packages/default-theme/components/cms/elements/SwTextSlot.vue
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,8 @@ export default {
rawHtml() {
return (
this.content &&
this.content.config &&
this.content.config.content &&
this.content.config.content.value
this.content.data &&
this.content.data.content
);
},
verticalAlign() {
Expand Down
44 changes: 44 additions & 0 deletions packages/helpers/__tests__/product/getProductName.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
import { getProductName } from "@shopware-pwa/helpers";

describe("Shopware helpers - getProductName", () => {
it("should return empty string if argument wasn't provided", () => {
const label = getProductName();
expect(label).toBeNull();
});

it("should return default value if product was null", () => {
const argument: any = { product: null };
const label = getProductName(argument);
expect(label).toBeNull();
});

it("should return translated name if the base one does not exist", () => {
const argument: any = {
product: {
name: null,
translated: {
name: "Existing"
}
}
};
const productName = getProductName(argument);
expect(productName).toBe("Existing");
});
it("should return name enriched with variant label if options are included", () => {
const argument: any = {
product: {
name: "T-Shirt",
options: [
{
name: "XL"
},
{
name: "yellow"
}
]
}
};
const productName = getProductName(argument);
expect(productName).toBe("T-Shirt - XL yellow");
});
});
55 changes: 55 additions & 0 deletions packages/helpers/__tests__/product/getVariantOptionsLabel.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
import { getVariantOptionsLabel } from "@shopware-pwa/helpers";

describe("Shopware helpers - getVariantOptionsLabel", () => {
it("should return empty string if argument wasn't provided", () => {
const label = getVariantOptionsLabel();
expect(label).toBeNull();
});

it("should return default value if product was null", () => {
const argument: any = { product: null };
const label = getVariantOptionsLabel(argument);
expect(label).toBeNull();
});

it("should return empty string if empty options array is provided", () => {
const argument: any = {
product: {
options: []
}
};
const label = getVariantOptionsLabel(argument);
expect(label).toBeNull();
});

it("should return label made of one option name", () => {
const argument: any = {
product: {
options: [
{
name: "XL"
}
]
}
};
const label = getVariantOptionsLabel(argument);
expect(label).toBe("XL");
});

it("should return label made of two option names", () => {
const argument: any = {
product: {
options: [
{
name: "L"
},
{
name: "black"
}
]
}
};
const label = getVariantOptionsLabel(argument);
expect(label).toBe("L black");
});
});
14 changes: 14 additions & 0 deletions packages/helpers/src/product/getProductName.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import { Product } from "@shopware-pwa/shopware-6-client/src/interfaces/models/content/product/Product";
import { getVariantOptionsLabel } from "./getVariantOptionsLabel";

export function getProductName({ product }: { product?: Product } = {}):
| string
| null {
if (!product) {
return null;
}
const variantLabel = getVariantOptionsLabel({ product: product });
return `${product.name || product.translated.name}${
variantLabel ? " - " + variantLabel : ""
}`;
}
19 changes: 19 additions & 0 deletions packages/helpers/src/product/getVariantOptionsLabel.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import { Product } from "@shopware-pwa/shopware-6-client/src/interfaces/models/content/product/Product";

export function getVariantOptionsLabel({
product
}: { product?: Product } = {}): string | null {
if (
!product ||
!product.options ||
(product.options && !product.options.length)
) {
return null;
}
let variantLabel = "";
for (let { name } of product.options) {
variantLabel += `${name} `;
}

return variantLabel.trim();
}
2 changes: 2 additions & 0 deletions packages/helpers/src/product/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ export * from "./getProductSpecialPrice";
export * from "./isProductSimple";
export * from "./getProductOptionsUrl";
export * from "./getProductUrl";
export * from "./getVariantOptionsLabel";
export * from "./getProductName";
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ export interface SeoUrl {
routeName: string;
salesChannelId: string | null;
seoPathInfo: string;
translated: [];
updatedAt: Date | null;
url: string | null;
versionId: string | null;
Expand Down Expand Up @@ -109,5 +108,8 @@ export interface Product {
parentVersionId: string;
productManufacturerVersionId: string;
seoUrls: SeoUrl[] | null;
translated: {
name: string | null;
};
productMediaVersiond?: null;
}