https://github.com/syucream/lightdash-client-typescript-fetch
A Lightdash API client library for TypeScript, Fetch API
https://github.com/syucream/lightdash-client-typescript-fetch
lightdash openapi
Last synced: about 2 months ago
JSON representation
A Lightdash API client library for TypeScript, Fetch API
- Host: GitHub
- URL: https://github.com/syucream/lightdash-client-typescript-fetch
- Owner: syucream
- License: mit
- Created: 2024-12-28T11:31:29.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-04-07T09:00:56.000Z (about 2 months ago)
- Last Synced: 2025-04-11T05:09:42.723Z (about 2 months ago)
- Topics: lightdash, openapi
- Language: Shell
- Homepage: https://www.npmjs.com/package/lightdash-client-typescript-fetch
- Size: 71.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Lightdash TypeScript Client based on openapi-fetch
[](https://badge.fury.io/js/lightdash-client-typescript-fetch)
A TypeScript client for the Lightdash API, generated from the official OpenAPI specification using [openapi-fetch](https://github.com/openapi-ts/openapi-typescript).
## Installation
```bash
npm install lightdash-client-typescript-fetch
```
## Usage
```typescript
import createLightdashClient from 'lightdash-client-typescript-fetch';
// Create a client instance
const client = createLightdashClient('https://your-lightdash-instance.com');
// Example: Get projects
const { data, error } = await client.GET('/api/v1/projects');
if (error) {
console.error('Error fetching projects:', error);
} else {
console.log('Projects:', data);
}
```
## Technical Stack
- TypeScript
- [openapi-fetch](https://github.com/openapi-ts/openapi-typescript) - Type-safe API client generator
- [openapi-typescript](https://github.com/openapi-ts/openapi-typescript) - OpenAPI to TypeScript type generator
## Development
1. Clone the repository
2. Install dependencies:
```bash
npm install
```
3. Generate the client code:
```bash
npm run generate
```
4. Build the project:
```bash
npm run build
```
### Code Quality
The project uses ESLint and Prettier for code quality and formatting:
- `npm run lint` - Check code style and potential issues
- `npm run fix` - Automatically fix code style issues
Individual commands are also available:
- `npm run lint:eslint` - Run ESLint checks only
- `npm run lint:prettier` - Run Prettier checks only
- `npm run fix:eslint` - Run ESLint auto-fix
- `npm run fix:prettier` - Run Prettier auto-fix
### Continuous Integration
The project uses GitHub Actions for CI:
- Pull Request Checks:
- Runs linting on all pull requests
- Ensures code quality before merging
- Main Branch CI:
- Runs on merges to main
- Generates client code from the latest OpenAPI spec
- Builds the project
- Uploads build artifacts
## Publishing
This package is published to GitHub Packages. To publish a new version:
1. Update the version in `package.json`
2. Make sure you're authenticated with GitHub Packages
3. Run:
```bash
npm publish
```
## License
MIT