@knownagents/sdk 1.6.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,97 @@
+# Known Agents SDK
+
+[![NPM version](https://img.shields.io/npm/v/@knownagents/sdk.svg)](https://npmjs.org/package/@knownagents/sdk) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@knownagents/sdk)
+
+This library provides convenient access to [Known Agents](https://knownagents.com/) from server-side TypeScript or JavaScript.
+
+## Install the Package
+
+Download and include the package via NPM:
+
+```sh
+npm install @knownagents/sdk
+```
+
+## Initialize the Client
+
+[Sign up](https://knownagents.com/sign-up) for Known Agents, create a project, and copy your access token from the project's settings page. Then, create a new instance of `KnownAgents`.
+
+```ts
+import { KnownAgents } from "@knownagents/sdk"
+
+const knownAgents = new KnownAgents("YOUR_ACCESS_TOKEN")
+```
+
+## How To Set Up Agent & LLM Analytics ([Full Docs](https://knownagents.com/docs/analytics))
+
+Get realtime insight into the hidden ecosystem of [crawlers, scrapers, AI agents, and other bots](https://knownagents.com/agents) browsing your website. Measure human traffic coming from AI chat and search platforms like ChatGPT, Perplexity, and Gemini.
+
+To collect this data, call `trackVisit` for each incoming request in the endpoints where you serve your pages.
+
+```ts
+knownAgents.trackVisit(incomingRequest)
+```
+
+### Use Middleware if Possible
+
+If you can, add this in middleware to track incoming requests to all pages from a single place.
+
+Here's an example with Express, but you can apply this same technique with other frameworks:
+
+```ts
+import express from "express"
+import { KnownAgents } from "@knownagents/sdk"
+
+const app = express()
+const knownAgents = new KnownAgents("YOUR_ACCESS_TOKEN")
+
+app.use((req, res, next) => {
+    knownAgents.trackVisit(req)
+    next()
+})
+
+app.get("/", (req, res) => {
+    res.send("Hello, world!")
+})
+
+app.listen(3000, () => console.log("Server running on port 3000"))
+```
+
+### Test Your Integration
+
+- Open your project's settings page
+- Click **Send a Test Visit**
+- Click **Realtime**
+
+If your website is correctly connected, you should see visits from the Known Agent in the realtime timeline within a few seconds.
+
+## How To Set Up Automatic Robots.txt ([Full Docs](https://knownagents.com/docs/robots-txt))
+
+Protect sensitive content from unwanted access and scraping. Generate a continuously updating robots.txt that stays up to date with [all current and future bots](https://knownagents.com/agents) in the specified categories automatically.
+
+Use the `generateRobotsTxt` function. Select which `AgentType`s you want to block, and a string specifying which URLs are disallowed (e.g. `"/"` to disallow all paths).
+
+```ts
+const robotsTxt = await knownAgents.generateRobotsTxt([
+  AgentType.AIDataScraper,
+  AgentType.Scraper,
+  AgentType.IntelligenceGatherer,
+  AgentType.SEOCrawler
+  // ...
+], "/")
+
+```
+
+The return value is a plain text robots.txt string. Generate a `robotsTXT` periodically (e.g. once per day), then cache and serve it from your website's `/robots.txt` endpoint.
+
+## Requirements
+
+TypeScript >= 4.7 is supported.
+
+The following runtimes are supported:
+
+- Node.js 18 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
+
+## Support
+
+Please [open an issue](https://github.com/knownagents/node-sdk/issues) with questions, bugs, or suggestions.

package/dist/index.d.ts

@@ -0,0 +1,56 @@
+import { IncomingMessage } from "http";
+export interface Request {
+    /** The path of the request's URL (e.g. "/about") */
+    path: string;
+    /** The request's HTTP method (e.g. "GET", "POST") */
+    method: string;
+    /** The request's HTTP headers */
+    headers: Record<string, string | string[] | undefined>;
+}
+/**
+ * Agent types that can be controlled with robots.txt rules.
+ */
+export declare enum AgentType {
+    AIAgent = "AI Agent",
+    AIAssistant = "AI Assistant",
+    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 an agent visit in Known Agents agent analytics.
+     *
+     * @param visitRequest - The incoming visit request.
+     */
+    trackVisit(request: Request): void;
+    trackVisit(request: IncomingMessage): void;
+    /**
+     * Generates a `robots.txt` file that disallows the specified agent types.
+     * Cache and serve this string at your website’s `/robots.txt` endpoint.
+     *
+     * @param agentTypes - A list of agent types to include.
+     * @param disallow - A path to disallow (default is "/" for all paths).
+     * @returns The generated `robots.txt` as a string.
+     * @throws If the API call fails or returns a non-200 status.
+     */
+    generateRobotsTxt(agentTypes: AgentType[], disallow?: string): Promise<string>;
+    private filterHeaders;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,MAAM,CAAA;AAItC,MAAM,WAAW,OAAO;IACpB,oDAAoD;IACpD,IAAI,EAAE,MAAM,CAAA;IACZ,qDAAqD;IACrD,MAAM,EAAE,MAAM,CAAA;IACd,iCAAiC;IACjC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAA;CACzD;AAED;;GAEG;AACH,oBAAY,SAAS;IACjB,OAAO,aAAa;IACpB,WAAW,iBAAiB;IAC5B,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;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAClC,UAAU,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI;IAyB1C;;;;;;;;OAQG;IACG,iBAAiB,CAAC,UAAU,EAAE,SAAS,EAAE,EAAE,QAAQ,GAAE,MAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAuBzF,OAAO,CAAC,aAAa;CAcxB"}

package/dist/index.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KnownAgents = exports.AgentType = void 0;
+const NODE_PACKAGE_VERSION = "1.3.0";
+/**
+ * Agent types that can be controlled with robots.txt rules.
+ */
+var AgentType;
+(function (AgentType) {
+    AgentType["AIAgent"] = "AI Agent";
+    AgentType["AIAssistant"] = "AI Assistant";
+    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;
+    }
+    trackVisit(visitRequest) {
+        const request = "path" in visitRequest ? visitRequest : {
+            path: visitRequest.url ? new URL(visitRequest.url, "https://example.org/").pathname : "/",
+            method: visitRequest.method ?? "GET",
+            headers: visitRequest.headers
+        };
+        fetch("https://api.knownagents.com/visits", {
+            method: "POST",
+            headers: {
+                "Authorization": `Bearer ${this.accessToken}`,
+                "Content-Type": "application/json"
+            },
+            body: JSON.stringify({
+                request_path: request.path,
+                request_method: request.method,
+                request_headers: this.filterHeaders(request.headers),
+                node_package_version: NODE_PACKAGE_VERSION
+            })
+        }).catch(error => {
+            console.error(`Known Agents failed to track visit: ${error.message}`);
+        });
+    }
+    /**
+     * Generates a `robots.txt` file that disallows the specified agent types.
+     * Cache and serve this string at your website’s `/robots.txt` endpoint.
+     *
+     * @param agentTypes - A list of agent types to include.
+     * @param disallow - A path to disallow (default is "/" for all paths).
+     * @returns The generated `robots.txt` as a string.
+     * @throws 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,
+                node_package_version: NODE_PACKAGE_VERSION
+            })
+        });
+        if (response.ok) {
+            return await response.text();
+        }
+        else {
+            throw new Error(`Known Agents failed to generate robots.txt: ${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;

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@knownagents/sdk",
+  "version": "1.6.0",
+  "description": "The official Node.js SDK for Known Agents: AI agent analytics (bot traffic), LLM referral tracking, automatic robots.txt",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "ai analytics",
+    "bot traffic",
+    "agent analytics",
+    "ai agents",
+    "ai scrapers",
+    "ai crawlers",
+    "ai bots",
+    "robots.txt",
+    "automatic robots.txt",
+    "robots.txt generator",
+    "web scraping",
+    "ai blocking",
+    "bot blocking",
+    "block ai bots",
+    "express middleware"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prepublishOnly": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/knownagents/node-sdk.git"
+  },
+  "author": "Known Agents <contact@knownagents.com>",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/knownagents/node-sdk/issues"
+  },
+  "homepage": "https://github.com/knownagents/node-sdk#readme",
+  "engines": {
+    "node": ">=18"
+  },
+  "devDependencies": {
+    "@types/node": "^22.13.10",
+    "typescript": "^5.8.2"
+  }
+}

package/src/index.ts

@@ -0,0 +1,123 @@
+import { IncomingMessage } from "http"
+
+const NODE_PACKAGE_VERSION = "1.3.0"
+
+export interface Request {
+    /** The path of the request's URL (e.g. "/about") */
+    path: string
+    /** The request's HTTP method (e.g. "GET", "POST") */
+    method: string
+    /** The request's HTTP headers */
+    headers: Record<string, string | string[] | undefined>
+}
+
+/**
+ * Agent types that can be controlled with robots.txt rules.
+ */
+export enum AgentType {
+    AIAgent = "AI Agent",
+    AIAssistant = "AI Assistant",
+    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 class KnownAgents {
+    private readonly accessToken: string
+
+    /**
+     * Creates a new instance of the Known Agents client.
+     * 
+     * @param accessToken - Your project's access token.
+     */
+    constructor(accessToken: string) {
+        this.accessToken = accessToken
+    }
+
+    /**
+     * Tracks an agent visit in Known Agents agent analytics.
+     *
+     * @param visitRequest - The incoming visit request.
+     */
+    trackVisit(request: Request): void
+    trackVisit(request: IncomingMessage): void
+    trackVisit(visitRequest: Request | IncomingMessage): void {
+        const request: Request = "path" in visitRequest ? visitRequest : {
+            path: visitRequest.url ? new URL(visitRequest.url, "https://example.org/").pathname : "/",
+            method: visitRequest.method ?? "GET",
+            headers: visitRequest.headers
+        }
+
+        fetch("https://api.knownagents.com/visits", {
+            method: "POST",
+            headers: {
+                "Authorization": `Bearer ${this.accessToken}`,
+                "Content-Type": "application/json"
+            },
+            body: JSON.stringify({
+                request_path: request.path,
+                request_method: request.method,
+                request_headers: this.filterHeaders(request.headers),
+                node_package_version: NODE_PACKAGE_VERSION
+            })
+        }).catch(error => {
+            console.error(`Known Agents failed to track visit: ${error.message}`)
+        })
+    }
+
+    /**
+     * Generates a `robots.txt` file that disallows the specified agent types.
+     * Cache and serve this string at your website’s `/robots.txt` endpoint.
+     *
+     * @param agentTypes - A list of agent types to include.
+     * @param disallow - A path to disallow (default is "/" for all paths).
+     * @returns The generated `robots.txt` as a string.
+     * @throws If the API call fails or returns a non-200 status.
+     */
+    async generateRobotsTxt(agentTypes: AgentType[], disallow: string = "/"): Promise<string> {
+        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,
+                node_package_version: NODE_PACKAGE_VERSION
+            })
+        })
+
+        if (response.ok) {
+            return await response.text()
+        } else {
+            throw new Error(`Known Agents failed to generate robots.txt: ${response.status} ${response.statusText}`)
+        }
+    }
+
+    // Helpers
+
+    private filterHeaders(headers: Record<string, string | string[] | undefined>): Record<string, string | string[] | undefined> {
+        const excludedHeaders = new Set([
+            "authorization",
+            "proxy-authorization",
+            "cookie",
+            "set-cookie"
+        ])
+
+        return Object.fromEntries(
+            Object.entries(headers).filter(([key]) => {
+                return !excludedHeaders.has(key.toLowerCase())
+            })
+        )
+    }
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "include": ["src"],
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "CommonJS",
+    "outDir": "dist",
+    "declaration": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "moduleResolution": "node"
+  }
+}