@ikas/bp-storefront 0.15.0

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

@@ -0,0 +1,57 @@
+import { IkasProduct } from "../../../../../storefront-models/src";
+/**
+ * In-memory store mapping variant IDs to their parent product instances.
+ *
+ * @ai-category Initialization, Product
+ * @ai-related initIkasProductExtraFields, getProductFromStore
+ */
+export declare const productVariantStore: Record<string, IkasProduct>;
+/**
+ * Initializes an IkasProduct by applying locale-specific translations and initializing all nested entities including metadata, brand, categories, variants, attributes, variant types, and product group.
+ *
+ * @ai-category Initialization, Product
+ * @ai-related initIkasProductExtraFields, getProductFromStore
+ *
+ * @param product - The product instance to initialize
+ * @param locale - The locale string for translations, or null to skip translations
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initIkasProduct } from "@ikas/bp-storefront";
+ * initIkasProduct(product, "en");
+ * ```
+ */
+export declare function initIkasProduct(product: IkasProduct, locale: string | null): void;
+/**
+ * Populates the product variant store by mapping each variant ID to its parent product.
+ *
+ * @ai-category Initialization, Product
+ * @ai-related initIkasProduct, getProductFromStore, productVariantStore
+ *
+ * @param product - The product whose variants will be registered in the variant store
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initIkasProductExtraFields } from "@ikas/bp-storefront";
+ * initIkasProductExtraFields(product);
+ * ```
+ */
+export declare function initIkasProductExtraFields(product: IkasProduct): void;
+/**
+ * Retrieves a product from the in-memory variant store by its variant ID.
+ *
+ * @ai-category Initialization, Product
+ * @ai-related initIkasProductExtraFields, productVariantStore
+ *
+ * @param variantId - The variant ID used to look up the parent product
+ * @returns The IkasProduct associated with the given variant ID, or undefined if not found
+ *
+ * @example
+ * ```typescript
+ * import { getProductFromStore } from "@ikas/bp-storefront";
+ * const product = getProductFromStore("variant-123");
+ * ```
+ */
+export declare function getProductFromStore(variantId: string): IkasProduct;

package/dist/storefront/src/functions/models/product/option-set/index.d.ts

@@ -0,0 +1,84 @@
+import { IkasProductOption, IkasProductOptionSet } from "../../../../../../storefront-models/src";
+/**
+ * Sets child options for each option in the option set by linking options that have a required parent option.
+ *
+ * @ai-category ProductOptionSet
+ * @ai-related getDisplayedOptions, initOptionValues, initProductOptionSetValues
+ *
+ * @param optionSet - The product option set whose options will have their child options populated.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setChildOptions } from "@ikas/bp-storefront";
+ * setChildOptions(product.optionSet);
+ * ```
+ */
+export declare function setChildOptions(optionSet: IkasProductOptionSet): void;
+/**
+ * Initializes the values for all options within the given product option set.
+ *
+ * @ai-category ProductOptionSet
+ * @ai-related initProductOptionSetValues, setChildOptions, getDisplayedOptions
+ *
+ * @param optionSet - The product option set whose option values will be initialized.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initOptionValues } from "@ikas/bp-storefront";
+ * initOptionValues(product.optionSet);
+ * ```
+ */
+export declare function initOptionValues(optionSet: IkasProductOptionSet): void;
+/**
+ * Returns the top-level displayed options from an option set, sorted by their order, excluding child options that depend on a parent.
+ *
+ * @ai-category ProductOptionSet
+ * @ai-related setChildOptions, hasValidProductOptionSetValues, initOptionValues
+ *
+ * @param optionSet - The product option set to retrieve displayed options from.
+ * @returns An array of top-level product options sorted by their order property.
+ *
+ * @example
+ * ```typescript
+ * import { getDisplayedOptions } from "@ikas/bp-storefront";
+ * const options = getDisplayedOptions(product.optionSet);
+ * options.forEach(option => console.log(option.name));
+ * ```
+ */
+export declare function getDisplayedOptions(optionSet: IkasProductOptionSet): IkasProductOption[];
+/**
+ * Initializes the values for all options in the product option set by delegating to the option-level initializer.
+ *
+ * @ai-category ProductOptionSet
+ * @ai-related initOptionValues, setChildOptions, hasValidProductOptionSetValues
+ *
+ * @param optionSet - The product option set whose option values will be initialized.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initProductOptionSetValues } from "@ikas/bp-storefront";
+ * initProductOptionSetValues(product.optionSet);
+ * ```
+ */
+export declare function initProductOptionSetValues(optionSet: IkasProductOptionSet): void;
+/**
+ * Checks whether all displayed options in the product option set have valid values selected.
+ *
+ * @ai-category ProductOptionSet
+ * @ai-related getDisplayedOptions, initProductOptionSetValues, initOptionValues
+ *
+ * @param optionSet - The product option set to validate.
+ * @returns True if every displayed option has valid values, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { hasValidProductOptionSetValues } from "@ikas/bp-storefront";
+ * if (hasValidProductOptionSetValues(product.optionSet)) {
+ *   // proceed to add to cart
+ * }
+ * ```
+ */
+export declare function hasValidProductOptionSetValues(optionSet: IkasProductOptionSet): boolean;

package/dist/storefront/src/functions/models/product/option-set/init.d.ts

@@ -0,0 +1,19 @@
+import { IkasProduct, IkasProductOptionSet } from "../../../../../../storefront-models/src";
+/**
+ * Initializes a product option set by linking each option to its parent set, initializing individual options, applying locale-specific translations, setting up child options, and initializing option values.
+ *
+ * @ai-category Initialization, ProductOptionSet
+ * @ai-related initIkasProductOption
+ *
+ * @param optionSet - The product option set to initialize
+ * @param locale - The locale string for translations, or null to skip translations
+ * @param product - The parent product used during option initialization
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initIkasProductOptionSet } from "@ikas/bp-storefront";
+ * initIkasProductOptionSet(optionSet, "en", product);
+ * ```
+ */
+export declare function initIkasProductOptionSet(optionSet: IkasProductOptionSet, locale: string | null, product: IkasProduct): void;

package/dist/storefront/src/functions/models/product/option-set/option/index.d.ts

@@ -0,0 +1,449 @@
+import { IkasProductOption, IkasProductOptionSelectValue } from "../../../../../../../storefront-models/src";
+/**
+ * Returns the visible child options of a product option, filtered by selection state and sorted by order.
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related hasValidProductOptionValues, clearValues, initIkasProductOptionValues
+ *
+ * @param option - The parent product option whose child options to retrieve.
+ * @returns An array of child options that should be displayed based on current selections.
+ *
+ * @example
+ * ```typescript
+ * import { getDisplayedChildOptions } from "@ikas/bp-storefront";
+ * const visibleChildren = getDisplayedChildOptions(option);
+ * ```
+ */
+export declare function getDisplayedChildOptions(option: IkasProductOption): IkasProductOption[];
+/**
+ * Checks whether a product option and all its displayed child options have valid values based on their type and settings.
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related hasError, getDisplayedChildOptions, isProductOptionSelectValueSelected
+ *
+ * @param option - The product option to validate.
+ * @returns True if the option and all its child options have valid values, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { hasValidProductOptionValues } from "@ikas/bp-storefront";
+ * const isValid = hasValidProductOptionValues(option);
+ * if (!isValid) {
+ *   console.log("Please fill in all required option fields.");
+ * }
+ * ```
+ */
+export declare function hasValidProductOptionValues(option: IkasProductOption): boolean;
+/**
+ * Determines whether a product option has a validation error by checking if its values are invalid.
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related hasValidProductOptionValues, getDisplayedChildOptions
+ *
+ * @param option - The product option to check for errors.
+ * @returns True if the option has invalid values, false if all values are valid.
+ *
+ * @example
+ * ```typescript
+ * import { hasError } from "@ikas/bp-storefront";
+ * if (hasError(option)) {
+ *   console.log("This option has a validation error.");
+ * }
+ * ```
+ */
+export declare function hasError(option: IkasProductOption): boolean;
+/**
+ * Sets the values of a product option and clears child option values when the parent is cleared.
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related clearValues, setTextValue, setCheckboxValue, selectValue
+ *
+ * @param option - The product option to update.
+ * @param values - The new values to assign to the option.
+ *
+ * @example
+ * ```typescript
+ * import { setValues } from "@ikas/bp-storefront";
+ * setValues(option, ["value1", "value2"]);
+ * ```
+ */
+export declare function setValues(option: IkasProductOption, values: string[]): void;
+/**
+ * Retrieves the text value of a TEXT or TEXT_AREA product option, returning an empty string for other types.
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related setTextValue, isTextOption, isTextAreaOption
+ *
+ * @param option - The product option to get the text value from.
+ * @returns The text value string, or an empty string if the option is not a text type.
+ *
+ * @example
+ * ```typescript
+ * import { getTextValue } from "@ikas/bp-storefront";
+ * const text = getTextValue(option);
+ * ```
+ */
+export declare function getTextValue(option: IkasProductOption): string;
+/**
+ * Sets the text value of a product option, or clears it if no value is provided.
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related getTextValue, isTextOption, isTextAreaOption, setValues
+ *
+ * @param option - The product option to update.
+ * @param value - The text value to set, or undefined to clear the value.
+ *
+ * @example
+ * ```typescript
+ * import { setTextValue } from "@ikas/bp-storefront";
+ * setTextValue(option, "Custom engraving text");
+ * ```
+ */
+export declare function setTextValue(option: IkasProductOption, value?: string): void;
+/**
+ * Checks whether a checkbox product option is currently checked (has a "true" value).
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related setCheckboxValue, isCheckboxOption
+ *
+ * @param option - The product option to check.
+ * @returns True if the option is a checkbox type and is checked, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isChecked } from "@ikas/bp-storefront";
+ * if (isChecked(option)) {
+ *   console.log("Gift wrapping is selected.");
+ * }
+ * ```
+ */
+export declare function isChecked(option: IkasProductOption): boolean;
+/**
+ * Sets the checked state of a checkbox product option.
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related isChecked, isCheckboxOption, setValues
+ *
+ * @param option - The checkbox product option to update.
+ * @param checked - Whether the checkbox should be checked or unchecked.
+ *
+ * @example
+ * ```typescript
+ * import { setCheckboxValue } from "@ikas/bp-storefront";
+ * setCheckboxValue(option, true);
+ * ```
+ */
+export declare function setCheckboxValue(option: IkasProductOption, checked: boolean): void;
+/**
+ * Toggles the selection of a choice value on a product option, respecting max selection limits.
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related isProductOptionSelectValueSelected, isChoiceOption, isChoiceOptionSelectType, isChoiceOptionSwatchType, isChoiceOptionBoxType
+ *
+ * @param option - The product option to update.
+ * @param value - The select value to toggle on or off.
+ *
+ * @example
+ * ```typescript
+ * import { selectValue } from "@ikas/bp-storefront";
+ * selectValue(option, selectedValue);
+ * ```
+ */
+export declare function selectValue(option: IkasProductOption, value: IkasProductOptionSelectValue): void;
+/**
+ * Checks whether a product option is of type TEXT (single-line text input).
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related isTextAreaOption, getTextValue, setTextValue
+ *
+ * @param option - The product option to check.
+ * @returns True if the option type is TEXT, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isTextOption } from "@ikas/bp-storefront";
+ * if (isTextOption(option)) {
+ *   console.log("Render a single-line text input.");
+ * }
+ * ```
+ */
+export declare function isTextOption(option: IkasProductOption): boolean;
+/**
+ * Checks whether a product option is of type TEXT_AREA (multi-line text input).
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related isTextOption, getTextValue, setTextValue
+ *
+ * @param option - The product option to check.
+ * @returns True if the option type is TEXT_AREA, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isTextAreaOption } from "@ikas/bp-storefront";
+ * if (isTextAreaOption(option)) {
+ *   console.log("Render a multi-line textarea input.");
+ * }
+ * ```
+ */
+export declare function isTextAreaOption(option: IkasProductOption): boolean;
+/**
+ * Checks whether a product option is of type CHECKBOX.
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related isChecked, setCheckboxValue
+ *
+ * @param option - The product option to check.
+ * @returns True if the option type is CHECKBOX, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isCheckboxOption } from "@ikas/bp-storefront";
+ * if (isCheckboxOption(option)) {
+ *   console.log("Render a checkbox input.");
+ * }
+ * ```
+ */
+export declare function isCheckboxOption(option: IkasProductOption): boolean;
+/**
+ * Checks whether a product option is of type COLOR_PICKER.
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related isChoiceOption, isChoiceOptionSwatchType
+ *
+ * @param option - The product option to check.
+ * @returns True if the option type is COLOR_PICKER, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isColorPickerOption } from "@ikas/bp-storefront";
+ * if (isColorPickerOption(option)) {
+ *   console.log("Render a color picker input.");
+ * }
+ * ```
+ */
+export declare function isColorPickerOption(option: IkasProductOption): boolean;
+/**
+ * Checks whether a product option is of type CHOICE (select, swatch, or box).
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related isChoiceOptionSelectType, isChoiceOptionSwatchType, isChoiceOptionBoxType, selectValue
+ *
+ * @param option - The product option to check.
+ * @returns True if the option type is CHOICE, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isChoiceOption } from "@ikas/bp-storefront";
+ * if (isChoiceOption(option)) {
+ *   console.log("Render a choice-based selection UI.");
+ * }
+ * ```
+ */
+export declare function isChoiceOption(option: IkasProductOption): boolean;
+/**
+ * Checks whether a product option is a CHOICE type with SELECT display style (dropdown).
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related isChoiceOption, isChoiceOptionSwatchType, isChoiceOptionBoxType, selectValue
+ *
+ * @param option - The product option to check.
+ * @returns True if the option is a CHOICE type with SELECT display, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isChoiceOptionSelectType } from "@ikas/bp-storefront";
+ * if (isChoiceOptionSelectType(option)) {
+ *   console.log("Render a dropdown select input.");
+ * }
+ * ```
+ */
+export declare function isChoiceOptionSelectType(option: IkasProductOption): boolean;
+/**
+ * Checks whether a product option is a CHOICE type with SWATCH display style (color/image swatches).
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related isChoiceOption, isChoiceOptionSelectType, isChoiceOptionBoxType, selectValue
+ *
+ * @param option - The product option to check.
+ * @returns True if the option is a CHOICE type with SWATCH display, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isChoiceOptionSwatchType } from "@ikas/bp-storefront";
+ * if (isChoiceOptionSwatchType(option)) {
+ *   console.log("Render color/image swatches.");
+ * }
+ * ```
+ */
+export declare function isChoiceOptionSwatchType(option: IkasProductOption): boolean;
+/**
+ * Checks whether a product option is a CHOICE type with BOX display style (button boxes).
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related isChoiceOption, isChoiceOptionSelectType, isChoiceOptionSwatchType, selectValue
+ *
+ * @param option - The product option to check.
+ * @returns True if the option is a CHOICE type with BOX display, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isChoiceOptionBoxType } from "@ikas/bp-storefront";
+ * if (isChoiceOptionBoxType(option)) {
+ *   console.log("Render clickable box options.");
+ * }
+ * ```
+ */
+export declare function isChoiceOptionBoxType(option: IkasProductOption): boolean;
+/**
+ * Checks whether a product option is of type DATE_PICKER.
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related isTextOption, isCheckboxOption, isChoiceOption, isFileOption
+ *
+ * @param option - The product option to check.
+ * @returns True if the option type is DATE_PICKER, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isDatePickerOption } from "@ikas/bp-storefront";
+ * if (isDatePickerOption(option)) {
+ *   console.log("Render a date picker input.");
+ * }
+ * ```
+ */
+export declare function isDatePickerOption(option: IkasProductOption): boolean;
+/**
+ * Checks whether a product option is of type FILE (file upload).
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related isImageOption, productOptionFileUpload
+ *
+ * @param option - The product option to check.
+ * @returns True if the option type is FILE, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isFileOption } from "@ikas/bp-storefront";
+ * if (isFileOption(option)) {
+ *   console.log("Render a file upload input.");
+ * }
+ * ```
+ */
+export declare function isFileOption(option: IkasProductOption): boolean;
+/**
+ * Checks whether a product option is of type IMAGE.
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related isFileOption, productOptionFileUpload
+ *
+ * @param option - The product option to check.
+ * @returns True if the option type is IMAGE, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isImageOption } from "@ikas/bp-storefront";
+ * if (isImageOption(option)) {
+ *   console.log("Render an image upload input.");
+ * }
+ * ```
+ */
+export declare function isImageOption(option: IkasProductOption): boolean;
+/**
+ * Returns the formatted price string for a product option using its currency settings.
+ *
+ * @ai-category ProductOption, ProductDetail
+ * @ai-related getProductOptionFormattedLabel
+ *
+ * @param option - The product option whose price to format.
+ * @returns A formatted currency string representing the option's price.
+ *
+ * @example
+ * ```typescript
+ * import { getProductOptionFormattedPrice } from "@ikas/bp-storefront";
+ * const priceText = getProductOptionFormattedPrice(option);
+ * // e.g. "$5.00"
+ * ```
+ */
+export declare function getProductOptionFormattedPrice(option: IkasProductOption): string;
+/**
+ * Returns a formatted label for a product option including its name, required indicator, and price if applicable.
+ *
+ * @ai-category ProductOption, ProductDetail
+ * @ai-related getProductOptionFormattedPrice
+ *
+ * @param option - The product option whose label to format.
+ * @returns A formatted string like "Option Name*" or "Option Name ($5.00)".
+ *
+ * @example
+ * ```typescript
+ * import { getProductOptionFormattedLabel } from "@ikas/bp-storefront";
+ * const label = getProductOptionFormattedLabel(option);
+ * // e.g. "Gift Wrapping* ($5.00)"
+ * ```
+ */
+export declare function getProductOptionFormattedLabel(option: IkasProductOption): string;
+/**
+ * Clears all values from a product option, and optionally clears all child option values recursively.
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related setValues, initIkasProductOptionValues, getDisplayedChildOptions
+ *
+ * @param option - The product option to clear.
+ * @param clearChildOptions - Whether to also recursively clear all child option values.
+ *
+ * @example
+ * ```typescript
+ * import { clearValues } from "@ikas/bp-storefront";
+ * clearValues(option, true);
+ * ```
+ */
+export declare function clearValues(option: IkasProductOption, clearChildOptions: boolean): void;
+/**
+ * Checks whether a specific select value is currently selected within a product option.
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related selectValue, isChoiceOption, hasValidProductOptionValues
+ *
+ * @param option - The product option to check.
+ * @param value - The select value to check for selection.
+ * @returns True if the value is currently selected, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isProductOptionSelectValueSelected } from "@ikas/bp-storefront";
+ * const selected = isProductOptionSelectValueSelected(option, value);
+ * ```
+ */
+export declare function isProductOptionSelectValueSelected(option: IkasProductOption, value: IkasProductOptionSelectValue): boolean;
+/**
+ * Initializes (resets) the values of a product option and all its child options recursively to empty arrays.
+ *
+ * @ai-category ProductOption, ProductOptionSet
+ * @ai-related clearValues, setValues, getDisplayedChildOptions
+ *
+ * @param option - The product option to initialize.
+ *
+ * @example
+ * ```typescript
+ * import { initIkasProductOptionValues } from "@ikas/bp-storefront";
+ * initIkasProductOptionValues(option);
+ * ```
+ */
+export declare function initIkasProductOptionValues(option: IkasProductOption): void;
+/**
+ * Uploads files for a FILE-type product option, respecting max quantity settings, and returns the uploaded file URLs.
+ *
+ * @ai-category ProductOption, Customization
+ * @ai-related isFileOption, isImageOption, setValues
+ *
+ * @param option - The file product option to upload files for.
+ * @param files - An array of File objects to upload.
+ * @returns A promise that resolves to an array of uploaded file URL strings.
+ *
+ * @example
+ * ```typescript
+ * import { productOptionFileUpload } from "@ikas/bp-storefront";
+ * const uploadedUrls = await productOptionFileUpload(option, fileList);
+ * ```
+ */
+export declare function productOptionFileUpload(option: IkasProductOption, files: File[]): Promise<string[]>;

package/dist/storefront/src/functions/models/product/option-set/option/init.d.ts

@@ -0,0 +1,17 @@
+import { IkasProduct, IkasProductOption } from "../../../../../../../storefront-models/src";
+/**
+ * Initializes a product option by setting its currency and currency symbol from the first variant's price, and sorting select settings values by order.
+ *
+ * @ai-category Initialization, ProductOptionSet
+ *
+ * @param option - The product option to initialize
+ * @param product - The parent product used to derive currency information from its first variant
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initIkasProductOption } from "@ikas/bp-storefront";
+ * initIkasProductOption(option, product);
+ * ```
+ */
+export declare function initIkasProductOption(option: IkasProductOption, product: IkasProduct): void;

package/dist/storefront/src/functions/models/product/stock-location/index.d.ts

@@ -0,0 +1,17 @@
+import { IkasProductStockLocations } from "../../../../../../storefront-models/src";
+/**
+ * Builds a comma-separated full address string from a stock location's address components including street address, postal code, district, city, state, and country.
+ *
+ * @ai-category StockLocation, Product
+ *
+ * @param stockLocations - The product stock location object containing the address to format.
+ * @returns A comma-separated address string, or an empty string if no address exists.
+ *
+ * @example
+ * ```typescript
+ * import { getStockLocationFullAddressText } from "@ikas/bp-storefront";
+ * const address = getStockLocationFullAddressText(variant.stockLocations[0]);
+ * console.log(address); // "123 Main St, 34000, Kadikoy, Istanbul, Turkey"
+ * ```
+ */
+export declare function getStockLocationFullAddressText(stockLocations: IkasProductStockLocations): string;