@react-pakistan/util-functions 1.25.11 → 1.25.13

package/general/generate-speakable-schema.js

@@ -0,0 +1,139 @@
+"use strict";
+/**
+ * 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.
+ */
+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.generateSpeakableSchema = void 0;
+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 formatPublisher = function (p) {
+    if (!p)
+        return undefined;
+    var out = { '@type': 'Organization', name: p.name };
+    if (p.url)
+        out.url = p.url;
+    if (p.logo)
+        out.logo = __assign(__assign({ '@type': 'ImageObject', url: p.logo.url }, (p.logo.width && { width: p.logo.width })), (p.logo.height && { height: p.logo.height }));
+    return out;
+};
+var buildSpeakable = function (s) {
+    if (!s)
+        return undefined;
+    // Normalize into SpeakableSpecification object
+    var spec = { '@type': 'SpeakableSpecification' };
+    if (Array.isArray(s)) {
+        // treat as xpath default
+        spec.xpath = s;
+        return spec;
+    }
+    if (s.xpath && s.xpath.length > 0)
+        spec.xpath = s.xpath;
+    if (s.cssSelector && s.cssSelector.length > 0)
+        spec.cssSelector = s.cssSelector;
+    return spec;
+};
+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.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 generateSpeakableSchema = function (_a) {
+    var _b = _a.type, type = _b === void 0 ? 'Article' : _b, headline = _a.headline, name = _a.name, description = _a.description, url = _a.url, author = _a.author, publisher = _a.publisher, speakable = _a.speakable, reviews = _a.reviews, aggregateRating = _a.aggregateRating, keywords = _a.keywords;
+    var out = {
+        '@context': 'https://schema.org',
+        '@type': type,
+    };
+    if (type === 'Article' && headline)
+        out.headline = headline;
+    if (type === 'WebPage' && name)
+        out.name = name;
+    if (description)
+        out.description = description;
+    if (url)
+        out.mainEntityOfPage = { '@type': 'WebPage', '@id': url };
+    var a = formatPerson(author);
+    if (a)
+        out.author = a;
+    var p = formatPublisher(publisher);
+    if (p)
+        out.publisher = p;
+    var s = buildSpeakable(speakable);
+    if (s)
+        out.speakable = s;
+    // Reviews
+    if (reviews && reviews.length > 0) {
+        var mapped = reviews.map(formatReview);
+        out.review = mapped;
+        // compute aggregate if not given
+        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);
+                out.aggregateRating = {
+                    '@type': 'AggregateRating',
+                    ratingValue: sum / ratings.length,
+                    reviewCount: reviews.length,
+                    ratingCount: ratings.length,
+                };
+            }
+        }
+    }
+    if (aggregateRating) {
+        out.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,
+        }));
+    }
+    if (keywords && keywords.length > 0)
+        out.keywords = keywords.join(', ');
+    return out;
+};
+exports.generateSpeakableSchema = generateSpeakableSchema;
+exports.default = exports.generateSpeakableSchema;

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

@@ -0,0 +1,59 @@
+/**
+ * Generate schema.org JSON-LD for a `CreativeWork` representing a
+ * Subscription.
+ *
+ * Supports author/publisher, reviews and aggregate ratings, accessibility
+ * flags and keywords. Only provided fields are emitted in the returned
+ * object.
+ *
+ * See `SubscriptionOptions` for accepted properties.
+ * @returns A JSON-LD compatible `CreativeWork` (Subscription) 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;
+}
+interface AggregateRatingOptions {
+    ratingValue: number | string;
+    reviewCount?: number;
+    ratingCount?: number;
+    bestRating?: number | string;
+    worstRating?: number | string;
+}
+interface SubscriptionOptions {
+    name: string;
+    description?: string;
+    image?: string | ImageRef;
+    url?: string;
+    author?: string | PersonRef;
+    publisher?: string | OrgRef;
+    datePublished?: string;
+    dateModified?: string;
+    isAccessibleForFree?: boolean;
+    genre?: string | string[];
+    keywords?: string | string[];
+    reviews?: ReviewItem[];
+    aggregateRating?: AggregateRatingOptions;
+}
+export declare const generateSubscriptionSchema: ({ name, description, image, url, author, publisher, datePublished, dateModified, isAccessibleForFree, genre, keywords, reviews, aggregateRating, }: SubscriptionOptions) => any;
+export default generateSubscriptionSchema;

package/general/generate-subscription-schema.js

@@ -0,0 +1,133 @@
+"use strict";
+/**
+ * Generate schema.org JSON-LD for a `CreativeWork` representing a
+ * Subscription.
+ *
+ * Supports author/publisher, reviews and aggregate ratings, accessibility
+ * flags and keywords. Only provided fields are emitted in the returned
+ * object.
+ *
+ * See `SubscriptionOptions` for accepted properties.
+ * @returns A JSON-LD compatible `CreativeWork` (Subscription) 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.generateSubscriptionSchema = 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.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 generateSubscriptionSchema = function (_a) {
+    var name = _a.name, description = _a.description, image = _a.image, url = _a.url, author = _a.author, publisher = _a.publisher, datePublished = _a.datePublished, dateModified = _a.dateModified, isAccessibleForFree = _a.isAccessibleForFree, genre = _a.genre, keywords = _a.keywords, reviews = _a.reviews, aggregateRating = _a.aggregateRating;
+    var schema = {
+        '@context': 'https://schema.org',
+        '@type': 'CreativeWork',
+        name: name,
+    };
+    if (description)
+        schema.description = description;
+    var img = formatImage(image);
+    if (img)
+        schema.image = img;
+    if (url)
+        schema.url = url;
+    var a = formatPerson(author);
+    if (a)
+        schema.author = a;
+    var p = formatOrganization(publisher);
+    if (p)
+        schema.publisher = p;
+    if (datePublished)
+        schema.datePublished = datePublished;
+    if (dateModified)
+        schema.dateModified = dateModified;
+    if (isAccessibleForFree != null)
+        schema.isAccessibleForFree = isAccessibleForFree;
+    if (genre)
+        schema.genre = Array.isArray(genre) ? genre.join(', ') : genre;
+    if (keywords)
+        schema.keywords = Array.isArray(keywords) ? keywords.join(', ') : keywords;
+    // Reviews -> map and compute aggregateRating if possible
+    if (reviews && reviews.length > 0) {
+        var mapped = reviews.map(formatReview);
+        schema.review = mapped;
+        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,
+                };
+            }
+        }
+    }
+    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.generateSubscriptionSchema = generateSubscriptionSchema;
+exports.default = exports.generateSubscriptionSchema;

package/general/generate-vacation-rental-schema.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Generate schema.org `VacationRental` JSON-LD including optional reviews
+ * and `AggregateRating`.
+ *
+ * The function accepts address or geo information, images, host references,
+ * and occupancy data. Reviews and aggregate ratings are formatted into
+ * `Review` and `AggregateRating` objects when provided.
+ *
+ * See `VacationRentalOptions` below for supported inputs.
+ * @returns A JSON-LD compatible `VacationRental` object
+ */
+interface ImageRef {
+    url: string;
+    width?: number;
+    height?: number;
+}
+interface PersonRef {
+    name: string;
+    url?: string;
+}
+interface AddressRef {
+    streetAddress?: string;
+    addressLocality?: string;
+    addressRegion?: string;
+    postalCode?: string;
+    addressCountry?: string;
+}
+interface GeoRef {
+    latitude?: number | string;
+    longitude?: number | string;
+}
+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 VacationRentalOptions {
+    name: string;
+    description?: string;
+    image?: string | ImageRef | (string | ImageRef)[];
+    url?: string;
+    address?: string | AddressRef;
+    geo?: GeoRef;
+    numberOfRooms?: number;
+    numberOfBeds?: number;
+    priceRange?: string;
+    host?: string | PersonRef;
+    reviews?: ReviewItem[];
+    aggregateRating?: AggregateRatingOptions;
+    keywords?: string | string[];
+}
+export declare const generateVacationRentalSchema: ({ name, description, image, url, address, geo, numberOfRooms, numberOfBeds, priceRange, host, reviews, aggregateRating, keywords, }: VacationRentalOptions) => any;
+export default generateVacationRentalSchema;

package/general/generate-vacation-rental-schema.js

@@ -0,0 +1,135 @@
+"use strict";
+/**
+ * Generate schema.org `VacationRental` JSON-LD including optional reviews
+ * and `AggregateRating`.
+ *
+ * The function accepts address or geo information, images, host references,
+ * and occupancy data. Reviews and aggregate ratings are formatted into
+ * `Review` and `AggregateRating` objects when provided.
+ *
+ * See `VacationRentalOptions` below for supported inputs.
+ * @returns A JSON-LD compatible `VacationRental` 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.generateVacationRentalSchema = void 0;
+var formatImage = function (image) {
+    if (!image)
+        return undefined;
+    if (Array.isArray(image))
+        return image.map(function (i) {
+            return typeof i === 'string'
+                ? i
+                : __assign(__assign({ '@type': 'ImageObject', url: i.url }, (i.width && { width: i.width })), (i.height && { height: i.height }));
+        });
+    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 formatAddress = function (a) {
+    if (!a)
+        return undefined;
+    if (typeof a === 'string')
+        return a;
+    return __assign(__assign(__assign(__assign(__assign({ '@type': 'PostalAddress' }, (a.streetAddress && { streetAddress: a.streetAddress })), (a.addressLocality && { addressLocality: a.addressLocality })), (a.addressRegion && { addressRegion: a.addressRegion })), (a.postalCode && { postalCode: a.postalCode })), (a.addressCountry && { addressCountry: a.addressCountry }));
+};
+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.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 generateVacationRentalSchema = function (_a) {
+    var name = _a.name, description = _a.description, image = _a.image, url = _a.url, address = _a.address, geo = _a.geo, numberOfRooms = _a.numberOfRooms, numberOfBeds = _a.numberOfBeds, priceRange = _a.priceRange, host = _a.host, reviews = _a.reviews, aggregateRating = _a.aggregateRating, keywords = _a.keywords;
+    var schema = {
+        '@context': 'https://schema.org',
+        '@type': 'VacationRental',
+        name: name,
+    };
+    if (description)
+        schema.description = description;
+    var img = formatImage(image);
+    if (img)
+        schema.image = img;
+    if (url)
+        schema.url = url;
+    var a = formatAddress(address);
+    if (a)
+        schema.address = a;
+    if (geo)
+        schema.geo = __assign(__assign({ '@type': 'GeoCoordinates' }, (geo.latitude != null && { latitude: geo.latitude })), (geo.longitude != null && { longitude: geo.longitude }));
+    if (numberOfRooms != null)
+        schema.numberOfRooms = numberOfRooms;
+    if (numberOfBeds != null)
+        schema.numberOfBeds = numberOfBeds;
+    if (priceRange)
+        schema.priceRange = priceRange;
+    var h = formatPerson(host);
+    if (h)
+        schema.host = h;
+    if (keywords)
+        schema.keywords = Array.isArray(keywords) ? keywords.join(', ') : keywords;
+    if (reviews && reviews.length > 0) {
+        var mapped = reviews.map(formatReview);
+        schema.review = mapped;
+        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 (x, y) { return x + y; }, 0);
+                schema.aggregateRating = {
+                    '@type': 'AggregateRating',
+                    ratingValue: sum / ratings.length,
+                    reviewCount: reviews.length,
+                    ratingCount: ratings.length,
+                };
+            }
+        }
+    }
+    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.generateVacationRentalSchema = generateVacationRentalSchema;
+exports.default = exports.generateVacationRentalSchema;

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

@@ -0,0 +1,74 @@
+/**
+ * Generate schema.org structured data for `VideoObject`, `Clip`, or
+ * `BroadcastEvent`.
+ *
+ * The `VideoOptions` input controls which type is produced and supports
+ * optional fields like `aggregateRating`, `reviews`, thumbnails and
+ * associated `Clip` or `BroadcastEvent` metadata. The result is a plain
+ * object ready to be stringified as JSON-LD for inclusion in a page.
+ *
+ * See `VideoOptions` below for accepted fields and shapes.
+ * @returns A JSON-LD compatible Video/Clip/BroadcastEvent 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;
+}
+interface ClipOptions {
+    name?: string;
+    startOffset?: number;
+    endOffset?: number;
+    url?: string;
+}
+interface BroadcastEventOptions {
+    name?: string;
+    startDate?: string;
+    endDate?: string;
+    isLiveBroadcast?: boolean;
+    url?: string;
+}
+interface AggregateRatingOptions {
+    ratingValue: number | string;
+    reviewCount?: number;
+    ratingCount?: number;
+    bestRating?: number | string;
+    worstRating?: number | string;
+}
+interface VideoOptions {
+    type?: 'VideoObject' | 'Clip' | 'BroadcastEvent';
+    name: string;
+    description?: string;
+    thumbnail?: string | ImageRef | (string | ImageRef)[];
+    uploadDate?: string;
+    duration?: string;
+    contentUrl?: string;
+    embedUrl?: string;
+    clip?: ClipOptions;
+    broadcastEvent?: BroadcastEventOptions;
+    publisher?: string | OrgRef;
+    author?: string | PersonRef;
+    reviews?: ReviewItem[];
+    aggregateRating?: AggregateRatingOptions;
+}
+export declare const generateVideoSchema: ({ type, name, description, thumbnail, uploadDate, duration, contentUrl, embedUrl, clip, broadcastEvent, publisher, author, reviews, aggregateRating, }: VideoOptions) => any;
+export default generateVideoSchema;