@ikas/bp-storefront 0.15.0

package/dist/storefront/src/functions/models/ikas-theme/date-picker.d.ts

@@ -0,0 +1,379 @@
+import { IkasThemeDatePicker } from "../../../../../storefront-models/src";
+/**
+ * Initializes a theme date picker with a value, min/max bounds, and optional time display.
+ *
+ * @ai-category DatePicker, UI
+ * @ai-related themeDatePickerOnChange, themeDatePickerOnDayChange, themeDatePickerGetDate
+ *
+ * @param dataPicker - The date picker instance to initialize.
+ * @param options - Configuration options for initialization.
+ * @param options.value - The initial date value. Defaults to the current date.
+ * @param options.minValue - The minimum selectable date. Defaults to 1900-01-01.
+ * @param options.maxValue - The maximum selectable date. Defaults to 9999-12-31.
+ * @param options.showTime - Whether to display time selection controls.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initThemeDatePicker } from "@ikas/bp-storefront";
+ * initThemeDatePicker(datePicker, {
+ *   value: new Date(),
+ *   minValue: new Date(2020, 0, 1),
+ *   maxValue: new Date(2030, 11, 31),
+ *   showTime: true,
+ * });
+ * ```
+ */
+export declare function initThemeDatePicker(dataPicker: IkasThemeDatePicker, options: {
+    value?: Date;
+    minValue?: Date;
+    maxValue?: Date;
+    showTime?: boolean;
+}): void;
+/**
+ * Handles a date change on the date picker, clamping the value within the configured min/max bounds.
+ *
+ * @ai-category DatePicker, Calendar
+ * @ai-related initThemeDatePicker, themeDatePickerOnDayChange, themeDatePickerOnHoursChange, themeDatePickerOnMinutesChange
+ *
+ * @param dataPicker - The date picker instance to update.
+ * @param value - The new date value to set.
+ * @returns The clamped date value that was actually applied.
+ *
+ * @example
+ * ```typescript
+ * import { themeDatePickerOnChange } from "@ikas/bp-storefront";
+ * const appliedDate = themeDatePickerOnChange(datePicker, new Date(2024, 5, 15));
+ * ```
+ */
+export declare function themeDatePickerOnChange(dataPicker: IkasThemeDatePicker, value: Date): Date;
+/**
+ * Updates the view year of the date picker, validating the year is between 1900 and 9999.
+ *
+ * @ai-category DatePicker, Calendar
+ * @ai-related themeDatePickerOnViewMonthChange, themeDatePickerGetViewFullYear, themeDatePickerSetViewPrevMonth, themeDatePickerSetViewNextMonth
+ *
+ * @param dataPicker - The date picker instance to update.
+ * @param value - The new year as a string. Must parse to a number between 1900 and 9999.
+ * @returns The updated view date with the new year applied.
+ *
+ * @example
+ * ```typescript
+ * import { themeDatePickerOnViewFullYearChange } from "@ikas/bp-storefront";
+ * const updatedView = themeDatePickerOnViewFullYearChange(datePicker, "2025");
+ * ```
+ */
+export declare function themeDatePickerOnViewFullYearChange(dataPicker: IkasThemeDatePicker, value?: string): Date;
+/**
+ * Updates the view month of the date picker, validating the month index is between 0 and 11.
+ *
+ * @ai-category DatePicker, Calendar
+ * @ai-related themeDatePickerOnViewFullYearChange, themeDatePickerGetViewMonth, themeDatePickerSetViewPrevMonth, themeDatePickerSetViewNextMonth
+ *
+ * @param dataPicker - The date picker instance to update.
+ * @param value - The new month index as a string (0 = January, 11 = December).
+ * @returns The updated view date with the new month applied.
+ *
+ * @example
+ * ```typescript
+ * import { themeDatePickerOnViewMonthChange } from "@ikas/bp-storefront";
+ * const updatedView = themeDatePickerOnViewMonthChange(datePicker, "3"); // April
+ * ```
+ */
+export declare function themeDatePickerOnViewMonthChange(dataPicker: IkasThemeDatePicker, value?: string): Date;
+/**
+ * Handles a day selection change on the date picker, preserving the current time and enforcing min/max bounds when time mode is enabled.
+ *
+ * @ai-category DatePicker, Calendar
+ * @ai-related themeDatePickerOnChange, themeDatePickerOnHoursChange, themeDatePickerOnMinutesChange, themeDatePickerGetDaysOfMonth
+ *
+ * @param dataPicker - The date picker instance to update.
+ * @param date - The day of the month (1-31).
+ * @param month - The month index (0-11).
+ * @param fullYear - The full year (e.g., 2024).
+ * @returns The updated date value after applying the day change.
+ *
+ * @example
+ * ```typescript
+ * import { themeDatePickerOnDayChange } from "@ikas/bp-storefront";
+ * const newDate = themeDatePickerOnDayChange(datePicker, 15, 5, 2024); // June 15, 2024
+ * ```
+ */
+export declare function themeDatePickerOnDayChange(dataPicker: IkasThemeDatePicker, date: number, month: number, fullYear: number): Date;
+/**
+ * Updates the hours component of the date picker value, validating against the 0-23 range and min/max bounds.
+ *
+ * @ai-category DatePicker, Calendar
+ * @ai-related themeDatePickerOnMinutesChange, themeDatePickerOnChange, themeDatePickerGetHours
+ *
+ * @param dataPicker - The date picker instance to update.
+ * @param value - The new hours value as a string (0-23).
+ * @returns The updated date value with the new hours applied.
+ *
+ * @example
+ * ```typescript
+ * import { themeDatePickerOnHoursChange } from "@ikas/bp-storefront";
+ * const updatedDate = themeDatePickerOnHoursChange(datePicker, "14"); // 2 PM
+ * ```
+ */
+export declare function themeDatePickerOnHoursChange(dataPicker: IkasThemeDatePicker, value?: string): Date;
+/**
+ * Updates the minutes component of the date picker value, validating against the 0-59 range and min/max bounds.
+ *
+ * @ai-category DatePicker, Calendar
+ * @ai-related themeDatePickerOnHoursChange, themeDatePickerOnChange, themeDatePickerGetMinutes
+ *
+ * @param dataPicker - The date picker instance to update.
+ * @param value - The new minutes value as a string (0-59).
+ * @returns The updated date value with the new minutes applied.
+ *
+ * @example
+ * ```typescript
+ * import { themeDatePickerOnMinutesChange } from "@ikas/bp-storefront";
+ * const updatedDate = themeDatePickerOnMinutesChange(datePicker, "30");
+ * ```
+ */
+export declare function themeDatePickerOnMinutesChange(dataPicker: IkasThemeDatePicker, value?: string): Date;
+/**
+ * Navigates the date picker view to the previous month.
+ *
+ * @ai-category DatePicker, Calendar, UI
+ * @ai-related themeDatePickerSetViewNextMonth, themeDatePickerOnViewMonthChange, themeDatePickerOnViewFullYearChange
+ *
+ * @param dataPicker - The date picker instance to update.
+ * @returns The updated view date set to the previous month.
+ *
+ * @example
+ * ```typescript
+ * import { themeDatePickerSetViewPrevMonth } from "@ikas/bp-storefront";
+ * const prevMonthView = themeDatePickerSetViewPrevMonth(datePicker);
+ * ```
+ */
+export declare function themeDatePickerSetViewPrevMonth(dataPicker: IkasThemeDatePicker): Date;
+/**
+ * Navigates the date picker view to the next month.
+ *
+ * @ai-category DatePicker, Calendar, UI
+ * @ai-related themeDatePickerSetViewPrevMonth, themeDatePickerOnViewMonthChange, themeDatePickerOnViewFullYearChange
+ *
+ * @param dataPicker - The date picker instance to update.
+ * @returns The updated view date set to the next month.
+ *
+ * @example
+ * ```typescript
+ * import { themeDatePickerSetViewNextMonth } from "@ikas/bp-storefront";
+ * const nextMonthView = themeDatePickerSetViewNextMonth(datePicker);
+ * ```
+ */
+export declare function themeDatePickerSetViewNextMonth(dataPicker: IkasThemeDatePicker): Date;
+/**
+ * Returns the day of the month from the date picker's current value.
+ *
+ * @ai-category DatePicker, Calendar
+ * @ai-related themeDatePickerGetMonth, themeDatePickerGetFullYear, themeDatePickerOnDayChange
+ *
+ * @param dataPicker - The date picker instance to read from.
+ * @returns The day of the month (1-31), or 0 if no value is set.
+ *
+ * @example
+ * ```typescript
+ * import { themeDatePickerGetDate } from "@ikas/bp-storefront";
+ * const dayOfMonth = themeDatePickerGetDate(datePicker); // e.g., 15
+ * ```
+ */
+export declare function themeDatePickerGetDate(dataPicker: IkasThemeDatePicker): number;
+/**
+ * Returns the month index from the date picker's current value.
+ *
+ * @ai-category DatePicker, Calendar
+ * @ai-related themeDatePickerGetDate, themeDatePickerGetFullYear, themeDatePickerGetMonthName, themeDatePickerGetViewMonth
+ *
+ * @param dataPicker - The date picker instance to read from.
+ * @returns The month index (0 = January, 11 = December), or 0 if no value is set.
+ *
+ * @example
+ * ```typescript
+ * import { themeDatePickerGetMonth } from "@ikas/bp-storefront";
+ * const monthIndex = themeDatePickerGetMonth(datePicker); // e.g., 5 for June
+ * ```
+ */
+export declare function themeDatePickerGetMonth(dataPicker: IkasThemeDatePicker): number;
+/**
+ * Returns the month index from the date picker's current view (navigation) value.
+ *
+ * @ai-category DatePicker, Calendar
+ * @ai-related themeDatePickerGetMonth, themeDatePickerGetViewFullYear, themeDatePickerOnViewMonthChange
+ *
+ * @param dataPicker - The date picker instance to read from.
+ * @returns The view month index (0 = January, 11 = December), or 0 if no view value is set.
+ *
+ * @example
+ * ```typescript
+ * import { themeDatePickerGetViewMonth } from "@ikas/bp-storefront";
+ * const viewMonthIndex = themeDatePickerGetViewMonth(datePicker);
+ * ```
+ */
+export declare function themeDatePickerGetViewMonth(dataPicker: IkasThemeDatePicker): number;
+/**
+ * Returns the localized full month name for the date picker's current value.
+ *
+ * @ai-category DatePicker, Calendar, UI
+ * @ai-related themeDatePickerGetMonth, themeDatePickerGetMonthList, themeDatePickerGetViewMonth
+ *
+ * @param dataPicker - The date picker instance to read from.
+ * @returns The localized month name (e.g., "January", "Ocak") based on the storefront locale.
+ *
+ * @example
+ * ```typescript
+ * import { themeDatePickerGetMonthName } from "@ikas/bp-storefront";
+ * const monthName = themeDatePickerGetMonthName(datePicker); // e.g., "June"
+ * ```
+ */
+export declare function themeDatePickerGetMonthName(dataPicker: IkasThemeDatePicker): string;
+/**
+ * Returns a list of all 12 months with localized labels, values, and selection state for populating a month selector dropdown.
+ *
+ * @ai-category DatePicker, Calendar, UI
+ * @ai-related themeDatePickerGetMonthName, themeDatePickerOnViewMonthChange, themeDatePickerGetViewMonth
+ *
+ * @param dataPicker - The date picker instance to read from.
+ * @returns An array of 12 month items, each with a localized label, string value (index), selected flag, and disabled flag.
+ *
+ * @example
+ * ```typescript
+ * import { themeDatePickerGetMonthList } from "@ikas/bp-storefront";
+ * const months = themeDatePickerGetMonthList(datePicker);
+ * // [{ label: "January", value: "0", selected: false, disabled: false }, ...]
+ * ```
+ */
+export declare function themeDatePickerGetMonthList(dataPicker: IkasThemeDatePicker): IkasThemeDatePickerMonthListItem[];
+/**
+ * Returns the localized short names of the days of the week, ordered by the locale's first day of the week.
+ *
+ * @ai-category DatePicker, Calendar, UI
+ * @ai-related themeDatePickerGetDaysOfMonth, themeDatePickerGetWeekFirstDay
+ *
+ * @returns An array of 7 short weekday names (e.g., ["Mon", "Tue", ...]) ordered starting from the locale's first day.
+ *
+ * @example
+ * ```typescript
+ * import { themeDatePickerGetDaysOfWeekShort } from "@ikas/bp-storefront";
+ * const weekdays = themeDatePickerGetDaysOfWeekShort(); // ["Mon", "Tue", "Wed", ...]
+ * ```
+ */
+export declare function themeDatePickerGetDaysOfWeekShort(): string[];
+/**
+ * Returns the full year from the date picker's current value.
+ *
+ * @ai-category DatePicker, Calendar
+ * @ai-related themeDatePickerGetDate, themeDatePickerGetMonth, themeDatePickerGetViewFullYear
+ *
+ * @param dataPicker - The date picker instance to read from.
+ * @returns The full year (e.g., 2024), or 0 if no value is set.
+ *
+ * @example
+ * ```typescript
+ * import { themeDatePickerGetFullYear } from "@ikas/bp-storefront";
+ * const year = themeDatePickerGetFullYear(datePicker); // e.g., 2024
+ * ```
+ */
+export declare function themeDatePickerGetFullYear(dataPicker: IkasThemeDatePicker): number;
+/**
+ * Returns the full year from the date picker's current view (navigation) value.
+ *
+ * @ai-category DatePicker, Calendar
+ * @ai-related themeDatePickerGetFullYear, themeDatePickerGetViewMonth, themeDatePickerOnViewFullYearChange
+ *
+ * @param dataPicker - The date picker instance to read from.
+ * @returns The view full year (e.g., 2024), or 0 if no view value is set.
+ *
+ * @example
+ * ```typescript
+ * import { themeDatePickerGetViewFullYear } from "@ikas/bp-storefront";
+ * const viewYear = themeDatePickerGetViewFullYear(datePicker);
+ * ```
+ */
+export declare function themeDatePickerGetViewFullYear(dataPicker: IkasThemeDatePicker): number;
+/**
+ * Returns the hours component from the date picker's current value.
+ *
+ * @ai-category DatePicker, Calendar
+ * @ai-related themeDatePickerGetMinutes, themeDatePickerOnHoursChange
+ *
+ * @param dataPicker - The date picker instance to read from.
+ * @returns The hours (0-23), or 0 if no value is set.
+ *
+ * @example
+ * ```typescript
+ * import { themeDatePickerGetHours } from "@ikas/bp-storefront";
+ * const hours = themeDatePickerGetHours(datePicker); // e.g., 14
+ * ```
+ */
+export declare function themeDatePickerGetHours(dataPicker: IkasThemeDatePicker): number;
+/**
+ * Returns the minutes component from the date picker's current value.
+ *
+ * @ai-category DatePicker, Calendar
+ * @ai-related themeDatePickerGetHours, themeDatePickerOnMinutesChange
+ *
+ * @param dataPicker - The date picker instance to read from.
+ * @returns The minutes (0-59), or 0 if no value is set.
+ *
+ * @example
+ * ```typescript
+ * import { themeDatePickerGetMinutes } from "@ikas/bp-storefront";
+ * const minutes = themeDatePickerGetMinutes(datePicker); // e.g., 30
+ * ```
+ */
+export declare function themeDatePickerGetMinutes(dataPicker: IkasThemeDatePicker): number;
+/**
+ * Generates a 42-cell calendar grid (6 weeks) for the current view month, including overflow days from adjacent months, with selection and disabled states.
+ *
+ * @ai-category DatePicker, Calendar, UI
+ * @ai-related themeDatePickerOnDayChange, themeDatePickerGetDaysOfWeekShort, themeDatePickerGetWeekFirstDay, themeDatePickerGetViewMonth, themeDatePickerGetViewFullYear
+ *
+ * @param dataPicker - The date picker instance to read from.
+ * @returns An array of 42 day objects, each containing date, month, fullYear, selected state, inCurrentMonth flag, and disabled state. Returns an empty array if no view value is set.
+ *
+ * @example
+ * ```typescript
+ * import { themeDatePickerGetDaysOfMonth } from "@ikas/bp-storefront";
+ * const days = themeDatePickerGetDaysOfMonth(datePicker);
+ * days.forEach((day) => {
+ *   if (day.inCurrentMonth && !day.disabled) {
+ *     console.log(`Day ${day.date} - selected: ${day.selected}`);
+ *   }
+ * });
+ * ```
+ */
+export declare function themeDatePickerGetDaysOfMonth(dataPicker: IkasThemeDatePicker): IkasThemeDatePickerDayOfMonth[];
+/**
+ * Determines the first day of the week based on the current storefront locale using Intl.Locale weekInfo.
+ *
+ * @ai-category DatePicker, Calendar
+ * @ai-related themeDatePickerGetDaysOfWeekShort, themeDatePickerGetDaysOfMonth
+ *
+ * @returns The first day of the week as a number (e.g., 1 for Monday, 7 for Sunday). Defaults to 1 (Monday) if locale data is unavailable.
+ *
+ * @example
+ * ```typescript
+ * import { themeDatePickerGetWeekFirstDay } from "@ikas/bp-storefront";
+ * const firstDay = themeDatePickerGetWeekFirstDay(); // 1 for Monday-first locales
+ * ```
+ */
+export declare function themeDatePickerGetWeekFirstDay(): number;
+type IkasThemeDatePickerMonthListItem = {
+    label: string;
+    value: string;
+    selected: boolean;
+    disabled: boolean;
+};
+type IkasThemeDatePickerDayOfMonth = {
+    date: number;
+    month: number;
+    fullYear: number;
+    selected: boolean;
+    inCurrentMonth: boolean;
+    disabled: boolean;
+};
+export {};

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

@@ -0,0 +1,56 @@
+import { IkasImage } from "../../../../../storefront-models/src";
+/**
+ * Returns the default source URL for an image at 1080px resolution.
+ *
+ * @ai-category Image
+ * @ai-related getThumbnailSrc, getSrc
+ *
+ * @param image - The image object to generate the default source URL for.
+ * @returns The CDN URL string for the image at 1080px size.
+ *
+ * @example
+ * ```typescript
+ * import { getDefaultSrc } from "@ikas/bp-storefront";
+ *
+ * const src = getDefaultSrc(image);
+ * console.log(src); // "https://cdn.example.com/images/.../1080/image.webp"
+ * ```
+ */
+export declare function getDefaultSrc(image: IkasImage): string;
+/**
+ * Returns the thumbnail source URL for an image at 180px resolution.
+ *
+ * @ai-category Image
+ * @ai-related getDefaultSrc, getSrc
+ *
+ * @param image - The image object to generate the thumbnail source URL for.
+ * @returns The CDN URL string for the image at 180px size.
+ *
+ * @example
+ * ```typescript
+ * import { getThumbnailSrc } from "@ikas/bp-storefront";
+ *
+ * const thumbnailSrc = getThumbnailSrc(image);
+ * console.log(thumbnailSrc); // "https://cdn.example.com/images/.../180/image.webp"
+ * ```
+ */
+export declare function getThumbnailSrc(image: IkasImage): string;
+/**
+ * Generates the full CDN source URL for an image or video at the specified size, handling both legacy path-based and merchant-scoped ID formats.
+ *
+ * @ai-category Image
+ * @ai-related getDefaultSrc, getThumbnailSrc
+ *
+ * @param image - The image object containing the id, fileName, and isVideo flag.
+ * @param size - The desired image width in pixels for the generated URL.
+ * @returns The full CDN URL string for the image or video.
+ *
+ * @example
+ * ```typescript
+ * import { getSrc } from "@ikas/bp-storefront";
+ *
+ * const src = getSrc(image, 640);
+ * console.log(src); // "https://cdn.example.com/images/.../640/image.webp"
+ * ```
+ */
+export declare function getSrc(image: IkasImage, size: number): string;

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

@@ -0,0 +1,84 @@
+export * from "./attribute-detail";
+export * from "./attribute-list";
+export * from "./base";
+export * from "./blog";
+export * from "./blog/category";
+export * from "./blog/category/init";
+export * from "./blog/init";
+export * from "./blog-category-list";
+export * from "./blog-category-list/init";
+export * from "./blog-list";
+export * from "./blog-list/init";
+export * from "./brand";
+export * from "./brand/init";
+export * from "./brand-list";
+export * from "./brand-list/init";
+export * from "./campaign-offer";
+export * from "./category";
+export * from "./category/init";
+export * from "./category-list";
+export * from "./category-list/init";
+export * from "./category/path-item";
+export * from "./category/path-item/init";
+export * from "./checkout";
+export * from "./country/init";
+export * from "./customer";
+export * from "./customer/address";
+export * from "./customer/attribute";
+export * from "./customer/attribute/init";
+export * from "./customer/review";
+export * from "./customer/review/init";
+export * from "./customer-review-list";
+export * from "./customer-review-list/init";
+export * from "./customer-review-summary-list";
+export * from "./customer-review-summary-list/init";
+export * from "./filter-category";
+export * from "./html-meta-data/init";
+export * from "./ikas-theme/date-picker";
+export * from "./image";
+export * from "./merchant-settings/init";
+export * from "./order";
+export * from "./order/address";
+export * from "./order/adjustment";
+export * from "./order/gift-package";
+export * from "./order/line-item";
+export * from "./order/line-item/variant";
+export * from "./order/line-item/variant/bundle-product/bundle-variant";
+export * from "./order/line-item/variant/value";
+export * from "./order/transaction";
+export * from "./payment-gateway";
+export * from "./payment-gateway/init";
+export * from "./product";
+export * from "./product/init";
+export * from "./product-list";
+export * from "./product/attribute-value";
+export * from "./product/attribute-value/init";
+export * from "./product/filter";
+export * from "./product/option-set";
+export * from "./product/option-set/init";
+export * from "./product/option-set/option";
+export * from "./product/option-set/option/init";
+export * from "./product/variant";
+export * from "./product/variant/init";
+export * from "./product/variant/price";
+export * from "./raffle";
+export * from "./raffle/init";
+export * from "./state/init";
+export * from "./variant-type";
+export * from "./variant-type/init";
+export * from "./variant-type/variant-value";
+export * from "./validator";
+export * from "./validator/account-info";
+export * from "./validator/address";
+export * from "./validator/back-in-stock-notification";
+export * from "./validator/contact-form";
+export * from "./validator/coupon-code-form";
+export * from "./validator/customer-review";
+export * from "./validator/forgot-password";
+export * from "./validator/login";
+export * from "./validator/newsletter-subscription";
+export * from "./validator/order-tracking";
+export * from "./validator/recover-password";
+export * from "./validator/register";
+export * from "./validator/sms-login";
+export * from "./validator/verify-phone-number";

package/dist/storefront/src/functions/models/merchant-settings/init.d.ts

@@ -0,0 +1,18 @@
+import { IkasMerchantSettings } from "../../../../../storefront-models/src";
+/**
+ * Initializes IkasMerchantSettings by constructing the logo media object from the stored logo ID.
+ *
+ * @ai-category Initialization, MerchantSettings
+ *
+ * @param settings - The merchant settings object to initialize.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initIkasMerchantSettings } from "@ikas/bp-storefront";
+ * const settings = { logoId: "logo-123" };
+ * initIkasMerchantSettings(settings);
+ * // settings.logo is now { id: "logo-123", isVideo: false }
+ * ```
+ */
+export declare function initIkasMerchantSettings(settings: IkasMerchantSettings): void;

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

@@ -0,0 +1,93 @@
+import { IkasCheckoutSettings, IkasOrderAddress } from "../../../../../../storefront-models/src";
+/**
+ * Creates a new empty order address object with default values.
+ *
+ * @ai-category OrderAddress, Order
+ * @ai-related getOrderAddressText, getOrderAddressValidationResult, isValidOrderAddress
+ *
+ * @returns A new IkasOrderAddress with all fields initialized to empty strings, null, or false.
+ *
+ * @example
+ * ```typescript
+ * import { createOrderAddress } from "@ikas/bp-storefront";
+ *
+ * const address = createOrderAddress();
+ * address.firstName = "John";
+ * address.lastName = "Doe";
+ * address.addressLine1 = "123 Main St";
+ * ```
+ */
+export declare function createOrderAddress(): IkasOrderAddress;
+/**
+ * Builds a comma-separated text representation of an order address.
+ *
+ * @ai-category OrderAddress, Order
+ * @ai-related createOrderAddress, getOrderAddressValidationResult, isValidOrderAddress
+ *
+ * @param address - The order address to convert to a display string.
+ * @returns A comma-separated string containing the non-empty address fields (address lines, postal code, region, district, city, state, and country).
+ *
+ * @example
+ * ```typescript
+ * import { getOrderAddressText } from "@ikas/bp-storefront";
+ *
+ * const text = getOrderAddressText(order.shippingAddress);
+ * // "123 Main St, 34000, Istanbul, Turkey"
+ * ```
+ */
+export declare function getOrderAddressText(address: IkasOrderAddress): string;
+/**
+ * Validates each field of an order address against checkout settings and returns per-field results.
+ *
+ * @ai-category OrderAddress, Order
+ * @ai-related isValidOrderAddress, createOrderAddress, getOrderAddressText
+ *
+ * @param address - The order address to validate.
+ * @param checkoutSettings - The checkout settings that determine which fields are mandatory, optional, or hidden.
+ * @param isDistrictRequired - Whether the district field is required for the selected country/state.
+ * @returns An object mapping each address field name to a boolean indicating whether it passes validation.
+ *
+ * @example
+ * ```typescript
+ * import { getOrderAddressValidationResult } from "@ikas/bp-storefront";
+ *
+ * const result = getOrderAddressValidationResult(address, checkoutSettings, true);
+ * if (!result.firstName) {
+ *   console.log("First name is required");
+ * }
+ * ```
+ */
+export declare function getOrderAddressValidationResult(address: IkasOrderAddress, checkoutSettings: IkasCheckoutSettings, isDistrictRequired: boolean): IkasOrderAddressValidationResult;
+/**
+ * Checks whether all fields of an order address pass validation.
+ *
+ * @ai-category OrderAddress, Order
+ * @ai-related getOrderAddressValidationResult, createOrderAddress, getOrderAddressText
+ *
+ * @param address - The order address to validate.
+ * @param checkoutSettings - The checkout settings that determine field requirements.
+ * @param isDistrictRequired - Whether the district field is required for the selected country/state.
+ * @returns True if every address field passes validation, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isValidOrderAddress } from "@ikas/bp-storefront";
+ *
+ * if (isValidOrderAddress(address, checkoutSettings, true)) {
+ *   // Proceed to next checkout step
+ * }
+ * ```
+ */
+export declare function isValidOrderAddress(address: IkasOrderAddress, checkoutSettings: IkasCheckoutSettings, isDistrictRequired: boolean): boolean;
+export type IkasOrderAddressValidationResult = {
+    firstName: boolean;
+    lastName: boolean;
+    addressLine1: boolean;
+    country: boolean;
+    state: boolean;
+    city: boolean;
+    district: boolean;
+    phone: boolean;
+    postalCode: boolean;
+    identityNumber: boolean;
+};

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

@@ -0,0 +1,56 @@
+import { IkasOrderAdjustment } from "../../../../../../storefront-models/src";
+/**
+ * Returns the formatted currency string for an order adjustment amount, negated if the adjustment is a decrement.
+ *
+ * @ai-category OrderAdjustment, Order
+ * @ai-related getOrderAdjustmentIsDecrement, getOrderAdjustmentDisplayName
+ *
+ * @param orderAdjustment - The order adjustment whose amount to format.
+ * @returns A locale-formatted currency string (e.g. "-$5.00" for decrements, "$5.00" for increments).
+ *
+ * @example
+ * ```typescript
+ * import { getOrderAdjustmentFormattedAmount } from "@ikas/bp-storefront";
+ *
+ * const formatted = getOrderAdjustmentFormattedAmount(adjustment);
+ * // "-$10.00"
+ * ```
+ */
+export declare function getOrderAdjustmentFormattedAmount(orderAdjustment: IkasOrderAdjustment): string;
+/**
+ * Determines whether an order adjustment is a decrement (i.e. a discount or reduction).
+ *
+ * @ai-category OrderAdjustment, Order
+ * @ai-related getOrderAdjustmentFormattedAmount, getOrderAdjustmentDisplayName
+ *
+ * @param orderAdjustment - The order adjustment to check.
+ * @returns True if the adjustment type is "DECREMENT", false otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { getOrderAdjustmentIsDecrement } from "@ikas/bp-storefront";
+ *
+ * if (getOrderAdjustmentIsDecrement(adjustment)) {
+ *   console.log("This adjustment reduces the order total");
+ * }
+ * ```
+ */
+export declare function getOrderAdjustmentIsDecrement(orderAdjustment: IkasOrderAdjustment): boolean;
+/**
+ * Returns the display name for an order adjustment, translating known names like "INTEREST" to localized strings.
+ *
+ * @ai-category OrderAdjustment, Order
+ * @ai-related getOrderAdjustmentFormattedAmount, getOrderAdjustmentIsDecrement
+ *
+ * @param orderAdjustment - The order adjustment whose display name to retrieve.
+ * @returns The translated display name if the adjustment name is a known key (e.g. "INTEREST"), otherwise the raw adjustment name.
+ *
+ * @example
+ * ```typescript
+ * import { getOrderAdjustmentDisplayName } from "@ikas/bp-storefront";
+ *
+ * const name = getOrderAdjustmentDisplayName(adjustment);
+ * // "Interest" or the raw adjustment name
+ * ```
+ */
+export declare function getOrderAdjustmentDisplayName(orderAdjustment: IkasOrderAdjustment): string;