@aryze/reforge
Version:
TypeScript SDK for Aryze Reforge cross-chain bridge protocol
68 lines (57 loc) • 2.83 kB
Markdown
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Changed
- **BREAKING**: SDK now requires explicit configuration before use
- **BREAKING**: Changed `configure()` method to `config()`
- **BREAKING**: Both `apiKey` and `apiUrl` are now required parameters
- **BREAKING**: Removed hardcoded default API URLs and automatic environment variable loading
- **BREAKING**: SDK will throw error if used without proper configuration
- **BREAKING**: Package renamed from `reforge-sdk` to `@aryze/reforge` (scoped package)
- Switched to pnpm as the default package manager for development and CI/CD
- Updated all build scripts and GitHub Actions to use pnpm
- Updated documentation to recommend pnpm for installation
- Updated UMD bundle name from `reforge-sdk.min.js` to `reforge.min.js`
- Updated all import/require statements to use new package name `@aryze/reforge`
- Fixed TypeScript compilation issues and added proper type safety
- Updated repository URLs to point to `aryze/reforge` organization
- Added `tslib` dependency for proper TypeScript compilation
- Fixed rollup configuration for modern Node.js versions
### Security
- Removed hardcoded API endpoints and secrets
- Users must explicitly provide their own API credentials
### Development
- Package is now ready for deployment to NPM registry as `@aryze/reforge`
- All build targets (CommonJS, ESM, UMD, TypeScript types) are working correctly
- Tests are updated and passing for core functionality
## [1.0.0] - 2024-01-01
### Added
- Initial release of Reforge SDK
- TypeScript/JavaScript support for Node.js and browser environments
- HTTP client with retry logic and exponential backoff
- Comprehensive error handling with custom error types
- Event system for request lifecycle monitoring
- Built-in authentication with API key support
- Request/response interceptors
- Debug logging capabilities
- Full TypeScript type definitions
- Support for GET, POST, PUT, PATCH, DELETE HTTP methods
- Request timeout and custom headers support
- Comprehensive test suite with Jest
- ESLint and Prettier configuration
- GitHub Actions CI/CD pipeline
- npm and GitHub Packages publishing support
- Rollup build system for multiple output formats (CJS, ESM, UMD)
- Professional documentation and examples
### Dependencies
- axios ^1.6.2 for HTTP requests
### Development Dependencies
- TypeScript 5.2.2
- Jest 29.7.0 for testing
- ESLint 8.54.0 for linting
- Prettier 3.1.0 for code formatting
- Rollup 4.5.0 for bundling
[Unreleased]: https://github.com/aryze/reforge/compare/v1.0.0...HEAD
[1.0.0]: https://github.com/aryze/reforge/releases/tag/v1.0.0