@shopware/helpers 1.4.0 → 1.5.0

package/README.md

@@ -36,10 +36,8 @@ export default defineConfig({
 
 Full changelog for stable version is available [here](https://github.com/shopware/frontends/blob/main/packages/helpers/CHANGELOG.md)
 
-### Latest changes: 1.4.0
+### Latest changes: 1.5.0
 
 ### Minor Changes
 
-- [#1602](https://github.com/shopware/frontends/pull/1602) [`bb7d1cb`](https://github.com/shopware/frontends/commit/bb7d1cbc4204ff1d48f77416f94f550bc235e5ed) Thanks [@patzick](https://github.com/patzick)! - Switch from `@shopware-pwa/helpers-next` to `@shopware/helpers` package.
-
-- [#1602](https://github.com/shopware/frontends/pull/1602) [`bb7d1cb`](https://github.com/shopware/frontends/commit/bb7d1cbc4204ff1d48f77416f94f550bc235e5ed) Thanks [@patzick](https://github.com/patzick)! - Switch from `@shopware-pwa/cms-base` to `@shopware/cms-base-layer` package.
+- [#1910](https://github.com/shopware/frontends/pull/1910) [`c8fa438`](https://github.com/shopware/frontends/commit/c8fa438b38de6dbc43a2895f2d1906907447c384) Thanks [@mdanilowicz](https://github.com/mdanilowicz)! - Add helper for getting payment and shipping method icon

package/dist/index.d.mts

@@ -584,6 +584,24 @@ declare function getShippingMethodDeliveryTime<T extends {
     };
 }>(shippingMethod: T): string | undefined;
 
+/**
+ * Get shipping method icon
+ */
+declare function getShippingMethodIcon<T extends {
+    media?: {
+        url: string;
+    };
+}>(shippingMethod: T): string;
+
+/**
+ * Get payment method icon
+ */
+declare function getPaymentMethodIcon<T extends {
+    media?: {
+        url: string;
+    };
+}>(paymentMethod: T): string;
+
 /**
  * Get translated language name
  *
@@ -614,4 +632,4 @@ declare function canUseQuoteActions<T extends {
     };
 }>(quote: T): boolean;
 
-export { type HelpersCssClasses, type LayoutConfiguration, type TierPrice, type UiMediaGalleryItem, type UiMediaGalleryItemUrl, type UiProductOption, type UiProductProperty, type UiProductReview, buildUrlPrefix, canUseQuoteActions, downloadFile, getBackgroundImageUrl, getBiggestThumbnailUrl, getCategoryBreadcrumbs, getCategoryImageUrl, getCategoryRoute, getCategoryUrl, getCmsBreadcrumbs, getCmsEntityObject, getCmsLayoutConfiguration, getCmsTranslate, getFormattedPrice, getLanguageName, getListingFilters, getMainImageUrl, getMedia, getProductCalculatedListingPrice, getProductFreeShipping, getProductFromPrice, getProductName, getProductRatingAverage, getProductReviews, getProductRoute, getProductTierPrices, getProductUrl, getShippingMethodDeliveryTime, getSmallestThumbnailUrl, getSrcSetForMedia, getTranslatedProperty, helpersCssClasses, isCategory, isLandingPage, isMaintenanceMode, isProduct, relativeUrlSlash, urlIsAbsolute };
+export { type HelpersCssClasses, type LayoutConfiguration, type TierPrice, type UiMediaGalleryItem, type UiMediaGalleryItemUrl, type UiProductOption, type UiProductProperty, type UiProductReview, buildUrlPrefix, canUseQuoteActions, downloadFile, getBackgroundImageUrl, getBiggestThumbnailUrl, getCategoryBreadcrumbs, getCategoryImageUrl, getCategoryRoute, getCategoryUrl, getCmsBreadcrumbs, getCmsEntityObject, getCmsLayoutConfiguration, getCmsTranslate, getFormattedPrice, getLanguageName, getListingFilters, getMainImageUrl, getMedia, getPaymentMethodIcon, getProductCalculatedListingPrice, getProductFreeShipping, getProductFromPrice, getProductName, getProductRatingAverage, getProductReviews, getProductRoute, getProductTierPrices, getProductUrl, getShippingMethodDeliveryTime, getShippingMethodIcon, getSmallestThumbnailUrl, getSrcSetForMedia, getTranslatedProperty, helpersCssClasses, isCategory, isLandingPage, isMaintenanceMode, isProduct, relativeUrlSlash, urlIsAbsolute };

package/dist/index.d.ts

@@ -584,6 +584,24 @@ declare function getShippingMethodDeliveryTime<T extends {
     };
 }>(shippingMethod: T): string | undefined;
 
+/**
+ * Get shipping method icon
+ */
+declare function getShippingMethodIcon<T extends {
+    media?: {
+        url: string;
+    };
+}>(shippingMethod: T): string;
+
+/**
+ * Get payment method icon
+ */
+declare function getPaymentMethodIcon<T extends {
+    media?: {
+        url: string;
+    };
+}>(paymentMethod: T): string;
+
 /**
  * Get translated language name
  *
@@ -614,4 +632,4 @@ declare function canUseQuoteActions<T extends {
     };
 }>(quote: T): boolean;
 
-export { type HelpersCssClasses, type LayoutConfiguration, type TierPrice, type UiMediaGalleryItem, type UiMediaGalleryItemUrl, type UiProductOption, type UiProductProperty, type UiProductReview, buildUrlPrefix, canUseQuoteActions, downloadFile, getBackgroundImageUrl, getBiggestThumbnailUrl, getCategoryBreadcrumbs, getCategoryImageUrl, getCategoryRoute, getCategoryUrl, getCmsBreadcrumbs, getCmsEntityObject, getCmsLayoutConfiguration, getCmsTranslate, getFormattedPrice, getLanguageName, getListingFilters, getMainImageUrl, getMedia, getProductCalculatedListingPrice, getProductFreeShipping, getProductFromPrice, getProductName, getProductRatingAverage, getProductReviews, getProductRoute, getProductTierPrices, getProductUrl, getShippingMethodDeliveryTime, getSmallestThumbnailUrl, getSrcSetForMedia, getTranslatedProperty, helpersCssClasses, isCategory, isLandingPage, isMaintenanceMode, isProduct, relativeUrlSlash, urlIsAbsolute };
+export { type HelpersCssClasses, type LayoutConfiguration, type TierPrice, type UiMediaGalleryItem, type UiMediaGalleryItemUrl, type UiProductOption, type UiProductProperty, type UiProductReview, buildUrlPrefix, canUseQuoteActions, downloadFile, getBackgroundImageUrl, getBiggestThumbnailUrl, getCategoryBreadcrumbs, getCategoryImageUrl, getCategoryRoute, getCategoryUrl, getCmsBreadcrumbs, getCmsEntityObject, getCmsLayoutConfiguration, getCmsTranslate, getFormattedPrice, getLanguageName, getListingFilters, getMainImageUrl, getMedia, getPaymentMethodIcon, getProductCalculatedListingPrice, getProductFreeShipping, getProductFromPrice, getProductName, getProductRatingAverage, getProductReviews, getProductRoute, getProductTierPrices, getProductUrl, getShippingMethodDeliveryTime, getShippingMethodIcon, getSmallestThumbnailUrl, getSrcSetForMedia, getTranslatedProperty, helpersCssClasses, isCategory, isLandingPage, isMaintenanceMode, isProduct, relativeUrlSlash, urlIsAbsolute };

package/dist/index.mjs

@@ -3,8 +3,7 @@ function getProductFreeShipping(product) {
 }
 
 function getMainImageUrl(object) {
-  if (!object)
-    return "";
+  if (!object) return "";
   if ("cover" in object && object.cover) {
     if ("media" in object.cover) {
       return object?.cover?.media?.url || "";
@@ -58,8 +57,7 @@ function getProductTierPrices(product) {
 }
 
 function getProductUrl(product) {
-  if (!product)
-    return "/";
+  if (!product) return "/";
   const seoUrl = product.seoUrls?.[0]?.seoPathInfo;
   return seoUrl ? `/${seoUrl}` : `/detail/${product.id}`;
 }
@@ -89,8 +87,8 @@ function getProductFromPrice(product) {
   }
   const realPrice = getProductRealPrice(product);
   const displayFromPriceLabel = (product.calculatedPrices?.length ?? 0) > 0;
-  if (displayFromPriceLabel)
-    return realPrice?.unitPrice;
+  if (displayFromPriceLabel) return realPrice?.unitPrice;
+  return void 0;
 }
 
 function getProductRoute(product) {
@@ -111,11 +109,12 @@ function getEntityPrefix(category) {
       return "detail";
     case "landing_page":
       return "landingPage";
+    default:
+      return "navigation";
   }
 }
 function getCategoryUrl(category) {
-  if (!category)
-    return "/";
+  if (!category) return "/";
   switch (category.type) {
     case void 0:
       return "/";
@@ -136,8 +135,7 @@ function getCategoryImageUrl(category) {
 function getCategoryBreadcrumbs(category, options) {
   const breadcrumbs = category?.translated?.breadcrumb || category?.breadcrumb || [];
   const startIndex = options?.startIndex || 0;
-  if (breadcrumbs.length <= startIndex)
-    return [];
+  if (breadcrumbs.length <= startIndex) return [];
   return breadcrumbs.slice(startIndex).map((element) => {
     return {
       name: element
@@ -146,8 +144,7 @@ function getCategoryBreadcrumbs(category, options) {
 }
 
 function getCategoryRoute(category) {
-  if (!category)
-    return "/";
+  if (!category) return "/";
   if (category.type === "page" || category.type === "link" && category.linkType === "category") {
     return {
       path: getCategoryUrl(category),
@@ -266,8 +263,7 @@ function urlIsAbsolute(url) {
 
 function buildUrlPrefix(url, prefix) {
   if (typeof url === "string") {
-    if (urlIsAbsolute(url))
-      return { path: url };
+    if (urlIsAbsolute(url)) return { path: url };
     const resultUrl = url[0] !== "/" ? `/${url}` : url;
     return { path: prefix ? `/${prefix}${resultUrl}` : resultUrl };
   }
@@ -290,8 +286,7 @@ function isMaintenanceMode(errors) {
 }
 
 function getCmsTranslate(key, params) {
-  if (!params)
-    return key;
+  if (!params) return key;
   let translatedText = key;
   for (const param in params) {
     const placeholder = `{${param}}`;
@@ -436,6 +431,14 @@ function getShippingMethodDeliveryTime(shippingMethod) {
   return shippingMethod.deliveryTime?.translated.name;
 }
 
+function getShippingMethodIcon(shippingMethod) {
+  return shippingMethod.media?.url ?? "";
+}
+
+function getPaymentMethodIcon(paymentMethod) {
+  return paymentMethod.media?.url ?? "";
+}
+
 function getLanguageName(language) {
   return language.translationCode?.translated.name || "";
 }
@@ -452,4 +455,4 @@ function canUseQuoteActions(quote) {
   return ["replied"].includes(quote.stateMachineState?.technicalName ?? "");
 }
 
-export { buildUrlPrefix, canUseQuoteActions, downloadFile, getBackgroundImageUrl, getBiggestThumbnailUrl, getCategoryBreadcrumbs, getCategoryImageUrl, getCategoryRoute, getCategoryUrl, getCmsBreadcrumbs, getCmsEntityObject, getCmsLayoutConfiguration, getCmsTranslate, getFormattedPrice, getLanguageName, getListingFilters, getMainImageUrl, getMedia, getProductCalculatedListingPrice, getProductFreeShipping, getProductFromPrice, getProductName, getProductRatingAverage, getProductReviews, getProductRoute, getProductTierPrices, getProductUrl, getShippingMethodDeliveryTime, getSmallestThumbnailUrl, getSrcSetForMedia, getTranslatedProperty, helpersCssClasses, isCategory, isLandingPage, isMaintenanceMode, isProduct, relativeUrlSlash, urlIsAbsolute };
+export { buildUrlPrefix, canUseQuoteActions, downloadFile, getBackgroundImageUrl, getBiggestThumbnailUrl, getCategoryBreadcrumbs, getCategoryImageUrl, getCategoryRoute, getCategoryUrl, getCmsBreadcrumbs, getCmsEntityObject, getCmsLayoutConfiguration, getCmsTranslate, getFormattedPrice, getLanguageName, getListingFilters, getMainImageUrl, getMedia, getPaymentMethodIcon, getProductCalculatedListingPrice, getProductFreeShipping, getProductFromPrice, getProductName, getProductRatingAverage, getProductReviews, getProductRoute, getProductTierPrices, getProductUrl, getShippingMethodDeliveryTime, getShippingMethodIcon, getSmallestThumbnailUrl, getSrcSetForMedia, getTranslatedProperty, helpersCssClasses, isCategory, isLandingPage, isMaintenanceMode, isProduct, relativeUrlSlash, urlIsAbsolute };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopware/helpers",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Shopware helpers for accessing API data",
   "author": "Shopware",
   "type": "module",
@@ -33,10 +33,10 @@
   },
   "devDependencies": {
     "@biomejs/biome": "1.8.3",
-    "@vitest/coverage-v8": "2.1.8",
-    "happy-dom": "16.6.0",
+    "@vitest/coverage-v8": "3.2.3",
+    "happy-dom": "18.0.1",
     "unbuild": "2.0.0",
-    "vitest": "2.1.8",
+    "vitest": "3.2.3",
     "tsconfig": "0.0.0"
   },
   "scripts": {