@pumicejs/client

Type-safe client generator for pumice.js APIs.

This package reads the route manifest exposed by ClientGenerationPlugin (default GET /@client) and generates a nested TypeScript client:

• static segments as nested objects
• dynamic segments as .$(param)
• typed .get(), .post(), .put(), .patch(), .delete(), .options() calls

Install

npm install @pumicejs/client

Requires Node.js >=18.

Generate a client

npx pumice-client generate --url http://localhost:3000 --output ./generated/api-client.ts

CLI options

• -u, --url <url> API base URL (default http://localhost:3000)
• -o, --output <path> Output file path (default ./generated/pumice-api-client.ts)
• -m, --manifest-path <path> Manifest endpoint path (default /@client)
• --no-format Skip Prettier formatting
• -d, --debug Enable debug logs
• --allow-request-specific-headers Add optional headers to generated method options
• --export-route-types Export route-specific aliases like PmUsersByIdGetResponseBody
• --type-prefix <prefix> Prefix exported route helper types (default Pm)

Generated exports

Generated client files intentionally export only:

• api
• createClient
• prefixed route helper types like PmRouteType / PmRoutePath

Route-specific request/response types stay internal to keep the public export surface small.

If you want those aliases exported (e.g. PmUsersByIdGetResponseBody), generate with --export-route-types.

Package exports

@pumicejs/client exports a minimal runtime API:

• createClientFactory
• ClientOptions
• RequestExecutor
• ProxyFn
• RequestError
• RequestErrorInfo

Runtime usage

import { api, createClient } from "./generated/api-client";

const users = await api.users.get();
const oneUser = await api.users.$(123).get();

const authed = createClient({
  baseUrl: "https://api.example.com",
  headers: {
    authorization: "Bearer <token>",
  },
});

await authed.users.post({
  body: { name: "Ada" },
});