@djangocfg/seo 2.1.50

package/dist/index.d.ts

@@ -0,0 +1,285 @@
+import { GoogleConsoleClient } from './google-console/index.js';
+export { analyzeInspectionResults, createAuthClient, verifyAuth } from './google-console/index.js';
+import { SeoModuleConfig, SeoReport, SeoIssue, UrlInspectionResult, CrawlResult } from './types/index.js';
+export { CoverageState, CrawlerConfig, GoogleConsoleConfig, IndexingState, IndexingVerdict, IssueCategory, IssueSeverity, PageFetchState, Recommendation, ReportSummary, RobotsTxtState } from './types/index.js';
+export { SiteCrawler, analyzeAllSitemaps, analyzeCrawlResults, analyzeRobotsTxt, analyzeSitemap, isUrlAllowed } from './crawler/index.js';
+export { CheckLinksOptions, CheckLinksResult, checkLinks, linkResultsToSeoIssues } from './link-checker/index.js';
+export { A as AI_REPORT_SCHEMA, c as generateAiSummary, g as generateAndSaveReports, a as generateJsonReport, b as generateMarkdownReport, m as mergeReports, p as printReportSummary } from './markdown-report-B3QdDzxE.js';
+export { R as RouteInfo, a as ScanOptions, S as ScanResult, f as findAppDir, g as getStaticUrls, r as routeToUrl, s as scanRoutes } from './scanner-Cz4Th2Pt.js';
+import '@googleapis/searchconsole';
+import 'google-auth-library';
+
+/**
+ * @djangocfg/seo - Main Analyzer
+ * High-level SEO analysis orchestrator
+ */
+
+interface AnalyzeOptions {
+    includeGoogleConsole?: boolean;
+    includeCrawler?: boolean;
+    includeRobotsTxt?: boolean;
+    includeSitemap?: boolean;
+    crawlerMaxPages?: number;
+    crawlerMaxDepth?: number;
+    urlsToInspect?: string[];
+}
+interface AnalyzeResult {
+    report: SeoReport;
+    issues: SeoIssue[];
+    urlInspections: UrlInspectionResult[];
+    crawlResults: CrawlResult[];
+}
+/**
+ * Main SEO Analyzer class
+ * Combines all modules for comprehensive SEO analysis
+ */
+declare class SeoAnalyzer {
+    private config;
+    private siteUrl;
+    private gscClient?;
+    constructor(config: SeoModuleConfig & {
+        siteUrl: string;
+    });
+    /**
+     * Run full SEO analysis
+     */
+    analyze(options?: AnalyzeOptions): Promise<AnalyzeResult>;
+    /**
+     * Save report to files
+     */
+    saveReport(outputDir?: string): Promise<void>;
+    /**
+     * Quick health check
+     */
+    healthCheck(): Promise<{
+        healthScore: number;
+        criticalIssues: number;
+        errors: number;
+        warnings: number;
+    }>;
+    /**
+     * Inspect specific URLs
+     */
+    inspectUrls(urls: string[]): Promise<UrlInspectionResult[]>;
+    /**
+     * Get Google Console client
+     */
+    getGoogleConsoleClient(): GoogleConsoleClient | undefined;
+}
+
+/**
+ * @djangocfg/seo - Utilities
+ * Shared utility functions
+ */
+/**
+ * Load URLs from a file (one URL per line)
+ */
+declare function loadUrlsFromFile(filePath: string): string[];
+/**
+ * Normalize URL for comparison
+ */
+declare function normalizeUrl(url: string, baseUrl?: string): string;
+/**
+ * Check if URL belongs to the same domain
+ */
+declare function isSameDomain(url: string, baseUrl: string): boolean;
+/**
+ * Format bytes to human readable string
+ */
+declare function formatBytes(bytes: number): string;
+/**
+ * Format milliseconds to human readable string
+ */
+declare function formatDuration(ms: number): string;
+/**
+ * Chunk array into smaller arrays
+ */
+declare function chunk<T>(array: T[], size: number): T[][];
+/**
+ * Sleep for a given number of milliseconds
+ */
+declare function sleep(ms: number): Promise<void>;
+/**
+ * Retry a function with exponential backoff
+ */
+declare function retry<T>(fn: () => Promise<T>, options?: {
+    retries?: number;
+    minTimeout?: number;
+    maxTimeout?: number;
+    factor?: number;
+}): Promise<T>;
+
+/**
+ * Content module types for MDX/Nextra projects
+ */
+interface ContentConfig {
+    /** Content directory path (default: 'content') */
+    contentDir: string;
+    /** App directory path (default: 'app') */
+    appDir: string;
+    /** Base URL path for docs (default: '/docs') */
+    basePath: string;
+    /** File extensions to scan (default: ['.mdx', '.md']) */
+    extensions: string[];
+    /** Asset extensions to ignore in links */
+    assetExtensions: string[];
+}
+interface SitemapConfig {
+    /** Output file path (default: 'app/_core/sitemap.ts') */
+    output: string;
+    /** Include app pages in sitemap */
+    includeApp: boolean;
+    /** Include content pages in sitemap */
+    includeContent: boolean;
+}
+interface SitemapItem {
+    title: string;
+    path: string;
+    children?: SitemapItem[];
+}
+interface SitemapData {
+    app: SitemapItem[];
+    docs: SitemapItem[];
+}
+type LinkType = 'absolute' | 'dotslash' | 'parent' | 'simple';
+interface BrokenLink {
+    /** File containing the broken link */
+    file: string;
+    /** Full link path (e.g., /docs/path) */
+    link: string;
+    /** Link type */
+    type: LinkType;
+    /** Raw link text */
+    raw: string;
+    /** Line number */
+    line: number;
+}
+interface LinkCheckResult {
+    /** Total files checked */
+    filesChecked: number;
+    /** Unique links checked */
+    uniqueLinks: number;
+    /** Broken links found */
+    brokenLinks: BrokenLink[];
+    /** All links are valid */
+    success: boolean;
+}
+interface LinkFix {
+    /** Original link */
+    from: string;
+    /** Replacement link */
+    to: string;
+    /** Line number */
+    line: number;
+}
+interface LinkFixResult {
+    /** File path */
+    file: string;
+    /** Full path to file */
+    fullPath: string;
+    /** Fixes applied/suggested */
+    fixes: LinkFix[];
+}
+interface FixLinksResult {
+    /** Total changes made/suggested */
+    totalChanges: number;
+    /** Files with changes */
+    fileChanges: LinkFixResult[];
+    /** Whether fixes were applied */
+    applied: boolean;
+}
+interface ContentScanResult {
+    /** Project type detected */
+    projectType: 'nextra' | 'nextjs' | 'unknown';
+    /** Content directory found */
+    hasContent: boolean;
+    /** App directory found */
+    hasApp: boolean;
+    /** MDX files found */
+    mdxFiles: string[];
+    /** Page files found in app/ */
+    pageFiles: string[];
+}
+
+/**
+ * Content scanner for MDX/Nextra projects
+ * Scans content/ and app/ directories for files
+ */
+
+/**
+ * Detect project type based on directory structure
+ */
+declare function detectProjectType(cwd: string): 'nextra' | 'nextjs' | 'unknown';
+/**
+ * Scan project and return content information
+ */
+declare function scanProject(cwd: string, config?: Partial<ContentConfig>): ContentScanResult;
+
+/**
+ * Link checker for MDX documentation
+ * Checks all internal links in content/ folder and verifies pages exist
+ * Properly handles Nextra's routing behavior for relative links
+ */
+
+/**
+ * Check all links in content directory
+ */
+declare function checkContentLinks(contentDir: string, config?: Partial<ContentConfig>): LinkCheckResult;
+/**
+ * Group broken links by file for display
+ */
+declare function groupBrokenLinksByFile(brokenLinks: BrokenLink[]): Map<string, BrokenLink[]>;
+
+/**
+ * Link fixer for MDX documentation
+ * Converts absolute /docs/ links to relative when appropriate
+ *
+ * Nextra routing rules:
+ * - index.mdx at /foo/ -> ./bar resolves to /foo/bar ✓
+ * - page.mdx at /foo/page -> ./bar resolves to /foo/page/bar ✗ (browser behavior)
+ *
+ * So for non-index files linking to siblings, we need ../sibling
+ */
+
+/**
+ * Fix absolute links to relative in content directory
+ */
+declare function fixContentLinks(contentDir: string, options?: {
+    apply?: boolean;
+    config?: Partial<ContentConfig>;
+}): FixLinksResult;
+
+/**
+ * Universal Sitemap Generator for Next.js App Router projects
+ * Supports both Nextra (MDX content) and standard Next.js projects
+ */
+
+/**
+ * Generate sitemap data from project
+ * Auto-detects project type (Nextra vs standard Next.js)
+ */
+declare function generateSitemapData(cwd: string, config?: Partial<ContentConfig>): Promise<SitemapData>;
+/**
+ * Generate and save sitemap file
+ */
+declare function generateSitemap(cwd: string, options?: {
+    output?: string;
+    config?: Partial<ContentConfig>;
+}): Promise<{
+    outputPath: string;
+    data: SitemapData;
+}>;
+/**
+ * Flatten sitemap items to list of paths
+ */
+declare function flattenSitemap(items: SitemapItem[]): string[];
+/**
+ * Count total items in sitemap
+ */
+declare function countSitemapItems(data: SitemapData): {
+    app: number;
+    docs: number;
+    total: number;
+};
+
+export { type BrokenLink, type ContentConfig, type ContentScanResult, CrawlResult, type FixLinksResult, GoogleConsoleClient, type LinkCheckResult, SeoAnalyzer, SeoIssue, SeoModuleConfig, SeoReport, type SitemapConfig, type SitemapData, type SitemapItem, UrlInspectionResult, checkContentLinks, chunk, countSitemapItems, detectProjectType, fixContentLinks, flattenSitemap, formatBytes, formatDuration, generateSitemap, generateSitemapData, groupBrokenLinksByFile, isSameDomain, loadUrlsFromFile, normalizeUrl, retry, scanProject, sleep };