@react-pakistan/util-functions 2.0.2 → 3.0.1

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

@@ -0,0 +1,52 @@
+/**
+ * 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;
+}
+declare const generateReviewSnippetSchema: ({ itemReviewed, reviews, aggregateRating, }: ReviewSnippetOptions) => any;
+
+export { generateReviewSnippetSchema as default, generateReviewSnippetSchema };

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

@@ -0,0 +1 @@
+const f=t=>{if(!t)return;if(typeof t=="string")return{"@type":"Person",name:t};const n={"@type":"Person",name:t.name};return t.url&&(n.url=t.url),n},m=t=>{if(!t)return;if(typeof t=="string")return{"@type":"Organization",name:t};const n={"@type":"Organization",name:t.name};return t.url&&(n.url=t.url),n},R=t=>{const n={"@type":"Review"};return t.author&&(n.author=f(t.author)),t.datePublished&&(n.datePublished=t.datePublished),t.reviewBody&&(n.reviewBody=t.reviewBody),t.name&&(n.name=t.name),t.url&&(n.url=t.url),t.publisher&&(n.publisher=m(t.publisher)),t.reviewRating&&(n.reviewRating={"@type":"Rating",ratingValue:t.reviewRating.ratingValue,...t.reviewRating.bestRating!=null&&{bestRating:t.reviewRating.bestRating},...t.reviewRating.worstRating!=null&&{worstRating:t.reviewRating.worstRating}}),n},p=({itemReviewed:t,reviews:n,aggregateRating:e})=>{const u=!!t,s=n&&n.length>0?n.map(R):void 0;let r;if(e)r={"@type":"AggregateRating",ratingValue:e.ratingValue,...e.reviewCount!=null&&{reviewCount:e.reviewCount},...e.ratingCount!=null&&{ratingCount:e.ratingCount},...e.bestRating!=null&&{bestRating:e.bestRating},...e.worstRating!=null&&{worstRating:e.worstRating}};else if(n&&n.length>0){const i=n.map(a=>a.reviewRating?Number(a.reviewRating.ratingValue):NaN).filter(a=>!Number.isNaN(a));i.length>0&&(r={"@type":"AggregateRating",ratingValue:i.reduce((o,l)=>o+l,0)/i.length,reviewCount:n.length,ratingCount:i.length})}if(u){const i={"@context":"https://schema.org","@type":typeof t=="string"?"Thing":t?.["@type"]||"Thing",name:typeof t=="string"?t:t.name};return s&&(i.review=s),r&&(i.aggregateRating=r),i}if(s&&s.length===1){const a={"@context":"https://schema.org",...s[0]};return r&&(a.aggregateRating=r),a}const g={"@context":"https://schema.org"};return s&&(g.review=s),r&&(g.aggregateRating=r),g};var c=p;export{c as default,p as generateReviewSnippetSchema};

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

@@ -0,0 +1,38 @@
+/**
+ * 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[];
+}
+declare const generateShoppingLoyaltyProgramSchema: ({ programName, programUrl, programId, member, membershipNumber, enrollmentDate, pointsBalance, pointsEarned, benefits, offers, }: LoyaltyOptions) => any;
+
+export { generateShoppingLoyaltyProgramSchema };

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

@@ -0,0 +1 @@
+const p=r=>{if(r)return{name:r.name,...r.url&&{url:r.url}}},u=({programName:r,programUrl:a,programId:f,member:s,membershipNumber:m,enrollmentDate:o,pointsBalance:g,pointsEarned:l,benefits:t,offers:i})=>{const e={"@context":"https://schema.org","@type":"ProgramMembership",programName:r};return a&&(e.url=a),f&&(e["@id"]=f),s&&(e.member=p(s)),m&&(e.membershipNumber=m),o&&(e.enrollmentDate=o),typeof g=="number"&&(e.pointsBalance=g),typeof l=="number"&&(e.pointsEarned=l),t&&t.length>0&&(e.benefits=t),i&&i.length>0&&(e.offers=i.map(n=>({"@type":"Offer",...n.description&&{description:n.description},...n.url&&{url:n.url}}))),e};export{u as generateShoppingLoyaltyProgramSchema};

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

@@ -0,0 +1,53 @@
+/**
+ * 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;
+}
+declare const generateShoppingMerchantListingSchema: ({ merchant, name, url, products, skipInvalidCurrency, }: MerchantListingOptions) => any;
+
+export { generateShoppingMerchantListingSchema };

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

@@ -0,0 +1 @@
+const C=e=>{if(e)return typeof e=="string"?e:{"@type":"ImageObject",url:e.url,...e.width&&{width:e.width},...e.height&&{height:e.height}}},I=e=>{if(e)return typeof e=="string"?{"@type":"Brand",name:e}:{"@type":"Brand",name:e.name,...e.url&&{url:e.url}}},l=e=>e?/^[A-Z]{3}$/.test(e):!1,m=["InStock","OutOfStock","PreOrder","PreSale","Discontinued","OnlineOnly","InStoreOnly","LimitedAvailability","BackOrder"],O=e=>{if(e)try{const s=String(e);if(s.startsWith("http")){const a=s.replace(/https?:\/\/schema\.org\//i,"");return m.includes(a)?`https://schema.org/${a}`:void 0}return m.includes(s)?`https://schema.org/${s}`:void 0}catch{return}},L=({merchant:e,name:s,url:a,products:y,skipInvalidCurrency:p=!1})=>{const c={"@context":"https://schema.org","@type":"ItemList",itemListElement:y.map((i,h)=>{const t={"@type":"Product",name:i.name};i.id&&(t["@id"]=i.id),i.url&&(t.url=i.url);const d=C(i.image);d&&(t.image=d),i.description&&(t.description=i.description);const o=I(i.brand);if(o&&(t.brand=o),i.sku&&(t.sku=i.sku),i.offers){const u=Array.isArray(i.offers)?i.offers:[i.offers],f=u.map(r=>{if(r.priceCurrency&&!l(r.priceCurrency))return{__invalidCurrency:r.priceCurrency};const n={"@type":"Offer"};if(r.price!=null&&(n.price=r.price),r.priceCurrency&&(n.priceCurrency=r.priceCurrency),r.availability){const g=O(r.availability);g&&(n.availability=g)}return r.url&&(n.url=r.url),r.seller&&(n.seller={"@type":"Organization",...r.seller.name&&{name:r.seller.name},...r.seller.url&&{url:r.seller.url}}),r.priceValidUntil&&(n.priceValidUntil=r.priceValidUntil),r.itemCondition&&(n.itemCondition=r.itemCondition),n}).filter(r=>r&&!("__invalidCurrency"in r));if(u.some(r=>r.priceCurrency&&!l(r.priceCurrency))&&!p){const r=u.find(n=>n.priceCurrency&&!l(n.priceCurrency));throw new Error(`Invalid currency code: ${r?.priceCurrency}`)}f.length===1?t.offers=f[0]:f.length>1&&(t.offers=f)}return{"@type":"ListItem",position:h+1,item:t}})};return s&&(c.name=s),a&&(c.mainEntityOfPage={"@type":"WebPage","@id":a}),e&&(c.provider={"@type":"Organization",name:e.name,...e.url&&{url:e.url}}),c};export{L as generateShoppingMerchantListingSchema};

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

@@ -0,0 +1,32 @@
+/**
+ * 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;
+}
+declare const generateShoppingReturnPolicySchema: ({ name, description, merchant, returnPolicyCategory, returnMethods, inStoreReturns, returnFees, skipInvalidCurrency, }: ReturnPolicyOptions) => any;
+
+export { generateShoppingReturnPolicySchema };

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

@@ -0,0 +1 @@
+const y=n=>n?/^[A-Z]{3}$/.test(n):!1,l=n=>{if(!n)return;const e=String(n);return e.startsWith("http")?e:`https://schema.org/${e}`},g=({name:n,description:e,merchant:i,returnPolicyCategory:s,returnMethods:c,inStoreReturns:o,returnFees:r,skipInvalidCurrency:u=!1})=>{const t={"@context":"https://schema.org","@type":"MerchantReturnPolicy",name:n};e&&(t.description=e),i&&(t.merchant={"@type":"Organization",name:i.name,...i.url&&{url:i.url}});const a=l(s);if(a&&(t.returnPolicyCategory=a),c&&c.length>0&&(t.returnMethods=c),typeof o=="boolean"&&(t.inStoreReturns=o),r)if(r.currency&&!y(r.currency)){if(!u)throw new Error(`Invalid currency code: ${r.currency}`)}else t.returnShippingFees={"@type":"MonetaryAmount",value:r.amount,...r.currency&&{currency:r.currency}};return t};export{g as generateShoppingReturnPolicySchema};

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

@@ -0,0 +1,36 @@
+/**
+ * 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;
+}
+declare const generateShoppingShippingPolicySchema: ({ name, provider, description, shippingDestination, transitTimeMinDays, transitTimeMaxDays, shippingRate, shippingSettingsLink, freeShippingThreshold, skipInvalidCurrency, }: ShippingPolicyOptions) => any;
+
+export { generateShoppingShippingPolicySchema };

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

@@ -0,0 +1 @@
+const a=r=>r?/^[A-Z]{3}$/.test(r):!1,f=r=>{if(!r)return;const e=String(r);return e.startsWith("http"),e},h=({name:r,provider:e,description:s,shippingDestination:g,transitTimeMinDays:t,transitTimeMaxDays:c,shippingRate:n,shippingSettingsLink:l,freeShippingThreshold:u,skipInvalidCurrency:o=!1})=>{const i={"@context":"https://schema.org","@type":"ShippingService",name:r};e&&(i.provider={"@type":"Organization",name:e.name,...e.url&&{url:e.url}}),s&&(i.description=s);const p=f(g);if(p&&(i.shippingDestination=p),(t!=null||c!=null)&&(i.shippingDeliveryTime={"@type":"ShippingDeliveryTime",...t!=null&&{transitTimeLabel:`${t}`},...t!=null&&{transitTimeMin:t},...c!=null&&{transitTimeMax:c}}),n)if(n.currency&&!a(n.currency)){if(!o)throw new Error(`Invalid currency code: ${n.currency}`)}else i.shippingRate={"@type":"MonetaryAmount",value:n.price,...n.currency&&{currency:n.currency},...n.shippingLabel&&{name:n.shippingLabel}};return l&&(i.shippingSettingsLink=l),u!=null&&(i.freeShippingThreshold=u),i};export{h as generateShoppingShippingPolicySchema};

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

@@ -0,0 +1,52 @@
+/**
+ * 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;
+}
+declare const generateShoppingOverviewSchema: ({ name, url, products, skipInvalidCurrency, }: ShoppingOverviewOptions) => any;
+
+export { generateShoppingOverviewSchema };

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

@@ -0,0 +1 @@
+const p=e=>{if(e)return typeof e=="string"?e:{"@type":"ImageObject",url:e.url,...e.width&&{width:e.width},...e.height&&{height:e.height}}},v=e=>{if(e)return typeof e=="string"?{"@type":"Brand",name:e}:{"@type":"Brand",name:e.name,...e.url&&{url:e.url}}},f=e=>e?/^[A-Z]{3}$/.test(e):!1,y=["InStock","OutOfStock","PreOrder","PreSale","Discontinued","OnlineOnly","InStoreOnly","LimitedAvailability","BackOrder"],C=e=>{if(e)try{const a=String(e);if(a.startsWith("http")){const c=a.replace(/https?:\/\/schema\.org\//i,"");return y.includes(c)?`https://schema.org/${c}`:void 0}return y.includes(a)?`https://schema.org/${a}`:void 0}catch{return}},w=({name:e,url:a,products:c,skipInvalidCurrency:h=!1})=>{const u={"@context":"https://schema.org","@type":"ItemList",itemListElement:c.map((r,m)=>{const n={"@type":"Product",name:r.name};r.id&&(n["@id"]=r.id),r.url&&(n.url=r.url);const o=p(r.image);o&&(n.image=o),r.description&&(n.description=r.description);const l=v(r.brand);if(l&&(n.brand=l),r.sku&&(n.sku=r.sku),r.category&&(n.category=Array.isArray(r.category)?r.category.join(", "):r.category),r.aggregateRating&&(n.aggregateRating={"@type":"AggregateRating",ratingValue:r.aggregateRating.ratingValue,...r.aggregateRating.reviewCount!=null&&{reviewCount:r.aggregateRating.reviewCount}}),r.priceRange&&(n.priceRange=`${r.priceRange.low??""}${r.priceRange.low!=null&&r.priceRange.high!=null?` - ${r.priceRange.high}`:""}`.trim()),r.offers){const g=Array.isArray(r.offers)?r.offers:[r.offers],s=g.map(i=>{if(i.priceCurrency&&!f(i.priceCurrency))return{__invalidCurrency:i.priceCurrency};const t={"@type":"Offer"};if(i.price!=null&&(t.price=i.price),i.priceCurrency&&(t.priceCurrency=i.priceCurrency),i.availability){const d=C(i.availability);d&&(t.availability=d)}return i.url&&(t.url=i.url),t}).filter(i=>i&&!("__invalidCurrency"in i));if(g.some(i=>i.priceCurrency&&!f(i.priceCurrency))&&!h){const i=g.find(t=>t.priceCurrency&&!f(t.priceCurrency));throw new Error(`Invalid currency code: ${i?.priceCurrency}`)}s.length===1?n.offers=s[0]:s.length>1&&(n.offers=s)}return{"@type":"ListItem",position:m+1,item:n}})};return e&&(u.name=e),a&&(u.mainEntityOfPage={"@type":"WebPage","@id":a}),u};export{w as generateShoppingOverviewSchema};

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

@@ -0,0 +1,57 @@
+/**
+ * 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;
+}
+declare const generateShoppingProductSnippetSchema: ({ name, description, image, sku, brand, reviews, offers, skipInvalidCurrency, }: ProductSnippetOptions) => any;
+
+export { generateShoppingProductSnippetSchema };

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

@@ -0,0 +1 @@
+const R=r=>{if(r)return typeof r=="string"?r:{"@type":"ImageObject",url:r.url,...r.width&&{width:r.width},...r.height&&{height:r.height}}},b=r=>{if(r)return typeof r=="string"?{"@type":"Brand",name:r}:{"@type":"Brand",name:r.name,...r.url&&{url:r.url}}},d=r=>r?/^[A-Z]{3}$/.test(r):!1,h=["InStock","OutOfStock","PreOrder","PreSale","Discontinued","OnlineOnly","InStoreOnly","LimitedAvailability","BackOrder"],w=r=>{if(r)try{const u=String(r);if(u.startsWith("http")){const c=u.replace(/https?:\/\/schema\.org\//i,"");return h.includes(c)?`https://schema.org/${c}`:void 0}return h.includes(u)?`https://schema.org/${u}`:void 0}catch{return}},C=({name:r,description:u,image:c,sku:f,brand:m,reviews:s,offers:g,skipInvalidCurrency:v=!1})=>{const t={"@context":"https://schema.org","@type":"Product",name:r};u&&(t.description=u);const p=R(c);p&&(t.image=p),f&&(t.sku=f);const o=b(m);if(o&&(t.brand=o),s&&s.length>0){const l=s.map(i=>{const e={"@type":"Review"};return i.author&&(e.author=typeof i.author=="string"?{"@type":"Person",name:i.author}:{"@type":"Person",name:i.author.name}),i.datePublished&&(e.datePublished=i.datePublished),i.reviewBody&&(e.reviewBody=i.reviewBody),i.reviewRating&&(e.reviewRating={"@type":"Rating",ratingValue:i.reviewRating.ratingValue,...i.reviewRating.bestRating!=null&&{bestRating:i.reviewRating.bestRating}}),e});t.review=l;const a=s.map(i=>i.reviewRating?Number(i.reviewRating.ratingValue):NaN).filter(i=>!Number.isNaN(i));if(a.length>0){const i=a.reduce((e,n)=>e+n,0);t.aggregateRating={"@type":"AggregateRating",ratingValue:i/a.length,reviewCount:s.length}}}if(g){const l=Array.isArray(g)?g:[g],a=l.map(e=>{if(e.priceCurrency&&!d(e.priceCurrency))return{__invalidCurrency:e.priceCurrency};const n={"@type":"Offer"};if(e.price!=null&&(n.price=e.price),e.priceCurrency&&(n.priceCurrency=e.priceCurrency),e.availability){const y=w(e.availability);y&&(n.availability=y)}return e.url&&(n.url=e.url),e.seller&&(n.seller={"@type":"Organization",...e.seller.name&&{name:e.seller.name},...e.seller.url&&{url:e.seller.url}}),e.priceValidUntil&&(n.priceValidUntil=e.priceValidUntil),e.itemCondition&&(n.itemCondition=e.itemCondition),n}).filter(e=>e&&!("__invalidCurrency"in e));if(l.some(e=>e.priceCurrency&&!d(e.priceCurrency))&&!v){const e=l.find(n=>n.priceCurrency&&!d(n.priceCurrency));throw new Error(`Invalid currency code: ${e?.priceCurrency}`)}a.length===1?t.offers=a[0]:a.length>1&&(t.offers=a)}return t};export{C as generateShoppingProductSnippetSchema};

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

@@ -0,0 +1,46 @@
+/**
+ * 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;
+}
+declare const generateShoppingVariantsSchema: ({ name, productGroupId, variants, skipInvalidCurrency, }: VariantsOptions) => any;
+
+export { generateShoppingVariantsSchema };

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

@@ -0,0 +1 @@
+const m=r=>{if(r)return typeof r=="string"?r:{"@type":"ImageObject",url:r.url,...r.width&&{width:r.width},...r.height&&{height:r.height}}},C=r=>{if(r)return typeof r=="string"?{"@type":"Brand",name:r}:{"@type":"Brand",name:r.name,...r.url&&{url:r.url}}},f=r=>r?/^[A-Z]{3}$/.test(r):!1,y=["InStock","OutOfStock","PreOrder","PreSale","Discontinued","OnlineOnly","InStoreOnly","LimitedAvailability","BackOrder"],I=r=>{if(r)try{const a=String(r);if(a.startsWith("http")){const s=a.replace(/https?:\/\/schema\.org\//i,"");return y.includes(s)?`https://schema.org/${s}`:void 0}return y.includes(a)?`https://schema.org/${a}`:void 0}catch{return}},b=({name:r,productGroupId:a,variants:s,skipInvalidCurrency:g=!1})=>{const h=s.map(n=>{const t={"@type":"Product",name:n.name};n.id&&(t["@id"]=n.id),n.url&&(t.url=n.url),n.sku&&(t.sku=n.sku),n.description&&(t.description=n.description);const l=m(n.image);l&&(t.image=l);const o=C(n.brand);if(o&&(t.brand=o),n.offers){const u=Array.isArray(n.offers)?n.offers:[n.offers],c=u.map(i=>{if(i.priceCurrency&&!f(i.priceCurrency))return{__invalidCurrency:i.priceCurrency};const e={"@type":"Offer"};if(i.price!=null&&(e.price=i.price),i.priceCurrency&&(e.priceCurrency=i.priceCurrency),i.availability){const p=I(i.availability);p&&(e.availability=p)}return i.url&&(e.url=i.url),i.priceValidUntil&&(e.priceValidUntil=i.priceValidUntil),i.itemCondition&&(e.itemCondition=i.itemCondition),e}).filter(i=>i&&!("__invalidCurrency"in i));if(u.some(i=>i.priceCurrency&&!f(i.priceCurrency))&&!g){const i=u.find(e=>e.priceCurrency&&!f(e.priceCurrency));throw new Error(`Invalid currency code: ${i?.priceCurrency}`)}c.length===1?t.offers=c[0]:c.length>1&&(t.offers=c)}return t}),d={"@context":"https://schema.org","@type":"ProductGroup",name:r,hasVariant:h};return a&&(d["@id"]=a),d};export{b as generateShoppingVariantsSchema};

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

@@ -0,0 +1,62 @@
+/**
+ * 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;
+}
+declare const generateSoftwareAppSchema: ({ name, description, image, url, softwareVersion, operatingSystem, applicationCategory, downloadUrl, author, publisher, reviews, aggregateRating, }: SoftwareAppOptions) => any;
+
+export { generateSoftwareAppSchema as default, generateSoftwareAppSchema };

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

@@ -0,0 +1 @@
+const O=t=>{if(t)return typeof t=="string"?t:{"@type":"ImageObject",url:t.url,...t.width&&{width:t.width},...t.height&&{height:t.height}}},h=t=>{if(!t)return;if(typeof t=="string")return{"@type":"Person",name:t};const n={"@type":"Person",name:t.name};return t.url&&(n.url=t.url),n},p=t=>{if(!t)return;if(typeof t=="string")return{"@type":"Organization",name:t};const n={"@type":"Organization",name:t.name};return t.url&&(n.url=t.url),n},P=t=>{const n={"@type":"Review"};return t.author&&(n.author=h(t.author)),t.datePublished&&(n.datePublished=t.datePublished),t.reviewBody&&(n.reviewBody=t.reviewBody),t.name&&(n.name=t.name),t.url&&(n.url=t.url),t.publisher&&(n.publisher=p(t.publisher)),t.reviewRating&&(n.reviewRating={"@type":"Rating",ratingValue:t.reviewRating.ratingValue,...t.reviewRating.bestRating!=null&&{bestRating:t.reviewRating.bestRating},...t.reviewRating.worstRating!=null&&{worstRating:t.reviewRating.worstRating}}),n},I=({name:t,description:n,image:b,url:o,softwareVersion:f,operatingSystem:s,applicationCategory:u,downloadUrl:l,author:c,publisher:d,reviews:a,aggregateRating:i})=>{const e={"@context":"https://schema.org","@type":"SoftwareApplication",name:t};n&&(e.description=n);const R=O(b);R&&(e.image=R),o&&(e.url=o),f&&(e.softwareVersion=f),s&&(e.operatingSystem=Array.isArray(s)?s.join(", "):s),u&&(e.applicationCategory=Array.isArray(u)?u.join(", "):u),l&&(e.downloadUrl=l);const m=h(c);m&&(e.author=m);const w=p(d);if(w&&(e.publisher=w),a&&a.length>0){const y=a.map(P);if(e.review=y,!i){const g=a.map(r=>r.reviewRating?Number(r.reviewRating.ratingValue):NaN).filter(r=>!Number.isNaN(r));if(g.length>0){const r=g.reduce((v,A)=>v+A,0);e.aggregateRating={"@type":"AggregateRating",ratingValue:r/g.length,reviewCount:a.length,ratingCount:g.length}}}}return i&&(e.aggregateRating={"@type":"AggregateRating",ratingValue:i.ratingValue,...i.reviewCount!=null&&{reviewCount:i.reviewCount},...i.ratingCount!=null&&{ratingCount:i.ratingCount},...i.bestRating!=null&&{bestRating:i.bestRating},...i.worstRating!=null&&{worstRating:i.worstRating}}),e};var C=I;export{C as default,I as generateSoftwareAppSchema};

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

@@ -0,0 +1,64 @@
+/**
+ * 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[];
+}
+declare const generateSpeakableSchema: ({ type, headline, name, description, url, author, publisher, speakable, reviews, aggregateRating, keywords, }: SpeakableOptions) => any;
+
+export { generateSpeakableSchema as default, generateSpeakableSchema };

package/general/generate-speakable-schema.mjs

@@ -0,0 +1 @@
+const c=e=>{if(!e)return;if(typeof e=="string")return{"@type":"Person",name:e};const t={"@type":"Person",name:e.name};return e.url&&(t.url=e.url),t},v=e=>{if(!e)return;const t={"@type":"Organization",name:e.name};return e.url&&(t.url=e.url),e.logo&&(t.logo={"@type":"ImageObject",url:e.logo.url,...e.logo.width&&{width:e.logo.width},...e.logo.height&&{height:e.logo.height}}),t},P=e=>{if(!e)return;const t={"@type":"SpeakableSpecification"};return Array.isArray(e)?(t.xpath=e,t):(e.xpath&&e.xpath.length>0&&(t.xpath=e.xpath),e.cssSelector&&e.cssSelector.length>0&&(t.cssSelector=e.cssSelector),t)},S=e=>{const t={"@type":"Review"};return e.author&&(t.author=c(e.author)),e.datePublished&&(t.datePublished=e.datePublished),e.reviewBody&&(t.reviewBody=e.reviewBody),e.reviewRating&&(t.reviewRating={"@type":"Rating",ratingValue:e.reviewRating.ratingValue,...e.reviewRating.bestRating!=null&&{bestRating:e.reviewRating.bestRating},...e.reviewRating.worstRating!=null&&{worstRating:e.reviewRating.worstRating}}),t},k=({type:e="Article",headline:t,name:u,description:g,url:l,author:R,publisher:p,speakable:m,reviews:a,aggregateRating:i,keywords:s})=>{const n={"@context":"https://schema.org","@type":e};e==="Article"&&t&&(n.headline=t),e==="WebPage"&&u&&(n.name=u),g&&(n.description=g),l&&(n.mainEntityOfPage={"@type":"WebPage","@id":l});const f=c(R);f&&(n.author=f);const h=v(p);h&&(n.publisher=h);const b=P(m);if(b&&(n.speakable=b),a&&a.length>0){const w=a.map(S);if(n.review=w,!i){const o=a.map(r=>r.reviewRating?Number(r.reviewRating.ratingValue):NaN).filter(r=>!Number.isNaN(r));if(o.length>0){const r=o.reduce((y,d)=>y+d,0);n.aggregateRating={"@type":"AggregateRating",ratingValue:r/o.length,reviewCount:a.length,ratingCount:o.length}}}}return i&&(n.aggregateRating={"@type":"AggregateRating",ratingValue:i.ratingValue,...i.reviewCount!=null&&{reviewCount:i.reviewCount},...i.ratingCount!=null&&{ratingCount:i.ratingCount},...i.bestRating!=null&&{bestRating:i.bestRating},...i.worstRating!=null&&{worstRating:i.worstRating}}),s&&s.length>0&&(n.keywords=s.join(", ")),n};var C=k;export{C as default,k as generateSpeakableSchema};

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

@@ -0,0 +1,60 @@
+/**
+ * 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;
+}
+declare const generateSubscriptionSchema: ({ name, description, image, url, author, publisher, datePublished, dateModified, isAccessibleForFree, genre, keywords, reviews, aggregateRating, }: SubscriptionOptions) => any;
+
+export { generateSubscriptionSchema as default, generateSubscriptionSchema };

package/general/generate-subscription-schema.mjs

@@ -0,0 +1 @@
+const C=t=>{if(t)return typeof t=="string"?t:{"@type":"ImageObject",url:t.url,...t.width&&{width:t.width},...t.height&&{height:t.height}}},b=t=>{if(!t)return;if(typeof t=="string")return{"@type":"Person",name:t};const n={"@type":"Person",name:t.name};return t.url&&(n.url=t.url),n},O=t=>{if(!t)return;if(typeof t=="string")return{"@type":"Organization",name:t};const n={"@type":"Organization",name:t.name};return t.url&&(n.url=t.url),n},I=t=>{const n={"@type":"Review"};return t.author&&(n.author=b(t.author)),t.datePublished&&(n.datePublished=t.datePublished),t.reviewBody&&(n.reviewBody=t.reviewBody),t.reviewRating&&(n.reviewRating={"@type":"Rating",ratingValue:t.reviewRating.ratingValue,...t.reviewRating.bestRating!=null&&{bestRating:t.reviewRating.bestRating},...t.reviewRating.worstRating!=null&&{worstRating:t.reviewRating.worstRating}}),n},A=({name:t,description:n,image:w,url:o,author:d,publisher:y,datePublished:f,dateModified:l,isAccessibleForFree:R,genre:s,keywords:u,reviews:a,aggregateRating:i})=>{const e={"@context":"https://schema.org","@type":"CreativeWork",name:t};n&&(e.description=n);const m=C(w);m&&(e.image=m),o&&(e.url=o);const c=b(d);c&&(e.author=c);const h=O(y);if(h&&(e.publisher=h),f&&(e.datePublished=f),l&&(e.dateModified=l),R!=null&&(e.isAccessibleForFree=R),s&&(e.genre=Array.isArray(s)?s.join(", "):s),u&&(e.keywords=Array.isArray(u)?u.join(", "):u),a&&a.length>0){const p=a.map(I);if(e.review=p,!i){const g=a.map(r=>r.reviewRating?Number(r.reviewRating.ratingValue):NaN).filter(r=>!Number.isNaN(r));if(g.length>0){const r=g.reduce((v,P)=>v+P,0);e.aggregateRating={"@type":"AggregateRating",ratingValue:r/g.length,reviewCount:a.length,ratingCount:g.length}}}}return i&&(e.aggregateRating={"@type":"AggregateRating",ratingValue:i.ratingValue,...i.reviewCount!=null&&{reviewCount:i.reviewCount},...i.ratingCount!=null&&{ratingCount:i.ratingCount},...i.bestRating!=null&&{bestRating:i.bestRating},...i.worstRating!=null&&{worstRating:i.worstRating}}),e};var V=A;export{V as default,A as generateSubscriptionSchema};