@xyz17711/sanctions-check 0.1.0 → 0.1.2

package/README.md

@@ -4,7 +4,7 @@
 [![npm](https://img.shields.io/npm/v/@xyz17711/sanctions-check)](https://www.npmjs.com/package/@xyz17711/sanctions-check)
 [![License](https://img.shields.io/npm/l/@xyz17711/sanctions-check)](https://github.com/17711-services/clients/blob/main/LICENSE)
 
-Typed TypeScript client for **🚫 sanctions-check-service**, part of the
+Typed TypeScript client for **sanctions-check-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/sanctions-check
 ```typescript
 import { Client } from "@xyz17711/sanctions-check";
 
-const client = new Client("https://api.17711.xyz/registry/🚫 sanctions-check-service");
+const client = new Client(); // talks to https://api.17711.xyz/registry/sanctions-check-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/sanctions-check-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/sanctions-check";
 
-const client = new Client("https://api.17711.xyz/registry/🚫 sanctions-check-service");
+const client = new Client();
 try {
   await client.screenName(/* ... */);
 } catch (e) {
@@ -54,7 +57,7 @@ own environment/secrets manager, never a literal string in source code:
 ```typescript
 import { Client } from "@xyz17711/sanctions-check";
 
-const client = new Client("https://api.17711.xyz/registry/🚫 sanctions-check-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/sanctions-check";
 import { SanctionsCheckToolkit } from "@xyz17711/sanctions-check/langchain";
 
-const client = new Client("https://api.17711.xyz/registry/🚫 sanctions-check-service", { /* ...wallet options... */ });
+const client = new Client({ /* ...wallet options... */ });
 const tools = new SanctionsCheckToolkit(client).getTools();
 ```
 

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * Typed HTTP client and request/response interfaces for 🚫 sanctions-check-service.
+ * Typed HTTP client and request/response interfaces for sanctions-check-service.
  */
 import { Client as BaseClient, type ClientOptions } from "@xyz17711/core";
 export interface ListStatus {
@@ -63,8 +63,17 @@ export interface ScreenNameRequest {
     /** Restrict the screening to `person`, `entity`, `vessel` or `aircraft`. Omit it to screen everything. */
     type?: string | null;
 }
-/** Typed client for 🚫 sanctions-check-service, e.g. `client.screenName(...)`. */
+/** Production base URL of this service; pass another to self-host or test. */
+export declare const DEFAULT_BASE_URL = "https://api.17711.xyz/registry/sanctions-check-service";
+/** Typed client for sanctions-check-service, e.g. `client.screenName(...)`. */
 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);
     /** Sanctions check: OFAC list check and sanctions screening of a person or company name against OFAC SDN, EU and UN lists (AML KYC) ($0.01, x402) */
     screenName(request: ScreenNameRequest): Promise<ScreenNameResponse>;
 }

package/dist/index.js

@@ -1,9 +1,17 @@
 /**
- * Typed HTTP client and request/response interfaces for 🚫 sanctions-check-service.
+ * Typed HTTP client and request/response interfaces for sanctions-check-service.
  */
 import { Client as BaseClient } from "@xyz17711/core";
-/** Typed client for 🚫 sanctions-check-service, e.g. `client.screenName(...)`. */
+/** Production base URL of this service; pass another to self-host or test. */
+export const DEFAULT_BASE_URL = "https://api.17711.xyz/registry/sanctions-check-service";
+/** Typed client for sanctions-check-service, e.g. `client.screenName(...)`. */
 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);
+    }
     /** Sanctions check: OFAC list check and sanctions screening of a person or company name against OFAC SDN, EU and UN lists (AML KYC) ($0.01, x402) */
     async screenName(request) {
         return this.post("/v1/sanctions-check/screen_name", request);

package/dist/langchain.d.ts

@@ -1,5 +1,5 @@
 /**
- * LangChain.js tools for 🚫 sanctions-check-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 `sanctions-check/langchain`, never from the package root, so importing the base client never requires them installed.
+ * LangChain.js tools for sanctions-check-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 `sanctions-check/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 🚫 sanctions-check-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 `sanctions-check/langchain`, never from the package root, so importing the base client never requires them installed.
+ * LangChain.js tools for sanctions-check-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 `sanctions-check/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/sanctions-check",
-  "version": "0.1.0",
-  "description": "Generated typed client for the 🚫 sanctions-check-service 17711.xyz microservice.",
+  "version": "0.1.2",
+  "description": "Typed TypeScript client for the 17711.xyz Sanctions Check 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/sanctions-check"
+  },
+  "bugs": {
+    "url": "https://github.com/17711-services/clients/issues"
+  },
+  "keywords": [
+    "x402",
+    "usdc",
+    "api-client",
+    "pay-per-call",
+    "ai-agents",
+    "mcp",
+    "langchain",
+    "sanctions-check"
+  ],
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/index.ts

@@ -1,80 +0,0 @@
-/**
- * Typed HTTP client and request/response interfaces for 🚫 sanctions-check-service.
- */
-
-import { Client as BaseClient, type ClientOptions } from "@xyz17711/core";
-
-export interface ListStatus {
-  entries: number;
-  /** When this service last downloaded the list (UTC). */
-  fetched_at: string;
-  list: string;
-  /** Publication date announced by the list itself, when it states one. */
-  published?: string | null;
-}
-
-export interface SanctionMatch {
-  /** Other names the entry is listed under (at most 5). */
-  aliases: string[];
-  /** `true`/`false` when a `birth_year` was given and the entry publishes birth years. */
-  birth_year_consistent?: boolean | null;
-  /** Published years of birth. */
-  birth_years: number[];
-  /** Nationalities or countries, when published. */
-  countries: string[];
-  /** The entry's identifier in that list. */
-  entry_id: string;
-  /** `person`, `entity`, `vessel` or `aircraft`. */
-  kind: string;
-  /** `OFAC SDN`, `EU consolidated` or `UN Security Council`. */
-  list: string;
-  /** The listed primary name. */
-  listed_name: string;
-  /** Date of listing, when published. */
-  listed_on?: string | null;
-  /** `exact`, `close` or `possible`. */
-  match_type: string;
-  /** The name or alias that matched, when it is not the primary name. */
-  matched_alias?: string | null;
-  /** Sanctions programmes or regimes. */
-  programs: string[];
-  /** Published remarks (truncated). */
-  remarks?: string | null;
-  /** 0 to 1: 1 means the same words (any order); lower means a partial or approximate match. */
-  score: number;
-}
-
-export interface ScreenNameResponse {
-  disclaimer: string;
-  /** Lists that could not be loaded: the screening did not cover them. */
-  lists_missing: string[];
-  /** The lists that were screened, with their size and freshness. */
-  lists_screened: ListStatus[];
-  /** The best matches, highest score first (at most 10). */
-  matches: SanctionMatch[];
-  /** The name as screened. */
-  name: string;
-  /** When the screening ran (UTC). */
-  screened_at: string;
-  /** `match` (an exact or close match), `possible_match` (a partial match to review) or `no_match`. */
-  verdict: string;
-}
-
-export interface ScreenNameRequest {
-  /** A person's year of birth. Listed people whose published birth years do not include it are ranked lower and marked `birth_year_consistent: false`. */
-  birth_year?: number | null;
-  /** The name to screen: a person (`Vladimir Putin`, `Putin, Vladimir`) or a company, vessel or organisation. Word order, accents, capitalisation and small spelling variants do not matter. */
-  name: string;
-  /** Restrict the screening to `person`, `entity`, `vessel` or `aircraft`. Omit it to screen everything. */
-  type?: string | null;
-}
-
-/** Typed client for 🚫 sanctions-check-service, e.g. `client.screenName(...)`. */
-export class Client extends BaseClient {
-  /** Sanctions check: OFAC list check and sanctions screening of a person or company name against OFAC SDN, EU and UN lists (AML KYC) ($0.01, x402) */
-  async screenName(request: ScreenNameRequest): Promise<ScreenNameResponse> {
-    return this.post<ScreenNameResponse>("/v1/sanctions-check/screen_name", request);
-  }
-}
-
-export { ClientOptions };

package/src/langchain.ts

@@ -1,28 +0,0 @@
-/**
- * LangChain.js tools for 🚫 sanctions-check-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 `sanctions-check/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 SanctionsCheckToolkit {
-  private client: Client;
-
-  constructor(client: Client) {
-    this.client = client;
-  }
-
-  getTools() {
-    return [
-      tool(
-        async (input) => this.client.screenName(input),
-        {
-          name: "screenName",
-          description: "Sanctions check: OFAC list check and sanctions screening of a person or company name against OFAC SDN, EU and UN lists (AML KYC) ($0.01, x402)",
-          schema: z.object({ birth_year: z.number().nullable().optional(), name: z.string(), type: z.string().nullable().optional() }),
-        },
-      ),
-    ];
-  }
-}

package/test/index.test.mjs

@@ -1,24 +0,0 @@
-/**
- * Verifies every sanctions-check 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("screenName 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/sanctions-check/screen_name");
-    return new Response(JSON.stringify({ disclaimer: "test", lists_missing: [], lists_screened: [], matches: [], name: "test", screened_at: "test", verdict: "test" }), { status: 200 });
-  };
-  try {
-    const client = new Client("https://example.test");
-    const result = await client.screenName({ birth_year: null, name: "test", type: null });
-    assert.ok(result !== undefined);
-  } finally {
-    globalThis.fetch = originalFetch;
-  }
-});

package/test/langchain.test.mjs

@@ -1,16 +0,0 @@
-/**
- * Verifies every sanctions-check 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 { SanctionsCheckToolkit } from "../dist/langchain.js";
-
-test("screenName tool invoke", async () => {
-  globalThis.fetch = async () => new Response(JSON.stringify({ disclaimer: "test", lists_missing: [], lists_screened: [], matches: [], name: "test", screened_at: "test", verdict: "test" }), { status: 200 });
-  const toolkit = new SanctionsCheckToolkit(new Client("https://example.test"));
-  const t = toolkit.getTools().find((x) => x.name === "screenName");
-  const result = await t.invoke({ birth_year: 0, name: "test", type: "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"
-  ]
-}