hevy-client

An unofficial TypeScript client library for the Hevy API.

Disclaimer: This project is not affiliated with, endorsed by, or associated with Hevy in any way. It is an independent, community-driven open source project.

Installation

npm install @ranzwertig/hevy-client

Usage

import { HevyClient } from "@ranzwertig/hevy-client";

Development

# Install dependencies
npm install

# Build
npm run build

# Lint
npm run lint

# Format
npm run format

Testing

Run unit tests:

npm test

Run the Swagger/OpenAPI snapshot test (requires Playwright and network access):

npm run test:swagger

The swagger test opens the Hevy API docs in a headless browser, extracts the OpenAPI spec, and compares it against a stored snapshot to detect API changes. To update the snapshot after an intentional API change:

npx vitest run --config vitest.swagger.config.ts --update-snapshots

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/my-feature)
3. Make your changes
4. Run linting and tests (npm run lint && npm test)
5. Commit your changes (git commit -m "Add my feature")
6. Push to the branch (git push origin feature/my-feature)
7. Open a pull request

License

This project is licensed under the MIT License.