@ikas/bp-storefront 0.25.0 → 0.26.0

package/dist/functions/models/product/variant/index.d.ts

@@ -6,22 +6,23 @@ import { BackInStockNotificationForm, IkasAppliedCampaignAmount, IkasProductAttr
  * @ai-related getSelectedProductVariant
  *
  * @param variant - The product variant
- * @returns The first image of the variant, or undefined if no images
+ * @returns The first IkasProductImage of the variant, or undefined if no images. Access `.image` to get the IkasImage for CDN helpers.
  *
  * @example
  * ```typescript
- * import { getProductVariantMainImage, getSelectedProductVariant } from "@ikas/bp-storefront";
+ * import { getProductVariantMainImage, getSelectedProductVariant, getDefaultSrc } from "@ikas/bp-storefront";
  * import { IkasProduct } from "@ikas/bp-storefront";
  *
  * function ProductImage({ product }: { product: IkasProduct }) {
  *   const variant = getSelectedProductVariant(product);
- *   const mainImage = getProductVariantMainImage(variant);
+ *   const productImage = getProductVariantMainImage(variant);
+ *   const image = productImage?.image;
  *
- *   if (!mainImage) {
+ *   if (!image) {
  *     return <div className="no-image">No image available</div>;
  *   }
  *
- *   return <img src={mainImage.src} alt={product.name} />;
+ *   return <img src={getDefaultSrc(image)} alt={product.name} />;
  * }
  * ```
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ikas/bp-storefront",
-  "version": "0.25.0",
+  "version": "0.26.0",
   "description": "A framework for the ikas blueprint storefronts.",
   "author": "ikas",
   "license": "ISC",