@xyz17711/ping 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -18,7 +18,7 @@ npm install @xyz17711/ping
18
18
 
19
19
  | Method | Description |
20
20
  | --- | --- |
21
- | `ping` | Echoes back the input plus this process's pid ($0.001, x402) |
21
+ | `ping` | x402 ping: the cheapest end-to-end payment test for an x402 client or agent wallet, returns an echo and the server pid ($0.002, x402) |
22
22
 
23
23
  ## Quickstart
24
24
 
package/dist/index.d.ts CHANGED
@@ -18,7 +18,7 @@ export interface PingRequest {
18
18
  }
19
19
  /** Typed client for ping-service, e.g. `client.ping(...)`. */
20
20
  export declare class Client extends BaseClient {
21
- /** Echoes back the input plus this process's pid ($0.001, x402) */
21
+ /** x402 ping: the cheapest end-to-end payment test for an x402 client or agent wallet, returns an echo and the server pid ($0.002, x402) */
22
22
  ping(request: PingRequest): Promise<PingResult>;
23
23
  }
24
24
  export { ClientOptions };
package/dist/index.js CHANGED
@@ -4,7 +4,7 @@
4
4
  import { Client as BaseClient } from "@xyz17711/core";
5
5
  /** Typed client for ping-service, e.g. `client.ping(...)`. */
6
6
  export class Client extends BaseClient {
7
- /** Echoes back the input plus this process's pid ($0.001, x402) */
7
+ /** x402 ping: the cheapest end-to-end payment test for an x402 client or agent wallet, returns an echo and the server pid ($0.002, x402) */
8
8
  async ping(request) {
9
9
  return this.post("/v1/ping", request);
10
10
  }
package/dist/langchain.js CHANGED
@@ -11,7 +11,7 @@ export class PingToolkit {
11
11
  return [
12
12
  tool(async (input) => this.client.ping(input), {
13
13
  name: "ping",
14
- description: "Echoes back the input plus this process's pid ($0.001, x402)",
14
+ description: "x402 ping: the cheapest end-to-end payment test for an x402 client or agent wallet, returns an echo and the server pid ($0.002, x402)",
15
15
  schema: z.object({ delay_ms: z.number().optional(), echo: z.string() }),
16
16
  }),
17
17
  ];
package/package.json CHANGED
@@ -1,7 +1,35 @@
1
1
  {
2
2
  "name": "@xyz17711/ping",
3
- "version": "0.1.0",
4
- "description": "Generated typed client for the ping-service 17711.xyz microservice.",
3
+ "version": "0.1.1",
4
+ "description": "Typed TypeScript client for the 17711.xyz Ping API: pay-per-call, settled in USDC via x402.",
5
+ "license": "MIT",
6
+ "author": "17711 Services",
7
+ "homepage": "https://api.17711.xyz",
8
+ "repository": {
9
+ "type": "git",
10
+ "url": "git+https://github.com/17711-services/clients.git",
11
+ "directory": "node/packages/ping"
12
+ },
13
+ "bugs": {
14
+ "url": "https://github.com/17711-services/clients/issues"
15
+ },
16
+ "keywords": [
17
+ "x402",
18
+ "usdc",
19
+ "api-client",
20
+ "pay-per-call",
21
+ "ai-agents",
22
+ "mcp",
23
+ "langchain",
24
+ "ping"
25
+ ],
26
+ "files": [
27
+ "dist",
28
+ "README.md"
29
+ ],
30
+ "publishConfig": {
31
+ "access": "public"
32
+ },
5
33
  "type": "module",
6
34
  "main": "dist/index.js",
7
35
  "types": "dist/index.d.ts",
package/src/index.ts DELETED
@@ -1,31 +0,0 @@
1
- /**
2
- * Typed HTTP client and request/response interfaces for ping-service.
3
- */
4
-
5
- import { Client as BaseClient, type ClientOptions } from "@xyz17711/core";
6
-
7
- export interface PingResult {
8
- /** Echoes the request's own `echo` field back verbatim. */
9
- echo: string;
10
- /** This process's OS pid -- proves which process instance actually answered (useful behind a load balancer fronting several instances of the same service). */
11
- pid: number;
12
- /** Always `true` -- a client can use this as a trivial liveness/reachability check. */
13
- pong: boolean;
14
- }
15
-
16
- export interface PingRequest {
17
- /** Testkit-only knob (not real business logic): lets a caller simulate a slow tool call, to check whether the server dispatches concurrent calls as independent tasks rather than serializing them. */
18
- delay_ms?: number;
19
- /** Arbitrary text echoed back verbatim in the response's own `echo` field. */
20
- echo: string;
21
- }
22
-
23
- /** Typed client for ping-service, e.g. `client.ping(...)`. */
24
- export class Client extends BaseClient {
25
- /** Echoes back the input plus this process's pid ($0.001, x402) */
26
- async ping(request: PingRequest): Promise<PingResult> {
27
- return this.post<PingResult>("/v1/ping", request);
28
- }
29
- }
30
-
31
- export { ClientOptions };
package/src/langchain.ts DELETED
@@ -1,28 +0,0 @@
1
- /**
2
- * LangChain.js tools for ping-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 `ping/langchain`, never from the package root, so importing the base client never requires them installed.
3
- */
4
-
5
- import { tool } from "@langchain/core/tools";
6
- import { z } from "zod";
7
- import { Client } from "./index.js";
8
-
9
- export class PingToolkit {
10
- private client: Client;
11
-
12
- constructor(client: Client) {
13
- this.client = client;
14
- }
15
-
16
- getTools() {
17
- return [
18
- tool(
19
- async (input) => this.client.ping(input),
20
- {
21
- name: "ping",
22
- description: "Echoes back the input plus this process's pid ($0.001, x402)",
23
- schema: z.object({ delay_ms: z.number().optional(), echo: z.string() }),
24
- },
25
- ),
26
- ];
27
- }
28
- }
@@ -1,24 +0,0 @@
1
- /**
2
- * Verifies every ping 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.
3
- */
4
-
5
- import { test } from "node:test";
6
- import assert from "node:assert/strict";
7
- import { Client } from "../dist/index.js";
8
-
9
- test("ping calls the expected path", async () => {
10
- const originalFetch = globalThis.fetch;
11
- globalThis.fetch = async (url, init = {}) => {
12
- const parsed = new URL(url);
13
- assert.equal((init.method ?? "GET").toUpperCase(), "POST");
14
- assert.equal(parsed.pathname, "/v1/ping");
15
- return new Response(JSON.stringify({ echo: "test", pid: 0, pong: false }), { status: 200 });
16
- };
17
- try {
18
- const client = new Client("https://example.test");
19
- const result = await client.ping({ delay_ms: null, echo: "test" });
20
- assert.ok(result !== undefined);
21
- } finally {
22
- globalThis.fetch = originalFetch;
23
- }
24
- });
@@ -1,16 +0,0 @@
1
- /**
2
- * Verifies every ping 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.
3
- */
4
-
5
- import { test } from "node:test";
6
- import assert from "node:assert/strict";
7
- import { Client } from "../dist/index.js";
8
- import { PingToolkit } from "../dist/langchain.js";
9
-
10
- test("ping tool invoke", async () => {
11
- globalThis.fetch = async () => new Response(JSON.stringify({ echo: "test", pid: 0, pong: false }), { status: 200 });
12
- const toolkit = new PingToolkit(new Client("https://example.test"));
13
- const t = toolkit.getTools().find((x) => x.name === "ping");
14
- const result = await t.invoke({ delay_ms: 0, echo: "test" });
15
- assert.ok(result !== undefined);
16
- });
package/tsconfig.json DELETED
@@ -1,16 +0,0 @@
1
- {
2
- "compilerOptions": {
3
- "target": "ES2020",
4
- "module": "ES2020",
5
- "moduleResolution": "bundler",
6
- "declaration": true,
7
- "outDir": "dist",
8
- "rootDir": "src",
9
- "strict": true,
10
- "esModuleInterop": true,
11
- "skipLibCheck": true
12
- },
13
- "include": [
14
- "src"
15
- ]
16
- }