@xyz17711/contact-finder 0.1.0 → 0.1.1

package/README.md

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

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * Typed HTTP client and request/response interfaces for 📇 contact-finder-service.
+ * Typed HTTP client and request/response interfaces for contact-finder-service.
  */
 import { Client as BaseClient, type ClientOptions } from "@xyz17711/core";
 export interface Contact {
@@ -68,7 +68,7 @@ export interface GetContactsRequest {
     /** The oldest result you accept, in seconds. Omit it for the default (results up to 12 hours old); `0` forces a fresh read of the website. The response always says how old it is. */
     max_age_seconds?: number | null;
 }
-/** Typed client for 📇 contact-finder-service, e.g. `client.getContacts(...)`. */
+/** Typed client for contact-finder-service, e.g. `client.getContacts(...)`. */
 export declare class Client extends BaseClient {
     /** Contact finder: public business emails, phone numbers, contact forms and support pages of a domain, with role and source ($0.009, x402) */
     getContacts(request: GetContactsRequest): Promise<GetContactsResponse>;

package/dist/index.js

@@ -1,8 +1,8 @@
 /**
- * Typed HTTP client and request/response interfaces for 📇 contact-finder-service.
+ * Typed HTTP client and request/response interfaces for contact-finder-service.
  */
 import { Client as BaseClient } from "@xyz17711/core";
-/** Typed client for 📇 contact-finder-service, e.g. `client.getContacts(...)`. */
+/** Typed client for contact-finder-service, e.g. `client.getContacts(...)`. */
 export class Client extends BaseClient {
     /** Contact finder: public business emails, phone numbers, contact forms and support pages of a domain, with role and source ($0.009, x402) */
     async getContacts(request) {

package/dist/langchain.d.ts

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

package/src/index.ts

@@ -1,85 +0,0 @@
-/**
- * Typed HTTP client and request/response interfaces for 📇 contact-finder-service.
- */
-
-import { Client as BaseClient, type ClientOptions } from "@xyz17711/core";
-
-export interface Contact {
-  /** `high` (published as a link or in structured data), `medium` or `low`. */
-  confidence: string;
-  /** How it appears there: `mailto`, `text`, `jsonld`, `tel`, `form`, `link`, `probe` (a common address that exists), `security.txt`. */
-  found_in: string;
-  /** `email`, `phone`, `form` (a contact form), `page` (a contact, support or help-centre page), `messaging` (WhatsApp, Telegram, Signal, Messenger), `security` (a vulnerability-reporting contact) or `social` (a profile link). */
-  kind: string;
-  /** The label published next to it (link text or heading), when there is one. */
-  label?: string | null;
-  /** For an e-mail address: whether its domain has mail servers (`false` = it cannot receive mail). */
-  mx_valid?: boolean | null;
-  /** `sales`, `support`, `press`, `jobs`, `legal`, `privacy`, `security`, `billing` or `general`. */
-  role: string;
-  /** The page where it was found. */
-  source_url: string;
-  /** The address, number or link, exactly as published. */
-  value: string;
-}
-
-export interface DomainMail {
-  /** DMARC policy: `reject`, `quarantine`, `none` or `absent`. */
-  dmarc?: string | null;
-  /** Mail servers (MX) of the website's domain, highest priority first (at most 5). */
-  mx: string[];
-  /** Mail platform deduced from the MX records (`google-workspace`, `microsoft-365`, ...). */
-  provider?: string | null;
-  /** SPF policy: `strict` (-all), `soft` (~all), `neutral` (?all), `open` (+all) or `none`. */
-  spf?: string | null;
-}
-
-export interface GetContactsResponse {
-  /** How old this answer is, in seconds (0 for a fresh read). */
-  age_seconds: number;
-  /** Public business contacts: role mailboxes, phones, contact forms, messaging links, security contact and social profiles -- only what is literally published on the pages read. */
-  contacts: Contact[];
-  /** The host that was searched, lowercased, without scheme or path. */
-  domain: string;
-  /** Mail health of the website's own domain: mail servers, platform, SPF and DMARC policies. */
-  domain_mail: DomainMail;
-  /** `true` when this answer was served from a stored result rather than a fresh read. */
-  from_cache: boolean;
-  /** Whether a contact form was found. */
-  has_contact_form: boolean;
-  /** E-mail addresses that look personal (a named individual) or have no recognizable role: they are not returned, only counted. */
-  omitted_non_role_addresses: number;
-  /** How many of the pages used came from a stored copy (fresh enough for `max_age_seconds`). */
-  pages_from_cache: number;
-  /** The pages that were actually read. */
-  pages_read: string[];
-  /** `true` when the website was found from `company_name`. */
-  resolved_from_name: boolean;
-  /** When the website was read to build this list (UTC). */
-  retrieved_at: string;
-  /** The first security contact published (security.txt), when there is one. */
-  security_contact?: string | null;
-  /** Language of the website (ISO 639-1 code). */
-  source_language: string;
-  /** How many pages could not be refreshed and were answered from an older stored copy. */
-  stale_pages: number;
-}
-
-export interface GetContactsRequest {
-  /** The company's name, when you do not know its website (e.g. `Mistral AI`): the official site is looked up first. `domain` wins when both are given. */
-  company_name?: string | null;
-  /** The company's website: a domain such as `stripe.com` or a full URL (`https://stripe.com/`). Give this or `company_name`. */
-  domain?: string | null;
-  /** The oldest result you accept, in seconds. Omit it for the default (results up to 12 hours old); `0` forces a fresh read of the website. The response always says how old it is. */
-  max_age_seconds?: number | null;
-}
-
-/** Typed client for 📇 contact-finder-service, e.g. `client.getContacts(...)`. */
-export class Client extends BaseClient {
-  /** Contact finder: public business emails, phone numbers, contact forms and support pages of a domain, with role and source ($0.009, x402) */
-  async getContacts(request: GetContactsRequest): Promise<GetContactsResponse> {
-    return this.post<GetContactsResponse>("/v1/contact-finder/get_contacts", request);
-  }
-}
-
-export { ClientOptions };

package/src/langchain.ts

@@ -1,28 +0,0 @@
-/**
- * LangChain.js tools for 📇 contact-finder-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 `contact-finder/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 ContactFinderToolkit {
-  private client: Client;
-
-  constructor(client: Client) {
-    this.client = client;
-  }
-
-  getTools() {
-    return [
-      tool(
-        async (input) => this.client.getContacts(input),
-        {
-          name: "getContacts",
-          description: "Contact finder: public business emails, phone numbers, contact forms and support pages of a domain, with role and source ($0.009, x402)",
-          schema: z.object({ company_name: z.string().nullable().optional(), domain: z.string().nullable().optional(), max_age_seconds: z.number().nullable().optional() }),
-        },
-      ),
-    ];
-  }
-}

package/test/index.test.mjs

@@ -1,24 +0,0 @@
-/**
- * Verifies every contact-finder 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("getContacts 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/contact-finder/get_contacts");
-    return new Response(JSON.stringify({ age_seconds: 0, contacts: [], domain: "test", domain_mail: { dmarc: null, mx: [], provider: null, spf: null }, from_cache: false, has_contact_form: false, omitted_non_role_addresses: 0, pages_from_cache: 0, pages_read: [], resolved_from_name: false, retrieved_at: "test", security_contact: null, source_language: "test", stale_pages: 0 }), { status: 200 });
-  };
-  try {
-    const client = new Client("https://example.test");
-    const result = await client.getContacts({ company_name: null, domain: null, max_age_seconds: null });
-    assert.ok(result !== undefined);
-  } finally {
-    globalThis.fetch = originalFetch;
-  }
-});

package/test/langchain.test.mjs

@@ -1,16 +0,0 @@
-/**
- * Verifies every contact-finder 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 { ContactFinderToolkit } from "../dist/langchain.js";
-
-test("getContacts tool invoke", async () => {
-  globalThis.fetch = async () => new Response(JSON.stringify({ age_seconds: 0, contacts: [], domain: "test", domain_mail: { dmarc: null, mx: [], provider: null, spf: null }, from_cache: false, has_contact_form: false, omitted_non_role_addresses: 0, pages_from_cache: 0, pages_read: [], resolved_from_name: false, retrieved_at: "test", security_contact: null, source_language: "test", stale_pages: 0 }), { status: 200 });
-  const toolkit = new ContactFinderToolkit(new Client("https://example.test"));
-  const t = toolkit.getTools().find((x) => x.name === "getContacts");
-  const result = await t.invoke({ company_name: "test", domain: "test", max_age_seconds: 0 });
-  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"
-  ]
-}