@waniwani/relay 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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/NOTICE

@@ -0,0 +1,2 @@
+WaniWani Relay
+Copyright 2026 WaniWani

package/README.md

@@ -1,3 +1,170 @@
-# Temporary Holding Version
+# @waniwani/relay
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+`@waniwani/relay` records the visits of AI agents to your website and sends them to [WaniWani](https://waniwani.ai). It runs in the middleware of your site, the code that sees each request before your pages do. For each request from an AI agent, it posts one small event to WaniWani after the response has gone out. It never changes the request or the response, and a person who visits your site sends nothing.
+
+The code is Apache 2.0 licensed and short, so your security team can read all of it before you deploy.
+
+## Install
+
+```bash
+npm install @waniwani/relay
+```
+
+Copy the key from the WaniWani setup screen into the environment variable `WANIWANI_AGENT_TRAFFIC_KEY` of your production deployment. When the variable is not set, the library sends nothing, so preview deployments and local runs stay silent.
+
+## Vercel
+
+### Next.js
+
+Next.js 16 calls its middleware file `proxy.ts` (it was `middleware.ts` before). Add the two calls to that file:
+
+```ts
+// proxy.ts
+import { isAgent, recordAgentVisit } from "@waniwani/relay";
+
+export default function proxy(request: Request) {
+  if (isAgent(request)) {
+    recordAgentVisit(request);
+  }
+}
+
+export const config = {
+  matcher: ["/((?!api/|_next/|.*\\.[a-z0-9]{1,5}$).*)", "/robots.txt", "/llms.txt"],
+};
+```
+
+If you already have a proxy, put the `if` block at the top of your proxy function and leave the rest as it is. The matcher keeps `/api/`, `/_next/` and every path with a file extension out of the middleware, so scripts, images, fonts and API calls never run it. It lists `/robots.txt` and `/llms.txt` by name, because AI agents read them.
+
+### Other frameworks
+
+Point Vercel at the middleware file with the `proxy` property in `vercel.json` (the same key works in `vercel.ts`):
+
+```json
+{
+  "proxy": {
+    "entrypoint": "proxy.ts",
+    "matcher": ["/((?!api/|.*\\.[a-z0-9]{1,5}$).*)", "/robots.txt", "/llms.txt"]
+  }
+}
+```
+
+```ts
+// proxy.ts
+import { isAgent, recordAgentVisit } from "@waniwani/relay";
+
+export default function proxy(request: Request) {
+  if (isAgent(request)) {
+    recordAgentVisit(request);
+  }
+}
+```
+
+If your organization is in the EU region, pass the region. Its events then go only to the EU host:
+
+```ts
+recordAgentVisit(request, { region: "eu" });
+```
+
+The setup screen shows the code for your organization.
+
+## How a request is matched
+
+`isAgent(request)` reads a few request headers and the client IP. It makes no network call and keeps no state between requests. It returns `true` when any of these hold:
+
+- The `User-Agent` header contains a token from the AI bot list, for example `ChatGPT-User`, `Claude-User`, `GPTBot` or `PerplexityBot`. The list comes from the AI bots in the WaniWani bot catalog: crawlers that collect training data, AI search bots and fetchers that act for a user. Classic search indexers such as `Googlebot` and `Bingbot`, browsers, `curl` and uptime monitors are not on it.
+- The request has a `Signature-Agent` header ([Web Bot Auth](https://datatracker.ietf.org/wg/webbotauth/about/)).
+- The client IP sits inside an IP range that an AI vendor publishes for its bots. Today the ranges come from OpenAI, Perplexity, Mistral, Common Crawl and DuckDuckGo (DuckAssistBot).
+- The request has a `DPoP` header, or its `Authorization` header uses the `DPoP` scheme.
+
+## What is sent
+
+For each matched request, `recordAgentVisit` posts one JSON record to `<host>/api/v2/agent-traffic/ingest/middleware/<token>`:
+
+| Field | Value |
+| --- | --- |
+| `occurredAt` | The time of the request, ISO 8601 in UTC |
+| `method` | The HTTP method |
+| `host` | The hostname of the request URL, without the port |
+| `path` | The path with its query string |
+| `userAgent`, `referer` | Copies of those two headers |
+| `headers` | The allowed headers that the request has (see below) |
+| `matchKey` | `HMAC-SHA256(org key, client IP)` as hex. WaniWani uses it to join this event with other events of the same visit. |
+| `sourceEventId` | A random UUID for this request |
+| `relayVersion` | The version of this library |
+
+Only these headers can ever go into an event: `user-agent`, `referer`, `accept`, `accept-language`, `from`, `signature-agent`, `signature-input`, `signature`, `dpop`, `sec-ch-ua`, `sec-ch-ua-platform`, `sec-ch-ua-mobile` and `authorization`. For `authorization` the library sends the scheme word alone, in its standard spelling, and only when a credential follows it and the word is one of `Basic`, `Bearer`, `Digest`, `DPoP`, `HOBA`, `Mutual`, `Negotiate`, `NTLM`, `OAuth`, `PrivateToken`, `SCRAM-SHA-1`, `SCRAM-SHA-256`, `vapid` or `AWS4-HMAC-SHA256`. Any other value sends no `authorization` header at all, so a raw API key in that header never leaves your deployment.
+
+These never leave your deployment:
+
+- The `cookie` header. The library never reads it.
+- The credential in the `Authorization` header.
+- The raw client IP. The library turns it into the match key with your org key and never logs it. The org key is the part of `WANIWANI_AGENT_TRAFFIC_KEY` after the dot, so two organizations get unrelated match keys for the same IP.
+- The request body, other headers and your environment variables.
+
+### Sending less
+
+`omit` takes header names, plus the field names `matchKey`, `userAgent` and `referer`. Whatever it names is left out of every event:
+
+```ts
+recordAgentVisit(request, {
+  omit: ["accept-language", "matchKey"],
+});
+```
+
+An event without a match key still counts. WaniWani then joins it with the chat embed's events on site, user agent and path alone, which is less exact.
+
+## When WaniWani is slow or down
+
+Your site does not notice. The post runs after the response, inside the `waitUntil` of your platform, with a 2 second timeout. After a network error, a timeout, a 429 or a 5xx it tries once more after 500 ms. Any other 4xx gets no retry. If the second try fails as well, the library writes one line to your function logs and drops the event. It never throws.
+
+## Dependencies
+
+The package has no runtime dependencies. The IP range check uses `BlockList` from `node:net`. On Vercel it finds `waitUntil` by itself, in the request context that the Vercel runtime sets for each request. On other platforms you pass `waitUntil` in the options. The bot list, the IP ranges and the match code ship inside the package, and the library never downloads code. To get a newer bot list, upgrade the package.
+
+## Cloudflare Workers and other platforms
+
+The library imports `node:net` for its IP range check, so a Cloudflare Worker needs the `nodejs_compat` flag. Workers with a compatibility date of 2026-08-04 or later have it on by default.
+
+Outside Vercel, pass the key and `waitUntil` yourself. In a Cloudflare Worker that looks like this:
+
+```ts
+import { isAgent, recordAgentVisit, type RelayOptions } from "@waniwani/relay";
+
+export default {
+  async fetch(request: Request, env: { WANIWANI_AGENT_TRAFFIC_KEY: string }, ctx: ExecutionContext) {
+    const relay: RelayOptions = {
+      key: env.WANIWANI_AGENT_TRAFFIC_KEY,
+      waitUntil: ctx.waitUntil.bind(ctx),
+    };
+    if (isAgent(request)) {
+      recordAgentVisit(request, relay);
+    }
+    return fetch(request);
+  },
+};
+```
+
+## Options
+
+| Option | Default | Purpose |
+| --- | --- | --- |
+| `region` | `"us"` | The region of your organization: `"us"` sends to `https://app.waniwani.ai`, `"eu"` to `https://eu.app.waniwani.ai` |
+| `apiUrl` | The host of `region` | Another WaniWani host, for local development |
+| `key` | `process.env.WANIWANI_AGENT_TRAFFIC_KEY` | The key from the setup screen, `wwt_<token>.<org key>` |
+| `waitUntil` | Found by itself on Vercel, none on other platforms | Keeps the post alive after the response |
+| `omit` | `[]` | Headers and fields to leave out of every event |
+
+## Development
+
+```bash
+bun install
+bun run build   # typecheck, lint and dist/index.js
+bun run test    # unit tests (run the build first, one test imports dist)
+bun run rules   # refreshes src/logic/ip-ranges.generated.json from the vendors' published lists
+```
+
+`src/logic/agents.json` is copied by hand from the WaniWani bot catalog (`src/lib/agent-traffic/bot-catalog.ts` in the WaniWani app): every entry of kind `training`, `search` or `fetcher`, using its `token` when it has one and its lowercased name otherwise.
+
+## License
+
+[Apache 2.0](LICENSE)

package/dist/index.d.ts

@@ -0,0 +1,44 @@
+declare const settings: {
+    apiUrls: {
+        us: string;
+        eu: string;
+    };
+    requestTimeoutMs: number;
+    retryDelayMs: number;
+};
+
+type Region = keyof typeof settings.apiUrls;
+type RelayOptions = {
+    /** The region of your WaniWani organization. Defaults to `"us"`. */
+    region?: Region;
+    /** Overrides the host that `region` picks. */
+    apiUrl?: string;
+    /** Overrides `process.env.WANIWANI_AGENT_TRAFFIC_KEY`. */
+    key?: string;
+    /** Keeps the background post alive after the response. Defaults to the `waitUntil` of the Vercel request context. */
+    waitUntil?: (promise: Promise<unknown>) => void;
+    /** Header names, and the fields `matchKey`, `userAgent` or `referer`, to leave out of every event. */
+    omit?: Array<string>;
+};
+type AgentVisitRecord = {
+    occurredAt: string;
+    method: string;
+    host: string;
+    path: string;
+    userAgent?: string;
+    referer?: string;
+    headers: Record<string, string>;
+    matchKey?: string;
+    sourceEventId: string;
+    relayVersion: string;
+};
+/** Tells whether a request comes from an AI agent. Reads headers only, makes no network call. */
+declare function isAgent(request: Request): boolean;
+/**
+ * Posts one event for this request to WaniWani after the response.
+ * Sends nothing when no key is set. Never throws and never touches the request.
+ */
+declare function recordAgentVisit(request: Request, options?: RelayOptions): void;
+
+export { isAgent, recordAgentVisit };
+export type { AgentVisitRecord, Region, RelayOptions };