@ikas/bp-storefront 0.15.0

package/dist/storefront/src/functions/models/validator/coupon-code-form/index.d.ts

@@ -0,0 +1,72 @@
+import { CouponCodeForm } from "../../../../../../storefront-models/src";
+/**
+ * Initializes the coupon code form with default values, labels, and placeholders.
+ *
+ * @ai-category Validation, CouponCode, Form
+ * @ai-related setCouponCodeFormCouponCode, submitCouponCodeForm, removeCouponCodeForm
+ *
+ * @param couponCodeForm - The coupon code form model to initialize
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initCouponCodeForm } from "@ikas/bp-storefront";
+ * initCouponCodeForm(couponCodeForm);
+ * ```
+ */
+export declare function initCouponCodeForm(couponCodeForm: CouponCodeForm): void;
+/**
+ * Sets the coupon code value on the form and re-validates if the form has already been submitted.
+ *
+ * @ai-category Validation, CouponCode, Form
+ * @ai-related initCouponCodeForm, submitCouponCodeForm, removeCouponCodeForm
+ *
+ * @param couponCodeForm - The coupon code form model to update
+ * @param value - The new coupon code string to set
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setCouponCodeFormCouponCode } from "@ikas/bp-storefront";
+ * setCouponCodeFormCouponCode(couponCodeForm, "SUMMER2024");
+ * ```
+ */
+export declare function setCouponCodeFormCouponCode(couponCodeForm: CouponCodeForm, value: string): void;
+/**
+ * Validates and submits the coupon code form, applying the coupon code to the current cart.
+ *
+ * @ai-category Validation, CouponCode, Form
+ * @ai-related initCouponCodeForm, setCouponCodeFormCouponCode, removeCouponCodeForm
+ *
+ * @param couponCodeForm - The coupon code form model to submit
+ * @returns A promise that resolves to true if the coupon was applied successfully, or false on validation error, missing cart, or API failure
+ *
+ * @example
+ * ```typescript
+ * import { submitCouponCodeForm } from "@ikas/bp-storefront";
+ * const success = await submitCouponCodeForm(couponCodeForm);
+ * if (success) {
+ *   console.log("Coupon applied!");
+ * }
+ * ```
+ */
+export declare function submitCouponCodeForm(couponCodeForm: CouponCodeForm): Promise<boolean>;
+/**
+ * Removes the currently applied coupon code from the cart.
+ *
+ * @ai-category Validation, CouponCode, Form
+ * @ai-related initCouponCodeForm, setCouponCodeFormCouponCode, submitCouponCodeForm
+ *
+ * @param couponCodeForm - The coupon code form model used to track submission state
+ * @returns A promise that resolves to true if the coupon was removed successfully, or false on missing cart or API failure
+ *
+ * @example
+ * ```typescript
+ * import { removeCouponCodeForm } from "@ikas/bp-storefront";
+ * const success = await removeCouponCodeForm(couponCodeForm);
+ * if (success) {
+ *   console.log("Coupon removed!");
+ * }
+ * ```
+ */
+export declare function removeCouponCodeForm(couponCodeForm: CouponCodeForm): Promise<boolean>;

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

@@ -0,0 +1,88 @@
+import { CustomerReviewForm } from "../../../../../../storefront-models/src";
+/**
+ * Initializes the customer review form with default field values, labels, and placeholders for title, comment, and star rating.
+ *
+ * @ai-category Validation, CustomerReview, Form
+ * @ai-related setCustomerReviewFormTitle, setCustomerReviewFormComment, setCustomerReviewFormStar, submitCustomerReviewForm
+ *
+ * @param customerReviewForm - The customer review form model to initialize
+ * @param productId - The ID of the product being reviewed
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initCustomerReviewForm } from "@ikas/bp-storefront";
+ * initCustomerReviewForm(customerReviewForm, "product-123");
+ * ```
+ */
+export declare function initCustomerReviewForm(customerReviewForm: CustomerReviewForm, productId: string): void;
+/**
+ * Sets the review title value and re-validates the form if it has already been submitted.
+ *
+ * @ai-category Validation, CustomerReview, Form
+ * @ai-related initCustomerReviewForm, setCustomerReviewFormComment, setCustomerReviewFormStar, submitCustomerReviewForm
+ *
+ * @param customerReviewForm - The customer review form model to update
+ * @param value - The new title string for the review
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setCustomerReviewFormTitle } from "@ikas/bp-storefront";
+ * setCustomerReviewFormTitle(customerReviewForm, "Great product!");
+ * ```
+ */
+export declare function setCustomerReviewFormTitle(customerReviewForm: CustomerReviewForm, value: string): void;
+/**
+ * Sets the review comment value and re-validates the form if it has already been submitted.
+ *
+ * @ai-category Validation, CustomerReview, Form
+ * @ai-related initCustomerReviewForm, setCustomerReviewFormTitle, setCustomerReviewFormStar, submitCustomerReviewForm
+ *
+ * @param customerReviewForm - The customer review form model to update
+ * @param value - The new comment string for the review
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setCustomerReviewFormComment } from "@ikas/bp-storefront";
+ * setCustomerReviewFormComment(customerReviewForm, "I really enjoyed using this product.");
+ * ```
+ */
+export declare function setCustomerReviewFormComment(customerReviewForm: CustomerReviewForm, value: string): void;
+/**
+ * Sets the star rating value and re-validates the form if it has already been submitted.
+ *
+ * @ai-category Validation, CustomerReview, Form
+ * @ai-related initCustomerReviewForm, setCustomerReviewFormTitle, setCustomerReviewFormComment, submitCustomerReviewForm
+ *
+ * @param customerReviewForm - The customer review form model to update
+ * @param value - The star rating as a string (expected to be an integer between 1 and 5)
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setCustomerReviewFormStar } from "@ikas/bp-storefront";
+ * setCustomerReviewFormStar(customerReviewForm, "5");
+ * ```
+ */
+export declare function setCustomerReviewFormStar(customerReviewForm: CustomerReviewForm, value: string): void;
+/**
+ * Validates and submits the customer review form, sending the review (title, comment, star rating) for the associated product.
+ *
+ * @ai-category Validation, CustomerReview, Form
+ * @ai-related initCustomerReviewForm, setCustomerReviewFormTitle, setCustomerReviewFormComment, setCustomerReviewFormStar
+ *
+ * @param customerReviewForm - The customer review form model to submit
+ * @returns A promise that resolves to true if the review was submitted successfully, or false on validation error or API failure
+ *
+ * @example
+ * ```typescript
+ * import { submitCustomerReviewForm } from "@ikas/bp-storefront";
+ * const success = await submitCustomerReviewForm(customerReviewForm);
+ * if (success) {
+ *   console.log("Review submitted!");
+ * }
+ * ```
+ */
+export declare function submitCustomerReviewForm(customerReviewForm: CustomerReviewForm): Promise<boolean>;

package/dist/storefront/src/functions/models/validator/forgot-password/index.d.ts

@@ -0,0 +1,53 @@
+import { ForgotPasswordForm } from "../../../../../../storefront-models/src";
+/**
+ * Initializes the forgot password form with default email field values, labels, and placeholders.
+ *
+ * @ai-category Validation, ForgotPassword, Form
+ * @ai-related setForgotPasswordFormEmail, submitForgotPasswordForm
+ *
+ * @param forgotPasswordForm - The forgot password form model to initialize
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initForgotPasswordForm } from "@ikas/bp-storefront";
+ * initForgotPasswordForm(forgotPasswordForm);
+ * ```
+ */
+export declare function initForgotPasswordForm(forgotPasswordForm: ForgotPasswordForm): void;
+/**
+ * Sets the email value on the forgot password form and re-validates if the form has already been submitted.
+ *
+ * @ai-category Validation, ForgotPassword, Form
+ * @ai-related initForgotPasswordForm, submitForgotPasswordForm
+ *
+ * @param forgotPasswordForm - The forgot password form model to update
+ * @param value - The new email address string to set
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setForgotPasswordFormEmail } from "@ikas/bp-storefront";
+ * setForgotPasswordFormEmail(forgotPasswordForm, "user@example.com");
+ * ```
+ */
+export declare function setForgotPasswordFormEmail(forgotPasswordForm: ForgotPasswordForm, value: string): void;
+/**
+ * Validates and submits the forgot password form, sending a password reset request for the provided email address.
+ *
+ * @ai-category Validation, ForgotPassword, Form
+ * @ai-related initForgotPasswordForm, setForgotPasswordFormEmail
+ *
+ * @param forgotPasswordForm - The forgot password form model to submit
+ * @returns A promise that resolves to true if the password reset email was sent successfully, or false on validation error or API failure
+ *
+ * @example
+ * ```typescript
+ * import { submitForgotPasswordForm } from "@ikas/bp-storefront";
+ * const success = await submitForgotPasswordForm(forgotPasswordForm);
+ * if (success) {
+ *   console.log("Password reset email sent!");
+ * }
+ * ```
+ */
+export declare function submitForgotPasswordForm(forgotPasswordForm: ForgotPasswordForm): Promise<boolean>;

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

@@ -0,0 +1,54 @@
+/**
+ * Validates a value against a set of configurable validation rules including required, email, phone, regex, integer, min/max constraints, and equality checks.
+ *
+ * @ai-category Validation, Form
+ * @ai-related FORM_ITEM_DEFAULT_VALUE
+ *
+ * @param value - The value to validate; can be a string, boolean, or array of strings.
+ * @param options - Optional validation options specifying which rules to apply (required, email, min, max, phone, equals, regex, integer).
+ * @returns An object with `hasError` (boolean) and optionally `message` (string) describing the validation failure.
+ *
+ * @example
+ * ```typescript
+ * import { validateValue } from "@ikas/bp-storefront";
+ * const result = validateValue("user@example.com", { required: true, email: true });
+ * if (result.hasError) {
+ *   console.log(result.message);
+ * }
+ * ```
+ */
+export declare function validateValue(value: string | boolean | string[], options?: IkasValidateValueOptions): {
+    hasError: boolean;
+    message: string;
+} | {
+    hasError: boolean;
+    message?: undefined;
+};
+type IkasValidateValueOptions = {
+    required?: boolean;
+    email?: boolean;
+    min?: number;
+    max?: number;
+    phone?: boolean;
+    equals?: string;
+    regex?: string;
+    integer?: boolean;
+};
+/**
+ * Default initial state for a form item, with an empty value, no error, and no message.
+ *
+ * @ai-category Validation, Form
+ * @ai-related validateValue
+ *
+ * @example
+ * ```typescript
+ * import { FORM_ITEM_DEFAULT_VALUE } from "@ikas/bp-storefront";
+ * const field = { ...FORM_ITEM_DEFAULT_VALUE, label: "Email" };
+ * ```
+ */
+export declare const FORM_ITEM_DEFAULT_VALUE: {
+    value: string;
+    hasError: boolean;
+    message: undefined;
+};
+export {};

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

@@ -0,0 +1,70 @@
+import { LoginForm } from "../../../../../../storefront-models/src";
+/**
+ * Initializes the login form with default email and password field values, labels, and placeholders.
+ *
+ * @ai-category Validation, Login, Form
+ * @ai-related setLoginFormEmail, setLoginFormPassword, submitLoginForm
+ *
+ * @param loginForm - The login form model to initialize
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initLoginForm } from "@ikas/bp-storefront";
+ * initLoginForm(loginForm);
+ * ```
+ */
+export declare function initLoginForm(loginForm: LoginForm): void;
+/**
+ * Sets the email value on the login form and re-validates if the form has already been submitted.
+ *
+ * @ai-category Validation, Login, Form
+ * @ai-related initLoginForm, setLoginFormPassword, submitLoginForm
+ *
+ * @param loginForm - The login form model to update
+ * @param value - The new email address string to set
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setLoginFormEmail } from "@ikas/bp-storefront";
+ * setLoginFormEmail(loginForm, "user@example.com");
+ * ```
+ */
+export declare function setLoginFormEmail(loginForm: LoginForm, value: string): void;
+/**
+ * Sets the password value on the login form and re-validates if the form has already been submitted.
+ *
+ * @ai-category Validation, Login, Form
+ * @ai-related initLoginForm, setLoginFormEmail, submitLoginForm
+ *
+ * @param loginForm - The login form model to update
+ * @param value - The new password string to set
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setLoginFormPassword } from "@ikas/bp-storefront";
+ * setLoginFormPassword(loginForm, "mySecurePassword123");
+ * ```
+ */
+export declare function setLoginFormPassword(loginForm: LoginForm, value: string): void;
+/**
+ * Validates and submits the login form, authenticating the customer with the provided email and password.
+ *
+ * @ai-category Validation, Login, Form
+ * @ai-related initLoginForm, setLoginFormEmail, setLoginFormPassword
+ *
+ * @param loginForm - The login form model to submit
+ * @returns A promise that resolves to true if login was successful, or false on validation error or authentication failure
+ *
+ * @example
+ * ```typescript
+ * import { submitLoginForm } from "@ikas/bp-storefront";
+ * const success = await submitLoginForm(loginForm);
+ * if (success) {
+ *   console.log("Login successful!");
+ * }
+ * ```
+ */
+export declare function submitLoginForm(loginForm: LoginForm): Promise<boolean>;

package/dist/storefront/src/functions/models/validator/newsletter-subscription/index.d.ts

@@ -0,0 +1,70 @@
+import { NewsletterSubscriptionForm } from "../../../../../../storefront-models/src";
+/**
+ * Initializes the newsletter subscription form with default field values and resets submission state.
+ *
+ * @ai-category Validation, Newsletter, Form
+ * @ai-related setNewsletterSubscriptionFormEmail, setNewsletterSubscriptionFormIsMarketingAccepted, submitNewsletterSubscriptionForm
+ *
+ * @param newsletterSubscriptionForm - The newsletter subscription form object to initialize
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initNewsletterSubscriptionForm } from "@ikas/bp-storefront";
+ * initNewsletterSubscriptionForm(newsletterSubscriptionForm);
+ * ```
+ */
+export declare function initNewsletterSubscriptionForm(newsletterSubscriptionForm: NewsletterSubscriptionForm): void;
+/**
+ * Sets the email field value on the newsletter subscription form and re-validates if the form has been submitted.
+ *
+ * @ai-category Validation, Newsletter, Form
+ * @ai-related initNewsletterSubscriptionForm, setNewsletterSubscriptionFormIsMarketingAccepted, submitNewsletterSubscriptionForm
+ *
+ * @param newsletterSubscriptionForm - The newsletter subscription form object to update
+ * @param value - The email address string to set
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setNewsletterSubscriptionFormEmail } from "@ikas/bp-storefront";
+ * setNewsletterSubscriptionFormEmail(newsletterSubscriptionForm, "user@example.com");
+ * ```
+ */
+export declare function setNewsletterSubscriptionFormEmail(newsletterSubscriptionForm: NewsletterSubscriptionForm, value: string): void;
+/**
+ * Sets the marketing acceptance checkbox value on the newsletter subscription form and re-validates if the form has been submitted.
+ *
+ * @ai-category Validation, Newsletter, Form
+ * @ai-related initNewsletterSubscriptionForm, setNewsletterSubscriptionFormEmail, submitNewsletterSubscriptionForm
+ *
+ * @param newsletterSubscriptionForm - The newsletter subscription form object to update
+ * @param value - Whether the user has accepted marketing communications
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setNewsletterSubscriptionFormIsMarketingAccepted } from "@ikas/bp-storefront";
+ * setNewsletterSubscriptionFormIsMarketingAccepted(newsletterSubscriptionForm, true);
+ * ```
+ */
+export declare function setNewsletterSubscriptionFormIsMarketingAccepted(newsletterSubscriptionForm: NewsletterSubscriptionForm, value: boolean): void;
+/**
+ * Validates and submits the newsletter subscription form, creating an email subscription via the API.
+ *
+ * @ai-category Validation, Newsletter, Form
+ * @ai-related initNewsletterSubscriptionForm, setNewsletterSubscriptionFormEmail, setNewsletterSubscriptionFormIsMarketingAccepted
+ *
+ * @param newsletterSubscriptionForm - The newsletter subscription form object to validate and submit
+ * @returns A promise that resolves to true if the subscription was successful, or false if validation failed or the API returned an error
+ *
+ * @example
+ * ```typescript
+ * import { submitNewsletterSubscriptionForm } from "@ikas/bp-storefront";
+ * const success = await submitNewsletterSubscriptionForm(newsletterSubscriptionForm);
+ * if (success) {
+ *   console.log("Subscribed successfully");
+ * }
+ * ```
+ */
+export declare function submitNewsletterSubscriptionForm(newsletterSubscriptionForm: NewsletterSubscriptionForm): Promise<boolean>;

package/dist/storefront/src/functions/models/validator/order-tracking/index.d.ts

@@ -0,0 +1,70 @@
+import { OrderTrackingForm } from "../../../../../../storefront-models/src";
+/**
+ * Initializes the order tracking form with default field values for email and order number, and resets submission state.
+ *
+ * @ai-category Validation, OrderTracking, Form
+ * @ai-related setOrderTrackingFormEmail, setOrderTrackingFormOrderNumber, submitOrderTrackingForm
+ *
+ * @param orderTrackingForm - The order tracking form object to initialize
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initOrderTrackingForm } from "@ikas/bp-storefront";
+ * initOrderTrackingForm(orderTrackingForm);
+ * ```
+ */
+export declare function initOrderTrackingForm(orderTrackingForm: OrderTrackingForm): void;
+/**
+ * Sets the email field value on the order tracking form and re-validates if the form has been submitted.
+ *
+ * @ai-category Validation, OrderTracking, Form
+ * @ai-related initOrderTrackingForm, setOrderTrackingFormOrderNumber, submitOrderTrackingForm
+ *
+ * @param orderTrackingForm - The order tracking form object to update
+ * @param value - The email address string to set
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setOrderTrackingFormEmail } from "@ikas/bp-storefront";
+ * setOrderTrackingFormEmail(orderTrackingForm, "customer@example.com");
+ * ```
+ */
+export declare function setOrderTrackingFormEmail(orderTrackingForm: OrderTrackingForm, value: string): void;
+/**
+ * Sets the order number field value on the order tracking form and re-validates if the form has been submitted.
+ *
+ * @ai-category Validation, OrderTracking, Form
+ * @ai-related initOrderTrackingForm, setOrderTrackingFormEmail, submitOrderTrackingForm
+ *
+ * @param orderTrackingForm - The order tracking form object to update
+ * @param value - The order number string to set
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setOrderTrackingFormOrderNumber } from "@ikas/bp-storefront";
+ * setOrderTrackingFormOrderNumber(orderTrackingForm, "ORD-12345");
+ * ```
+ */
+export declare function setOrderTrackingFormOrderNumber(orderTrackingForm: OrderTrackingForm, value: string): void;
+/**
+ * Validates and submits the order tracking form, retrieving order details by email and order number.
+ *
+ * @ai-category Validation, OrderTracking, Form
+ * @ai-related initOrderTrackingForm, setOrderTrackingFormEmail, setOrderTrackingFormOrderNumber
+ *
+ * @param orderTrackingForm - The order tracking form object to validate and submit
+ * @returns A promise that resolves to the order response object if successful, or null if validation failed or the order was not found
+ *
+ * @example
+ * ```typescript
+ * import { submitOrderTrackingForm } from "@ikas/bp-storefront";
+ * const order = await submitOrderTrackingForm(orderTrackingForm);
+ * if (order) {
+ *   console.log("Order found:", order);
+ * }
+ * ```
+ */
+export declare function submitOrderTrackingForm(orderTrackingForm: OrderTrackingForm): Promise<import("../../../../../../storefront-models/src").IkasOrder | null>;

package/dist/storefront/src/functions/models/validator/recover-password/index.d.ts

@@ -0,0 +1,70 @@
+import { RecoverPasswordForm } from "../../../../../../storefront-models/src";
+/**
+ * Initializes the recover password form with default field values for password and password confirmation, and resets submission state.
+ *
+ * @ai-category Validation, RecoverPassword, Form
+ * @ai-related setRecoverPasswordFormPassword, setRecoverPasswordFormPasswordAgain, submitRecoverPasswordForm
+ *
+ * @param recoverPasswordForm - The recover password form object to initialize
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initRecoverPasswordForm } from "@ikas/bp-storefront";
+ * initRecoverPasswordForm(recoverPasswordForm);
+ * ```
+ */
+export declare function initRecoverPasswordForm(recoverPasswordForm: RecoverPasswordForm): void;
+/**
+ * Sets the password field value on the recover password form and re-validates if the form has been submitted.
+ *
+ * @ai-category Validation, RecoverPassword, Form
+ * @ai-related initRecoverPasswordForm, setRecoverPasswordFormPasswordAgain, submitRecoverPasswordForm
+ *
+ * @param recoverPasswordForm - The recover password form object to update
+ * @param value - The new password string to set
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setRecoverPasswordFormPassword } from "@ikas/bp-storefront";
+ * setRecoverPasswordFormPassword(recoverPasswordForm, "newSecurePassword123");
+ * ```
+ */
+export declare function setRecoverPasswordFormPassword(recoverPasswordForm: RecoverPasswordForm, value: string): void;
+/**
+ * Sets the password confirmation field value on the recover password form and re-validates if the form has been submitted.
+ *
+ * @ai-category Validation, RecoverPassword, Form
+ * @ai-related initRecoverPasswordForm, setRecoverPasswordFormPassword, submitRecoverPasswordForm
+ *
+ * @param recoverPasswordForm - The recover password form object to update
+ * @param value - The password confirmation string to set
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setRecoverPasswordFormPasswordAgain } from "@ikas/bp-storefront";
+ * setRecoverPasswordFormPasswordAgain(recoverPasswordForm, "newSecurePassword123");
+ * ```
+ */
+export declare function setRecoverPasswordFormPasswordAgain(recoverPasswordForm: RecoverPasswordForm, value: string): void;
+/**
+ * Validates and submits the recover password form, sending the new password along with the URL token to the API.
+ *
+ * @ai-category Validation, RecoverPassword, Form
+ * @ai-related initRecoverPasswordForm, setRecoverPasswordFormPassword, setRecoverPasswordFormPasswordAgain
+ *
+ * @param recoverPasswordForm - The recover password form object to validate and submit
+ * @returns A promise that resolves to true if the password was recovered successfully, or false if validation failed or the API returned an error
+ *
+ * @example
+ * ```typescript
+ * import { submitRecoverPasswordForm } from "@ikas/bp-storefront";
+ * const success = await submitRecoverPasswordForm(recoverPasswordForm);
+ * if (success) {
+ *   console.log("Password recovered successfully");
+ * }
+ * ```
+ */
+export declare function submitRecoverPasswordForm(recoverPasswordForm: RecoverPasswordForm): Promise<boolean>;