@react-pakistan/util-functions 1.25.11 → 1.25.13

package/general/generate-video-schema.js

@@ -0,0 +1,163 @@
+"use strict";
+/**
+ * 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
+ */
+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.generateVideoSchema = void 0;
+var formatImage = function (i) {
+    if (!i)
+        return undefined;
+    if (Array.isArray(i))
+        return i.map(function (item) {
+            return typeof item === 'string'
+                ? item
+                : __assign(__assign({ '@type': 'ImageObject', url: item.url }, (item.width && { width: item.width })), (item.height && { height: item.height }));
+        });
+    if (typeof i === 'string')
+        return i;
+    return __assign(__assign({ '@type': 'ImageObject', url: i.url }, (i.width && { width: i.width })), (i.height && { height: i.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 formatOrg = 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 generateVideoSchema = function (_a) {
+    var _b = _a.type, type = _b === void 0 ? 'VideoObject' : _b, name = _a.name, description = _a.description, thumbnail = _a.thumbnail, uploadDate = _a.uploadDate, duration = _a.duration, contentUrl = _a.contentUrl, embedUrl = _a.embedUrl, clip = _a.clip, broadcastEvent = _a.broadcastEvent, publisher = _a.publisher, author = _a.author, reviews = _a.reviews, aggregateRating = _a.aggregateRating;
+    var schema = {
+        '@context': 'https://schema.org',
+        '@type': type,
+        name: name,
+    };
+    if (description)
+        schema.description = description;
+    var thumb = formatImage(thumbnail);
+    if (thumb)
+        schema.thumbnail = thumb;
+    if (uploadDate)
+        schema.uploadDate = uploadDate;
+    if (duration)
+        schema.duration = duration;
+    if (contentUrl)
+        schema.contentUrl = contentUrl;
+    if (embedUrl)
+        schema.embedUrl = embedUrl;
+    var a = formatOrg(publisher);
+    if (a)
+        schema.publisher = a;
+    var au = formatPerson(author);
+    if (au)
+        schema.author = au;
+    if (clip) {
+        var c = { '@type': 'Clip' };
+        if (clip.name)
+            c.name = clip.name;
+        if (clip.startOffset != null)
+            c.startOffset = clip.startOffset;
+        if (clip.endOffset != null)
+            c.endOffset = clip.endOffset;
+        if (clip.url)
+            c.url = clip.url;
+        schema.clip = c;
+    }
+    if (broadcastEvent) {
+        var b = { '@type': 'BroadcastEvent' };
+        if (broadcastEvent.name)
+            b.name = broadcastEvent.name;
+        if (broadcastEvent.startDate)
+            b.startDate = broadcastEvent.startDate;
+        if (broadcastEvent.endDate)
+            b.endDate = broadcastEvent.endDate;
+        if (broadcastEvent.isLiveBroadcast != null)
+            b.isLiveBroadcast = broadcastEvent.isLiveBroadcast;
+        if (broadcastEvent.url)
+            b.url = broadcastEvent.url;
+        schema.broadcaster = b;
+    }
+    // Reviews
+    if (reviews && reviews.length > 0) {
+        var mapped = reviews.map(formatReview);
+        schema.review = mapped;
+        // compute aggregate rating if not supplied
+        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.generateVideoSchema = generateVideoSchema;
+exports.default = exports.generateVideoSchema;

package/general/index.d.ts

@@ -19,12 +19,42 @@ export * from './format-secs';
 export * from './format-time';
 export * from './full-month-range';
 export * from './full-year-range';
+export * from './generate-article-schema';
+export * from './generate-book-schema';
 export * from './generate-blog-schema';
+export * from './generate-carousel-schema';
+export * from './generate-course-schema';
+export * from './generate-dataset-schema';
+export * from './generate-discussion-forum-schema';
+export * from './generate-education-schema';
+export * from './generate-employer-aggregate-rating-schema';
 export * from './generate-breadcrumb-schema';
 export * from './generate-faq-schema';
+export * from './generate-event-schema';
+export * from './generate-image-metadata-schema';
+export * from './generate-job-posting-schema';
 export * from './generate-grid';
+export * from './generate-local-business-schema';
+export * from './generate-movie-carousel-schema';
 export * from './generate-organization-schema';
+export * from './generate-math-solver-schema';
+export * from './generate-shopping-overview-schema';
+export * from './generate-shopping-product-snippet-schema';
+export * from './generate-shopping-merchant-listing-schema';
+export * from './generate-shopping-variants-schema';
+export * from './generate-shopping-loyalty-program-schema';
+export * from './generate-shopping-merchant-return-policy-schema';
+export * from './generate-shopping-merchant-shipping-policy-schema';
+export * from './generate-profile-page-schema';
+export * from './generate-qa-page-schema';
 export * from './generate-ref';
+export * from './generate-recipe-schema';
+export * from './generate-review-snippet-schema';
+export * from './generate-software-app-schema';
+export * from './generate-speakable-schema';
+export * from './generate-subscription-schema';
+export * from './generate-vacation-rental-schema';
+export * from './generate-video-schema';
 export * from './generic-cache';
 export * from './get-available-page-limit';
 export * from './get-calendar-current-month';

package/general/index.js

@@ -35,12 +35,42 @@ __exportStar(require("./format-secs"), exports);
 __exportStar(require("./format-time"), exports);
 __exportStar(require("./full-month-range"), exports);
 __exportStar(require("./full-year-range"), exports);
+__exportStar(require("./generate-article-schema"), exports);
+__exportStar(require("./generate-book-schema"), exports);
 __exportStar(require("./generate-blog-schema"), exports);
+__exportStar(require("./generate-carousel-schema"), exports);
+__exportStar(require("./generate-course-schema"), exports);
+__exportStar(require("./generate-dataset-schema"), exports);
+__exportStar(require("./generate-discussion-forum-schema"), exports);
+__exportStar(require("./generate-education-schema"), exports);
+__exportStar(require("./generate-employer-aggregate-rating-schema"), exports);
 __exportStar(require("./generate-breadcrumb-schema"), exports);
 __exportStar(require("./generate-faq-schema"), exports);
+__exportStar(require("./generate-event-schema"), exports);
+__exportStar(require("./generate-image-metadata-schema"), exports);
+__exportStar(require("./generate-job-posting-schema"), exports);
 __exportStar(require("./generate-grid"), exports);
+__exportStar(require("./generate-local-business-schema"), exports);
+__exportStar(require("./generate-movie-carousel-schema"), exports);
 __exportStar(require("./generate-organization-schema"), exports);
+__exportStar(require("./generate-math-solver-schema"), exports);
+__exportStar(require("./generate-shopping-overview-schema"), exports);
+__exportStar(require("./generate-shopping-product-snippet-schema"), exports);
+__exportStar(require("./generate-shopping-merchant-listing-schema"), exports);
+__exportStar(require("./generate-shopping-variants-schema"), exports);
+__exportStar(require("./generate-shopping-loyalty-program-schema"), exports);
+__exportStar(require("./generate-shopping-merchant-return-policy-schema"), exports);
+__exportStar(require("./generate-shopping-merchant-shipping-policy-schema"), exports);
+__exportStar(require("./generate-profile-page-schema"), exports);
+__exportStar(require("./generate-qa-page-schema"), exports);
 __exportStar(require("./generate-ref"), exports);
+__exportStar(require("./generate-recipe-schema"), exports);
+__exportStar(require("./generate-review-snippet-schema"), exports);
+__exportStar(require("./generate-software-app-schema"), exports);
+__exportStar(require("./generate-speakable-schema"), exports);
+__exportStar(require("./generate-subscription-schema"), exports);
+__exportStar(require("./generate-vacation-rental-schema"), exports);
+__exportStar(require("./generate-video-schema"), exports);
 __exportStar(require("./generic-cache"), exports);
 __exportStar(require("./get-available-page-limit"), exports);
 __exportStar(require("./get-calendar-current-month"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-pakistan/util-functions",
-  "version": "1.25.11",
+  "version": "1.25.13",
   "description": "A library of all util functions",
   "main": "index.js",
   "scripts": {