aeo.js 0.0.1 → 0.0.3

package/dist/index.d.ts

@@ -1 +1,191 @@
-export declare const VERSION = "0.0.1";
+import { F as FrameworkInfo, R as ResolvedAeoConfig, A as AeoConfig, P as PageEntry } from './types-Cn_Qbkmg.js';
+export { a as AIIndexEntry, b as AeoManifest, D as DocEntry, c as FrameworkType, M as ManifestEntry, d as MarkdownFile } from './types-Cn_Qbkmg.js';
+
+declare function detectFramework(projectRoot?: string): FrameworkInfo;
+
+interface GenerateResult {
+    files: string[];
+    errors: string[];
+}
+declare function generateAEOFiles(configOrRoot?: ResolvedAeoConfig | AeoConfig | string, maybeConfig?: Partial<AeoConfig>): Promise<GenerateResult>;
+
+declare function validateConfig(config: AeoConfig): string[];
+declare function resolveConfig(config?: AeoConfig): ResolvedAeoConfig;
+
+interface SchemaOutput {
+    site: object[];
+    pages: Record<string, object[]>;
+}
+/**
+ * Generate JSON-LD structured data for the entire site.
+ * Returns site-level schemas (WebSite, Organization) and per-page schemas.
+ */
+declare function generateSchema(config: ResolvedAeoConfig): string;
+/**
+ * Generate schema objects without serialization (for injection into HTML).
+ */
+declare function generateSchemaObjects(config: ResolvedAeoConfig): SchemaOutput;
+/**
+ * Generate per-page schemas based on page content and config defaults.
+ */
+declare function generatePageSchemas(page: PageEntry, config: ResolvedAeoConfig): object[];
+/**
+ * Generate a JSON-LD script tag string for injection into HTML.
+ */
+declare function generateJsonLdScript(schemas: object[]): string;
+
+/**
+ * Shared HTML-to-markdown extraction utilities.
+ * Used by all framework plugins for content extraction from build output.
+ */
+/**
+ * Extract text content from HTML and convert to markdown.
+ * Removes scripts, styles, SVGs, and boilerplate (nav, header, footer).
+ * Prefers <main> content when available.
+ */
+declare function extractTextFromHtml(html: string): string;
+/**
+ * Extract title from HTML <title> tag. Splits on | and takes the first part.
+ */
+declare function extractTitle(html: string): string | undefined;
+/**
+ * Extract description from HTML <meta name="description"> tag.
+ */
+declare function extractDescription(html: string): string | undefined;
+/**
+ * Extract existing JSON-LD structured data from HTML.
+ */
+declare function extractJsonLd(html: string): object[];
+/**
+ * Convert HTML page to a complete markdown document with YAML frontmatter.
+ */
+declare function htmlToMarkdown(html: string, pagePath: string, config: {
+    url: string;
+}): string;
+
+interface MetaTag {
+    property?: string;
+    name?: string;
+    content: string;
+}
+/**
+ * Generate Open Graph and Twitter Card meta tags for a page.
+ */
+declare function generateOGTags(page: PageEntry, config: ResolvedAeoConfig): MetaTag[];
+/**
+ * Generate meta tag HTML strings for injection.
+ */
+declare function generateOGTagsHtml(page: PageEntry, config: ResolvedAeoConfig): string;
+
+interface AuditIssue {
+    category: string;
+    severity: 'error' | 'warning' | 'info';
+    message: string;
+    fix?: string;
+}
+interface AuditCategory {
+    name: string;
+    score: number;
+    maxScore: number;
+    checks: {
+        label: string;
+        passed: boolean;
+        points: number;
+    }[];
+}
+interface AuditResult {
+    score: number;
+    categories: AuditCategory[];
+    issues: AuditIssue[];
+    suggestions: string[];
+}
+/**
+ * Audit a site's GEO readiness based on config and generated files.
+ * Returns a 0-100 score across 5 categories (20 points each).
+ */
+declare function auditSite(config: ResolvedAeoConfig): AuditResult;
+/**
+ * Format audit result as a human-readable report string.
+ */
+declare function formatAuditReport(result: AuditResult): string;
+
+interface CitabilityDimension {
+    name: string;
+    score: number;
+    maxScore: number;
+    details: string;
+}
+interface ContentHint {
+    type: 'error' | 'warning' | 'suggestion';
+    message: string;
+    line?: number;
+}
+interface PageCitabilityResult {
+    pathname: string;
+    score: number;
+    dimensions: CitabilityDimension[];
+    hints: ContentHint[];
+}
+interface SiteCitabilityResult {
+    averageScore: number;
+    pages: PageCitabilityResult[];
+}
+/**
+ * Score a single page's AI citability (0-100).
+ * Four dimensions, 25 points each:
+ * 1. Answer Blocks — direct, self-contained answers
+ * 2. Self-Containment — paragraphs make sense without context
+ * 3. Statistical Density — numbers, facts, named entities
+ * 4. Structure Quality — heading hierarchy, lists, summaries
+ */
+declare function scorePageCitability(page: PageEntry): PageCitabilityResult;
+/**
+ * Score all pages in a site config.
+ */
+declare function scoreSiteCitability(config: ResolvedAeoConfig): SiteCitabilityResult;
+/**
+ * Format a page citability result as a human-readable string.
+ */
+declare function formatPageCitability(result: PageCitabilityResult): string;
+
+interface PlatformHint {
+    platform: string;
+    status: 'good' | 'needs-work' | 'critical';
+    tips: string[];
+}
+/**
+ * Generate platform-specific optimization hints based on audit and citability results.
+ * These are static recommendations — no live API calls.
+ */
+declare function generatePlatformHints(audit: AuditResult, citability?: {
+    averageScore: number;
+}): PlatformHint[];
+
+interface AeoReport {
+    generatedAt: string;
+    site: {
+        title: string;
+        url: string;
+        pageCount: number;
+    };
+    audit: AuditResult;
+    citability: SiteCitabilityResult;
+    platformHints: PlatformHint[];
+}
+/**
+ * Generate a comprehensive AEO/GEO report for a site.
+ */
+declare function generateReport(config: ResolvedAeoConfig): AeoReport;
+/**
+ * Format the report as markdown.
+ */
+declare function formatReportMarkdown(report: AeoReport): string;
+/**
+ * Format the report as JSON string.
+ */
+declare function formatReportJson(report: AeoReport): string;
+
+declare const VERSION = "0.0.3";
+declare function defineConfig(config: AeoConfig): AeoConfig;
+
+export { AeoConfig, type AeoReport, type AuditCategory, type AuditIssue, type AuditResult, type CitabilityDimension, type ContentHint, FrameworkInfo, type MetaTag, type PageCitabilityResult, PageEntry, type PlatformHint, ResolvedAeoConfig, type SiteCitabilityResult, VERSION, auditSite, defineConfig, detectFramework, extractDescription, extractJsonLd, extractTextFromHtml, extractTitle, formatAuditReport, formatPageCitability, formatReportJson, formatReportMarkdown, generateAEOFiles, generateAEOFiles as generateAll, generateJsonLdScript, generateOGTags, generateOGTagsHtml, generatePageSchemas, generatePlatformHints, generateReport, generateSchema, generateSchemaObjects, htmlToMarkdown, resolveConfig, scorePageCitability, scoreSiteCitability, validateConfig };