@react-pakistan/util-functions 2.0.2 → 3.0.1

package/general/format-phone.d.mts

@@ -0,0 +1,13 @@
+interface FormattedPhoneNumber {
+    e164: string;
+    international: string;
+}
+/**
+ * Parses and formats a phone number into E.164 and international formats.
+ * @param phone - The phone number string.
+ * @param defaultCountry - Default country code (default 'US').
+ * @returns Object with `e164` and `international` strings, or null if invalid.
+ */
+declare const formatPhone: (phone: string, defaultCountry?: string) => FormattedPhoneNumber | null;
+
+export { formatPhone };

package/general/format-phone.d.ts

@@ -1,5 +1,3 @@
-import { CountryCode } from 'libphonenumber-js';
-
 interface FormattedPhoneNumber {
     e164: string;
     international: string;
@@ -10,6 +8,6 @@ interface FormattedPhoneNumber {
  * @param defaultCountry - Default country code (default 'US').
  * @returns Object with `e164` and `international` strings, or null if invalid.
  */
-declare const formatPhone: (phone: string, defaultCountry?: CountryCode) => FormattedPhoneNumber | null;
+declare const formatPhone: (phone: string, defaultCountry?: string) => FormattedPhoneNumber | null;
 
 export { formatPhone };

package/general/format-phone.js

@@ -1 +1 @@
-var a=Object.defineProperty;var m=Object.getOwnPropertyDescriptor;var u=Object.getOwnPropertyNames;var l=Object.prototype.hasOwnProperty;var s=(t,r)=>{for(var n in r)a(t,n,{get:r[n],enumerable:!0})},d=(t,r,n,e)=>{if(r&&typeof r=="object"||typeof r=="function")for(let o of u(r))!l.call(t,o)&&o!==n&&a(t,o,{get:()=>r[o],enumerable:!(e=m(r,o))||e.enumerable});return t};var f=t=>d(a({},"__esModule",{value:!0}),t);var P={};s(P,{formatPhone:()=>h});module.exports=f(P);var i=require("libphonenumber-js");const h=(t,r="US")=>{let n=t;t.startsWith("+")||(n=`+${t}`);const e=(0,i.parsePhoneNumberFromString)(n,r);return e&&e.isValid()?{e164:e.format("E.164"),international:e.formatInternational()}:null};0&&(module.exports={formatPhone});
+var o=Object.defineProperty;var a=Object.getOwnPropertyDescriptor;var s=Object.getOwnPropertyNames;var m=Object.prototype.hasOwnProperty;var u=(t,r)=>{for(var e in r)o(t,e,{get:r[e],enumerable:!0})},l=(t,r,e,i)=>{if(r&&typeof r=="object"||typeof r=="function")for(let n of s(r))!m.call(t,n)&&n!==e&&o(t,n,{get:()=>r[n],enumerable:!(i=a(r,n))||i.enumerable});return t};var f=t=>l(o({},"__esModule",{value:!0}),t);var g={};u(g,{formatPhone:()=>d});module.exports=f(g);const d=(t,r="US")=>{const{parsePhoneNumberFromString:e}=require("libphonenumber-js");let i=t;t.startsWith("+")||(i=`+${t}`);const n=e(i,r);return n&&n.isValid()?{e164:n.format("E.164"),international:n.formatInternational()}:null};0&&(module.exports={formatPhone});

package/general/format-phone.mjs

@@ -0,0 +1 @@
+const o=(r,e="US")=>{const{parsePhoneNumberFromString:i}=require("libphonenumber-js");let n=r;r.startsWith("+")||(n=`+${r}`);const t=i(n,e);return t&&t.isValid()?{e164:t.format("E.164"),international:t.formatInternational()}:null};export{o as formatPhone};

package/general/format-pricing.d.mts

@@ -0,0 +1,8 @@
+/**
+ * Formats a number or numeric string as a USD price with 2 decimal places.
+ * @param value - The price value as a number or string.
+ * @returns The formatted price string.
+ */
+declare const formatPricing: (value: string | number) => string;
+
+export { formatPricing };

package/general/format-pricing.mjs

@@ -0,0 +1 @@
+const n=t=>{let r="";if(typeof t=="string"){const i=Number(t).toFixed(2);r=new Intl.NumberFormat("en-US",{minimumFractionDigits:2,maximumFractionDigits:2}).format(Number(i))}return typeof t=="number"&&(r=new Intl.NumberFormat("en-US",{minimumFractionDigits:2,maximumFractionDigits:2}).format(Number(t))),r};export{n as formatPricing};

package/general/format-secs.d.mts

@@ -0,0 +1,8 @@
+/**
+ * Formats seconds into a human-readable `Xh Ym Zs` string (handles negative values).
+ * @param sec - The number of seconds.
+ * @returns The formatted duration string.
+ */
+declare const formatSecs: (sec: number) => string;
+
+export { formatSecs };

package/general/format-secs.mjs

@@ -0,0 +1 @@
+const e=t=>{if(t>=0){const o=Math.floor(t/3600),s=Math.floor(t%3600/60),n=t%60;return`${o}h ${s}m ${n}s`}else{const o=Math.abs(t),s=-Math.ceil(o/3600),n=o%3600,r=Math.floor((3600-n)/60)%60,c=(60-o%60)%60;return`${s}h ${r}m ${c}s`}};export{e as formatSecs};

package/general/format-time.d.mts

@@ -0,0 +1,11 @@
+interface Params {
+    seconds: number;
+}
+/**
+ * Formats a duration in seconds into a human-friendly string (e.g. "2 mins and 30 secs").
+ * @param params.seconds - Duration in seconds (non-negative integer).
+ * @returns The formatted duration string.
+ */
+declare const formatDuration: ({ seconds }: Params) => string;
+
+export { formatDuration };

package/general/format-time.mjs

@@ -0,0 +1 @@
+const s=[{divisor:86400,singular:"day",plural:"days"},{divisor:3600,singular:"hour",plural:"hours"},{divisor:60,singular:"min",plural:"mins"},{divisor:1,singular:"sec",plural:"secs"}],l=({seconds:n})=>{if(typeof n!="number"||n<0||!Number.isInteger(n))throw new Error("Invalid input: must be a non-negative integer");let a=n;const r=[];for(const i of s){const t=Math.floor(a/i.divisor);a%=i.divisor,t>0&&r.push(`${t} ${t===1?i.singular:i.plural}`)}return r.length===0?`0 ${s[s.length-1].plural}`:r.length>1?`${r.slice(0,-1).join(", ")} and ${r[r.length-1]}`:r[0]};export{l as formatDuration};

package/general/format-value.d.mts

@@ -0,0 +1,8 @@
+/**
+ * Returns a string representation of a value, or an em dash if null/undefined/empty.
+ * @param v - The value to format.
+ * @returns The string representation or '—'.
+ */
+declare const formatValue: (v?: string | number | null) => string;
+
+export { formatValue };

package/general/format-value.mjs

@@ -0,0 +1 @@
+const e=n=>n==null||n===""?"\u2014":String(n);export{e as formatValue};

package/general/full-month-range.d.mts

@@ -0,0 +1,13 @@
+interface Return {
+    startOfMonth: Date;
+    endOfMonth: Date;
+}
+/**
+ * Get the full month range for a given month and year
+ * @param month - The month (0-11, where 0 is January). Defaults to current month.
+ * @param year - The year. Defaults to current year.
+ * @returns An object containing startOfMonth and endOfMonth dates in UTC
+ */
+declare const fullMonthRange: (month?: number, year?: number) => Return;
+
+export { fullMonthRange };

package/general/full-month-range.mjs

@@ -0,0 +1 @@
+const c=(a,o)=>{const t=new Date,e=o??t.getUTCFullYear(),n=a??t.getUTCMonth(),r=new Date(Date.UTC(e,n,1,0,0,0,0)),s=new Date(Date.UTC(e,n+1,0,23,59,59,999));return{startOfMonth:r,endOfMonth:s}};export{c as fullMonthRange};

package/general/full-year-range.d.mts

@@ -0,0 +1,12 @@
+interface Return {
+    startOfYear: Date;
+    endOfYear: Date;
+}
+/**
+ * Get the full year range for a given year
+ * @param year - The year. Defaults to current year.
+ * @returns An object containing startOfYear and endOfYear dates
+ */
+declare const fullYearRange: (year?: number) => Return;
+
+export { fullYearRange };

package/general/full-year-range.mjs

@@ -0,0 +1 @@
+const n=t=>{const e=t??new Date().getUTCFullYear(),a=new Date(Date.UTC(e,0,1,0,0,0,0)),r=new Date(Date.UTC(e,11,31,23,59,59,999));return{startOfYear:a,endOfYear:r}};export{n as fullYearRange};

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

@@ -0,0 +1,50 @@
+/**
+ * Generate schema.org JSON-LD for `Article`, `NewsArticle`, or `BlogPosting`.
+ *
+ * This helper accepts `ArticleSchema` inputs and formats authors,
+ * publisher/logo, images, and optional fields such as `keywords`,
+ * `articleSection`, and `wordCount`. Only supplied fields are emitted in
+ * the resulting object, making the output safe to merge into page
+ * metadata bundles.
+ *
+ * Examples are provided in the interface comments below — consult the
+ * `ArticleSchema` type for full details of supported inputs.
+ *
+ * @param options - Article metadata and optional fields
+ * @returns A JSON-LD compatible Article/NewsArticle/BlogPosting object
+ */
+type ArticleType = 'Article' | 'NewsArticle' | 'BlogPosting';
+interface ArticleAuthor {
+    name: string;
+    url?: string;
+}
+interface ArticleImage {
+    url: string;
+    width?: number;
+    height?: number;
+}
+interface ArticlePublisher {
+    name: string;
+    logo?: {
+        url: string;
+        width?: number;
+        height?: number;
+    };
+}
+interface ArticleSchema {
+    type?: ArticleType;
+    headline: string;
+    description?: string;
+    image: string | string[] | ArticleImage | ArticleImage[];
+    author: string | ArticleAuthor | ArticleAuthor[];
+    publisher: ArticlePublisher;
+    datePublished: string;
+    dateModified?: string;
+    url?: string;
+    keywords?: string[];
+    articleSection?: string;
+    wordCount?: number;
+}
+declare const generateArticleSchema: ({ type, headline, description, image, author, publisher, datePublished, dateModified, url, keywords, articleSection, wordCount, }: ArticleSchema) => any;
+
+export { generateArticleSchema };

package/general/generate-article-schema.mjs

@@ -0,0 +1 @@
+const A=t=>typeof t=="string"?{"@type":"Person",name:t}:Array.isArray(t)?t.map(e=>({"@type":"Person",name:e.name,...e.url&&{url:e.url}})):{"@type":"Person",name:t.name,...t.url&&{url:t.url}},f=t=>typeof t=="string"?t:Array.isArray(t)?t.map(e=>typeof e=="string"?e:{"@type":"ImageObject",url:e.url,...e.width&&{width:e.width},...e.height&&{height:e.height}}):{"@type":"ImageObject",url:t.url,...t.width&&{width:t.width},...t.height&&{height:t.height}},y=t=>{const e={"@type":"Organization",name:t.name};return t.logo&&(e.logo={"@type":"ImageObject",url:t.logo.url,...t.logo.width&&{width:t.logo.width},...t.logo.height&&{height:t.logo.height}}),e},m=({type:t="Article",headline:e,description:n,image:c,author:s,publisher:a,datePublished:u,dateModified:l,url:g,keywords:i,articleSection:h,wordCount:o})=>{const r={"@context":"https://schema.org","@type":t,headline:e,image:f(c),author:A(s),publisher:y(a),datePublished:u};return n&&(r.description=n),l&&(r.dateModified=l),g&&(r.mainEntityOfPage={"@type":"WebPage","@id":g}),i&&i.length>0&&(r.keywords=i.join(", ")),h&&(r.articleSection=h),o&&(r.wordCount=o),r};export{m as generateArticleSchema};

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

@@ -0,0 +1,37 @@
+/**
+ * Generate schema.org `BlogPosting` JSON-LD for a blog entry.
+ *
+ * Produces a compact `BlogPosting` object using headline, dates, image and
+ * author information. Only provided fields are emitted, and the returned
+ * object is ready to be stringified as JSON-LD.
+ *
+ * See the `Blog` interface below for the accepted properties.
+ * @returns A JSON-LD compatible `BlogPosting` object
+ */
+interface Blog {
+    authorImage: string;
+    authorName: string;
+    banner: string;
+    createdAt: string;
+    excerpt: string;
+    title: string;
+    updatedAt: string;
+    url: string;
+}
+declare const generateBlogSchema: ({ authorImage, authorName, banner, createdAt, excerpt, title, updatedAt, url, }: Blog) => {
+    '@context': string;
+    '@type': string;
+    headline: string;
+    dateModified: string;
+    datePublished: string;
+    description: string;
+    image: string;
+    url: string;
+    author: {
+        '@type': string;
+        name: string;
+        url: string;
+    };
+};
+
+export { generateBlogSchema };

package/general/generate-blog-schema.mjs

@@ -0,0 +1 @@
+const s=({authorImage:t,authorName:e,banner:r,createdAt:n,excerpt:i,title:a,updatedAt:g,url:o})=>({"@context":"https://schema.org","@type":"BlogPosting",headline:`${a}`,dateModified:`${g}`,datePublished:`${n}`,description:`${i}`,image:`${r}`,url:`${o}`,author:{"@type":"Person",name:`${e}`,url:`${t}`}});export{s as generateBlogSchema};

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

@@ -0,0 +1,58 @@
+/**
+ * Generate schema.org `Book` JSON-LD for use in page <script type="application/ld+json">.
+ *
+ * This helper accepts a compact `BookSchemaOptions` input and returns a
+ * plain object ready to be stringified and inlined on a page. Common
+ * fields supported:
+ *
+ * - `title` → maps to `name`
+ * - `author` → accepts a `string`, an `{ name, url? }` object, or an array of
+ *   those; these are formatted as `Person` objects
+ * - `publisher` → `{ name, logo? }` formatted as an `Organization` with
+ *   an optional `ImageObject` logo
+ * - `image` → accepts a `string`, `BookImage` or arrays; non-string images are
+ *   converted to `ImageObject` entries
+ * - `url` → attached to `mainEntityOfPage.@id` when provided
+ * - `keywords` → joined into a comma-separated string
+ *
+ * The implementation intentionally produces minimal output (only provided
+ * fields are added) so the result can be safely merged into other page
+ * metadata.
+ *
+ * @param options.book title, author, publisher and optional metadata
+ * @returns A JSON-LD compatible `Book` object
+ */
+interface BookAuthor {
+    name: string;
+    url?: string;
+}
+interface BookImage {
+    url: string;
+    width?: number;
+    height?: number;
+}
+interface BookPublisher {
+    name: string;
+    logo?: {
+        url: string;
+        width?: number;
+        height?: number;
+    };
+}
+interface BookSchemaOptions {
+    title: string;
+    author: string | BookAuthor | BookAuthor[];
+    isbn?: string;
+    numberOfPages?: number;
+    inLanguage?: string;
+    publisher: BookPublisher;
+    datePublished?: string;
+    image?: string | string[] | BookImage | BookImage[];
+    description?: string;
+    url?: string;
+    keywords?: string[];
+    bookFormat?: string;
+}
+declare const generateBookSchema: ({ title, author, isbn, numberOfPages, inLanguage, publisher, datePublished, image, description, url, keywords, bookFormat, }: BookSchemaOptions) => any;
+
+export { generateBookSchema };

package/general/generate-book-schema.mjs

@@ -0,0 +1 @@
+const c=t=>typeof t=="string"?{"@type":"Person",name:t}:Array.isArray(t)?t.map(r=>({"@type":"Person",name:r.name,...r.url&&{url:r.url}})):{"@type":"Person",name:t.name,...t.url&&{url:t.url}},y=t=>{if(t)return typeof t=="string"?t:Array.isArray(t)?t.map(r=>typeof r=="string"?r:{"@type":"ImageObject",url:r.url,...r.width&&{width:r.width},...r.height&&{height:r.height}}):{"@type":"ImageObject",url:t.url,...t.width&&{width:t.width},...t.height&&{height:t.height}}},k=t=>{const r={"@type":"Organization",name:t.name};return t.logo&&(r.logo={"@type":"ImageObject",url:t.logo.url,...t.logo.width&&{width:t.logo.width},...t.logo.height&&{height:t.logo.height}}),r},d=({title:t,author:r,isbn:o,numberOfPages:i,inLanguage:g,publisher:l,datePublished:h,image:m,description:s,url:u,keywords:n,bookFormat:a})=>{const e={"@context":"https://schema.org","@type":"Book",name:t,author:c(r),publisher:k(l)};o&&(e.isbn=o),i&&(e.numberOfPages=i),g&&(e.inLanguage=g),h&&(e.datePublished=h),s&&(e.description=s),a&&(e.bookFormat=a);const f=y(m);return f&&(e.image=f),u&&(e.mainEntityOfPage={"@type":"WebPage","@id":u}),n&&n.length>0&&(e.keywords=n.join(", ")),e};export{d as generateBookSchema};

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

@@ -0,0 +1,40 @@
+/**
+ * Generate a schema.org `BreadcrumbList` JSON-LD object.
+ *
+ * The `data` array may contain either strings or `Crumb` objects. If an
+ * entry is a string it will be treated as a path segment and slugified when
+ * appended to `baseUrl`. A `Crumb` object may provide an explicit `path` to
+ * use when building the segment, or an absolute `url` to use directly.
+ *
+ * Output: each list item will include an `item` object with `@id` (the URL)
+ * and `name` (the breadcrumb label).
+ *
+ * @param props.data - Array of path segments or Crumb objects
+ * @param props.baseUrl - The base URL to build breadcrumb URLs from
+ * @returns A JSON-LD `BreadcrumbList` object
+ * @author Taimoor Khan
+ */
+interface Crumb {
+    name: string;
+    path?: string;
+    url?: string;
+}
+interface Props {
+    data: Array<string | Crumb>;
+    baseUrl: string;
+}
+declare const generateBreadcrumbSchema: ({ data, baseUrl }: Props) => {
+    '@context': string;
+    '@type': string;
+    itemListElement: {
+        '@type': string;
+        position: number;
+        name: string;
+        item: {
+            '@id': string;
+            name: string;
+        };
+    }[];
+};
+
+export { generateBreadcrumbSchema };

package/general/generate-breadcrumb-schema.mjs

@@ -0,0 +1 @@
+import{slugify as n}from"./slugify";const g=({data:r,baseUrl:i})=>{let e=i;return{"@context":"https://schema.org","@type":"BreadcrumbList",itemListElement:r.map((t,m)=>{const s=typeof t=="string"?t:t.name;if(typeof t!="string"&&t.url)e=t.url;else{const a=typeof t=="string"?t:t.path||t.name;e+=`/${n(a)}`}return{"@type":"ListItem",position:m+1,name:s,item:{"@id":e,name:s}}})}};export{g as generateBreadcrumbSchema};

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

@@ -0,0 +1,52 @@
+/**
+ * Generate schema.org `ItemList` JSON-LD for a carousel of items.
+ *
+ * Each carousel item is emitted as a `ListItem` containing a `Thing`
+ * (Product, Article, Movie, etc.) depending on the provided item fields.
+ * Currency and availability values are normalized where applicable; use
+ * `skipInvalidCurrency` to bypass currency validation.
+ *
+ * See `CarouselSchemaOptions` and `CarouselItem` for input details.
+ * @returns A JSON-LD compatible `ItemList` object
+ */
+interface CarouselImage {
+    url: string;
+    width?: number;
+    height?: number;
+}
+interface CarouselItem {
+    id?: string;
+    name: string;
+    url?: string;
+    image?: string | CarouselImage;
+    description?: string;
+    type?: string;
+    price?: string | number;
+    priceCurrency?: string;
+    aggregateRating?: {
+        ratingValue: number | string;
+        reviewCount?: number;
+        bestRating?: number;
+        worstRating?: number;
+    };
+    offers?: Array<{
+        price: string | number;
+        priceCurrency?: string;
+        availability?: string;
+        url?: string;
+        priceValidUntil?: string;
+        priceRange?: {
+            low?: string | number;
+            high?: string | number;
+        };
+    }>;
+}
+interface CarouselSchemaOptions {
+    name?: string;
+    url?: string;
+    items: CarouselItem[];
+    skipInvalidCurrency?: boolean;
+}
+declare const generateCarouselSchema: ({ name, url, items, skipInvalidCurrency, }: CarouselSchemaOptions) => any;
+
+export { generateCarouselSchema };

package/general/generate-carousel-schema.mjs

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

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

@@ -0,0 +1,53 @@
+/**
+ * Generate schema.org `Course` JSON-LD.
+ *
+ * Accepts metadata for a course and optional `CourseInstance` objects
+ * including offers and locations. Provider can be a string or a structured
+ * object with `logo` support. Only provided fields are emitted.
+ *
+ * See `CourseSchema` and `CourseInstance` for field details.
+ * @returns A JSON-LD compatible `Course` object
+ */
+interface CourseProvider {
+    name: string;
+    url?: string;
+    logo?: {
+        url: string;
+        width?: number;
+        height?: number;
+    };
+}
+interface CourseImage {
+    url: string;
+    width?: number;
+    height?: number;
+}
+interface CourseInstanceOffer {
+    price?: string | number;
+    priceCurrency?: string;
+    availability?: string;
+    url?: string;
+}
+interface CourseInstance {
+    name?: string;
+    description?: string;
+    courseMode?: string;
+    startDate?: string;
+    endDate?: string;
+    location?: string;
+    offers?: CourseInstanceOffer | CourseInstanceOffer[];
+}
+interface CourseSchema {
+    name: string;
+    description?: string;
+    courseCode?: string;
+    educationalCredentialAwarded?: string;
+    provider: string | CourseProvider;
+    image?: string | CourseImage | Array<string | CourseImage>;
+    url?: string;
+    hasCourseInstance?: CourseInstance | CourseInstance[];
+    keywords?: string[];
+}
+declare const generateCourseSchema: ({ name, description, courseCode, educationalCredentialAwarded, provider, image, url, hasCourseInstance, keywords, }: CourseSchema) => any;
+
+export { generateCourseSchema };

package/general/generate-course-schema.mjs

@@ -0,0 +1 @@
+const y=e=>{if(typeof e=="string")return{"@type":"Organization",name:e};const r={"@type":"Organization",name:e.name};return e.url&&(r.url=e.url),e.logo&&(r.logo={"@type":"ImageObject",url:e.logo.url,...e.logo.width&&{width:e.logo.width},...e.logo.height&&{height:e.logo.height}}),r},m=e=>{if(e)return typeof e=="string"?e:Array.isArray(e)?e.map(r=>typeof r=="string"?r:{"@type":"ImageObject",url:r.url,...r.width&&{width:r.width},...r.height&&{height:r.height}}):{"@type":"ImageObject",url:e.url,...e.width&&{width:e.width},...e.height&&{height:e.height}}},C=e=>{if(!e)return;const r=n=>{const a={"@type":"Offer"};return n.price!==void 0&&(a.price=n.price),n.priceCurrency&&(a.priceCurrency=n.priceCurrency),n.availability&&(a.availability=n.availability),n.url&&(a.url=n.url),a};return Array.isArray(e)?e.map(r):r(e)},p=({name:e,description:r,courseCode:n,educationalCredentialAwarded:a,provider:h,image:d,url:f,hasCourseInstance:o,keywords:u})=>{const i={"@context":"https://schema.org","@type":"Course",name:e};r&&(i.description=r),n&&(i.courseCode=n),a&&(i.educationalCredentialAwarded=a),i.provider=y(h);const c=m(d);if(c&&(i.image=c),f&&(i.url=f),u&&u.length>0&&(i.keywords=u.join(", ")),o){const g=t=>{const s={"@type":"CourseInstance"};t.name&&(s.name=t.name),t.description&&(s.description=t.description),t.courseMode&&(s.courseMode=t.courseMode),t.startDate&&(s.startDate=t.startDate),t.endDate&&(s.endDate=t.endDate),t.location&&(s.location=t.location);const l=C(t.offers);return l&&(s.offers=l),s};Array.isArray(o)?i.hasCourseInstance=o.map(g):i.hasCourseInstance=g(o)}return i};export{p as generateCourseSchema};

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

@@ -0,0 +1,65 @@
+/**
+ * Generate schema.org JSON-LD for `Dataset`, `DataCatalog`, or
+ * `DataDownload` distributions.
+ *
+ * Supports publisher formatting, distribution normalization (including
+ * encoding format validation with `skipInvalidEncoding`), variable
+ * measurement metadata and nested datasets for `DataCatalog`.
+ *
+ * See `DatasetOptions` for the input shape and available flags.
+ * @returns A JSON-LD compatible `Dataset` or `DataCatalog` object
+ */
+interface PublisherLogo {
+    url: string;
+    width?: number;
+    height?: number;
+}
+interface Publisher {
+    name: string;
+    url?: string;
+    logo?: PublisherLogo;
+}
+interface Distribution {
+    name?: string;
+    contentUrl: string;
+    encodingFormat?: string;
+    byteSize?: number | string;
+    datePublished?: string;
+    license?: string;
+    measurementTechnique?: string;
+}
+interface DatasetOptions {
+    type?: 'Dataset' | 'DataCatalog';
+    name?: string;
+    description?: string;
+    url?: string;
+    datePublished?: string;
+    dateModified?: string;
+    publisher: string | Publisher;
+    keywords?: string[];
+    license?: string;
+    version?: string;
+    variableMeasured?: string | string[] | Array<{
+        name: string;
+        value?: string | number;
+        unitText?: string;
+    }>;
+    spatialCoverage?: string;
+    distribution?: Distribution | Distribution[];
+    citation?: string | {
+        text?: string;
+        url?: string;
+    };
+    funding?: string | {
+        name: string;
+        funder?: string;
+    } | Array<string | {
+        name: string;
+        funder?: string;
+    }>;
+    skipInvalidEncoding?: boolean;
+    datasets?: DatasetOptions[];
+}
+declare const generateDatasetSchema: ({ type, name, description, url, datePublished, dateModified, publisher, keywords, license, version, variableMeasured, spatialCoverage, distribution, datasets, skipInvalidEncoding, }: DatasetOptions) => any;
+
+export { generateDatasetSchema };

package/general/generate-dataset-schema.mjs

@@ -0,0 +1 @@
+const d=t=>{if(typeof t=="string")return{"@type":"Organization",name:t};const n={"@type":"Organization",name:t.name};return t.url&&(n.url=t.url),t.logo&&(n.logo={"@type":"ImageObject",url:t.logo.url},t.logo.width&&(n.logo.width=t.logo.width),t.logo.height&&(n.logo.height=t.logo.height)),n},z=(t,n=!1)=>{const i={"@type":"DataDownload",contentUrl:t.contentUrl};if(t.name&&(i.name=t.name),t.encodingFormat){const r=x(t.encodingFormat,n);r&&(i.encodingFormat=r)}return t.byteSize!=null&&(i.byteSize=t.byteSize),t.datePublished&&(i.datePublished=t.datePublished),t.license&&(i.license=t.license),t.measurementTechnique&&(i.measurementTechnique=t.measurementTechnique),i},D={csv:"text/csv",json:"application/json",geojson:"application/geo+json",xml:"application/xml",txt:"text/plain",zip:"application/zip",gzip:"application/gzip"},P=t=>/^[a-z0-9!#$&.+\-_]+\/[a-z0-9!#$&.+\-_]+$/i.test(t),x=(t,n=!1)=>{if(!t)return;const i=String(t).trim(),r=i.toLowerCase();if(D[r])return D[r];if(P(i))return i;if(!n)throw new Error(`Invalid encodingFormat: ${t}`)},A=({type:t="Dataset",name:n,description:i,url:r,datePublished:c,dateModified:f,publisher:o,keywords:s,license:m,version:h,variableMeasured:b,spatialCoverage:y,distribution:g,datasets:l,skipInvalidEncoding:p=!1})=>{if(t==="DataCatalog"){const a={"@context":"https://schema.org","@type":"DataCatalog"};return n&&(a.name=n),i&&(a.description=i),r&&(a.url=r),o&&(a.publisher=d(o)),s&&s.length&&(a.keywords=s.join(", ")),l&&Array.isArray(l)&&(a.dataset=l.map(u=>A({...u,type:"Dataset",skipInvalidEncoding:p}))),a}const e={"@context":"https://schema.org","@type":"Dataset"};if(n&&(e.name=n),i&&(e.description=i),r&&(e.url=r),c&&(e.datePublished=c),f&&(e.dateModified=f),o&&(e.publisher=d(o)),s&&s.length&&(e.keywords=s.join(", ")),m&&(e.license=m),h&&(e.version=h),b&&(e.variableMeasured=b),y&&(e.spatialCoverage=y),g){const a=Array.isArray(g)?g:[g];e.distribution=a.map(u=>z(u,p))}return e};export{A as generateDatasetSchema};

package/general/generate-discussion-forum-schema.d.mts

@@ -0,0 +1,39 @@
+/**
+ * Generate schema.org JSON-LD for `DiscussionForumPosting`.
+ *
+ * Formats author and publisher references, optional interaction statistics,
+ * and content fields into a compact `DiscussionForumPosting` object ready
+ * for JSON-LD embedding.
+ *
+ * See `DiscussionForumOptions` for supported inputs.
+ * @returns A JSON-LD compatible `DiscussionForumPosting` object
+ */
+interface PersonRef {
+    name?: string;
+    url?: string;
+}
+interface DiscussionForumOptions {
+    headline?: string;
+    articleBody?: string;
+    url?: string;
+    datePublished?: string;
+    dateModified?: string;
+    author?: string | PersonRef;
+    publisher?: string | {
+        name: string;
+        url?: string;
+    };
+    about?: string | {
+        '@type': string;
+        name?: string;
+    };
+    discussionUrl?: string;
+    interactionStatistic?: Array<{
+        '@type': string;
+        interactionType?: string;
+        userInteractionCount?: number;
+    }>;
+}
+declare const generateDiscussionForumSchema: ({ headline, articleBody, url, datePublished, dateModified, author, publisher, about, discussionUrl, interactionStatistic, }?: DiscussionForumOptions) => any;
+
+export { generateDiscussionForumSchema as default, generateDiscussionForumSchema };

package/general/generate-discussion-forum-schema.mjs

@@ -0,0 +1 @@
+const y=n=>{if(!n)return;if(typeof n=="string")return{"@type":"Person",name:n};const t={"@type":"Person"};return n.name&&(t.name=n.name),n.url&&(t.url=n.url),t},l=n=>{if(!n)return;if(typeof n=="string")return{"@type":"Organization",name:n};const t={"@type":"Organization",name:n.name};return n.url&&(t.url=n.url),t},d=({headline:n,articleBody:t,url:e,datePublished:s,dateModified:o,author:c,publisher:m,about:a,discussionUrl:u,interactionStatistic:i}={})=>{const r={"@context":"https://schema.org","@type":"DiscussionForumPosting"};n&&(r.headline=n),t&&(r.articleBody=t),e&&(r.url=e),s&&(r.datePublished=s),o&&(r.dateModified=o);const f=y(c);f&&(r.author=f);const g=l(m);return g&&(r.publisher=g),a&&(r.about=a),u&&(r.discussionUrl=u),i&&Array.isArray(i)&&(r.interactionStatistic=i),r};var h=d;export{h as default,d as generateDiscussionForumSchema};

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

@@ -0,0 +1,68 @@
+/**
+ * Generate schema.org JSON-LD for a Quiz (Question and Answer items).
+ *
+ * Supports author and publisher metadata along with detailed `Question`
+ * and `Answer` structures (including accepted/suggested answers,
+ * feedback and scoring fields). Only provided values are emitted.
+ *
+ * See `QuizOptions`, `Question`, and `Answer` types for the available
+ * fields and formats.
+ * @returns A JSON-LD compatible `Quiz` object
+ */
+interface PersonRef {
+    name?: string;
+    url?: string;
+}
+interface PublisherRef {
+    name: string;
+    url?: string;
+}
+interface Answer {
+    text: string;
+    url?: string;
+    author?: string | PersonRef;
+    upvoteCount?: number;
+    feedback?: string | {
+        text?: string;
+        score?: number;
+    };
+}
+interface Question {
+    name?: string;
+    text?: string;
+    acceptedAnswer?: Answer | Answer[];
+    suggestedAnswer?: Answer | Answer[];
+    answerCount?: number;
+    upvoteCount?: number;
+    difficulty?: string;
+    points?: number;
+    score?: number;
+    timeLimit?: string;
+    attempts?: number;
+    tags?: string[];
+    hints?: string[];
+    learningObjective?: string | string[];
+    timeRecommended?: string;
+    isRequired?: boolean;
+}
+interface QuizOptions {
+    name?: string;
+    description?: string;
+    url?: string;
+    datePublished?: string;
+    author?: string | PersonRef;
+    publisher?: string | PublisherRef;
+    difficulty?: string;
+    learningResourceType?: string;
+    educationalLevel?: string;
+    timeRequired?: string;
+    typicalAgeRange?: string | number;
+    inLanguage?: string;
+    keywords?: string[];
+    learningOutcome?: string | string[];
+    isAccessibleForFree?: boolean;
+    questions?: Question[];
+}
+declare const generateEducationSchema: ({ name, description, url, datePublished, author, publisher, difficulty, learningResourceType, educationalLevel, timeRequired, typicalAgeRange, inLanguage, keywords, learningOutcome, isAccessibleForFree, questions, }?: QuizOptions) => any;
+
+export { generateEducationSchema as default, generateEducationSchema };

package/general/generate-education-schema.mjs

@@ -0,0 +1 @@
+const b=e=>{if(!e)return;if(typeof e=="string")return{"@type":"Person",name:e};const t={"@type":"Person"};return e.name&&(t.name=e.name),e.url&&(t.url=e.url),t},R=e=>{if(!e)return;if(typeof e=="string")return{"@type":"Organization",name:e};const t={"@type":"Organization",name:e.name};return e.url&&(t.url=e.url),t},i=e=>{const t={"@type":"Answer",text:e.text};return e.url&&(t.url=e.url),e.author&&(t.author=b(e.author)),e.upvoteCount!=null&&(t.upvoteCount=e.upvoteCount),e.feedback&&(t.feedback=e.feedback),t},v=e=>{const t={"@type":"Question"};if(e.name&&(t.name=e.name),e.text&&(t.text=e.text),e.answerCount!=null&&(t.answerCount=e.answerCount),e.upvoteCount!=null&&(t.upvoteCount=e.upvoteCount),e.difficulty&&(t.difficulty=e.difficulty),e.points!=null&&(t.points=e.points),e.score!=null&&(t.score=e.score),e.timeLimit&&(t.timeLimit=e.timeLimit),e.attempts!=null&&(t.attempts=e.attempts),e.tags&&Array.isArray(e.tags)&&(t.tags=e.tags),e.hints&&Array.isArray(e.hints)&&(t.hints=e.hints),e.learningObjective&&(t.learningObjective=e.learningObjective),e.timeRecommended&&(t.timeRecommended=e.timeRecommended),e.isRequired!=null&&(t.isRequired=e.isRequired),e.acceptedAnswer){const r=Array.isArray(e.acceptedAnswer)?e.acceptedAnswer.map(i):i(e.acceptedAnswer);t.acceptedAnswer=r}if(e.suggestedAnswer){const r=Array.isArray(e.suggestedAnswer)?e.suggestedAnswer.map(i):i(e.suggestedAnswer);t.suggestedAnswer=r}return t},C=({name:e,description:t,url:r,datePublished:a,author:w,publisher:h,difficulty:o,learningResourceType:f,educationalLevel:g,timeRequired:c,typicalAgeRange:m,inLanguage:l,keywords:s,learningOutcome:d,isAccessibleForFree:y,questions:u}={})=>{const n={"@context":"https://schema.org","@type":"Quiz"};e&&(n.name=e),t&&(n.description=t),r&&(n.url=r),a&&(n.datePublished=a);const A=b(w);A&&(n.author=A);const p=R(h);return p&&(n.publisher=p),o&&(n.difficulty=o),f&&(n.learningResourceType=f),g&&(n.educationalLevel=g),c&&(n.timeRequired=c),m!=null&&(n.typicalAgeRange=m),l&&(n.inLanguage=l),s&&Array.isArray(s)&&(n.keywords=s.join(", ")),d&&(n.learningOutcome=d),y!=null&&(n.isAccessibleForFree=y),u&&Array.isArray(u)&&(n.question=u.map(v)),n};var P=C;export{P as default,C as generateEducationSchema};