geo-semantic-layer 2.0.1

package/dist/generators/index.d.ts

@@ -0,0 +1,723 @@
+import { d as IdentityConfig, G as GeoConfig, P as PostalAddress, c as ContactPoint } from '../config-BcP2K8Tq.js';
+import { a as Organization, d as Person, h as Product, n as Article, r as FAQPage, v as BreadcrumbList, H as LocalBusiness, U as Event, y as WebPage } from '../event-BG0_yYK4.js';
+import 'zod';
+
+/**
+ * Identity schema generator (Organization/Person)
+ * @module generators/identity
+ */
+
+/**
+ * Configuration for generating Organization schema
+ */
+interface OrganizationConfig {
+    name: string;
+    alternateName?: string;
+    url?: string;
+    logo?: string;
+    description?: string;
+    sameAs?: string[];
+    email?: string;
+    telephone?: string;
+    address?: PostalAddress;
+    contactPoint?: ContactPoint;
+    foundingDate?: string;
+    founder?: string | string[];
+    founders?: string[];
+    numberOfEmployees?: number;
+    /**
+     * GEO optimization settings
+     */
+    geo?: Partial<GeoConfig>;
+}
+/**
+ * Configuration for generating Person schema
+ */
+interface PersonConfig {
+    name: string;
+    url?: string;
+    image?: string;
+    description?: string;
+    jobTitle?: string;
+    sameAs?: string[];
+    email?: string;
+    telephone?: string;
+    address?: PostalAddress;
+    worksFor?: {
+        '@type': 'Organization';
+        name: string;
+    } | string;
+    birthDate?: string;
+    /**
+     * GEO optimization settings
+     */
+    geo?: Partial<GeoConfig>;
+}
+/**
+ * Generates a validated JSON-LD schema for Organization or Person identity
+ *
+ * This is the core function for creating your website's root entity,
+ * which serves as the anchor for all semantic relationships.
+ *
+ * @param config - Identity configuration (name, URL, social profiles, etc.)
+ * @returns Validated JSON-LD schema ready to inject into <script type="application/ld+json">
+ *
+ * @throws {z.ZodError} If validation fails (invalid URLs, missing required fields, etc.)
+ *
+ * @example
+ * ```typescript
+ * // Organization example
+ * const orgSchema = generateIdentitySchema({
+ *   type: 'Organization',
+ *   name: 'Acme Corp',
+ *   url: 'https://acme.com',
+ *   logoUrl: 'https://acme.com/logo.png',
+ *   sameAs: [
+ *     'https://twitter.com/acme',
+ *     'https://www.wikidata.org/wiki/Q123456'
+ *   ],
+ *   email: 'contact@acme.com',
+ *   telephone: '+1-555-0100'
+ * });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Person example
+ * const personSchema = generateIdentitySchema({
+ *   type: 'Person',
+ *   name: 'John Doe',
+ *   url: 'https://johndoe.com',
+ *   imageUrl: 'https://johndoe.com/photo.jpg',
+ *   sameAs: [
+ *     'https://twitter.com/johndoe',
+ *     'https://linkedin.com/in/johndoe'
+ *   ],
+ *   jobTitle: 'Senior Software Architect',
+ *   worksFor: 'Acme Corp'
+ * });
+ * ```
+ */
+declare function generateIdentitySchema(config: IdentityConfig & {
+    geo?: Partial<GeoConfig>;
+}): Organization | Person;
+/**
+ * Generates Organization JSON-LD schema
+ *
+ * @param config - Organization configuration
+ * @returns Validated Organization schema
+ *
+ * @example
+ * ```typescript
+ * const orgSchema = generateOrganizationSchema({
+ *   name: 'Acme Corp',
+ *   url: 'https://acme.com',
+ *   logo: 'https://acme.com/logo.png',
+ *   sameAs: ['https://twitter.com/acme']
+ * });
+ * ```
+ */
+declare function generateOrganizationSchema(config: OrganizationConfig): Organization;
+/**
+ * Generates Person JSON-LD schema
+ *
+ * @param config - Person configuration
+ * @returns Validated Person schema
+ *
+ * @example
+ * ```typescript
+ * const personSchema = generatePersonSchema({
+ *   name: 'John Doe',
+ *   url: 'https://johndoe.com',
+ *   image: 'https://johndoe.com/photo.jpg',
+ *   jobTitle: 'Software Engineer'
+ * });
+ * ```
+ */
+declare function generatePersonSchema(config: PersonConfig): Person;
+/**
+ * Serializes a JSON-LD schema to string for HTML injection
+ *
+ * @param schema - JSON-LD schema object
+ * @returns Formatted JSON string ready for <script type="application/ld+json">
+ *
+ * @example
+ * ```typescript
+ * const schema = generateIdentitySchema({ ... });
+ * const scriptContent = serializeSchema(schema);
+ *
+ * // In HTML:
+ * // <script type="application/ld+json">{scriptContent}</script>
+ * ```
+ */
+declare function serializeSchema(schema: Organization | Person): string;
+/**
+ * Generates a complete <script> tag with JSON-LD content
+ *
+ * @param schema - JSON-LD schema object
+ * @returns Complete script tag HTML string
+ *
+ * @example
+ * ```typescript
+ * const schema = generateIdentitySchema({ ... });
+ * const scriptTag = generateScriptTag(schema);
+ *
+ * // Returns:
+ * // <script type="application/ld+json">
+ * // { "@context": "https://schema.org", ... }
+ * // </script>
+ * ```
+ */
+declare function generateScriptTag(schema: Organization | Person): string;
+
+/**
+ * Product schema generator
+ * @module generators/product
+ */
+
+/**
+ * Configuration for generating Product schema
+ */
+interface ProductConfig {
+    name: string;
+    description?: string;
+    image?: string | string[];
+    sku?: string;
+    gtin?: string;
+    brand?: string;
+    offers?: OfferConfig | OfferConfig[];
+    aggregateRating?: {
+        ratingValue: number | string;
+        reviewCount: number;
+        bestRating?: number | string;
+        worstRating?: number | string;
+    };
+    category?: string;
+    color?: string | string[];
+}
+/**
+ * Configuration for Offer
+ */
+interface OfferConfig {
+    price: number | string;
+    priceCurrency: string;
+    availability?: string;
+    url?: string;
+    priceValidUntil?: string;
+    seller?: {
+        name: string;
+    };
+}
+/**
+ * Generates a validated Product JSON-LD schema
+ *
+ * @param config - Product configuration
+ * @returns Validated Product schema
+ *
+ * @example
+ * ```typescript
+ * const product = generateProductSchema({
+ *   name: 'Premium Wireless Headphones',
+ *   description: 'High-quality wireless headphones with noise cancellation',
+ *   image: 'https://example.com/headphones.jpg',
+ *   sku: 'WH-1000XM5',
+ *   brand: 'TechBrand',
+ *   offers: {
+ *     price: 299.99,
+ *     priceCurrency: 'USD',
+ *     availability: 'https://schema.org/InStock',
+ *   },
+ *   aggregateRating: {
+ *     ratingValue: 4.8,
+ *     reviewCount: 247,
+ *   },
+ * });
+ * ```
+ */
+declare function generateProductSchema(config: ProductConfig): Product;
+
+/**
+ * Article schema generator
+ * @module generators/article
+ */
+
+/**
+ * Configuration for generating Article schema
+ */
+interface ArticleConfig {
+    headline: string;
+    image: string | string[];
+    author: string | {
+        name: string;
+        url?: string;
+    } | Array<{
+        name: string;
+        url?: string;
+    }>;
+    datePublished: string;
+    dateModified?: string;
+    description?: string;
+    articleBody?: string;
+    publisher?: {
+        name: string;
+        logo?: string;
+    };
+    url?: string;
+    keywords?: string | string[];
+    articleSection?: string;
+    /**
+     * GEO optimization settings for this specific article
+     */
+    geo?: Partial<GeoConfig>;
+}
+/**
+ * Generates a validated Article JSON-LD schema
+ *
+ * @param config - Article configuration
+ * @returns Validated Article schema
+ *
+ * @example
+ * ```typescript
+ * const article = generateArticleSchema({
+ *   headline: 'The Future of GEO in 2026',
+ *   image: 'https://example.com/article-image.jpg',
+ *   author: 'John Doe',
+ *   datePublished: '2026-01-05',
+ *   geo: { contentDensity: 'high' } // Optimize for LLMs
+ * });
+ * ```
+ */
+declare function generateArticleSchema(config: ArticleConfig): Article;
+
+/**
+ * FAQ schema generator
+ * @module generators/faq
+ */
+
+/**
+ * Configuration for a single FAQ question
+ */
+interface FAQQuestion {
+    question: string;
+    answer: string;
+}
+/**
+ * Configuration for generating FAQPage schema
+ */
+interface FAQConfig {
+    questions: FAQQuestion[];
+}
+/**
+ * Generates a validated FAQPage JSON-LD schema
+ *
+ * @param config - FAQ configuration with array of questions and answers
+ * @returns Validated FAQPage schema
+ *
+ * @example
+ * ```typescript
+ * const faq = generateFAQSchema({
+ *   questions: [
+ *     {
+ *       question: 'What is GEO?',
+ *       answer: 'GEO (Generative Engine Optimization) is the practice of optimizing content for AI search engines like ChatGPT, Gemini, and Perplexity.',
+ *     },
+ *     {
+ *       question: 'How does Semantic Layer help with GEO?',
+ *       answer: 'Semantic Layer automatically generates validated JSON-LD schemas that help AI models understand and cite your content.',
+ *     },
+ *   ],
+ * });
+ * ```
+ */
+declare function generateFAQSchema(config: FAQConfig): FAQPage;
+
+/**
+ * Breadcrumb schema generator
+ * @module generators/breadcrumb
+ */
+
+/**
+ * Configuration for a single breadcrumb item
+ */
+interface BreadcrumbItem {
+    name: string;
+    url?: string;
+}
+/**
+ * Configuration for generating BreadcrumbList schema
+ */
+interface BreadcrumbConfig {
+    items: BreadcrumbItem[];
+}
+/**
+ * Generates a validated BreadcrumbList JSON-LD schema
+ *
+ * @param config - Breadcrumb configuration with ordered array of items
+ * @returns Validated BreadcrumbList schema
+ *
+ * @example
+ * ```typescript
+ * const breadcrumb = generateBreadcrumbSchema({
+ *   items: [
+ *     { name: 'Home', url: 'https://example.com' },
+ *     { name: 'Products', url: 'https://example.com/products' },
+ *     { name: 'Headphones', url: 'https://example.com/products/headphones' },
+ *     { name: 'WH-1000XM5' }, // Current page (no URL)
+ *   ],
+ * });
+ * ```
+ */
+declare function generateBreadcrumbSchema(config: BreadcrumbConfig): BreadcrumbList;
+
+/**
+ * OpenGraph and Twitter Cards meta tag generators
+ * @module generators/opengraph
+ */
+/**
+ * Meta tag interface
+ */
+interface MetaTag {
+    property?: string;
+    name?: string;
+    content: string;
+}
+/**
+ * Configuration for OpenGraph
+ */
+interface OpenGraphConfig {
+    title: string;
+    description: string;
+    url: string;
+    type?: 'website' | 'article' | 'product' | 'book' | 'profile' | 'music' | 'video';
+    image: string;
+    imageAlt?: string;
+    siteName?: string;
+    locale?: string;
+    publishedTime?: string;
+    modifiedTime?: string;
+    author?: string;
+    section?: string;
+    tags?: string[];
+    price?: number | string;
+    currency?: string;
+}
+/**
+ * Configuration for Twitter Cards
+ */
+interface TwitterCardConfig {
+    card?: 'summary' | 'summary_large_image' | 'app' | 'player';
+    site?: string;
+    creator?: string;
+    title: string;
+    description: string;
+    image: string;
+    imageAlt?: string;
+}
+/**
+ * Generates OpenGraph meta tags
+ *
+ * @param config - OpenGraph configuration
+ * @returns Array of validated meta tags
+ *
+ * @example
+ * ```typescript
+ * const ogTags = generateOpenGraphTags({
+ *   title: 'Amazing Product',
+ *   description: 'The best product ever',
+ *   url: 'https://example.com/product',
+ *   image: 'https://example.com/image.jpg',
+ *   type: 'product',
+ *   price: 99.99,
+ *   currency: 'USD',
+ * });
+ * ```
+ */
+declare function generateOpenGraphTags(config: OpenGraphConfig): MetaTag[];
+/**
+ * Generates Twitter Card meta tags
+ *
+ * @param config - Twitter Card configuration
+ * @returns Array of validated meta tags
+ *
+ * @example
+ * ```typescript
+ * const twitterTags = generateTwitterCardTags({
+ *   card: 'summary_large_image',
+ *   site: '@mysite',
+ *   title: 'Amazing Product',
+ *   description: 'Check out this product',
+ *   image: 'https://example.com/image.jpg',
+ * });
+ * ```
+ */
+declare function generateTwitterCardTags(config: TwitterCardConfig): MetaTag[];
+/**
+ * Generates both OpenGraph and Twitter Card meta tags
+ *
+ * @param config - Combined configuration
+ * @returns Object with separate arrays for og and twitter tags
+ *
+ * @example
+ * ```typescript
+ * const { openGraph, twitter } = generateSocialMetaTags({
+ *   title: 'My Page',
+ *   description: 'Page description',
+ *   url: 'https://example.com',
+ *   image: 'https://example.com/image.jpg',
+ *   twitterSite: '@mysite',
+ * });
+ * ```
+ */
+declare function generateSocialMetaTags(config: {
+    title: string;
+    description: string;
+    url: string;
+    image: string;
+    imageAlt?: string;
+    type?: OpenGraphConfig['type'];
+    siteName?: string;
+    twitterSite?: string;
+    twitterCreator?: string;
+    twitterCard?: TwitterCardConfig['card'];
+}): {
+    openGraph: MetaTag[];
+    twitter: MetaTag[];
+};
+/**
+ * Converts meta tags to HTML string
+ *
+ * @param tags - Array of meta tags
+ * @returns HTML string
+ */
+declare function metaTagsToHTML(tags: MetaTag[]): string;
+
+/**
+ * LocalBusiness schema generator
+ * @module generators/localbusiness
+ */
+
+/**
+ * Day of week type
+ */
+type DayOfWeek = 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' | 'Sunday';
+/**
+ * Opening hours configuration
+ */
+interface OpeningHoursConfig {
+    dayOfWeek: DayOfWeek | DayOfWeek[];
+    opens: string;
+    closes: string;
+}
+/**
+ * Configuration for LocalBusiness schema
+ */
+interface LocalBusinessConfig {
+    type?: string;
+    name: string;
+    image: string | string[];
+    address: {
+        streetAddress: string;
+        addressLocality: string;
+        addressRegion: string;
+        postalCode: string;
+        addressCountry: string;
+    };
+    geo?: {
+        latitude: number;
+        longitude: number;
+    };
+    url?: string;
+    telephone?: string;
+    priceRange?: string;
+    openingHours?: OpeningHoursConfig | OpeningHoursConfig[];
+    description?: string;
+    aggregateRating?: {
+        ratingValue: number | string;
+        reviewCount: number;
+    };
+    servesCuisine?: string | string[];
+    menu?: string;
+    acceptsReservations?: boolean | string;
+    paymentAccepted?: string;
+}
+/**
+ * Generates a validated LocalBusiness JSON-LD schema
+ *
+ * Perfect for restaurants, stores, offices, dentists, salons, etc.
+ *
+ * @param config - LocalBusiness configuration
+ * @returns Validated LocalBusiness schema
+ *
+ * @example
+ * ```typescript
+ * const business = generateLocalBusinessSchema({
+ *   type: 'Restaurant',
+ *   name: 'Pizza Palace',
+ *   image: 'https://example.com/pizza.jpg',
+ *   address: {
+ *     streetAddress: '123 Main St',
+ *     addressLocality: 'New York',
+ *     addressRegion: 'NY',
+ *     postalCode: '10001',
+ *     addressCountry: 'US',
+ *   },
+ *   geo: {
+ *     latitude: 40.7128,
+ *     longitude: -74.0060,
+ *   },
+ *   telephone: '+1-555-0199',
+ *   priceRange: '$$',
+ *   servesCuisine: 'Italian',
+ *   openingHours: [
+ *     { dayOfWeek: ['Monday', 'Tuesday', 'Wednesday', 'Thursday'], opens: '11:00', closes: '22:00' },
+ *     { dayOfWeek: ['Friday', 'Saturday'], opens: '11:00', closes: '23:00' },
+ *     { dayOfWeek: 'Sunday', opens: '12:00', closes: '21:00' },
+ *   ],
+ * });
+ * ```
+ */
+declare function generateLocalBusinessSchema(config: LocalBusinessConfig): LocalBusiness;
+
+/**
+ * Event schema generator
+ * @module generators/event
+ */
+
+/**
+ * Configuration for Event schema
+ */
+interface EventConfig {
+    type?: 'Event' | 'MusicEvent' | 'BusinessEvent' | 'SportsEvent' | 'TheaterEvent' | 'EducationEvent';
+    name: string;
+    startDate: string;
+    endDate?: string;
+    eventStatus?: 'EventScheduled' | 'EventCancelled' | 'EventMovedOnline' | 'EventPostponed' | 'EventRescheduled';
+    eventAttendanceMode?: 'OfflineEventAttendanceMode' | 'OnlineEventAttendanceMode' | 'MixedEventAttendanceMode';
+    location?: {
+        name: string;
+        address?: string | {
+            streetAddress?: string;
+            addressLocality?: string;
+            addressRegion?: string;
+            postalCode?: string;
+            addressCountry?: string;
+        };
+    } | string;
+    image?: string | string[];
+    description?: string;
+    url?: string;
+    organizer?: {
+        type: 'Organization' | 'Person';
+        name: string;
+        url?: string;
+    };
+    performer?: {
+        type: 'Person' | 'PerformingGroup';
+        name: string;
+    } | Array<{
+        type: 'Person' | 'PerformingGroup';
+        name: string;
+    }>;
+    offers?: {
+        url?: string;
+        price: number | string;
+        priceCurrency: string;
+        availability?: string;
+        validFrom?: string;
+    } | Array<{
+        url?: string;
+        price: number | string;
+        priceCurrency: string;
+        availability?: string;
+        validFrom?: string;
+    }>;
+}
+/**
+ * Generates a validated Event JSON-LD schema
+ *
+ * Perfect for concerts, conferences, workshops, sports games, theater shows, etc.
+ *
+ * @param config - Event configuration
+ * @returns Validated Event schema
+ *
+ * @example
+ * ```typescript
+ * const event = generateEventSchema({
+ *   type: 'MusicEvent',
+ *   name: 'Summer Music Festival 2026',
+ *   startDate: '2026-07-15T18:00:00-05:00',
+ *   endDate: '2026-07-15T23:00:00-05:00',
+ *   eventStatus: 'EventScheduled',
+ *   eventAttendanceMode: 'OfflineEventAttendanceMode',
+ *   location: {
+ *     name: 'Central Park',
+ *     address: {
+ *       addressLocality: 'New York',
+ *       addressRegion: 'NY',
+ *       addressCountry: 'US',
+ *     },
+ *   },
+ *   image: 'https://example.com/festival.jpg',
+ *   description: 'Annual summer music festival featuring top artists',
+ *   organizer: {
+ *     type: 'Organization',
+ *     name: 'Music Events Inc',
+ *   },
+ *   offers: {
+ *     price: 75,
+ *     priceCurrency: 'USD',
+ *     availability: 'https://schema.org/InStock',
+ *     url: 'https://example.com/tickets',
+ *   },
+ * });
+ * ```
+ */
+declare function generateEventSchema(config: EventConfig): Event;
+
+/**
+ * WebPage schema generator
+ * @module generators/webpage
+ */
+
+/**
+ * Configuration for generating WebPage schema
+ */
+interface WebPageConfig {
+    name: string;
+    description: string;
+    url: string;
+    inLanguage?: string;
+    isPartOf?: {
+        '@type': 'WebSite';
+        name: string;
+        url: string;
+    };
+    breadcrumb?: {
+        '@type': 'BreadcrumbList';
+        itemListElement: Array<{
+            '@type': 'ListItem';
+            position: number;
+            name: string;
+            item?: string;
+        }>;
+    };
+}
+/**
+ * Generates a validated WebPage JSON-LD schema
+ *
+ * @param config - WebPage configuration
+ * @returns Validated WebPage schema
+ *
+ * @example
+ * ```typescript
+ * const webPage = generateWebPageSchema({
+ *   name: 'Product Catalog',
+ *   description: 'Browse our complete product catalog',
+ *   url: 'https://example.com/products',
+ *   inLanguage: 'en-US'
+ * });
+ * ```
+ */
+declare function generateWebPageSchema(config: WebPageConfig): WebPage;
+
+export { type ArticleConfig, type BreadcrumbConfig, type BreadcrumbItem, type DayOfWeek, type EventConfig, type FAQConfig, type FAQQuestion, type LocalBusinessConfig, type MetaTag, type OfferConfig, type OpenGraphConfig, type OpeningHoursConfig, type OrganizationConfig, type PersonConfig, type ProductConfig, type TwitterCardConfig, type WebPageConfig, generateArticleSchema, generateBreadcrumbSchema, generateEventSchema, generateFAQSchema, generateIdentitySchema, generateLocalBusinessSchema, generateOpenGraphTags, generateOrganizationSchema, generatePersonSchema, generateProductSchema, generateScriptTag, generateSocialMetaTags, generateTwitterCardTags, generateWebPageSchema, metaTagsToHTML, serializeSchema };