Libraries & SDKs Overview
Burdenoff maintains several shared libraries and SDKs that are used across multiple products.
Frontend SDK
Repository: /Users/vignesh/official/algoshred/products/burdenoff-fe-sdk
The Burdenoff Frontend SDK provides:
- Common UI components
- Shared utilities
- API client abstractions
- Authentication helpers
- State management patterns
Usage
npm install @burdenoff/fe-sdk
Node.js SDK
Repository: /Users/vignesh/official/algoshred/products/workspaces/workspaces-sdk-node
The Node.js SDK provides:
- Server-side API client
- Authentication helpers
- Database utilities
- Common middleware
Usage
npm install @burdenoff/sdk-node
Python SDK
Repository: /Users/vignesh/official/algoshred/products/workspaces/workspaces-sdk-python
The Python SDK provides:
- API client for Python applications
- Authentication helpers
- Database utilities
- Common decorators
Usage
pip install burdenoff-sdk
Publishing
NPM Packages
Burdenoff maintains 196 npm packages under the @burdenoff scope:
- 101 private packages: Alpha/beta versions and internal tools
- 95 public packages: Stable, production-ready packages
- Scope:
@burdenoff - Registry: npm
- Token: Managed via GitHub Secrets
See NPM Package Management for complete package list and visibility policies.
PyPI Packages
- Organization: burdenoff
- Registry: PyPI (public/private)
- Token: Managed via GitHub Secrets
Development Guidelines
Versioning
All SDKs follow Semantic Versioning:
- Major: Breaking changes
- Minor: New features (backward compatible)
- Patch: Bug fixes
Testing
- Comprehensive unit tests
- Integration tests
- Type checking (TypeScript/mypy)
- Code coverage targets
Documentation
- Inline code documentation
- API reference docs
- Usage examples
- Migration guides
Boilerplates
SDK boilerplates are available in:
/Users/vignesh/official/algoshred/products/boilerpates/boiler-sdk-node/Users/vignesh/official/algoshred/products/boilerpates/boiler-sdk-python