@ikas/bp-storefront 0.15.0

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

@@ -0,0 +1,297 @@
+import { IkasFormAttributeItem, RegisterForm } from "../../../../../../storefront-models/src";
+/**
+ * Initializes the registration form with default field values, labels, placeholders, and customer attributes.
+ *
+ * @ai-category Registration, Form, Initialization
+ * @ai-related submitRegisterForm, setRegisterFormFirstName, setRegisterFormLastName, setRegisterFormEmail, setRegisterFormPassword, setRegisterFormPhone
+ *
+ * @param registerForm - The register form instance to initialize with default values.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initRegisterForm } from "@ikas/bp-storefront";
+ *
+ * initRegisterForm(registerForm);
+ * ```
+ */
+export declare function initRegisterForm(registerForm: RegisterForm): void;
+/**
+ * Sets the value of a text-type custom attribute on the registration form.
+ *
+ * @ai-category Registration, Form, Customer, Validation
+ * @ai-related setRegisterFormDateAttribute, setRegisterFormDateTimeAttribute, setRegisterFormChoiceAttribute, setRegisterFormNumericAttribute, setRegisterFormBooleanAttribute, setRegisterFormMultipleChoiceAttribute
+ *
+ * @param registerForm - The register form instance containing the attribute.
+ * @param attribute - The form attribute item to update.
+ * @param value - The text value to assign to the attribute.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setRegisterFormTextAttribute } from "@ikas/bp-storefront";
+ *
+ * setRegisterFormTextAttribute(registerForm, attribute, "some text value");
+ * ```
+ */
+export declare function setRegisterFormTextAttribute(registerForm: RegisterForm, attribute: IkasFormAttributeItem, value: string): void;
+/**
+ * Sets the value of a datetime-type custom attribute on the registration form.
+ *
+ * @ai-category Registration, Form, Customer, Validation
+ * @ai-related setRegisterFormTextAttribute, setRegisterFormDateAttribute, setRegisterFormChoiceAttribute, setRegisterFormNumericAttribute, setRegisterFormBooleanAttribute, setRegisterFormMultipleChoiceAttribute
+ *
+ * @param registerForm - The register form instance containing the attribute.
+ * @param attribute - The form attribute item to update.
+ * @param value - The datetime string value to assign to the attribute.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setRegisterFormDateTimeAttribute } from "@ikas/bp-storefront";
+ *
+ * setRegisterFormDateTimeAttribute(registerForm, attribute, "2024-06-15T10:30:00");
+ * ```
+ */
+export declare function setRegisterFormDateTimeAttribute(registerForm: RegisterForm, attribute: IkasFormAttributeItem, value: string): void;
+/**
+ * Sets the value of a date-type custom attribute on the registration form.
+ *
+ * @ai-category Registration, Form, Customer, Validation
+ * @ai-related setRegisterFormTextAttribute, setRegisterFormDateTimeAttribute, setRegisterFormChoiceAttribute, setRegisterFormNumericAttribute, setRegisterFormBooleanAttribute, setRegisterFormMultipleChoiceAttribute
+ *
+ * @param registerForm - The register form instance containing the attribute.
+ * @param attribute - The form attribute item to update.
+ * @param value - The date string value to assign to the attribute.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setRegisterFormDateAttribute } from "@ikas/bp-storefront";
+ *
+ * setRegisterFormDateAttribute(registerForm, attribute, "2024-06-15");
+ * ```
+ */
+export declare function setRegisterFormDateAttribute(registerForm: RegisterForm, attribute: IkasFormAttributeItem, value: string): void;
+/**
+ * Sets the value of a single-choice custom attribute on the registration form.
+ *
+ * @ai-category Registration, Form, Customer, Validation
+ * @ai-related setRegisterFormTextAttribute, setRegisterFormDateAttribute, setRegisterFormDateTimeAttribute, setRegisterFormNumericAttribute, setRegisterFormBooleanAttribute, setRegisterFormMultipleChoiceAttribute
+ *
+ * @param registerForm - The register form instance containing the attribute.
+ * @param attribute - The form attribute item to update.
+ * @param value - The selected choice option value (typically an option ID).
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setRegisterFormChoiceAttribute } from "@ikas/bp-storefront";
+ *
+ * setRegisterFormChoiceAttribute(registerForm, attribute, "optionId123");
+ * ```
+ */
+export declare function setRegisterFormChoiceAttribute(registerForm: RegisterForm, attribute: IkasFormAttributeItem, value: string): void;
+/**
+ * Sets the value of a numeric-type custom attribute on the registration form, ensuring only valid integers are accepted.
+ *
+ * @ai-category Registration, Form, Customer, Validation
+ * @ai-related setRegisterFormTextAttribute, setRegisterFormDateAttribute, setRegisterFormDateTimeAttribute, setRegisterFormChoiceAttribute, setRegisterFormBooleanAttribute, setRegisterFormMultipleChoiceAttribute
+ *
+ * @param registerForm - The register form instance containing the attribute.
+ * @param attribute - The form attribute item to update.
+ * @param value - The numeric string value to assign; non-integer trailing characters are stripped.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setRegisterFormNumericAttribute } from "@ikas/bp-storefront";
+ *
+ * setRegisterFormNumericAttribute(registerForm, attribute, "42");
+ * ```
+ */
+export declare function setRegisterFormNumericAttribute(registerForm: RegisterForm, attribute: IkasFormAttributeItem, value: string): void;
+/**
+ * Sets the checked state of a boolean-type custom attribute on the registration form.
+ *
+ * @ai-category Registration, Form, Customer, Validation
+ * @ai-related setRegisterFormTextAttribute, setRegisterFormDateAttribute, setRegisterFormDateTimeAttribute, setRegisterFormChoiceAttribute, setRegisterFormNumericAttribute, setRegisterFormMultipleChoiceAttribute
+ *
+ * @param registerForm - The register form instance containing the attribute.
+ * @param attribute - The form attribute item to update.
+ * @param value - The boolean value indicating whether the attribute is checked.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setRegisterFormBooleanAttribute } from "@ikas/bp-storefront";
+ *
+ * setRegisterFormBooleanAttribute(registerForm, attribute, true);
+ * ```
+ */
+export declare function setRegisterFormBooleanAttribute(registerForm: RegisterForm, attribute: IkasFormAttributeItem, value: boolean): void;
+/**
+ * Sets the selected option IDs for a multiple-choice custom attribute on the registration form.
+ *
+ * @ai-category Registration, Form, Customer, Validation
+ * @ai-related setRegisterFormTextAttribute, setRegisterFormDateAttribute, setRegisterFormDateTimeAttribute, setRegisterFormChoiceAttribute, setRegisterFormNumericAttribute, setRegisterFormBooleanAttribute
+ *
+ * @param registerForm - The register form instance containing the attribute.
+ * @param attribute - The form attribute item to update.
+ * @param value - An array of selected option IDs.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setRegisterFormMultipleChoiceAttribute } from "@ikas/bp-storefront";
+ *
+ * setRegisterFormMultipleChoiceAttribute(registerForm, attribute, ["optionId1", "optionId2"]);
+ * ```
+ */
+export declare function setRegisterFormMultipleChoiceAttribute(registerForm: RegisterForm, attribute: IkasFormAttributeItem, value: string[]): void;
+/**
+ * Sets the first name field on the registration form and re-validates if the form has been submitted.
+ *
+ * @ai-category Registration, Form, Customer, Validation
+ * @ai-related setRegisterFormLastName, setRegisterFormEmail, setRegisterFormPassword, setRegisterFormPhone, initRegisterForm, submitRegisterForm
+ *
+ * @param registerForm - The register form instance to update.
+ * @param value - The first name value to set.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setRegisterFormFirstName } from "@ikas/bp-storefront";
+ *
+ * setRegisterFormFirstName(registerForm, "Jane");
+ * ```
+ */
+export declare function setRegisterFormFirstName(registerForm: RegisterForm, value: string): void;
+/**
+ * Sets the last name field on the registration form and re-validates if the form has been submitted.
+ *
+ * @ai-category Registration, Form, Customer, Validation
+ * @ai-related setRegisterFormFirstName, setRegisterFormEmail, setRegisterFormPassword, setRegisterFormPhone, initRegisterForm, submitRegisterForm
+ *
+ * @param registerForm - The register form instance to update.
+ * @param value - The last name value to set.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setRegisterFormLastName } from "@ikas/bp-storefront";
+ *
+ * setRegisterFormLastName(registerForm, "Doe");
+ * ```
+ */
+export declare function setRegisterFormLastName(registerForm: RegisterForm, value: string): void;
+/**
+ * Sets the email field on the registration form and re-validates if the form has been submitted.
+ *
+ * @ai-category Registration, Form, Customer, Validation
+ * @ai-related setRegisterFormFirstName, setRegisterFormLastName, setRegisterFormPassword, setRegisterFormPhone, initRegisterForm, submitRegisterForm
+ *
+ * @param registerForm - The register form instance to update.
+ * @param value - The email address value to set.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setRegisterFormEmail } from "@ikas/bp-storefront";
+ *
+ * setRegisterFormEmail(registerForm, "jane.doe@example.com");
+ * ```
+ */
+export declare function setRegisterFormEmail(registerForm: RegisterForm, value: string): void;
+/**
+ * Sets the password field on the registration form and re-validates if the form has been submitted.
+ *
+ * @ai-category Registration, Form, Customer, Validation
+ * @ai-related setRegisterFormFirstName, setRegisterFormLastName, setRegisterFormEmail, setRegisterFormPhone, initRegisterForm, submitRegisterForm
+ *
+ * @param registerForm - The register form instance to update.
+ * @param value - The password value to set.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setRegisterFormPassword } from "@ikas/bp-storefront";
+ *
+ * setRegisterFormPassword(registerForm, "securePassword123");
+ * ```
+ */
+export declare function setRegisterFormPassword(registerForm: RegisterForm, value: string): void;
+/**
+ * Sets the phone number field on the registration form and re-validates if the form has been submitted.
+ *
+ * @ai-category Registration, Form, Customer, Validation
+ * @ai-related setRegisterFormFirstName, setRegisterFormLastName, setRegisterFormEmail, setRegisterFormPassword, initRegisterForm, submitRegisterForm
+ *
+ * @param registerForm - The register form instance to update.
+ * @param value - The phone number value to set.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setRegisterFormPhone } from "@ikas/bp-storefront";
+ *
+ * setRegisterFormPhone(registerForm, "+1234567890");
+ * ```
+ */
+export declare function setRegisterFormPhone(registerForm: RegisterForm, value: string): void;
+/**
+ * Sets the marketing consent acceptance flag on the registration form and re-validates if the form has been submitted.
+ *
+ * @ai-category Registration, Form, Customer, Validation
+ * @ai-related setRegisterFormIsMembershipAgreementAccepted, initRegisterForm, submitRegisterForm
+ *
+ * @param registerForm - The register form instance to update.
+ * @param value - Whether the customer accepts marketing communications.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setRegisterFormIsMarketingAccepted } from "@ikas/bp-storefront";
+ *
+ * setRegisterFormIsMarketingAccepted(registerForm, true);
+ * ```
+ */
+export declare function setRegisterFormIsMarketingAccepted(registerForm: RegisterForm, value: boolean): void;
+/**
+ * Sets the membership agreement acceptance flag on the registration form and re-validates if the form has been submitted.
+ *
+ * @ai-category Registration, Form, Customer, Validation
+ * @ai-related setRegisterFormIsMarketingAccepted, initRegisterForm, submitRegisterForm
+ *
+ * @param registerForm - The register form instance to update.
+ * @param value - Whether the customer accepts the membership agreement.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setRegisterFormIsMembershipAgreementAccepted } from "@ikas/bp-storefront";
+ *
+ * setRegisterFormIsMembershipAgreementAccepted(registerForm, true);
+ * ```
+ */
+export declare function setRegisterFormIsMembershipAgreementAccepted(registerForm: RegisterForm, value: boolean): void;
+/**
+ * Validates and submits the registration form, creating a new customer account if all fields pass validation.
+ *
+ * @ai-category Registration, Form, Customer, Validation
+ * @ai-related initRegisterForm, setRegisterFormFirstName, setRegisterFormLastName, setRegisterFormEmail, setRegisterFormPassword, setRegisterFormPhone, setRegisterFormIsMarketingAccepted, setRegisterFormIsMembershipAgreementAccepted
+ *
+ * @param registerForm - The register form instance to validate and submit.
+ * @returns A promise that resolves to `true` if registration succeeded, or `false` if validation failed or the API request was unsuccessful.
+ *
+ * @example
+ * ```typescript
+ * import { submitRegisterForm } from "@ikas/bp-storefront";
+ *
+ * const success = await submitRegisterForm(registerForm);
+ * if (success) {
+ *   // Registration was successful
+ * }
+ * ```
+ */
+export declare function submitRegisterForm(registerForm: RegisterForm): Promise<boolean>;

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

@@ -0,0 +1,171 @@
+import { SmsLoginForm } from "../../../../../../storefront-models/src";
+/**
+ * Initializes the SMS login form with default field values, labels, placeholders, and resets all state.
+ *
+ * @ai-category SMSLogin, Authentication, Validation
+ * @ai-related setSmsLoginFormPhone, setSmsLoginFormCode, submitSmsLoginForm
+ *
+ * @param smsLoginForm - The SMS login form instance to initialize.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initSmsLoginForm } from "@ikas/bp-storefront";
+ * initSmsLoginForm(smsLoginForm);
+ * ```
+ */
+export declare function initSmsLoginForm(smsLoginForm: SmsLoginForm): void;
+/**
+ * Sets the phone number value on the SMS login form and re-validates if the form has been submitted during the phone entry step.
+ *
+ * @ai-category SMSLogin, PhoneVerification, Validation
+ * @ai-related setSmsLoginFormCode, initSmsLoginForm, submitSmsLoginForm
+ *
+ * @param smsLoginForm - The SMS login form instance to update.
+ * @param value - The phone number string to set.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setSmsLoginFormPhone } from "@ikas/bp-storefront";
+ * setSmsLoginFormPhone(smsLoginForm, "+905551234567");
+ * ```
+ */
+export declare function setSmsLoginFormPhone(smsLoginForm: SmsLoginForm, value: string): void;
+/**
+ * Sets the OTP verification code value on the SMS login form and re-validates if the form has been submitted during the code verification step.
+ *
+ * @ai-category SMSLogin, PhoneVerification, Validation
+ * @ai-related setSmsLoginFormPhone, submitSmsLoginForm, resendSmsLoginFormCode
+ *
+ * @param smsLoginForm - The SMS login form instance to update.
+ * @param value - The OTP code string to set.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setSmsLoginFormCode } from "@ikas/bp-storefront";
+ * setSmsLoginFormCode(smsLoginForm, "123456");
+ * ```
+ */
+export declare function setSmsLoginFormCode(smsLoginForm: SmsLoginForm, value: string): void;
+/**
+ * Sets the first name value on the SMS login form and re-validates if the form has been submitted during the profile completion step.
+ *
+ * @ai-category SMSLogin, Authentication, Validation
+ * @ai-related setSmsLoginFormLastName, setSmsLoginFormEmail, submitSmsLoginForm
+ *
+ * @param smsLoginForm - The SMS login form instance to update.
+ * @param value - The first name string to set.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setSmsLoginFormFirstName } from "@ikas/bp-storefront";
+ * setSmsLoginFormFirstName(smsLoginForm, "John");
+ * ```
+ */
+export declare function setSmsLoginFormFirstName(smsLoginForm: SmsLoginForm, value: string): void;
+/**
+ * Sets the last name value on the SMS login form and re-validates if the form has been submitted during the profile completion step.
+ *
+ * @ai-category SMSLogin, Authentication, Validation
+ * @ai-related setSmsLoginFormFirstName, setSmsLoginFormEmail, submitSmsLoginForm
+ *
+ * @param smsLoginForm - The SMS login form instance to update.
+ * @param value - The last name string to set.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setSmsLoginFormLastName } from "@ikas/bp-storefront";
+ * setSmsLoginFormLastName(smsLoginForm, "Doe");
+ * ```
+ */
+export declare function setSmsLoginFormLastName(smsLoginForm: SmsLoginForm, value: string): void;
+/**
+ * Sets the email value on the SMS login form and re-validates if the form has been submitted during the profile completion step.
+ *
+ * @ai-category SMSLogin, Authentication, Validation
+ * @ai-related setSmsLoginFormFirstName, setSmsLoginFormLastName, submitSmsLoginForm
+ *
+ * @param smsLoginForm - The SMS login form instance to update.
+ * @param value - The email address string to set.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setSmsLoginFormEmail } from "@ikas/bp-storefront";
+ * setSmsLoginFormEmail(smsLoginForm, "john@example.com");
+ * ```
+ */
+export declare function setSmsLoginFormEmail(smsLoginForm: SmsLoginForm, value: string): void;
+/**
+ * Sets the marketing consent acceptance value on the SMS login form and re-validates if the form has been submitted.
+ *
+ * @ai-category SMSLogin, Authentication, Validation
+ * @ai-related setSmsLoginFormIsMembershipAgreementAccepted, submitSmsLoginForm
+ *
+ * @param smsLoginForm - The SMS login form instance to update.
+ * @param value - Whether the user has accepted marketing communications.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setSmsLoginFormIsMarketingAccepted } from "@ikas/bp-storefront";
+ * setSmsLoginFormIsMarketingAccepted(smsLoginForm, true);
+ * ```
+ */
+export declare function setSmsLoginFormIsMarketingAccepted(smsLoginForm: SmsLoginForm, value: boolean): void;
+/**
+ * Sets the membership agreement acceptance value on the SMS login form and re-validates if the form has been submitted.
+ *
+ * @ai-category SMSLogin, Authentication, Validation
+ * @ai-related setSmsLoginFormIsMarketingAccepted, submitSmsLoginForm
+ *
+ * @param smsLoginForm - The SMS login form instance to update.
+ * @param value - Whether the user has accepted the membership agreement.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setSmsLoginFormIsMembershipAgreementAccepted } from "@ikas/bp-storefront";
+ * setSmsLoginFormIsMembershipAgreementAccepted(smsLoginForm, true);
+ * ```
+ */
+export declare function setSmsLoginFormIsMembershipAgreementAccepted(smsLoginForm: SmsLoginForm, value: boolean): void;
+/**
+ * Submits the SMS login form, advancing through the multi-step flow: sends an OTP code for the phone number, verifies the OTP code, or completes profile registration depending on the current step.
+ *
+ * @ai-category SMSLogin, Authentication, PhoneVerification, Validation
+ * @ai-related initSmsLoginForm, setSmsLoginFormPhone, setSmsLoginFormCode, resendSmsLoginFormCode
+ *
+ * @param smsLoginForm - The SMS login form instance to submit.
+ * @returns A promise that resolves to `true` if the current step succeeded, or `false` if validation or the request failed.
+ *
+ * @example
+ * ```typescript
+ * import { submitSmsLoginForm } from "@ikas/bp-storefront";
+ * const success = await submitSmsLoginForm(smsLoginForm);
+ * if (success) {
+ *   // Proceed to the next step or handle successful login
+ * }
+ * ```
+ */
+export declare function submitSmsLoginForm(smsLoginForm: SmsLoginForm): Promise<boolean>;
+/**
+ * Resends the OTP verification code to the phone number on the SMS login form. Only operates when the form is on the "Verify Code" step.
+ *
+ * @ai-category SMSLogin, PhoneVerification, Authentication
+ * @ai-related setSmsLoginFormCode, submitSmsLoginForm, setSmsLoginFormPhone
+ *
+ * @param smsLoginForm - The SMS login form instance for which to resend the code.
+ * @returns A promise that resolves when the resend operation completes. Returns early if the form is not on the verification step.
+ *
+ * @example
+ * ```typescript
+ * import { resendSmsLoginFormCode } from "@ikas/bp-storefront";
+ * await resendSmsLoginFormCode(smsLoginForm);
+ * ```
+ */
+export declare function resendSmsLoginFormCode(smsLoginForm: SmsLoginForm): Promise<void>;

package/dist/storefront/src/functions/models/validator/verify-phone-number/index.d.ts

@@ -0,0 +1,69 @@
+import { VerifyPhoneNumberForm } from "../../../../../../storefront-models/src";
+/**
+ * Initializes the phone number verification form with default field values and sets the step to "Enter Phone Number".
+ *
+ * @ai-category Validation, PhoneVerification, Form
+ * @ai-related setVerifyPhoneNumberFormCode, submitVerifyPhoneNumberForm, resendVerifyPhoneNumberFormCode
+ *
+ * @param verifyPhoneNumberForm - The phone number verification form object to initialize
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initVerifyPhoneNumberForm } from "@ikas/bp-storefront";
+ * initVerifyPhoneNumberForm(verifyPhoneNumberForm);
+ * ```
+ */
+export declare function initVerifyPhoneNumberForm(verifyPhoneNumberForm: VerifyPhoneNumberForm): void;
+/**
+ * Sets the verification code field value on the phone number verification form and re-validates if the form has been submitted.
+ *
+ * @ai-category Validation, PhoneVerification, Form
+ * @ai-related initVerifyPhoneNumberForm, submitVerifyPhoneNumberForm, resendVerifyPhoneNumberFormCode
+ *
+ * @param verifyPhoneNumberForm - The phone number verification form object to update
+ * @param value - The verification code string to set
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { setVerifyPhoneNumberFormCode } from "@ikas/bp-storefront";
+ * setVerifyPhoneNumberFormCode(verifyPhoneNumberForm, "123456");
+ * ```
+ */
+export declare function setVerifyPhoneNumberFormCode(verifyPhoneNumberForm: VerifyPhoneNumberForm, value: string): void;
+/**
+ * Validates and submits the phone number verification form, handling the multi-step flow of sending a code and then verifying it.
+ *
+ * @ai-category Validation, PhoneVerification, Form
+ * @ai-related initVerifyPhoneNumberForm, setVerifyPhoneNumberFormCode, resendVerifyPhoneNumberFormCode
+ *
+ * @param verifyPhoneNumberForm - The phone number verification form object to validate and submit
+ * @returns A promise that resolves to true if the current step completed successfully, or false if validation failed or the API returned an error
+ *
+ * @example
+ * ```typescript
+ * import { submitVerifyPhoneNumberForm } from "@ikas/bp-storefront";
+ * const success = await submitVerifyPhoneNumberForm(verifyPhoneNumberForm);
+ * if (success) {
+ *   console.log("Step completed successfully");
+ * }
+ * ```
+ */
+export declare function submitVerifyPhoneNumberForm(verifyPhoneNumberForm: VerifyPhoneNumberForm): Promise<boolean>;
+/**
+ * Resends the phone verification code if the form is currently in the "Verify Code" step.
+ *
+ * @ai-category Validation, PhoneVerification, Form
+ * @ai-related initVerifyPhoneNumberForm, setVerifyPhoneNumberFormCode, submitVerifyPhoneNumberForm
+ *
+ * @param verifyPhoneNumberForm - The phone number verification form object
+ * @returns A promise that resolves when the code has been resent, or returns immediately if not in the correct step
+ *
+ * @example
+ * ```typescript
+ * import { resendVerifyPhoneNumberFormCode } from "@ikas/bp-storefront";
+ * await resendVerifyPhoneNumberFormCode(verifyPhoneNumberForm);
+ * ```
+ */
+export declare function resendVerifyPhoneNumberFormCode(verifyPhoneNumberForm: VerifyPhoneNumberForm): Promise<void>;

package/dist/storefront/src/functions/models/variant-type/index.d.ts

@@ -0,0 +1,37 @@
+import { IkasVariantType } from "../../../../../storefront-models/src";
+/**
+ * Checks whether the given variant type uses color-based selection.
+ *
+ * @ai-category VariantType, ProductVariant
+ * @ai-related getIkasVariantTypeSlug
+ *
+ * @param variantType - The variant type to check.
+ * @returns `true` if the variant type's selection type is "COLOR", `false` otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isIkasVariantTypeColorSelection } from "@ikas/bp-storefront";
+ * const isColor = isIkasVariantTypeColorSelection(variantType);
+ * if (isColor) {
+ *   // render color swatches
+ * }
+ * ```
+ */
+export declare function isIkasVariantTypeColorSelection(variantType: IkasVariantType): boolean;
+/**
+ * Generates a URL-friendly slug from the variant type's name.
+ *
+ * @ai-category VariantType, ProductVariant
+ * @ai-related isIkasVariantTypeColorSelection
+ *
+ * @param variantType - The variant type whose name will be converted to a slug.
+ * @returns A slugified string derived from the variant type's name.
+ *
+ * @example
+ * ```typescript
+ * import { getIkasVariantTypeSlug } from "@ikas/bp-storefront";
+ * const slug = getIkasVariantTypeSlug(variantType);
+ * // e.g. "color" or "size"
+ * ```
+ */
+export declare function getIkasVariantTypeSlug(variantType: IkasVariantType): string;

package/dist/storefront/src/functions/models/variant-type/init.d.ts

@@ -0,0 +1,18 @@
+import { IkasVariantType } from "../../../../../storefront-models/src";
+/**
+ * Initializes a variant type by linking each variant value back to its parent variant type and applying locale-specific translations.
+ *
+ * @ai-category VariantType, Initialization
+ * @ai-related setIkasVariantTypeTranslations
+ *
+ * @param variantType - The variant type to initialize.
+ * @param locale - The locale code to apply translations for, or `null` to skip translations.
+ * @returns void
+ *
+ * @example
+ * ```typescript
+ * import { initIkasVariantType } from "@ikas/bp-storefront";
+ * initIkasVariantType(variantType, "en");
+ * ```
+ */
+export declare function initIkasVariantType(variantType: IkasVariantType, locale: string | null): void;

package/dist/storefront/src/functions/models/variant-type/variant-value/index.d.ts

@@ -0,0 +1,91 @@
+import { IkasImage, IkasVariantValue } from "../../../../../../storefront-models/src";
+/**
+ * Generates a URL-friendly slug from the variant value's name.
+ *
+ * @ai-category VariantValue, ProductVariant
+ * @ai-related getIkasVariantValueThumbnailImage, isColorVariantValue, isImageVariantValue, isTextVariantValue
+ *
+ * @param variantValue - The variant value whose name will be converted to a slug.
+ * @returns A slugified string derived from the variant value's name.
+ *
+ * @example
+ * ```typescript
+ * import { getIkasVariantValueSlug } from "@ikas/bp-storefront";
+ * const slug = getIkasVariantValueSlug(variantValue);
+ * // e.g. "red" or "large"
+ * ```
+ */
+export declare function getIkasVariantValueSlug(variantValue: IkasVariantValue): string;
+/**
+ * Retrieves the thumbnail image associated with a variant value, if one exists.
+ *
+ * @ai-category VariantValue, ProductVariant, Product
+ * @ai-related getIkasVariantValueSlug, isImageVariantValue, isColorVariantValue
+ *
+ * @param variantValue - The variant value to retrieve the thumbnail image for.
+ * @returns An `IkasImage` object if the variant value has a thumbnail image ID, or `undefined` otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { getIkasVariantValueThumbnailImage } from "@ikas/bp-storefront";
+ * const image = getIkasVariantValueThumbnailImage(variantValue);
+ * if (image) {
+ *   // render the thumbnail image
+ * }
+ * ```
+ */
+export declare function getIkasVariantValueThumbnailImage(variantValue: IkasVariantValue): IkasImage | undefined;
+/**
+ * Checks whether the given variant value represents a color by testing for a color code.
+ *
+ * @ai-category VariantValue, ProductVariant
+ * @ai-related isImageVariantValue, isTextVariantValue, getIkasVariantValueThumbnailImage
+ *
+ * @param variantValue - The variant value to check.
+ * @returns `true` if the variant value has a color code, `false` otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isColorVariantValue } from "@ikas/bp-storefront";
+ * if (isColorVariantValue(variantValue)) {
+ *   // render a color swatch using variantValue.colorCode
+ * }
+ * ```
+ */
+export declare function isColorVariantValue(variantValue: IkasVariantValue): boolean;
+/**
+ * Checks whether the given variant value represents an image by testing for a thumbnail image ID.
+ *
+ * @ai-category VariantValue, ProductVariant
+ * @ai-related isColorVariantValue, isTextVariantValue, getIkasVariantValueThumbnailImage
+ *
+ * @param variantValue - The variant value to check.
+ * @returns `true` if the variant value has a thumbnail image ID, `false` otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isImageVariantValue } from "@ikas/bp-storefront";
+ * if (isImageVariantValue(variantValue)) {
+ *   // render the variant as an image thumbnail
+ * }
+ * ```
+ */
+export declare function isImageVariantValue(variantValue: IkasVariantValue): boolean;
+/**
+ * Checks whether the given variant value is a plain text variant (neither color nor image).
+ *
+ * @ai-category VariantValue, ProductVariant
+ * @ai-related isColorVariantValue, isImageVariantValue, getIkasVariantValueSlug
+ *
+ * @param variantValue - The variant value to check.
+ * @returns `true` if the variant value has neither a color code nor a thumbnail image ID, `false` otherwise.
+ *
+ * @example
+ * ```typescript
+ * import { isTextVariantValue } from "@ikas/bp-storefront";
+ * if (isTextVariantValue(variantValue)) {
+ *   // render the variant as plain text (e.g. "Small", "Medium", "Large")
+ * }
+ * ```
+ */
+export declare function isTextVariantValue(variantValue: IkasVariantValue): boolean;