@react-pakistan/util-functions 1.25.11 → 1.25.13

package/general/generate-shopping-merchant-listing-schema.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Generate a merchant product listing as schema.org structured data.
+ *
+ * Returns an `ItemList` where each `ListItem.item` is a `Product` with
+ * optional `Offer` entries. Supports brand, seller, images, and basic
+ * offer normalization; pass `skipInvalidCurrency` to ignore currency
+ * validation for price fields.
+ *
+ * See `MerchantListingOptions` and `MerchantProduct` types for accepted
+ * fields.
+ * @returns A JSON-LD compatible `ItemList` of Products
+ */
+interface BrandRef {
+    name: string;
+    url?: string;
+}
+interface MerchantRef {
+    name: string;
+    url?: string;
+}
+interface OfferItem {
+    price?: string | number;
+    priceCurrency?: string;
+    availability?: string;
+    url?: string;
+    priceValidUntil?: string;
+    itemCondition?: string;
+    seller?: MerchantRef;
+}
+interface MerchantProduct {
+    id?: string;
+    name: string;
+    url?: string;
+    image?: string | {
+        url: string;
+        width?: number;
+        height?: number;
+    };
+    description?: string;
+    brand?: string | BrandRef;
+    sku?: string;
+    offers?: OfferItem | OfferItem[];
+}
+interface MerchantListingOptions {
+    merchant?: MerchantRef;
+    name?: string;
+    url?: string;
+    products: MerchantProduct[];
+    skipInvalidCurrency?: boolean;
+}
+export declare const generateShoppingMerchantListingSchema: ({ merchant, name, url, products, skipInvalidCurrency, }: MerchantListingOptions) => any;
+export {};

package/general/generate-shopping-merchant-listing-schema.js

@@ -0,0 +1,153 @@
+"use strict";
+/**
+ * Generate a merchant product listing as schema.org structured data.
+ *
+ * Returns an `ItemList` where each `ListItem.item` is a `Product` with
+ * optional `Offer` entries. Supports brand, seller, images, and basic
+ * offer normalization; pass `skipInvalidCurrency` to ignore currency
+ * validation for price fields.
+ *
+ * See `MerchantListingOptions` and `MerchantProduct` types for accepted
+ * fields.
+ * @returns A JSON-LD compatible `ItemList` of Products
+ */
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateShoppingMerchantListingSchema = void 0;
+var formatImage = function (image) {
+    if (!image)
+        return undefined;
+    if (typeof image === 'string')
+        return image;
+    return __assign(__assign({ '@type': 'ImageObject', url: image.url }, (image.width && { width: image.width })), (image.height && { height: image.height }));
+};
+var formatBrand = function (b) {
+    if (!b)
+        return undefined;
+    if (typeof b === 'string')
+        return { '@type': 'Brand', name: b };
+    return __assign({ '@type': 'Brand', name: b.name }, (b.url && { url: b.url }));
+};
+var isValidCurrency = function (code) {
+    if (!code)
+        return false;
+    return /^[A-Z]{3}$/.test(code);
+};
+var AVAILABILITIES = [
+    'InStock',
+    'OutOfStock',
+    'PreOrder',
+    'PreSale',
+    'Discontinued',
+    'OnlineOnly',
+    'InStoreOnly',
+    'LimitedAvailability',
+    'BackOrder',
+];
+var normalizeAvailability = function (val) {
+    if (!val)
+        return undefined;
+    try {
+        var asUrl = String(val);
+        if (asUrl.startsWith('http')) {
+            var token = asUrl.replace(/https?:\/\/schema\.org\//i, '');
+            if (AVAILABILITIES.includes(token))
+                return "https://schema.org/".concat(token);
+            return undefined;
+        }
+        if (AVAILABILITIES.includes(asUrl))
+            return "https://schema.org/".concat(asUrl);
+        return undefined;
+    }
+    catch (_a) {
+        return undefined;
+    }
+};
+var generateShoppingMerchantListingSchema = function (_a) {
+    var merchant = _a.merchant, name = _a.name, url = _a.url, products = _a.products, _b = _a.skipInvalidCurrency, skipInvalidCurrency = _b === void 0 ? false : _b;
+    var itemList = products.map(function (p, i) {
+        var product = {
+            '@type': 'Product',
+            name: p.name,
+        };
+        if (p.id)
+            product['@id'] = p.id;
+        if (p.url)
+            product.url = p.url;
+        var img = formatImage(p.image);
+        if (img)
+            product.image = img;
+        if (p.description)
+            product.description = p.description;
+        var brand = formatBrand(p.brand);
+        if (brand)
+            product.brand = brand;
+        if (p.sku)
+            product.sku = p.sku;
+        if (p.offers) {
+            var offs = Array.isArray(p.offers) ? p.offers : [p.offers];
+            var mapped = offs
+                .map(function (o) {
+                if (o.priceCurrency && !isValidCurrency(o.priceCurrency))
+                    return { __invalidCurrency: o.priceCurrency };
+                var of = { '@type': 'Offer' };
+                if (o.price != null)
+                    of.price = o.price;
+                if (o.priceCurrency)
+                    of.priceCurrency = o.priceCurrency;
+                if (o.availability) {
+                    var n = normalizeAvailability(o.availability);
+                    if (n)
+                        of.availability = n;
+                }
+                if (o.url)
+                    of.url = o.url;
+                if (o.seller)
+                    of.seller = __assign(__assign({ '@type': 'Organization' }, (o.seller.name && { name: o.seller.name })), (o.seller.url && { url: o.seller.url }));
+                if (o.priceValidUntil)
+                    of.priceValidUntil = o.priceValidUntil;
+                if (o.itemCondition)
+                    of.itemCondition = o.itemCondition;
+                return of;
+            })
+                .filter(function (x) { return x && !('__invalidCurrency' in x); });
+            var hadInvalid = offs.some(function (o) { return o.priceCurrency && !isValidCurrency(o.priceCurrency); });
+            if (hadInvalid && !skipInvalidCurrency) {
+                var bad = offs.find(function (o) { return o.priceCurrency && !isValidCurrency(o.priceCurrency); });
+                throw new Error("Invalid currency code: ".concat(bad === null || bad === void 0 ? void 0 : bad.priceCurrency));
+            }
+            if (mapped.length === 1)
+                product.offers = mapped[0];
+            else if (mapped.length > 1)
+                product.offers = mapped;
+        }
+        return {
+            '@type': 'ListItem',
+            position: i + 1,
+            item: product,
+        };
+    });
+    var schema = {
+        '@context': 'https://schema.org',
+        '@type': 'ItemList',
+        itemListElement: itemList,
+    };
+    if (name)
+        schema.name = name;
+    if (url)
+        schema.mainEntityOfPage = { '@type': 'WebPage', '@id': url };
+    if (merchant)
+        schema.provider = __assign({ '@type': 'Organization', name: merchant.name }, (merchant.url && { url: merchant.url }));
+    return schema;
+};
+exports.generateShoppingMerchantListingSchema = generateShoppingMerchantListingSchema;

package/general/generate-shopping-merchant-return-policy-schema.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Generate schema.org structured data for a merchant return policy
+ * (`MerchantReturnPolicy`).
+ *
+ * The utility supports normalizing the `returnPolicyCategory` token or
+ * URL and optionally validates currency codes for `returnFees`. Set
+ * `skipInvalidCurrency` to true to ignore currency validation.
+ *
+ * See `ReturnPolicyOptions` for available fields.
+ * @returns A JSON-LD compatible `MerchantReturnPolicy` object
+ */
+interface MerchantRef {
+    name: string;
+    url?: string;
+}
+interface ReturnFees {
+    amount?: number | string;
+    currency?: string;
+}
+interface ReturnPolicyOptions {
+    name: string;
+    description?: string;
+    merchant?: MerchantRef;
+    returnPolicyCategory?: string;
+    returnMethods?: string[];
+    inStoreReturns?: boolean;
+    returnFees?: ReturnFees;
+    skipInvalidCurrency?: boolean;
+}
+export declare const generateShoppingReturnPolicySchema: ({ name, description, merchant, returnPolicyCategory, returnMethods, inStoreReturns, returnFees, skipInvalidCurrency, }: ReturnPolicyOptions) => any;
+export {};

package/general/generate-shopping-merchant-return-policy-schema.js

@@ -0,0 +1,68 @@
+"use strict";
+/**
+ * Generate schema.org structured data for a merchant return policy
+ * (`MerchantReturnPolicy`).
+ *
+ * The utility supports normalizing the `returnPolicyCategory` token or
+ * URL and optionally validates currency codes for `returnFees`. Set
+ * `skipInvalidCurrency` to true to ignore currency validation.
+ *
+ * See `ReturnPolicyOptions` for available fields.
+ * @returns A JSON-LD compatible `MerchantReturnPolicy` object
+ */
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateShoppingReturnPolicySchema = void 0;
+var isValidCurrency = function (code) {
+    if (!code)
+        return false;
+    return /^[A-Z]{3}$/.test(code);
+};
+var normalizePolicyCategory = function (val) {
+    if (!val)
+        return undefined;
+    var s = String(val);
+    if (s.startsWith('http'))
+        return s;
+    return "https://schema.org/".concat(s);
+};
+var generateShoppingReturnPolicySchema = function (_a) {
+    var name = _a.name, description = _a.description, merchant = _a.merchant, returnPolicyCategory = _a.returnPolicyCategory, returnMethods = _a.returnMethods, inStoreReturns = _a.inStoreReturns, returnFees = _a.returnFees, _b = _a.skipInvalidCurrency, skipInvalidCurrency = _b === void 0 ? false : _b;
+    var schema = {
+        '@context': 'https://schema.org',
+        '@type': 'MerchantReturnPolicy',
+        name: name,
+    };
+    if (description)
+        schema.description = description;
+    if (merchant)
+        schema.merchant = __assign({ '@type': 'Organization', name: merchant.name }, (merchant.url && { url: merchant.url }));
+    var cat = normalizePolicyCategory(returnPolicyCategory);
+    if (cat)
+        schema.returnPolicyCategory = cat;
+    if (returnMethods && returnMethods.length > 0)
+        schema.returnMethods = returnMethods;
+    if (typeof inStoreReturns === 'boolean')
+        schema.inStoreReturns = inStoreReturns;
+    if (returnFees) {
+        if (returnFees.currency && !isValidCurrency(returnFees.currency)) {
+            if (!skipInvalidCurrency)
+                throw new Error("Invalid currency code: ".concat(returnFees.currency));
+        }
+        else {
+            schema.returnShippingFees = __assign({ '@type': 'MonetaryAmount', value: returnFees.amount }, (returnFees.currency && { currency: returnFees.currency }));
+        }
+    }
+    return schema;
+};
+exports.generateShoppingReturnPolicySchema = generateShoppingReturnPolicySchema;

package/general/generate-shopping-merchant-shipping-policy-schema.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Generate schema.org JSON-LD for a merchant shipping policy or service
+ * (`ShippingService`).
+ *
+ * Supports provider information, shipping rates (with currency
+ * validation), transit time ranges, free shipping thresholds, and an
+ * optional `shippingSettingsLink`.
+ *
+ * See `ShippingPolicyOptions` for supported fields and the
+ * `skipInvalidCurrency` flag behaviour.
+ * @returns A JSON-LD compatible `ShippingService` object
+ */
+interface MerchantRef {
+    name: string;
+    url?: string;
+}
+interface ShippingRate {
+    price?: number | string;
+    currency?: string;
+    shippingLabel?: string;
+}
+interface ShippingPolicyOptions {
+    name: string;
+    provider?: MerchantRef;
+    description?: string;
+    shippingDestination?: string;
+    transitTimeMinDays?: number;
+    transitTimeMaxDays?: number;
+    shippingRate?: ShippingRate;
+    shippingSettingsLink?: string;
+    freeShippingThreshold?: number | string;
+    skipInvalidCurrency?: boolean;
+}
+export declare const generateShoppingShippingPolicySchema: ({ name, provider, description, shippingDestination, transitTimeMinDays, transitTimeMaxDays, shippingRate, shippingSettingsLink, freeShippingThreshold, skipInvalidCurrency, }: ShippingPolicyOptions) => any;
+export {};

package/general/generate-shopping-merchant-shipping-policy-schema.js

@@ -0,0 +1,74 @@
+"use strict";
+/**
+ * Generate schema.org JSON-LD for a merchant shipping policy or service
+ * (`ShippingService`).
+ *
+ * Supports provider information, shipping rates (with currency
+ * validation), transit time ranges, free shipping thresholds, and an
+ * optional `shippingSettingsLink`.
+ *
+ * See `ShippingPolicyOptions` for supported fields and the
+ * `skipInvalidCurrency` flag behaviour.
+ * @returns A JSON-LD compatible `ShippingService` object
+ */
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateShoppingShippingPolicySchema = void 0;
+var isValidCurrency = function (code) {
+    if (!code)
+        return false;
+    return /^[A-Z]{3}$/.test(code);
+};
+var normalizeDestination = function (val) {
+    if (!val)
+        return undefined;
+    var s = String(val);
+    if (s.startsWith('http'))
+        return s;
+    return s;
+};
+var generateShoppingShippingPolicySchema = function (_a) {
+    var name = _a.name, provider = _a.provider, description = _a.description, shippingDestination = _a.shippingDestination, transitTimeMinDays = _a.transitTimeMinDays, transitTimeMaxDays = _a.transitTimeMaxDays, shippingRate = _a.shippingRate, shippingSettingsLink = _a.shippingSettingsLink, freeShippingThreshold = _a.freeShippingThreshold, _b = _a.skipInvalidCurrency, skipInvalidCurrency = _b === void 0 ? false : _b;
+    var schema = {
+        '@context': 'https://schema.org',
+        '@type': 'ShippingService',
+        name: name,
+    };
+    if (provider)
+        schema.provider = __assign({ '@type': 'Organization', name: provider.name }, (provider.url && { url: provider.url }));
+    if (description)
+        schema.description = description;
+    var dest = normalizeDestination(shippingDestination);
+    if (dest)
+        schema.shippingDestination = dest;
+    if (transitTimeMinDays != null || transitTimeMaxDays != null) {
+        schema.shippingDeliveryTime = __assign(__assign(__assign({ '@type': 'ShippingDeliveryTime' }, (transitTimeMinDays != null && {
+            transitTimeLabel: "".concat(transitTimeMinDays),
+        })), (transitTimeMinDays != null && { transitTimeMin: transitTimeMinDays })), (transitTimeMaxDays != null && { transitTimeMax: transitTimeMaxDays }));
+    }
+    if (shippingRate) {
+        if (shippingRate.currency && !isValidCurrency(shippingRate.currency)) {
+            if (!skipInvalidCurrency)
+                throw new Error("Invalid currency code: ".concat(shippingRate.currency));
+        }
+        else {
+            schema.shippingRate = __assign(__assign({ '@type': 'MonetaryAmount', value: shippingRate.price }, (shippingRate.currency && { currency: shippingRate.currency })), (shippingRate.shippingLabel && { name: shippingRate.shippingLabel }));
+        }
+    }
+    if (shippingSettingsLink)
+        schema.shippingSettingsLink = shippingSettingsLink;
+    if (freeShippingThreshold != null)
+        schema.freeShippingThreshold = freeShippingThreshold;
+    return schema;
+};
+exports.generateShoppingShippingPolicySchema = generateShoppingShippingPolicySchema;

package/general/generate-shopping-overview-schema.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Generate schema.org `ItemList` JSON-LD for a shopping overview (Products).
+ *
+ * The function emits an `ItemList` where each `ListItem.item` is a
+ * `Product` object with optional `offers` and `aggregateRating`. Use
+ * `skipInvalidCurrency` to ignore invalid currency codes in offers.
+ *
+ * See `ShoppingOverviewOptions` and `ProductItem` for accepted fields.
+ * @returns A JSON-LD compatible `ItemList` of Product objects
+ */
+interface BrandRef {
+    name: string;
+    url?: string;
+}
+interface ProductOffer {
+    price?: string | number;
+    priceCurrency?: string;
+    availability?: string;
+    url?: string;
+}
+interface ProductItem {
+    id?: string;
+    name: string;
+    url?: string;
+    image?: string | {
+        url: string;
+        width?: number;
+        height?: number;
+    };
+    description?: string;
+    brand?: string | BrandRef;
+    sku?: string;
+    aggregateRating?: {
+        ratingValue: number | string;
+        reviewCount?: number;
+    };
+    offers?: ProductOffer | ProductOffer[];
+    priceRange?: {
+        low?: string | number;
+        high?: string | number;
+    };
+    category?: string | string[];
+}
+interface ShoppingOverviewOptions {
+    name?: string;
+    url?: string;
+    products: ProductItem[];
+    skipInvalidCurrency?: boolean;
+}
+export declare const generateShoppingOverviewSchema: ({ name, url, products, skipInvalidCurrency, }: ShoppingOverviewOptions) => any;
+export {};

package/general/generate-shopping-overview-schema.js

@@ -0,0 +1,157 @@
+"use strict";
+/**
+ * Generate schema.org `ItemList` JSON-LD for a shopping overview (Products).
+ *
+ * The function emits an `ItemList` where each `ListItem.item` is a
+ * `Product` object with optional `offers` and `aggregateRating`. Use
+ * `skipInvalidCurrency` to ignore invalid currency codes in offers.
+ *
+ * See `ShoppingOverviewOptions` and `ProductItem` for accepted fields.
+ * @returns A JSON-LD compatible `ItemList` of Product objects
+ */
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateShoppingOverviewSchema = void 0;
+var formatImage = function (image) {
+    if (!image)
+        return undefined;
+    if (typeof image === 'string')
+        return image;
+    return __assign(__assign({ '@type': 'ImageObject', url: image.url }, (image.width && { width: image.width })), (image.height && { height: image.height }));
+};
+var formatBrand = function (b) {
+    if (!b)
+        return undefined;
+    if (typeof b === 'string')
+        return { '@type': 'Brand', name: b };
+    return __assign({ '@type': 'Brand', name: b.name }, (b.url && { url: b.url }));
+};
+var isValidCurrency = function (code) {
+    if (!code)
+        return false;
+    return /^[A-Z]{3}$/.test(code);
+};
+var AVAILABILITIES = [
+    'InStock',
+    'OutOfStock',
+    'PreOrder',
+    'PreSale',
+    'Discontinued',
+    'OnlineOnly',
+    'InStoreOnly',
+    'LimitedAvailability',
+    'BackOrder',
+];
+var normalizeAvailability = function (val) {
+    if (!val)
+        return undefined;
+    try {
+        var asUrl = String(val);
+        if (asUrl.startsWith('http')) {
+            var token = asUrl.replace(/https?:\/\/schema\.org\//i, '');
+            if (AVAILABILITIES.includes(token))
+                return "https://schema.org/".concat(token);
+            return undefined;
+        }
+        if (AVAILABILITIES.includes(asUrl))
+            return "https://schema.org/".concat(asUrl);
+        return undefined;
+    }
+    catch (_a) {
+        return undefined;
+    }
+};
+var generateShoppingOverviewSchema = function (_a) {
+    var name = _a.name, url = _a.url, products = _a.products, _b = _a.skipInvalidCurrency, skipInvalidCurrency = _b === void 0 ? false : _b;
+    var itemList = products.map(function (p, i) {
+        var _a;
+        var product = {
+            '@type': 'Product',
+            name: p.name,
+        };
+        if (p.id)
+            product['@id'] = p.id;
+        if (p.url)
+            product.url = p.url;
+        var img = formatImage(p.image);
+        if (img)
+            product.image = img;
+        if (p.description)
+            product.description = p.description;
+        var brand = formatBrand(p.brand);
+        if (brand)
+            product.brand = brand;
+        if (p.sku)
+            product.sku = p.sku;
+        if (p.category)
+            product.category = Array.isArray(p.category)
+                ? p.category.join(', ')
+                : p.category;
+        if (p.aggregateRating) {
+            product.aggregateRating = __assign({ '@type': 'AggregateRating', ratingValue: p.aggregateRating.ratingValue }, (p.aggregateRating.reviewCount != null && {
+                reviewCount: p.aggregateRating.reviewCount,
+            }));
+        }
+        if (p.priceRange) {
+            product.priceRange =
+                "".concat((_a = p.priceRange.low) !== null && _a !== void 0 ? _a : '').concat(p.priceRange.low != null && p.priceRange.high != null ? " - ".concat(p.priceRange.high) : '').trim();
+        }
+        if (p.offers) {
+            var offs = Array.isArray(p.offers) ? p.offers : [p.offers];
+            var mapped = offs
+                .map(function (o) {
+                if (o.priceCurrency && !isValidCurrency(o.priceCurrency))
+                    return { __invalidCurrency: o.priceCurrency };
+                var of = { '@type': 'Offer' };
+                if (o.price != null)
+                    of.price = o.price;
+                if (o.priceCurrency)
+                    of.priceCurrency = o.priceCurrency;
+                if (o.availability) {
+                    var n = normalizeAvailability(o.availability);
+                    if (n)
+                        of.availability = n;
+                }
+                if (o.url)
+                    of.url = o.url;
+                return of;
+            })
+                .filter(function (x) { return x && !('__invalidCurrency' in x); });
+            var hadInvalid = offs.some(function (o) { return o.priceCurrency && !isValidCurrency(o.priceCurrency); });
+            if (hadInvalid && !skipInvalidCurrency) {
+                var bad = offs.find(function (o) { return o.priceCurrency && !isValidCurrency(o.priceCurrency); });
+                throw new Error("Invalid currency code: ".concat(bad === null || bad === void 0 ? void 0 : bad.priceCurrency));
+            }
+            if (mapped.length === 1)
+                product.offers = mapped[0];
+            else if (mapped.length > 1)
+                product.offers = mapped;
+        }
+        return {
+            '@type': 'ListItem',
+            position: i + 1,
+            item: product,
+        };
+    });
+    var schema = {
+        '@context': 'https://schema.org',
+        '@type': 'ItemList',
+        itemListElement: itemList,
+    };
+    if (name)
+        schema.name = name;
+    if (url)
+        schema.mainEntityOfPage = { '@type': 'WebPage', '@id': url };
+    return schema;
+};
+exports.generateShoppingOverviewSchema = generateShoppingOverviewSchema;

package/general/generate-shopping-product-snippet-schema.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Create schema.org structured data for a single `Product` with optional
+ * `Review` and `Offer` entries.
+ *
+ * Supports brand and seller references, image normalization, review
+ * formatting and simple availability/price handling. Use
+ * `skipInvalidCurrency` to avoid throwing on bad currency codes.
+ *
+ * See `ProductSnippetOptions` for accepted fields.
+ * @returns A JSON-LD compatible `Product` object
+ */
+interface BrandRef {
+    name: string;
+    url?: string;
+}
+interface SellerRef {
+    name?: string;
+    url?: string;
+}
+interface ReviewRating {
+    ratingValue: number | string;
+    bestRating?: number | string;
+}
+interface ReviewItem {
+    author?: string | {
+        name: string;
+    };
+    datePublished?: string;
+    reviewBody?: string;
+    reviewRating?: ReviewRating;
+}
+interface OfferItem {
+    price?: string | number;
+    priceCurrency?: string;
+    availability?: string;
+    url?: string;
+    seller?: SellerRef;
+    priceValidUntil?: string;
+    itemCondition?: string;
+}
+interface ProductSnippetOptions {
+    name: string;
+    description?: string;
+    image?: string | {
+        url: string;
+        width?: number;
+        height?: number;
+    };
+    sku?: string;
+    brand?: string | BrandRef;
+    reviews?: ReviewItem[];
+    offers?: OfferItem | OfferItem[];
+    skipInvalidCurrency?: boolean;
+}
+export declare const generateShoppingProductSnippetSchema: ({ name, description, image, sku, brand, reviews, offers, skipInvalidCurrency, }: ProductSnippetOptions) => any;
+export {};