@xyz17711/extract-correct 0.1.0 → 0.1.2

package/README.md

@@ -4,7 +4,7 @@
 [![npm](https://img.shields.io/npm/v/@xyz17711/extract-correct)](https://www.npmjs.com/package/@xyz17711/extract-correct)
 [![License](https://img.shields.io/npm/l/@xyz17711/extract-correct)](https://github.com/17711-services/clients/blob/main/LICENSE)
 
-Typed TypeScript client for **🩹 extract-correct-service**, part of the
+Typed TypeScript client for **extract-correct-service**, 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).
 
@@ -25,10 +25,13 @@ npm install @xyz17711/extract-correct
 ```typescript
 import { Client } from "@xyz17711/extract-correct";
 
-const client = new Client("https://api.17711.xyz/registry/🩹 extract-correct-service");
+const client = new Client(); // talks to https://api.17711.xyz/registry/extract-correct-service 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/extract-correct-service")`.
+
 ## Paying past the free quota
 
 Every gated tool allows a small number of free calls per day; beyond that it returns a 402
@@ -38,7 +41,7 @@ network, and payee address attached:
 ```typescript
 import { Client, PaymentRequiredError } from "@xyz17711/extract-correct";
 
-const client = new Client("https://api.17711.xyz/registry/🩹 extract-correct-service");
+const client = new Client();
 try {
   await client.parseJson(/* ... */);
 } catch (e) {
@@ -54,7 +57,7 @@ own environment/secrets manager, never a literal string in source code:
 ```typescript
 import { Client } from "@xyz17711/extract-correct";
 
-const client = new Client("https://api.17711.xyz/registry/🩹 extract-correct-service", {
+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
@@ -73,7 +76,7 @@ with that same key in this process.
 import { Client } from "@xyz17711/extract-correct";
 import { ExtractCorrectToolkit } from "@xyz17711/extract-correct/langchain";
 
-const client = new Client("https://api.17711.xyz/registry/🩹 extract-correct-service", { /* ...wallet options... */ });
+const client = new Client({ /* ...wallet options... */ });
 const tools = new ExtractCorrectToolkit(client).getTools();
 ```
 

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * Typed HTTP client and request/response interfaces for 🩹 extract-correct-service.
+ * Typed HTTP client and request/response interfaces for extract-correct-service.
  */
 import { Client as BaseClient, type ClientOptions } from "@xyz17711/core";
 /** One deterministic correction actually applied to the extracted value. */
@@ -38,8 +38,17 @@ export interface ParseJsonRequest {
     /** Free-form or messy text to extract structured JSON from -- already-valid JSON, JSON wrapped in prose or a markdown code fence, or malformed JSON (trailing commas, single-quoted strings, unquoted keys, a truncated array/object). */
     text: string;
 }
-/** Typed client for 🩹 extract-correct-service, e.g. `client.parseJson(...)`. */
+/** Production base URL of this service; pass another to self-host or test. */
+export declare const DEFAULT_BASE_URL = "https://api.17711.xyz/registry/extract-correct-service";
+/** Typed client for extract-correct-service, e.g. `client.parseJson(...)`. */
 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);
     /** JSON repair API: extract valid JSON from messy text or model output and fix it against a JSON Schema ($0.006, x402) */
     parseJson(request: ParseJsonRequest): Promise<ParseJsonResponse>;
 }

package/dist/index.js

@@ -1,9 +1,17 @@
 /**
- * Typed HTTP client and request/response interfaces for 🩹 extract-correct-service.
+ * Typed HTTP client and request/response interfaces for extract-correct-service.
  */
 import { Client as BaseClient } from "@xyz17711/core";
-/** Typed client for 🩹 extract-correct-service, e.g. `client.parseJson(...)`. */
+/** Production base URL of this service; pass another to self-host or test. */
+export const DEFAULT_BASE_URL = "https://api.17711.xyz/registry/extract-correct-service";
+/** Typed client for extract-correct-service, e.g. `client.parseJson(...)`. */
 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);
+    }
     /** JSON repair API: extract valid JSON from messy text or model output and fix it against a JSON Schema ($0.006, x402) */
     async parseJson(request) {
         return this.post("/v1/extract-correct/parse_json", request);

package/dist/langchain.d.ts

@@ -1,5 +1,5 @@
 /**
- * LangChain.js tools for 🩹 extract-correct-service, 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 `extract-correct/langchain`, never from the package root, so importing the base client never requires them installed.
+ * LangChain.js tools for extract-correct-service, 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 `extract-correct/langchain`, never from the package root, so importing the base client never requires them installed.
  */
 import { z } from "zod";
 import { Client } from "./index.js";

package/dist/langchain.js

@@ -1,5 +1,5 @@
 /**
- * LangChain.js tools for 🩹 extract-correct-service, 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 `extract-correct/langchain`, never from the package root, so importing the base client never requires them installed.
+ * LangChain.js tools for extract-correct-service, 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 `extract-correct/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";

package/package.json

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

package/src/index.ts

@@ -1,55 +0,0 @@
-/**
- * Typed HTTP client and request/response interfaces for 🩹 extract-correct-service.
- */
-
-import { Client as BaseClient, type ClientOptions } from "@xyz17711/core";
-
-/** One deterministic correction actually applied to the extracted value. */
-export interface AppliedFix {
-  /** Human-readable detail of what changed. */
-  detail: string;
-  /** JSON Pointer to the field that was corrected (e.g. `/user/age`; `""` = the whole value). */
-  path: string;
-  /** Which bounded correction rule fired (e.g. `type_coercion`, `additional_property_stripped`, `enum_case_insensitive_match`, `required_default_filled`, `clamped_to_minimum`, `clamped_to_maximum`, `array_truncated_to_max_items`). */
-  rule: string;
-}
-
-/** One schema violation that could NOT be corrected -- never silently dropped or guessed. */
-export interface RemainingIssue {
-  /** The JSON Schema keyword that failed (e.g. `pattern`, `format`, `minItems`, `oneOf`). */
-  keyword: string;
-  /** The underlying validator's own error message. */
-  message: string;
-  /** JSON Pointer to the field that still fails validation. */
-  path: string;
-}
-
-export interface ParseJsonResponse {
-  /** Every correction actually applied, in the order applied. */
-  applied_fixes: AppliedFix[];
-  /** The extracted (and, if a schema was supplied, corrected) JSON value. */
-  data: unknown;
-  /** How `data` was obtained: `"direct"` (already valid JSON), `"repaired"` (malformed JSON fixed in place), or `"extracted_and_repaired"` (isolated from surrounding text, then fixed). */
-  extraction_method: string;
-  /** Every schema violation that remains after correction -- non-empty only when `schema` was supplied and at least one issue couldn't be fixed by a bounded v1 rule. */
-  remaining_issues: RemainingIssue[];
-  /** Whether `data` satisfies `schema` after correction. `None` when no `schema` was supplied -- never conflated with "assumed valid". */
-  valid?: boolean | null;
-}
-
-export interface ParseJsonRequest {
-  /** Optional JSON Schema to validate the extracted value against and auto-correct where a bounded, deterministic fix rule applies. Omitted = extraction only, no validation. */
-  schema?: unknown;
-  /** Free-form or messy text to extract structured JSON from -- already-valid JSON, JSON wrapped in prose or a markdown code fence, or malformed JSON (trailing commas, single-quoted strings, unquoted keys, a truncated array/object). */
-  text: string;
-}
-
-/** Typed client for 🩹 extract-correct-service, e.g. `client.parseJson(...)`. */
-export class Client extends BaseClient {
-  /** JSON repair API: extract valid JSON from messy text or model output and fix it against a JSON Schema ($0.006, x402) */
-  async parseJson(request: ParseJsonRequest): Promise<ParseJsonResponse> {
-    return this.post<ParseJsonResponse>("/v1/extract-correct/parse_json", request);
-  }
-}
-
-export { ClientOptions };

package/src/langchain.ts

@@ -1,28 +0,0 @@
-/**
- * LangChain.js tools for 🩹 extract-correct-service, 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 `extract-correct/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 ExtractCorrectToolkit {
-  private client: Client;
-
-  constructor(client: Client) {
-    this.client = client;
-  }
-
-  getTools() {
-    return [
-      tool(
-        async (input) => this.client.parseJson(input),
-        {
-          name: "parseJson",
-          description: "JSON repair API: extract valid JSON from messy text or model output and fix it against a JSON Schema ($0.006, x402)",
-          schema: z.object({ schema: z.unknown().optional(), text: z.string() }),
-        },
-      ),
-    ];
-  }
-}

package/test/index.test.mjs

@@ -1,24 +0,0 @@
-/**
- * Verifies every extract-correct 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("parseJson 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/extract-correct/parse_json");
-    return new Response(JSON.stringify({ applied_fixes: [], data: null, extraction_method: "test", remaining_issues: [], valid: null }), { status: 200 });
-  };
-  try {
-    const client = new Client("https://example.test");
-    const result = await client.parseJson({ schema: null, text: "test" });
-    assert.ok(result !== undefined);
-  } finally {
-    globalThis.fetch = originalFetch;
-  }
-});

package/test/langchain.test.mjs

@@ -1,16 +0,0 @@
-/**
- * Verifies every extract-correct 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 { ExtractCorrectToolkit } from "../dist/langchain.js";
-
-test("parseJson tool invoke", async () => {
-  globalThis.fetch = async () => new Response(JSON.stringify({ applied_fixes: [], data: null, extraction_method: "test", remaining_issues: [], valid: null }), { status: 200 });
-  const toolkit = new ExtractCorrectToolkit(new Client("https://example.test"));
-  const t = toolkit.getTools().find((x) => x.name === "parseJson");
-  const result = await t.invoke({ schema: null, text: "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"
-  ]
-}