@xyz17711/websearch 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,89 @@
-# Temporary Holding Version
+# @xyz17711/websearch
 
-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.
+[![Publish](https://github.com/17711-services/clients/actions/workflows/publish-node.yml/badge.svg)](https://github.com/17711-services/clients/actions/workflows/publish-node.yml)
+[![npm](https://img.shields.io/npm/v/@xyz17711/websearch)](https://www.npmjs.com/package/@xyz17711/websearch)
+[![License](https://img.shields.io/npm/l/@xyz17711/websearch)](https://github.com/17711-services/clients/blob/main/LICENSE)
+
+Typed TypeScript client for **websearch**, part of the
+[17711.xyz](https://api.17711.xyz) microservice fleet -- pay-per-call APIs settled in USDC via
+[x402](https://x402.org), listed on [x402scan](https://www.x402scan.com/server/f1c7b972-3405-4b75-8b4f-d1bfbd6305ff).
+
+## Install
+
+```bash
+npm install @xyz17711/websearch
+```
+
+## Methods
+
+| Method | Description |
+| --- | --- |
+| `getTaskStatus` | Polls for the result of a task enqueued by a *_async tool |
+| `searchWeb` | Searches the web, always through a free public proxy sourced from proxy-pool ($0.003, x402) |
+| `searchWebAsync` | Enqueues a websearch_search_web job and returns a task id immediately ($0.003, x402) |
+
+## Quickstart
+
+```typescript
+import { Client } from "@xyz17711/websearch";
+
+const client = new Client("https://api.17711.xyz/registry/websearch");
+// see the Methods table above for every available call and its request/response type
+```
+
+## Paying past the free quota
+
+Every gated tool allows a small number of free calls per day; beyond that it returns a 402
+challenge. Without a wallet configured, this client throws `PaymentRequiredError` with the price,
+network, and payee address attached:
+
+```typescript
+import { Client, PaymentRequiredError } from "@xyz17711/websearch";
+
+const client = new Client("https://api.17711.xyz/registry/websearch");
+try {
+  await client.getTaskStatus(/* ... */);
+} catch (e) {
+  if (e instanceof PaymentRequiredError) {
+    console.log(`needs ${e.priceUsdc} USDC on ${e.network}, payable to ${e.payTo}`);
+  }
+}
+```
+
+To pay automatically, configure a wallet on the client -- the private key should come from your
+own environment/secrets manager, never a literal string in source code:
+
+```typescript
+import { Client } from "@xyz17711/websearch";
+
+const client = new Client("https://api.17711.xyz/registry/websearch", {
+  x402PrivateKey: process.env.X402_PRIVATE_KEY,
+  x402ExpectedNetwork: "eip155:8453", // Base mainnet; use eip155:84532 for Base Sepolia testnet
+  x402MaxPaymentUsdc: 0.01,           // refuse any single call above this
+  x402MaxTotalSpendUsdc: 1.0,         // refuse once this WALLET's lifetime spend would exceed it
+});
+```
+
+**Never commit a private key.** Both spend caps are required together with the key -- a wallet
+with real funds and no explicit caps refuses to construct at all (`WalletConfigError`), on
+purpose. The cumulative cap is tracked per wallet address, shared by every `Client` you construct
+with that same key in this process.
+
+## LangChain.js
+
+```typescript
+import { Client } from "@xyz17711/websearch";
+import { WebsearchToolkit } from "@xyz17711/websearch/langchain";
+
+const client = new Client("https://api.17711.xyz/registry/websearch", { /* ...wallet options... */ });
+const tools = new WebsearchToolkit(client).getTools();
+```
+
+Requires the optional `@langchain/core`+`zod` peer dependencies (`npm install @langchain/core
+zod`) -- importing the base package above never requires them; only `@xyz17711/websearch/langchain`
+does.
+
+## License
+
+MIT -- see [`LICENSE`](../../LICENSE), shared by every language's client library in the
+`clients` repo this package lives in.

package/dist/index.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Typed HTTP client and request/response interfaces for websearch.
+ */
+import { Client as BaseClient, type ClientOptions } from "@xyz17711/core";
+/** `"pending"` (enqueued, no result yet), `"finished"` (a worker wrote a result -- see `ok`/ `result`), or `"unknown"` (this id was never valid, or both it and its result have expired -- see [`nimpoleon_tasks::TaskState`]'s own doc comment for why this is 3 states, not 2). */
+export interface TaskStatusKind {
+}
+export interface GetTaskStatusResponse {
+    ok?: boolean | null;
+    result?: unknown;
+    status: TaskStatusKind;
+}
+export interface GetTaskStatusRequest {
+    /** The `task_id` a `*_async` tool returned. */
+    task_id: string;
+}
+export interface SearchResultItem {
+    snippet: string;
+    title: string;
+    url: string;
+}
+export interface SearchWebResponse {
+    results: SearchResultItem[];
+}
+export interface SearchWebRequest {
+    /** The search query text, e.g. `"rust async runtime comparison"`. */
+    query: string;
+}
+/** The fixed response shape of every `*_async` tool -- deliberately NOT generic over the underlying sync tool's own response type, since no work has actually happened yet at this point. */
+export interface AsyncTaskResponse {
+    task_id: string;
+}
+export interface SearchWebAsyncRequest {
+    /** When set, the worker that processes this task POSTs the eventual result (a `TaskResult` JSON body) here, best-effort -- polling `websearch_get_task_status` always works too, regardless of whether this is set. */
+    callback_url?: string | null;
+    /** The search query text, e.g. `"rust async runtime comparison"`. */
+    query: string;
+}
+/** Typed client for websearch, e.g. `client.getTaskStatus(...)`. */
+export declare class Client extends BaseClient {
+    /** Polls for the result of a task enqueued by a *_async tool */
+    getTaskStatus(request: GetTaskStatusRequest): Promise<GetTaskStatusResponse>;
+    /** Searches the web, always through a free public proxy sourced from proxy-pool ($0.003, x402) */
+    searchWeb(request: SearchWebRequest): Promise<SearchWebResponse>;
+    /** Enqueues a websearch_search_web job and returns a task id immediately ($0.003, x402) */
+    searchWebAsync(request: SearchWebAsyncRequest): Promise<AsyncTaskResponse>;
+}
+export { ClientOptions };

package/dist/index.js

@@ -0,0 +1,19 @@
+/**
+ * Typed HTTP client and request/response interfaces for websearch.
+ */
+import { Client as BaseClient } from "@xyz17711/core";
+/** Typed client for websearch, e.g. `client.getTaskStatus(...)`. */
+export class Client extends BaseClient {
+    /** Polls for the result of a task enqueued by a *_async tool */
+    async getTaskStatus(request) {
+        return this.post("/v1/websearch/get_task_status", request);
+    }
+    /** Searches the web, always through a free public proxy sourced from proxy-pool ($0.003, x402) */
+    async searchWeb(request) {
+        return this.post("/v1/websearch/search_web", request);
+    }
+    /** Enqueues a websearch_search_web job and returns a task id immediately ($0.003, x402) */
+    async searchWebAsync(request) {
+        return this.post("/v1/websearch/search_web_async", request);
+    }
+}

package/dist/langchain.d.ts

@@ -0,0 +1,31 @@
+/**
+ * LangChain.js tools for websearch, grouped in one Toolkit -- one tool per operation, each just an async function (JS has no separate sync form to generate). Requires the `@langchain/core`+`zod` peer dependencies declared in this package's own package.json -- imported from `websearch/langchain`, never from the package root, so importing the base client never requires them installed.
+ */
+import { z } from "zod";
+import { Client } from "./index.js";
+export declare class WebsearchToolkit {
+    private client;
+    constructor(client: Client);
+    getTools(): (import("@langchain/core/tools").DynamicStructuredTool<z.ZodObject<{
+        task_id: z.ZodString;
+    }, z.core.$strip>, {
+        task_id: string;
+    }, {
+        task_id: string;
+    }, import("./index.js").GetTaskStatusResponse, unknown, "getTaskStatus"> | import("@langchain/core/tools").DynamicStructuredTool<z.ZodObject<{
+        query: z.ZodString;
+    }, z.core.$strip>, {
+        query: string;
+    }, {
+        query: string;
+    }, import("./index.js").SearchWebResponse, unknown, "searchWeb"> | import("@langchain/core/tools").DynamicStructuredTool<z.ZodObject<{
+        callback_url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        query: z.ZodString;
+    }, z.core.$strip>, {
+        query: string;
+        callback_url?: string | null | undefined;
+    }, {
+        query: string;
+        callback_url?: string | null | undefined;
+    }, import("./index.js").AsyncTaskResponse, unknown, "searchWebAsync">)[];
+}

package/dist/langchain.js

@@ -0,0 +1,29 @@
+/**
+ * LangChain.js tools for websearch, grouped in one Toolkit -- one tool per operation, each just an async function (JS has no separate sync form to generate). Requires the `@langchain/core`+`zod` peer dependencies declared in this package's own package.json -- imported from `websearch/langchain`, never from the package root, so importing the base client never requires them installed.
+ */
+import { tool } from "@langchain/core/tools";
+import { z } from "zod";
+export class WebsearchToolkit {
+    constructor(client) {
+        this.client = client;
+    }
+    getTools() {
+        return [
+            tool(async (input) => this.client.getTaskStatus(input), {
+                name: "getTaskStatus",
+                description: "Polls for the result of a task enqueued by a *_async tool",
+                schema: z.object({ task_id: z.string() }),
+            }),
+            tool(async (input) => this.client.searchWeb(input), {
+                name: "searchWeb",
+                description: "Searches the web, always through a free public proxy sourced from proxy-pool ($0.003, x402)",
+                schema: z.object({ query: z.string() }),
+            }),
+            tool(async (input) => this.client.searchWebAsync(input), {
+                name: "searchWebAsync",
+                description: "Enqueues a websearch_search_web job and returns a task id immediately ($0.003, x402)",
+                schema: z.object({ callback_url: z.string().nullable().optional(), query: z.string() }),
+            }),
+        ];
+    }
+}

package/package.json

@@ -1,6 +1,42 @@
 {
   "name": "@xyz17711/websearch",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Generated typed client for the websearch 17711.xyz microservice.",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./langchain": {
+      "types": "./dist/langchain.d.ts",
+      "default": "./dist/langchain.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc -p .",
+    "test": "npm run build && node --test test/*.test.mjs"
+  },
+  "dependencies": {
+    "@xyz17711/core": "^0.1.0"
+  },
+  "peerDependencies": {
+    "@langchain/core": ">=0.3",
+    "zod": "^3 || ^4"
+  },
+  "peerDependenciesMeta": {
+    "@langchain/core": {
+      "optional": true
+    },
+    "zod": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "typescript": "^5",
+    "@langchain/core": "^1.2",
+    "zod": "^4"
+  }
+}

package/src/index.ts

@@ -0,0 +1,67 @@
+/**
+ * Typed HTTP client and request/response interfaces for websearch.
+ */
+
+import { Client as BaseClient, type ClientOptions } from "@xyz17711/core";
+
+/** `"pending"` (enqueued, no result yet), `"finished"` (a worker wrote a result -- see `ok`/ `result`), or `"unknown"` (this id was never valid, or both it and its result have expired -- see [`nimpoleon_tasks::TaskState`]'s own doc comment for why this is 3 states, not 2). */
+export interface TaskStatusKind {
+}
+
+export interface GetTaskStatusResponse {
+  ok?: boolean | null;
+  result?: unknown;
+  status: TaskStatusKind;
+}
+
+export interface GetTaskStatusRequest {
+  /** The `task_id` a `*_async` tool returned. */
+  task_id: string;
+}
+
+export interface SearchResultItem {
+  snippet: string;
+  title: string;
+  url: string;
+}
+
+export interface SearchWebResponse {
+  results: SearchResultItem[];
+}
+
+export interface SearchWebRequest {
+  /** The search query text, e.g. `"rust async runtime comparison"`. */
+  query: string;
+}
+
+/** The fixed response shape of every `*_async` tool -- deliberately NOT generic over the underlying sync tool's own response type, since no work has actually happened yet at this point. */
+export interface AsyncTaskResponse {
+  task_id: string;
+}
+
+export interface SearchWebAsyncRequest {
+  /** When set, the worker that processes this task POSTs the eventual result (a `TaskResult` JSON body) here, best-effort -- polling `websearch_get_task_status` always works too, regardless of whether this is set. */
+  callback_url?: string | null;
+  /** The search query text, e.g. `"rust async runtime comparison"`. */
+  query: string;
+}
+
+/** Typed client for websearch, e.g. `client.getTaskStatus(...)`. */
+export class Client extends BaseClient {
+  /** Polls for the result of a task enqueued by a *_async tool */
+  async getTaskStatus(request: GetTaskStatusRequest): Promise<GetTaskStatusResponse> {
+    return this.post<GetTaskStatusResponse>("/v1/websearch/get_task_status", request);
+  }
+
+  /** Searches the web, always through a free public proxy sourced from proxy-pool ($0.003, x402) */
+  async searchWeb(request: SearchWebRequest): Promise<SearchWebResponse> {
+    return this.post<SearchWebResponse>("/v1/websearch/search_web", request);
+  }
+
+  /** Enqueues a websearch_search_web job and returns a task id immediately ($0.003, x402) */
+  async searchWebAsync(request: SearchWebAsyncRequest): Promise<AsyncTaskResponse> {
+    return this.post<AsyncTaskResponse>("/v1/websearch/search_web_async", request);
+  }
+}
+
+export { ClientOptions };

package/src/langchain.ts

@@ -0,0 +1,44 @@
+/**
+ * LangChain.js tools for websearch, grouped in one Toolkit -- one tool per operation, each just an async function (JS has no separate sync form to generate). Requires the `@langchain/core`+`zod` peer dependencies declared in this package's own package.json -- imported from `websearch/langchain`, never from the package root, so importing the base client never requires them installed.
+ */
+
+import { tool } from "@langchain/core/tools";
+import { z } from "zod";
+import { Client } from "./index.js";
+
+export class WebsearchToolkit {
+  private client: Client;
+
+  constructor(client: Client) {
+    this.client = client;
+  }
+
+  getTools() {
+    return [
+      tool(
+        async (input) => this.client.getTaskStatus(input),
+        {
+          name: "getTaskStatus",
+          description: "Polls for the result of a task enqueued by a *_async tool",
+          schema: z.object({ task_id: z.string() }),
+        },
+      ),
+      tool(
+        async (input) => this.client.searchWeb(input),
+        {
+          name: "searchWeb",
+          description: "Searches the web, always through a free public proxy sourced from proxy-pool ($0.003, x402)",
+          schema: z.object({ query: z.string() }),
+        },
+      ),
+      tool(
+        async (input) => this.client.searchWebAsync(input),
+        {
+          name: "searchWebAsync",
+          description: "Enqueues a websearch_search_web job and returns a task id immediately ($0.003, x402)",
+          schema: z.object({ callback_url: z.string().nullable().optional(), query: z.string() }),
+        },
+      ),
+    ];
+  }
+}

package/test/index.test.mjs

@@ -0,0 +1,58 @@
+/**
+ * Verifies every websearch client method sends a request to the expected path/HTTP verb and parses a well-formed response -- one test per operation, real fetch mocked via a plain reassignment of `globalThis.fetch` (no extra test/mocking dependency). Runs against the COMPILED package (`../dist/index.js`) -- build before testing.
+ */
+
+import { test } from "node:test";
+import assert from "node:assert/strict";
+import { Client } from "../dist/index.js";
+
+test("getTaskStatus calls the expected path", async () => {
+  const originalFetch = globalThis.fetch;
+  globalThis.fetch = async (url, init = {}) => {
+    const parsed = new URL(url);
+    assert.equal((init.method ?? "GET").toUpperCase(), "POST");
+    assert.equal(parsed.pathname, "/v1/websearch/get_task_status");
+    return new Response(JSON.stringify({ ok: null, result: null, status: {  } }), { status: 200 });
+  };
+  try {
+    const client = new Client("https://example.test");
+    const result = await client.getTaskStatus({ task_id: "test" });
+    assert.ok(result !== undefined);
+  } finally {
+    globalThis.fetch = originalFetch;
+  }
+});
+
+test("searchWeb calls the expected path", async () => {
+  const originalFetch = globalThis.fetch;
+  globalThis.fetch = async (url, init = {}) => {
+    const parsed = new URL(url);
+    assert.equal((init.method ?? "GET").toUpperCase(), "POST");
+    assert.equal(parsed.pathname, "/v1/websearch/search_web");
+    return new Response(JSON.stringify({ results: [] }), { status: 200 });
+  };
+  try {
+    const client = new Client("https://example.test");
+    const result = await client.searchWeb({ query: "test" });
+    assert.ok(result !== undefined);
+  } finally {
+    globalThis.fetch = originalFetch;
+  }
+});
+
+test("searchWebAsync calls the expected path", async () => {
+  const originalFetch = globalThis.fetch;
+  globalThis.fetch = async (url, init = {}) => {
+    const parsed = new URL(url);
+    assert.equal((init.method ?? "GET").toUpperCase(), "POST");
+    assert.equal(parsed.pathname, "/v1/websearch/search_web_async");
+    return new Response(JSON.stringify({ task_id: "test" }), { status: 200 });
+  };
+  try {
+    const client = new Client("https://example.test");
+    const result = await client.searchWebAsync({ callback_url: null, query: "test" });
+    assert.ok(result !== undefined);
+  } finally {
+    globalThis.fetch = originalFetch;
+  }
+});

package/test/langchain.test.mjs

@@ -0,0 +1,32 @@
+/**
+ * Verifies every websearch LangChain tool through the real StructuredTool (`.invoke()`), not just the underlying client method -- catches schema-shape bugs a plain client-method test would miss. Requires the `langchain`/`zod` dev dependencies.
+ */
+
+import { test } from "node:test";
+import assert from "node:assert/strict";
+import { Client } from "../dist/index.js";
+import { WebsearchToolkit } from "../dist/langchain.js";
+
+test("getTaskStatus tool invoke", async () => {
+  globalThis.fetch = async () => new Response(JSON.stringify({ ok: null, result: null, status: {  } }), { status: 200 });
+  const toolkit = new WebsearchToolkit(new Client("https://example.test"));
+  const t = toolkit.getTools().find((x) => x.name === "getTaskStatus");
+  const result = await t.invoke({ task_id: "test" });
+  assert.ok(result !== undefined);
+});
+
+test("searchWeb tool invoke", async () => {
+  globalThis.fetch = async () => new Response(JSON.stringify({ results: [] }), { status: 200 });
+  const toolkit = new WebsearchToolkit(new Client("https://example.test"));
+  const t = toolkit.getTools().find((x) => x.name === "searchWeb");
+  const result = await t.invoke({ query: "test" });
+  assert.ok(result !== undefined);
+});
+
+test("searchWebAsync tool invoke", async () => {
+  globalThis.fetch = async () => new Response(JSON.stringify({ task_id: "test" }), { status: 200 });
+  const toolkit = new WebsearchToolkit(new Client("https://example.test"));
+  const t = toolkit.getTools().find((x) => x.name === "searchWebAsync");
+  const result = await t.invoke({ callback_url: "test", query: "test" });
+  assert.ok(result !== undefined);
+});

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ES2020",
+    "moduleResolution": "bundler",
+    "declaration": true,
+    "outDir": "dist",
+    "rootDir": "src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true
+  },
+  "include": [
+    "src"
+  ]
+}