@xyz17711/sanctions-check 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,87 @@
-# Temporary Holding Version
+# @xyz17711/sanctions-check
 
-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/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
+[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/sanctions-check
+```
+
+## Methods
+
+| Method | Description |
+| --- | --- |
+| `screenName` | 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) |
+
+## Quickstart
+
+```typescript
+import { Client } from "@xyz17711/sanctions-check";
+
+const client = new Client("https://api.17711.xyz/registry/🚫 sanctions-check-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/sanctions-check";
+
+const client = new Client("https://api.17711.xyz/registry/🚫 sanctions-check-service");
+try {
+  await client.screenName(/* ... */);
+} 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/sanctions-check";
+
+const client = new Client("https://api.17711.xyz/registry/🚫 sanctions-check-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/sanctions-check";
+import { SanctionsCheckToolkit } from "@xyz17711/sanctions-check/langchain";
+
+const client = new Client("https://api.17711.xyz/registry/🚫 sanctions-check-service", { /* ...wallet options... */ });
+const tools = new SanctionsCheckToolkit(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/sanctions-check/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,71 @@
+/**
+ * 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 declare 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) */
+    screenName(request: ScreenNameRequest): Promise<ScreenNameResponse>;
+}
+export { ClientOptions };

package/dist/index.js

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

package/dist/langchain.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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";
+export declare class SanctionsCheckToolkit {
+    private client;
+    constructor(client: Client);
+    getTools(): import("@langchain/core/tools").DynamicStructuredTool<z.ZodObject<{
+        birth_year: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        name: z.ZodString;
+        type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>, {
+        name: string;
+        birth_year?: number | null | undefined;
+        type?: string | null | undefined;
+    }, {
+        name: string;
+        birth_year?: number | null | undefined;
+        type?: string | null | undefined;
+    }, import("./index.js").ScreenNameResponse, unknown, "screenName">[];
+}

package/dist/langchain.js

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

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

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

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

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

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