@bootstrapware/sdk
v0.1.3
Published
Shared types, errors, and conventions for Bootstrapware products.
Readme
@bootstrapware/sdk
Shared types, errors, webhook names, and install-snippet helpers for Bootstrapware products. This package does not render a widget and it does not call a hosted API on its own.
Install
pnpm add @bootstrapware/sdkInstall a product package (@bootstrapware/chat, @bootstrapware/onboard, @bootstrapware/answers, and the others) when you want a widget. Depend on @bootstrapware/sdk directly when you are building against the shared contracts.
What it is
One module of the contracts the products share:
- API key classification (
bsw_test_/bsw_live_, publishable and secret) - Error classes and the
{ data }/{ error }HTTP envelope - Product ids
- Webhook event names and payload types
- Config and install-snippet helpers for each product
Product packages that depend on it
These published packages declare a dependency on @bootstrapware/sdk:
@bootstrapware/answers@bootstrapware/chat@bootstrapware/onboard@bootstrapware/core@bootstrapware/company-answers
@bootstrapware/importer, @bootstrapware/feedback, @bootstrapware/comments, and @bootstrapware/rfq do not depend on this package. The hosted service for every product does.
License
MIT. See CHANGELOG.md.
