@sonordev/site-kit 1.2.7

package/dist/types-Blb2QNkV.d.mts

@@ -0,0 +1,263 @@
+/**
+ * @sonordev/site-kit/llms - Types
+ *
+ * LLM Visibility Types for Answer Engine Optimization (AEO)
+ */
+interface LLMBusinessInfo {
+    /** Business/organization name */
+    name: string;
+    /** One-line tagline or mission */
+    tagline?: string;
+    /** Longer description (1-3 paragraphs) */
+    description: string;
+    /** Industry/category */
+    industry?: string;
+    /** Primary service area (city, region, or "nationwide") */
+    service_area?: string;
+    /** Year established */
+    founded?: string;
+    /** Website URL */
+    website: string;
+}
+interface LLMContactInfo {
+    /** Primary phone */
+    phone?: string;
+    /** Primary email */
+    email?: string;
+    /** Street address */
+    address?: string;
+    /** City */
+    city?: string;
+    /** State/province */
+    state?: string;
+    /** ZIP/postal code */
+    postal_code?: string;
+    /** Country */
+    country?: string;
+    /** Business hours (e.g., "Mon-Fri 9am-5pm EST") */
+    hours?: string;
+}
+interface LLMService {
+    /** Service name */
+    name: string;
+    /** Brief description */
+    description: string;
+    /** URL path to service page */
+    url?: string;
+}
+interface LLMFAQItem {
+    /** Question */
+    question: string;
+    /** Answer */
+    answer: string;
+}
+interface LLMPageSummary {
+    /** Page path */
+    path: string;
+    /** Page title */
+    title: string;
+    /** Brief description of page content */
+    description?: string;
+}
+interface GenerateLLMSTxtOptions {
+    /** Project ID for fetching data (optional - uses API key's project) */
+    projectId?: string;
+    /** When Portal returns empty services/faq/pages, use this to supply local site data */
+    getLocalData?: () => Promise<LLMsDataResponse | null>;
+    /** Include business info section */
+    includeBusinessInfo?: boolean;
+    /** Include services list */
+    includeServices?: boolean;
+    /** Include FAQ section */
+    includeFAQ?: boolean;
+    /** Include page index */
+    includePages?: boolean;
+    /** Include contact info */
+    includeContact?: boolean;
+    /** Maximum number of FAQ items */
+    maxFAQItems?: number;
+    /** Maximum number of pages to list */
+    maxPages?: number;
+    /** Include entity knowledge graph section (default: true) */
+    includeEntities?: boolean;
+    /** Maximum number of entities to include (default: 50) */
+    maxEntities?: number;
+    /** Custom sections to append */
+    customSections?: Array<{
+        title: string;
+        content: string;
+    }>;
+}
+interface LLMSTxtContent {
+    /** Raw markdown content */
+    markdown: string;
+    /** Metadata about generation */
+    metadata: {
+        generated_at: string;
+        project_id: string;
+        sections: string[];
+    };
+}
+interface SpeakableConfig {
+    /** CSS selectors for speakable content */
+    cssSelectors?: string[];
+    /** XPath selectors for speakable content */
+    xPaths?: string[];
+}
+interface SpeakableSchemaProps {
+    /** Page type - Article or WebPage */
+    type: 'Article' | 'WebPage';
+    /** Page name/title */
+    name: string;
+    /** Page URL */
+    url: string;
+    /** Speakable content selectors */
+    speakable: SpeakableConfig;
+    /** Additional schema properties */
+    additionalProperties?: Record<string, unknown>;
+}
+interface AEOBlockProps {
+    /** Block ID for speakable reference */
+    id?: string;
+    /** Type of content block */
+    type: 'summary' | 'definition' | 'answer' | 'list' | 'steps' | 'comparison';
+    /** Optional question (for Q&A format) */
+    question?: string;
+    /** Whether to mark as speakable */
+    speakable?: boolean;
+    /** Entity ID for knowledge graph linking */
+    entityId?: string;
+    /** Children content */
+    children: React.ReactNode;
+    /** Optional CSS class */
+    className?: string;
+}
+interface AEOSummaryProps {
+    /** Title for the summary */
+    title?: string;
+    /** Key points to highlight */
+    points: string[];
+    /** Whether to mark as speakable */
+    speakable?: boolean;
+    /** Entity ID for knowledge graph linking */
+    entityId?: string;
+    /** Optional CSS class */
+    className?: string;
+}
+interface AEODefinitionProps {
+    /** Term being defined */
+    term: string;
+    /** Definition */
+    definition: string;
+    /** Whether to mark as speakable */
+    speakable?: boolean;
+    /** Entity ID for knowledge graph linking */
+    entityId?: string;
+    /** Source for the definition (e.g., statute code) */
+    source?: string;
+    /** Optional CSS class */
+    className?: string;
+}
+/**
+ * AEOClaimProps - AI-Verifiable Claim with Provenance
+ *
+ * For wrapping factual claims with machine-readable source attribution.
+ * LLMs heavily favor content with verifiable sources and confidence scores.
+ */
+interface AEOClaimProps {
+    /** Source reference (e.g., "KRS 281A.170", "NIH Study 2024") */
+    source: string;
+    /** URL to source document */
+    sourceUrl?: string;
+    /** Confidence score 0-1 */
+    confidence?: number;
+    /** Type of claim */
+    claimType?: 'fact' | 'statute' | 'study' | 'quote' | 'statistic';
+    /** When the source was retrieved */
+    retrievedAt?: string;
+    /** Children content */
+    children: React.ReactNode;
+    /** Optional CSS class */
+    className?: string;
+}
+/**
+ * AEOEntityProps - Inline Entity Annotation
+ *
+ * For annotating entity mentions with knowledge graph IDs.
+ */
+interface AEOEntityProps {
+    /** Entity ID from knowledge graph */
+    entityId: string;
+    /** Entity type */
+    entityType: 'organization' | 'person' | 'service' | 'product' | 'location' | 'concept' | 'credential';
+    /** Canonical entity name */
+    name: string;
+    /** Entity URL */
+    url?: string;
+    /** Children content */
+    children: React.ReactNode;
+    /** Optional CSS class */
+    className?: string;
+}
+/**
+ * ContentProvenance - Source attribution for content
+ *
+ * Links content to authoritative sources for AI verification.
+ */
+interface ContentProvenance {
+    /** Unique provenance ID */
+    id: string;
+    /** Type of source */
+    source_type: 'press_release' | 'news_article' | 'legal_statute' | 'research_paper' | 'official_document' | 'internal' | 'citation';
+    /** Source title */
+    title: string;
+    /** Source URL */
+    url?: string;
+    /** Publisher/organization name */
+    publisher?: string;
+    /** Publication date */
+    published_at?: string;
+    /** Date accessed */
+    accessed_at?: string;
+    /** Brief excerpt or summary */
+    excerpt?: string;
+    /** Confidence score 0-1 */
+    confidence?: number;
+    /** DOI or other identifier */
+    identifier?: string;
+}
+/**
+ * AEOProvenanceListProps - Display provenance sources
+ */
+interface AEOProvenanceListProps {
+    /** List of provenance sources */
+    sources: ContentProvenance[];
+    /** Title for the section */
+    title?: string;
+    /** Optional CSS class */
+    className?: string;
+}
+/**
+ * AEOCitedContentProps - Content with inline citations
+ *
+ * Wraps content that has numbered citations referencing provenance sources.
+ */
+interface AEOCitedContentProps {
+    /** Content with [1], [2] style inline citations */
+    children: React.ReactNode;
+    /** Provenance sources (index matches citation number) */
+    sources: ContentProvenance[];
+    /** Whether to show sources list at bottom */
+    showSourcesList?: boolean;
+    /** Optional CSS class */
+    className?: string;
+}
+interface LLMsDataResponse {
+    business: LLMBusinessInfo;
+    contact?: LLMContactInfo;
+    services: LLMService[];
+    faq: LLMFAQItem[];
+    pages: LLMPageSummary[];
+}
+
+export type { AEOBlockProps as A, ContentProvenance as C, GenerateLLMSTxtOptions as G, LLMsDataResponse as L, SpeakableSchemaProps as S, LLMSTxtContent as a, SpeakableConfig as b, AEOSummaryProps as c, AEODefinitionProps as d, AEOClaimProps as e, LLMBusinessInfo as f, LLMService as g, LLMFAQItem as h, LLMPageSummary as i, LLMContactInfo as j, AEOEntityProps as k, AEOProvenanceListProps as l, AEOCitedContentProps as m };

package/dist/types-Blb2QNkV.d.ts

@@ -0,0 +1,263 @@
+/**
+ * @sonordev/site-kit/llms - Types
+ *
+ * LLM Visibility Types for Answer Engine Optimization (AEO)
+ */
+interface LLMBusinessInfo {
+    /** Business/organization name */
+    name: string;
+    /** One-line tagline or mission */
+    tagline?: string;
+    /** Longer description (1-3 paragraphs) */
+    description: string;
+    /** Industry/category */
+    industry?: string;
+    /** Primary service area (city, region, or "nationwide") */
+    service_area?: string;
+    /** Year established */
+    founded?: string;
+    /** Website URL */
+    website: string;
+}
+interface LLMContactInfo {
+    /** Primary phone */
+    phone?: string;
+    /** Primary email */
+    email?: string;
+    /** Street address */
+    address?: string;
+    /** City */
+    city?: string;
+    /** State/province */
+    state?: string;
+    /** ZIP/postal code */
+    postal_code?: string;
+    /** Country */
+    country?: string;
+    /** Business hours (e.g., "Mon-Fri 9am-5pm EST") */
+    hours?: string;
+}
+interface LLMService {
+    /** Service name */
+    name: string;
+    /** Brief description */
+    description: string;
+    /** URL path to service page */
+    url?: string;
+}
+interface LLMFAQItem {
+    /** Question */
+    question: string;
+    /** Answer */
+    answer: string;
+}
+interface LLMPageSummary {
+    /** Page path */
+    path: string;
+    /** Page title */
+    title: string;
+    /** Brief description of page content */
+    description?: string;
+}
+interface GenerateLLMSTxtOptions {
+    /** Project ID for fetching data (optional - uses API key's project) */
+    projectId?: string;
+    /** When Portal returns empty services/faq/pages, use this to supply local site data */
+    getLocalData?: () => Promise<LLMsDataResponse | null>;
+    /** Include business info section */
+    includeBusinessInfo?: boolean;
+    /** Include services list */
+    includeServices?: boolean;
+    /** Include FAQ section */
+    includeFAQ?: boolean;
+    /** Include page index */
+    includePages?: boolean;
+    /** Include contact info */
+    includeContact?: boolean;
+    /** Maximum number of FAQ items */
+    maxFAQItems?: number;
+    /** Maximum number of pages to list */
+    maxPages?: number;
+    /** Include entity knowledge graph section (default: true) */
+    includeEntities?: boolean;
+    /** Maximum number of entities to include (default: 50) */
+    maxEntities?: number;
+    /** Custom sections to append */
+    customSections?: Array<{
+        title: string;
+        content: string;
+    }>;
+}
+interface LLMSTxtContent {
+    /** Raw markdown content */
+    markdown: string;
+    /** Metadata about generation */
+    metadata: {
+        generated_at: string;
+        project_id: string;
+        sections: string[];
+    };
+}
+interface SpeakableConfig {
+    /** CSS selectors for speakable content */
+    cssSelectors?: string[];
+    /** XPath selectors for speakable content */
+    xPaths?: string[];
+}
+interface SpeakableSchemaProps {
+    /** Page type - Article or WebPage */
+    type: 'Article' | 'WebPage';
+    /** Page name/title */
+    name: string;
+    /** Page URL */
+    url: string;
+    /** Speakable content selectors */
+    speakable: SpeakableConfig;
+    /** Additional schema properties */
+    additionalProperties?: Record<string, unknown>;
+}
+interface AEOBlockProps {
+    /** Block ID for speakable reference */
+    id?: string;
+    /** Type of content block */
+    type: 'summary' | 'definition' | 'answer' | 'list' | 'steps' | 'comparison';
+    /** Optional question (for Q&A format) */
+    question?: string;
+    /** Whether to mark as speakable */
+    speakable?: boolean;
+    /** Entity ID for knowledge graph linking */
+    entityId?: string;
+    /** Children content */
+    children: React.ReactNode;
+    /** Optional CSS class */
+    className?: string;
+}
+interface AEOSummaryProps {
+    /** Title for the summary */
+    title?: string;
+    /** Key points to highlight */
+    points: string[];
+    /** Whether to mark as speakable */
+    speakable?: boolean;
+    /** Entity ID for knowledge graph linking */
+    entityId?: string;
+    /** Optional CSS class */
+    className?: string;
+}
+interface AEODefinitionProps {
+    /** Term being defined */
+    term: string;
+    /** Definition */
+    definition: string;
+    /** Whether to mark as speakable */
+    speakable?: boolean;
+    /** Entity ID for knowledge graph linking */
+    entityId?: string;
+    /** Source for the definition (e.g., statute code) */
+    source?: string;
+    /** Optional CSS class */
+    className?: string;
+}
+/**
+ * AEOClaimProps - AI-Verifiable Claim with Provenance
+ *
+ * For wrapping factual claims with machine-readable source attribution.
+ * LLMs heavily favor content with verifiable sources and confidence scores.
+ */
+interface AEOClaimProps {
+    /** Source reference (e.g., "KRS 281A.170", "NIH Study 2024") */
+    source: string;
+    /** URL to source document */
+    sourceUrl?: string;
+    /** Confidence score 0-1 */
+    confidence?: number;
+    /** Type of claim */
+    claimType?: 'fact' | 'statute' | 'study' | 'quote' | 'statistic';
+    /** When the source was retrieved */
+    retrievedAt?: string;
+    /** Children content */
+    children: React.ReactNode;
+    /** Optional CSS class */
+    className?: string;
+}
+/**
+ * AEOEntityProps - Inline Entity Annotation
+ *
+ * For annotating entity mentions with knowledge graph IDs.
+ */
+interface AEOEntityProps {
+    /** Entity ID from knowledge graph */
+    entityId: string;
+    /** Entity type */
+    entityType: 'organization' | 'person' | 'service' | 'product' | 'location' | 'concept' | 'credential';
+    /** Canonical entity name */
+    name: string;
+    /** Entity URL */
+    url?: string;
+    /** Children content */
+    children: React.ReactNode;
+    /** Optional CSS class */
+    className?: string;
+}
+/**
+ * ContentProvenance - Source attribution for content
+ *
+ * Links content to authoritative sources for AI verification.
+ */
+interface ContentProvenance {
+    /** Unique provenance ID */
+    id: string;
+    /** Type of source */
+    source_type: 'press_release' | 'news_article' | 'legal_statute' | 'research_paper' | 'official_document' | 'internal' | 'citation';
+    /** Source title */
+    title: string;
+    /** Source URL */
+    url?: string;
+    /** Publisher/organization name */
+    publisher?: string;
+    /** Publication date */
+    published_at?: string;
+    /** Date accessed */
+    accessed_at?: string;
+    /** Brief excerpt or summary */
+    excerpt?: string;
+    /** Confidence score 0-1 */
+    confidence?: number;
+    /** DOI or other identifier */
+    identifier?: string;
+}
+/**
+ * AEOProvenanceListProps - Display provenance sources
+ */
+interface AEOProvenanceListProps {
+    /** List of provenance sources */
+    sources: ContentProvenance[];
+    /** Title for the section */
+    title?: string;
+    /** Optional CSS class */
+    className?: string;
+}
+/**
+ * AEOCitedContentProps - Content with inline citations
+ *
+ * Wraps content that has numbered citations referencing provenance sources.
+ */
+interface AEOCitedContentProps {
+    /** Content with [1], [2] style inline citations */
+    children: React.ReactNode;
+    /** Provenance sources (index matches citation number) */
+    sources: ContentProvenance[];
+    /** Whether to show sources list at bottom */
+    showSourcesList?: boolean;
+    /** Optional CSS class */
+    className?: string;
+}
+interface LLMsDataResponse {
+    business: LLMBusinessInfo;
+    contact?: LLMContactInfo;
+    services: LLMService[];
+    faq: LLMFAQItem[];
+    pages: LLMPageSummary[];
+}
+
+export type { AEOBlockProps as A, ContentProvenance as C, GenerateLLMSTxtOptions as G, LLMsDataResponse as L, SpeakableSchemaProps as S, LLMSTxtContent as a, SpeakableConfig as b, AEOSummaryProps as c, AEODefinitionProps as d, AEOClaimProps as e, LLMBusinessInfo as f, LLMService as g, LLMFAQItem as h, LLMPageSummary as i, LLMContactInfo as j, AEOEntityProps as k, AEOProvenanceListProps as l, AEOCitedContentProps as m };