@plentymarkets/shop-api 0.168.1 → 0.170.0

package/lib/getters/productGetters.d.ts

@@ -1,75 +1,441 @@
 import { AgnosticImage, ProductAttributeValue } from './agnostic';
 import type { CategoryTreeItem, Product, VariationMapProductVariation, VariationProperty, VariationPropertyGroup, ImagesData, Manufacturer, Barcode, ProductGroupedAttribute } from '../types';
+/**
+ * Returns the primary name (`name1`) of the product.
+ * @param product - The product object.
+ * @returns The primary product name, or an empty string if not set.
+ */
 declare function getName(product: Product): string;
+/**
+ * Returns the secondary name (`name2`) of the product.
+ * @param product - The product object.
+ * @returns The secondary product name, or an empty string if not set.
+ */
+declare function getName2(product: Product): string;
+/**
+ * Returns the tertiary name (`name3`) of the product.
+ * @param product - The product object.
+ * @returns The tertiary product name, or an empty string if not set.
+ */
+declare function getName3(product: Product): string;
+/**
+ * Returns the URL slug (last segment of the URL path) of the product.
+ * @param product - The product object.
+ * @returns The slug string, or an empty string if not set.
+ */
 declare function getSlug(product: Product): string;
+/**
+ * Returns the full URL path of the product.
+ * @param product - The product object.
+ * @returns The URL path string, or an empty string if not set.
+ */
 declare function getUrlPath(product: Product): string;
+/**
+ * Returns the minimum order quantity for the product variation.
+ * @param product - The product object.
+ * @returns The minimum order quantity, defaulting to `1`.
+ */
 declare function getMinimumOrderQuantity(product: Product): number;
+/**
+ * Returns the image gallery for the product.
+ * Prefers variation-specific images; falls back to all item images.
+ * @param product - The product object.
+ * @returns An array of image data objects, or an empty array if the product is not defined.
+ */
 declare function getGallery(product: Product): ImagesData[] | [];
+/**
+ * Returns the width of the first gallery image in pixels.
+ * @param product - The product object.
+ * @returns The image width, or `0` if not set.
+ */
 declare function getImageWidth(product: Product): number;
+/**
+ * Returns the height of the first gallery image in pixels.
+ * @param product - The product object.
+ * @returns The image height, or `0` if not set.
+ */
 declare function getImageHeight(product: Product): number;
+/**
+ * Returns the URL path for the product's primary default category.
+ * @param product - The product object.
+ * @param categories - The full category tree.
+ * @returns The category URL path, or an empty string if the category is not found.
+ */
 declare function getCategoryUrlPath(product: Product, categories: CategoryTreeItem[]): string;
+/**
+ * Returns the normal-size URL of the product's primary cover image.
+ * @param product - The product object.
+ * @returns The cover image URL, or an empty string if not available.
+ */
 declare function getCoverImage(product: Product): string;
+/**
+ * Returns the normal-size URL of the product's second cover image.
+ * @param product - The product object.
+ * @returns The second cover image URL, or an empty string if not available.
+ */
 declare function getSecondCoverImage(product: Product): string;
+/**
+ * Returns the small-size preview URL of the product's primary cover image.
+ * @param product - The product object.
+ * @returns The cover image preview URL, or an empty string if not available.
+ */
 declare function getCoverImagePreview(product: Product): string;
+/**
+ * Returns the full-size image URL, preferring a variation-specific image over the general item image.
+ * @param product - The product object.
+ * @returns The full-size image URL, or an empty string if not available.
+ */
 declare function getFullImage(product: Product): string;
+/**
+ * Returns the medium-size image URL, preferring a variation-specific image over the general item image.
+ * @param product - The product object.
+ * @returns The medium-size image URL, or an empty string if not available.
+ */
 declare function getMiddleImage(product: Product): string;
+/**
+ * Returns the second preview image URL, preferring a variation-specific image over the general item image.
+ * @param product - The product object.
+ * @returns The second preview image URL, or an empty string if not available.
+ */
 declare function getSecondPreviewImage(product: Product): string;
+/**
+ * Returns the preview image URL, preferring a variation-specific image over the general item image.
+ * @param product - The product object.
+ * @returns The preview image URL, or an empty string if not available.
+ */
 declare function getPreviewImage(product: Product): string;
+/**
+ * Returns the first product image as an {@link AgnosticImage} with a URL and alt text.
+ * Prefers variation-specific images; falls back to all item images.
+ * @param product - The product object.
+ * @returns An `AgnosticImage` containing the medium-size URL and a clean image name as alt text.
+ */
 declare function getFirstImage(product: Product): AgnosticImage;
+/**
+ * Returns a three-dimensional array of attribute values for each product.
+ * The structure is `[product][attribute][attributeValue]`.
+ * @param products - An array of product objects.
+ * @returns A nested array of {@link ProductAttributeValue} objects.
+ */
 declare function getAttributes(products: Product[]): ProductAttributeValue[][][];
+/**
+ * Builds a map of unit combination IDs to unit names from all product variations.
+ * @param products - An array of product objects.
+ * @returns A record mapping `unitCombinationId` to its display name.
+ */
 declare function getUnits(products: Product[]): Record<number, string>;
+/**
+ * Returns all variations from the product's variation attribute map.
+ * @param product - The product object.
+ * @returns An array of {@link VariationMapProductVariation} objects, or an empty array.
+ */
 declare function getAttributeMapVariations(product: Product): VariationMapProductVariation[];
+/**
+ * Returns the unique unit combinations available for the product.
+ * Filters out duplicate `unitCombinationId` entries, keeping the first occurrence.
+ * @param product - The product object.
+ * @returns An array of {@link VariationMapProductVariation} objects with distinct unit combinations.
+ */
 declare function possibleUnitCombination(product: Product): VariationMapProductVariation[];
+/**
+ * Finds the variation ID that matches a given attribute value and unit combination.
+ * @param product - The product object.
+ * @param selectedAttributId - The ID of the selected attribute value as a string.
+ * @param unitCombinationId - The unit combination ID to match, or `null` to ignore unit filtering.
+ * @returns The matching variation ID, or `-1` if no match is found.
+ */
 declare function getVariationIdForAttributes(product: Product, selectedAttributId: string, unitCombinationId: string | null): number;
+/**
+ * Returns the variation matching the given variation ID, or `null` if not found.
+ * @param product - The product object.
+ * @param variationId - The numeric ID of the variation to look up.
+ * @returns The matching {@link VariationMapProductVariation}, or `null`.
+ */
 declare function getVariariationById(product: Product, variationId: number): VariationMapProductVariation | null;
+/**
+ * Returns the SEO title of the product.
+ * @param product - The product object.
+ * @returns The product title, or an empty string if not set.
+ */
 declare function getTitle(product: Product): string;
+/**
+ * Returns the full HTML description of the product.
+ * @param product - The product object.
+ * @returns The product description, or an empty string if not set.
+ */
 declare function getDescription(product: Product): string;
+/**
+ * Returns the short description of the product.
+ * @param product - The product object.
+ * @returns The short description, or an empty string if not set.
+ */
 declare function getShortDescription(product: Product): string;
+/**
+ * Returns the technical data text of the product.
+ * @param product - The product object.
+ * @returns The technical data string, or an empty string if not set.
+ */
 declare function getTechnicalData(product: Product): string;
+/**
+ * Returns the meta description of the product for SEO purposes.
+ * @param product - The product object.
+ * @returns The meta description string, or an empty string if not set.
+ */
 declare function getMetaDescription(product: Product): string;
+/**
+ * Returns the meta keywords of the product for SEO purposes.
+ * @param product - The product object.
+ * @returns The keywords string, or an empty string if not set.
+ */
 declare function getMetaKeywords(product: Product): string;
+/**
+ * Returns an array of category IDs for all of the product's default categories.
+ * @param product - The product object.
+ * @returns An array of category ID strings, or `['']` if no categories are assigned.
+ */
 declare function getCategoryIds(product: Product): string[];
+/**
+ * Returns the name of the product's primary default category.
+ * @param product - The product object.
+ * @returns The category name, or an empty string if no default category is assigned.
+ */
 declare function getCategoryName(product: Product): string;
+/**
+ * Returns the variation ID as a string.
+ * @param product - The product object.
+ * @returns The variation ID string, or an empty string if not set.
+ */
 declare function getId(product: Product): string;
+/**
+ * Returns the item ID (parent product ID) as a string.
+ * @param product - The product object.
+ * @returns The item ID string, or an empty string if not set.
+ */
 declare function getItemId(product: Product): string;
+/**
+ * Returns the unit content quantity of the product (e.g. `500` for 500 ml).
+ * @param product - The product object.
+ * @returns The unit content as a number.
+ */
 declare function getUnitContent(product: Product): number;
+/**
+ * Returns the unit name of the product (e.g. `"ml"`, `"kg"`).
+ * @param product - The product object.
+ * @returns The unit name string.
+ */
 declare function getUnitName(product: Product): string;
+/**
+ * Returns the total number of customer reviews for the product.
+ * @param product - The product object.
+ * @returns The review count, or `0` if not set.
+ */
 declare function getTotalReviews(product: Product): number;
+/**
+ * Returns the average customer rating of the product.
+ * @param product - The product object.
+ * @param roundOption - Optional rounding strategy: `'half'` rounds to the nearest 0.5, `'tenth'` rounds to the nearest 0.1.
+ * @returns The average rating as a number, or `0` if not set.
+ */
 declare function getAverageRating(product: Product, roundOption?: 'half' | 'tenth'): number;
+/**
+ * Returns `true` if at least one variation of the product is salable.
+ * @param product - The product object.
+ * @returns `true` if any variation is salable, otherwise `false`.
+ */
 declare function isSalable(product: Product): boolean;
+/**
+ * Returns `true` if the currently active variation of the product is salable.
+ * @param product - The product object.
+ * @returns `true` if the active variation is salable, otherwise `false`.
+ */
 declare function isActiveVariationSalable(product: Product): boolean;
+/**
+ * Returns the maximum possible rating value.
+ * @param product - The product object (currently unused).
+ * @returns Always returns `5`.
+ */
 declare function getMaxRating(product: Product): number;
+/**
+ * Determines whether the product can be added directly to the cart from a category page.
+ * Returns `false` if the product is not salable, has required order properties,
+ * is a set item, has a minimum order quantity other than 1, has an interval order
+ * quantity greater than 1, has multiple salable variations, or has graduated prices.
+ * @param product - The product object.
+ * @returns `true` if the product can be added to cart from the category page.
+ */
 declare function canBeAddedToCartFromCategoryPage(product: Product): boolean;
+/**
+ * Returns `true` if the product has order properties and all of them are required and preselected.
+ * @param product - The product object.
+ * @returns `true` when all order properties are required and already preselected.
+ */
 declare function hasOrderPropertiesRequiredAndPreselected(product: Product): boolean;
+/**
+ * Determines whether a "from" price prefix should be shown for the product.
+ * Returns `true` when the product has multiple salable variations with cheapest-sorting
+ * enabled, or when a single variation has more than one graduated price step.
+ * Always returns `false` for set items.
+ * @param product - The product object.
+ * @returns `true` if the "from" prefix should be displayed alongside the price.
+ */
 declare function showFromText(product: Product): boolean;
+/**
+ * Returns all variation property groups for the product.
+ * @param product - The product object.
+ * @returns An array of {@link VariationPropertyGroup} objects, or an empty array.
+ */
 declare function getPropertyGroups(product: Product): VariationPropertyGroup[];
+/**
+ * Returns the variation property group with the given ID.
+ * @param id - The numeric ID of the property group.
+ * @param product - The product object.
+ * @returns The matching {@link VariationPropertyGroup}.
+ */
 declare function getPropertyGroupById(id: number, product: Product): VariationPropertyGroup;
+/**
+ * Returns the variation property with the given ID.
+ * @param id - The numeric ID of the property.
+ * @param product - The product object.
+ * @returns The matching {@link VariationProperty}.
+ */
 declare function getPropertyById(id: number, product: Product): VariationProperty;
+/**
+ * Returns the numeric ID of the current product variation.
+ * @param product - The product object.
+ * @returns The variation ID, or `0` if not set.
+ */
 declare function getVariationId(product: Product): number;
+/**
+ * Returns the variation number (SKU / external ID) of the product variation.
+ * @param product - The product object.
+ * @returns The variation number string, or an empty string if not set.
+ */
 declare function getVariationNumber(product: Product): string;
+/**
+ * Returns the total number of salable variations for the product.
+ * @param product - The product object.
+ * @returns The salable variation count, or `0` if not set.
+ */
 declare function getSalableVariationCount(product: Product): number;
+/**
+ * Returns the date until which the variation is available for sale.
+ * @param product - The product object.
+ * @returns The availability end date value.
+ */
 declare function getVariationAvailableUntil(product: Product): unknown;
+/**
+ * Returns the width of the product variation in millimeters.
+ * @param product - The product object.
+ * @returns The width in mm, or `0` if not set.
+ */
 declare function getWidthMM(product: Product): number;
+/**
+ * Returns the height of the product variation in millimeters.
+ * @param product - The product object.
+ * @returns The height in mm, or `0` if not set.
+ */
 declare function getHeightMM(product: Product): number;
+/**
+ * Returns the weight of the product variation in grams.
+ * @param product - The product object.
+ * @returns The weight in grams, or `0` if not set.
+ */
 declare function getWeightG(product: Product): number;
+/**
+ * Returns the length of the product variation in millimeters.
+ * @param product - The product object.
+ * @returns The length in mm, or `0` if not set.
+ */
 declare function getLengthMM(product: Product): number;
+/**
+ * Returns the availability ID for the product variation (1–10).
+ * @param product - The product object.
+ * @returns The numeric availability ID.
+ */
 declare function getAvailabilityId(product: Product): number;
+/**
+ * Returns the average number of days for the variation's availability (e.g. delivery time).
+ * @param product - The product object.
+ * @returns The average days as a number.
+ */
 declare function getAvailabilityAverageDays(product: Product): number;
+/**
+ * Returns the display name of the variation's availability state.
+ * @param product - The product object.
+ * @returns The availability name string.
+ */
 declare function getAvailabilityName(product: Product): string;
+/**
+ * Returns a CSS class name derived from the variation's availability ID
+ * (e.g. `"availability-1"`).
+ * @param product - The product object.
+ * @returns The CSS class name string.
+ */
 declare function getAgenciesAvailabilityCLass(product: Product): string;
+/**
+ * Returns the background color associated with the variation's availability state.
+ * @param product - The product object.
+ * @returns The background color value from {@link AvailabilityBackgroundColor}.
+ */
 declare function getAvailabilityBackgroundColor(product: Product): string;
+/**
+ * Returns the text color associated with the variation's availability state.
+ * @param product - The product object.
+ * @returns The text color value from {@link AvailabilityTextColor}.
+ */
 declare function getAvailabilityTextColor(product: Product): string;
+/**
+ * Returns the parent category ID of the product's first default category.
+ * @param product - The product object.
+ * @returns The parent category ID, or `0` if not set.
+ */
 declare function getParentCategoryId(product: Product): number;
+/**
+ * Returns the numeric ID of the product's first default category.
+ * @param product - The product object.
+ * @returns The category ID, or `0` if not set.
+ */
 declare function getCategoryId(product: Product): number;
+/**
+ * Returns the list of barcodes associated with the product.
+ * @param product - The product object.
+ * @returns An array of {@link Barcode} objects, or an empty array.
+ */
 declare function getBarcodes(product: Product): Barcode[];
+/**
+ * Returns the manufacturer of the product.
+ * When the manufacturer data is an array, the first entry is returned.
+ * @param product - The product object.
+ * @returns The {@link Manufacturer} object.
+ */
 declare function getManufacturer(product: Product): Manufacturer;
+/**
+ * Returns the grouped attributes for the product (e.g. color and size combined).
+ * @param product - The product object.
+ * @returns An array of {@link ProductGroupedAttribute} objects, or an empty array.
+ */
 declare function getGroupedAttributes(product: Product): ProductGroupedAttribute[];
+/**
+ * Returns a formatted string of all grouped attributes in `", name: value"` format.
+ * Returns an empty string if the product has no grouped attributes.
+ * @param product - The product object.
+ * @returns A concatenated attribute string prefixed with `", "`, or an empty string.
+ */
 declare function getGroupedAttributesString(product: Product): string;
+/**
+ * Determines whether the variation ID should be appended to the product URL.
+ * Returns `true` if there is exactly one salable variation with a valid variation ID,
+ * or if the product has any grouped attributes.
+ * @param product - The product object.
+ * @returns `true` if the variation should be included in the link.
+ */
 declare function shouldAppendVariationToLink(product: Product): boolean;
 export declare const productGetters: {
     getUnitContent: typeof getUnitContent;
     getUnitName: typeof getUnitName;
     getName: typeof getName;
+    getName2: typeof getName2;
+    getName3: typeof getName3;
     getMinimumOrderQuantity: typeof getMinimumOrderQuantity;
     getSlug: typeof getSlug;
     getUrlPath: typeof getUrlPath;

package/lib/getters/productGetters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"productGetters.d.ts","sourceRoot":"","sources":["../../src/getters/productGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EAKb,qBAAqB,EACtB,MAAM,YAAY,CAAC;AAEpB,OAAO,KAAK,EACV,gBAAgB,EAChB,OAAO,EAEP,4BAA4B,EAC5B,iBAAiB,EACjB,sBAAsB,EACtB,UAAU,EACV,YAAY,EACZ,OAAO,EACP,uBAAuB,EACxB,MAAM,UAAU,CAAC;AAWlB,iBAAS,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEzC;AAED,iBAAS,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEzC;AAED,iBAAS,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE5C;AAED,iBAAS,uBAAuB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEzD;AAED,iBAAS,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU,EAAE,GAAG,EAAE,CAOvD;AAED,iBAAS,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE/C;AAED,iBAAS,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEhD;AAED,iBAAS,kBAAkB,CACzB,OAAO,EAAE,OAAO,EAChB,UAAU,EAAE,gBAAgB,EAAE,GAC7B,MAAM,CAWR;AAED,iBAAS,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE/C;AAED,iBAAS,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAErD;AAED,iBAAS,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEtD;AAED,iBAAS,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE9C;AAED,iBAAS,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAMhD;AAED,iBAAS,qBAAqB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAMvD;AAED,iBAAS,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAMjD;AAED,iBAAS,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,aAAa,CAStD;AAQD,iBAAS,aAAa,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,qBAAqB,EAAE,EAAE,EAAE,CA4BvE;AAED,iBAAS,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAY7D;AAED,iBAAS,yBAAyB,CAChC,OAAO,EAAE,OAAO,GACf,4BAA4B,EAAE,CAEhC;AAED,iBAAS,uBAAuB,CAC9B,OAAO,EAAE,OAAO,GACf,4BAA4B,EAAE,CAShC;AAED,iBAAS,2BAA2B,CAClC,OAAO,EAAE,OAAO,EAChB,kBAAkB,EAAE,MAAM,EAC1B,iBAAiB,EAAE,MAAM,GAAG,IAAI,GAC/B,MAAM,CA2BR;AAED,iBAAS,mBAAmB,CAC1B,OAAO,EAAE,OAAO,EAChB,WAAW,EAAE,MAAM,GAClB,4BAA4B,GAAG,IAAI,CAMrC;AAED,iBAAS,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE1C;AAED,iBAAS,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEhD;AAED,iBAAS,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAIrD;AAED,iBAAS,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAElD;AAED,iBAAS,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEpD;AAED,iBAAS,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEjD;AAED,iBAAS,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,EAAE,CAMlD;AAED,iBAAS,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEjD;AAED,iBAAS,KAAK,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEvC;AAED,iBAAS,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE3C;AAED,iBAAS,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEhD;AAED,iBAAS,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE7C;AAED,iBAAS,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEjD;AAED,iBAAS,gBAAgB,CACvB,OAAO,EAAE,OAAO,EAChB,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,GAC7B,MAAM,CAKR;AAED,iBAAS,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAM5C;AAED,iBAAS,wBAAwB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAM3D;AAGD,iBAAS,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAG9C;AAED,iBAAS,gCAAgC,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAUnE;AAED,iBAAS,wCAAwC,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAK3E;AAED,iBAAS,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAsB/C;AAED,iBAAS,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,sBAAsB,EAAE,CAErE;AAED,iBAAS,oBAAoB,CAC3B,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,OAAO,GACf,sBAAsB,CAIxB;AAED,iBAAS,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,iBAAiB,CAIxE;AAED,iBAAS,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEhD;AAED,iBAAS,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEpD;AAED,iBAAS,wBAAwB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE1D;AAED,iBAAS,0BAA0B,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAE7D;AAED,iBAAS,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE5C;AAED,iBAAS,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE7C;AAED,iBAAS,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE5C;AAED,iBAAS,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE7C;AAED,iBAAS,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEnD;AAED,iBAAS,0BAA0B,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE5D;AAED,iBAAS,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAErD;AAED,iBAAS,4BAA4B,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE9D;AAED,iBAAS,8BAA8B,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEhE;AAED,iBAAS,wBAAwB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE1D;AAED,iBAAS,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAErD;AAED,iBAAS,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE/C;AAED,iBAAS,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,EAAE,CAEhD;AAED,iBAAS,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,YAAY,CAMvD;AAED,iBAAS,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,uBAAuB,EAAE,CAEzE;AAED,iBAAS,0BAA0B,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAM5D;AAED,iBAAS,2BAA2B,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAM9D;AAED,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiF1B,CAAC"}
+{"version":3,"file":"productGetters.d.ts","sourceRoot":"","sources":["../../src/getters/productGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EAKb,qBAAqB,EACtB,MAAM,YAAY,CAAC;AAEpB,OAAO,KAAK,EACV,gBAAgB,EAChB,OAAO,EAEP,4BAA4B,EAC5B,iBAAiB,EACjB,sBAAsB,EACtB,UAAU,EACV,YAAY,EACZ,OAAO,EACP,uBAAuB,EACxB,MAAM,UAAU,CAAC;AAWlB;;;;GAIG;AACH,iBAAS,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEzC;AAED;;;;GAIG;AACH,iBAAS,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE1C;AAED;;;;GAIG;AACH,iBAAS,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE1C;AAED;;;;GAIG;AACH,iBAAS,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEzC;AAED;;;;GAIG;AACH,iBAAS,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE5C;AAED;;;;GAIG;AACH,iBAAS,uBAAuB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEzD;AAED;;;;;GAKG;AACH,iBAAS,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU,EAAE,GAAG,EAAE,CAOvD;AAED;;;;GAIG;AACH,iBAAS,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE/C;AAED;;;;GAIG;AACH,iBAAS,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEhD;AAED;;;;;GAKG;AACH,iBAAS,kBAAkB,CACzB,OAAO,EAAE,OAAO,EAChB,UAAU,EAAE,gBAAgB,EAAE,GAC7B,MAAM,CAWR;AAED;;;;GAIG;AACH,iBAAS,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE/C;AAED;;;;GAIG;AACH,iBAAS,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAErD;AAED;;;;GAIG;AACH,iBAAS,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEtD;AAED;;;;GAIG;AACH,iBAAS,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE9C;AAED;;;;GAIG;AACH,iBAAS,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAMhD;AAED;;;;GAIG;AACH,iBAAS,qBAAqB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAMvD;AAED;;;;GAIG;AACH,iBAAS,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAMjD;AAED;;;;;GAKG;AACH,iBAAS,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,aAAa,CAStD;AAcD;;;;;GAKG;AACH,iBAAS,aAAa,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,qBAAqB,EAAE,EAAE,EAAE,CA4BvE;AAED;;;;GAIG;AACH,iBAAS,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAY7D;AAED;;;;GAIG;AACH,iBAAS,yBAAyB,CAChC,OAAO,EAAE,OAAO,GACf,4BAA4B,EAAE,CAEhC;AAED;;;;;GAKG;AACH,iBAAS,uBAAuB,CAC9B,OAAO,EAAE,OAAO,GACf,4BAA4B,EAAE,CAShC;AAED;;;;;;GAMG;AACH,iBAAS,2BAA2B,CAClC,OAAO,EAAE,OAAO,EAChB,kBAAkB,EAAE,MAAM,EAC1B,iBAAiB,EAAE,MAAM,GAAG,IAAI,GAC/B,MAAM,CA2BR;AAED;;;;;GAKG;AACH,iBAAS,mBAAmB,CAC1B,OAAO,EAAE,OAAO,EAChB,WAAW,EAAE,MAAM,GAClB,4BAA4B,GAAG,IAAI,CAMrC;AAED;;;;GAIG;AACH,iBAAS,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE1C;AAED;;;;GAIG;AACH,iBAAS,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEhD;AAED;;;;GAIG;AACH,iBAAS,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAIrD;AAED;;;;GAIG;AACH,iBAAS,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAElD;AAED;;;;GAIG;AACH,iBAAS,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEpD;AAED;;;;GAIG;AACH,iBAAS,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEjD;AAED;;;;GAIG;AACH,iBAAS,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,EAAE,CAMlD;AAED;;;;GAIG;AACH,iBAAS,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEjD;AAED;;;;GAIG;AACH,iBAAS,KAAK,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEvC;AAED;;;;GAIG;AACH,iBAAS,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE3C;AAED;;;;GAIG;AACH,iBAAS,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEhD;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE7C;AAED;;;;GAIG;AACH,iBAAS,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEjD;AAED;;;;;GAKG;AACH,iBAAS,gBAAgB,CACvB,OAAO,EAAE,OAAO,EAChB,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,GAC7B,MAAM,CAKR;AAED;;;;GAIG;AACH,iBAAS,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAM5C;AAED;;;;GAIG;AACH,iBAAS,wBAAwB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAM3D;AAED;;;;GAIG;AAEH,iBAAS,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAG9C;AAED;;;;;;;GAOG;AACH,iBAAS,gCAAgC,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAUnE;AAED;;;;GAIG;AACH,iBAAS,wCAAwC,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAK3E;AAED;;;;;;;GAOG;AACH,iBAAS,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAsB/C;AAED;;;;GAIG;AACH,iBAAS,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,sBAAsB,EAAE,CAErE;AAED;;;;;GAKG;AACH,iBAAS,oBAAoB,CAC3B,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,OAAO,GACf,sBAAsB,CAIxB;AAED;;;;;GAKG;AACH,iBAAS,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,iBAAiB,CAIxE;AAED;;;;GAIG;AACH,iBAAS,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEhD;AAED;;;;GAIG;AACH,iBAAS,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEpD;AAED;;;;GAIG;AACH,iBAAS,wBAAwB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE1D;AAED;;;;GAIG;AACH,iBAAS,0BAA0B,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAE7D;AAED;;;;GAIG;AACH,iBAAS,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE5C;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE7C;AAED;;;;GAIG;AACH,iBAAS,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE5C;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE7C;AAED;;;;GAIG;AACH,iBAAS,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEnD;AAED;;;;GAIG;AACH,iBAAS,0BAA0B,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE5D;AAED;;;;GAIG;AACH,iBAAS,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAErD;AAED;;;;;GAKG;AACH,iBAAS,4BAA4B,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE9D;AAED;;;;GAIG;AACH,iBAAS,8BAA8B,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEhE;AAED;;;;GAIG;AACH,iBAAS,wBAAwB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE1D;AAED;;;;GAIG;AACH,iBAAS,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAErD;AAED;;;;GAIG;AACH,iBAAS,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE/C;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,EAAE,CAEhD;AAED;;;;;GAKG;AACH,iBAAS,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,YAAY,CAMvD;AAED;;;;GAIG;AACH,iBAAS,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,uBAAuB,EAAE,CAEzE;AAED;;;;;GAKG;AACH,iBAAS,0BAA0B,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAM5D;AAED;;;;;;GAMG;AACH,iBAAS,2BAA2B,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAM9D;AAED,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmF1B,CAAC"}

package/lib/getters/productImageGetters.d.ts

@@ -1,13 +1,63 @@
 import type { ImagesData, Product } from '../types';
+/**
+ * Returns the alternate text for an image.
+ * @param image - The image data object.
+ * @returns The alternate text string, or an empty string if names is an array or not set.
+ */
 declare function getImageAlternate(image: ImagesData): string;
+/**
+ * Returns the display name of an image.
+ * @param image - The image data object.
+ * @returns The name string, or an empty string if names is an array or not set.
+ */
 declare function getImageName(image: ImagesData): string;
+/**
+ * Returns the clean (filename-safe) name of an image.
+ * @param image - The image data object.
+ * @returns The clean image name string, or an empty string if not set.
+ */
 declare function getCleanImageName(image: ImagesData): string;
+/**
+ * Returns the full-size URL of an image.
+ * @param image - The image data object.
+ * @returns The image URL string, or an empty string if not set.
+ */
 declare function getImageUrl(image: ImagesData): string;
+/**
+ * Returns the preview URL of an image.
+ * @param image - The image data object.
+ * @returns The preview image URL string, or an empty string if not set.
+ */
 declare function getImageUrlPreview(image: ImagesData): string;
+/**
+ * Returns the second preview URL of an image.
+ * @param image - The image data object.
+ * @returns The second preview image URL string, or an empty string if not set.
+ */
 declare function getImageUrlSecondPreview(image: ImagesData): string;
+/**
+ * Returns the medium-size URL of an image.
+ * @param image - The image data object.
+ * @returns The medium image URL string, or an empty string if not set.
+ */
 declare function getImageUrlMiddle(image: ImagesData): string;
+/**
+ * Returns the width of an image in pixels.
+ * @param image - The image data object.
+ * @returns The image width, or `0` if not set.
+ */
 declare function getImageWidth(image: ImagesData): number;
+/**
+ * Returns the height of an image in pixels.
+ * @param image - The image data object.
+ * @returns The image height, or `0` if not set.
+ */
 declare function getImageHeight(image: ImagesData): number;
+/**
+ * Returns the first image from the product's `all` image list.
+ * @param product - The product object.
+ * @returns The first {@link ImagesData} object in the all-images list.
+ */
 declare function getFirstImage(product: Product): ImagesData;
 export declare const productImageGetters: {
     getImageAlternate: typeof getImageAlternate;

package/lib/getters/productImageGetters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"productImageGetters.d.ts","sourceRoot":"","sources":["../../src/getters/productImageGetters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAEpD,iBAAS,iBAAiB,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAKpD;AAED,iBAAS,YAAY,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAK/C;AAED,iBAAS,iBAAiB,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAEpD;AAED,iBAAS,WAAW,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAE9C;AAED,iBAAS,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAErD;AAED,iBAAS,wBAAwB,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAE3D;AAED,iBAAS,iBAAiB,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAEpD;AAED,iBAAS,aAAa,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAEhD;AAED,iBAAS,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAEjD;AAED,iBAAS,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU,CAEnD;AAED,eAAO,MAAM,mBAAmB;;;;;;;;;;;CAW/B,CAAC"}
+{"version":3,"file":"productImageGetters.d.ts","sourceRoot":"","sources":["../../src/getters/productImageGetters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAEpD;;;;GAIG;AACH,iBAAS,iBAAiB,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAKpD;AAED;;;;GAIG;AACH,iBAAS,YAAY,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAK/C;AAED;;;;GAIG;AACH,iBAAS,iBAAiB,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAEpD;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAE9C;AAED;;;;GAIG;AACH,iBAAS,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAErD;AAED;;;;GAIG;AACH,iBAAS,wBAAwB,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAE3D;AAED;;;;GAIG;AACH,iBAAS,iBAAiB,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAEpD;AAED;;;;GAIG;AACH,iBAAS,aAAa,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAEhD;AAED;;;;GAIG;AACH,iBAAS,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAEjD;AAED;;;;GAIG;AACH,iBAAS,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU,CAEnD;AAED,eAAO,MAAM,mBAAmB;;;;;;;;;;;CAW/B,CAAC"}

package/lib/getters/productPriceGetters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"productPriceGetters.d.ts","sourceRoot":"","sources":["../../src/getters/productPriceGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AA6GjE,eAAO,MAAM,mBAAmB;wBA3GL,OAAO,KAAG,MAAM,GAAG,IAAI;+BAIhB,OAAO,KAAG,MAAM,GAAG,IAAI;+BAIvB,OAAO,KAAG,MAAM,GAAG,IAAI;8BAIxB,OAAO,KAAG,MAAM,GAAG,IAAI;kCAInB,OAAO,KAAG,OAAO,EAAE;2CAS7C,OAAO,YACN,MAAM,KACf,OAAO,GAAG,IAAI;gCAakB,OAAO,KAAG,kBAAkB,EAAE;yCAiBrB,OAAO,KAAG,MAAM;kDAQP,OAAO,KAAG,MAAM;wCAgB1B,OAAO,KAAG,MAAM;iCAJvB,OAAO,KAAG,MAAM;wCAJT,OAAO,KAAG,MAAM;gCAYxB,OAAO,KAAG,OAAO;yCAMR,OAAO,KAAG,MAAM;mCAItB,OAAO,KAAG,MAAM;uCAIZ,OAAO,KAAG,MAAM;uCAIhB,OAAO,KAAG,MAAM;CAsBzD,CAAC"}
+{"version":3,"file":"productPriceGetters.d.ts","sourceRoot":"","sources":["../../src/getters/productPriceGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAyMjE,eAAO,MAAM,mBAAmB;wBAlML,OAAO,KAAG,MAAM,GAAG,IAAI;+BAShB,OAAO,KAAG,MAAM,GAAG,IAAI;+BASvB,OAAO,KAAG,MAAM,GAAG,IAAI;8BASxB,OAAO,KAAG,MAAM,GAAG,IAAI;kCASnB,OAAO,KAAG,OAAO,EAAE;2CAiB7C,OAAO,YACN,MAAM,KACf,OAAO,GAAG,IAAI;gCAmBkB,OAAO,KAAG,kBAAkB,EAAE;yCAuBrB,OAAO,KAAG,MAAM;kDAaP,OAAO,KAAG,MAAM;wCA+B1B,OAAO,KAAG,MAAM;iCATvB,OAAO,KAAG,MAAM;wCATT,OAAO,KAAG,MAAM;gCA6BxB,OAAO,KAAG,OAAO;yCAWR,OAAO,KAAG,MAAM;mCAStB,OAAO,KAAG,MAAM;uCASZ,OAAO,KAAG,MAAM;uCAShB,OAAO,KAAG,MAAM;CAsBzD,CAAC"}