@forsyteco/actionstep-client-typescript
v0.1.0
Published
TypeScript Actionstep API client generated with Hey API.
Readme
Actionstep Client TypeScript
TypeScript Actionstep API clients generated from the official OpenAPI YAML files using Hey API.
This package generates one client module per Actionstep domain under src/clients/<endpoint> and exports them all through src/index.ts.
Install
npm install @forsyteco/actionstep-client-typescriptDevelopment
npm install
npm run generate
npm run lint
npm run buildRegenerate Clients
npm run generateThe generation flow:
- Runs spec preflight checks against every
https://docs.actionstep.com/downloads/<endpoint>.yamlURL. - Runs Hey API with one generation job per endpoint.
- Refreshes
src/index.tsandsrc/clients/index.tsbarrel exports from the manifest.
Manifest
The endpoint list is defined in openapi/manifest.ts.
Add/remove endpoints in that file, then rerun:
npm run generate- Generated clients are intended to be treated as build artifacts.
- Re-run generation whenever Actionstep updates their published YAML specs.
Publish Checklist
npm run generate
npm run pack:check
npm run publish:publicprepack runs automatically during pack/publish, so lint/build happen before publishing without committing dist.
Release Commands
# choose one semantic version bump
npm run release:patch
npm run release:minor
npm run release:majorCI Publish (npm token)
Set NPM_TOKEN in your CI secret store, then run:
npm ci
npm run generate
npm run lint
npm run build
npm run pack:check
npm run publish:public