Pinnate Docs

GitHubApp

TypeScript SDK

Configure and publish a TypeScript / npm SDK target.

Generates a NodeNext ESM TypeScript client for npm.

Target settings

Setting

Purpose

Package name

npm name (for example @acme/payments)

Description

Optional package description

Typical install after publish:

npm install @acme/payments

Build output

The generator emits TypeScript sources, package.json ("type": "module"), and tsconfig suited to NodeNext resolution. Review the PR from a connected GitHub/GitLab repo, then publish with your usual npm release workflow.

Good OpenAPI habits

  • Stable operationIds become method names

  • Request/response schemas should be named components when reused

  • Document auth schemes so the client can surface helpers