@xyz17711/catalog 0.1.0 → 0.1.2

package/README.md

@@ -27,10 +27,13 @@ npm install @xyz17711/catalog
 ```typescript
 import { Client } from "@xyz17711/catalog";
 
-const client = new Client("https://api.17711.xyz/registry/catalog");
+const client = new Client(); // talks to https://api.17711.xyz/registry/catalog by default
 // see the Methods table above for every available call and its request/response type
 ```
 
+Pass another base URL (self-hosted instance, test server) as the first argument:
+`new Client("https://my-host.example/registry/catalog")`.
+
 ## Paying past the free quota
 
 Every gated tool allows a small number of free calls per day; beyond that it returns a 402
@@ -40,7 +43,7 @@ network, and payee address attached:
 ```typescript
 import { Client, PaymentRequiredError } from "@xyz17711/catalog";
 
-const client = new Client("https://api.17711.xyz/registry/catalog");
+const client = new Client();
 try {
   await client.category(/* ... */);
 } catch (e) {
@@ -56,7 +59,7 @@ own environment/secrets manager, never a literal string in source code:
 ```typescript
 import { Client } from "@xyz17711/catalog";
 
-const client = new Client("https://api.17711.xyz/registry/catalog", {
+const client = new Client({
   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
@@ -75,7 +78,7 @@ with that same key in this process.
 import { Client } from "@xyz17711/catalog";
 import { CatalogToolkit } from "@xyz17711/catalog/langchain";
 
-const client = new Client("https://api.17711.xyz/registry/catalog", { /* ...wallet options... */ });
+const client = new Client({ /* ...wallet options... */ });
 const tools = new CatalogToolkit(client).getTools();
 ```
 

package/dist/index.d.ts

@@ -59,8 +59,17 @@ export interface CatalogSearchResponse {
     /** Ranked best-match-first, truncated to the request's own `limit`. */
     results: CatalogSearchResult[];
 }
+/** Production base URL of this service; pass another to self-host or test. */
+export declare const DEFAULT_BASE_URL = "https://api.17711.xyz/registry/catalog";
 /** Typed client for catalog, e.g. `client.category(...)`. */
 export declare class Client extends BaseClient {
+    /**
+     * `new Client()` talks to the production service. Pass a base URL to target another
+     * instance, and/or wallet options (`new Client({ x402PrivateKey, ... })`) to pay past the
+     * free quota automatically.
+     */
+    constructor(options?: ClientOptions);
+    constructor(baseUrl?: string, options?: ClientOptions);
     /** Lists every registration in one category, paginated (public GET) */
     category(params: {
         q: string;

package/dist/index.js

@@ -2,8 +2,16 @@
  * Typed HTTP client and request/response interfaces for catalog.
  */
 import { Client as BaseClient } from "@xyz17711/core";
+/** Production base URL of this service; pass another to self-host or test. */
+export const DEFAULT_BASE_URL = "https://api.17711.xyz/registry/catalog";
 /** Typed client for catalog, e.g. `client.category(...)`. */
 export class Client extends BaseClient {
+    constructor(baseUrlOrOptions, options = {}) {
+        const [url, opts] = typeof baseUrlOrOptions === "object"
+            ? [DEFAULT_BASE_URL, baseUrlOrOptions]
+            : [baseUrlOrOptions ?? DEFAULT_BASE_URL, options];
+        super(url, opts);
+    }
     /** Lists every registration in one category, paginated (public GET) */
     async category(params) {
         return this.get("/v1/catalog/category", { q: params.q, limit: params.limit, offset: params.offset });

package/package.json

@@ -1,7 +1,35 @@
 {
   "name": "@xyz17711/catalog",
-  "version": "0.1.0",
-  "description": "Generated typed client for the catalog 17711.xyz microservice.",
+  "version": "0.1.2",
+  "description": "Typed TypeScript client for the 17711.xyz Catalog 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/catalog"
+  },
+  "bugs": {
+    "url": "https://github.com/17711-services/clients/issues"
+  },
+  "keywords": [
+    "x402",
+    "usdc",
+    "api-client",
+    "pay-per-call",
+    "ai-agents",
+    "mcp",
+    "langchain",
+    "catalog"
+  ],
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/index.ts

@@ -1,89 +0,0 @@
-/**
- * Typed HTTP client and request/response interfaces for catalog.
- */
-
-import { Client as BaseClient, type ClientOptions } from "@xyz17711/core";
-
-export interface CatalogCategoryEntry {
-  category: string;
-  description: string;
-  host: string;
-  name: string;
-  port: number;
-  registered_at: number;
-}
-
-export interface CatalogCategoryResponse {
-  /** This page's entries, in no particular order (no ranking -- this is a listing, not a search). */
-  entries: CatalogCategoryEntry[];
-  limit: number;
-  offset: number;
-  /** Total number of registrations matching `q`, BEFORE `limit`/`offset` are applied -- lets a caller know whether more pages remain. */
-  total_count: number;
-}
-
-export interface SearchResult {
-  description: string;
-  host: string;
-  method: string;
-  port: number;
-  /** Decimal USDC string (e.g. `"0.01"`), or `""` if this tool is free -- structural pricing, not just prose in `description`. */
-  price_usdc: string;
-  route: string;
-  /** Similarity score (semantic embedding cosine similarity when available, else keyword overlap in `[0, 1]`) -- higher is a better match. Not comparable across two different searches (the scoring method may differ per-call depending on embedding availability). */
-  score: number;
-  service_name: string;
-  tool_name: string;
-}
-
-export interface SearchResponse {
-  /** Ranked best-match-first, truncated to the request's own `top_k`. */
-  results: SearchResult[];
-}
-
-export interface SearchRequest {
-  /** Free-text description of the task to find a service for. */
-  query: string;
-  /** Max number of results to return. */
-  top_k?: number;
-}
-
-export interface CatalogSearchResult {
-  category: string;
-  description: string;
-  host: string;
-  method: string;
-  port: number;
-  /** Decimal USDC string (e.g. `"0.01"`), or `""` if this tool is free -- structural pricing, not just prose in `description`. */
-  price_usdc: string;
-  route: string;
-  /** Similarity score (semantic embedding cosine similarity when available, else keyword overlap in `[0, 1]`) -- higher is a better match. Not comparable across two different searches (the scoring method may differ per-call depending on embedding availability). */
-  score: number;
-  service_name: string;
-  tool_name: string;
-}
-
-export interface CatalogSearchResponse {
-  /** Ranked best-match-first, truncated to the request's own `limit`. */
-  results: CatalogSearchResult[];
-}
-
-/** Typed client for catalog, e.g. `client.category(...)`. */
-export class Client extends BaseClient {
-  /** Lists every registration in one category, paginated (public GET) */
-  async category(params: { q: string; limit?: number; offset?: number }): Promise<CatalogCategoryResponse> {
-    return this.get<CatalogCategoryResponse>("/v1/catalog/category", { q: params.q, limit: params.limit, offset: params.offset });
-  }
-
-  /** Ranks registered services/tools by relevance to a free-text query */
-  async findServicesByCapability(request: SearchRequest): Promise<SearchResponse> {
-    return this.post<SearchResponse>("/v1/catalog/find_services_by_capability", request);
-  }
-
-  /** Ranks registered services/tools by relevance to a free-text query (public GET) */
-  async search(params: { q: string; category?: string | null; limit?: number }): Promise<CatalogSearchResponse> {
-    return this.get<CatalogSearchResponse>("/v1/catalog/search", { q: params.q, category: params.category, limit: params.limit });
-  }
-}
-
-export { ClientOptions };

package/src/langchain.ts

@@ -1,44 +0,0 @@
-/**
- * LangChain.js tools for catalog, 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 `catalog/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 CatalogToolkit {
-  private client: Client;
-
-  constructor(client: Client) {
-    this.client = client;
-  }
-
-  getTools() {
-    return [
-      tool(
-        async (input) => this.client.category(input),
-        {
-          name: "category",
-          description: "Lists every registration in one category, paginated (public GET)",
-          schema: z.object({ q: z.string(), limit: z.number().optional(), offset: z.number().optional() }),
-        },
-      ),
-      tool(
-        async (input) => this.client.findServicesByCapability(input),
-        {
-          name: "findServicesByCapability",
-          description: "Ranks registered services/tools by relevance to a free-text query",
-          schema: z.object({ query: z.string(), top_k: z.number().optional() }),
-        },
-      ),
-      tool(
-        async (input) => this.client.search(input),
-        {
-          name: "search",
-          description: "Ranks registered services/tools by relevance to a free-text query (public GET)",
-          schema: z.object({ q: z.string(), category: z.string().nullable().optional(), limit: z.number().optional() }),
-        },
-      ),
-    ];
-  }
-}

package/test/index.test.mjs

@@ -1,58 +0,0 @@
-/**
- * Verifies every catalog 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("category 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(), "GET");
-    assert.equal(parsed.pathname, "/v1/catalog/category");
-    return new Response(JSON.stringify({ entries: [], limit: 0, offset: 0, total_count: 0 }), { status: 200 });
-  };
-  try {
-    const client = new Client("https://example.test");
-    const result = await client.category({ q: "test", limit: null, offset: null });
-    assert.ok(result !== undefined);
-  } finally {
-    globalThis.fetch = originalFetch;
-  }
-});
-
-test("findServicesByCapability 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/catalog/find_services_by_capability");
-    return new Response(JSON.stringify({ results: [] }), { status: 200 });
-  };
-  try {
-    const client = new Client("https://example.test");
-    const result = await client.findServicesByCapability({ query: "test", top_k: null });
-    assert.ok(result !== undefined);
-  } finally {
-    globalThis.fetch = originalFetch;
-  }
-});
-
-test("search 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(), "GET");
-    assert.equal(parsed.pathname, "/v1/catalog/search");
-    return new Response(JSON.stringify({ results: [] }), { status: 200 });
-  };
-  try {
-    const client = new Client("https://example.test");
-    const result = await client.search({ q: "test", category: null, limit: null });
-    assert.ok(result !== undefined);
-  } finally {
-    globalThis.fetch = originalFetch;
-  }
-});

package/test/langchain.test.mjs

@@ -1,32 +0,0 @@
-/**
- * Verifies every catalog 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 { CatalogToolkit } from "../dist/langchain.js";
-
-test("category tool invoke", async () => {
-  globalThis.fetch = async () => new Response(JSON.stringify({ entries: [], limit: 0, offset: 0, total_count: 0 }), { status: 200 });
-  const toolkit = new CatalogToolkit(new Client("https://example.test"));
-  const t = toolkit.getTools().find((x) => x.name === "category");
-  const result = await t.invoke({ q: "test", limit: 0, offset: 0 });
-  assert.ok(result !== undefined);
-});
-
-test("findServicesByCapability tool invoke", async () => {
-  globalThis.fetch = async () => new Response(JSON.stringify({ results: [] }), { status: 200 });
-  const toolkit = new CatalogToolkit(new Client("https://example.test"));
-  const t = toolkit.getTools().find((x) => x.name === "findServicesByCapability");
-  const result = await t.invoke({ query: "test", top_k: 0 });
-  assert.ok(result !== undefined);
-});
-
-test("search tool invoke", async () => {
-  globalThis.fetch = async () => new Response(JSON.stringify({ results: [] }), { status: 200 });
-  const toolkit = new CatalogToolkit(new Client("https://example.test"));
-  const t = toolkit.getTools().find((x) => x.name === "search");
-  const result = await t.invoke({ q: "test", category: "test", limit: 0 });
-  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"
-  ]
-}