@xyz17711/company-check 0.1.0 → 0.1.1

package/README.md

@@ -4,7 +4,7 @@
 [![npm](https://img.shields.io/npm/v/@xyz17711/company-check)](https://www.npmjs.com/package/@xyz17711/company-check)
 [![License](https://img.shields.io/npm/l/@xyz17711/company-check)](https://github.com/17711-services/clients/blob/main/LICENSE)
 
-Typed TypeScript client for **🏢 company-check-service**, part of the
+Typed TypeScript client for **company-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,7 +25,7 @@ npm install @xyz17711/company-check
 ```typescript
 import { Client } from "@xyz17711/company-check";
 
-const client = new Client("https://api.17711.xyz/registry/🏢 company-check-service");
+const client = new Client("https://api.17711.xyz/registry/company-check-service");
 // see the Methods table above for every available call and its request/response type
 ```
 
@@ -38,7 +38,7 @@ network, and payee address attached:
 ```typescript
 import { Client, PaymentRequiredError } from "@xyz17711/company-check";
 
-const client = new Client("https://api.17711.xyz/registry/🏢 company-check-service");
+const client = new Client("https://api.17711.xyz/registry/company-check-service");
 try {
   await client.verifyCompany(/* ... */);
 } catch (e) {
@@ -54,7 +54,7 @@ own environment/secrets manager, never a literal string in source code:
 ```typescript
 import { Client } from "@xyz17711/company-check";
 
-const client = new Client("https://api.17711.xyz/registry/🏢 company-check-service", {
+const client = new Client("https://api.17711.xyz/registry/company-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
@@ -73,7 +73,7 @@ with that same key in this process.
 import { Client } from "@xyz17711/company-check";
 import { CompanyCheckToolkit } from "@xyz17711/company-check/langchain";
 
-const client = new Client("https://api.17711.xyz/registry/🏢 company-check-service", { /* ...wallet options... */ });
+const client = new Client("https://api.17711.xyz/registry/company-check-service", { /* ...wallet options... */ });
 const tools = new CompanyCheckToolkit(client).getTools();
 ```
 

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * Typed HTTP client and request/response interfaces for 🏢 company-check-service.
+ * Typed HTTP client and request/response interfaces for company-check-service.
  */
 import { Client as BaseClient, type ClientOptions } from "@xyz17711/core";
 export interface Company {
@@ -131,7 +131,7 @@ export interface VerifyCompanyRequest {
     /** An EU VAT number with its country prefix (`FR22424761419`, `DE811907980`). */
     vat_number?: string | null;
 }
-/** Typed client for 🏢 company-check-service, e.g. `client.verifyCompany(...)`. */
+/** Typed client for company-check-service, e.g. `client.verifyCompany(...)`. */
 export declare class Client extends BaseClient {
     /** Company check (KYB) and business verification: VAT validation (VIES), LEI lookup, registry status and company directors ($0.009, x402) */
     verifyCompany(request: VerifyCompanyRequest): Promise<VerifyCompanyResponse>;

package/dist/index.js

@@ -1,8 +1,8 @@
 /**
- * Typed HTTP client and request/response interfaces for 🏢 company-check-service.
+ * Typed HTTP client and request/response interfaces for company-check-service.
  */
 import { Client as BaseClient } from "@xyz17711/core";
-/** Typed client for 🏢 company-check-service, e.g. `client.verifyCompany(...)`. */
+/** Typed client for company-check-service, e.g. `client.verifyCompany(...)`. */
 export class Client extends BaseClient {
     /** Company check (KYB) and business verification: VAT validation (VIES), LEI lookup, registry status and company directors ($0.009, x402) */
     async verifyCompany(request) {

package/dist/langchain.d.ts

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

package/src/index.ts

@@ -1,154 +0,0 @@
-/**
- * Typed HTTP client and request/response interfaces for 🏢 company-check-service.
- */
-
-import { Client as BaseClient, type ClientOptions } from "@xyz17711/core";
-
-export interface Company {
-  /** Main activity code (NAF/APE for France). */
-  activity_code?: string | null;
-  address?: string | null;
-  /** Date of closure (YYYY-MM-DD), when closed. */
-  closed_at?: string | null;
-  /** ISO country code of the legal seat. */
-  country: string;
-  /** Date of creation (YYYY-MM-DD). */
-  created_at?: string | null;
-  /** Employee size bracket, e.g. `50-99`. */
-  employees?: string | null;
-  /** SIRET of the head office (France). */
-  head_office_id?: string | null;
-  /** Legal form (`SAS`, `SARL`, ...) or its register code. */
-  legal_form?: string | null;
-  legal_name: string;
-  lei?: string | null;
-  /** Number in the company register (SIREN for France). */
-  registration_number?: string | null;
-  /** Size category: `PME`, `ETI`, `GE`. */
-  size_category?: string | null;
-  /** `active`, `closed` or `unknown`. */
-  status: string;
-  /** Commercial name or acronym, when different. */
-  trade_name?: string | null;
-  vat_number?: string | null;
-}
-
-export interface Director {
-  /** Month and year of birth (`1975-01`) for a person, as published in the register. */
-  born?: string | null;
-  /** `person` or `company`. */
-  kind: string;
-  /** Full name of the person or the legal entity. */
-  name: string;
-  nationality?: string | null;
-  /** Registration number of a legal-entity director. */
-  registration_number?: string | null;
-  /** Role as published (`Président de SAS`, `Directeur Général`, `Commissaire aux comptes titulaire`...). */
-  role: string;
-}
-
-export interface Financial {
-  /** Net result, in euros. */
-  net_result?: number | null;
-  /** Revenue, in euros. */
-  revenue?: number | null;
-  year: number;
-}
-
-export interface Flag {
-  /** Stable code, e.g. `company.closed`, `vat.invalid`, `vat.name_mismatch`, `lei.lapsed`. */
-  code: string;
-  message: string;
-  /** `high`, `medium`, `low` or `info`. */
-  severity: string;
-}
-
-export interface LeiParent {
-  country?: string | null;
-  legal_name: string;
-  lei: string;
-}
-
-export interface LeiRecord {
-  direct_parent?: LeiParent | null;
-  /** Entity status in the LEI register (`ACTIVE`, `INACTIVE`). */
-  entity_status: string;
-  lei: string;
-  next_renewal?: string | null;
-  /** Registration status of the LEI (`ISSUED`, `LAPSED`, ...). */
-  registration_status: string;
-  ultimate_parent?: LeiParent | null;
-}
-
-export interface Candidate {
-  city?: string | null;
-  name: string;
-  registration_number: string;
-  status: string;
-}
-
-export interface VatCheck {
-  /** When the number was validated (UTC). */
-  checked_at: string;
-  /** The number as checked, with country prefix. */
-  number: string;
-  registered_address?: string | null;
-  /** Name registered for the VAT number, when the member state discloses it. */
-  registered_name?: string | null;
-  /** `valid`, `invalid` or `unavailable` (the EU service did not answer: try again later). */
-  status: string;
-}
-
-export interface VerifyCompanyResponse {
-  /** How old this answer is, in seconds (0 for a fresh check). */
-  age_seconds: number;
-  company: Company;
-  /** `high` (identified by a number), `medium` (a clear name match) or `low` (several similar names). */
-  confidence: string;
-  /** What this answer does not cover for the company's country. */
-  coverage_note: string;
-  /** Officers and statutory auditors published in the register (France only). */
-  directors: Director[];
-  /** Revenue and net result of the latest published years (France only). */
-  financials: Financial[];
-  /** Things to know: closed company, invalid VAT number, name mismatch, lapsed LEI. */
-  flags: Flag[];
-  /** `true` when this answer was served from a stored result. */
-  from_cache: boolean;
-  lei?: LeiRecord | null;
-  /** How the company was identified: `lei`, `vat_number`, `registration_number` or `name`. */
-  matched_by: string;
-  /** Other companies that matched a name search (to disambiguate). */
-  other_candidates: Candidate[];
-  /** When the registers were queried (UTC). */
-  retrieved_at: string;
-  /** The registers consulted. */
-  sources: string[];
-  /** VAT number validation, when a VAT number is known. */
-  vat?: VatCheck | null;
-}
-
-export interface VerifyCompanyRequest {
-  /** The company's name (`OVH`, `Mistral AI`). Give at least one of `company_name`, `registration_number`, `vat_number` or `lei`. */
-  company_name?: string | null;
-  /** ISO 3166-1 alpha-2 country code (`FR`, `DE`) to narrow a name or number search. */
-  country?: string | null;
-  /** A Legal Entity Identifier (20 characters). */
-  lei?: string | null;
-  /** The oldest answer you accept, in seconds. Omit it for the default (answers up to 6 hours old); `0` forces a fresh check, including a new VAT validation. */
-  max_age_seconds?: number | null;
-  /** A company registration number: a French SIREN (9 digits) or SIRET (14 digits), or a number from another register (then give `country`). */
-  registration_number?: string | null;
-  /** An EU VAT number with its country prefix (`FR22424761419`, `DE811907980`). */
-  vat_number?: string | null;
-}
-
-/** Typed client for 🏢 company-check-service, e.g. `client.verifyCompany(...)`. */
-export class Client extends BaseClient {
-  /** Company check (KYB) and business verification: VAT validation (VIES), LEI lookup, registry status and company directors ($0.009, x402) */
-  async verifyCompany(request: VerifyCompanyRequest): Promise<VerifyCompanyResponse> {
-    return this.post<VerifyCompanyResponse>("/v1/company-check/verify_company", request);
-  }
-}
-
-export { ClientOptions };

package/src/langchain.ts

@@ -1,28 +0,0 @@
-/**
- * LangChain.js tools for 🏢 company-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 `company-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 CompanyCheckToolkit {
-  private client: Client;
-
-  constructor(client: Client) {
-    this.client = client;
-  }
-
-  getTools() {
-    return [
-      tool(
-        async (input) => this.client.verifyCompany(input),
-        {
-          name: "verifyCompany",
-          description: "Company check (KYB) and business verification: VAT validation (VIES), LEI lookup, registry status and company directors ($0.009, x402)",
-          schema: z.object({ company_name: z.string().nullable().optional(), country: z.string().nullable().optional(), lei: z.string().nullable().optional(), max_age_seconds: z.number().nullable().optional(), registration_number: z.string().nullable().optional(), vat_number: z.string().nullable().optional() }),
-        },
-      ),
-    ];
-  }
-}

package/test/index.test.mjs

@@ -1,24 +0,0 @@
-/**
- * Verifies every company-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("verifyCompany 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/company-check/verify_company");
-    return new Response(JSON.stringify({ age_seconds: 0, company: { activity_code: null, address: null, closed_at: null, country: "test", created_at: null, employees: null, head_office_id: null, legal_form: null, legal_name: "test", lei: null, registration_number: null, size_category: null, status: "test", trade_name: null, vat_number: null }, confidence: "test", coverage_note: "test", directors: [], financials: [], flags: [], from_cache: false, lei: null, matched_by: "test", other_candidates: [], retrieved_at: "test", sources: [], vat: null }), { status: 200 });
-  };
-  try {
-    const client = new Client("https://example.test");
-    const result = await client.verifyCompany({ company_name: null, country: null, lei: null, max_age_seconds: null, registration_number: null, vat_number: null });
-    assert.ok(result !== undefined);
-  } finally {
-    globalThis.fetch = originalFetch;
-  }
-});

package/test/langchain.test.mjs

@@ -1,16 +0,0 @@
-/**
- * Verifies every company-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 { CompanyCheckToolkit } from "../dist/langchain.js";
-
-test("verifyCompany tool invoke", async () => {
-  globalThis.fetch = async () => new Response(JSON.stringify({ age_seconds: 0, company: { activity_code: null, address: null, closed_at: null, country: "test", created_at: null, employees: null, head_office_id: null, legal_form: null, legal_name: "test", lei: null, registration_number: null, size_category: null, status: "test", trade_name: null, vat_number: null }, confidence: "test", coverage_note: "test", directors: [], financials: [], flags: [], from_cache: false, lei: null, matched_by: "test", other_candidates: [], retrieved_at: "test", sources: [], vat: null }), { status: 200 });
-  const toolkit = new CompanyCheckToolkit(new Client("https://example.test"));
-  const t = toolkit.getTools().find((x) => x.name === "verifyCompany");
-  const result = await t.invoke({ company_name: "test", country: "test", lei: "test", max_age_seconds: 0, registration_number: "test", vat_number: "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"
-  ]
-}