@ikas/bp-storefront 0.15.0

package/dist/storefront/src/functions/models/order/line-item/index.d.ts

@@ -0,0 +1,307 @@
+import { IkasOrderLineItem } from "../../../../../../storefront-models/src";
+/**
+ * Calculates the total original price for a line item by multiplying unit price by quantity.
+ *
+ * @ai-category OrderLineItem, Pricing
+ * @ai-related getOrderLineItemFormattedPriceWithQuantity, getOrderLineItemFinalPriceWithQuantity, getOrderLineItemOverridenPriceWithQuantity
+ *
+ * @param item - The order line item to calculate the price for.
+ * @returns The total original price (unit price * quantity).
+ *
+ * @example
+ * ```typescript
+ * import { getOrderLineItemPriceWithQuantity } from "@ikas/bp-storefront";
+ * const totalPrice = getOrderLineItemPriceWithQuantity(lineItem);
+ * ```
+ */
+export declare function getOrderLineItemPriceWithQuantity(item: IkasOrderLineItem): number;
+/**
+ * Returns the formatted total original price for a line item (unit price * quantity) as a currency string.
+ *
+ * @ai-category OrderLineItem, Pricing
+ * @ai-related getOrderLineItemPriceWithQuantity, getOrderLineItemFormattedFinalPriceWithQuantity, getOrderLineItemFormattedOverridenPriceWithQuantity
+ *
+ * @param item - The order line item to format the price for.
+ * @returns A formatted currency string representing the total original price.
+ *
+ * @example
+ * ```typescript
+ * import { getOrderLineItemFormattedPriceWithQuantity } from "@ikas/bp-storefront";
+ * const formattedTotal = getOrderLineItemFormattedPriceWithQuantity(lineItem);
+ * // e.g. "$30.00"
+ * ```
+ */
+export declare function getOrderLineItemFormattedPriceWithQuantity(item: IkasOrderLineItem): string;
+/**
+ * Calculates the overridden total price when the original price differs from the final price. Returns 0 if no override exists.
+ *
+ * @ai-category OrderLineItem, Pricing
+ * @ai-related getOrderLineItemFormattedOverridenPriceWithQuantity, getOrderLineItemPriceWithQuantity, getOrderLineItemFinalPriceWithQuantity
+ *
+ * @param item - The order line item to check for price override.
+ * @returns The overridden total price (original price * quantity) if prices differ, otherwise 0.
+ *
+ * @example
+ * ```typescript
+ * import { getOrderLineItemOverridenPriceWithQuantity } from "@ikas/bp-storefront";
+ * const overriddenPrice = getOrderLineItemOverridenPriceWithQuantity(lineItem);
+ * if (overriddenPrice > 0) {
+ *   // Display strikethrough price
+ * }
+ * ```
+ */
+export declare function getOrderLineItemOverridenPriceWithQuantity(item: IkasOrderLineItem): number;
+/**
+ * Returns the formatted overridden total price as a currency string. Shows the original price when it differs from the final price.
+ *
+ * @ai-category OrderLineItem, Pricing
+ * @ai-related getOrderLineItemOverridenPriceWithQuantity, getOrderLineItemFormattedPriceWithQuantity, getOrderLineItemFormattedFinalPriceWithQuantity
+ *
+ * @param item - The order line item to format the overridden price for.
+ * @returns A formatted currency string representing the overridden total price.
+ *
+ * @example
+ * ```typescript
+ * import { getOrderLineItemFormattedOverridenPriceWithQuantity } from "@ikas/bp-storefront";
+ * const formattedOverridden = getOrderLineItemFormattedOverridenPriceWithQuantity(lineItem);
+ * // e.g. "$50.00" (original price before discount)
+ * ```
+ */
+export declare function getOrderLineItemFormattedOverridenPriceWithQuantity(item: IkasOrderLineItem): string;
+/**
+ * Returns the formatted original unit price of a line item as a currency string.
+ *
+ * @ai-category OrderLineItem, Pricing
+ * @ai-related getOrderLineItemFormattedFinalPrice, getOrderLineItemFormattedPriceWithQuantity, getOrderLineItemFormattedUnitPrice
+ *
+ * @param item - The order line item to format the unit price for.
+ * @returns A formatted currency string representing the original unit price.
+ *
+ * @example
+ * ```typescript
+ * import { getOrderLineItemFormattedPrice } from "@ikas/bp-storefront";
+ * const formattedPrice = getOrderLineItemFormattedPrice(lineItem);
+ * // e.g. "$10.00"
+ * ```
+ */
+export declare function getOrderLineItemFormattedPrice(item: IkasOrderLineItem): string;
+/**
+ * Calculates the total final price for a line item by multiplying the final unit price by quantity. Falls back to the original price if no final price is set.
+ *
+ * @ai-category OrderLineItem, Pricing
+ * @ai-related getOrderLineItemFormattedFinalPriceWithQuantity, getOrderLineItemPriceWithQuantity, getOrderLineItemFormattedFinalPrice
+ *
+ * @param item - The order line item to calculate the final total for.
+ * @returns The total final price (final unit price * quantity).
+ *
+ * @example
+ * ```typescript
+ * import { getOrderLineItemFinalPriceWithQuantity } from "@ikas/bp-storefront";
+ * const finalTotal = getOrderLineItemFinalPriceWithQuantity(lineItem);
+ * ```
+ */
+export declare function getOrderLineItemFinalPriceWithQuantity(item: IkasOrderLineItem): number;
+/**
+ * Returns the formatted final unit price of a line item as a currency string, reflecting any discounts applied.
+ *
+ * @ai-category OrderLineItem, Pricing
+ * @ai-related getOrderLineItemFormattedPrice, getOrderLineItemFormattedFinalPriceWithQuantity, getOrderLineItemFormattedDiscountPrice
+ *
+ * @param item - The order line item to format the final price for.
+ * @returns A formatted currency string representing the final unit price.
+ *
+ * @example
+ * ```typescript
+ * import { getOrderLineItemFormattedFinalPrice } from "@ikas/bp-storefront";
+ * const formattedFinal = getOrderLineItemFormattedFinalPrice(lineItem);
+ * // e.g. "$8.00" (after discount)
+ * ```
+ */
+export declare function getOrderLineItemFormattedFinalPrice(item: IkasOrderLineItem): string;
+/**
+ * Returns the formatted total final price for a line item (final unit price * quantity) as a currency string.
+ *
+ * @ai-category OrderLineItem, Pricing
+ * @ai-related getOrderLineItemFinalPriceWithQuantity, getOrderLineItemFormattedPriceWithQuantity, getOrderLineItemFormattedFinalPrice
+ *
+ * @param item - The order line item to format the final total for.
+ * @returns A formatted currency string representing the total final price.
+ *
+ * @example
+ * ```typescript
+ * import { getOrderLineItemFormattedFinalPriceWithQuantity } from "@ikas/bp-storefront";
+ * const formattedFinalTotal = getOrderLineItemFormattedFinalPriceWithQuantity(lineItem);
+ * // e.g. "$24.00"
+ * ```
+ */
+export declare function getOrderLineItemFormattedFinalPriceWithQuantity(item: IkasOrderLineItem): string;
+/**
+ * Returns the formatted unit price of a line item as a currency string.
+ *
+ * @ai-category OrderLineItem, Pricing
+ * @ai-related getOrderLineItemFormattedFinalUnitPrice, getOrderLineItemFormattedPrice, getOrderLineItemUnitPriceText
+ *
+ * @param item - The order line item to format the unit price for.
+ * @returns A formatted currency string representing the unit price.
+ *
+ * @example
+ * ```typescript
+ * import { getOrderLineItemFormattedUnitPrice } from "@ikas/bp-storefront";
+ * const formattedUnit = getOrderLineItemFormattedUnitPrice(lineItem);
+ * // e.g. "$5.00"
+ * ```
+ */
+export declare function getOrderLineItemFormattedUnitPrice(item: IkasOrderLineItem): string;
+/**
+ * Returns the formatted final unit price of a line item as a currency string, reflecting any applied discounts.
+ *
+ * @ai-category OrderLineItem, Pricing
+ * @ai-related getOrderLineItemFormattedUnitPrice, getOrderLineItemFormattedFinalPrice, getOrderLineItemUnitPriceText
+ *
+ * @param item - The order line item to format the final unit price for.
+ * @returns A formatted currency string representing the final unit price.
+ *
+ * @example
+ * ```typescript
+ * import { getOrderLineItemFormattedFinalUnitPrice } from "@ikas/bp-storefront";
+ * const formattedFinalUnit = getOrderLineItemFormattedFinalUnitPrice(lineItem);
+ * // e.g. "$4.50"
+ * ```
+ */
+export declare function getOrderLineItemFormattedFinalUnitPrice(item: IkasOrderLineItem): string;
+/**
+ * Returns a descriptive text combining the formatted final unit price with the base unit name (e.g. "$5.00 / kg"). Returns an empty string if no final unit price exists.
+ *
+ * @ai-category OrderLineItem, Pricing
+ * @ai-related getOrderLineItemFormattedUnitPrice, getOrderLineItemFormattedFinalUnitPrice, getOrderLineItemFormattedFinalPrice
+ *
+ * @param item - The order line item to generate the unit price text for.
+ * @returns A string with the formatted price per unit, or an empty string if finalUnitPrice is null.
+ *
+ * @example
+ * ```typescript
+ * import { getOrderLineItemUnitPriceText } from "@ikas/bp-storefront";
+ * const unitText = getOrderLineItemUnitPriceText(lineItem);
+ * // e.g. "$5.00 / kg"
+ * ```
+ */
+export declare function getOrderLineItemUnitPriceText(item: IkasOrderLineItem): string;
+/**
+ * Returns the formatted discount amount applied to a line item as a currency string.
+ *
+ * @ai-category OrderLineItem, Pricing
+ * @ai-related hasOrderLineItemDiscount, getOrderLineItemFormattedFinalPrice, getOrderLineItemFormattedPrice
+ *
+ * @param item - The order line item to format the discount price for.
+ * @returns A formatted currency string representing the discount amount.
+ *
+ * @example
+ * ```typescript
+ * import { getOrderLineItemFormattedDiscountPrice, hasOrderLineItemDiscount } from "@ikas/bp-storefront";
+ * if (hasOrderLineItemDiscount(lineItem)) {
+ *   const discount = getOrderLineItemFormattedDiscountPrice(lineItem);
+ *   // e.g. "$2.00"
+ * }
+ * ```
+ */
+export declare function getOrderLineItemFormattedDiscountPrice(item: IkasOrderLineItem): string;
+/**
+ * Calculates the tax amount for a line item by extracting it from the tax-inclusive final price using the tax rate.
+ *
+ * @ai-category OrderLineItem, Pricing
+ * @ai-related getOrderLineItemFormattedTax, getOrderLineItemFinalPriceWithQuantity, getOrderLineItemFormattedFinalPriceWithQuantity
+ *
+ * @param item - The order line item to calculate tax for.
+ * @returns The calculated tax amount extracted from the tax-inclusive total.
+ *
+ * @example
+ * ```typescript
+ * import { getOrderLineItemTax } from "@ikas/bp-storefront";
+ * const taxAmount = getOrderLineItemTax(lineItem);
+ * ```
+ */
+export declare function getOrderLineItemTax(item: IkasOrderLineItem): number;
+/**
+ * Returns the formatted tax amount for a line item as a currency string.
+ *
+ * @ai-category OrderLineItem, Pricing
+ * @ai-related getOrderLineItemTax, getOrderLineItemFormattedFinalPriceWithQuantity, getOrderLineItemFormattedPrice
+ *
+ * @param item - The order line item to format the tax amount for.
+ * @returns A formatted currency string representing the tax amount.
+ *
+ * @example
+ * ```typescript
+ * import { getOrderLineItemFormattedTax } from "@ikas/bp-storefront";
+ * const formattedTax = getOrderLineItemFormattedTax(lineItem);
+ * // e.g. "$1.60"
+ * ```
+ */
+export declare function getOrderLineItemFormattedTax(item: IkasOrderLineItem): string;
+/**
+ * Checks whether a line item has a discount applied by verifying the discount price is not null.
+ *
+ * @ai-category OrderLineItem, Pricing
+ * @ai-related getOrderLineItemFormattedDiscountPrice, getOrderLineItemOverridenPriceWithQuantity, getOrderLineItemFormattedFinalPrice
+ *
+ * @param item - The order line item to check for a discount.
+ * @returns True if the line item has a discount applied, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { hasOrderLineItemDiscount, getOrderLineItemFormattedDiscountPrice } from "@ikas/bp-storefront";
+ * if (hasOrderLineItemDiscount(lineItem)) {
+ *   console.log("Discount:", getOrderLineItemFormattedDiscountPrice(lineItem));
+ * }
+ * ```
+ */
+export declare function hasOrderLineItemDiscount(item: IkasOrderLineItem): boolean;
+/**
+ * Gets the current refund quantity set on a line item.
+ *
+ * @ai-category OrderLineItem, Order
+ * @ai-related setOrderLineItemRefundQuantity
+ *
+ * @param item - The order line item to get the refund quantity from.
+ * @returns The refund quantity, or null/undefined if none is set.
+ *
+ * @example
+ * ```typescript
+ * import { getOrderLineItemRefundQuantity } from "@ikas/bp-storefront";
+ * const refundQty = getOrderLineItemRefundQuantity(lineItem);
+ * ```
+ */
+export declare function getOrderLineItemRefundQuantity(item: IkasOrderLineItem): number | null;
+/**
+ * Sets the refund quantity on a line item, clamping the value between 0 and the item's total quantity. Values of 0 or below are treated as null (no refund).
+ *
+ * @ai-category OrderLineItem, Order
+ * @ai-related getOrderLineItemRefundQuantity
+ *
+ * @param value - The refund quantity to set. Clamped to the item's quantity. Null, undefined, or values <= 0 clear the refund.
+ * @param item - The order line item to set the refund quantity on.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setOrderLineItemRefundQuantity } from "@ikas/bp-storefront";
+ * setOrderLineItemRefundQuantity(2, lineItem);
+ * ```
+ */
+export declare function setOrderLineItemRefundQuantity(value: number | null | undefined, item: IkasOrderLineItem): void;
+/**
+ * Navigates to the product variant page with an edit parameter for the given line item, allowing the user to modify the line item in the storefront.
+ *
+ * @ai-category OrderLineItem, Cart
+ * @ai-related getOrderLineItemRefundQuantity, setOrderLineItemRefundQuantity
+ *
+ * @param item - The order line item to navigate to for editing.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { editOrderLineItem } from "@ikas/bp-storefront";
+ * editOrderLineItem(lineItem);
+ * ```
+ */
+export declare function editOrderLineItem(item: IkasOrderLineItem): void;

package/dist/storefront/src/functions/models/order/line-item/option/value/index.d.ts

@@ -0,0 +1,37 @@
+import { IkasOrderLineItemOptionValue } from "../../../../../../../../storefront-models/src";
+/**
+ * Extracts the file name from an order line item option value's URL path.
+ *
+ * @ai-category LineItemOption, OrderLineItem
+ * @ai-related downloadFile
+ *
+ * @param value - The order line item option value containing a file URL in its value property.
+ * @returns The decoded file name extracted from the URL, or an empty string if decoding fails.
+ *
+ * @example
+ * ```typescript
+ * import { getOrderLineOptionFileName } from "@ikas/bp-storefront";
+ * const fileName = getOrderLineOptionFileName(optionValue);
+ * console.log(fileName); // "uploaded-image.png"
+ * ```
+ */
+export declare function getOrderLineOptionFileName(value: IkasOrderLineItemOptionValue): string;
+/**
+ * Downloads a file associated with an order line item option value by fetching a temporary download URL and triggering a browser download.
+ *
+ * @ai-category LineItemOption, OrderLineItem
+ * @ai-related getOrderLineOptionFileName
+ *
+ * @param value - The order line item option value containing the file URL to download.
+ * @returns The download URL string if successful, or undefined if the download fails.
+ *
+ * @example
+ * ```typescript
+ * import { downloadFile } from "@ikas/bp-storefront";
+ * const url = await downloadFile(optionValue);
+ * if (url) {
+ *   console.log("File downloaded successfully");
+ * }
+ * ```
+ */
+export declare function downloadFile(value: IkasOrderLineItemOptionValue): Promise<string | undefined>;

package/dist/storefront/src/functions/models/order/line-item/variant/bundle-product/bundle-variant/index.d.ts

@@ -0,0 +1,20 @@
+import { IkasImage, IkasOrderLineBundleVariant } from "../../../../../../../../../storefront-models/src";
+/**
+ * Retrieves the main image of an order line item bundle variant as an IkasImage object.
+ *
+ * @ai-category BundleProduct, LineItemVariant, OrderLineItem
+ * @ai-related getIkasOrderLineVariantMainImage
+ *
+ * @param variant - The order line bundle variant containing the main image ID.
+ * @returns An IkasImage object with the main image ID, or null if no main image is set.
+ *
+ * @example
+ * ```typescript
+ * import { getIkasOrderLineBundleVariantMainImage } from "@ikas/bp-storefront";
+ * const image = getIkasOrderLineBundleVariantMainImage(bundleVariant);
+ * if (image) {
+ *   console.log(image.id);
+ * }
+ * ```
+ */
+export declare function getIkasOrderLineBundleVariantMainImage(variant: IkasOrderLineBundleVariant): IkasImage | null;

package/dist/storefront/src/functions/models/order/line-item/variant/index.d.ts

@@ -0,0 +1,37 @@
+import { IkasImage, IkasOrderLineVariant } from "../../../../../../../storefront-models/src";
+/**
+ * Builds the product page URL for an order line item variant, including variant query parameters.
+ *
+ * @ai-category LineItemVariant, OrderLineItem
+ * @ai-related getIkasOrderLineVariantMainImage
+ *
+ * @param variant - The order line item variant containing slug and variant values.
+ * @returns The full href string with route prefix and variant parameters, or undefined if the variant has no slug.
+ *
+ * @example
+ * ```typescript
+ * import { getIkasOrderLineVariantHref } from "@ikas/bp-storefront";
+ * const href = getIkasOrderLineVariantHref(lineItemVariant);
+ * // "/product-slug?color=red&size=large"
+ * ```
+ */
+export declare function getIkasOrderLineVariantHref(variant: IkasOrderLineVariant): string | undefined;
+/**
+ * Retrieves the main image of an order line item variant as an IkasImage object.
+ *
+ * @ai-category LineItemVariant, OrderLineItem
+ * @ai-related getIkasOrderLineVariantHref
+ *
+ * @param variant - The order line item variant containing the main image ID.
+ * @returns An IkasImage object with the main image ID, or null if no main image is set.
+ *
+ * @example
+ * ```typescript
+ * import { getIkasOrderLineVariantMainImage } from "@ikas/bp-storefront";
+ * const image = getIkasOrderLineVariantMainImage(lineItemVariant);
+ * if (image) {
+ *   console.log(image.id);
+ * }
+ * ```
+ */
+export declare function getIkasOrderLineVariantMainImage(variant: IkasOrderLineVariant): IkasImage | null;

package/dist/storefront/src/functions/models/order/line-item/variant/value/index.d.ts

@@ -0,0 +1,35 @@
+import { IkasOrderLineVariantVariantValue } from "../../../../../../../../storefront-models/src";
+/**
+ * Converts the variant type name of an order line item variant value into a URL-friendly slug.
+ *
+ * @ai-category LineItemVariant, OrderLineItem
+ * @ai-related getIkasOrderLineVariantNameSlug
+ *
+ * @param variantValue - The order line variant value containing the variant type name.
+ * @returns A slugified version of the variant type name, or an empty string if no type name exists.
+ *
+ * @example
+ * ```typescript
+ * import { getIkasOrderLineVariantTypeSlug } from "@ikas/bp-storefront";
+ * const typeSlug = getIkasOrderLineVariantTypeSlug(variantValue);
+ * // "color"
+ * ```
+ */
+export declare function getIkasOrderLineVariantTypeSlug(variantValue: IkasOrderLineVariantVariantValue): string;
+/**
+ * Converts the variant value name of an order line item variant value into a URL-friendly slug.
+ *
+ * @ai-category LineItemVariant, OrderLineItem
+ * @ai-related getIkasOrderLineVariantTypeSlug
+ *
+ * @param variantValue - The order line variant value containing the variant value name.
+ * @returns A slugified version of the variant value name, or an empty string if no value name exists.
+ *
+ * @example
+ * ```typescript
+ * import { getIkasOrderLineVariantNameSlug } from "@ikas/bp-storefront";
+ * const nameSlug = getIkasOrderLineVariantNameSlug(variantValue);
+ * // "red"
+ * ```
+ */
+export declare function getIkasOrderLineVariantNameSlug(variantValue: IkasOrderLineVariantVariantValue): string;

package/dist/storefront/src/functions/models/order/package/index.d.ts

@@ -0,0 +1,20 @@
+import { IkasOrder, IkasOrderPackage } from "../../../../../../storefront-models/src";
+/**
+ * Filters and returns the order line items that belong to a specific order package.
+ *
+ * @ai-category OrderPackage, Order
+ * @ai-related
+ *
+ * @param order - The full order containing all line items.
+ * @param orderPackage - The order package whose associated line items to retrieve.
+ * @returns An array of order line items whose IDs are included in the package's orderLineItemIds.
+ *
+ * @example
+ * ```typescript
+ * import { getOrderPackageOrderLineItems } from "@ikas/bp-storefront";
+ *
+ * const lineItems = getOrderPackageOrderLineItems(order, order.orderPackages[0]);
+ * lineItems.forEach(item => console.log(item.name));
+ * ```
+ */
+export declare function getOrderPackageOrderLineItems(order: IkasOrder, orderPackage: IkasOrderPackage): import("../../../../../../storefront-models/src").IkasOrderLineItem[];

package/dist/storefront/src/functions/models/order/transaction/index.d.ts

@@ -0,0 +1,37 @@
+import { IkasOrderTransaction } from "../../../../../../storefront-models/src";
+/**
+ * Returns the formatted currency string for an order transaction amount, defaulting to zero and empty strings for missing values.
+ *
+ * @ai-category OrderTransaction, Order
+ * @ai-related getOrderTransactionPaymentMethodTranslation
+ *
+ * @param transaction - The order transaction whose amount to format.
+ * @returns A locale-formatted currency string representing the transaction amount (e.g. "$25.00").
+ *
+ * @example
+ * ```typescript
+ * import { getOrderTransactionFormattedAmount } from "@ikas/bp-storefront";
+ *
+ * const formatted = getOrderTransactionFormattedAmount(transaction);
+ * // "$25.00"
+ * ```
+ */
+export declare function getOrderTransactionFormattedAmount(transaction: IkasOrderTransaction): string;
+/**
+ * Returns the localized label for an order transaction's payment method.
+ *
+ * @ai-category OrderTransaction, Order
+ * @ai-related getOrderTransactionFormattedAmount
+ *
+ * @param orderTransaction - The order transaction whose payment method to translate.
+ * @returns The translated payment method string (e.g. "Credit Card", "Cash on Delivery"), or an empty string if the payment method is not set or unrecognized.
+ *
+ * @example
+ * ```typescript
+ * import { getOrderTransactionPaymentMethodTranslation } from "@ikas/bp-storefront";
+ *
+ * const label = getOrderTransactionPaymentMethodTranslation(transaction);
+ * // "Credit Card"
+ * ```
+ */
+export declare function getOrderTransactionPaymentMethodTranslation(orderTransaction: IkasOrderTransaction): string;

package/dist/storefront/src/functions/models/payment-gateway/index.d.ts

@@ -0,0 +1,31 @@
+import { IkasOrderShippingLine, IkasPaymentGateway } from "../../../../../storefront-models/src";
+/**
+ * Calculates the additional price adjustments for a payment gateway, applying ratio-based or fixed amounts sequentially after excluding shipping costs.
+ *
+ * @ai-category PaymentGateway
+ * @ai-related getCheckoutTotalFinalPrice
+ *
+ * @param paymentGateway - The payment gateway containing the additional price rules to apply.
+ * @param totalFinalPrice - The total final price of the order before additional price adjustments.
+ * @param shippingLines - The shipping lines whose prices are subtracted from the total before calculating additional prices, or null if none.
+ * @returns An array of calculated additional price objects with name, amount, and type, or undefined if no additional prices are configured.
+ *
+ * @example
+ * ```typescript
+ * import { getPaymentGatewayCalculatedAdditionalPrices } from "@ikas/bp-storefront";
+ *
+ * const additionalPrices = getPaymentGatewayCalculatedAdditionalPrices(
+ *   paymentGateway,
+ *   100,
+ *   shippingLines
+ * );
+ * additionalPrices?.forEach((price) => {
+ *   console.log(price.name, price.amount, price.type);
+ * });
+ * ```
+ */
+export declare function getPaymentGatewayCalculatedAdditionalPrices(paymentGateway: IkasPaymentGateway, totalFinalPrice: number, shippingLines: IkasOrderShippingLine[] | null): {
+    name: string;
+    amount: number;
+    type: import("../../../../../storefront-models/src").IkasPaymentGatewayAdditionalPriceType;
+}[] | undefined;

package/dist/storefront/src/functions/models/payment-gateway/init.d.ts

@@ -0,0 +1,20 @@
+import { IkasPaymentGateway } from "../../../../../storefront-models/src";
+/**
+ * Initializes an IkasPaymentGateway by applying locale-specific translations to its name and description, then removing raw translation data.
+ *
+ * @ai-category Initialization, PaymentGateway
+ * @ai-related setIkasPaymentGatewayTranslations
+ *
+ * @param paymentGateway - The payment gateway object to initialize with localized data.
+ * @param locale - The locale code to use for translation lookup, or null to skip translation.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initIkasPaymentGateway } from "@ikas/bp-storefront";
+ * const gateway = { name: "Credit Card", translations: [{ locale: "fr", name: "Carte de credit" }] };
+ * initIkasPaymentGateway(gateway, "fr");
+ * // gateway.name is now "Carte de credit"
+ * ```
+ */
+export declare function initIkasPaymentGateway(paymentGateway: IkasPaymentGateway, locale: string | null): void;

package/dist/storefront/src/functions/models/product/attribute/init.d.ts

@@ -0,0 +1,17 @@
+import { IkasProductAttribute } from "../../../../../../storefront-models/src";
+/**
+ * Initializes a product attribute by applying locale-specific translations for name, description, and options, then removes the raw translations data.
+ *
+ * @ai-category Initialization, ProductAttribute
+ *
+ * @param attribute - The product attribute to initialize
+ * @param locale - The locale string for translations, or null to skip translations
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initIkasProductAttribute } from "@ikas/bp-storefront";
+ * initIkasProductAttribute(attribute, "en");
+ * ```
+ */
+export declare function initIkasProductAttribute(attribute: IkasProductAttribute, locale: string | null): void;

package/dist/storefront/src/functions/models/product/attribute-value/index.d.ts

@@ -0,0 +1,52 @@
+import { IkasAttributeTableCellValue, IkasProductAttributeValue } from "../../../../../../storefront-models/src";
+/**
+ * Parses and returns the table cell values from a product attribute value's JSON string.
+ *
+ * @ai-category ProductAttribute
+ * @ai-related getIkasProductAttrributeProductIds, getIkasProductAttributeProducts
+ *
+ * @param value - The product attribute value containing a JSON-encoded table value.
+ * @returns An array of table cell values, or an empty array if parsing fails or value is empty.
+ *
+ * @example
+ * ```typescript
+ * import { getIkasProductAttributeTableValue } from "@ikas/bp-storefront";
+ * const tableCells = getIkasProductAttributeTableValue(attributeValue);
+ * tableCells?.forEach(cell => console.log(cell));
+ * ```
+ */
+export declare function getIkasProductAttributeTableValue(value: IkasProductAttributeValue): IkasAttributeTableCellValue[] | undefined;
+/**
+ * Extracts and returns the product IDs from a PRODUCT-type attribute value's JSON string.
+ *
+ * @ai-category ProductAttribute, Product
+ * @ai-related getIkasProductAttributeTableValue, getIkasProductAttributeProducts
+ *
+ * @param value - The product attribute value containing a JSON-encoded array of product IDs.
+ * @returns An array of product ID strings, or an empty array if the attribute is not of type PRODUCT or parsing fails.
+ *
+ * @example
+ * ```typescript
+ * import { getIkasProductAttrributeProductIds } from "@ikas/bp-storefront";
+ * const productIds = getIkasProductAttrributeProductIds(attributeValue);
+ * console.log(productIds); // ["id1", "id2"]
+ * ```
+ */
+export declare function getIkasProductAttrributeProductIds(value: IkasProductAttributeValue): string[];
+/**
+ * Fetches and returns the full product objects referenced by a PRODUCT-type attribute value.
+ *
+ * @ai-category ProductAttribute, Product
+ * @ai-related getIkasProductAttrributeProductIds, getIkasProductAttributeTableValue
+ *
+ * @param value - The product attribute value containing product IDs to look up.
+ * @returns A promise that resolves to an array of product objects, or an empty array if the attribute is not of type PRODUCT or the fetch fails.
+ *
+ * @example
+ * ```typescript
+ * import { getIkasProductAttributeProducts } from "@ikas/bp-storefront";
+ * const products = await getIkasProductAttributeProducts(attributeValue);
+ * products.forEach(product => console.log(product.name));
+ * ```
+ */
+export declare function getIkasProductAttributeProducts(value: IkasProductAttributeValue): Promise<import("../../../../../../storefront-models/src").IkasProduct[]>;

package/dist/storefront/src/functions/models/product/attribute-value/init.d.ts

@@ -0,0 +1,16 @@
+import { IkasProductAttributeValue } from "../../../../../../storefront-models/src";
+/**
+ * Initializes a product attribute value by converting its image IDs into image objects with default non-video flags.
+ *
+ * @ai-category Initialization, ProductAttribute
+ *
+ * @param value - The product attribute value to initialize
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initIkasProductAttributeValue } from "@ikas/bp-storefront";
+ * initIkasProductAttributeValue(attributeValue);
+ * ```
+ */
+export declare function initIkasProductAttributeValue(value: IkasProductAttributeValue): void;

package/dist/storefront/src/functions/models/product/campaign-offer/index.d.ts

@@ -0,0 +1,18 @@
+import { IkasProductOffer } from "../../../../../../storefront-models/src";
+/**
+ * Checks whether a product campaign offer has been accepted in the current cart by matching offer and product IDs with a PRODUCT target page type and ACCEPTED status.
+ *
+ * @ai-category CampaignOffer, Product
+ *
+ * @param offer - The product offer to check acceptance status for.
+ * @returns True if the offer is found in the cart with an ACCEPTED status targeting product pages, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isProductOfferAccepted } from "@ikas/bp-storefront";
+ * if (isProductOfferAccepted(product.offers[0])) {
+ *   console.log("Campaign offer has been accepted");
+ * }
+ * ```
+ */
+export declare function isProductOfferAccepted(offer: IkasProductOffer): boolean;