@ikas/bp-storefront 0.15.0

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

@@ -0,0 +1,141 @@
+import { IkasCustomerReviewList, IkasProduct } from "../../../../../storefront-models/src";
+/**
+ * Calculates the total number of pages for a customer review list based on count and limit.
+ *
+ * @ai-category CustomerReview, Pagination
+ * @ai-related hasCustomerReviewListPrevPage, hasCustomerReviewListNextPage, getCustomerReviewListPage
+ *
+ * @param list - The customer review list to calculate page count for.
+ * @returns The total number of pages.
+ *
+ * @example
+ * ```typescript
+ * import { getCustomerReviewListPageCount } from "@ikas/bp-storefront";
+ * const totalPages = getCustomerReviewListPageCount(reviewList);
+ * ```
+ */
+export declare function getCustomerReviewListPageCount(list: IkasCustomerReviewList): number;
+/**
+ * Checks whether the customer review list has a previous page available for navigation.
+ *
+ * @ai-category CustomerReview, Pagination
+ * @ai-related hasCustomerReviewListNextPage, getCustomerReviewListPrev, getCustomerReviewListPageCount
+ *
+ * @param list - The customer review list to check for a previous page.
+ * @returns True if a previous page exists, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { hasCustomerReviewListPrevPage } from "@ikas/bp-storefront";
+ * if (hasCustomerReviewListPrevPage(reviewList)) {
+ *   // Show previous page button
+ * }
+ * ```
+ */
+export declare function hasCustomerReviewListPrevPage(list: IkasCustomerReviewList): boolean;
+/**
+ * Checks whether the customer review list has a next page available for navigation.
+ *
+ * @ai-category CustomerReview, Pagination
+ * @ai-related hasCustomerReviewListPrevPage, getCustomerReviewListNextPage, getCustomerReviewListPageCount
+ *
+ * @param list - The customer review list to check for a next page.
+ * @returns True if a next page exists, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { hasCustomerReviewListNextPage } from "@ikas/bp-storefront";
+ * if (hasCustomerReviewListNextPage(reviewList)) {
+ *   // Show next page button
+ * }
+ * ```
+ */
+export declare function hasCustomerReviewListNextPage(list: IkasCustomerReviewList): boolean;
+/**
+ * Fetches and populates the initial data for a customer review list, including the first page of reviews.
+ *
+ * @ai-category CustomerReview, ReviewList
+ * @ai-related getCustomerReviewListPage, getCustomerReviewListNextPage, getCustomerReviewListPrev
+ *
+ * @param list - The customer review list to initialize with data.
+ * @returns A promise that resolves when the initial data has been loaded.
+ *
+ * @example
+ * ```typescript
+ * import { getCustomerReviewListInitialData } from "@ikas/bp-storefront";
+ * await getCustomerReviewListInitialData(reviewList);
+ * ```
+ */
+export declare function getCustomerReviewListInitialData(list: IkasCustomerReviewList): Promise<void>;
+/**
+ * Fetches the previous page of customer reviews and prepends them to the existing list data.
+ *
+ * @ai-category CustomerReview, Pagination
+ * @ai-related hasCustomerReviewListPrevPage, getCustomerReviewListNextPage, getCustomerReviewListPage
+ *
+ * @param list - The customer review list to load the previous page for.
+ * @returns A promise that resolves when the previous page has been loaded and prepended.
+ *
+ * @example
+ * ```typescript
+ * import { getCustomerReviewListPrev, hasCustomerReviewListPrevPage } from "@ikas/bp-storefront";
+ * if (hasCustomerReviewListPrevPage(reviewList)) {
+ *   await getCustomerReviewListPrev(reviewList);
+ * }
+ * ```
+ */
+export declare function getCustomerReviewListPrev(list: IkasCustomerReviewList): Promise<void>;
+/**
+ * Fetches the next page of customer reviews and appends them to the existing list data.
+ *
+ * @ai-category CustomerReview, Pagination
+ * @ai-related hasCustomerReviewListNextPage, getCustomerReviewListPrev, getCustomerReviewListPage
+ *
+ * @param list - The customer review list to load the next page for.
+ * @returns A promise that resolves when the next page has been loaded and appended.
+ *
+ * @example
+ * ```typescript
+ * import { getCustomerReviewListNextPage, hasCustomerReviewListNextPage } from "@ikas/bp-storefront";
+ * if (hasCustomerReviewListNextPage(reviewList)) {
+ *   await getCustomerReviewListNextPage(reviewList);
+ * }
+ * ```
+ */
+export declare function getCustomerReviewListNextPage(list: IkasCustomerReviewList): Promise<void>;
+/**
+ * Navigates to a specific page of customer reviews, replacing the current list data with the requested page.
+ *
+ * @ai-category CustomerReview, Pagination
+ * @ai-related getCustomerReviewListNextPage, getCustomerReviewListPrev, getCustomerReviewListPageCount
+ *
+ * @param list - The customer review list to load the page for.
+ * @param page - The page number to navigate to.
+ * @returns A promise that resolves when the specified page has been loaded.
+ *
+ * @example
+ * ```typescript
+ * import { getCustomerReviewListPage } from "@ikas/bp-storefront";
+ * await getCustomerReviewListPage(reviewList, 3);
+ * ```
+ */
+export declare function getCustomerReviewListPage(list: IkasCustomerReviewList, page: number): Promise<void>;
+/**
+ * Retrieves customer reviews for a specific product, including reviews for bundle sub-products if applicable.
+ *
+ * @ai-category CustomerReview, ProductReview
+ * @ai-related getCustomerReviewListInitialData, getCustomerReviewListPage, getCustomerReviewListNextPage
+ *
+ * @param product - The product to fetch customer reviews for.
+ * @param limit - The maximum number of reviews per page (defaults to 5).
+ * @param page - The page number to fetch (defaults to 1).
+ * @param hasImage - Optional filter to only include reviews that have images.
+ * @returns A promise that resolves to an initialized customer review list with the fetched data.
+ *
+ * @example
+ * ```typescript
+ * import { getProductCustomerReviews } from "@ikas/bp-storefront";
+ * const reviewList = await getProductCustomerReviews(product, 10, 1, true);
+ * ```
+ */
+export declare function getProductCustomerReviews(product: IkasProduct, limit?: number, page?: number, hasImage?: boolean): Promise<IkasCustomerReviewList>;

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

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

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

@@ -0,0 +1,106 @@
+import { IkasCustomerReviewSummaryList } from "../../../../../storefront-models/src";
+/**
+ * Checks whether the customer review summary list has a previous page available for navigation.
+ *
+ * @ai-category CustomerReview, Pagination
+ * @ai-related hasCustomerReviewSummaryListNextPage, getCustomerReviewSummaryListPrev, getCustomerReviewSummaryListPage
+ *
+ * @param list - The customer review summary list to check for a previous page.
+ * @returns True if a previous page exists, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { hasCustomerReviewSummaryListPrevPage } from "@ikas/bp-storefront";
+ * if (hasCustomerReviewSummaryListPrevPage(summaryList)) {
+ *   // Show previous page button
+ * }
+ * ```
+ */
+export declare function hasCustomerReviewSummaryListPrevPage(list: IkasCustomerReviewSummaryList): boolean;
+/**
+ * Checks whether the customer review summary list has a next page available for navigation.
+ *
+ * @ai-category CustomerReview, Pagination
+ * @ai-related hasCustomerReviewSummaryListPrevPage, getCustomerReviewSummaryListNextPage, getCustomerReviewSummaryListPage
+ *
+ * @param list - The customer review summary list to check for a next page.
+ * @returns True if a next page exists, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { hasCustomerReviewSummaryListNextPage } from "@ikas/bp-storefront";
+ * if (hasCustomerReviewSummaryListNextPage(summaryList)) {
+ *   // Show next page button
+ * }
+ * ```
+ */
+export declare function hasCustomerReviewSummaryListNextPage(list: IkasCustomerReviewSummaryList): boolean;
+/**
+ * Fetches and populates the initial data for a customer review summary list, including the first page of summaries.
+ *
+ * @ai-category CustomerReview, ReviewList
+ * @ai-related getCustomerReviewSummaryListPage, getCustomerReviewSummaryListNextPage, getCustomerReviewSummaryListPrev
+ *
+ * @param list - The customer review summary list to initialize with data.
+ * @returns A promise that resolves when the initial data has been loaded.
+ *
+ * @example
+ * ```typescript
+ * import { getCustomerReviewSummaryListInitialData } from "@ikas/bp-storefront";
+ * await getCustomerReviewSummaryListInitialData(summaryList);
+ * ```
+ */
+export declare function getCustomerReviewSummaryListInitialData(list: IkasCustomerReviewSummaryList): Promise<void>;
+/**
+ * Fetches the previous page of customer review summaries and prepends them to the existing list data.
+ *
+ * @ai-category CustomerReview, Pagination
+ * @ai-related hasCustomerReviewSummaryListPrevPage, getCustomerReviewSummaryListNextPage, getCustomerReviewSummaryListPage
+ *
+ * @param list - The customer review summary list to load the previous page for.
+ * @returns A promise that resolves when the previous page has been loaded and prepended.
+ *
+ * @example
+ * ```typescript
+ * import { getCustomerReviewSummaryListPrev, hasCustomerReviewSummaryListPrevPage } from "@ikas/bp-storefront";
+ * if (hasCustomerReviewSummaryListPrevPage(summaryList)) {
+ *   await getCustomerReviewSummaryListPrev(summaryList);
+ * }
+ * ```
+ */
+export declare function getCustomerReviewSummaryListPrev(list: IkasCustomerReviewSummaryList): Promise<void>;
+/**
+ * Fetches the next page of customer review summaries and appends them to the existing list data.
+ *
+ * @ai-category CustomerReview, Pagination
+ * @ai-related hasCustomerReviewSummaryListNextPage, getCustomerReviewSummaryListPrev, getCustomerReviewSummaryListPage
+ *
+ * @param list - The customer review summary list to load the next page for.
+ * @returns A promise that resolves when the next page has been loaded and appended.
+ *
+ * @example
+ * ```typescript
+ * import { getCustomerReviewSummaryListNextPage, hasCustomerReviewSummaryListNextPage } from "@ikas/bp-storefront";
+ * if (hasCustomerReviewSummaryListNextPage(summaryList)) {
+ *   await getCustomerReviewSummaryListNextPage(summaryList);
+ * }
+ * ```
+ */
+export declare function getCustomerReviewSummaryListNextPage(list: IkasCustomerReviewSummaryList): Promise<void>;
+/**
+ * Navigates to a specific page of customer review summaries, replacing the current list data with the requested page.
+ *
+ * @ai-category CustomerReview, Pagination
+ * @ai-related getCustomerReviewSummaryListNextPage, getCustomerReviewSummaryListPrev, getCustomerReviewSummaryListInitialData
+ *
+ * @param list - The customer review summary list to load the page for.
+ * @param page - The page number to navigate to.
+ * @returns A promise that resolves when the specified page has been loaded.
+ *
+ * @example
+ * ```typescript
+ * import { getCustomerReviewSummaryListPage } from "@ikas/bp-storefront";
+ * await getCustomerReviewSummaryListPage(summaryList, 3);
+ * ```
+ */
+export declare function getCustomerReviewSummaryListPage(list: IkasCustomerReviewSummaryList, page: number): Promise<void>;

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

@@ -0,0 +1,17 @@
+import { IkasCustomerReviewSummaryList } from "../../../../../storefront-models/src";
+/**
+ * Initializes a customer review summary list with default values, merging in any provided partial data.
+ *
+ * @ai-category Initialization, CustomerReviewSummaryList
+ *
+ * @param data - Partial customer review summary list data to override the defaults
+ * @returns A fully initialized IkasCustomerReviewSummaryList object
+ *
+ * @example
+ * ```typescript
+ * import { initCustomerReviewSummaryList } from "@ikas/bp-storefront";
+ *
+ * const summaryList = initCustomerReviewSummaryList({ productId: "prod-456", limit: 10 });
+ * ```
+ */
+export declare function initCustomerReviewSummaryList(data: Partial<IkasCustomerReviewSummaryList>): IkasCustomerReviewSummaryList;

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

@@ -0,0 +1,35 @@
+import { IkasFilterCategory } from "../../../../../storefront-models/src";
+/**
+ * Returns the fully qualified href for a filter category based on its metadata slug.
+ *
+ * @ai-category FilterCategory, Navigation
+ * @ai-related getIkasFilterCategorySlug
+ *
+ * @param filterCategory - The filter category object to generate the href for.
+ * @returns The route-prefixed href string, or an empty string if no metadata is available.
+ *
+ * @example
+ * ```typescript
+ * import { getIkasFilterCategoryHref } from "@ikas/bp-storefront";
+ * const href = getIkasFilterCategoryHref(filterCategory);
+ * // e.g. "/en/sale"
+ * ```
+ */
+export declare function getIkasFilterCategoryHref(filterCategory: IkasFilterCategory): string;
+/**
+ * Returns the slug for a filter category from its metadata.
+ *
+ * @ai-category FilterCategory, Navigation
+ * @ai-related getIkasFilterCategoryHref
+ *
+ * @param filterCategory - The filter category object to extract the slug from.
+ * @returns The slug string, or an empty string if no metadata slug is available.
+ *
+ * @example
+ * ```typescript
+ * import { getIkasFilterCategorySlug } from "@ikas/bp-storefront";
+ * const slug = getIkasFilterCategorySlug(filterCategory);
+ * // e.g. "sale"
+ * ```
+ */
+export declare function getIkasFilterCategorySlug(filterCategory: IkasFilterCategory): string;

package/dist/storefront/src/functions/models/html-meta-data/init.d.ts

@@ -0,0 +1,38 @@
+import { IkasHTMLMetaData } from "../../../../../storefront-models/src";
+/**
+ * Initializes an IkasHTMLMetaData object by applying locale-specific translations if a locale is provided.
+ *
+ * @ai-category HtmlMetaData
+ * @ai-related setHTMLMetaDataTranslations
+ *
+ * @param metaData - The HTML meta data object to initialize.
+ * @param locale - The locale string to apply translations for, or null to skip translation.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initIkasHTMLMetaData } from "@ikas/bp-storefront";
+ *
+ * initIkasHTMLMetaData(metaData, "en");
+ * ```
+ */
+export declare function initIkasHTMLMetaData(metaData: IkasHTMLMetaData, locale: string | null): void;
+/**
+ * Sets locale-specific translations on an HTML meta data object, overriding pageTitle, description, and slug when available.
+ *
+ * @ai-category HtmlMetaData
+ * @ai-related initIkasHTMLMetaData
+ *
+ * @param metaData - The HTML meta data object whose fields will be overridden with translated values.
+ * @param locale - The locale string to find matching translations for.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setHTMLMetaDataTranslations } from "@ikas/bp-storefront";
+ *
+ * setHTMLMetaDataTranslations(metaData, "tr");
+ * console.log(metaData.pageTitle); // translated title
+ * ```
+ */
+export declare function setHTMLMetaDataTranslations(metaData: IkasHTMLMetaData, locale: string): void;