b23-lib 3.8.0 → 3.9.0

package/dist/Product-BywRotdH.d.mts

@@ -0,0 +1,367 @@
+import BaseModel, { BaseAttributes } from './Classes/Base.mjs';
+import { a as PriceModel, P as PriceData, b as Prettify, c as CurrencyCode, f as Color, d as LocalizedString, C as CountryCode, e as LocalizedValue, L as LocaleCode } from './Common-BqhQxCq8.mjs';
+import { GenderCategory, ProductType, ImageCategory } from './Classes/Enum.mjs';
+import ImageInfoModel, { ImageInfoData } from './Classes/ImageInfo.mjs';
+
+declare enum PricingType {
+    VOLUME = "volume",
+    SELECTION = "selection"
+}
+/**
+ * Represents a pricing tier based on a minimum purchase quantity.
+ */
+type PriceTier = {
+    enabled: boolean;
+    minQuantity: number;
+    unitPrice: PriceModel;
+};
+type PriceTierData = {
+    enabled: boolean;
+    minQuantity: number;
+    unitPrice: PriceData;
+};
+/**
+ * Represents the configuration for a specific selection variant.
+ */
+type SelectionPricingData = {
+    selectionAttributes: SelectionAttributes;
+    baseUnitPrice: PriceData;
+    tiers?: PriceTierData[];
+};
+type SelectionPricing = {
+    selectionAttributes: SelectionAttributes;
+    baseUnitPrice: PriceModel;
+    tiers: PriceTier[];
+};
+type PriceTierAttributes = Prettify<Omit<PriceTierData, 'enabled'> & {
+    enabled?: boolean;
+}>;
+/**
+ * Represents the attributes required for tiered pricing.
+ */
+type TieredPriceAttributes = Prettify<{
+    taxCategory: string;
+    isTaxInclusive?: boolean;
+} & ({
+    currency?: CurrencyCode;
+    type?: PricingType.VOLUME;
+    baseUnitPrice: PriceData;
+    tiers?: PriceTierAttributes[];
+} | {
+    currency: CurrencyCode;
+    type: PricingType.SELECTION;
+    selections: (Omit<SelectionPricingData, 'tiers'> & {
+        tiers?: PriceTierAttributes[];
+    })[];
+})>;
+type TieredPriceData = Prettify<{
+    taxCategory: string;
+    isTaxInclusive: boolean;
+    currency: CurrencyCode;
+} & ({
+    type?: PricingType.VOLUME;
+    baseUnitPrice: PriceData;
+    tiers: PriceTierData[];
+} | {
+    type: PricingType.SELECTION;
+    selections: SelectionPricingData[];
+})>;
+declare abstract class TieredPriceModel {
+    protected type: PricingType;
+    protected taxCategory: string;
+    protected isTaxInclusive: boolean;
+    /**
+     * Factory method to instantiate the correct concrete TieredPriceModel implementation.
+     */
+    static create(data: TieredPriceAttributes): TieredPriceModel;
+    constructor(data: TieredPriceAttributes);
+    getType(): PricingType;
+    getTaxCategory(): string;
+    getIsTaxInclusive(): boolean;
+    abstract getBaseUnitPrice(selectionAttributes?: SelectionAttributes): PriceModel;
+    abstract getDetails(): TieredPriceData;
+    abstract getCurrency(): string;
+    abstract getApplicableUnitPrice(quantity: number, selectionAttributes?: SelectionAttributes): PriceModel;
+    abstract getMinQuantity(selectionAttributes?: SelectionAttributes): number;
+    abstract getMaxDiscountPercent(selectionAttributes?: SelectionAttributes): number;
+}
+declare class VolumeTieredPriceModel extends TieredPriceModel {
+    protected baseUnitPrice: PriceModel;
+    protected tiers: PriceTier[];
+    protected currency: CurrencyCode;
+    constructor(data: Extract<TieredPriceAttributes, {
+        type?: PricingType.VOLUME;
+    }>);
+    getBaseUnitPrice(): PriceModel;
+    getCurrency(): string;
+    getApplicableUnitPrice(quantity: number): PriceModel;
+    getMinQuantity(): number;
+    getMaxDiscountPercent(): number;
+    getDetails(): TieredPriceData;
+}
+declare class SelectionTieredPriceModel extends TieredPriceModel {
+    protected currency: CurrencyCode;
+    protected selections: SelectionPricing[];
+    constructor(data: Extract<TieredPriceAttributes, {
+        type: PricingType.SELECTION;
+    }>);
+    protected findMatch(selectionAttributes: SelectionAttributes): SelectionPricing;
+    getBaseUnitPrice(selectionAttributes?: SelectionAttributes): PriceModel;
+    getCurrency(): string;
+    getApplicableUnitPrice(quantity: number, selectionAttributes?: SelectionAttributes): PriceModel;
+    getMinQuantity(selectionAttributes?: SelectionAttributes): number;
+    getMaxDiscountPercent(selectionAttributes?: SelectionAttributes): number;
+    getDetails(): TieredPriceData;
+}
+
+type ProductSelectionAttributes = Prettify<{
+    color: Color[];
+    size: string[];
+} & {
+    [key: string]: string | string[] | Color[];
+}>;
+type SelectionAttributes = {
+    color: Color;
+    [key: string]: string | Color;
+};
+type VariantData = {
+    sku: string;
+    selectionAttributes: SelectionAttributes;
+    images: {
+        primary: ImageInfoData;
+        gallery: ImageInfoData[];
+    };
+};
+type VariantModel = {
+    sku: string;
+    selectionAttributes: SelectionAttributes;
+    images: {
+        primary: ImageInfoModel;
+        gallery: ImageInfoModel[];
+    };
+};
+type ProductSpecification = {
+    [key: string]: string | string[];
+};
+type ProductAttributes = BaseAttributes & {
+    id: string;
+    key: string;
+    name: LocalizedString;
+    description: LocalizedString;
+    slug: LocalizedString;
+    brand: string;
+    pricing: {
+        [country in CountryCode]?: TieredPriceAttributes;
+    };
+    targetGender: GenderCategory;
+    attributes: ProductSelectionAttributes;
+    specifications: LocalizedValue<ProductSpecification>;
+    categories: string[];
+    productType?: ProductType;
+    variants: VariantData[];
+    isActive: boolean;
+    searchTags?: LocalizedValue<string[]>;
+};
+type ProductData = Required<ProductAttributes>;
+declare class ProductModel extends BaseModel {
+    protected id: string;
+    protected key: string;
+    protected name: LocalizedString;
+    protected description: LocalizedString;
+    protected slug: LocalizedString;
+    protected brand: string;
+    protected pricing: {
+        [country in CountryCode]?: TieredPriceModel;
+    };
+    protected variants: VariantModel[];
+    protected targetGender: GenderCategory;
+    protected attributes: ProductSelectionAttributes;
+    protected specifications: LocalizedValue<ProductSpecification>;
+    protected categories: string[];
+    protected productType: ProductType;
+    protected isActive: boolean;
+    protected searchTags: LocalizedValue<string[]>;
+    static productKeyRegex: RegExp;
+    static productSKURegex: RegExp;
+    /**
+     * Generates a unique key for checking uniqueness for a given selection attributes.
+     * Excludes 'size' from the key generation.
+     * @param selectionAttributes - The selection attributes.
+     * @returns A string key representing the unique attribute combination.
+     */
+    static generateSelectionAttributesKey(selectionAttributes: SelectionAttributes): string;
+    /**
+     * Parses a selection attributes key into an object.
+     * @param key - The selection attributes key to parse.
+     * @returns An object containing the parsed selection attributes.
+     */
+    static parseSelectionAttributesKey(key: string): SelectionAttributes;
+    /**
+     * Creates an instance of ProductModel.
+     * Initializes properties based on the provided data, creating copies where necessary.
+     * @param data - The initial product attributes.
+     * @param date - Optional date for setting creation/modification times (defaults to now).
+    */
+    constructor(data: ProductAttributes, date?: Date);
+    /**
+     * Gets the base Product ID.
+     * @returns Product ID.
+    */
+    getId(): string;
+    /**
+     * Gets the user-friendly product key.
+     * @returns Product Key.
+     */
+    getKey(): string;
+    /**
+     * Gets the full localized product name object.
+     * @returns A copy of the LocalizedString object for the name.
+     */
+    getName(): LocalizedString;
+    /**
+     * Gets the product name for a specific locale, falling back to English ('en').
+     * @param locale - The desired locale code.
+     * @returns The name string for the specified locale.
+     */
+    getName(locale: LocaleCode): string;
+    /**
+     * Gets the full localized product description object.
+     * @returns A copy of the LocalizedString object for the description.
+     */
+    getDescription(): LocalizedString;
+    /**
+     * Gets the product description for a specific locale, falling back to English ('en').
+     * @param locale - The desired locale code.
+     * @returns The description string for the specified locale.
+     */
+    getDescription(locale: LocaleCode): string;
+    /**
+     * Gets the full localized product slug object.
+     * @returns A copy of the LocalizedString object for the slug.
+     */
+    getSlug(): LocalizedString;
+    /**
+     * Gets the product slug for a specific locale, falling back to English ('en').
+     * @param locale - The desired locale code.
+     * @returns The slug string for the specified locale.
+     */
+    getSlug(locale: LocaleCode): string;
+    /**
+     * Gets the brand associated with the product.
+     * @returns The brand name string.
+     */
+    getBrand(): string;
+    /**
+     * Gets the tiered price details for the product.
+     * @returns Pricing details mapped by country.
+     */
+    getPriceDetails(): {
+        [country in CountryCode]?: TieredPriceModel;
+    };
+    /**
+     * Gets the tiered price details for a specific country.
+     * @param country - The country code.
+     * @returns The tiered price model for the country, or null if not found.
+     */
+    getPriceDetails(country: CountryCode): TieredPriceModel | null;
+    /**
+     * Gets the variant-specific attributes (color, sizes). Returns copies.
+     * @returns Product Attributes.
+     */
+    getAttributes(): ProductSelectionAttributes;
+    /**
+     * Gets the variant-specific attributes (color, sizes). Returns copies.
+     * @returns Product Attributes.
+     */
+    getVariants(): VariantModel[];
+    /**
+     * Gets the images for a specific selection attribute combination.
+     * @param selectionAttributes - The selection attributes to search for.
+     * @returns The matching image set or null if not found.
+     */
+    private getImagesBySelectionAttributes;
+    /**
+     * Gets the images for a specific selection attribute combination.
+     * @param selectionAttributes - The selection attributes to search for.
+     * @returns The matching image set or null if not found.
+     */
+    getImages(selectionAttributes: SelectionAttributes): {
+        primary: ImageInfoModel;
+        gallery: ImageInfoModel[];
+    };
+    getImages(selectionAttributes: SelectionAttributes, category: ImageCategory.PRIMARY): ImageInfoModel;
+    getImages(selectionAttributes: SelectionAttributes, category: ImageCategory.GALLERY): ImageInfoModel[];
+    /**
+     * Checks if the product is active.
+     * @returns True if the product is active, false otherwise.
+     */
+    getIsActive(): boolean;
+    /**
+     * Gets the target gender category for the product.
+     * @returns The GenderCategory enum value.
+     */
+    getTargetGender(): GenderCategory;
+    /**
+     * Gets the list of categories the product belongs to. Returns a copy.
+     * @returns An array of category.
+     */
+    getCategories(): string[];
+    /**
+     * Gets the product type.
+     * @returns ProductType.
+     */
+    getProductType(): ProductType;
+    /**
+     * Gets the full localized product specifications object.
+     * @returns Product Specifications
+     */
+    getSpecifications(): LocalizedValue<ProductSpecification>;
+    /**
+     * Gets the product specifications for a specific locale, falling back to English ('en').
+     * @param locale - The desired locale code.
+     * @returns The ProductSpecification object for the specified locale, or undefined if not found.
+     */
+    getSpecifications(locale: LocaleCode): ProductSpecification;
+    /**
+     * Gets the localized list of search tags. Returns a copy.
+     * @returns Localized array of search tags.
+     */
+    getSearchTags(): LocalizedValue<string[]>;
+    /**
+     * Gets the search tags for a specific locale, falling back to English ('en').
+     * @param locale - The desired locale code.
+     * @returns The array of search tags for the specified locale, or undefined if not found.
+     */
+    getSearchTags(locale: LocaleCode): string[];
+    /**
+     *
+     * @returns ProductData
+     */
+    getDetails(): ProductData;
+    /**
+     * Checks if the provided selection attributes are valid for the product.
+     * @param selectionAttributes The selection attributes to validate.
+     * @throws {SelectionAttributeParseError} If the selection attributes are invalid.
+     */
+    checkSelectionAttributes(selectionAttributes: SelectionAttributes): void;
+    /**
+     * Gets the SKU of the variant matching the selection attributes.
+     * @param selectionAttributes - The selection attributes to search for.
+     * @returns The SKU string, or undefined if no matching variant is found.
+     */
+    getSku(selectionAttributes: SelectionAttributes): string | undefined;
+    /**
+     * Validates if the provided selection attributes exist for this product.
+     * @param selectionAttributes - The attributes to validate.
+     * @returns True if a valid selection attribute exists, false otherwise.
+     */
+    validateSelectionAttribute(selectionAttributes: SelectionAttributes): boolean;
+    /**
+     * Validates if a specific size is available for this product.
+     * @param size - The size to check.
+     * @returns True if the size exists in the product's attributes, false otherwise.
+     */
+    validateSize(size: string): boolean;
+}
+
+export { ProductModel as P, type SelectionAttributes as S, type TieredPriceData as T, VolumeTieredPriceModel as V, TieredPriceModel as a, type ProductSpecification as b, PricingType as c, type PriceTier as d, type PriceTierData as e, type SelectionPricingData as f, type SelectionPricing as g, type PriceTierAttributes as h, type TieredPriceAttributes as i, SelectionTieredPriceModel as j, type ProductSelectionAttributes as k, type VariantData as l, type VariantModel as m, type ProductAttributes as n, type ProductData as o };