@react-pakistan/util-functions 1.25.11 → 1.25.13

package/general/generate-shopping-product-snippet-schema.js

@@ -0,0 +1,167 @@
+"use strict";
+/**
+ * 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
+ */
+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.generateShoppingProductSnippetSchema = 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 generateShoppingProductSnippetSchema = function (_a) {
+    var name = _a.name, description = _a.description, image = _a.image, sku = _a.sku, brand = _a.brand, reviews = _a.reviews, offers = _a.offers, _b = _a.skipInvalidCurrency, skipInvalidCurrency = _b === void 0 ? false : _b;
+    var product = {
+        '@context': 'https://schema.org',
+        '@type': 'Product',
+        name: name,
+    };
+    if (description)
+        product.description = description;
+    var img = formatImage(image);
+    if (img)
+        product.image = img;
+    if (sku)
+        product.sku = sku;
+    var b = formatBrand(brand);
+    if (b)
+        product.brand = b;
+    // Reviews -> Review entries + aggregateRating if possible
+    if (reviews && reviews.length > 0) {
+        var mapped = reviews.map(function (r) {
+            var out = { '@type': 'Review' };
+            if (r.author) {
+                out.author =
+                    typeof r.author === 'string'
+                        ? { '@type': 'Person', name: r.author }
+                        : { '@type': 'Person', name: r.author.name };
+            }
+            if (r.datePublished)
+                out.datePublished = r.datePublished;
+            if (r.reviewBody)
+                out.reviewBody = r.reviewBody;
+            if (r.reviewRating) {
+                out.reviewRating = __assign({ '@type': 'Rating', ratingValue: r.reviewRating.ratingValue }, (r.reviewRating.bestRating != null && {
+                    bestRating: r.reviewRating.bestRating,
+                }));
+            }
+            return out;
+        });
+        product.review = mapped;
+        // compute aggregate rating if ratings present
+        var ratings = reviews
+            .map(function (r) { return (r.reviewRating ? Number(r.reviewRating.ratingValue) : NaN); })
+            .filter(function (n) { return !Number.isNaN(n); });
+        if (ratings.length > 0) {
+            var sum = ratings.reduce(function (a, b) { return a + b; }, 0);
+            product.aggregateRating = {
+                '@type': 'AggregateRating',
+                ratingValue: sum / ratings.length,
+                reviewCount: reviews.length,
+            };
+        }
+    }
+    // Offers
+    if (offers) {
+        var offs = Array.isArray(offers) ? offers : [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 product;
+};
+exports.generateShoppingProductSnippetSchema = generateShoppingProductSnippetSchema;

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

@@ -0,0 +1,45 @@
+/**
+ * Generate schema.org `ProductGroup` (variants) and its `Product` variants
+ * JSON-LD.
+ *
+ * Accepts a parent group name and a list of variant `Product` entries with
+ * optional offers. Images and brand references are normalized into the
+ * appropriate schema.org objects.
+ *
+ * See `VariantsOptions` and `VariantProduct` for accepted fields.
+ * @returns A JSON-LD compatible `ProductGroup` object
+ */
+interface BrandRef {
+    name: string;
+    url?: string;
+}
+interface OfferItem {
+    price?: string | number;
+    priceCurrency?: string;
+    availability?: string;
+    url?: string;
+    priceValidUntil?: string;
+    itemCondition?: string;
+}
+interface VariantProduct {
+    id?: string;
+    name: string;
+    sku?: string;
+    url?: string;
+    image?: string | {
+        url: string;
+        width?: number;
+        height?: number;
+    };
+    description?: string;
+    brand?: string | BrandRef;
+    offers?: OfferItem | OfferItem[];
+}
+interface VariantsOptions {
+    name: string;
+    productGroupId?: string;
+    variants: VariantProduct[];
+    skipInvalidCurrency?: boolean;
+}
+export declare const generateShoppingVariantsSchema: ({ name, productGroupId, variants, skipInvalidCurrency, }: VariantsOptions) => any;
+export {};

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

@@ -0,0 +1,143 @@
+"use strict";
+/**
+ * Generate schema.org `ProductGroup` (variants) and its `Product` variants
+ * JSON-LD.
+ *
+ * Accepts a parent group name and a list of variant `Product` entries with
+ * optional offers. Images and brand references are normalized into the
+ * appropriate schema.org objects.
+ *
+ * See `VariantsOptions` and `VariantProduct` for accepted fields.
+ * @returns A JSON-LD compatible `ProductGroup` 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.generateShoppingVariantsSchema = 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 generateShoppingVariantsSchema = function (_a) {
+    var name = _a.name, productGroupId = _a.productGroupId, variants = _a.variants, _b = _a.skipInvalidCurrency, skipInvalidCurrency = _b === void 0 ? false : _b;
+    var mappedVariants = variants.map(function (v) {
+        var product = {
+            '@type': 'Product',
+            name: v.name,
+        };
+        if (v.id)
+            product['@id'] = v.id;
+        if (v.url)
+            product.url = v.url;
+        if (v.sku)
+            product.sku = v.sku;
+        if (v.description)
+            product.description = v.description;
+        var img = formatImage(v.image);
+        if (img)
+            product.image = img;
+        var b = formatBrand(v.brand);
+        if (b)
+            product.brand = b;
+        if (v.offers) {
+            var offs = Array.isArray(v.offers) ? v.offers : [v.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.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 product;
+    });
+    var schema = {
+        '@context': 'https://schema.org',
+        '@type': 'ProductGroup',
+        name: name,
+        hasVariant: mappedVariants,
+    };
+    if (productGroupId)
+        schema['@id'] = productGroupId;
+    return schema;
+};
+exports.generateShoppingVariantsSchema = generateShoppingVariantsSchema;

package/general/generate-software-app-schema.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Generate schema.org `SoftwareApplication` JSON-LD, optionally including
+ * `Review` and `AggregateRating` data.
+ *
+ * Accepts application metadata (platforms, versions, downloads), images,
+ * author/publisher references, reviews and an aggregate rating. Only
+ * provided fields are emitted in the returned object.
+ *
+ * See `SoftwareAppOptions` below for the input shape.
+ * @returns A JSON-LD compatible `SoftwareApplication` object
+ */
+interface ImageRef {
+    url: string;
+    width?: number;
+    height?: number;
+}
+interface PersonRef {
+    name: string;
+    url?: string;
+}
+interface OrgRef {
+    name: string;
+    url?: string;
+}
+interface RatingItem {
+    ratingValue: number | string;
+    bestRating?: number | string;
+    worstRating?: number | string;
+}
+interface ReviewItem {
+    author?: string | PersonRef;
+    datePublished?: string;
+    reviewBody?: string;
+    reviewRating?: RatingItem;
+    name?: string;
+    url?: string;
+    publisher?: string | OrgRef;
+}
+interface AggregateRatingOptions {
+    ratingValue: number | string;
+    reviewCount?: number;
+    ratingCount?: number;
+    bestRating?: number | string;
+    worstRating?: number | string;
+}
+interface SoftwareAppOptions {
+    name: string;
+    description?: string;
+    image?: string | ImageRef;
+    url?: string;
+    softwareVersion?: string;
+    operatingSystem?: string | string[];
+    applicationCategory?: string | string[];
+    downloadUrl?: string;
+    author?: string | PersonRef;
+    publisher?: string | OrgRef;
+    reviews?: ReviewItem[];
+    aggregateRating?: AggregateRatingOptions;
+}
+export declare const generateSoftwareAppSchema: ({ name, description, image, url, softwareVersion, operatingSystem, applicationCategory, downloadUrl, author, publisher, reviews, aggregateRating, }: SoftwareAppOptions) => any;
+export default generateSoftwareAppSchema;

package/general/generate-software-app-schema.js

@@ -0,0 +1,143 @@
+"use strict";
+/**
+ * Generate schema.org `SoftwareApplication` JSON-LD, optionally including
+ * `Review` and `AggregateRating` data.
+ *
+ * Accepts application metadata (platforms, versions, downloads), images,
+ * author/publisher references, reviews and an aggregate rating. Only
+ * provided fields are emitted in the returned object.
+ *
+ * See `SoftwareAppOptions` below for the input shape.
+ * @returns A JSON-LD compatible `SoftwareApplication` 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.generateSoftwareAppSchema = 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 formatPerson = function (p) {
+    if (!p)
+        return undefined;
+    if (typeof p === 'string')
+        return { '@type': 'Person', name: p };
+    var out = { '@type': 'Person', name: p.name };
+    if (p.url)
+        out.url = p.url;
+    return out;
+};
+var formatOrganization = function (o) {
+    if (!o)
+        return undefined;
+    if (typeof o === 'string')
+        return { '@type': 'Organization', name: o };
+    var out = { '@type': 'Organization', name: o.name };
+    if (o.url)
+        out.url = o.url;
+    return out;
+};
+var formatReview = function (r) {
+    var out = { '@type': 'Review' };
+    if (r.author)
+        out.author = formatPerson(r.author);
+    if (r.datePublished)
+        out.datePublished = r.datePublished;
+    if (r.reviewBody)
+        out.reviewBody = r.reviewBody;
+    if (r.name)
+        out.name = r.name;
+    if (r.url)
+        out.url = r.url;
+    if (r.publisher)
+        out.publisher = formatOrganization(r.publisher);
+    if (r.reviewRating) {
+        out.reviewRating = __assign(__assign({ '@type': 'Rating', ratingValue: r.reviewRating.ratingValue }, (r.reviewRating.bestRating != null && {
+            bestRating: r.reviewRating.bestRating,
+        })), (r.reviewRating.worstRating != null && {
+            worstRating: r.reviewRating.worstRating,
+        }));
+    }
+    return out;
+};
+var generateSoftwareAppSchema = function (_a) {
+    var name = _a.name, description = _a.description, image = _a.image, url = _a.url, softwareVersion = _a.softwareVersion, operatingSystem = _a.operatingSystem, applicationCategory = _a.applicationCategory, downloadUrl = _a.downloadUrl, author = _a.author, publisher = _a.publisher, reviews = _a.reviews, aggregateRating = _a.aggregateRating;
+    var schema = {
+        '@context': 'https://schema.org',
+        '@type': 'SoftwareApplication',
+        name: name,
+    };
+    if (description)
+        schema.description = description;
+    var img = formatImage(image);
+    if (img)
+        schema.image = img;
+    if (url)
+        schema.url = url;
+    if (softwareVersion)
+        schema.softwareVersion = softwareVersion;
+    if (operatingSystem)
+        schema.operatingSystem = Array.isArray(operatingSystem)
+            ? operatingSystem.join(', ')
+            : operatingSystem;
+    if (applicationCategory)
+        schema.applicationCategory = Array.isArray(applicationCategory)
+            ? applicationCategory.join(', ')
+            : applicationCategory;
+    if (downloadUrl)
+        schema.downloadUrl = downloadUrl;
+    var a = formatPerson(author);
+    if (a)
+        schema.author = a;
+    var p = formatOrganization(publisher);
+    if (p)
+        schema.publisher = p;
+    // Reviews
+    if (reviews && reviews.length > 0) {
+        var mapped = reviews.map(formatReview);
+        schema.review = mapped;
+        // compute aggregate rating if not explicitly provided
+        if (!aggregateRating) {
+            var ratings = reviews
+                .map(function (r) { return (r.reviewRating ? Number(r.reviewRating.ratingValue) : NaN); })
+                .filter(function (n) { return !Number.isNaN(n); });
+            if (ratings.length > 0) {
+                var sum = ratings.reduce(function (a, b) { return a + b; }, 0);
+                schema.aggregateRating = {
+                    '@type': 'AggregateRating',
+                    ratingValue: sum / ratings.length,
+                    reviewCount: reviews.length,
+                    ratingCount: ratings.length,
+                };
+            }
+        }
+    }
+    // explicit aggregateRating provided
+    if (aggregateRating) {
+        schema.aggregateRating = __assign(__assign(__assign(__assign({ '@type': 'AggregateRating', ratingValue: aggregateRating.ratingValue }, (aggregateRating.reviewCount != null && {
+            reviewCount: aggregateRating.reviewCount,
+        })), (aggregateRating.ratingCount != null && {
+            ratingCount: aggregateRating.ratingCount,
+        })), (aggregateRating.bestRating != null && {
+            bestRating: aggregateRating.bestRating,
+        })), (aggregateRating.worstRating != null && {
+            worstRating: aggregateRating.worstRating,
+        }));
+    }
+    return schema;
+};
+exports.generateSoftwareAppSchema = generateSoftwareAppSchema;
+exports.default = exports.generateSoftwareAppSchema;

package/general/generate-speakable-schema.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Generate schema.org structured data for an `Article` or `WebPage` with a
+ * `SpeakableSpecification`.
+ *
+ * The `speakable` input may be an array of XPaths/CSS selectors or an
+ * object with `xpath`/`cssSelector` arrays. The helper will produce a
+ * `SpeakableSpecification` and attach it to the chosen page type.
+ *
+ * See `SpeakableOptions` for full details.
+ * @returns A JSON-LD compatible Article/WebPage object with `speakable`
+ * specification when provided.
+ */
+type SpeakableInput = string[] | {
+    xpath?: string[];
+    cssSelector?: string[];
+};
+type PageType = 'Article' | 'WebPage';
+interface PersonRef {
+    name: string;
+    url?: string;
+}
+interface PublisherRef {
+    name: string;
+    url?: string;
+    logo?: {
+        url: string;
+        width?: number;
+        height?: number;
+    };
+}
+interface RatingItem {
+    ratingValue: number | string;
+    bestRating?: number | string;
+    worstRating?: number | string;
+}
+interface ReviewItem {
+    author?: string | PersonRef;
+    datePublished?: string;
+    reviewBody?: string;
+    reviewRating?: RatingItem;
+}
+interface AggregateRatingOptions {
+    ratingValue: number | string;
+    reviewCount?: number;
+    ratingCount?: number;
+    bestRating?: number | string;
+    worstRating?: number | string;
+}
+interface SpeakableOptions {
+    type?: PageType;
+    headline?: string;
+    name?: string;
+    description?: string;
+    url?: string;
+    author?: string | PersonRef;
+    publisher?: PublisherRef;
+    speakable?: SpeakableInput;
+    reviews?: ReviewItem[];
+    aggregateRating?: AggregateRatingOptions;
+    keywords?: string[];
+}
+export declare const generateSpeakableSchema: ({ type, headline, name, description, url, author, publisher, speakable, reviews, aggregateRating, keywords, }: SpeakableOptions) => any;
+export default generateSpeakableSchema;