@react-pakistan/util-functions 1.25.11 → 1.25.13

package/general/generate-profile-page-schema.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Generate schema.org `ProfilePage` JSON-LD describing a person or profile.
+ *
+ * Accepts a `mainEntity` person object along with optional author or
+ * organization metadata. Images are normalized to `ImageObject` entries.
+ *
+ * See `ProfilePageOptions` and `PersonRef` for the input shape.
+ * @returns A JSON-LD compatible `ProfilePage` object
+ */
+interface ImageRef {
+    url: string;
+    width?: number;
+    height?: number;
+}
+interface PersonRef {
+    name: string;
+    url?: string;
+    sameAs?: string[];
+    jobTitle?: string;
+    image?: string | ImageRef;
+}
+interface OrgRef {
+    name: string;
+    url?: string;
+}
+interface ProfilePageOptions {
+    name?: string;
+    headline?: string;
+    url?: string;
+    description?: string;
+    mainEntity?: PersonRef;
+    author?: PersonRef | OrgRef;
+    about?: string[];
+}
+export declare const generateProfilePageSchema: ({ name, headline, url, description, mainEntity, author, about, }: ProfilePageOptions) => any;
+export {};

package/general/generate-profile-page-schema.js

@@ -0,0 +1,82 @@
+"use strict";
+/**
+ * Generate schema.org `ProfilePage` JSON-LD describing a person or profile.
+ *
+ * Accepts a `mainEntity` person object along with optional author or
+ * organization metadata. Images are normalized to `ImageObject` entries.
+ *
+ * See `ProfilePageOptions` and `PersonRef` for the input shape.
+ * @returns A JSON-LD compatible `ProfilePage` 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.generateProfilePageSchema = 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;
+    var out = { '@type': 'Person', name: p.name };
+    if (p.url)
+        out.url = p.url;
+    if (p.sameAs)
+        out.sameAs = p.sameAs;
+    if (p.jobTitle)
+        out.jobTitle = p.jobTitle;
+    var img = formatImage(p.image);
+    if (img)
+        out.image = img;
+    return out;
+};
+var formatAuthor = function (a) {
+    if (!a)
+        return undefined;
+    var isPerson = a.jobTitle !== undefined ||
+        a.sameAs !== undefined;
+    if (isPerson)
+        return formatPerson(a);
+    var out = { '@type': 'Organization', name: a.name };
+    if (a.url)
+        out.url = a.url;
+    return out;
+};
+var generateProfilePageSchema = function (_a) {
+    var name = _a.name, headline = _a.headline, url = _a.url, description = _a.description, mainEntity = _a.mainEntity, author = _a.author, about = _a.about;
+    var schema = {
+        '@context': 'https://schema.org',
+        '@type': 'ProfilePage',
+    };
+    if (name)
+        schema.name = name;
+    if (headline)
+        schema.headline = headline;
+    if (url)
+        schema.mainEntityOfPage = { '@type': 'WebPage', '@id': url };
+    if (description)
+        schema.description = description;
+    var me = formatPerson(mainEntity);
+    if (me)
+        schema.mainEntity = me;
+    var a = formatAuthor(author);
+    if (a)
+        schema.author = a;
+    if (about && about.length > 0)
+        schema.about = about;
+    return schema;
+};
+exports.generateProfilePageSchema = generateProfilePageSchema;

package/general/generate-qa-page-schema.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Generate schema.org `QAPage` JSON-LD (Question + Answers).
+ *
+ * The helper formats a single `Question` and its `Answer` entries,
+ * including author references and date fields. Use `acceptedAnswer` and
+ * `suggestedAnswer` to provide preferred or additional answers.
+ *
+ * See `QAPageOptions` and related types for the input contract.
+ * @returns A JSON-LD compatible `QAPage` object
+ */
+interface PersonRef {
+    name: string;
+    url?: string;
+}
+interface AnswerItem {
+    text: string;
+    author?: string | PersonRef;
+    datePublished?: string;
+}
+interface QuestionItem {
+    name: string;
+    text?: string;
+    author?: string | PersonRef;
+    datePublished?: string;
+    answers?: AnswerItem[];
+    acceptedAnswer?: AnswerItem;
+}
+interface QAPageOptions {
+    headline?: string;
+    mainEntity: QuestionItem;
+}
+export declare const generateQAPageSchema: ({ headline, mainEntity, }: QAPageOptions) => any;
+export {};

package/general/generate-qa-page-schema.js

@@ -0,0 +1,67 @@
+"use strict";
+/**
+ * Generate schema.org `QAPage` JSON-LD (Question + Answers).
+ *
+ * The helper formats a single `Question` and its `Answer` entries,
+ * including author references and date fields. Use `acceptedAnswer` and
+ * `suggestedAnswer` to provide preferred or additional answers.
+ *
+ * See `QAPageOptions` and related types for the input contract.
+ * @returns A JSON-LD compatible `QAPage` object
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateQAPageSchema = 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 formatAnswer = function (a) {
+    var out = { '@type': 'Answer' };
+    if (a.text)
+        out.text = a.text;
+    if (a.author)
+        out.author = formatPerson(a.author);
+    if (a.datePublished)
+        out.datePublished = a.datePublished;
+    return out;
+};
+var generateQAPageSchema = function (_a) {
+    var headline = _a.headline, mainEntity = _a.mainEntity;
+    var question = {
+        '@type': 'Question',
+        name: mainEntity.name,
+    };
+    if (mainEntity.text)
+        question.text = mainEntity.text;
+    if (mainEntity.author)
+        question.author = formatPerson(mainEntity.author);
+    if (mainEntity.datePublished)
+        question.datePublished = mainEntity.datePublished;
+    if (mainEntity.answers && mainEntity.answers.length > 0) {
+        question.answerCount = mainEntity.answers.length;
+        question.acceptedAnswer = mainEntity.acceptedAnswer
+            ? formatAnswer(mainEntity.acceptedAnswer)
+            : undefined;
+        question.suggestedAnswer = mainEntity.answers
+            .filter(function (a) {
+            return !mainEntity.acceptedAnswer ||
+                a.text !== mainEntity.acceptedAnswer.text;
+        })
+            .map(function (a) { return formatAnswer(a); });
+    }
+    var schema = {
+        '@context': 'https://schema.org',
+        '@type': 'QAPage',
+        mainEntity: question,
+    };
+    if (headline)
+        schema.headline = headline;
+    return schema;
+};
+exports.generateQAPageSchema = generateQAPageSchema;

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

@@ -0,0 +1,48 @@
+/**
+ * Generate schema.org `Recipe` JSON-LD, with support for `HowToStep`
+ * instructions and `ItemList` ingredients.
+ *
+ * Accepts recipe metadata (times, yields, cuisine, ingredients, steps)
+ * and will format steps as `HowToStep` objects and images as `ImageObject`
+ * entries when provided.
+ *
+ * See `RecipeOptions` for the accepted input shape.
+ * @returns A JSON-LD compatible `Recipe` object
+ */
+interface ImageRef {
+    url: string;
+    width?: number;
+    height?: number;
+}
+interface PersonRef {
+    name: string;
+    url?: string;
+}
+interface HowToStep {
+    name?: string;
+    text: string;
+    image?: string | ImageRef;
+    url?: string;
+}
+interface AggregateRating {
+    ratingValue: number | string;
+    reviewCount?: number;
+}
+interface RecipeOptions {
+    name: string;
+    description?: string;
+    image?: string | ImageRef;
+    author?: string | PersonRef;
+    recipeYield?: string;
+    prepTime?: string;
+    cookTime?: string;
+    totalTime?: string;
+    recipeCategory?: string | string[];
+    recipeCuisine?: string | string[];
+    keywords?: string | string[];
+    recipeIngredient?: string[];
+    recipeInstructions?: HowToStep[];
+    aggregateRating?: AggregateRating;
+}
+export declare const generateRecipeSchema: ({ name, description, image, author, recipeYield, prepTime, cookTime, totalTime, recipeCategory, recipeCuisine, keywords, recipeIngredient, recipeInstructions, aggregateRating, }: RecipeOptions) => any;
+export {};

package/general/generate-recipe-schema.js

@@ -0,0 +1,104 @@
+"use strict";
+/**
+ * Generate schema.org `Recipe` JSON-LD, with support for `HowToStep`
+ * instructions and `ItemList` ingredients.
+ *
+ * Accepts recipe metadata (times, yields, cuisine, ingredients, steps)
+ * and will format steps as `HowToStep` objects and images as `ImageObject`
+ * entries when provided.
+ *
+ * See `RecipeOptions` for the accepted input shape.
+ * @returns A JSON-LD compatible `Recipe` 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.generateRecipeSchema = 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 formatHowToStep = function (s) {
+    var out = { '@type': 'HowToStep' };
+    if (s.name)
+        out.name = s.name;
+    if (s.text)
+        out.text = s.text;
+    if (s.url)
+        out.url = s.url;
+    var img = formatImage(s.image);
+    if (img)
+        out.image = img;
+    return out;
+};
+var generateRecipeSchema = function (_a) {
+    var name = _a.name, description = _a.description, image = _a.image, author = _a.author, recipeYield = _a.recipeYield, prepTime = _a.prepTime, cookTime = _a.cookTime, totalTime = _a.totalTime, recipeCategory = _a.recipeCategory, recipeCuisine = _a.recipeCuisine, keywords = _a.keywords, recipeIngredient = _a.recipeIngredient, recipeInstructions = _a.recipeInstructions, aggregateRating = _a.aggregateRating;
+    var schema = {
+        '@context': 'https://schema.org',
+        '@type': 'Recipe',
+        name: name,
+    };
+    if (description)
+        schema.description = description;
+    var img = formatImage(image);
+    if (img)
+        schema.image = img;
+    var a = formatPerson(author);
+    if (a)
+        schema.author = a;
+    if (recipeYield)
+        schema.recipeYield = recipeYield;
+    if (prepTime)
+        schema.prepTime = prepTime;
+    if (cookTime)
+        schema.cookTime = cookTime;
+    if (totalTime)
+        schema.totalTime = totalTime;
+    if (recipeCategory)
+        schema.recipeCategory = Array.isArray(recipeCategory)
+            ? recipeCategory.join(', ')
+            : recipeCategory;
+    if (recipeCuisine)
+        schema.recipeCuisine = Array.isArray(recipeCuisine)
+            ? recipeCuisine.join(', ')
+            : recipeCuisine;
+    if (keywords)
+        schema.keywords = Array.isArray(keywords) ? keywords.join(', ') : keywords;
+    if (recipeIngredient && recipeIngredient.length > 0)
+        schema.recipeIngredient = recipeIngredient;
+    if (recipeInstructions && recipeInstructions.length > 0) {
+        schema.recipeInstructions = recipeInstructions.map(formatHowToStep);
+    }
+    if (aggregateRating) {
+        schema.aggregateRating = {
+            '@type': 'AggregateRating',
+            ratingValue: aggregateRating.ratingValue,
+        };
+        if (aggregateRating.reviewCount != null)
+            schema.aggregateRating.reviewCount = aggregateRating.reviewCount;
+    }
+    return schema;
+};
+exports.generateRecipeSchema = generateRecipeSchema;

package/general/generate-review-snippet-schema.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Generate structured data for Review snippets and `AggregateRating`.
+ *
+ * Accepts a compact `ReviewSnippetOptions` object and returns a plain object
+ * compatible with schema.org JSON-LD for embedding in a page. The function
+ * supports formatting `Person` and `Organization` references and can produce
+ * an `AggregateRating` object either from supplied options or derived from
+ * reviews.
+ *
+ * See the TypeScript interfaces below for the exact input shape.
+ * @returns A JSON-LD compatible Review / ReviewSnippet object
+ */
+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 ReviewSnippetOptions {
+    itemReviewed?: string | {
+        name: string;
+        '@type'?: string;
+    };
+    reviews?: ReviewItem[];
+    aggregateRating?: AggregateRatingOptions;
+}
+export declare const generateReviewSnippetSchema: ({ itemReviewed, reviews, aggregateRating, }: ReviewSnippetOptions) => any;
+export default generateReviewSnippetSchema;

package/general/generate-review-snippet-schema.js

@@ -0,0 +1,137 @@
+"use strict";
+/**
+ * Generate structured data for Review snippets and `AggregateRating`.
+ *
+ * Accepts a compact `ReviewSnippetOptions` object and returns a plain object
+ * compatible with schema.org JSON-LD for embedding in a page. The function
+ * supports formatting `Person` and `Organization` references and can produce
+ * an `AggregateRating` object either from supplied options or derived from
+ * reviews.
+ *
+ * See the TypeScript interfaces below for the exact input shape.
+ * @returns A JSON-LD compatible Review / ReviewSnippet 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.generateReviewSnippetSchema = 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 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 generateReviewSnippetSchema = function (_a) {
+    var itemReviewed = _a.itemReviewed, reviews = _a.reviews, aggregateRating = _a.aggregateRating;
+    // If an itemReviewed is provided we return that item with nested review(s)
+    var hasItem = !!itemReviewed;
+    // Map reviews if present
+    var mappedReviews = reviews && reviews.length > 0 ? reviews.map(formatReview) : undefined;
+    // Compute aggregate rating from provided aggregateRating or from reviews
+    var agg = undefined;
+    if (aggregateRating) {
+        agg = __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,
+        }));
+    }
+    else if (reviews && reviews.length > 0) {
+        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);
+            agg = {
+                '@type': 'AggregateRating',
+                ratingValue: sum / ratings.length,
+                reviewCount: reviews.length,
+                ratingCount: ratings.length,
+            };
+        }
+    }
+    if (hasItem) {
+        var item = {
+            '@context': 'https://schema.org',
+            '@type': typeof itemReviewed === 'string'
+                ? 'Thing'
+                : (itemReviewed === null || itemReviewed === void 0 ? void 0 : itemReviewed['@type']) || 'Thing',
+            name: typeof itemReviewed === 'string'
+                ? itemReviewed
+                : itemReviewed.name,
+        };
+        if (mappedReviews)
+            item.review = mappedReviews;
+        if (agg)
+            item.aggregateRating = agg;
+        return item;
+    }
+    // No itemReviewed -> if single review return a Review object, else return an array wrapper
+    if (mappedReviews && mappedReviews.length === 1) {
+        var r = mappedReviews[0];
+        var schema_1 = __assign({ '@context': 'https://schema.org' }, r);
+        if (agg)
+            schema_1.aggregateRating = agg;
+        return schema_1;
+    }
+    var schema = {
+        '@context': 'https://schema.org',
+    };
+    if (mappedReviews)
+        schema.review = mappedReviews;
+    if (agg)
+        schema.aggregateRating = agg;
+    return schema;
+};
+exports.generateReviewSnippetSchema = generateReviewSnippetSchema;
+exports.default = exports.generateReviewSnippetSchema;

package/general/generate-shopping-loyalty-program-schema.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Generate schema.org structured data for a loyalty or membership program
+ * (`ProgramMembership`).
+ *
+ * The helper formats membership details, member references, points and
+ * optional offers into a `ProgramMembership` object. Only supplied fields
+ * are emitted.
+ *
+ * See `LoyaltyOptions` for the accepted input properties.
+ * @returns A JSON-LD compatible `ProgramMembership` object
+ */
+interface MemberRef {
+    name: string;
+    url?: string;
+}
+interface OrganizationRef {
+    name: string;
+    url?: string;
+}
+interface LoyaltyOffer {
+    description?: string;
+    url?: string;
+}
+interface LoyaltyOptions {
+    programName: string;
+    programUrl?: string;
+    programId?: string;
+    member?: MemberRef | OrganizationRef;
+    membershipNumber?: string;
+    enrollmentDate?: string;
+    pointsBalance?: number;
+    pointsEarned?: number;
+    benefits?: string[];
+    offers?: LoyaltyOffer[];
+}
+export declare const generateShoppingLoyaltyProgramSchema: ({ programName, programUrl, programId, member, membershipNumber, enrollmentDate, pointsBalance, pointsEarned, benefits, offers, }: LoyaltyOptions) => any;
+export {};

package/general/generate-shopping-loyalty-program-schema.js

@@ -0,0 +1,59 @@
+"use strict";
+/**
+ * Generate schema.org structured data for a loyalty or membership program
+ * (`ProgramMembership`).
+ *
+ * The helper formats membership details, member references, points and
+ * optional offers into a `ProgramMembership` object. Only supplied fields
+ * are emitted.
+ *
+ * See `LoyaltyOptions` for the accepted input properties.
+ * @returns A JSON-LD compatible `ProgramMembership` 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.generateShoppingLoyaltyProgramSchema = void 0;
+var formatAgent = function (a) {
+    if (!a)
+        return undefined;
+    return __assign({ name: a.name }, (a.url && { url: a.url }));
+};
+var generateShoppingLoyaltyProgramSchema = function (_a) {
+    var programName = _a.programName, programUrl = _a.programUrl, programId = _a.programId, member = _a.member, membershipNumber = _a.membershipNumber, enrollmentDate = _a.enrollmentDate, pointsBalance = _a.pointsBalance, pointsEarned = _a.pointsEarned, benefits = _a.benefits, offers = _a.offers;
+    var schema = {
+        '@context': 'https://schema.org',
+        '@type': 'ProgramMembership',
+        programName: programName,
+    };
+    if (programUrl)
+        schema.url = programUrl;
+    if (programId)
+        schema['@id'] = programId;
+    if (member)
+        schema.member = formatAgent(member);
+    if (membershipNumber)
+        schema.membershipNumber = membershipNumber;
+    if (enrollmentDate)
+        schema.enrollmentDate = enrollmentDate;
+    if (typeof pointsBalance === 'number')
+        schema.pointsBalance = pointsBalance;
+    if (typeof pointsEarned === 'number')
+        schema.pointsEarned = pointsEarned;
+    if (benefits && benefits.length > 0)
+        schema.benefits = benefits;
+    if (offers && offers.length > 0) {
+        schema.offers = offers.map(function (o) { return (__assign(__assign({ '@type': 'Offer' }, (o.description && { description: o.description })), (o.url && { url: o.url }))); });
+    }
+    return schema;
+};
+exports.generateShoppingLoyaltyProgramSchema = generateShoppingLoyaltyProgramSchema;