@ikas/bp-storefront 0.15.0

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

@@ -0,0 +1,18 @@
+import { IkasCategory } from "../../../../../storefront-models/src";
+/**
+ * Initializes a category by resolving its image, applying locale-specific translations, and initializing its path items.
+ *
+ * @ai-category Category, Initialization
+ * @ai-related initIkasCategoryPathItem
+ *
+ * @param category - The category object to initialize.
+ * @param locale - The locale string used to apply translations, or null if no translations should be applied.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initIkasCategory } from "@ikas/bp-storefront";
+ * initIkasCategory(category, "en");
+ * ```
+ */
+export declare function initIkasCategory(category: IkasCategory, locale: string | null): void;

package/dist/storefront/src/functions/models/category/path-item/index.d.ts

@@ -0,0 +1,35 @@
+import { IkasCategoryPathItem } from "../../../../../../storefront-models/src";
+/**
+ * Resolves the localized slug for a category path item, falling back to the default metadata slug.
+ *
+ * @ai-category Breadcrumb, Navigation
+ * @ai-related getIkasCategoryPathItemHref
+ *
+ * @param categoryPathItem - The category path item to extract the slug from.
+ * @returns The localized slug string, or the default slug, or undefined if no slug is available.
+ *
+ * @example
+ * ```typescript
+ * import { getIkasCategoryPathItemSlug } from "@ikas/bp-storefront";
+ * const slug = getIkasCategoryPathItemSlug(pathItem);
+ * // e.g. "shoes"
+ * ```
+ */
+export declare function getIkasCategoryPathItemSlug(categoryPathItem: IkasCategoryPathItem): string | undefined;
+/**
+ * Returns the fully qualified href for a category path item using its resolved slug.
+ *
+ * @ai-category Breadcrumb, Navigation
+ * @ai-related getIkasCategoryPathItemSlug
+ *
+ * @param categoryPathItem - The category path item to generate the href for.
+ * @returns The route-prefixed href string, or an empty string if no slug is available.
+ *
+ * @example
+ * ```typescript
+ * import { getIkasCategoryPathItemHref } from "@ikas/bp-storefront";
+ * const href = getIkasCategoryPathItemHref(pathItem);
+ * // e.g. "/en/shoes"
+ * ```
+ */
+export declare function getIkasCategoryPathItemHref(categoryPathItem: IkasCategoryPathItem): string;

package/dist/storefront/src/functions/models/category/path-item/init.d.ts

@@ -0,0 +1,18 @@
+import { IkasCategoryPathItem } from "../../../../../../storefront-models/src";
+/**
+ * Initializes a category path item by applying locale-specific translations for its name.
+ *
+ * @ai-category Breadcrumb, Initialization
+ * @ai-related initIkasCategory
+ *
+ * @param categoryPathItem - The category path item to initialize.
+ * @param locale - The locale string used to apply translations, or null if no translations should be applied.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initIkasCategoryPathItem } from "@ikas/bp-storefront";
+ * initIkasCategoryPathItem(pathItem, "en");
+ * ```
+ */
+export declare function initIkasCategoryPathItem(categoryPathItem: IkasCategoryPathItem, locale: string | null): void;

package/dist/storefront/src/functions/models/category-list/index.d.ts

@@ -0,0 +1,149 @@
+import { IkasCategoryList } from "../../../../../storefront-models/src";
+/**
+ * Calculates the total number of pages in a category list based on item count and page limit.
+ *
+ * @ai-category CategoryList, Pagination
+ * @ai-related hasCategoryListPrevPage, hasCategoryListNextPage, getCategoryListPage
+ *
+ * @param list - The category list instance to calculate page count for.
+ * @returns The total number of pages, rounded up to the nearest integer.
+ *
+ * @example
+ * ```typescript
+ * import { getCategoryListPageCount } from "@ikas/bp-storefront";
+ *
+ * const totalPages = getCategoryListPageCount(categoryList);
+ * console.log(`There are ${totalPages} pages of categories.`);
+ * ```
+ */
+export declare function getCategoryListPageCount(list: IkasCategoryList): number;
+/**
+ * Checks whether the category list is configured as a static list with manually selected categories.
+ *
+ * @ai-category CategoryList, Listing
+ * @ai-related getCategoryListInitialData, getCategoryListPageCount
+ *
+ * @param list - The category list instance to check.
+ * @returns True if the list type is "STATIC", false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isCategoryListStatic } from "@ikas/bp-storefront";
+ *
+ * if (isCategoryListStatic(categoryList)) {
+ *   console.log("This list uses statically selected categories.");
+ * }
+ * ```
+ */
+export declare function isCategoryListStatic(list: IkasCategoryList): boolean;
+/**
+ * Determines whether a previous page of categories is available for loading.
+ *
+ * @ai-category CategoryList, Pagination
+ * @ai-related hasCategoryListNextPage, getCategoryListPrevPage, getCategoryListPageCount
+ *
+ * @param list - The category list instance to check.
+ * @returns True if there is a previous page available, false if the list is static or already at the first page.
+ *
+ * @example
+ * ```typescript
+ * import { hasCategoryListPrevPage } from "@ikas/bp-storefront";
+ *
+ * if (hasCategoryListPrevPage(categoryList)) {
+ *   console.log("Previous page of categories is available.");
+ * }
+ * ```
+ */
+export declare function hasCategoryListPrevPage(list: IkasCategoryList): boolean;
+/**
+ * Determines whether a next page of categories is available for loading.
+ *
+ * @ai-category CategoryList, Pagination
+ * @ai-related hasCategoryListPrevPage, getCategoryListNextPage, getCategoryListPageCount
+ *
+ * @param list - The category list instance to check.
+ * @returns True if there are more pages of categories beyond the current page, false if the list is static or at the last page.
+ *
+ * @example
+ * ```typescript
+ * import { hasCategoryListNextPage } from "@ikas/bp-storefront";
+ *
+ * if (hasCategoryListNextPage(categoryList)) {
+ *   console.log("More categories are available on the next page.");
+ * }
+ * ```
+ */
+export declare function hasCategoryListNextPage(list: IkasCategoryList): boolean;
+/**
+ * Fetches and populates the initial data for a category list, handling both static and dynamic list types with sort support.
+ *
+ * @ai-category CategoryList, Listing
+ * @ai-related isCategoryListStatic, getCategoryListPageCount, getCategoryListPage
+ *
+ * @param list - The category list instance to initialize with data from the API.
+ * @returns A promise that resolves when the initial data has been loaded and assigned to the list.
+ *
+ * @example
+ * ```typescript
+ * import { getCategoryListInitialData } from "@ikas/bp-storefront";
+ *
+ * await getCategoryListInitialData(categoryList);
+ * console.log("Category list initialized:", categoryList.data);
+ * ```
+ */
+export declare function getCategoryListInitialData(list: IkasCategoryList): Promise<void>;
+/**
+ * Loads the previous page of categories and prepends the results to the existing list data.
+ *
+ * @ai-category CategoryList, Pagination
+ * @ai-related getCategoryListNextPage, hasCategoryListPrevPage, getCategoryListPage
+ *
+ * @param list - The category list instance to load the previous page for.
+ * @returns A promise that resolves when the previous page data has been prepended, or returns immediately if the list is static, already loading, or has no previous page.
+ *
+ * @example
+ * ```typescript
+ * import { getCategoryListPrevPage } from "@ikas/bp-storefront";
+ *
+ * await getCategoryListPrevPage(categoryList);
+ * console.log("Previous page loaded:", categoryList.data);
+ * ```
+ */
+export declare function getCategoryListPrevPage(list: IkasCategoryList): Promise<void>;
+/**
+ * Loads the next page of categories and appends the results to the existing list data.
+ *
+ * @ai-category CategoryList, Pagination
+ * @ai-related getCategoryListPrevPage, hasCategoryListNextPage, getCategoryListPage
+ *
+ * @param list - The category list instance to load the next page for.
+ * @returns A promise that resolves when the next page data has been appended, or returns immediately if the list is static, already loading, or has no next page.
+ *
+ * @example
+ * ```typescript
+ * import { getCategoryListNextPage } from "@ikas/bp-storefront";
+ *
+ * await getCategoryListNextPage(categoryList);
+ * console.log("Next page loaded:", categoryList.data);
+ * ```
+ */
+export declare function getCategoryListNextPage(list: IkasCategoryList): Promise<void>;
+/**
+ * Navigates to a specific page of categories, replacing the current list data with the requested page.
+ *
+ * @ai-category CategoryList, Pagination
+ * @ai-related getCategoryListPrevPage, getCategoryListNextPage, getCategoryListPageCount
+ *
+ * @param list - The category list instance to navigate.
+ * @param page - The page number to load.
+ * @returns A promise that resolves when the specified page data has been loaded, or returns immediately if the list is static or already loading.
+ *
+ * @example
+ * ```typescript
+ * import { getCategoryListPage } from "@ikas/bp-storefront";
+ *
+ * await getCategoryListPage(categoryList, 3);
+ * console.log("Page 3 loaded:", categoryList.data);
+ * ```
+ */
+export declare function getCategoryListPage(list: IkasCategoryList, page: number): Promise<void>;

package/dist/storefront/src/functions/models/category-list/init.d.ts

@@ -0,0 +1,17 @@
+import { IkasCategoryList } from "../../../../../storefront-models/src";
+/**
+ * Initializes a category list with default values, merging in any provided partial data.
+ *
+ * @ai-category Initialization, CategoryList
+ *
+ * @param data - Partial category list data to override the defaults
+ * @returns A fully initialized IkasCategoryList object
+ *
+ * @example
+ * ```typescript
+ * import { initCategoryList } from "@ikas/bp-storefront";
+ *
+ * const categoryList = initCategoryList({ limit: 20, sort: "A_Z" });
+ * ```
+ */
+export declare function initCategoryList(data: Partial<IkasCategoryList>): IkasCategoryList;

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

@@ -0,0 +1,39 @@
+import { IkasCheckout, IkasPaymentGateway } from "../../../../../storefront-models/src";
+/**
+ * Determines whether a checkout process is complete based on the checkout origin and payment status.
+ *
+ * @ai-category Checkout
+ * @ai-related getCheckoutTotalFinalPrice
+ *
+ * @param checkout - The checkout object to evaluate completion status for.
+ * @returns True if the checkout is complete: for admin-created checkouts, checks if payment status is PAID; otherwise, checks if an order number exists.
+ *
+ * @example
+ * ```typescript
+ * import { isCheckoutComplete } from "@ikas/bp-storefront";
+ *
+ * if (isCheckoutComplete(checkout)) {
+ *   console.log("Checkout is complete.");
+ * }
+ * ```
+ */
+export declare function isCheckoutComplete(checkout: IkasCheckout): boolean;
+/**
+ * Calculates the total final price of a checkout including any additional price adjustments from the selected payment gateway.
+ *
+ * @ai-category Checkout, PaymentGateway
+ * @ai-related isCheckoutComplete, getPaymentGatewayCalculatedAdditionalPrices
+ *
+ * @param checkout - The checkout object containing the base total final price and shipping lines.
+ * @param selectedPaymentGateway - The selected payment gateway whose additional prices (increments/decrements) are applied to the total.
+ * @returns The adjusted total final price after applying payment gateway additional prices, with a minimum of 0.
+ *
+ * @example
+ * ```typescript
+ * import { getCheckoutTotalFinalPrice } from "@ikas/bp-storefront";
+ *
+ * const totalPrice = getCheckoutTotalFinalPrice(checkout, selectedPaymentGateway);
+ * console.log("Total:", totalPrice);
+ * ```
+ */
+export declare function getCheckoutTotalFinalPrice(checkout: IkasCheckout, selectedPaymentGateway: IkasPaymentGateway): number;

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

@@ -0,0 +1,20 @@
+import { IkasCountry } from "../../../../../storefront-models/src";
+/**
+ * Initializes an IkasCountry by applying locale-specific translations to the country name and cleaning up raw translation data.
+ *
+ * @ai-category Initialization, Country
+ * @ai-related setIkasCountryTranslations
+ *
+ * @param country - The country 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 { initIkasCountry } from "@ikas/bp-storefront";
+ * const country = { name: "Turkey", locationTranslations: { en: "Turkey", fr: "Turquie" } };
+ * initIkasCountry(country, "fr");
+ * // country.name is now "Turquie"
+ * ```
+ */
+export declare function initIkasCountry(country: IkasCountry, locale: string | null): void;

package/dist/storefront/src/functions/models/customer/address/index.d.ts

@@ -0,0 +1,106 @@
+import { AddressForm, IkasCheckoutSettings, IkasCustomerAddress } from "../../../../../../storefront-models/src";
+/**
+ * Builds a comma-separated text representation of a customer address from its non-empty fields.
+ *
+ * @ai-category Address
+ * @ai-related getCustomerAddressValidationResult, isValidCustomerAddress, getIkasCustomerAddressForm
+ *
+ * @param address - The customer address object to convert to text.
+ * @returns A comma-separated string composed of address lines, postal code, region, district, city, state, and country.
+ *
+ * @example
+ * ```typescript
+ * import { getCustomerAddressText } from "@ikas/bp-storefront";
+ * const text = getCustomerAddressText(address);
+ * console.log(text); // "123 Main St, Suite 4, 10001, New York, US"
+ * ```
+ */
+export declare function getCustomerAddressText(address: IkasCustomerAddress): string;
+/**
+ * Validates each field of a customer address against checkout settings and returns a per-field result object.
+ *
+ * @ai-category Address
+ * @ai-related isValidCustomerAddress, getCustomerAddressText, getIkasCustomerAddressForm
+ *
+ * @param address - The customer address to validate.
+ * @param checkoutSettings - The checkout settings that determine which fields are mandatory or optional.
+ * @param isDistrictRequired - Whether the district field is required for the selected location.
+ * @returns An object mapping each address field name to a boolean indicating whether it passes validation.
+ *
+ * @example
+ * ```typescript
+ * import { getCustomerAddressValidationResult } from "@ikas/bp-storefront";
+ * const result = getCustomerAddressValidationResult(address, checkoutSettings, true);
+ * if (!result.phone) {
+ *   console.log("Phone number is invalid.");
+ * }
+ * ```
+ */
+export declare function getCustomerAddressValidationResult(address: IkasCustomerAddress, checkoutSettings: IkasCheckoutSettings, isDistrictRequired: boolean): IkasCustomerAddressValidationResult;
+/**
+ * Checks whether all fields of a customer address pass validation based on checkout settings.
+ *
+ * @ai-category Address
+ * @ai-related getCustomerAddressValidationResult, getCustomerAddressText, getIkasCustomerAddressForm
+ *
+ * @param address - The customer address to validate.
+ * @param checkoutSettings - The checkout settings that determine which fields are mandatory or optional.
+ * @param isDistrictRequired - Whether the district field is required for the selected location.
+ * @returns True if every field in the address passes validation, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isValidCustomerAddress } from "@ikas/bp-storefront";
+ * const valid = isValidCustomerAddress(address, checkoutSettings, false);
+ * if (!valid) {
+ *   console.log("Address is incomplete or invalid.");
+ * }
+ * ```
+ */
+export declare function isValidCustomerAddress(address: IkasCustomerAddress, checkoutSettings: IkasCheckoutSettings, isDistrictRequired: boolean): boolean;
+export type IkasCustomerAddressValidationResult = {
+    firstName: boolean;
+    lastName: boolean;
+    addressLine1: boolean;
+    country: boolean;
+    state: boolean;
+    city: boolean;
+    district: boolean;
+    phone: boolean;
+    postalCode: boolean;
+    identityNumber: boolean;
+    title: boolean;
+};
+/**
+ * Retrieves or initializes the address form for a given customer address, caching it in the customer store.
+ *
+ * @ai-category Address, Initialization
+ * @ai-related clearIkasCustomerAddressForm, getCustomerAddressValidationResult
+ *
+ * @param address - The customer address whose form should be retrieved or created.
+ * @returns The cached AddressForm instance associated with the given address.
+ *
+ * @example
+ * ```typescript
+ * import { getIkasCustomerAddressForm } from "@ikas/bp-storefront";
+ * const form = getIkasCustomerAddressForm(address);
+ * console.log(form);
+ * ```
+ */
+export declare function getIkasCustomerAddressForm(address: IkasCustomerAddress): AddressForm;
+/**
+ * Removes the cached address form for a given customer address from the customer store.
+ *
+ * @ai-category Address
+ * @ai-related getIkasCustomerAddressForm
+ *
+ * @param address - The customer address whose cached form should be cleared.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { clearIkasCustomerAddressForm } from "@ikas/bp-storefront";
+ * clearIkasCustomerAddressForm(address);
+ * ```
+ */
+export declare function clearIkasCustomerAddressForm(address: IkasCustomerAddress): void;

package/dist/storefront/src/functions/models/customer/attribute/index.d.ts

@@ -0,0 +1,39 @@
+import { IkasCustomerAttribute } from "../../../../../../storefront-models/src";
+/**
+ * Retrieves the account page permission for a customer attribute based on the current sales channel.
+ *
+ * @ai-category CustomerAttribute
+ * @ai-related getCustomerAttributeRegisterPageRequirement
+ *
+ * @param attribute - The customer attribute to look up the account page permission for.
+ * @returns The permission setting for the current sales channel, or undefined if no matching sales channel is found.
+ *
+ * @example
+ * ```typescript
+ * import { getCustomerAttributeAccountPagePermission } from "@ikas/bp-storefront";
+ * const permission = getCustomerAttributeAccountPagePermission(attribute);
+ * if (permission === "EDITABLE") {
+ *   console.log("Customer can edit this attribute.");
+ * }
+ * ```
+ */
+export declare function getCustomerAttributeAccountPagePermission(attribute: IkasCustomerAttribute): import("../../../../../../storefront-models/src").IkasCustomerAttributePermission | undefined;
+/**
+ * Retrieves the register page requirement for a customer attribute based on the current sales channel.
+ *
+ * @ai-category CustomerAttribute
+ * @ai-related getCustomerAttributeAccountPagePermission
+ *
+ * @param attribute - The customer attribute to look up the register page requirement for.
+ * @returns The register page requirement setting for the current sales channel, or undefined if no matching sales channel is found.
+ *
+ * @example
+ * ```typescript
+ * import { getCustomerAttributeRegisterPageRequirement } from "@ikas/bp-storefront";
+ * const requirement = getCustomerAttributeRegisterPageRequirement(attribute);
+ * if (requirement === "REQUIRED") {
+ *   console.log("This attribute is required during registration.");
+ * }
+ * ```
+ */
+export declare function getCustomerAttributeRegisterPageRequirement(attribute: IkasCustomerAttribute): import("../../../../../../storefront-models/src").IkasCustomerAttributeRegisterPageRequirement | undefined;

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

@@ -0,0 +1,19 @@
+import { IkasCustomerAttribute } from "../../../../../../storefront-models/src";
+/**
+ * Initializes a customer attribute by applying locale-specific translations and removing the raw translations array.
+ *
+ * @ai-category CustomerAttribute, Initialization
+ * @ai-related getCustomerAttributeAccountPagePermission, getCustomerAttributeRegisterPageRequirement
+ *
+ * @param attribute - The customer attribute to initialize with locale translations.
+ * @param locale - The locale string to use for translation lookup, or null to skip translation.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initIkasCustomerAttribute } from "@ikas/bp-storefront";
+ * initIkasCustomerAttribute(attribute, "en");
+ * console.log(attribute.name); // Now contains the localized name
+ * ```
+ */
+export declare function initIkasCustomerAttribute(attribute: IkasCustomerAttribute, locale: string | null): void;

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

@@ -0,0 +1,47 @@
+import { IkasCustomer } from "../../../../../storefront-models/src";
+/**
+ * Checks whether the customer is subscribed or has a pending subscription confirmation.
+ *
+ * @ai-category Customer
+ * @ai-related getCustomerBasicInfo
+ *
+ * @param customer - The customer object to check subscription status for.
+ * @returns True if the customer's subscription status is "SUBSCRIBED" or "PENDING_CONFIRMATION", false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isCustomerSubscribed } from "@ikas/bp-storefront";
+ * const subscribed = isCustomerSubscribed(customer);
+ * if (subscribed) {
+ *   console.log("Customer is subscribed.");
+ * }
+ * ```
+ */
+export declare function isCustomerSubscribed(customer: IkasCustomer): boolean;
+/**
+ * Retrieves the basic profile information of a customer.
+ *
+ * @ai-category Customer
+ * @ai-related isCustomerSubscribed
+ *
+ * @param customer - The customer object to extract basic info from.
+ * @returns An object containing the customer's id, firstName, lastName, email, phone, verification statuses, orderCount, and subscriptionStatus.
+ *
+ * @example
+ * ```typescript
+ * import { getCustomerBasicInfo } from "@ikas/bp-storefront";
+ * const info = getCustomerBasicInfo(customer);
+ * console.log(info.firstName, info.lastName);
+ * ```
+ */
+export declare function getCustomerBasicInfo(customer: IkasCustomer): {
+    id: string;
+    firstName: string;
+    lastName: string | null;
+    email: string | null;
+    phone: string | null;
+    isEmailVerified: boolean | null;
+    isPhoneVerified: boolean | null;
+    orderCount: number | null;
+    subscriptionStatus: import("../../../../../storefront-models/src").IkasCustomerEmailSubscriptionStatus | null;
+};

package/dist/storefront/src/functions/models/customer/review/index.d.ts

@@ -0,0 +1,18 @@
+import { IkasCustomerReview } from "../../../../../../storefront-models/src";
+/**
+ * Formats the creation date of a customer review into a human-readable date string.
+ *
+ * @ai-category CustomerReview
+ * @ai-related initIkasCustomerReview
+ *
+ * @param customerReview - The customer review whose creation date should be formatted.
+ * @returns A formatted date string representing when the review was created.
+ *
+ * @example
+ * ```typescript
+ * import { getIkasCustomerReviewFormattedDate } from "@ikas/bp-storefront";
+ * const dateStr = getIkasCustomerReviewFormattedDate(review);
+ * console.log(dateStr); // e.g. "January 15, 2025"
+ * ```
+ */
+export declare function getIkasCustomerReviewFormattedDate(customerReview: IkasCustomerReview): string;

package/dist/storefront/src/functions/models/customer/review/init.d.ts

@@ -0,0 +1,18 @@
+import { IkasCustomerReview } from "../../../../../../storefront-models/src";
+/**
+ * Initializes a customer review by mapping its image IDs into structured image objects.
+ *
+ * @ai-category CustomerReview, Initialization
+ * @ai-related getIkasCustomerReviewFormattedDate
+ *
+ * @param customerReview - The customer review to initialize with image data.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initIkasCustomerReview } from "@ikas/bp-storefront";
+ * initIkasCustomerReview(review);
+ * console.log(review.images); // [{ id: "img1", isVideo: false }, ...]
+ * ```
+ */
+export declare function initIkasCustomerReview(customerReview: IkasCustomerReview): void;