@xyz17711/extract-correct 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,87 @@
-# Temporary Holding Version
+# @xyz17711/extract-correct
 
-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/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
+[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/extract-correct
+```
+
+## Methods
+
+| Method | Description |
+| --- | --- |
+| `parseJson` | JSON repair API: extract valid JSON from messy text or model output and fix it against a JSON Schema ($0.006, x402) |
+
+## Quickstart
+
+```typescript
+import { Client } from "@xyz17711/extract-correct";
+
+const client = new Client("https://api.17711.xyz/registry/🩹 extract-correct-service");
+// 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/extract-correct";
+
+const client = new Client("https://api.17711.xyz/registry/🩹 extract-correct-service");
+try {
+  await client.parseJson(/* ... */);
+} 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/extract-correct";
+
+const client = new Client("https://api.17711.xyz/registry/🩹 extract-correct-service", {
+  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/extract-correct";
+import { ExtractCorrectToolkit } from "@xyz17711/extract-correct/langchain";
+
+const client = new Client("https://api.17711.xyz/registry/🩹 extract-correct-service", { /* ...wallet options... */ });
+const tools = new ExtractCorrectToolkit(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/extract-correct/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,46 @@
+/**
+ * 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 declare 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) */
+    parseJson(request: ParseJsonRequest): Promise<ParseJsonResponse>;
+}
+export { ClientOptions };

package/dist/index.js

@@ -0,0 +1,11 @@
+/**
+ * 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(...)`. */
+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) {
+        return this.post("/v1/extract-correct/parse_json", request);
+    }
+}

package/dist/langchain.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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";
+export declare class ExtractCorrectToolkit {
+    private client;
+    constructor(client: Client);
+    getTools(): import("@langchain/core/tools").DynamicStructuredTool<z.ZodObject<{
+        schema: z.ZodOptional<z.ZodUnknown>;
+        text: z.ZodString;
+    }, z.core.$strip>, {
+        text: string;
+        schema?: unknown;
+    }, {
+        text: string;
+        schema?: unknown;
+    }, import("./index.js").ParseJsonResponse, unknown, "parseJson">[];
+}

package/dist/langchain.js

@@ -0,0 +1,19 @@
+/**
+ * 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";
+export class ExtractCorrectToolkit {
+    constructor(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/package.json

@@ -1,6 +1,42 @@
 {
   "name": "@xyz17711/extract-correct",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Generated typed client for the 🩹 extract-correct-service 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,55 @@
+/**
+ * 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

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

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

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

@@ -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"
+  ]
+}