b23-lib 1.7.0 → 1.7.2

package/dist/Classes/Product.d.ts

@@ -0,0 +1,209 @@
+import BaseModel, { BaseAttributes } from './Base.js';
+import { LocalizedString, BasePriceList, PriceTierList, Color, LocaleCode, CountryCode } from './Common.js';
+import { GenderCategory } from './Enum.js';
+import ImageInfoModel, { ImageInfoData } from './ImageInfo.js';
+
+type ProductVariantIdentifier = {
+    key: string;
+    variantId: string;
+};
+type ProductHashKey = {
+    id: string;
+    variantId: string;
+};
+type ProductAttributes = BaseAttributes & {
+    id: string;
+    key: string;
+    variantId: string;
+    name: LocalizedString;
+    description: LocalizedString;
+    slug: LocalizedString;
+    brand: string;
+    basePrices: BasePriceList;
+    priceTiers: PriceTierList;
+    attributes: {
+        color: Color;
+        sizes: string[];
+    };
+    primaryImage: ImageInfoData;
+    additionalImages?: ImageInfoData[];
+    isActive: boolean;
+    targetGender: GenderCategory;
+    categories: string[];
+    specifications: {
+        [locale: string]: {
+            [key: string]: string | string[];
+        };
+    };
+    searchTags?: string[];
+};
+type ProductData = Required<ProductAttributes>;
+type ProductSpecification = {
+    [key: string]: string | string[];
+};
+type LocalizedProductSpecification = {
+    en: ProductSpecification;
+} & {
+    [locale in LocaleCode]?: ProductSpecification;
+};
+declare class ProductModel extends BaseModel {
+    protected id: string;
+    protected key: string;
+    protected variantId: string;
+    protected name: LocalizedString;
+    protected description: LocalizedString;
+    protected slug: LocalizedString;
+    protected brand: string;
+    protected basePrices: BasePriceList;
+    protected priceTiers: PriceTierList;
+    protected attributes: {
+        color: Color;
+        sizes: string[];
+    };
+    protected primaryImage: ImageInfoModel;
+    protected additionalImages: ImageInfoModel[];
+    protected isActive: boolean;
+    protected targetGender: GenderCategory;
+    protected categories: string[];
+    protected specifications: LocalizedProductSpecification;
+    protected searchTags: string[];
+    static productKeyRegex: RegExp;
+    static variantIdRegex: RegExp;
+    /**
+     * 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 specific Variant ID.
+     * @returns Variant ID.
+     */
+    getVariantId(): 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 list of base prices. Returns copies of the price objects.
+     * Optionally filters by country.
+     * @param country - Optional country code to filter prices for.
+     * @returns A list of base prices (or an empty list if none match).
+     */
+    getBasePrices(country?: CountryCode): BasePriceList;
+    /**
+     * Gets the list of quantity-based price tiers. Returns copies of the tier objects.
+     * Optionally filters by country.
+     * @param country - Optional country code to filter tiers for.
+     * @returns A list of price tiers (or an empty list if none match or none exist).
+     */
+    getPriceTiers(country?: CountryCode): PriceTierList;
+    /**
+     * Gets the variant-specific attributes (color, sizes). Returns copies.
+     * @returns Product Attributes.
+     */
+    getAttributes(): {
+        color: Color;
+        sizes: string[];
+    };
+    /**
+     * Gets details of product's primary image.
+     * @returns The ImageInfoModel instance for the primary image.
+     */
+    getPrimaryImage(): ImageInfoModel;
+    /**
+     * Gets the list of additional product images.
+     * @returns An array of ImageInfoModel instances.
+     */
+    getAdditionalImages(): ImageInfoModel[];
+    /**
+     * Checks if the product variant 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 full localized product specifications object.
+     * @returns Product Specifications
+     */
+    getSpecifications(): LocalizedProductSpecification;
+    /**
+     * 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 | undefined;
+    /**
+     * Gets the list of search tags. Returns a copy.
+     * @returns An array of search tags.
+     */
+    getSearchTags(): string[];
+    /**
+     *
+     * @returns ProductData
+     */
+    getDetails(): ProductData;
+    /**
+     * Calculates the maximum potential discount percentage for a given country
+     * based on the lowest price tier compared to the base price.
+     * @param country - The country code to calculate the discount for.
+     * @returns The maximum discount percentage (0-100), or 0 if calculation is not possible.
+     */
+    getMaxDiscountPercent(country: CountryCode): number;
+}
+
+export { type LocalizedProductSpecification, type ProductAttributes, type ProductData, type ProductHashKey, type ProductSpecification, type ProductVariantIdentifier, ProductModel as default };

package/dist/Classes/Product.js

@@ -0,0 +1,2 @@
+'use strict';var n=class{customFields;version;createdAt;modifiedAt;modifiedBy;constructor(e,t=new Date){this.customFields={...e.customFields},this.version=e.version??1,this.createdAt=e.createdAt&&!isNaN(Date.parse(e.createdAt))?new Date(e.createdAt).toISOString():t.toISOString(),this.modifiedAt=e.modifiedAt&&!isNaN(Date.parse(e.modifiedAt))?new Date(e.modifiedAt).toISOString():t.toISOString(),this.modifiedBy=e.modifiedBy??"";}getDetails(){return {customFields:this.getAllCustomFields(),version:this.getVersion(),createdAt:this.getCreatedAt(),modifiedAt:this.getModifiedAt(),modifiedBy:this.getModifiedBy()}}getVersion(){return this.version}getCreatedAt(){return this.createdAt}getCreatedAtTime(){return new Date(this.createdAt).getTime()}getModifiedAt(){return this.modifiedAt}getModifiedAtTime(){return new Date(this.modifiedAt).getTime()}getModifiedBy(){return this.modifiedBy}setModifiedBy(e){this.modifiedBy=e;}getCustomField(e){return this.customFields[e]??null}setCustomField(e,t){this.customFields[e]=t;}getAllCustomFields(){return {...this.customFields}}};var r=class{sources;alt;order;label;constructor(e){if(this.sources={...e.sources},this.alt=e.alt,this.order=e.order,this.label=e.label,!this.sources.original)throw "ImageInfoModel cannot be created without an 'original' source URL."}getSources(){return {...this.sources}}getSource(e){return this.sources[e]||this.sources.original}getAlt(){return this.alt}getOrder(){return this.order}getLabel(){return this.label}setAlt(e){this.alt=e;}setOrder(e){this.order=e;}setLabel(e){this.label=e;}setSource(e,t){if(t===void 0){if(e==="original")throw "Cannot remove the 'original' image source.";delete this.sources[e];}else this.sources[e]=t;}getDetails(){return {sources:this.getSources(),alt:this.getAlt(),order:this.getOrder(),label:this.getLabel()}}};var o=class extends n{id;key;variantId;name;description;slug;brand;basePrices;priceTiers;attributes;primaryImage;additionalImages;isActive;targetGender;categories;specifications;searchTags;static productKeyRegex=/^(?!\s)(?!.*\s$)[A-Z0-9-]{4,16}$/;static variantIdRegex=/^(?!\s)(?!.*\s$)[A-Z0-9-]{4,16}$/;constructor(e,t=new Date){super(e,t),this.id=e.id,this.key=e.key,this.variantId=e.variantId,this.name=e.name,this.description=e.description,this.slug=e.slug,this.brand=e.brand,this.basePrices=e.basePrices.map(i=>({...i})),this.priceTiers=e.priceTiers?e.priceTiers.map(i=>({...i})):e.basePrices.map(i=>({...i})),this.attributes={...e.attributes,sizes:[...e.attributes.sizes]},this.primaryImage=new r(e.primaryImage),this.additionalImages=(e.additionalImages||[]).map(i=>new r(i)),this.isActive=e.isActive,this.targetGender=e.targetGender,this.categories=[...e.categories],this.specifications=JSON.parse(JSON.stringify({...e.specifications})),this.searchTags=e.searchTags?[...e.searchTags]:[];}getId(){return this.id}getKey(){return this.key}getVariantId(){return this.variantId}getName(e){return e?this.name[e]??this.name.en:{...this.name}}getDescription(e){return e?this.description[e]??this.description.en:{...this.description}}getSlug(e){return e?this.slug[e]??this.slug.en:{...this.slug}}getBrand(){return this.brand}getBasePrices(e){return (e?this.basePrices.filter(i=>i.country===e):this.basePrices).map(i=>({...i}))}getPriceTiers(e){return (e?this.priceTiers.filter(i=>i.country===e):this.priceTiers).map(i=>({...i}))}getAttributes(){return {...this.attributes,color:{...this.attributes.color},sizes:[...this.attributes.sizes]}}getPrimaryImage(){return this.primaryImage}getAdditionalImages(){return this.additionalImages}getIsActive(){return this.isActive}getTargetGender(){return this.targetGender}getCategories(){return [...this.categories]}getSpecifications(e){return e?this.specifications[e]??this.specifications.en:JSON.parse(JSON.stringify(this.specifications))}getSearchTags(){return [...this.searchTags]}getDetails(){let e=super.getDetails();return {id:this.getId(),key:this.getKey(),variantId:this.getVariantId(),name:this.getName(),description:this.getDescription(),slug:this.getSlug(),brand:this.getBrand(),basePrices:this.getBasePrices(),priceTiers:this.getPriceTiers(),attributes:this.getAttributes(),primaryImage:this.getPrimaryImage().getDetails(),additionalImages:this.getAdditionalImages().map(t=>t.getDetails()),isActive:this.getIsActive(),targetGender:this.getTargetGender(),categories:this.getCategories(),specifications:this.getSpecifications(),searchTags:this.getSearchTags(),...e}}getMaxDiscountPercent(e){let t=this.basePrices.find(s=>s.country===e),i=this.priceTiers?.filter(s=>s.country===e).sort((s,d)=>s.unitPrice-d.unitPrice)[0]?.unitPrice;return !t||t.unitPrice<=0||i===void 0?0:Math.max(0,t.unitPrice-i)/t.unitPrice*100}};module.exports=o;//# sourceMappingURL=Product.js.map
+//# sourceMappingURL=Product.js.map

package/dist/Classes/Product.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/Classes/Base.ts","../../src/Classes/ImageInfo.ts","../../src/Classes/Product.ts"],"names":["BaseModel","data","date","modifiedBy","fieldName","value","ImageInfoModel","resolutionKey","altText","order","label","url","ProductModel","price","tier","image","locale","country","baseDetails","basePrice","lowestTierPrice","a","b"],"mappings":"aA0BA,IAAqBA,CAAAA,CAArB,KAA+B,CACnB,YAAA,CACA,QACA,SACA,CAAA,UAAA,CACA,UAQV,CAAA,WAAA,CAAYC,CAAsBC,CAAAA,CAAAA,CAAa,IAAI,IAAQ,CAAA,CACzD,KAAK,YAAe,CAAA,CAAE,GAAGD,CAAK,CAAA,YAAa,CAC3C,CAAA,IAAA,CAAK,OAAUA,CAAAA,CAAAA,CAAK,SAAW,CAC/B,CAAA,IAAA,CAAK,UAAYA,CAAK,CAAA,SAAA,EAAa,CAAC,KAAM,CAAA,IAAA,CAAK,KAAMA,CAAAA,CAAAA,CAAK,SAAS,CAAC,EAElE,IAAI,IAAA,CAAKA,CAAK,CAAA,SAAS,CAAE,CAAA,WAAA,GAEzBC,CAAK,CAAA,WAAA,EACP,CAAA,IAAA,CAAK,UAAaD,CAAAA,CAAAA,CAAK,YAAc,CAAC,KAAA,CAAM,KAAK,KAAMA,CAAAA,CAAAA,CAAK,UAAU,CAAC,CAAA,CACnE,IAAI,IAAA,CAAKA,CAAK,CAAA,UAAU,EAAE,WAAY,EAAA,CACtCC,CAAK,CAAA,WAAA,EAET,CAAA,IAAA,CAAK,WAAaD,CAAK,CAAA,UAAA,EAAc,GACvC,CAMA,UAAuB,EAAA,CACrB,OAAO,CACL,YAAA,CAAc,KAAK,kBAAmB,EAAA,CACtC,QAAS,IAAK,CAAA,UAAA,EACd,CAAA,SAAA,CAAW,IAAK,CAAA,YAAA,GAChB,UAAY,CAAA,IAAA,CAAK,aAAc,EAAA,CAC/B,UAAY,CAAA,IAAA,CAAK,eACnB,CACF,CAMA,UAAA,EAAqB,CACnB,OAAO,KAAK,OACd,CAMA,cAAuB,CACrB,OAAO,KAAK,SACd,CAMA,gBAA2B,EAAA,CACzB,OAAO,IAAI,KAAK,IAAK,CAAA,SAAS,CAAE,CAAA,OAAA,EAClC,CAOA,eAAwB,CACtB,OAAO,IAAK,CAAA,UACd,CAMA,iBAAA,EAA4B,CAC1B,OAAO,IAAI,KAAK,IAAK,CAAA,UAAU,EAAE,OAAQ,EAC3C,CAMA,aAAA,EAAwB,CACtB,OAAO,KAAK,UACd,CAMA,aAAcE,CAAAA,CAAAA,CAA0B,CACtC,IAAA,CAAK,WAAaA,EACpB,CAOA,cAAeC,CAAAA,CAAAA,CAAwB,CACrC,OAAO,KAAK,YAAaA,CAAAA,CAAS,GAAK,IACzC,CAQA,eAAeA,CAAmBC,CAAAA,CAAAA,CAAkB,CAClD,IAAA,CAAK,YAAaD,CAAAA,CAAS,EAAIC,EACjC,CAMA,kBAAmC,EAAA,CACjC,OAAO,CAAE,GAAG,IAAK,CAAA,YAAa,CAChC,CACF,CCnIA,CAAA,IAAqBC,EAArB,KAAoC,CACxB,QACA,GACA,CAAA,KAAA,CACA,MAMV,WAAYL,CAAAA,CAAAA,CAA0B,CAMpC,GALA,IAAK,CAAA,OAAA,CAAU,CAAE,GAAGA,CAAAA,CAAK,OAAQ,CAAA,CACjC,IAAK,CAAA,GAAA,CAAMA,EAAK,GAChB,CAAA,IAAA,CAAK,KAAQA,CAAAA,CAAAA,CAAK,KAClB,CAAA,IAAA,CAAK,MAAQA,CAAK,CAAA,KAAA,CAEd,CAAC,IAAK,CAAA,OAAA,CAAQ,SACd,MAAO,oEAEb,CAMA,UAAA,EAAa,CACX,OAAO,CAAE,GAAG,IAAA,CAAK,OAAQ,CAC3B,CAOA,UAAUM,CAAuC,CAAA,CAC/C,OAAO,IAAA,CAAK,OAAQA,CAAAA,CAAa,GAAK,IAAK,CAAA,OAAA,CAAQ,QACrD,CAKA,MAAA,EAA6B,CAC3B,OAAO,IAAA,CAAK,GACd,CAKA,QAA+B,EAAA,CAC7B,OAAO,IAAK,CAAA,KACd,CAKA,QAAA,EAA+B,CAC7B,OAAO,KAAK,KACd,CAMA,MAAOC,CAAAA,CAAAA,CAAmC,CACxC,IAAA,CAAK,IAAMA,EAEb,CAMA,SAASC,CAAiC,CAAA,CACxC,KAAK,KAAQA,CAAAA,EACf,CAMA,QAAA,CAASC,CAAiC,CAAA,CACxC,KAAK,KAAQA,CAAAA,EACf,CAOA,SAAA,CAAUH,CAAgCI,CAAAA,CAAAA,CAA+B,CACrE,GAAIA,CAAAA,GAAQ,KAAW,CAAA,CAAA,CAEnB,GAAIJ,CAAAA,GAAkB,WAClB,MAAO,4CAAA,CAGX,OAAO,IAAK,CAAA,OAAA,CAAQA,CAAa,EACrC,CAAA,KACI,IAAK,CAAA,OAAA,CAAQA,CAAa,CAAA,CAAII,EAEtC,CAKA,UAAA,EAA4B,CAC1B,OAAO,CACL,OAAA,CAAS,KAAK,UAAW,EAAA,CACzB,GAAK,CAAA,IAAA,CAAK,MAAO,EAAA,CACjB,MAAO,IAAK,CAAA,QAAA,GACZ,KAAO,CAAA,IAAA,CAAK,UACd,CACF,CACF,CAAA,CC/EqBC,IAAAA,CAAAA,CAArB,cAA0CZ,CAAU,CACtC,EACA,CAAA,GAAA,CACA,SAEA,CAAA,IAAA,CACA,YACA,IACA,CAAA,KAAA,CAEA,UACA,CAAA,UAAA,CAEA,UAKA,CAAA,YAAA,CACA,iBAEA,QACA,CAAA,YAAA,CACA,WACA,cACA,CAAA,UAAA,CAEV,OAAO,eAAkB,CAAA,kCAAA,CACzB,OAAO,cAAA,CAAiB,kCAQxB,CAAA,WAAA,CAAYC,EAAyBC,CAAa,CAAA,IAAI,IAAQ,CAAA,CAC1D,KAAMD,CAAAA,CAAAA,CAAMC,CAAI,CAChB,CAAA,IAAA,CAAK,EAAKD,CAAAA,CAAAA,CAAK,EACf,CAAA,IAAA,CAAK,IAAMA,CAAK,CAAA,GAAA,CAChB,KAAK,SAAYA,CAAAA,CAAAA,CAAK,UACtB,IAAK,CAAA,IAAA,CAAOA,CAAK,CAAA,IAAA,CACjB,IAAK,CAAA,WAAA,CAAcA,EAAK,WACxB,CAAA,IAAA,CAAK,IAAOA,CAAAA,CAAAA,CAAK,IACjB,CAAA,IAAA,CAAK,MAAQA,CAAK,CAAA,KAAA,CAElB,IAAK,CAAA,UAAA,CAAaA,CAAK,CAAA,UAAA,CAAW,IAAIY,CAAU,GAAA,CAAE,GAAGA,CAAM,CAAA,CAAE,EAC7D,IAAK,CAAA,UAAA,CAAaZ,CAAK,CAAA,UAAA,CACrBA,CAAK,CAAA,UAAA,CAAW,IAAIa,CAAS,GAAA,CAAE,GAAGA,CAAK,CAAE,CAAA,CAAA,CAEzCb,EAAK,UAAW,CAAA,GAAA,CAAIY,CAAU,GAAA,CAAE,GAAGA,CAAM,EAAE,CAE7C,CAAA,IAAA,CAAK,WAAa,CACd,GAAGZ,EAAK,UACR,CAAA,KAAA,CAAO,CAAC,GAAGA,CAAK,CAAA,UAAA,CAAW,KAAK,CACpC,CAAA,CAEA,KAAK,YAAe,CAAA,IAAIK,EAAeL,CAAK,CAAA,YAAY,CACxD,CAAA,IAAA,CAAK,gBAAoBA,CAAAA,CAAAA,CAAAA,CAAK,kBAAoB,EAAC,EAAG,IAAIc,CAAS,EAAA,IAAIT,EAAeS,CAAK,CAAC,CAC5F,CAAA,IAAA,CAAK,QAAWd,CAAAA,CAAAA,CAAK,SACrB,IAAK,CAAA,YAAA,CAAeA,CAAK,CAAA,YAAA,CACzB,IAAK,CAAA,UAAA,CAAa,CAAC,GAAGA,CAAAA,CAAK,UAAU,CAAA,CACrC,IAAK,CAAA,cAAA,CAAiB,KAAK,KAAM,CAAA,IAAA,CAAK,UAAU,CAAE,GAAGA,EAAK,cAAe,CAAC,CAAC,CAAA,CAC3E,IAAK,CAAA,UAAA,CAAaA,EAAK,UAAa,CAAA,CAAC,GAAGA,CAAAA,CAAK,UAAU,CAAA,CAAI,GAC/D,CAMF,KAAgB,EAAA,CACZ,OAAO,IAAA,CAAK,EAChB,CAMA,MAAA,EAAiB,CACb,OAAO,IAAA,CAAK,GAChB,CAMA,YAAA,EAAuB,CACnB,OAAO,IAAK,CAAA,SAChB,CAaA,OAAQe,CAAAA,CAAAA,CAA+C,CACrD,OAAGA,CACM,CAAA,IAAA,CAAK,KAAKA,CAAM,CAAA,EAAK,IAAK,CAAA,IAAA,CAAK,EAE/B,CAAA,CAAE,GAAG,IAAK,CAAA,IAAK,CAE1B,CAaA,cAAA,CAAeA,EAAgD,CAC7D,OAAGA,CACM,CAAA,IAAA,CAAK,WAAYA,CAAAA,CAAM,GAAK,IAAK,CAAA,WAAA,CAAY,EAE7C,CAAA,CAAE,GAAG,IAAA,CAAK,WAAY,CAEjC,CAaA,OAAQA,CAAAA,CAAAA,CAA+C,CACrD,OAAIA,EACK,IAAK,CAAA,IAAA,CAAKA,CAAM,CAAK,EAAA,IAAA,CAAK,KAAK,EAE/B,CAAA,CAAE,GAAG,IAAA,CAAK,IAAK,CAE1B,CAMA,QAAmB,EAAA,CACf,OAAO,IAAA,CAAK,KAChB,CAQA,cAAcC,CAAsC,CAAA,CAElD,OADuBA,CAAAA,CAAAA,CAAU,IAAK,CAAA,UAAA,CAAW,OAAOJ,CAASA,EAAAA,CAAAA,CAAM,UAAYI,CAAO,CAAA,CAAI,KAAK,UAC7E,EAAA,GAAA,CAAIJ,CAAU,GAAA,CAAE,GAAGA,CAAM,EAAE,CACnD,CAQA,aAAcI,CAAAA,CAAAA,CAAsC,CAElD,OAAA,CADsBA,EAAU,IAAK,CAAA,UAAA,CAAW,MAAOH,CAAAA,CAAAA,EAAQA,CAAK,CAAA,OAAA,GAAYG,CAAO,CAAI,CAAA,IAAA,CAAK,YAC3E,GAAIH,CAAAA,CAAAA,GAAS,CAAE,GAAGA,CAAK,CAAE,CAAA,CAChD,CAMA,aAAA,EAAmD,CAC/C,OAAO,CACH,GAAG,IAAA,CAAK,UACR,CAAA,KAAA,CAAO,CAAE,GAAG,IAAA,CAAK,UAAW,CAAA,KAAM,CAClC,CAAA,KAAA,CAAO,CAAC,GAAG,IAAA,CAAK,WAAW,KAAK,CACpC,CACJ,CAMA,eAAA,EAAkC,CAC9B,OAAO,IAAK,CAAA,YAChB,CAMA,mBAAwC,EAAA,CACpC,OAAO,IAAK,CAAA,gBAChB,CAMA,WAAuB,EAAA,CACnB,OAAO,IAAA,CAAK,QAChB,CAMA,iBAAkC,CAC9B,OAAO,KAAK,YAChB,CAMA,eAA0B,CACtB,OAAO,CAAC,GAAG,IAAK,CAAA,UAAU,CAC9B,CAaA,iBAAA,CAAkBE,CAAuF,CAAA,CACrG,OAAGA,CAAAA,CACM,KAAK,cAAeA,CAAAA,CAAM,CAAK,EAAA,IAAA,CAAK,cAAe,CAAA,EAAA,CAEnD,KAAK,KAAM,CAAA,IAAA,CAAK,UAAU,IAAK,CAAA,cAAc,CAAC,CAE3D,CAMA,aAA0B,EAAA,CACtB,OAAO,CAAC,GAAG,IAAK,CAAA,UAAU,CAC9B,CAMA,UAA0B,EAAA,CACtB,IAAME,CAAc,CAAA,KAAA,CAAM,UAAW,EAAA,CACrC,OAAO,CACH,GAAI,IAAK,CAAA,KAAA,GACT,GAAK,CAAA,IAAA,CAAK,QACV,CAAA,SAAA,CAAW,IAAK,CAAA,YAAA,EAChB,CAAA,IAAA,CAAM,KAAK,OAAQ,EAAA,CACnB,WAAa,CAAA,IAAA,CAAK,cAAe,EAAA,CACjC,KAAM,IAAK,CAAA,OAAA,EACX,CAAA,KAAA,CAAO,IAAK,CAAA,QAAA,GACZ,UAAY,CAAA,IAAA,CAAK,eACjB,CAAA,UAAA,CAAY,KAAK,aAAc,EAAA,CAC/B,UAAY,CAAA,IAAA,CAAK,aAAc,EAAA,CAC/B,aAAc,IAAK,CAAA,eAAA,EAAkB,CAAA,UAAA,EACrC,CAAA,gBAAA,CAAkB,KAAK,mBAAoB,EAAA,CAAE,GAAIH,CAAAA,CAAAA,EAASA,CAAM,CAAA,UAAA,EAAY,CAC5E,CAAA,QAAA,CAAU,KAAK,WAAY,EAAA,CAC3B,aAAc,IAAK,CAAA,eAAA,EACnB,CAAA,UAAA,CAAY,IAAK,CAAA,aAAA,GACjB,cAAgB,CAAA,IAAA,CAAK,iBAAkB,EAAA,CACvC,UAAY,CAAA,IAAA,CAAK,eACjB,CAAA,GAAGG,CACP,CACJ,CAQA,qBAAA,CAAsBD,EAA8B,CAElD,IAAME,EAAY,IAAK,CAAA,UAAA,CAAW,KAAKN,CAASA,EAAAA,CAAAA,CAAM,OAAYI,GAAAA,CAAO,CAGnEG,CAAAA,CAAAA,CAAkB,KAAK,UACC,EAAA,MAAA,CAAON,CAAQA,EAAAA,CAAAA,CAAK,OAAYG,GAAAA,CAAO,EACxC,IAAK,CAAA,CAACI,CAAGC,CAAAA,CAAAA,GAAMD,CAAE,CAAA,SAAA,CAAYC,EAAE,SAAS,CAAA,CAAE,CAAC,CAAG,EAAA,SAAA,CAG3E,OAAI,CAACH,CAAAA,EAAaA,CAAU,CAAA,SAAA,EAAa,CAAKC,EAAAA,CAAAA,GAAoB,OACvD,CAIM,CAAA,IAAA,CAAK,GAAI,CAAA,CAAA,CAAGD,CAAU,CAAA,SAAA,CAAYC,CAAe,CAG/CD,CAAAA,CAAAA,CAAU,SAAa,CAAA,GAC5C,CACF","file":"Product.js","sourcesContent":["import { ISODateTime } from \"./Common\";\r\n\r\nexport interface CustomFields {\r\n  [key: string]: any;\r\n}\r\n\r\nexport type BaseAttributes = {\r\n  customFields?: CustomFields;\r\n  version?: number;\r\n  createdAt?: ISODateTime;\r\n  modifiedAt?: ISODateTime;\r\n  modifiedBy?: string;\r\n};\r\n\r\nexport type BaseData = {\r\n  customFields: CustomFields;\r\n  version: number;\r\n  createdAt: ISODateTime;\r\n  modifiedAt: ISODateTime;\r\n  modifiedBy: string;\r\n};\r\n\r\n/**\r\n * Provides common foundational properties and methods for other data models.\r\n * Handles tracking of custom fields, versioning, and timestamps.\r\n */\r\nexport default class BaseModel {\r\n  protected customFields: CustomFields;\r\n  protected version: number;\r\n  protected createdAt: ISODateTime;\r\n  protected modifiedAt: ISODateTime;\r\n  protected modifiedBy: string;\r\n\r\n  /**\r\n   * Creates an instance of BaseModel.\r\n   * Initializes common properties like timestamps, version, and custom fields.\r\n   * @param data - Optional initial attributes for the base model.\r\n   * @param date - Optional date object to use for default timestamps (defaults to current time).\r\n   */\r\n  constructor(data: BaseAttributes, date: Date = new Date()) {\r\n    this.customFields = { ...data.customFields };\r\n    this.version = data.version ?? 1;\r\n    this.createdAt = data.createdAt && !isNaN(Date.parse(data.createdAt))\r\n      ?\r\n      new Date(data.createdAt).toISOString()\r\n      :\r\n      date.toISOString();\r\n    this.modifiedAt = data.modifiedAt && !isNaN(Date.parse(data.modifiedAt))\r\n      ? new Date(data.modifiedAt).toISOString()\r\n      : date.toISOString();\r\n\r\n    this.modifiedBy = data.modifiedBy ?? '';\r\n  }\r\n\r\n  /**\r\n   * Gets a plain data object representing the base model's current state.\r\n   * @returns BaseData object containing common properties.\r\n   */\r\n  getDetails(): BaseData {\r\n    return {\r\n      customFields: this.getAllCustomFields(), // Use getter to return a copy\r\n      version: this.getVersion(),\r\n      createdAt: this.getCreatedAt(),\r\n      modifiedAt: this.getModifiedAt(),\r\n      modifiedBy: this.getModifiedBy(),\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Gets the current version number of the model instance.\r\n   * @returns The version number.\r\n   */\r\n  getVersion(): number {\r\n    return this.version;\r\n  }\r\n\r\n  /**\r\n   * Gets the creation timestamp as an ISO 8601 string.\r\n   * @returns The creation timestamp string.\r\n   */\r\n  getCreatedAt(): string {\r\n    return this.createdAt;\r\n  }\r\n\r\n  /**\r\n   * Gets the creation timestamp as a Unix epoch time (milliseconds).\r\n   * @returns The creation time in milliseconds since the epoch.\r\n   */\r\n  getCreatedAtTime(): number {\r\n    return new Date(this.createdAt).getTime();\r\n  }\r\n\r\n\r\n  /**\r\n   * Gets the last modification timestamp as an ISO 8601 string.\r\n   * @returns The last modification timestamp string.\r\n   */\r\n  getModifiedAt(): string {\r\n    return this.modifiedAt;\r\n  }\r\n\r\n  /**\r\n   * Gets the last modification timestamp as a Unix epoch time (milliseconds).\r\n   * @returns The last modification time in milliseconds since the epoch.\r\n   */\r\n  getModifiedAtTime(): number {\r\n    return new Date(this.modifiedAt).getTime();\r\n  }\r\n\r\n  /**\r\n   * Gets the identifier of the user or process that last modified the instance.\r\n   * @returns The modifier identifier string.\r\n   */\r\n  getModifiedBy(): string {\r\n    return this.modifiedBy;\r\n  }\r\n\r\n  /**\r\n   * Sets the identifier of the user or process that last modified the instance.\r\n   * @param modifiedBy - The identifier string.\r\n   */\r\n  setModifiedBy(modifiedBy: string): void {\r\n    this.modifiedBy = modifiedBy;\r\n  }\r\n\r\n  /**\r\n   * Retrieves the value of a specific custom field.\r\n   * @param fieldName - The name (key) of the custom field to retrieve.\r\n   * @returns The value of the custom field, or null if the field does not exist.\r\n   */\r\n  getCustomField(fieldName: string): any {\r\n    return this.customFields[fieldName] ?? null;\r\n  }\r\n\r\n  /**\r\n   * Sets the value of a specific custom field.\r\n   * Also updates the modification timestamp and increments the version.\r\n   * @param fieldName - The name (key) of the custom field to set.\r\n   * @param value - The value to assign to the custom field.\r\n   */\r\n  setCustomField(fieldName: string, value: any): void {\r\n    this.customFields[fieldName] = value;\r\n  }\r\n\r\n  /**\r\n   * Retrieves a shallow copy of all custom fields associated with the instance.\r\n   * @returns An object containing all custom fields.\r\n   */\r\n  getAllCustomFields(): CustomFields {\r\n    return { ...this.customFields };\r\n  }\r\n}\r\n","export enum ImageResolution {\r\n  THUMBNAIL = 'thumbnail',\r\n  SMALL = 'small',\r\n  MEDIUM = 'medium',\r\n  LARGE = 'large',\r\n  ORIGINAL = 'original',\r\n}\r\n\r\nexport type ImageInfoAttribute = {\r\n  sources: { [key in ImageResolution]?: string } & { original: string };\r\n  alt?: string;\r\n  order?: number;\r\n  label?: string;\r\n};\r\n\r\nexport type ImageInfoData = ImageInfoAttribute;\r\n\r\n/**\r\n * Represents and manages structured image data, including multiple resolutions.\r\n */\r\nexport default class ImageInfoModel {\r\n  protected sources: { [key in ImageResolution]?: string } & { original: string };\r\n  protected alt?: string;\r\n  protected order?: number;\r\n  protected label?: string;\r\n\r\n  /**\r\n   * Creates an instance of ImageInfoModel.\r\n   * @param data - The initial image data.\r\n   */\r\n  constructor(data: ImageInfoAttribute) {\r\n    this.sources = { ...data.sources };\r\n    this.alt = data.alt;\r\n    this.order = data.order;\r\n    this.label = data.label;\r\n\r\n    if (!this.sources.original) {\r\n        throw (\"ImageInfoModel cannot be created without an 'original' source URL.\");\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Gets the sources object containing URLs for different resolutions.\r\n   * Returns a copy to prevent external modification.\r\n   */\r\n  getSources() {\r\n    return { ...this.sources };\r\n  }\r\n\r\n  /**\r\n   * Gets the URL for a specific resolution key.\r\n   * @param resolutionKey - The key of the desired resolution (e.g., 'thumbnail', 'medium').\r\n   * @returns The URL string if the key doesn't exist, otherwise original image URL will be returned.\r\n   */\r\n  getSource(resolutionKey: ImageResolution): string{\r\n    return this.sources[resolutionKey] || this.sources.original;\r\n  }\r\n\r\n  /**\r\n   * Gets the alternative text for the image.\r\n   */\r\n  getAlt(): string | undefined {\r\n    return this.alt;\r\n  }\r\n\r\n  /**\r\n   * Gets the display order number for the image.\r\n   */\r\n  getOrder(): number | undefined {\r\n    return this.order;\r\n  }\r\n\r\n  /**\r\n   * Gets the display label or caption for the image.\r\n   */\r\n  getLabel(): string | undefined {\r\n    return this.label;\r\n  }\r\n\r\n  /**\r\n   * Sets the alternative text for the image.\r\n   * @param altText - The new alt text.\r\n   */\r\n  setAlt(altText: string | undefined): void {\r\n    this.alt = altText;\r\n    // Potentially add logic here to trigger updates if needed\r\n  }\r\n\r\n  /**\r\n   * Sets the display order for the image.\r\n   * @param order - The new order number.\r\n   */\r\n  setOrder(order: number | undefined): void {\r\n    this.order = order;\r\n  }\r\n\r\n   /**\r\n   * Sets the display label for the image.\r\n   * @param label - The new label text.\r\n   */\r\n  setLabel(label: string | undefined): void {\r\n    this.label = label;\r\n  }\r\n\r\n  /**\r\n   * Updates or adds a URL for a specific resolution.\r\n   * @param resolutionKey - The key of the resolution to update/add.\r\n   * @param url - The URL for the resolution. Set to undefined to remove.\r\n   */\r\n  setSource(resolutionKey: ImageResolution, url: string | undefined): void {\r\n      if (url === undefined) {\r\n          // Prevent deleting the 'original' key if it's required\r\n          if (resolutionKey === 'original') {\r\n              throw (\"Cannot remove the 'original' image source.\");\r\n              return;\r\n          }\r\n          delete this.sources[resolutionKey];\r\n      } else {\r\n          this.sources[resolutionKey] = url;\r\n      }\r\n  }\r\n\r\n  /**\r\n   * Returns a plain JavaScript object representation of the image info.\r\n   */\r\n  getDetails(): ImageInfoData {\r\n    return {\r\n      sources: this.getSources(),\r\n      alt: this.getAlt(),\r\n      order: this.getOrder(),\r\n      label: this.getLabel(),\r\n    };\r\n  }\r\n}","import BaseModel, { BaseAttributes } from \"./Base\";\r\nimport { BasePriceList, PriceTierList, Color, LocalizedString, CountryCode, LocaleCode } from './Common';\r\nimport { GenderCategory } from \"./Enum\";\r\nimport ImageInfoModel, { ImageInfoData } from \"./ImageInfo\";\r\n\r\nexport type ProductVariantIdentifier =  {\r\n  key: string;\r\n  variantId: string;\r\n};\r\n\r\nexport type ProductHashKey = {\r\n  id: string;\r\n  variantId: string;\r\n}\r\n\r\nexport type ProductAttributes = BaseAttributes & {\r\n    id: string;\r\n    key: string;\r\n    variantId: string;\r\n\r\n    name: LocalizedString;\r\n    description: LocalizedString;\r\n    slug: LocalizedString;\r\n    brand: string;\r\n\r\n    basePrices: BasePriceList;\r\n    priceTiers: PriceTierList;\r\n\r\n    attributes: {\r\n      color: Color;\r\n      sizes: string[];\r\n    };\r\n\r\n    primaryImage: ImageInfoData;\r\n    additionalImages?: ImageInfoData[];\r\n\r\n    // Metadata & Categorization\r\n    isActive: boolean;\r\n    targetGender: GenderCategory;\r\n    categories: string[];\r\n    specifications: { [locale: string]: { [key: string]: string | string[] } };\r\n    searchTags?: string[];\r\n};\r\n\r\nexport type ProductData = Required<ProductAttributes>\r\n\r\nexport type ProductSpecification = { [key: string]: string | string[] };\r\n\r\nexport type LocalizedProductSpecification = {\r\n  en: ProductSpecification\r\n} & {\r\n  [locale in LocaleCode]?: ProductSpecification\r\n}\r\n\r\nexport default class ProductModel extends BaseModel {\r\n    protected id: string;\r\n    protected key: string;\r\n    protected variantId: string;\r\n\r\n    protected name: LocalizedString;\r\n    protected description: LocalizedString;\r\n    protected slug: LocalizedString;\r\n    protected brand: string;\r\n\r\n    protected basePrices: BasePriceList;\r\n    protected priceTiers: PriceTierList;\r\n\r\n    protected attributes: {\r\n      color: Color;\r\n      sizes: string[];\r\n    };\r\n\r\n    protected primaryImage: ImageInfoModel;\r\n    protected additionalImages: ImageInfoModel[];\r\n\r\n    protected isActive: boolean;\r\n    protected targetGender: GenderCategory;\r\n    protected categories: string[];\r\n    protected specifications: LocalizedProductSpecification;\r\n    protected searchTags: string[];\r\n\r\n    static productKeyRegex = /^(?!\\s)(?!.*\\s$)[A-Z0-9-]{4,16}$/;\r\n    static variantIdRegex = /^(?!\\s)(?!.*\\s$)[A-Z0-9-]{4,16}$/;\r\n\r\n    /**\r\n     * Creates an instance of ProductModel.\r\n     * Initializes properties based on the provided data, creating copies where necessary.\r\n     * @param data - The initial product attributes.\r\n     * @param date - Optional date for setting creation/modification times (defaults to now).\r\n    */\r\n    constructor(data: ProductAttributes, date: Date = new Date()) {\r\n        super(data, date);\r\n        this.id = data.id;\r\n        this.key = data.key;\r\n        this.variantId = data.variantId;\r\n        this.name = data.name;\r\n        this.description = data.description;\r\n        this.slug = data.slug;\r\n        this.brand = data.brand;\r\n\r\n        this.basePrices = data.basePrices.map(price => ({ ...price }));\r\n        this.priceTiers = data.priceTiers ? \r\n          data.priceTiers.map(tier => ({ ...tier })) \r\n          : \r\n          data.basePrices.map(price => ({ ...price }));;\r\n\r\n        this.attributes = {\r\n            ...data.attributes,\r\n            sizes: [...data.attributes.sizes]\r\n        };\r\n\r\n        this.primaryImage = new ImageInfoModel(data.primaryImage);\r\n        this.additionalImages = (data.additionalImages || []).map(image => new ImageInfoModel(image));\r\n        this.isActive = data.isActive;\r\n        this.targetGender = data.targetGender;\r\n        this.categories = [...data.categories];\r\n        this.specifications = JSON.parse(JSON.stringify({ ...data.specifications }));\r\n        this.searchTags = data.searchTags ? [...data.searchTags] : [];\r\n    }\r\n\r\n  /**\r\n   * Gets the base Product ID.\r\n   * @returns Product ID.\r\n  */\r\n  getId(): string {\r\n      return this.id;\r\n  }\r\n\r\n  /**\r\n   * Gets the user-friendly product key.\r\n   * @returns Product Key.\r\n   */\r\n  getKey(): string {\r\n      return this.key;\r\n  }\r\n\r\n  /**\r\n   * Gets the specific Variant ID.\r\n   * @returns Variant ID.\r\n   */\r\n  getVariantId(): string {\r\n      return this.variantId;\r\n  }\r\n\r\n  /**\r\n   * Gets the full localized product name object.\r\n   * @returns A copy of the LocalizedString object for the name.\r\n   */\r\n  getName(): LocalizedString\r\n  /**\r\n   * Gets the product name for a specific locale, falling back to English ('en').\r\n   * @param locale - The desired locale code.\r\n   * @returns The name string for the specified locale.\r\n   */\r\n  getName(locale: LocaleCode): string\r\n  getName(locale?: LocaleCode): LocalizedString | string {\r\n    if(locale) {\r\n      return this.name[locale] ?? this.name.en;\r\n    } else {\r\n      return { ...this.name };\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Gets the full localized product description object.\r\n   * @returns A copy of the LocalizedString object for the description.\r\n   */\r\n  getDescription(): LocalizedString\r\n  /**\r\n   * Gets the product description for a specific locale, falling back to English ('en').\r\n   * @param locale - The desired locale code.\r\n   * @returns The description string for the specified locale.\r\n   */\r\n  getDescription(locale: LocaleCode): string\r\n  getDescription(locale?: LocaleCode): LocalizedString | string  {\r\n    if(locale){\r\n      return this.description[locale] ?? this.description.en;\r\n    } else {\r\n      return { ...this.description };\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Gets the full localized product slug object.\r\n   * @returns A copy of the LocalizedString object for the slug.\r\n   */\r\n  getSlug(): LocalizedString\r\n  /**\r\n   * Gets the product slug for a specific locale, falling back to English ('en').\r\n   * @param locale - The desired locale code.\r\n   * @returns The slug string for the specified locale.\r\n   */\r\n  getSlug(locale: LocaleCode): string\r\n  getSlug(locale?: LocaleCode): LocalizedString | string {\r\n    if (locale) {\r\n      return this.slug[locale] ?? this.slug.en;\r\n    } else {\r\n      return { ...this.slug };\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Gets the brand associated with the product.\r\n   * @returns The brand name string.\r\n   */\r\n  getBrand(): string {\r\n      return this.brand;\r\n  }\r\n\r\n  /**\r\n   * Gets the list of base prices. Returns copies of the price objects.\r\n   * Optionally filters by country.\r\n   * @param country - Optional country code to filter prices for.\r\n   * @returns A list of base prices (or an empty list if none match).\r\n   */\r\n  getBasePrices(country?: CountryCode): BasePriceList {\r\n    const filteredPrices = country ? this.basePrices.filter(price => price.country === country) : this.basePrices;\r\n    return filteredPrices.map(price => ({ ...price }));\r\n  }\r\n\r\n  /**\r\n   * Gets the list of quantity-based price tiers. Returns copies of the tier objects.\r\n   * Optionally filters by country.\r\n   * @param country - Optional country code to filter tiers for.\r\n   * @returns A list of price tiers (or an empty list if none match or none exist).\r\n   */\r\n  getPriceTiers(country?: CountryCode): PriceTierList {\r\n    const filteredTiers = country ? this.priceTiers.filter(tier => tier.country === country) : this.priceTiers;\r\n    return filteredTiers.map(tier => ({ ...tier }));\r\n  }\r\n\r\n  /**\r\n   * Gets the variant-specific attributes (color, sizes). Returns copies.\r\n   * @returns Product Attributes.\r\n   */\r\n  getAttributes(): { color: Color; sizes: string[] } {\r\n      return {\r\n          ...this.attributes,\r\n          color: { ...this.attributes.color }, // Copy color object\r\n          sizes: [...this.attributes.sizes]\r\n      };\r\n  }\r\n\r\n  /**\r\n   * Gets details of product's primary image.\r\n   * @returns The ImageInfoModel instance for the primary image.\r\n   */\r\n  getPrimaryImage(): ImageInfoModel {\r\n      return this.primaryImage;\r\n  }\r\n\r\n  /**\r\n   * Gets the list of additional product images.\r\n   * @returns An array of ImageInfoModel instances.\r\n   */\r\n  getAdditionalImages(): ImageInfoModel[] {\r\n      return this.additionalImages;\r\n  }\r\n\r\n  /**\r\n   * Checks if the product variant is active.\r\n   * @returns True if the product is active, false otherwise.\r\n   */\r\n  getIsActive(): boolean {\r\n      return this.isActive;\r\n  }\r\n\r\n  /**\r\n   * Gets the target gender category for the product.\r\n   * @returns The GenderCategory enum value.\r\n   */\r\n  getTargetGender(): GenderCategory {\r\n      return this.targetGender;\r\n  }\r\n\r\n  /**\r\n   * Gets the list of categories the product belongs to. Returns a copy.\r\n   * @returns An array of category.\r\n   */\r\n  getCategories(): string[] {\r\n      return [...this.categories];\r\n  }\r\n\r\n  /**\r\n   * Gets the full localized product specifications object.\r\n   * @returns Product Specifications\r\n   */\r\n  getSpecifications(): LocalizedProductSpecification\r\n  /**\r\n   * Gets the product specifications for a specific locale, falling back to English ('en').\r\n   * @param locale - The desired locale code.\r\n   * @returns The ProductSpecification object for the specified locale, or undefined if not found.\r\n   */\r\n  getSpecifications(locale: LocaleCode): ProductSpecification | undefined\r\n  getSpecifications(locale?: LocaleCode): LocalizedProductSpecification | ProductSpecification | undefined {\r\n      if(locale){\r\n        return this.specifications[locale] ?? this.specifications.en;\r\n      } else {\r\n        return JSON.parse(JSON.stringify(this.specifications));\r\n      }\r\n  }\r\n\r\n  /**\r\n   * Gets the list of search tags. Returns a copy.\r\n   * @returns An array of search tags.\r\n   */\r\n  getSearchTags(): string[] {\r\n      return [...this.searchTags];\r\n  }\r\n\r\n  /**\r\n   *\r\n   * @returns ProductData\r\n   */\r\n  getDetails(): ProductData {\r\n      const baseDetails = super.getDetails();\r\n      return {\r\n          id: this.getId(),\r\n          key: this.getKey(),\r\n          variantId: this.getVariantId(),\r\n          name: this.getName(),\r\n          description: this.getDescription(),\r\n          slug: this.getSlug(),\r\n          brand: this.getBrand(),\r\n          basePrices: this.getBasePrices(),\r\n          priceTiers: this.getPriceTiers(),\r\n          attributes: this.getAttributes(),\r\n          primaryImage: this.getPrimaryImage().getDetails(),\r\n          additionalImages: this.getAdditionalImages().map(image => image.getDetails()),\r\n          isActive: this.getIsActive(),\r\n          targetGender: this.getTargetGender(),\r\n          categories: this.getCategories(),\r\n          specifications: this.getSpecifications(),\r\n          searchTags: this.getSearchTags(),\r\n          ...baseDetails\r\n      }; \r\n  }\r\n\r\n  /**\r\n   * Calculates the maximum potential discount percentage for a given country\r\n   * based on the lowest price tier compared to the base price.\r\n   * @param country - The country code to calculate the discount for.\r\n   * @returns The maximum discount percentage (0-100), or 0 if calculation is not possible.\r\n   */\r\n  getMaxDiscountPercent(country: CountryCode): number {\r\n    // Find base price for the country (should be unique per country)\r\n    const basePrice = this.basePrices.find(price => price.country === country);\r\n\r\n    // Find the lowest unit price among tiers for the country\r\n    const lowestTierPrice = this.priceTiers\r\n                                ?.filter(tier => tier.country === country) // Filter tiers for the country first\r\n                                .sort((a, b) => a.unitPrice - b.unitPrice)[0]?.unitPrice; // Then sort and get lowest\r\n\r\n    // Validate prices before calculation\r\n    if (!basePrice || basePrice.unitPrice <= 0 || lowestTierPrice === undefined) {\r\n        return 0; // Cannot calculate discount\r\n    }\r\n\r\n    // Calculate discount, ensuring it's not negative\r\n    const discount = Math.max(0, basePrice.unitPrice - lowestTierPrice);\r\n\r\n    // Calculate percentage\r\n    return (discount / basePrice.unitPrice) * 100;\r\n  }\r\n}"]}

package/dist/Classes/Product.mjs

@@ -0,0 +1,2 @@
+import {b}from'../chunk-DKI6BDWK.mjs';import {a}from'../chunk-SPLTJRHG.mjs';var n=class extends a{id;key;variantId;name;description;slug;brand;basePrices;priceTiers;attributes;primaryImage;additionalImages;isActive;targetGender;categories;specifications;searchTags;static productKeyRegex=/^(?!\s)(?!.*\s$)[A-Z0-9-]{4,16}$/;static variantIdRegex=/^(?!\s)(?!.*\s$)[A-Z0-9-]{4,16}$/;constructor(e,i=new Date){super(e,i),this.id=e.id,this.key=e.key,this.variantId=e.variantId,this.name=e.name,this.description=e.description,this.slug=e.slug,this.brand=e.brand,this.basePrices=e.basePrices.map(t=>({...t})),this.priceTiers=e.priceTiers?e.priceTiers.map(t=>({...t})):e.basePrices.map(t=>({...t})),this.attributes={...e.attributes,sizes:[...e.attributes.sizes]},this.primaryImage=new b(e.primaryImage),this.additionalImages=(e.additionalImages||[]).map(t=>new b(t)),this.isActive=e.isActive,this.targetGender=e.targetGender,this.categories=[...e.categories],this.specifications=JSON.parse(JSON.stringify({...e.specifications})),this.searchTags=e.searchTags?[...e.searchTags]:[];}getId(){return this.id}getKey(){return this.key}getVariantId(){return this.variantId}getName(e){return e?this.name[e]??this.name.en:{...this.name}}getDescription(e){return e?this.description[e]??this.description.en:{...this.description}}getSlug(e){return e?this.slug[e]??this.slug.en:{...this.slug}}getBrand(){return this.brand}getBasePrices(e){return (e?this.basePrices.filter(t=>t.country===e):this.basePrices).map(t=>({...t}))}getPriceTiers(e){return (e?this.priceTiers.filter(t=>t.country===e):this.priceTiers).map(t=>({...t}))}getAttributes(){return {...this.attributes,color:{...this.attributes.color},sizes:[...this.attributes.sizes]}}getPrimaryImage(){return this.primaryImage}getAdditionalImages(){return this.additionalImages}getIsActive(){return this.isActive}getTargetGender(){return this.targetGender}getCategories(){return [...this.categories]}getSpecifications(e){return e?this.specifications[e]??this.specifications.en:JSON.parse(JSON.stringify(this.specifications))}getSearchTags(){return [...this.searchTags]}getDetails(){let e=super.getDetails();return {id:this.getId(),key:this.getKey(),variantId:this.getVariantId(),name:this.getName(),description:this.getDescription(),slug:this.getSlug(),brand:this.getBrand(),basePrices:this.getBasePrices(),priceTiers:this.getPriceTiers(),attributes:this.getAttributes(),primaryImage:this.getPrimaryImage().getDetails(),additionalImages:this.getAdditionalImages().map(i=>i.getDetails()),isActive:this.getIsActive(),targetGender:this.getTargetGender(),categories:this.getCategories(),specifications:this.getSpecifications(),searchTags:this.getSearchTags(),...e}}getMaxDiscountPercent(e){let i=this.basePrices.find(r=>r.country===e),t=this.priceTiers?.filter(r=>r.country===e).sort((r,c)=>r.unitPrice-c.unitPrice)[0]?.unitPrice;return !i||i.unitPrice<=0||t===void 0?0:Math.max(0,i.unitPrice-t)/i.unitPrice*100}};export{n as default};//# sourceMappingURL=Product.mjs.map
+//# sourceMappingURL=Product.mjs.map

package/dist/Classes/Product.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/Classes/Product.ts"],"names":["ProductModel","BaseModel","data","date","price","tier","ImageInfoModel","image","locale","country","baseDetails","basePrice","lowestTierPrice","a","b"],"mappings":"4EAsDA,IAAqBA,CAArB,CAAA,cAA0CC,CAAU,CACtC,EACA,CAAA,GAAA,CACA,SAEA,CAAA,IAAA,CACA,WACA,CAAA,IAAA,CACA,KAEA,CAAA,UAAA,CACA,UAEA,CAAA,UAAA,CAKA,YACA,CAAA,gBAAA,CAEA,QACA,CAAA,YAAA,CACA,UACA,CAAA,cAAA,CACA,UAEV,CAAA,OAAO,eAAkB,CAAA,kCAAA,CACzB,OAAO,cAAA,CAAiB,kCAQxB,CAAA,WAAA,CAAYC,EAAyBC,CAAa,CAAA,IAAI,IAAQ,CAAA,CAC1D,KAAMD,CAAAA,CAAAA,CAAMC,CAAI,CAAA,CAChB,IAAK,CAAA,EAAA,CAAKD,CAAK,CAAA,EAAA,CACf,IAAK,CAAA,GAAA,CAAMA,CAAK,CAAA,GAAA,CAChB,IAAK,CAAA,SAAA,CAAYA,CAAK,CAAA,SAAA,CACtB,IAAK,CAAA,IAAA,CAAOA,CAAK,CAAA,IAAA,CACjB,IAAK,CAAA,WAAA,CAAcA,CAAK,CAAA,WAAA,CACxB,IAAK,CAAA,IAAA,CAAOA,CAAK,CAAA,IAAA,CACjB,KAAK,KAAQA,CAAAA,CAAAA,CAAK,KAElB,CAAA,IAAA,CAAK,UAAaA,CAAAA,CAAAA,CAAK,UAAW,CAAA,GAAA,CAAIE,CAAU,GAAA,CAAE,GAAGA,CAAM,CAAE,CAAA,CAAA,CAC7D,IAAK,CAAA,UAAA,CAAaF,CAAK,CAAA,UAAA,CACrBA,CAAK,CAAA,UAAA,CAAW,GAAIG,CAAAA,CAAAA,GAAS,CAAE,GAAGA,CAAK,CAAA,CAAE,CAEzCH,CAAAA,CAAAA,CAAK,UAAW,CAAA,GAAA,CAAIE,CAAU,GAAA,CAAE,GAAGA,CAAM,CAAA,CAAE,CAE7C,CAAA,IAAA,CAAK,UAAa,CAAA,CACd,GAAGF,CAAAA,CAAK,UACR,CAAA,KAAA,CAAO,CAAC,GAAGA,CAAK,CAAA,UAAA,CAAW,KAAK,CACpC,CAEA,CAAA,IAAA,CAAK,YAAe,CAAA,IAAII,CAAeJ,CAAAA,CAAAA,CAAK,YAAY,CAAA,CACxD,IAAK,CAAA,gBAAA,CAAA,CAAoBA,CAAK,CAAA,gBAAA,EAAoB,EAAC,EAAG,GAAIK,CAAAA,CAAAA,EAAS,IAAID,CAAeC,CAAAA,CAAK,CAAC,CAAA,CAC5F,IAAK,CAAA,QAAA,CAAWL,CAAK,CAAA,QAAA,CACrB,IAAK,CAAA,YAAA,CAAeA,CAAK,CAAA,YAAA,CACzB,IAAK,CAAA,UAAA,CAAa,CAAC,GAAGA,CAAK,CAAA,UAAU,CACrC,CAAA,IAAA,CAAK,cAAiB,CAAA,IAAA,CAAK,KAAM,CAAA,IAAA,CAAK,SAAU,CAAA,CAAE,GAAGA,CAAAA,CAAK,cAAe,CAAC,CAAC,CAAA,CAC3E,KAAK,UAAaA,CAAAA,CAAAA,CAAK,UAAa,CAAA,CAAC,GAAGA,CAAAA,CAAK,UAAU,CAAA,CAAI,GAC/D,CAMF,KAAA,EAAgB,CACZ,OAAO,IAAK,CAAA,EAChB,CAMA,MAAA,EAAiB,CACb,OAAO,IAAK,CAAA,GAChB,CAMA,YAAA,EAAuB,CACnB,OAAO,IAAK,CAAA,SAChB,CAaA,OAAA,CAAQM,CAA+C,CAAA,CACrD,OAAGA,CACM,CAAA,IAAA,CAAK,IAAKA,CAAAA,CAAM,CAAK,EAAA,IAAA,CAAK,IAAK,CAAA,EAAA,CAE/B,CAAE,GAAG,IAAK,CAAA,IAAK,CAE1B,CAaA,cAAeA,CAAAA,CAAAA,CAAgD,CAC7D,OAAGA,CACM,CAAA,IAAA,CAAK,WAAYA,CAAAA,CAAM,CAAK,EAAA,IAAA,CAAK,WAAY,CAAA,EAAA,CAE7C,CAAE,GAAG,IAAK,CAAA,WAAY,CAEjC,CAaA,QAAQA,CAA+C,CAAA,CACrD,OAAIA,CAAAA,CACK,IAAK,CAAA,IAAA,CAAKA,CAAM,CAAA,EAAK,IAAK,CAAA,IAAA,CAAK,EAE/B,CAAA,CAAE,GAAG,IAAA,CAAK,IAAK,CAE1B,CAMA,QAAA,EAAmB,CACf,OAAO,IAAK,CAAA,KAChB,CAQA,aAAA,CAAcC,CAAsC,CAAA,CAElD,OADuBA,CAAAA,CAAAA,CAAU,IAAK,CAAA,UAAA,CAAW,MAAOL,CAAAA,CAAAA,EAASA,EAAM,OAAYK,GAAAA,CAAO,CAAI,CAAA,IAAA,CAAK,UAC7E,EAAA,GAAA,CAAIL,CAAU,GAAA,CAAE,GAAGA,CAAM,CAAE,CAAA,CACnD,CAQA,aAAA,CAAcK,CAAsC,CAAA,CAElD,OADsBA,CAAAA,CAAAA,CAAU,IAAK,CAAA,UAAA,CAAW,MAAOJ,CAAAA,CAAAA,EAAQA,CAAK,CAAA,OAAA,GAAYI,CAAO,CAAA,CAAI,IAAK,CAAA,UAAA,EAC3E,GAAIJ,CAAAA,CAAAA,GAAS,CAAE,GAAGA,CAAK,CAAE,CAAA,CAChD,CAMA,aAAA,EAAmD,CAC/C,OAAO,CACH,GAAG,IAAK,CAAA,UAAA,CACR,KAAO,CAAA,CAAE,GAAG,IAAA,CAAK,UAAW,CAAA,KAAM,CAClC,CAAA,KAAA,CAAO,CAAC,GAAG,IAAK,CAAA,UAAA,CAAW,KAAK,CACpC,CACJ,CAMA,eAAkC,EAAA,CAC9B,OAAO,IAAA,CAAK,YAChB,CAMA,qBAAwC,CACpC,OAAO,IAAK,CAAA,gBAChB,CAMA,WAAA,EAAuB,CACnB,OAAO,IAAK,CAAA,QAChB,CAMA,eAAA,EAAkC,CAC9B,OAAO,IAAK,CAAA,YAChB,CAMA,aAAA,EAA0B,CACtB,OAAO,CAAC,GAAG,IAAK,CAAA,UAAU,CAC9B,CAaA,iBAAkBG,CAAAA,CAAAA,CAAuF,CACrG,OAAGA,CACM,CAAA,IAAA,CAAK,eAAeA,CAAM,CAAA,EAAK,IAAK,CAAA,cAAA,CAAe,EAEnD,CAAA,IAAA,CAAK,KAAM,CAAA,IAAA,CAAK,SAAU,CAAA,IAAA,CAAK,cAAc,CAAC,CAE3D,CAMA,aAA0B,EAAA,CACtB,OAAO,CAAC,GAAG,IAAA,CAAK,UAAU,CAC9B,CAMA,UAAA,EAA0B,CACtB,IAAME,CAAc,CAAA,KAAA,CAAM,UAAW,EAAA,CACrC,OAAO,CACH,GAAI,IAAK,CAAA,KAAA,EACT,CAAA,GAAA,CAAK,IAAK,CAAA,MAAA,EACV,CAAA,SAAA,CAAW,IAAK,CAAA,YAAA,EAChB,CAAA,IAAA,CAAM,IAAK,CAAA,OAAA,EACX,CAAA,WAAA,CAAa,IAAK,CAAA,cAAA,EAClB,CAAA,IAAA,CAAM,IAAK,CAAA,OAAA,EACX,CAAA,KAAA,CAAO,IAAK,CAAA,QAAA,EACZ,CAAA,UAAA,CAAY,IAAK,CAAA,aAAA,EACjB,CAAA,UAAA,CAAY,KAAK,aAAc,EAAA,CAC/B,UAAY,CAAA,IAAA,CAAK,aAAc,EAAA,CAC/B,YAAc,CAAA,IAAA,CAAK,eAAgB,EAAA,CAAE,UAAW,EAAA,CAChD,gBAAkB,CAAA,IAAA,CAAK,mBAAoB,EAAA,CAAE,GAAIH,CAAAA,CAAAA,EAASA,CAAM,CAAA,UAAA,EAAY,CAAA,CAC5E,QAAU,CAAA,IAAA,CAAK,WAAY,EAAA,CAC3B,YAAc,CAAA,IAAA,CAAK,eAAgB,EAAA,CACnC,UAAY,CAAA,IAAA,CAAK,eACjB,CAAA,cAAA,CAAgB,IAAK,CAAA,iBAAA,EACrB,CAAA,UAAA,CAAY,IAAK,CAAA,aAAA,EACjB,CAAA,GAAGG,CACP,CACJ,CAQA,qBAAA,CAAsBD,CAA8B,CAAA,CAElD,IAAME,CAAAA,CAAY,IAAK,CAAA,UAAA,CAAW,IAAKP,CAAAA,CAAAA,EAASA,CAAM,CAAA,OAAA,GAAYK,CAAO,CAAA,CAGnEG,CAAkB,CAAA,IAAA,CAAK,UACC,EAAA,MAAA,CAAOP,CAAQA,EAAAA,CAAAA,CAAK,UAAYI,CAAO,CAAA,CACxC,IAAK,CAAA,CAACI,CAAGC,CAAAA,CAAAA,GAAMD,CAAE,CAAA,SAAA,CAAYC,CAAE,CAAA,SAAS,CAAE,CAAA,CAAC,CAAG,EAAA,SAAA,CAG3E,OAAI,CAACH,CAAaA,EAAAA,CAAAA,CAAU,SAAa,EAAA,CAAA,EAAKC,CAAoB,GAAA,KAAA,CAAA,CACvD,CAIM,CAAA,IAAA,CAAK,GAAI,CAAA,CAAA,CAAGD,CAAU,CAAA,SAAA,CAAYC,CAAe,CAAA,CAG/CD,CAAU,CAAA,SAAA,CAAa,GAC5C,CACF","file":"Product.mjs","sourcesContent":["import BaseModel, { BaseAttributes } from \"./Base\";\r\nimport { BasePriceList, PriceTierList, Color, LocalizedString, CountryCode, LocaleCode } from './Common';\r\nimport { GenderCategory } from \"./Enum\";\r\nimport ImageInfoModel, { ImageInfoData } from \"./ImageInfo\";\r\n\r\nexport type ProductVariantIdentifier =  {\r\n  key: string;\r\n  variantId: string;\r\n};\r\n\r\nexport type ProductHashKey = {\r\n  id: string;\r\n  variantId: string;\r\n}\r\n\r\nexport type ProductAttributes = BaseAttributes & {\r\n    id: string;\r\n    key: string;\r\n    variantId: string;\r\n\r\n    name: LocalizedString;\r\n    description: LocalizedString;\r\n    slug: LocalizedString;\r\n    brand: string;\r\n\r\n    basePrices: BasePriceList;\r\n    priceTiers: PriceTierList;\r\n\r\n    attributes: {\r\n      color: Color;\r\n      sizes: string[];\r\n    };\r\n\r\n    primaryImage: ImageInfoData;\r\n    additionalImages?: ImageInfoData[];\r\n\r\n    // Metadata & Categorization\r\n    isActive: boolean;\r\n    targetGender: GenderCategory;\r\n    categories: string[];\r\n    specifications: { [locale: string]: { [key: string]: string | string[] } };\r\n    searchTags?: string[];\r\n};\r\n\r\nexport type ProductData = Required<ProductAttributes>\r\n\r\nexport type ProductSpecification = { [key: string]: string | string[] };\r\n\r\nexport type LocalizedProductSpecification = {\r\n  en: ProductSpecification\r\n} & {\r\n  [locale in LocaleCode]?: ProductSpecification\r\n}\r\n\r\nexport default class ProductModel extends BaseModel {\r\n    protected id: string;\r\n    protected key: string;\r\n    protected variantId: string;\r\n\r\n    protected name: LocalizedString;\r\n    protected description: LocalizedString;\r\n    protected slug: LocalizedString;\r\n    protected brand: string;\r\n\r\n    protected basePrices: BasePriceList;\r\n    protected priceTiers: PriceTierList;\r\n\r\n    protected attributes: {\r\n      color: Color;\r\n      sizes: string[];\r\n    };\r\n\r\n    protected primaryImage: ImageInfoModel;\r\n    protected additionalImages: ImageInfoModel[];\r\n\r\n    protected isActive: boolean;\r\n    protected targetGender: GenderCategory;\r\n    protected categories: string[];\r\n    protected specifications: LocalizedProductSpecification;\r\n    protected searchTags: string[];\r\n\r\n    static productKeyRegex = /^(?!\\s)(?!.*\\s$)[A-Z0-9-]{4,16}$/;\r\n    static variantIdRegex = /^(?!\\s)(?!.*\\s$)[A-Z0-9-]{4,16}$/;\r\n\r\n    /**\r\n     * Creates an instance of ProductModel.\r\n     * Initializes properties based on the provided data, creating copies where necessary.\r\n     * @param data - The initial product attributes.\r\n     * @param date - Optional date for setting creation/modification times (defaults to now).\r\n    */\r\n    constructor(data: ProductAttributes, date: Date = new Date()) {\r\n        super(data, date);\r\n        this.id = data.id;\r\n        this.key = data.key;\r\n        this.variantId = data.variantId;\r\n        this.name = data.name;\r\n        this.description = data.description;\r\n        this.slug = data.slug;\r\n        this.brand = data.brand;\r\n\r\n        this.basePrices = data.basePrices.map(price => ({ ...price }));\r\n        this.priceTiers = data.priceTiers ? \r\n          data.priceTiers.map(tier => ({ ...tier })) \r\n          : \r\n          data.basePrices.map(price => ({ ...price }));;\r\n\r\n        this.attributes = {\r\n            ...data.attributes,\r\n            sizes: [...data.attributes.sizes]\r\n        };\r\n\r\n        this.primaryImage = new ImageInfoModel(data.primaryImage);\r\n        this.additionalImages = (data.additionalImages || []).map(image => new ImageInfoModel(image));\r\n        this.isActive = data.isActive;\r\n        this.targetGender = data.targetGender;\r\n        this.categories = [...data.categories];\r\n        this.specifications = JSON.parse(JSON.stringify({ ...data.specifications }));\r\n        this.searchTags = data.searchTags ? [...data.searchTags] : [];\r\n    }\r\n\r\n  /**\r\n   * Gets the base Product ID.\r\n   * @returns Product ID.\r\n  */\r\n  getId(): string {\r\n      return this.id;\r\n  }\r\n\r\n  /**\r\n   * Gets the user-friendly product key.\r\n   * @returns Product Key.\r\n   */\r\n  getKey(): string {\r\n      return this.key;\r\n  }\r\n\r\n  /**\r\n   * Gets the specific Variant ID.\r\n   * @returns Variant ID.\r\n   */\r\n  getVariantId(): string {\r\n      return this.variantId;\r\n  }\r\n\r\n  /**\r\n   * Gets the full localized product name object.\r\n   * @returns A copy of the LocalizedString object for the name.\r\n   */\r\n  getName(): LocalizedString\r\n  /**\r\n   * Gets the product name for a specific locale, falling back to English ('en').\r\n   * @param locale - The desired locale code.\r\n   * @returns The name string for the specified locale.\r\n   */\r\n  getName(locale: LocaleCode): string\r\n  getName(locale?: LocaleCode): LocalizedString | string {\r\n    if(locale) {\r\n      return this.name[locale] ?? this.name.en;\r\n    } else {\r\n      return { ...this.name };\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Gets the full localized product description object.\r\n   * @returns A copy of the LocalizedString object for the description.\r\n   */\r\n  getDescription(): LocalizedString\r\n  /**\r\n   * Gets the product description for a specific locale, falling back to English ('en').\r\n   * @param locale - The desired locale code.\r\n   * @returns The description string for the specified locale.\r\n   */\r\n  getDescription(locale: LocaleCode): string\r\n  getDescription(locale?: LocaleCode): LocalizedString | string  {\r\n    if(locale){\r\n      return this.description[locale] ?? this.description.en;\r\n    } else {\r\n      return { ...this.description };\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Gets the full localized product slug object.\r\n   * @returns A copy of the LocalizedString object for the slug.\r\n   */\r\n  getSlug(): LocalizedString\r\n  /**\r\n   * Gets the product slug for a specific locale, falling back to English ('en').\r\n   * @param locale - The desired locale code.\r\n   * @returns The slug string for the specified locale.\r\n   */\r\n  getSlug(locale: LocaleCode): string\r\n  getSlug(locale?: LocaleCode): LocalizedString | string {\r\n    if (locale) {\r\n      return this.slug[locale] ?? this.slug.en;\r\n    } else {\r\n      return { ...this.slug };\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Gets the brand associated with the product.\r\n   * @returns The brand name string.\r\n   */\r\n  getBrand(): string {\r\n      return this.brand;\r\n  }\r\n\r\n  /**\r\n   * Gets the list of base prices. Returns copies of the price objects.\r\n   * Optionally filters by country.\r\n   * @param country - Optional country code to filter prices for.\r\n   * @returns A list of base prices (or an empty list if none match).\r\n   */\r\n  getBasePrices(country?: CountryCode): BasePriceList {\r\n    const filteredPrices = country ? this.basePrices.filter(price => price.country === country) : this.basePrices;\r\n    return filteredPrices.map(price => ({ ...price }));\r\n  }\r\n\r\n  /**\r\n   * Gets the list of quantity-based price tiers. Returns copies of the tier objects.\r\n   * Optionally filters by country.\r\n   * @param country - Optional country code to filter tiers for.\r\n   * @returns A list of price tiers (or an empty list if none match or none exist).\r\n   */\r\n  getPriceTiers(country?: CountryCode): PriceTierList {\r\n    const filteredTiers = country ? this.priceTiers.filter(tier => tier.country === country) : this.priceTiers;\r\n    return filteredTiers.map(tier => ({ ...tier }));\r\n  }\r\n\r\n  /**\r\n   * Gets the variant-specific attributes (color, sizes). Returns copies.\r\n   * @returns Product Attributes.\r\n   */\r\n  getAttributes(): { color: Color; sizes: string[] } {\r\n      return {\r\n          ...this.attributes,\r\n          color: { ...this.attributes.color }, // Copy color object\r\n          sizes: [...this.attributes.sizes]\r\n      };\r\n  }\r\n\r\n  /**\r\n   * Gets details of product's primary image.\r\n   * @returns The ImageInfoModel instance for the primary image.\r\n   */\r\n  getPrimaryImage(): ImageInfoModel {\r\n      return this.primaryImage;\r\n  }\r\n\r\n  /**\r\n   * Gets the list of additional product images.\r\n   * @returns An array of ImageInfoModel instances.\r\n   */\r\n  getAdditionalImages(): ImageInfoModel[] {\r\n      return this.additionalImages;\r\n  }\r\n\r\n  /**\r\n   * Checks if the product variant is active.\r\n   * @returns True if the product is active, false otherwise.\r\n   */\r\n  getIsActive(): boolean {\r\n      return this.isActive;\r\n  }\r\n\r\n  /**\r\n   * Gets the target gender category for the product.\r\n   * @returns The GenderCategory enum value.\r\n   */\r\n  getTargetGender(): GenderCategory {\r\n      return this.targetGender;\r\n  }\r\n\r\n  /**\r\n   * Gets the list of categories the product belongs to. Returns a copy.\r\n   * @returns An array of category.\r\n   */\r\n  getCategories(): string[] {\r\n      return [...this.categories];\r\n  }\r\n\r\n  /**\r\n   * Gets the full localized product specifications object.\r\n   * @returns Product Specifications\r\n   */\r\n  getSpecifications(): LocalizedProductSpecification\r\n  /**\r\n   * Gets the product specifications for a specific locale, falling back to English ('en').\r\n   * @param locale - The desired locale code.\r\n   * @returns The ProductSpecification object for the specified locale, or undefined if not found.\r\n   */\r\n  getSpecifications(locale: LocaleCode): ProductSpecification | undefined\r\n  getSpecifications(locale?: LocaleCode): LocalizedProductSpecification | ProductSpecification | undefined {\r\n      if(locale){\r\n        return this.specifications[locale] ?? this.specifications.en;\r\n      } else {\r\n        return JSON.parse(JSON.stringify(this.specifications));\r\n      }\r\n  }\r\n\r\n  /**\r\n   * Gets the list of search tags. Returns a copy.\r\n   * @returns An array of search tags.\r\n   */\r\n  getSearchTags(): string[] {\r\n      return [...this.searchTags];\r\n  }\r\n\r\n  /**\r\n   *\r\n   * @returns ProductData\r\n   */\r\n  getDetails(): ProductData {\r\n      const baseDetails = super.getDetails();\r\n      return {\r\n          id: this.getId(),\r\n          key: this.getKey(),\r\n          variantId: this.getVariantId(),\r\n          name: this.getName(),\r\n          description: this.getDescription(),\r\n          slug: this.getSlug(),\r\n          brand: this.getBrand(),\r\n          basePrices: this.getBasePrices(),\r\n          priceTiers: this.getPriceTiers(),\r\n          attributes: this.getAttributes(),\r\n          primaryImage: this.getPrimaryImage().getDetails(),\r\n          additionalImages: this.getAdditionalImages().map(image => image.getDetails()),\r\n          isActive: this.getIsActive(),\r\n          targetGender: this.getTargetGender(),\r\n          categories: this.getCategories(),\r\n          specifications: this.getSpecifications(),\r\n          searchTags: this.getSearchTags(),\r\n          ...baseDetails\r\n      }; \r\n  }\r\n\r\n  /**\r\n   * Calculates the maximum potential discount percentage for a given country\r\n   * based on the lowest price tier compared to the base price.\r\n   * @param country - The country code to calculate the discount for.\r\n   * @returns The maximum discount percentage (0-100), or 0 if calculation is not possible.\r\n   */\r\n  getMaxDiscountPercent(country: CountryCode): number {\r\n    // Find base price for the country (should be unique per country)\r\n    const basePrice = this.basePrices.find(price => price.country === country);\r\n\r\n    // Find the lowest unit price among tiers for the country\r\n    const lowestTierPrice = this.priceTiers\r\n                                ?.filter(tier => tier.country === country) // Filter tiers for the country first\r\n                                .sort((a, b) => a.unitPrice - b.unitPrice)[0]?.unitPrice; // Then sort and get lowest\r\n\r\n    // Validate prices before calculation\r\n    if (!basePrice || basePrice.unitPrice <= 0 || lowestTierPrice === undefined) {\r\n        return 0; // Cannot calculate discount\r\n    }\r\n\r\n    // Calculate discount, ensuring it's not negative\r\n    const discount = Math.max(0, basePrice.unitPrice - lowestTierPrice);\r\n\r\n    // Calculate percentage\r\n    return (discount / basePrice.unitPrice) * 100;\r\n  }\r\n}"]}

package/dist/Classes/ShoppingContainer.d.mts

@@ -0,0 +1,194 @@
+import BaseModel, { BaseAttributes, BaseData } from './Base.mjs';
+import AddressModel, { AddressData } from './Address.mjs';
+import LineItemModel, { LineItemData } from './LineItem.mjs';
+import { ShippingDetails, CountryCode, CurrencyCode, LocaleCode } from './Common.mjs';
+import CouponModel, { CouponData } from './Coupon.mjs';
+import './ImageInfo.mjs';
+import './Enum.mjs';
+
+type BaseShoppingContainerAttributes = BaseAttributes & {
+    id: string;
+    customerId?: string;
+    customerEmail?: string;
+    anonymousId?: string;
+    lineItems: LineItemData[];
+    shippingDetails: ShippingDetails | null;
+    shippingAddress?: AddressData | null;
+    billingAddress?: AddressData | null;
+    coupons?: CouponData[];
+    total?: {
+        shipping?: number;
+        effectiveShipping?: number;
+        subtotal?: number;
+        mrpTotal?: number;
+        couponTotal?: {
+            [key: string]: number;
+        };
+        grandTotal?: number;
+    };
+    country: CountryCode;
+    currency: CurrencyCode;
+    locale: LocaleCode;
+};
+type BaseShoppingContainerData = Omit<BaseShoppingContainerAttributes, 'coupons' | 'total'> & BaseData & {
+    coupons: CouponData[];
+    total: {
+        shipping: number;
+        effectiveShipping: number;
+        subtotal: number;
+        mrpTotal: number;
+        couponTotal: {
+            [key: string]: number;
+        };
+        grandTotal: number;
+    };
+};
+/**
+ * Abstract base class for shopping-related containers like carts and orders.
+ * Manages common elements such as line items, addresses, coupons, and totals.
+ */
+declare abstract class BaseShoppingContainerModel extends BaseModel {
+    protected id: string;
+    protected customerId?: string;
+    protected customerEmail?: string;
+    protected anonymousId?: string;
+    protected lineItems: LineItemModel[];
+    protected shippingDetails: ShippingDetails | null;
+    protected shippingAddress: AddressModel | null;
+    protected billingAddress: AddressModel | null;
+    protected coupons: CouponModel[];
+    protected total: {
+        shipping: number;
+        effectiveShipping: number;
+        subtotal: number;
+        mrpTotal: number;
+        couponTotal: {
+            [key: string]: number;
+        };
+        grandTotal: number;
+    };
+    protected country: CountryCode;
+    protected currency: CurrencyCode;
+    protected locale: LocaleCode;
+    /**
+     * Creates an instance of BaseShoppingContainerModel.
+     * Initializes common properties and calculates initial base totals.
+     * @param data - The initial attributes for the shopping container.
+     * @param date - Optional date object for setting creation/modification times (defaults to now).
+     */
+    constructor(data: BaseShoppingContainerAttributes, date?: Date);
+    /**
+     * Recalculates the subtotal and mrpTotal based on the current line items.
+     * Uses PriceModel for rounding based on the country.
+     */
+    protected recalculateBaseTotals(): void;
+    /**
+     * Gets the unique identifier for this shopping container (cart ID or order ID).
+     * @returns The ID string.
+     */
+    getId(): string;
+    /**
+     * Gets the customer ID associated with this container, if available.
+     * @returns The customer ID string, or undefined.
+     */
+    getCustomerId(): string | undefined;
+    /**
+     * Gets the customer email associated with this container, if available.
+     * @returns The customer email string, or undefined.
+     */
+    getCustomerEmail(): string | undefined;
+    /**
+     * Gets the anonymous user ID associated with this container, if available.
+     * @returns The anonymous ID string, or undefined.
+     */
+    getAnonymousId(): string | undefined;
+    /**
+     * Gets a defensive copy of the line items in the container.
+     * Each item is a new LineItemModel instance created from the original's details.
+     * @returns An array of LineItemModel instances.
+     */
+    getLineItems(): LineItemModel[];
+    /**
+     * Gets a copy of the shipping details associated with the container.
+     * @returns A ShippingDetails object, or null if none are set.
+     */
+    getShippingDetails(): ShippingDetails | null;
+    /**
+     * Gets a defensive copy of the shipping address associated with the container.
+     * Returns a new AddressModel instance created from the original's details.
+     * @returns An AddressModel instance, or null if no shipping address is set.
+     */
+    getShippingAddress(): AddressModel | null;
+    /**
+     * Gets a defensive copy of the billing address associated with the container.
+     * Returns a new AddressModel instance created from the original's details.
+     * @returns An AddressModel instance, or null if no billing address is set.
+     */
+    getBillingAddress(): AddressModel | null;
+    /**
+     * Gets a defensive copy of the coupons applied to the container.
+     * Each item is a new CouponModel instance created from the original's details.
+     * @returns An array of CouponModel instances.
+     */
+    getCoupons(): CouponModel[];
+    /**
+     * Gets the country code associated with this container.
+     * @returns The CountryCode enum value.
+     */
+    getCountry(): CountryCode;
+    /**
+     * Gets the currency code associated with this container.
+     * @returns The CurrencyCode enum value.
+     */
+    getCurrency(): CurrencyCode;
+    /**
+     * Gets the locale code associated with this container.
+     * @returns The LocaleCode enum value.
+     */
+    getLocale(): LocaleCode;
+    /**
+     * Gets a defensive copy of the calculated totals for the container.
+     * @returns An object containing shipping, subtotal, coupon, and grand totals.
+     */
+    getTotal(): {
+        couponTotal: {
+            [x: string]: number;
+        };
+        shipping: number;
+        effectiveShipping: number;
+        subtotal: number;
+        mrpTotal: number;
+        grandTotal: number;
+    };
+    /**
+     * Calculates the discount value for a given coupon based on the current container state.
+     * Returns 0 if the coupon is invalid, expired, or not applicable based on cart value or target category.
+     * @param coupon - The CouponModel instance to evaluate.
+     * @returns The calculated discount amount (rounded according to country rules).
+     */
+    calculateApplicableCouponDiscount(coupon: CouponModel): number;
+    /**
+     * Recalculates the `couponTotal` map based on currently applied coupons.
+     * Iterates through coupons, calculates their applicable discount, and stores it.
+     * @returns The total discount amount from all valid and applicable coupons (rounded).
+     */
+    recalculateCouponTotals(): number;
+    /**
+    * Recalculates all container totals (subtotal, mrpTotal, coupons, shipping, grandTotal).
+    * Should be called whenever line items, coupons, or base shipping cost change.
+    */
+    updateCartTotals(): void;
+    /**
+    * Updates the shipping details (including estimated cost) for the container and recalculates totals.
+    * @param details - The new ShippingDetails object, or null to clear shipping details and cost.
+    */
+    setShippingDetails(details: ShippingDetails | null): void;
+    /**
+     * Gets a plain data object representing the shopping container's current state.
+     * Includes details from the base model and specific container properties.
+     * @returns BaseShoppingContainerData object suitable for serialization or API responses.
+     */
+    getDetails(): BaseShoppingContainerData;
+}
+
+export { type BaseShoppingContainerAttributes, type BaseShoppingContainerData, BaseShoppingContainerModel as default };