@knownagents/sdk 1.10.0 → 2.0.0

package/dist/headers.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFilteredHeaders = getFilteredHeaders;
+exports.getIsMCPCall = getIsMCPCall;
+exports.getIsUCPCall = getIsUCPCall;
+exports.getIsProbablyACPCall = getIsProbablyACPCall;
+const filteredHeaderNames = [
+    "authorization",
+    "proxy-authorization",
+    "cookie",
+    "set-cookie",
+    "x-api-key",
+    "api-key",
+    "apikey",
+    "x-auth-token",
+    "x-access-token",
+    "x-id-token",
+    "x-refresh-token",
+    "x-session-token",
+    "session-token",
+    "csrf-token",
+    "x-csrf-token",
+    "xsrf-token",
+    "x-xsrf-token",
+    "x-amz-security-token",
+    "x-goog-api-key",
+    "x-client-secret",
+    "client-secret",
+    "private-token"
+];
+function getFilteredHeaders(headers) {
+    const filteredHeaders = { ...headers };
+    Object.keys(filteredHeaders).forEach((key) => {
+        if (filteredHeaderNames.includes(key.toLowerCase())) {
+            delete filteredHeaders[key];
+        }
+    });
+    return filteredHeaders;
+}
+function getIsMCPCall(headers) {
+    return Object.keys(headers).some((key) => {
+        return key.toLowerCase() === "mcp-protocol-version";
+    });
+}
+function getIsUCPCall(headers) {
+    return Object.keys(headers).some((key) => {
+        return key.toLowerCase() === "ucp-agent";
+    });
+}
+function getIsProbablyACPCall(headers) {
+    return Object.keys(headers).some((key) => {
+        return key.toLowerCase() === "api-version";
+    });
+}

package/dist/index.d.ts

@@ -1,154 +1,3 @@
-import { IncomingMessage, ServerResponse } from "http";
-/**
- * A framework-agnostic HTTP request interface.
- * Used as a convenience type for single-request methods.
- */
-export interface Request {
-    /** The URL path and query string (e.g. "/about?foo=bar") */
-    path: string;
-    /** The HTTP method (e.g. "GET", "POST") */
-    method: string;
-    /** The HTTP request headers */
-    headers: Record<string, string | string[] | undefined>;
-}
-/**
- * A minimal HTTP response interface.
- * Used as a convenience type for single-request methods.
- */
-export interface Response {
-    /** The HTTP response status code (e.g. 200, 404) */
-    statusCode: number;
-}
-/**
- * A visit tracking request for the Known Agents API.
- * Used for batch visit tracking with `trackVisits()`.
- */
-export interface VisitRequest {
-    /** The URL path of the request (e.g. "/about?foo=bar") */
-    request_path: string;
-    /** The HTTP method (e.g. "GET", "POST") */
-    request_method: string;
-    /** The HTTP request headers */
-    request_headers: Record<string, string | string[] | undefined>;
-    /** The HTTP response status code (e.g. 200, 404) */
-    response_status_code?: number;
-    /** The HTTP response headers */
-    response_headers?: Record<string, string | string[] | undefined>;
-    /** The response duration in milliseconds */
-    response_duration_in_milliseconds?: number;
-    /** The timestamp when the visit occurred (ISO 8601 format) */
-    created?: string;
-}
-/**
- * An agent identification request for the Known Agents API.
- * Used for batch agent identification with `identifyAgents()`.
- */
-export interface IdentificationRequest {
-    /** An identifier that will be echoed back in the response to match requests with results */
-    id?: string;
-    /** The HTTP request headers */
-    request_headers: Record<string, string | string[] | undefined>;
-}
-/**
- * The result of an agent identification request.
- */
-export interface IdentificationResult {
-    /** The identifier from the request (if provided) */
-    id?: string;
-    /**
-     * The identification result:
-     * - "verified": The agent was identified and verified
-     * - "verification_failed": The agent was identified but failed verification (spoofed)
-     * - "unknown_agent": The request is from an unrecognized agent or human
-     * - "not_verifiable": The agent was identified but cannot be verified
-     */
-    result: "verified" | "verification_failed" | "unknown_agent" | "not_verifiable";
-    /** The unique ID of the identified agent */
-    agent_id?: string;
-    /** The name of the identified agent (e.g. "Googlebot") */
-    agent_token?: string;
-    /** The documentation URL for the identified agent */
-    agent_url?: string;
-    /** The type of the identified agent (e.g. "AI Agent", "Search Engine Crawler") */
-    agent_type_name?: string;
-    /** The company behind the identified agent (e.g. "Google") */
-    operator_name?: string;
-}
-/**
- * Agent types that can be controlled with robots.txt rules.
- */
-export declare enum AgentType {
-    AIAgent = "AI Agent",
-    AIAssistant = "AI Assistant",
-    AICodingAgent = "AI Coding Agent",
-    AIDataProvider = "AI Data Provider",
-    AIDataScraper = "AI Data Scraper",
-    AISearchCrawler = "AI Search Crawler",
-    Archiver = "Archiver",
-    DeveloperHelper = "Developer Helper",
-    Fetcher = "Fetcher",
-    HeadlessAgent = "Headless Agent",
-    IntelligenceGatherer = "Intelligence Gatherer",
-    Scraper = "Scraper",
-    SEOCrawler = "SEO Crawler",
-    SearchEngineCrawler = "Search Engine Crawler",
-    SecurityScanner = "Security Scanner",
-    UndocumentedAIAgent = "Undocumented AI Agent"
-}
-export declare class KnownAgents {
-    private readonly accessToken;
-    /**
-     * Creates a new instance of the Known Agents client.
-     *
-     * @param accessToken - Your project's access token.
-     */
-    constructor(accessToken: string);
-    /**
-     * Tracks a single agent visit for analytics.
-     * This method is non-blocking and handles errors internally.
-     *
-     * @param request - The incoming HTTP request (Request or Node.js IncomingMessage).
-     * @param response - The outgoing HTTP response (optional).
-     * @param responseDurationInMilliseconds - The time taken to process the request in milliseconds (optional).
-     */
-    trackVisit(request: Request | IncomingMessage, response?: Response | ServerResponse, responseDurationInMilliseconds?: number): void;
-    /**
-     * Tracks multiple agent visits in a batch for analytics.
-     * This method is non-blocking and handles errors internally.
-     * Recommended for high-traffic websites - batch visits and send periodically (e.g. every 30 seconds).
-     *
-     * @param visits - An array of visit tracking requests.
-     */
-    trackVisits(visits: VisitRequest[]): void;
-    /**
-     * Generates a robots.txt file that disallows the specified agent types.
-     * The generated file stays up-to-date with all current and future agents in the specified categories.
-     * Cache and serve the result at your website's `/robots.txt` endpoint.
-     *
-     * @param agentTypes - An array of agent types to disallow.
-     * @param disallow - The path to disallow (default: "/" for all paths).
-     * @returns A promise that resolves to the generated robots.txt content as a string.
-     * @throws {Error} If the API call fails or returns a non-200 status.
-     */
-    generateRobotsTXT(agentTypes: AgentType[], disallow?: string): Promise<string>;
-    /**
-     * Identifies and verifies a single agent from an HTTP request.
-     * Uses Web Bot Auth (HTTP message signatures), IP matching, or other available methods.
-     *
-     * @param request - The incoming HTTP request (Request or Node.js IncomingMessage).
-     * @returns A promise that resolves to the identification result.
-     * @throws {Error} If the API call fails or returns a non-200 status.
-     */
-    identifyAgent(request: Request | IncomingMessage): Promise<IdentificationResult>;
-    /**
-     * Identifies and verifies multiple agents from HTTP requests in a batch.
-     * Uses Web Bot Auth (HTTP message signatures), IP matching, or other available methods.
-     *
-     * @param requests - An array of identification requests.
-     * @returns A promise that resolves to an array of identification results.
-     * @throws {Error} If the API call fails or returns a non-200 status.
-     */
-    identifyAgents(requests: IdentificationRequest[]): Promise<IdentificationResult[]>;
-    private filterHeaders;
-}
+export { KnownAgents } from "./KnownAgents";
+export { AgentType, type IdentificationRequest, type IdentificationResult, type RESTACPResponseBody, type RESTUCPResponseBody, type TrackPageviewOrRESTCallOptions, type VisitRequest } from "./types";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,MAAM,CAAA;AAEtD;;;GAGG;AACH,MAAM,WAAW,OAAO;IACpB,4DAA4D;IAC5D,IAAI,EAAE,MAAM,CAAA;IACZ,2CAA2C;IAC3C,MAAM,EAAE,MAAM,CAAA;IACd,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAA;CACzD;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACrB,oDAAoD;IACpD,UAAU,EAAE,MAAM,CAAA;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IACzB,0DAA0D;IAC1D,YAAY,EAAE,MAAM,CAAA;IACpB,2CAA2C;IAC3C,cAAc,EAAE,MAAM,CAAA;IACtB,+BAA+B;IAC/B,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAA;IAC9D,oDAAoD;IACpD,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAC7B,gCAAgC;IAChC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAA;IAChE,4CAA4C;IAC5C,iCAAiC,CAAC,EAAE,MAAM,CAAA;IAC1C,8DAA8D;IAC9D,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IAClC,4FAA4F;IAC5F,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,+BAA+B;IAC/B,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAA;CACjE;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC,oDAAoD;IACpD,EAAE,CAAC,EAAE,MAAM,CAAA;IACX;;;;;;OAMG;IACH,MAAM,EAAE,UAAU,GAAG,qBAAqB,GAAG,eAAe,GAAG,gBAAgB,CAAA;IAC/E,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,0DAA0D;IAC1D,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,qDAAqD;IACrD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,kFAAkF;IAClF,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,8DAA8D;IAC9D,aAAa,CAAC,EAAE,MAAM,CAAA;CACzB;AAED;;GAEG;AACH,oBAAY,SAAS;IACjB,OAAO,aAAa;IACpB,WAAW,iBAAiB;IAC5B,aAAa,oBAAoB;IACjC,cAAc,qBAAqB;IACnC,aAAa,oBAAoB;IACjC,eAAe,sBAAsB;IACrC,QAAQ,aAAa;IACrB,eAAe,qBAAqB;IACpC,OAAO,YAAY;IACnB,aAAa,mBAAmB;IAChC,oBAAoB,0BAA0B;IAC9C,OAAO,YAAY;IACnB,UAAU,gBAAgB;IAC1B,mBAAmB,0BAA0B;IAC7C,eAAe,qBAAqB;IACpC,mBAAmB,0BAA0B;CAChD;AAED,qBAAa,WAAW;IACpB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAQ;IAEpC;;;;OAIG;gBACS,WAAW,EAAE,MAAM;IAI/B;;;;;;;OAOG;IACH,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,eAAe,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,cAAc,EAAE,8BAA8B,CAAC,EAAE,MAAM,GAAG,IAAI;IAoBnI;;;;;;OAMG;IACH,WAAW,CAAC,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI;IAazC;;;;;;;;;OASG;IACG,iBAAiB,CAAC,UAAU,EAAE,SAAS,EAAE,EAAE,QAAQ,GAAE,MAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAoBzF;;;;;;;OAOG;IACG,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,eAAe,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAmBtF;;;;;;;OAOG;IACG,cAAc,CAAC,QAAQ,EAAE,qBAAqB,EAAE,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAmBxF,OAAO,CAAC,aAAa;CAcxB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EACH,SAAS,EACT,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,8BAA8B,EACnC,KAAK,YAAY,EACpB,MAAM,SAAS,CAAA"}

package/dist/index.js

@@ -1,173 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KnownAgents = exports.AgentType = void 0;
-/**
- * Agent types that can be controlled with robots.txt rules.
- */
-var AgentType;
-(function (AgentType) {
-    AgentType["AIAgent"] = "AI Agent";
-    AgentType["AIAssistant"] = "AI Assistant";
-    AgentType["AICodingAgent"] = "AI Coding Agent";
-    AgentType["AIDataProvider"] = "AI Data Provider";
-    AgentType["AIDataScraper"] = "AI Data Scraper";
-    AgentType["AISearchCrawler"] = "AI Search Crawler";
-    AgentType["Archiver"] = "Archiver";
-    AgentType["DeveloperHelper"] = "Developer Helper";
-    AgentType["Fetcher"] = "Fetcher";
-    AgentType["HeadlessAgent"] = "Headless Agent";
-    AgentType["IntelligenceGatherer"] = "Intelligence Gatherer";
-    AgentType["Scraper"] = "Scraper";
-    AgentType["SEOCrawler"] = "SEO Crawler";
-    AgentType["SearchEngineCrawler"] = "Search Engine Crawler";
-    AgentType["SecurityScanner"] = "Security Scanner";
-    AgentType["UndocumentedAIAgent"] = "Undocumented AI Agent";
-})(AgentType || (exports.AgentType = AgentType = {}));
-class KnownAgents {
-    /**
-     * Creates a new instance of the Known Agents client.
-     *
-     * @param accessToken - Your project's access token.
-     */
-    constructor(accessToken) {
-        this.accessToken = accessToken;
-    }
-    /**
-     * Tracks a single agent visit for analytics.
-     * This method is non-blocking and handles errors internally.
-     *
-     * @param request - The incoming HTTP request (Request or Node.js IncomingMessage).
-     * @param response - The outgoing HTTP response (optional).
-     * @param responseDurationInMilliseconds - The time taken to process the request in milliseconds (optional).
-     */
-    trackVisit(request, response, responseDurationInMilliseconds) {
-        fetch("https://api.knownagents.com/visits", {
-            method: "POST",
-            headers: {
-                "Authorization": `Bearer ${this.accessToken}`,
-                "Content-Type": "application/json"
-            },
-            body: JSON.stringify({
-                request_path: "path" in request ? request.path : request.url,
-                request_method: request.method,
-                request_headers: this.filterHeaders(request.headers),
-                response_status_code: response?.statusCode,
-                response_duration_in_milliseconds: responseDurationInMilliseconds,
-                created: new Date().toISOString()
-            })
-        }).catch(error => {
-            console.error(`Known Agents failed to track visit: ${error.message}`);
-        });
-    }
-    /**
-     * Tracks multiple agent visits in a batch for analytics.
-     * This method is non-blocking and handles errors internally.
-     * Recommended for high-traffic websites - batch visits and send periodically (e.g. every 30 seconds).
-     *
-     * @param visits - An array of visit tracking requests.
-     */
-    trackVisits(visits) {
-        fetch("https://api.knownagents.com/visits", {
-            method: "POST",
-            headers: {
-                "Authorization": `Bearer ${this.accessToken}`,
-                "Content-Type": "application/json"
-            },
-            body: JSON.stringify(visits)
-        }).catch(error => {
-            console.error(`Known Agents failed to track visits: ${error.message}`);
-        });
-    }
-    /**
-     * Generates a robots.txt file that disallows the specified agent types.
-     * The generated file stays up-to-date with all current and future agents in the specified categories.
-     * Cache and serve the result at your website's `/robots.txt` endpoint.
-     *
-     * @param agentTypes - An array of agent types to disallow.
-     * @param disallow - The path to disallow (default: "/" for all paths).
-     * @returns A promise that resolves to the generated robots.txt content as a string.
-     * @throws {Error} If the API call fails or returns a non-200 status.
-     */
-    async generateRobotsTXT(agentTypes, disallow = "/") {
-        const response = await fetch("https://api.knownagents.com/robots-txts", {
-            method: "POST",
-            headers: {
-                "Authorization": `Bearer ${this.accessToken}`,
-                "Content-Type": "application/json"
-            },
-            body: JSON.stringify({
-                agent_types: agentTypes,
-                disallow: disallow
-            })
-        });
-        if (response.ok) {
-            return await response.text();
-        }
-        else {
-            throw new Error(`Known Agents failed to generate robots.txt: ${response.status} ${response.statusText}`);
-        }
-    }
-    /**
-     * Identifies and verifies a single agent from an HTTP request.
-     * Uses Web Bot Auth (HTTP message signatures), IP matching, or other available methods.
-     *
-     * @param request - The incoming HTTP request (Request or Node.js IncomingMessage).
-     * @returns A promise that resolves to the identification result.
-     * @throws {Error} If the API call fails or returns a non-200 status.
-     */
-    async identifyAgent(request) {
-        const response = await fetch("https://api.knownagents.com/agent-identifications", {
-            method: "POST",
-            headers: {
-                "Authorization": `Bearer ${this.accessToken}`,
-                "Content-Type": "application/json"
-            },
-            body: JSON.stringify({
-                request_headers: this.filterHeaders(request.headers)
-            })
-        });
-        if (response.ok) {
-            return await response.json();
-        }
-        else {
-            throw new Error(`Known Agents failed to identify agent: ${response.status} ${response.statusText}`);
-        }
-    }
-    /**
-     * Identifies and verifies multiple agents from HTTP requests in a batch.
-     * Uses Web Bot Auth (HTTP message signatures), IP matching, or other available methods.
-     *
-     * @param requests - An array of identification requests.
-     * @returns A promise that resolves to an array of identification results.
-     * @throws {Error} If the API call fails or returns a non-200 status.
-     */
-    async identifyAgents(requests) {
-        const response = await fetch("https://api.knownagents.com/agent-identifications", {
-            method: "POST",
-            headers: {
-                "Authorization": `Bearer ${this.accessToken}`,
-                "Content-Type": "application/json"
-            },
-            body: JSON.stringify(requests)
-        });
-        if (response.ok) {
-            return await response.json();
-        }
-        else {
-            throw new Error(`Known Agents failed to identify agents: ${response.status} ${response.statusText}`);
-        }
-    }
-    // Helpers
-    filterHeaders(headers) {
-        const excludedHeaders = new Set([
-            "authorization",
-            "proxy-authorization",
-            "cookie",
-            "set-cookie"
-        ]);
-        return Object.fromEntries(Object.entries(headers).filter(([key]) => {
-            return !excludedHeaders.has(key.toLowerCase());
-        }));
-    }
-}
-exports.KnownAgents = KnownAgents;
+exports.AgentType = exports.KnownAgents = void 0;
+var KnownAgents_1 = require("./KnownAgents");
+Object.defineProperty(exports, "KnownAgents", { enumerable: true, get: function () { return KnownAgents_1.KnownAgents; } });
+var types_1 = require("./types");
+Object.defineProperty(exports, "AgentType", { enumerable: true, get: function () { return types_1.AgentType; } });

package/dist/paths.d.ts

@@ -0,0 +1,2 @@
+export declare function getIsPathExcluded(path: string): boolean;
+//# sourceMappingURL=paths.d.ts.map

package/dist/paths.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.d.ts","sourceRoot":"","sources":["../src/paths.ts"],"names":[],"mappings":"AAAA,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAuEvD"}

package/dist/paths.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getIsPathExcluded = getIsPathExcluded;
+function getIsPathExcluded(path) {
+    const pathWithoutQueryString = path.split(/[?#]/)[0];
+    const lowercasedPath = pathWithoutQueryString.toLowerCase();
+    const excludedPrefixes = [
+        "/_next/",
+        "/_nuxt/",
+        "/_astro/",
+        "/_app/",
+        "/__nextjs",
+        "/__vite_ping",
+        "/__webpack_hmr",
+        "/@vite/",
+        "/@fs/",
+        "/@id/",
+        "/@react-refresh",
+        "/node_modules/",
+        "/_vercel/",
+        "/sockjs-node/",
+        "/webpack-dev-server/",
+    ];
+    const excludedSuffixes = [
+        ".ico",
+        ".png",
+        ".jpg",
+        ".jpeg",
+        ".gif",
+        ".webp",
+        ".svg",
+        ".bmp",
+        ".tiff",
+        ".avif",
+        ".heic",
+        ".heif",
+        ".css",
+        ".js",
+        ".mjs",
+        ".ts",
+        ".jsx",
+        ".tsx",
+        ".map",
+        ".wasm",
+        ".woff",
+        ".woff2",
+        ".ttf",
+        ".otf",
+        ".eot",
+        ".mp3",
+        ".mp4",
+        ".webm",
+        ".wav",
+        ".ogg",
+        ".aac",
+        ".m4a",
+        ".flac",
+        ".mov",
+        ".avi",
+        ".flv",
+        ".m4v",
+        ".webmanifest",
+        ".pdf",
+        ".zip",
+        ".gz",
+    ];
+    return excludedPrefixes.some((excludedPrefix) => {
+        return lowercasedPath.startsWith(excludedPrefix.toLowerCase());
+    }) || excludedSuffixes.some((excludedSuffix) => {
+        return lowercasedPath.endsWith(excludedSuffix.toLowerCase());
+    });
+}

package/dist/types.d.ts

@@ -0,0 +1,133 @@
+import type { IncomingHttpHeaders, OutgoingHttpHeaders } from "http";
+/**
+ * ACP response details from a REST API call.
+ */
+export interface RESTACPResponseBody {
+    /** The response currency, usually an ISO 4217 code. */
+    currency?: string;
+    /** ACP totals returned by the REST endpoint. The "total" item is sent to Known Agents. */
+    totals?: {
+        type?: string;
+        amount?: number;
+    }[];
+}
+/**
+ * UCP response details from a REST API call.
+ */
+export interface RESTUCPResponseBody {
+    /** The response currency, usually an ISO 4217 code. */
+    currency?: string;
+    /** UCP totals returned by the REST endpoint. The "total" item is sent to Known Agents. */
+    totals?: {
+        type?: string;
+        amount?: number;
+    }[];
+}
+/**
+ * Additional metadata to include when tracking a pageview or REST API call.
+ */
+export interface TrackPageviewOrRESTCallOptions {
+    /** ACP response body from the REST endpoint. */
+    restACPResponseBody?: RESTACPResponseBody;
+    /** UCP response body from the REST endpoint. */
+    restUCPResponseBody?: RESTUCPResponseBody;
+}
+/**
+ * A normalized visit payload for the Known Agents API.
+ * Use this with `trackVisits()` when batching requests yourself.
+ */
+export interface VisitRequest {
+    /** The URL path and query string of the request (e.g. "/about?foo=bar") */
+    request_path: string;
+    /** The HTTP method (e.g. "GET", "POST") */
+    request_method: string;
+    /** The HTTP request headers. Sensitive headers are removed before sending. */
+    request_headers: IncomingHttpHeaders;
+    /** The HTTP response status code (e.g. 200, 404) */
+    response_status_code?: number;
+    /** The HTTP response headers. Sensitive headers are removed before sending. */
+    response_headers?: OutgoingHttpHeaders;
+    /** The response duration in milliseconds */
+    response_duration_in_milliseconds?: number;
+    /** The MCP JSON-RPC request method */
+    mcp_request_method?: string;
+    /** The MCP request tool name */
+    mcp_request_tool_name?: string;
+    /** The MCP request client name */
+    mcp_request_client_info_name?: string;
+    /** The MCP request client version */
+    mcp_request_client_info_version?: string;
+    /** Whether the MCP response result is an error */
+    mcp_response_result_is_error?: boolean;
+    /** The MCP response error code */
+    mcp_response_error_code?: number;
+    /** The MCP response error message */
+    mcp_response_error_message?: string;
+    /** The ACP response currency */
+    acp_response_currency?: string;
+    /** The ACP response "total" amount */
+    acp_response_total_amount?: number;
+    /** The UCP response currency */
+    ucp_response_currency?: string;
+    /** The UCP response "total" amount */
+    ucp_response_total_amount?: number;
+    /** The timestamp when the visit occurred (ISO 8601 format) */
+    created?: string;
+}
+/**
+ * An agent identification request for the Known Agents API.
+ * Used for batch agent identification with `identifyAgents()`.
+ */
+export interface IdentificationRequest {
+    /** An identifier that will be echoed back in the response to match requests with results */
+    id?: string;
+    /** The HTTP request headers. Sensitive headers are removed before sending. */
+    request_headers: IncomingHttpHeaders;
+}
+/**
+ * The result of an agent identification request.
+ */
+export interface IdentificationResult {
+    /** The identifier from the request (if provided) */
+    id?: string;
+    /**
+     * The identification result:
+     * - "verified": The agent was identified and verified
+     * - "verification_failed": The agent was identified but failed verification (spoofed)
+     * - "unknown_agent": The request is from an unrecognized agent or human
+     * - "not_verifiable": The agent was identified but cannot be verified
+     */
+    result: "verified" | "verification_failed" | "unknown_agent" | "not_verifiable";
+    /** The unique ID of the identified agent */
+    agent_id?: string;
+    /** The name of the identified agent (e.g. "Googlebot") */
+    agent_token?: string;
+    /** The documentation URL for the identified agent */
+    agent_url?: string;
+    /** The type of the identified agent (e.g. "AI Agent", "Search Engine Crawler") */
+    agent_type_name?: string;
+    /** The company behind the identified agent (e.g. "Google") */
+    operator_name?: string;
+}
+/**
+ * Agent types that can be controlled with robots.txt rules.
+ */
+export declare enum AgentType {
+    AIAgent = "AI Agent",
+    AIAssistant = "AI Assistant",
+    AICodingAgent = "AI Coding Agent",
+    AIDataProvider = "AI Data Provider",
+    AIDataScraper = "AI Data Scraper",
+    AISearchCrawler = "AI Search Crawler",
+    Archiver = "Archiver",
+    AutomatedAgent = "Automated Agent",
+    DeveloperHelper = "Developer Helper",
+    Fetcher = "Fetcher",
+    IntelligenceGatherer = "Intelligence Gatherer",
+    Scraper = "Scraper",
+    SEOCrawler = "SEO Crawler",
+    SearchEngineCrawler = "Search Engine Crawler",
+    SecurityScanner = "Security Scanner",
+    UndocumentedAIAgent = "Undocumented AI Agent"
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,MAAM,CAAA;AAEpE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC,uDAAuD;IACvD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,0FAA0F;IAC1F,MAAM,CAAC,EAAE;QACL,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,MAAM,CAAC,EAAE,MAAM,CAAA;KAClB,EAAE,CAAA;CACN;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC,uDAAuD;IACvD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,0FAA0F;IAC1F,MAAM,CAAC,EAAE;QACL,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,MAAM,CAAC,EAAE,MAAM,CAAA;KAClB,EAAE,CAAA;CACN;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC3C,gDAAgD;IAChD,mBAAmB,CAAC,EAAE,mBAAmB,CAAA;IACzC,gDAAgD;IAChD,mBAAmB,CAAC,EAAE,mBAAmB,CAAA;CAC5C;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IACzB,2EAA2E;IAC3E,YAAY,EAAE,MAAM,CAAA;IACpB,2CAA2C;IAC3C,cAAc,EAAE,MAAM,CAAA;IACtB,8EAA8E;IAC9E,eAAe,EAAE,mBAAmB,CAAA;IACpC,oDAAoD;IACpD,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAC7B,+EAA+E;IAC/E,gBAAgB,CAAC,EAAE,mBAAmB,CAAA;IACtC,4CAA4C;IAC5C,iCAAiC,CAAC,EAAE,MAAM,CAAA;IAC1C,sCAAsC;IACtC,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,gCAAgC;IAChC,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,kCAAkC;IAClC,4BAA4B,CAAC,EAAE,MAAM,CAAA;IACrC,qCAAqC;IACrC,+BAA+B,CAAC,EAAE,MAAM,CAAA;IACxC,kDAAkD;IAClD,4BAA4B,CAAC,EAAE,OAAO,CAAA;IACtC,kCAAkC;IAClC,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,qCAAqC;IACrC,0BAA0B,CAAC,EAAE,MAAM,CAAA;IACnC,gCAAgC;IAChC,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,sCAAsC;IACtC,yBAAyB,CAAC,EAAE,MAAM,CAAA;IAClC,gCAAgC;IAChC,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,sCAAsC;IACtC,yBAAyB,CAAC,EAAE,MAAM,CAAA;IAClC,8DAA8D;IAC9D,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IAClC,4FAA4F;IAC5F,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,8EAA8E;IAC9E,eAAe,EAAE,mBAAmB,CAAA;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC,oDAAoD;IACpD,EAAE,CAAC,EAAE,MAAM,CAAA;IACX;;;;;;OAMG;IACH,MAAM,EAAE,UAAU,GAAG,qBAAqB,GAAG,eAAe,GAAG,gBAAgB,CAAA;IAC/E,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,0DAA0D;IAC1D,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,qDAAqD;IACrD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,kFAAkF;IAClF,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,8DAA8D;IAC9D,aAAa,CAAC,EAAE,MAAM,CAAA;CACzB;AAED;;GAEG;AACH,oBAAY,SAAS;IACjB,OAAO,aAAa;IACpB,WAAW,iBAAiB;IAC5B,aAAa,oBAAoB;IACjC,cAAc,qBAAqB;IACnC,aAAa,oBAAoB;IACjC,eAAe,sBAAsB;IACrC,QAAQ,aAAa;IACrB,cAAc,oBAAoB;IAClC,eAAe,qBAAqB;IACpC,OAAO,YAAY;IACnB,oBAAoB,0BAA0B;IAC9C,OAAO,YAAY;IACnB,UAAU,gBAAgB;IAC1B,mBAAmB,0BAA0B;IAC7C,eAAe,qBAAqB;IACpC,mBAAmB,0BAA0B;CAChD"}

package/dist/types.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgentType = void 0;
+/**
+ * Agent types that can be controlled with robots.txt rules.
+ */
+var AgentType;
+(function (AgentType) {
+    AgentType["AIAgent"] = "AI Agent";
+    AgentType["AIAssistant"] = "AI Assistant";
+    AgentType["AICodingAgent"] = "AI Coding Agent";
+    AgentType["AIDataProvider"] = "AI Data Provider";
+    AgentType["AIDataScraper"] = "AI Data Scraper";
+    AgentType["AISearchCrawler"] = "AI Search Crawler";
+    AgentType["Archiver"] = "Archiver";
+    AgentType["AutomatedAgent"] = "Automated Agent";
+    AgentType["DeveloperHelper"] = "Developer Helper";
+    AgentType["Fetcher"] = "Fetcher";
+    AgentType["IntelligenceGatherer"] = "Intelligence Gatherer";
+    AgentType["Scraper"] = "Scraper";
+    AgentType["SEOCrawler"] = "SEO Crawler";
+    AgentType["SearchEngineCrawler"] = "Search Engine Crawler";
+    AgentType["SecurityScanner"] = "Security Scanner";
+    AgentType["UndocumentedAIAgent"] = "Undocumented AI Agent";
+})(AgentType || (exports.AgentType = AgentType = {}));