Skip to main content

​
Semantic versioning

Official Bachs SDKs follow semantic versioning. For a version MAJOR.MINOR.PATCH:
  • Major releases can break your code, for example by renaming a method or changing a type. Read the changelog before you upgrade.
  • Minor releases add features, such as a new resource or method, without breaking existing code.
  • Patch releases fix bugs.
A version with a hyphen, such as 1.1.0-rc.1, is a pre-release. Pre-releases are published under the npm next tag, so npm install @bachs/sdk never installs one. Install one by name only when you want to try it.

​
SDK and API versions

The SDK version and the API version are separate. The API is versioned in its path, /v1. SDK 1.x calls API /v1. When the API adds a field, you can read it from the response before an SDK release types it: responses keep fields the SDK does not know about yet. When the API adds an endpoint, the SDK adds it in a minor release. Until then, call the endpoint directly.

​
Supported runtimes

The SDK uses the fetch and crypto built into Node.js. It is for servers only and does not support browsers.

​
Upgrade

Check the version you have:
Update within your current major version:
Every release is listed in the changelog. Major releases are also announced in the product changelog.
@bachs/sdk version 0.0.1 is an empty placeholder. If your lockfile has it, upgrade to 1.0.0 or later.