@rivi-software/agentic-seo-check 0.1.0 → 0.2.0

package/dist/core/audit.d.ts

@@ -1,7 +1,7 @@
-import { type ProgressEvent } from './crawl.js';
-import { type FetchOptions } from './fetch.js';
-import { type Audit, type IssueRollup, type PageAudit, type PageSource, type ResponseInfo, type SiteAudit, type Thresholds } from './types.js';
-export type { ProgressEvent } from './crawl.js';
+import type { ProgressEvent } from "./crawl.js";
+import type { FetchOptions } from "./fetch.js";
+import type { Audit, Finding, IssueRollup, PageAudit, PageSource, ResponseInfo, SiteAudit, Thresholds } from "./types.js";
+export type { ProgressEvent } from "./crawl.js";
 export interface AuditOptions {
     /** Target keyword/phrase for the keyword.* rules. */
     keyword?: string;
@@ -9,7 +9,7 @@ export interface AuditOptions {
     render?: boolean;
     /** Run Lighthouse (performance + SEO + agentic-browsing categories). */
     lighthouse?: boolean;
-    formFactor?: 'mobile' | 'desktop';
+    formFactor?: "mobile" | "desktop";
     /** Include info-level findings (default true). */
     includeInfo?: boolean;
     /** Rule ids to skip. */
@@ -32,7 +32,7 @@ export interface CrawlOptions extends AuditOptions {
     includePatterns?: string[];
     excludePatterns?: string[];
     /** How much per-page detail to keep in the site result. */
-    pageDetail?: 'full' | 'summary';
+    pageDetail?: "full" | "summary";
 }
 export interface HtmlAuditInput {
     url?: string;
@@ -48,25 +48,46 @@ export declare const DEFAULT_CRAWL: {
     readonly delayMs: 0;
     readonly maxLinkChecks: 200;
 };
+export declare const rollupIssues: (pages: Pick<PageAudit, "url" | "findings">[]) => IssueRollup[];
+export declare const recomputeSite: (site: SiteAudit) => void;
 /** Audit an HTML string. `url` is used to resolve links and for display. */
-export declare function auditHtml(html: string, input?: HtmlAuditInput, options?: AuditOptions): Promise<PageAudit>;
+export declare const auditHtml: (html: string, input?: HtmlAuditInput, options?: AuditOptions) => Promise<PageAudit>;
 /** Fetch and audit one URL. Optionally render and/or run Lighthouse. */
-export declare function auditUrl(url: string, options?: AuditOptions): Promise<PageAudit>;
+export declare const auditUrl: (url: string, options?: AuditOptions) => Promise<PageAudit>;
 /** Audit a single .html file from disk. */
-export declare function auditFile(filePath: string, options?: AuditOptions): Promise<PageAudit>;
+export declare const auditFile: (filePath: string, options?: AuditOptions) => Promise<PageAudit>;
 /** Crawl a site and audit every page plus site-level checks. */
-export declare function auditSite(startUrl: string, options?: CrawlOptions): Promise<SiteAudit>;
+export declare const auditSite: (startUrl: string, options?: CrawlOptions) => Promise<SiteAudit>;
 /** Audit a directory of built HTML files (dist/, out/, build/). */
-export declare function auditDirectory(dir: string, options?: CrawlOptions): Promise<SiteAudit>;
+export declare const auditDirectory: (dir: string, options?: CrawlOptions) => Promise<SiteAudit>;
+export type ResolvedTarget = {
+    kind: "stdin";
+} | {
+    kind: "url";
+    url: string;
+} | {
+    kind: "directory";
+    path: string;
+} | {
+    kind: "file";
+    path: string;
+};
+/**
+ * What a target names: "-" for stdin, an http(s) URL, a bare host such as `example.com/page` or
+ * `localhost:3000`, a directory or a file.
+ */
+export declare const resolveTarget: (target: string) => Promise<ResolvedTarget>;
+/** HTML piped to the process. */
+export declare const readStdin: () => Promise<string>;
 /**
  * Auto-detect the target type: http(s) URL, directory, .html file, or "-" for stdin.
  * `crawl` forces a site crawl for URLs.
  */
-export declare function auditTarget(target: string, options?: CrawlOptions & {
+export declare const auditTarget: (target: string, options?: CrawlOptions & {
     crawl?: boolean;
     stdinHtml?: string;
-}): Promise<Audit>;
-export declare function recomputeSite(site: SiteAudit): void;
-export declare function rollupIssues(pages: PageAudit[]): IssueRollup[];
+}) => Promise<Audit>;
+/** Keeps the first three items of every evidence list. */
+export declare const trimFinding: (f: Finding) => Finding;
 /** Drop bulky, low-value fields to save tokens when the result is consumed by an LLM. */
-export declare function compactAudit<T extends Audit>(audit: T): T;
+export declare const compactAudit: <T extends Audit>(audit: T) => T;