ChemPal Documentation - v0.0.13-beta.5
    Preparing search index...

    Module types/product

    Interfaces

    ISupplier

    Interface defining the required properties for a supplier. This ensures all suppliers have the necessary readonly properties.

    QuantityObject

    Represents a quantity measurement with a numeric value and unit. Used for specifying product amounts and their units of measurement.

    Variant

    Represents a specific variation of a product with its unique characteristics and pricing. Used to model different versions or package sizes of the same product.

    Product

    Represents a chemical product with its complete details, extending the Variant interface. This is the main product type used throughout the application.

    Item

    Represents a hierarchical task or item with nested structure. Used for organizing items in a tree-like structure.

    Sku

    Represents a stock keeping unit with detailed inventory and pricing information. Used for managing product variants and their specific characteristics.

    ProductDetails

    Basic product information structure. Used for simplified product representations.

    SearchProps

    Props interface for search component functionality. Used to manage search state in React components.

    Supplier

    Base interface for product supplier implementation. Defines the common structure and functionality that all suppliers must implement.

    ProductObject

    Represents a product object in the Wix platform format. Used for compatibility with Wix e-commerce platform.

    SupplierExecutionError

    Error captured during parallel supplier execution in SupplierFactory.executeAll.

    Type Aliases

    RequiredProductFields

    Represents the required fields that must be present in a Product object. These fields are essential for product identification and basic information.

    OptionalProductFields

    Represents the optional fields that may be present in a Product object. These fields provide additional product information but are not required.

    SyntheticFields

    Synthetic columns - stuff that I add to the response body during processing.

    FuzzyMatchResult

    Result of a fuzzy match operation, extending the original item with match scoring metadata. Used by SupplierBase.fuzzyFilter to annotate search results with relevance scores.

    GroupedItem

    A product item extended with a group identifier and optional variant children. Used by SupplierBase.groupVariants to cluster product variants under a common listing.

    CountryDomainMap

    Mapping of ISO 3166-1 alpha-2 country codes to domain URLs. Used by Amazon supplier classes to resolve the correct regional storefront.