@xyz17711/websearch 0.1.0 → 0.1.1

package/README.md

@@ -19,8 +19,8 @@ npm install @xyz17711/websearch
 | 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) |
+| `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
 

package/dist/index.d.ts

@@ -40,9 +40,9 @@ export interface SearchWebAsyncRequest {
 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) */
+    /** 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>;
-    /** Enqueues a websearch_search_web job and returns a task id immediately ($0.003, x402) */
+    /** [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

@@ -8,11 +8,11 @@ export class Client extends BaseClient {
     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) */
+    /** 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);
     }
-    /** Enqueues a websearch_search_web job and returns a task id immediately ($0.003, x402) */
+    /** [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.js

@@ -16,12 +16,12 @@ export class WebsearchToolkit {
             }),
             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)",
+                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: "Enqueues a websearch_search_web job and returns a task id immediately ($0.003, x402)",
+                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,7 +1,35 @@
 {
   "name": "@xyz17711/websearch",
-  "version": "0.1.0",
-  "description": "Generated typed client for the websearch 17711.xyz microservice.",
+  "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",

package/src/index.ts

@@ -1,67 +0,0 @@
-/**
- * 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

@@ -1,44 +0,0 @@
-/**
- * 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

@@ -1,58 +0,0 @@
-/**
- * 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

@@ -1,32 +0,0 @@
-/**
- * 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

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