@fulldotdev/scan 0.1.0

package/dist/engine/site.d.ts

@@ -0,0 +1,186 @@
+import { XMLParser } from "fast-xml-parser";
+import { HttpClient } from "./network.js";
+import { type JobResult, type Scan } from "./types.js";
+export declare const xmlParser: XMLParser;
+export declare function parseSitemap(body: string): {
+    valid: boolean;
+    error: string;
+    urls: never[];
+    sitemaps: never[];
+} | {
+    error?: undefined;
+    valid: boolean;
+    urls: {
+        url: string;
+        lastmod: any;
+        priority: any;
+        changefreq: any;
+    }[];
+    sitemaps: string[];
+};
+export declare const botPurposes: Record<string, string[]>;
+export declare function crawlerPolicy(robots: Awaited<ReturnType<HttpClient["getRobots"]>>, url: string): {
+    robotsUrl: string;
+    robotsOutcome: "blocked" | "error" | "http-error" | "inconclusive" | "ok";
+    bots: {
+        bot: string;
+        purpose: string;
+        allowed: boolean | null;
+    }[];
+    interpretation: string;
+};
+export declare function collectSitemap(scan: Scan, url: string, http: HttpClient): Promise<JobResult>;
+export declare function dnsSnapshot(host: string): Promise<{
+    host: string;
+    domain: string;
+    records: any;
+    email: {
+        spf: string[];
+        dmarc: string[];
+        mtaSts: string[];
+        bimi: string[];
+        scope: string;
+    };
+}>;
+export declare function tlsSnapshot(host: string): Promise<unknown>;
+export declare function discover(scan: Scan, http: HttpClient): Promise<JobResult>;
+export declare function domainSnapshot(domain: string): Promise<{
+    status: string;
+    domain: string;
+    error: string;
+    expiresAt?: undefined;
+    daysRemaining?: undefined;
+    registrar?: undefined;
+    statuses?: undefined;
+    source?: undefined;
+} | {
+    error?: undefined;
+    status: string;
+    domain: string;
+    expiresAt: any;
+    daysRemaining: number | null;
+    registrar: any;
+    statuses: any;
+    source: string;
+}>;
+export declare function fieldData(target: {
+    origin: string;
+} | {
+    url: string;
+}): Promise<{
+    source?: undefined;
+    available: boolean;
+    level: string;
+    note: string;
+    lcp?: undefined;
+    inp?: undefined;
+    cls?: undefined;
+    period?: undefined;
+} | {
+    note?: undefined;
+    available: boolean;
+    level: string;
+    lcp: number | null;
+    inp: number | null;
+    cls: number | null;
+    period: {
+        from: string | null;
+        to: string | null;
+    };
+    source: string;
+} | null>;
+export declare function safeBrowsing(url: string): Promise<{
+    status: string;
+    error: string;
+    flagged?: undefined;
+    threats?: undefined;
+} | {
+    error?: undefined;
+    status: string;
+    flagged: boolean;
+    threats: string[];
+} | null>;
+export declare function fieldHistory(origin: string): Promise<{
+    note?: undefined;
+    available: boolean;
+    points?: undefined;
+} | {
+    available: boolean;
+    note: string;
+    points?: undefined;
+} | {
+    note?: undefined;
+    available: boolean;
+    points: any;
+} | null>;
+export declare function sslLabs(host: string): Promise<{
+    source?: undefined;
+    note?: undefined;
+    status: string;
+    error: string;
+    grade?: undefined;
+    hasWarnings?: undefined;
+    endpoints?: undefined;
+    testedAt?: undefined;
+} | {
+    error?: undefined;
+    source?: undefined;
+    status: string;
+    note: any;
+    grade?: undefined;
+    hasWarnings?: undefined;
+    endpoints?: undefined;
+    testedAt?: undefined;
+} | {
+    error?: undefined;
+    note?: undefined;
+    status: string;
+    grade: any;
+    hasWarnings: boolean;
+    endpoints: number;
+    testedAt: string | null;
+    source: string;
+}>;
+export declare function hstsPreload(domain: string): Promise<{
+    status: string;
+    error: string;
+    preload?: undefined;
+} | {
+    error?: undefined;
+    status: string;
+    preload: any;
+}>;
+export declare function certificateLogs(domain: string): Promise<{
+    source?: undefined;
+    status: string;
+    error: string;
+    hostnames?: undefined;
+    issuers?: undefined;
+    issuedLast30Days?: undefined;
+} | {
+    error?: undefined;
+    status: string;
+    hostnames: string[];
+    issuers: string[];
+    issuedLast30Days: number;
+    source: string;
+}>;
+export declare function blocklists(domain: string, _address: string | null): Promise<{
+    status: string;
+    results: ({
+        list: string;
+        status: string;
+        note: string;
+        answers?: undefined;
+    } | {
+        note?: undefined;
+        list: string;
+        status: string;
+        answers: string[];
+    } | {
+        note?: undefined;
+        answers?: undefined;
+        list: string;
+        status: string;
+    })[];
+}>;