@ikas/bp-storefront 0.15.0

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

@@ -0,0 +1,18 @@
+import { IkasCampaignOffer } from "../../../../../../storefront-models/src";
+/**
+ * Initializes a campaign offer by delegating initialization of each individual offer product with locale-specific translations.
+ *
+ * @ai-category Initialization, CampaignOffer
+ * @ai-related initIkasCampaignOfferProduct
+ *
+ * @param campaignOffer - The campaign offer containing offers to initialize
+ * @param locale - The locale string for translations, or null to skip translations
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initIkasCampaignOffer } from "@ikas/bp-storefront";
+ * initIkasCampaignOffer(campaignOffer, "en");
+ * ```
+ */
+export declare function initIkasCampaignOffer(campaignOffer: IkasCampaignOffer, locale: string | null): void;

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

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

package/dist/storefront/src/functions/models/product/filter/index.d.ts

@@ -0,0 +1,344 @@
+import { IkasApplicableProductFilterValue, IkasFilterRangeValue, IkasImage, IkasProductFilter, IkasProductFilterDisplayType, IkasProductFilterNumberRangeListOption, IkasProductFilterType } from "../../../../../../storefront-models/src";
+/**
+ * Initializes a product filter by resetting all selected states and parsing custom range values.
+ *
+ * @ai-category ProductFilter, Filtering
+ * @ai-related clearFilter, isCustomValueFilter, filterParseRangeStr
+ *
+ * @param filter - The product filter to initialize.
+ * @returns The initialized product filter with reset selections and parsed range options.
+ *
+ * @example
+ * ```typescript
+ * import { initIkasProductFilter } from "@ikas/bp-storefront";
+ * const initializedFilter = initIkasProductFilter(filter);
+ * ```
+ */
+export declare function initIkasProductFilter(filter: IkasProductFilter): IkasProductFilter;
+/**
+ * Checks whether the filter uses custom numeric range values (NUMBER_RANGE or NUMBER_RANGE_LIST).
+ *
+ * @ai-category ProductFilter, Filtering
+ * @ai-related isBoxFilter, isListFilter, isSwatchFilter, isStockFilter
+ *
+ * @param filter - The product filter to check.
+ * @returns True if the filter display type is NUMBER_RANGE_LIST or NUMBER_RANGE.
+ *
+ * @example
+ * ```typescript
+ * import { isCustomValueFilter } from "@ikas/bp-storefront";
+ * if (isCustomValueFilter(filter)) {
+ *   // handle numeric range filter
+ * }
+ * ```
+ */
+export declare function isCustomValueFilter(filter: IkasProductFilter): boolean;
+/**
+ * Checks whether the filter uses a box display type.
+ *
+ * @ai-category ProductFilter, Filtering
+ * @ai-related isListFilter, isSwatchFilter, isCustomValueFilter, isStockFilter
+ *
+ * @param filter - The product filter to check.
+ * @returns True if the filter display type is BOX.
+ *
+ * @example
+ * ```typescript
+ * import { isBoxFilter } from "@ikas/bp-storefront";
+ * if (isBoxFilter(filter)) {
+ *   // render box-style filter UI
+ * }
+ * ```
+ */
+export declare function isBoxFilter(filter: IkasProductFilter): boolean;
+/**
+ * Checks whether the filter uses a list display type.
+ *
+ * @ai-category ProductFilter, Filtering
+ * @ai-related isBoxFilter, isSwatchFilter, isCustomValueFilter, isStockFilter
+ *
+ * @param filter - The product filter to check.
+ * @returns True if the filter display type is LIST.
+ *
+ * @example
+ * ```typescript
+ * import { isListFilter } from "@ikas/bp-storefront";
+ * if (isListFilter(filter)) {
+ *   // render list-style filter UI
+ * }
+ * ```
+ */
+export declare function isListFilter(filter: IkasProductFilter): boolean;
+/**
+ * Checks whether the filter uses a swatch display type (e.g., color swatches).
+ *
+ * @ai-category ProductFilter, Filtering
+ * @ai-related isBoxFilter, isListFilter, isCustomValueFilter, isStockFilter
+ *
+ * @param filter - The product filter to check.
+ * @returns True if the filter display type is SWATCH.
+ *
+ * @example
+ * ```typescript
+ * import { isSwatchFilter } from "@ikas/bp-storefront";
+ * if (isSwatchFilter(filter)) {
+ *   // render swatch-style filter UI (e.g., color circles)
+ * }
+ * ```
+ */
+export declare function isSwatchFilter(filter: IkasProductFilter): boolean;
+/**
+ * Checks whether the filter is a stock status filter.
+ *
+ * @ai-category ProductFilter, Filtering
+ * @ai-related isBoxFilter, isListFilter, isSwatchFilter, isCustomValueFilter
+ *
+ * @param filter - The product filter to check.
+ * @returns True if the filter type is STOCK_STATUS.
+ *
+ * @example
+ * ```typescript
+ * import { isStockFilter } from "@ikas/bp-storefront";
+ * if (isStockFilter(filter)) {
+ *   // handle stock availability filtering
+ * }
+ * ```
+ */
+export declare function isStockFilter(filter: IkasProductFilter): boolean;
+/**
+ * Returns a list of selected filter value IDs, handling standard values, number range, and number range list types.
+ *
+ * @ai-category ProductFilter, Filtering
+ * @ai-related getFilterKeyList, getFilterDisplayedValues, filterRangeToId
+ *
+ * @param filter - The product filter to extract selected value IDs from.
+ * @returns An array of string IDs representing the currently selected filter values.
+ *
+ * @example
+ * ```typescript
+ * import { getFilterValueList } from "@ikas/bp-storefront";
+ * const selectedIds = getFilterValueList(filter);
+ * console.log(selectedIds); // ["value1", "value2"]
+ * ```
+ */
+export declare function getFilterValueList(filter: IkasProductFilter): string[];
+/**
+ * Returns a list of selected filter value keys, handling standard values, number range, and number range list types.
+ *
+ * @ai-category ProductFilter, Filtering
+ * @ai-related getFilterValueList, getFilterDisplayedValues, filterRangeToId
+ *
+ * @param filter - The product filter to extract selected value keys from.
+ * @returns An array of string keys representing the currently selected filter values.
+ *
+ * @example
+ * ```typescript
+ * import { getFilterKeyList } from "@ikas/bp-storefront";
+ * const selectedKeys = getFilterKeyList(filter);
+ * console.log(selectedKeys); // ["red", "blue"]
+ * ```
+ */
+export declare function getFilterKeyList(filter: IkasProductFilter): string[];
+/**
+ * Returns the filter values sorted and filtered for display, respecting the configured sort type (alphabetical, product count, or custom).
+ *
+ * @ai-category ProductFilter, Filtering, ProductList
+ * @ai-related getFilterValueList, getFilterKeyList, selectFilterValue
+ *
+ * @param filter - The product filter whose values to retrieve and sort for display.
+ * @returns A sorted array of filter values, excluding unselected values with zero result count.
+ *
+ * @example
+ * ```typescript
+ * import { getFilterDisplayedValues } from "@ikas/bp-storefront";
+ * const displayedValues = getFilterDisplayedValues(filter);
+ * displayedValues.forEach(value => {
+ *   console.log(value.key, value.resultCount);
+ * });
+ * ```
+ */
+export declare function getFilterDisplayedValues(filter: IkasProductFilter): IkasApplicableProductFilterValue[];
+/**
+ * Toggles the selection state of a filter value, enforcing single-select behavior when the filter does not allow multi-select.
+ *
+ * @ai-category ProductFilter, Filtering
+ * @ai-related getFilterValueList, getFilterDisplayedValues, clearFilter, isCustomValueFilter
+ *
+ * @param filter - The product filter containing the value to select.
+ * @param filterValue - The specific filter value to toggle selection on.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { selectFilterValue } from "@ikas/bp-storefront";
+ * selectFilterValue(filter, filterValue);
+ * // filterValue.isSelected is now toggled
+ * ```
+ */
+export declare function selectFilterValue(filter: IkasProductFilter, filterValue: IkasApplicableProductFilterValue): void;
+/**
+ * Handles a click on a number range list filter option, toggling its selection and enforcing single-select when applicable.
+ *
+ * @ai-category ProductFilter, Filtering
+ * @ai-related onNumberRangeFilterChange, selectFilterValue, isCustomValueFilter
+ *
+ * @param filter - The product filter of type NUMBER_RANGE_LIST.
+ * @param option - The number range list option that was clicked.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { onNumberRangeFilterOptionClick } from "@ikas/bp-storefront";
+ * onNumberRangeFilterOptionClick(filter, selectedOption);
+ * // selectedOption.isSelected is now toggled
+ * ```
+ */
+export declare function onNumberRangeFilterOptionClick(filter: IkasProductFilter, option: IkasProductFilterNumberRangeListOption): void;
+/**
+ * Updates the number range filter value, clamping it within the configured range limits.
+ *
+ * @ai-category ProductFilter, Filtering
+ * @ai-related onNumberRangeFilterOptionClick, filterParseRangeStr, clearFilter
+ *
+ * @param filter - The product filter of type NUMBER_RANGE.
+ * @param numberRange - The new range value to apply, or null to clear the range.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { onNumberRangeFilterChange } from "@ikas/bp-storefront";
+ * onNumberRangeFilterChange(filter, { from: 10, to: 100 });
+ * // or clear the range:
+ * onNumberRangeFilterChange(filter, null);
+ * ```
+ */
+export declare function onNumberRangeFilterChange(filter: IkasProductFilter, numberRange: IkasFilterRangeValue | null): void;
+/**
+ * Resets all selected states on a filter, clearing number range, number range list options, and standard values.
+ *
+ * @ai-category ProductFilter, Filtering
+ * @ai-related initIkasProductFilter, selectFilterValue, onNumberRangeFilterChange
+ *
+ * @param filter - The product filter to clear.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { clearFilter } from "@ikas/bp-storefront";
+ * clearFilter(filter);
+ * // all filter selections are now reset
+ * ```
+ */
+export declare function clearFilter(filter: IkasProductFilter): void;
+/**
+ * Converts a product filter into a search input filter object suitable for API queries.
+ *
+ * @ai-category ProductFilter, Search, Filtering
+ * @ai-related getFilterValueList, applyQueryParamForFilter
+ *
+ * @param filter - The product filter to convert.
+ * @returns An IkasSearchInputFilterListInput object containing the filter's key, type, selected values, and AND filter setting.
+ *
+ * @example
+ * ```typescript
+ * import { filterToInput } from "@ikas/bp-storefront";
+ * const searchInput = filterToInput(filter);
+ * // use searchInput in a product search API call
+ * ```
+ */
+export declare function filterToInput(filter: IkasProductFilter): IkasSearchInputFilterListInput;
+/**
+ * Applies URL query parameter values to a filter, restoring selected states for number range, number range list, or standard filter values.
+ *
+ * @ai-category ProductFilter, Filtering, Search
+ * @ai-related filterToInput, filterParseRangeStr, selectFilterValue
+ *
+ * @param filter - The product filter to apply query parameter values to.
+ * @param value - A comma-separated string of filter value keys from the URL query parameter.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { applyQueryParamForFilter } from "@ikas/bp-storefront";
+ * applyQueryParamForFilter(filter, "red,blue,green");
+ * // filter values matching "red", "blue", "green" are now selected
+ * ```
+ */
+export declare function applyQueryParamForFilter(filter: IkasProductFilter, value: string): void;
+/**
+ * Converts a filter range value into a colon-separated string identifier (e.g., "10:100" or "10:").
+ *
+ * @ai-category ProductFilter, Filtering
+ * @ai-related filterParseRangeStr, getFilterValueList, getFilterKeyList
+ *
+ * @param range - The range value containing `from` and optionally `to` numeric bounds.
+ * @returns A string in the format "from:to" representing the range, with an empty `to` if undefined.
+ *
+ * @example
+ * ```typescript
+ * import { filterRangeToId } from "@ikas/bp-storefront";
+ * const id = filterRangeToId({ from: 10, to: 100 });
+ * console.log(id); // "10:100"
+ * ```
+ */
+export declare function filterRangeToId(range: IkasFilterRangeValue): string;
+/**
+ * Parses a colon-separated range string (e.g., "10:100") into a structured range value with `from` and `to` fields.
+ *
+ * @ai-category ProductFilter, Filtering
+ * @ai-related filterRangeToId, initIkasProductFilter, applyQueryParamForFilter
+ *
+ * @param rangeStr - A colon-separated string representing a numeric range (e.g., "10:100" or "10:").
+ * @returns An IkasFilterRangeValue with parsed `from` and `to` values, defaulting to 0 on parse errors.
+ *
+ * @example
+ * ```typescript
+ * import { filterParseRangeStr } from "@ikas/bp-storefront";
+ * const range = filterParseRangeStr("10:100");
+ * console.log(range); // { from: 10, to: 100 }
+ * ```
+ */
+export declare function filterParseRangeStr(rangeStr: string): IkasFilterRangeValue;
+/**
+ * Returns the navigable href for a filter value based on its slug, prefixed with the current route prefix.
+ *
+ * @ai-category ProductFilter, Filtering, ProductList
+ * @ai-related getIkasFilterThumbnailImage, getFilterDisplayedValues
+ *
+ * @param value - The applicable product filter value containing a slug.
+ * @returns A prefixed URL path string for the filter value, or the route prefix root if no slug exists.
+ *
+ * @example
+ * ```typescript
+ * import { getIkasFilterHref } from "@ikas/bp-storefront";
+ * const href = getIkasFilterHref(filterValue);
+ * // e.g., "/en/shoes" or "/en"
+ * ```
+ */
+export declare function getIkasFilterHref(value: IkasApplicableProductFilterValue): string;
+/**
+ * Returns a thumbnail image object for a filter value if a thumbnail image ID exists.
+ *
+ * @ai-category ProductFilter, Filtering, ProductList
+ * @ai-related getIkasFilterHref, getFilterDisplayedValues
+ *
+ * @param value - The applicable product filter value that may contain a thumbnail image ID.
+ * @returns An IkasImage object with the thumbnail image ID if available, or undefined if no thumbnail exists.
+ *
+ * @example
+ * ```typescript
+ * import { getIkasFilterThumbnailImage } from "@ikas/bp-storefront";
+ * const image = getIkasFilterThumbnailImage(filterValue);
+ * if (image) {
+ *   console.log(image.id); // thumbnail image ID
+ * }
+ * ```
+ */
+export declare function getIkasFilterThumbnailImage(value: IkasApplicableProductFilterValue): IkasImage | undefined;
+export type IkasSearchInputFilterListInput = {
+    displayType?: IkasProductFilterDisplayType | null;
+    id: string;
+    type: IkasProductFilterType;
+    useAndFilter?: boolean | null;
+    valueList: string[];
+};

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

@@ -0,0 +1,22 @@
+import { IkasProductFilterSettings } from "../../../../../../../storefront-models/src";
+/**
+ * Initializes product filter settings by creating a shallow copy of the provided partial settings data.
+ *
+ * @ai-category Initialization, ProductFilter
+ *
+ * @param data - Partial product filter settings to initialize from
+ * @returns A new object containing the spread filter settings
+ *
+ * @example
+ * ```typescript
+ * import { initProductFilterSettings } from "@ikas/bp-storefront";
+ * const settings = initProductFilterSettings({ minPrice: 0, maxPrice: 100 });
+ * ```
+ */
+export declare function initProductFilterSettings(data: Partial<IkasProductFilterSettings>): {
+    useAndFilter?: (boolean | null) | undefined;
+    showCollapsedOnDesktop?: boolean | undefined;
+    showCollapsedOnMobile?: boolean | undefined;
+    sortType?: import("../../../../../../../storefront-models/src").IkasProductFilterSortType | undefined;
+    customSortedValues?: string[] | null | undefined;
+};

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

@@ -0,0 +1,35 @@
+import { IkasProductGroup } from "../../../../../../storefront-models/src";
+/**
+ * Initializes a product group by applying locale-specific translations to group values and then removing the raw translations data.
+ *
+ * @ai-category Initialization, ProductGroup
+ * @ai-related setProductGroupTranslations
+ *
+ * @param group - The product group to initialize
+ * @param locale - The locale string for translations, or null to skip translations
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initIkasProductGroup } from "@ikas/bp-storefront";
+ * initIkasProductGroup(productGroup, "en");
+ * ```
+ */
+export declare function initIkasProductGroup(group: IkasProductGroup, locale: string | null): void;
+/**
+ * Applies locale-specific translations to a product group's values, updating each value's name and value fields from the matching translation.
+ *
+ * @ai-category Initialization, ProductGroup
+ * @ai-related initIkasProductGroup
+ *
+ * @param group - The product group whose values will be translated
+ * @param locale - The locale string to match against available translations
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setProductGroupTranslations } from "@ikas/bp-storefront";
+ * setProductGroupTranslations(productGroup, "en");
+ * ```
+ */
+export declare function setProductGroupTranslations(group: IkasProductGroup, locale: string): void;

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

@@ -0,0 +1,16 @@
+import { IkasProductImage } from "../../../../../../storefront-models/src";
+/**
+ * Initializes a product image by converting its image ID into an image object with a video flag, or setting it to null if no image ID exists.
+ *
+ * @ai-category Initialization, ProductImage
+ *
+ * @param productImage - The product image to initialize
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initIkasProductImage } from "@ikas/bp-storefront";
+ * initIkasProductImage(productImage);
+ * ```
+ */
+export declare function initIkasProductImage(productImage: IkasProductImage): void;