Releases: Raw-Fun-Gaming/stake-engine-client
v1.0.7
v1.0.6 - Simplified API & Type System Refactor
🎯 Major API Improvements
This release includes a major refactoring to simplify the API and standardize the type system.
✨ New Simplified Function Names
We've removed the redundant "request" prefix from all function names:
| Old (Deprecated) | New (Recommended) |
|---|---|
requestAuthenticate |
authenticate |
requestBalance |
getBalance |
requestBet |
play |
requestEndRound |
endRound |
requestEndEvent |
endEvent |
requestForceResult |
forceResult |
requestReplay |
replay |
Migration Example:
// Old API (still works, deprecated)
import { requestAuthenticate, requestBet } from 'stake-engine-client';
const auth = await requestAuthenticate();
const bet = await requestBet({ amount: 1.00, mode: 'base' });
// New API (recommended)
import { authenticate, play } from 'stake-engine-client';
const auth = await authenticate();
const result = await play({ amount: 1.00, mode: 'base' });🔧 Type System Standardization
Standardized all TypeScript types to use consistent PascalCase/camelCase naming:
Schema Types:
req_*→*Request(e.g.,req_authenticate→AuthenticateRequest)res_*→*Response(e.g.,res_play→PlayResponse)
Examples:
import type {
AuthenticateResponse,
PlayResponse,
BalanceResponse,
EndRoundResponse,
ReplayResponse
} from 'stake-engine-client';📚 Complete Documentation Update
- ✅ All 23 wiki pages updated with new function names
- ✅ README.md examples updated
- ✅ Demo application rebuilt with new API
- ✅ All code examples across documentation
- ✅ Wiki pages renamed (authenticate.md, play.md, etc.)
🔄 Backward Compatibility
All old request* function names still work with @deprecated warnings. You can migrate at your own pace.
🐛 Fixes
- Fixed
requestReplayresponse structure documentation (noroundwrapper) - Removed redundant version metadata exports
- Cleaned up CLAUDE.md project instructions
📦 What's Changed
- Simplified API with cleaner function names
- Consistent TypeScript type naming throughout
- Complete documentation overhaul
- Demo page updated to use new API
- All backward compatible with deprecation warnings
View Documentation: https://github.com/Raw-Fun-Gaming/stake-engine-client/wiki
Live Demo: https://raw-fun-gaming.github.io/stake-engine-client/
Full Changelog: v1.0.5...v1.0.6
v1.0.5 - Complete Wiki Documentation
📚 Complete Wiki Documentation
This release includes comprehensive wiki documentation with all referenced pages now complete.
New Wiki Pages (10)
- Package Integration - Complete npm installation and usage guide
- URL Parameters - Browser configuration documentation
- StakeEngineClient Class - Low-level client API reference
- Low-Level Fetcher - HTTP client documentation
- TypeScript Types - Complete type reference with examples
- Usage Patterns - Real-world usage examples
- Browser Integration - Browser-specific integration guide
- Node.js Integration - Server-side integration guide
- Common Issues - Comprehensive troubleshooting guide
- Debug Guide - Debugging strategies and tools
Updated Wiki Pages
- Home - Updated with new guide links and better organization
- Getting Started - Renamed to "Getting Started with Demo" for clarity
Documentation Highlights
- ✅ All 23 wiki pages complete with no broken links
- ✅ Comprehensive coverage for both browser and Node.js environments
- ✅ Extensive examples and troubleshooting guides
- ✅ Complete TypeScript type documentation
- ✅ Real-world usage patterns and best practices
Wiki Structure
Getting Started
- Getting Started with Demo - Setup and test with Stake Engine
- Package Integration - Install and use in your project
- URL Parameters - Browser-friendly configuration
Advanced Usage
- StakeEngineClient Class - Custom client instances
- Low-Level Fetcher - Direct HTTP client
- TypeScript Types - Type definitions
Integration Guides
- Browser Integration - Web application usage
- Node.js Integration - Server-side usage
- Usage Patterns - Real-world examples
Troubleshooting
- Common Issues - Solutions to frequent problems
- Debug Guide - Debugging tips and tools
- Status Codes - Complete error reference
View the complete documentation at: https://github.com/Raw-Fun-Gaming/stake-engine-client/wiki
Full Changelog: v1.0.4...v1.0.5
v1.0.4
Improvements
- Improved error handling consistency across all API methods
- Error messages now consistently use response message only
- Better error logging for debugging
🤖 Generated with Claude Code
v1.0.3
Minor improvements and bug fixes.
🤖 Generated with Claude Code
v1.0.2: ES Modules Migration
What's Changed
- 🚀 ES Modules Migration: Converted package to use ES modules with
"type": "module" - ⚙️ TypeScript Updates: Updated to ESNext module system with bundler resolution
- 🏗️ Build Modernization: Aligned with modern JavaScript standards and build tooling
- 📦 Better Compatibility: Improved compatibility with modern bundlers and frameworks
Technical Changes
- Added
"type": "module"to package.json for ES module support - Updated TypeScript config: CommonJS → ESNext module system
- Changed module resolution from "node" to "bundler"
Full Changelog: v1.0.1...v1.0.2
v1.0.1
What's Changed
✨ New Features
- URL Parameter Fallback: Functions now automatically use URL search parameters when options are not provided
- from URL param
- from URL param
- from URL param (defaults to 'en')
- Optional Parameters: Most function parameters are now optional with intelligent fallbacks
- Browser-Friendly: Much easier to use in browser environments with URL-based configuration
🔧 Improvements
- Updated README with comprehensive examples for both URL parameter and explicit parameter usage
- Added CLAUDE.md for future development guidance
- Fixed security workflow issues and updated to latest GitHub Actions
🛠️ Technical Changes
- Added
getUrlParams()helper function for URL parameter extraction - Made options optional for
requestAuthenticate(),requestEndRound(),requestBalance() - Made sessionID/rgsUrl optional for
requestBet(),requestEndEvent(),requestForceResult() - Updated CodeQL to v3, fixed TruffleHog configuration
- Enhanced error messages when required parameters are missing
📚 Documentation
- Updated API documentation to reflect optional parameters
- Added URL parameter usage examples
- Created comprehensive CLAUDE.md for development guidance
Full Changelog: v1.0.0...v1.0.1