https://github.com/selfagency/teamdynamix-ts
🎟️ teamdynamix-ts – A TypeScript client for the TeamDynamix Web API
https://github.com/selfagency/teamdynamix-ts
js-sdk sdk-js tdx teamdynamix typescript
Last synced: 13 days ago
JSON representation
🎟️ teamdynamix-ts – A TypeScript client for the TeamDynamix Web API
- Host: GitHub
- URL: https://github.com/selfagency/teamdynamix-ts
- Owner: selfagency
- Created: 2026-04-21T03:09:08.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2026-04-22T02:13:43.000Z (about 2 months ago)
- Last Synced: 2026-04-22T02:39:01.486Z (about 2 months ago)
- Topics: js-sdk, sdk-js, tdx, teamdynamix, typescript
- Language: TypeScript
- Homepage: http://teamdynamix-ts.self.agency/
- Size: 345 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# teamdynamix-ts
[](https://github.com/selfagency/teamdynamix-ts/actions/workflows/ci.yml) [](https://codecov.io/gh/selfagency/teamdynamix-ts)
Secure Node-first TypeScript client for the TeamDynamix Web API,
generated from OpenAPI 3.1.
## Quick start
```ts
import { createTeamDynamixClient } from 'teamdynamix-ts';
const { client } = await createTeamDynamixClient({
tenant: 'api',
tokenProvider: async () => process.env.TEAMDYNAMIX_TOKEN ?? '',
environment: 'production',
runtimeValidationMode: 'fail-closed',
});
const accounts = await client.referenceData.accounts();
```
## Documentation
- Browse docs in `docs/` with VitePress.
- Local docs dev server: `pnpm run docs:dev`
- Build docs: `pnpm run docs:build`
- Preview built docs: `pnpm run docs:preview`
### API reference in docs
- Full spec page: `docs/api/spec.md`
- Operation pages: generated from `docs/operations/[operationId].paths.ts`
- Tag pages: generated from `docs/tags/[tag].paths.ts`
## Development commands
- `pnpm run typecheck` — strict TypeScript checks
- `pnpm run lint` — Oxlint
- `pnpm run format:check` — formatting verification
- `pnpm run lint:md` — markdown lint checks
- `pnpm run test` — Vitest suite
## Source of truth
- Canonical OpenAPI spec in repo: `src/spec/openapi.yaml`
- Enriched outputs and reports: `output/`
- Type generation source: `output/openapi-types.json`
- Generated declarations: `src/generated/schema.d.ts`
## More detail
See the full documentation in `docs/` for:
- SDK usage patterns and migration guidance
- Generated API reference
- contributor-focused architecture and workflow guidance