@masters-ws/react-seo 1.0.0 → 1.1.0

package/dist/core/index.js

@@ -0,0 +1,272 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/core/index.ts
+var core_exports = {};
+__export(core_exports, {
+  generateArticleSchema: () => generateArticleSchema,
+  generateBreadcrumbSchema: () => generateBreadcrumbSchema,
+  generateEventSchema: () => generateEventSchema,
+  generateFAQSchema: () => generateFAQSchema,
+  generateLocalBusinessSchema: () => generateLocalBusinessSchema,
+  generateOrganizationSchema: () => generateOrganizationSchema,
+  generatePaginatedTitle: () => generatePaginatedTitle,
+  generatePaginationLinks: () => generatePaginationLinks,
+  generateProductSchema: () => generateProductSchema,
+  generateVideoSchema: () => generateVideoSchema,
+  generateWebSiteSchema: () => generateWebSiteSchema,
+  toNextMetadata: () => toNextMetadata
+});
+module.exports = __toCommonJS(core_exports);
+
+// src/core/schemas.ts
+function generateOrganizationSchema(config) {
+  return {
+    "@context": "https://schema.org",
+    "@type": "Organization",
+    "name": config.name,
+    "url": config.url,
+    "logo": config.logo,
+    "sameAs": config.socialLinks || []
+  };
+}
+function generateWebSiteSchema(config) {
+  return {
+    "@context": "https://schema.org",
+    "@type": "WebSite",
+    "name": config.name,
+    "url": config.url,
+    "potentialAction": {
+      "@type": "SearchAction",
+      "target": `${config.url}/search?q={search_term_string}`,
+      "query-input": "required name=search_term_string"
+    }
+  };
+}
+function generateArticleSchema(data, config) {
+  const org = generateOrganizationSchema(config);
+  return {
+    "@context": "https://schema.org",
+    "@type": "NewsArticle",
+    "headline": data.title,
+    "description": data.description,
+    "image": data.image || config.logo,
+    "datePublished": data.publishedTime,
+    "dateModified": data.modifiedTime || data.publishedTime,
+    "mainEntityOfPage": data.url,
+    "author": data.author ? {
+      "@type": "Person",
+      "name": data.author.name,
+      "url": data.author.url
+    } : org,
+    "publisher": org
+  };
+}
+function generateProductSchema(data) {
+  return {
+    "@context": "https://schema.org",
+    "@type": "Product",
+    "name": data.name,
+    "description": data.description,
+    "image": data.image,
+    "sku": data.sku,
+    "brand": data.brand ? { "@type": "Brand", "name": data.brand } : void 0,
+    "offers": {
+      "@type": "Offer",
+      "url": data.url,
+      "priceCurrency": data.currency || "USD",
+      "price": data.price,
+      "availability": data.availability || "https://schema.org/InStock"
+    },
+    "aggregateRating": data.rating ? {
+      "@type": "AggregateRating",
+      "ratingValue": data.rating,
+      "reviewCount": data.reviewCount || 1
+    } : void 0
+  };
+}
+function generateFAQSchema(questions) {
+  return {
+    "@context": "https://schema.org",
+    "@type": "FAQPage",
+    "mainEntity": questions.map((item) => ({
+      "@type": "Question",
+      "name": item.q,
+      "acceptedAnswer": {
+        "@type": "Answer",
+        "text": item.a
+      }
+    }))
+  };
+}
+function generateBreadcrumbSchema(items) {
+  return {
+    "@context": "https://schema.org",
+    "@type": "BreadcrumbList",
+    "itemListElement": items.map((item, index) => ({
+      "@type": "ListItem",
+      "position": index + 1,
+      "name": item.name,
+      "item": item.item
+    }))
+  };
+}
+function generateVideoSchema(data) {
+  return {
+    "@context": "https://schema.org",
+    "@type": "VideoObject",
+    "name": data.name,
+    "description": data.description,
+    "thumbnailUrl": data.thumbnailUrl,
+    "uploadDate": data.uploadDate,
+    "duration": data.duration,
+    "contentUrl": data.contentUrl,
+    "embedUrl": data.embedUrl
+  };
+}
+function generateEventSchema(data) {
+  const isOnline = data.location && "url" in data.location;
+  return {
+    "@context": "https://schema.org",
+    "@type": "Event",
+    "name": data.name,
+    "description": data.description,
+    "startDate": data.startDate,
+    "endDate": data.endDate,
+    "eventAttendanceMode": isOnline ? "https://schema.org/OnlineEventAttendanceMode" : "https://schema.org/OfflineEventAttendanceMode",
+    "location": isOnline ? {
+      "@type": "VirtualLocation",
+      "url": data.location.url
+    } : data.location ? {
+      "@type": "Place",
+      "name": data.location.name,
+      "address": data.location.address
+    } : void 0,
+    "image": data.image,
+    "offers": data.offers ? {
+      "@type": "Offer",
+      "price": data.offers.price,
+      "priceCurrency": data.offers.currency,
+      "url": data.offers.url
+    } : void 0
+  };
+}
+function generateLocalBusinessSchema(data) {
+  return {
+    "@context": "https://schema.org",
+    "@type": "LocalBusiness",
+    "name": data.name,
+    "description": data.description,
+    "image": data.image,
+    "telephone": data.telephone,
+    "address": {
+      "@type": "PostalAddress",
+      "streetAddress": data.address.street,
+      "addressLocality": data.address.city,
+      "addressRegion": data.address.region,
+      "postalCode": data.address.postalCode,
+      "addressCountry": data.address.country
+    },
+    "geo": data.geo ? {
+      "@type": "GeoCoordinates",
+      "latitude": data.geo.lat,
+      "longitude": data.geo.lng
+    } : void 0,
+    "openingHours": data.openingHours,
+    "priceRange": data.priceRange
+  };
+}
+
+// src/core/metadata.ts
+function toNextMetadata(props, config) {
+  const title = props.title ? `${props.title} | ${config.name}` : config.name;
+  const description = props.description || config.description;
+  const url = props.canonical || config.url;
+  const image = props.image || config.logo;
+  const metadata = {
+    title,
+    description,
+    keywords: props.keywords,
+    robots: props.noindex ? "noindex, nofollow" : props.robots || "index, follow",
+    alternates: {
+      canonical: props.noindex ? void 0 : url
+    },
+    openGraph: {
+      title: props.ogTitle || title,
+      description: props.ogDescription || description,
+      url,
+      siteName: config.name,
+      images: props.ogImage || image ? [{ url: props.ogImage || image }] : [],
+      type: props.ogType || (props.type === "article" ? "article" : "website"),
+      locale: props.ogLocale || config.language || "ar_SA"
+    },
+    twitter: {
+      card: props.twitterCard || "summary_large_image",
+      title: props.twitterTitle || title,
+      description: props.twitterDescription || description,
+      images: props.twitterImage || image ? [props.twitterImage || image] : [],
+      site: config.twitterHandle,
+      creator: config.twitterHandle
+    },
+    other: {}
+  };
+  if (props.alternates && props.alternates.length > 0) {
+    const languages = {};
+    props.alternates.forEach((alt) => {
+      languages[alt.hreflang] = alt.href;
+    });
+    metadata.alternates.languages = languages;
+  }
+  metadata.appleWebApp = {
+    capable: true,
+    title: config.name,
+    statusBarStyle: "default"
+  };
+  if (config.themeColor) metadata.themeColor = config.themeColor;
+  if (config.manifest) metadata.manifest = config.manifest;
+  return metadata;
+}
+function generatePaginationLinks(baseUrl, currentPage, totalPages) {
+  const hasNext = currentPage < totalPages;
+  const hasPrev = currentPage > 1;
+  const cleanBase = baseUrl.split("?")[0];
+  return {
+    next: hasNext ? `${cleanBase}?page=${currentPage + 1}` : void 0,
+    prev: hasPrev ? currentPage === 2 ? cleanBase : `${cleanBase}?page=${currentPage - 1}` : void 0,
+    canonical: currentPage === 1 ? cleanBase : `${cleanBase}?page=${currentPage}`
+  };
+}
+function generatePaginatedTitle(title, page, suffix = "\u0635\u0641\u062D\u0629") {
+  return page > 1 ? `${title} - ${suffix} ${page}` : title;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  generateArticleSchema,
+  generateBreadcrumbSchema,
+  generateEventSchema,
+  generateFAQSchema,
+  generateLocalBusinessSchema,
+  generateOrganizationSchema,
+  generatePaginatedTitle,
+  generatePaginationLinks,
+  generateProductSchema,
+  generateVideoSchema,
+  generateWebSiteSchema,
+  toNextMetadata
+});

package/dist/core/index.mjs

@@ -0,0 +1,28 @@
+import {
+  generateArticleSchema,
+  generateBreadcrumbSchema,
+  generateEventSchema,
+  generateFAQSchema,
+  generateLocalBusinessSchema,
+  generateOrganizationSchema,
+  generatePaginatedTitle,
+  generatePaginationLinks,
+  generateProductSchema,
+  generateVideoSchema,
+  generateWebSiteSchema,
+  toNextMetadata
+} from "../chunk-AAN7NRZE.mjs";
+export {
+  generateArticleSchema,
+  generateBreadcrumbSchema,
+  generateEventSchema,
+  generateFAQSchema,
+  generateLocalBusinessSchema,
+  generateOrganizationSchema,
+  generatePaginatedTitle,
+  generatePaginationLinks,
+  generateProductSchema,
+  generateVideoSchema,
+  generateWebSiteSchema,
+  toNextMetadata
+};

package/dist/index-CGVLxGDj.d.mts

@@ -0,0 +1,362 @@
+interface SiteConfig {
+    name: string;
+    description: string;
+    url: string;
+    logo?: string;
+    publisher?: string;
+    twitterHandle?: string;
+    facebookAppId?: string;
+    language?: string;
+    socialLinks?: string[];
+    googleAnalyticsId?: string;
+    gtmId?: string;
+    facebookPixelId?: string;
+    yandexMetricaId?: string;
+    themeColor?: string;
+    manifest?: string;
+}
+interface SEOData {
+    title?: string;
+    description?: string;
+    image?: string;
+    canonical?: string;
+    type?: 'website' | 'article' | 'product' | 'profile' | 'video' | 'faq';
+    robots?: string;
+    noindex?: boolean;
+    keywords?: string[];
+    prev?: string;
+    next?: string;
+    alternates?: Array<{
+        hreflang: string;
+        href: string;
+    }>;
+    ogTitle?: string;
+    ogDescription?: string;
+    ogImage?: string;
+    ogType?: string;
+    ogLocale?: string;
+    twitterCard?: 'summary' | 'summary_large_image' | 'app' | 'player';
+    twitterTitle?: string;
+    twitterDescription?: string;
+    twitterImage?: string;
+    publishedTime?: string;
+    modifiedTime?: string;
+    author?: {
+        name: string;
+        url?: string;
+        image?: string;
+    };
+    tags?: string[];
+    section?: string;
+    readingTime?: number;
+    product?: {
+        sku?: string;
+        brand?: string;
+        price?: number;
+        currency?: string;
+        availability?: string;
+        rating?: number;
+        reviewCount?: number;
+    };
+    dnsPrefetch?: string[];
+    preconnect?: string[];
+    prefetch?: string[];
+    preload?: Array<{
+        href: string;
+        as: string;
+        type?: string;
+    }>;
+    whatsappImage?: string;
+    whatsappDescription?: string;
+    schema?: any;
+}
+interface BreadcrumbItem {
+    name: string;
+    item: string;
+}
+
+/**
+ * Generate Organization Schema
+ */
+declare function generateOrganizationSchema(config: SiteConfig): {
+    "@context": string;
+    "@type": string;
+    name: string;
+    url: string;
+    logo: string | undefined;
+    sameAs: string[];
+};
+/**
+ * Generate WebSite Schema with SearchAction
+ */
+declare function generateWebSiteSchema(config: SiteConfig): {
+    "@context": string;
+    "@type": string;
+    name: string;
+    url: string;
+    potentialAction: {
+        "@type": string;
+        target: string;
+        "query-input": string;
+    };
+};
+/**
+ * Generate NewsArticle Schema
+ */
+declare function generateArticleSchema(data: {
+    title: string;
+    description: string;
+    image?: string;
+    publishedTime?: string;
+    modifiedTime?: string;
+    author?: {
+        name: string;
+        url?: string;
+    };
+    url?: string;
+}, config: SiteConfig): {
+    "@context": string;
+    "@type": string;
+    headline: string;
+    description: string;
+    image: string | undefined;
+    datePublished: string | undefined;
+    dateModified: string | undefined;
+    mainEntityOfPage: string | undefined;
+    author: {
+        "@context": string;
+        "@type": string;
+        name: string;
+        url: string;
+        logo: string | undefined;
+        sameAs: string[];
+    } | {
+        "@type": string;
+        name: string;
+        url: string | undefined;
+    };
+    publisher: {
+        "@context": string;
+        "@type": string;
+        name: string;
+        url: string;
+        logo: string | undefined;
+        sameAs: string[];
+    };
+};
+/**
+ * Generate Product Schema
+ */
+declare function generateProductSchema(data: {
+    name: string;
+    description: string;
+    image?: string;
+    sku?: string;
+    brand?: string;
+    price?: number;
+    currency?: string;
+    availability?: string;
+    rating?: number;
+    reviewCount?: number;
+    url?: string;
+}): {
+    "@context": string;
+    "@type": string;
+    name: string;
+    description: string;
+    image: string | undefined;
+    sku: string | undefined;
+    brand: {
+        "@type": string;
+        name: string;
+    } | undefined;
+    offers: {
+        "@type": string;
+        url: string | undefined;
+        priceCurrency: string;
+        price: number | undefined;
+        availability: string;
+    };
+    aggregateRating: {
+        "@type": string;
+        ratingValue: number;
+        reviewCount: number;
+    } | undefined;
+};
+/**
+ * Generate FAQ Schema
+ */
+declare function generateFAQSchema(questions: Array<{
+    q: string;
+    a: string;
+}>): {
+    "@context": string;
+    "@type": string;
+    mainEntity: {
+        "@type": string;
+        name: string;
+        acceptedAnswer: {
+            "@type": string;
+            text: string;
+        };
+    }[];
+};
+/**
+ * Generate Breadcrumb Schema
+ */
+declare function generateBreadcrumbSchema(items: Array<{
+    name: string;
+    item: string;
+}>): {
+    "@context": string;
+    "@type": string;
+    itemListElement: {
+        "@type": string;
+        position: number;
+        name: string;
+        item: string;
+    }[];
+};
+/**
+ * Generate Video Schema
+ */
+declare function generateVideoSchema(data: {
+    name: string;
+    description: string;
+    thumbnailUrl: string;
+    uploadDate: string;
+    duration?: string;
+    contentUrl?: string;
+    embedUrl?: string;
+}): {
+    "@context": string;
+    "@type": string;
+    name: string;
+    description: string;
+    thumbnailUrl: string;
+    uploadDate: string;
+    duration: string | undefined;
+    contentUrl: string | undefined;
+    embedUrl: string | undefined;
+};
+/**
+ * Generate Event Schema
+ */
+declare function generateEventSchema(data: {
+    name: string;
+    description: string;
+    startDate: string;
+    endDate?: string;
+    location?: {
+        name: string;
+        address: string;
+    } | {
+        url: string;
+    };
+    image?: string;
+    offers?: {
+        price: number;
+        currency: string;
+        url: string;
+    };
+}): {
+    "@context": string;
+    "@type": string;
+    name: string;
+    description: string;
+    startDate: string;
+    endDate: string | undefined;
+    eventAttendanceMode: string;
+    location: {
+        "@type": string;
+        url: string;
+        name?: undefined;
+        address?: undefined;
+    } | {
+        "@type": string;
+        name: string;
+        address: string;
+        url?: undefined;
+    } | undefined;
+    image: string | undefined;
+    offers: {
+        "@type": string;
+        price: number;
+        priceCurrency: string;
+        url: string;
+    } | undefined;
+};
+/**
+ * Generate LocalBusiness Schema
+ */
+declare function generateLocalBusinessSchema(data: {
+    name: string;
+    description: string;
+    image?: string;
+    telephone?: string;
+    address: {
+        street: string;
+        city: string;
+        region?: string;
+        postalCode?: string;
+        country: string;
+    };
+    geo?: {
+        lat: number;
+        lng: number;
+    };
+    openingHours?: string[];
+    priceRange?: string;
+}): {
+    "@context": string;
+    "@type": string;
+    name: string;
+    description: string;
+    image: string | undefined;
+    telephone: string | undefined;
+    address: {
+        "@type": string;
+        streetAddress: string;
+        addressLocality: string;
+        addressRegion: string | undefined;
+        postalCode: string | undefined;
+        addressCountry: string;
+    };
+    geo: {
+        "@type": string;
+        latitude: number;
+        longitude: number;
+    } | undefined;
+    openingHours: string[] | undefined;
+    priceRange: string | undefined;
+};
+
+/**
+ * Converts SEOData and SiteConfig to a Next.js compatible Metadata object.
+ * This is designed to be used in Server Components (App Router).
+ *
+ * @example
+ * // In page.tsx
+ * import { toNextMetadata } from '@masters-ws/react-seo';
+ *
+ * export async function generateMetadata({ params }) {
+ *   const post = await getPost(params.id);
+ *   return toNextMetadata({ title: post.title, ... }, siteConfig);
+ * }
+ */
+declare function toNextMetadata(props: SEOData, config: SiteConfig): any;
+/**
+ * Generates pagination links for category/tag pages.
+ * Returns { prev, next, canonical } URLs.
+ */
+declare function generatePaginationLinks(baseUrl: string, currentPage: number, totalPages: number): {
+    next: string | undefined;
+    prev: string | undefined;
+    canonical: string;
+};
+/**
+ * Generates title with page number suffix for paginated pages.
+ */
+declare function generatePaginatedTitle(title: string, page: number, suffix?: string): string;
+
+export { type BreadcrumbItem as B, type SiteConfig as S, type SEOData as a, generateBreadcrumbSchema as b, generateEventSchema as c, generateFAQSchema as d, generateLocalBusinessSchema as e, generateOrganizationSchema as f, generateArticleSchema as g, generatePaginatedTitle as h, generatePaginationLinks as i, generateProductSchema as j, generateVideoSchema as k, generateWebSiteSchema as l, toNextMetadata as t };