https://github.com/epilot-dev/sdk-js
javascript epilot-sdk
https://github.com/epilot-dev/sdk-js
javascript nodejs sdk typescript
Last synced: about 1 year ago
JSON representation
javascript epilot-sdk
- Host: GitHub
- URL: https://github.com/epilot-dev/sdk-js
- Owner: epilot-dev
- License: mit
- Created: 2022-01-26T23:05:05.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-27T14:01:14.000Z (about 1 year ago)
- Last Synced: 2025-03-27T19:54:33.780Z (about 1 year ago)
- Topics: javascript, nodejs, sdk, typescript
- Language: TypeScript
- Homepage:
- Size: 20 MB
- Stars: 18
- Watchers: 6
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
epilot-sdk
[](https://github.com/epilot-dev/sdk-js/actions?query=workflow%3ACI)
[](https://www.npmjs.com/package/epilot-sdk)
[](https://github.com/epilot-dev/sdk-js/blob/main/)
> ⚠️ **DISCLAIMER!**
>
> The epilot SDK is in `beta`. Missing features, incomplete documentation and breaking API changes are to be expected!
## Quick Start
```sh
npm install --save epilot-sdk
```
```typescript
import { authorizeWithToken } from 'epilot-sdk/auth';
import entityClient from 'epilot-sdk/entity-client';
// authorize client using an access token
authorizeWithToken(entityClient, '');
// use epilot client
await entityClient.createEntity('contact', { first_name: 'Example', last_name: 'Contact' });
```
# Documentation
- [epilot-sdk Docs](https://docs.epilot.io/docs/architecture/sdk)
- [epilot-sdk Reference](https://docs.epilot.io/api)
# Updating clients (epilot internal)
To update a client package with a new API definition, you should have made the changes already on the current API repo.
⚠️ Never modify a client `openapi.json` directly, such approach will most certainly lead to you losing your changes on a future release.
```bash
## navigate into you client folder
cd clients/entity-client
## update openapi.json with the new API spec (if already deployed to prod)
npm run openapi
## shortcut: if the desired openapi spec is still deploying, but will be in prod soon.
npm run openapi
## build and generate new types
npm run typegen && npm run build
## commit your changes
git commit -am 'chore(entity-client): update client with new spec'
## push, tag & release
## ensure you are only bumping the package your changed & the epilot-sdk.
npx lerna publish
```
Depending on whether you have publish access to [epilot-sdk](https://www.npmjs.com/package/epilot-sdk) registry repo or not `epilot-sdk` may fail with 403, which will leave some unstaged package.json's with a gitHead entry. Feel free to discard those files–the pipeline will pick up the changes an publish the `epilot-sdk` automatically.
# Contributing
The epilot Javascript SDK is free and open source software. PRs welcome!
🚀