Inverter / NPM package Template

Bun + Npm + Typescript + Standard Version + Flat Config Linting + Husky + Commit / Release Pipeline

Summary

This package contains the API SDK for Breadcrumb.cash.

Check out the Changelog to see what changed in the last releases.

Install

bun add @quantidexyz/oven-sdk

Install Bun ( bun is the default package manager for this project ( its optional ) ):

# Supported on macOS, Linux, and WSL
curl -fsSL https://bun.sh/install | bash
# Upgrade Bun every once in a while
bun upgrage

Use the SDK

Here's an example of how to use the SDK to fetch a public user:

import { client, user_user } from '@quantidexyz/oven-sdk'

// Set the config for the client with the Base URL and API key
client.setConfig({
  // Base URL is optional, by default it's https://www.breadcrumb.cash/api
  baseUrl: 'https://www.breadcrumb.cash/api',
  // Replace with your cookie connect.sid / if you have one
  headers: {
    Cookie: `connect.sid=<connect.sid>`,
  },
})

// Use the internal method to call the API
const response = await user_user({
  path: {
    x_user_id: '1941253809302593536',
  },
  query: {
    include_smart_followers: 'false',
    include_smart_follower_history: 'false',
  },
})

// Log the response
console.log('API response data:', response.data)

Developing

Install Dependencies:

bun i

Watching TS Problems:

bun watch

How to make a release

For the Maintainer: Add NPM_TOKEN to the GitHub Secrets.

1. PR with changes
2. Merge PR into main
3. Checkout main
4. git pull
5. bun release: '' | alpha | beta optionally add -- --release-as minor | major | 0.0.1
6. Make sure everything looks good (e.g. in CHANGELOG.md)
7. Lastly run bun release:pub
8. Done

License

This package is licensed - see the LICENSE file for details.