@xyz17711/websearch 0.0.0-stage → 0.1.1

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` | Web search API for agents: search the web and get result titles, URLs and snippets as JSON ($0.005, x402) |
+| `searchWebAsync` | [Deprecated - use websearch_search_web] Enqueues a websearch_search_web job and returns a task id immediately ($0.005, 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>;
+    /** Web search API for agents: search the web and get result titles, URLs and snippets as JSON ($0.005, x402) */
+    searchWeb(request: SearchWebRequest): Promise<SearchWebResponse>;
+    /** [Deprecated - use websearch_search_web] Enqueues a websearch_search_web job and returns a task id immediately ($0.005, 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);
+    }
+    /** Web search API for agents: search the web and get result titles, URLs and snippets as JSON ($0.005, x402) */
+    async searchWeb(request) {
+        return this.post("/v1/websearch/search_web", request);
+    }
+    /** [Deprecated - use websearch_search_web] Enqueues a websearch_search_web job and returns a task id immediately ($0.005, 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: "Web search API for agents: search the web and get result titles, URLs and snippets as JSON ($0.005, x402)",
+                schema: z.object({ query: z.string() }),
+            }),
+            tool(async (input) => this.client.searchWebAsync(input), {
+                name: "searchWebAsync",
+                description: "[Deprecated - use websearch_search_web] Enqueues a websearch_search_web job and returns a task id immediately ($0.005, x402)",
+                schema: z.object({ callback_url: z.string().nullable().optional(), query: z.string() }),
+            }),
+        ];
+    }
+}

package/package.json

@@ -1,6 +1,70 @@
 {
   "name": "@xyz17711/websearch",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "description": "Typed TypeScript client for the 17711.xyz Websearch API: pay-per-call, settled in USDC via x402.",
+  "license": "MIT",
+  "author": "17711 Services",
+  "homepage": "https://api.17711.xyz",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/17711-services/clients.git",
+    "directory": "node/packages/websearch"
+  },
+  "bugs": {
+    "url": "https://github.com/17711-services/clients/issues"
+  },
+  "keywords": [
+    "x402",
+    "usdc",
+    "api-client",
+    "pay-per-call",
+    "ai-agents",
+    "mcp",
+    "langchain",
+    "websearch"
+  ],
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "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"
+  }
+}