Skip to content

Commit e4ffd2a

Browse files
committed
docs: add changelog for v0.2.1
1 parent f017dbd commit e4ffd2a

1 file changed

Lines changed: 58 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
---
8+
9+
## [0.2.1] - 2025-10-14
10+
### Added
11+
- **PeerJS standalone defaults**
12+
- Built-in configuration compatible with Wind’s production signaling service:
13+
- `host=core.windcrypto.com`
14+
- `port=443`
15+
- `secure=true`
16+
- `path='/'`
17+
- `key='peerjs'`
18+
- **Server configuration helpers**
19+
- `configureForCore()` – instantly configure connection for Wind’s main backend.
20+
- `setServer()`, `setPath()`, `setKey()`, `setSecure()`, and `setPort()` for granular overrides.
21+
- **ICE / TURN utilities**
22+
- `addIceServer()`, `setIceServers()`, and `clearIceServers()` for dynamic WebRTC setups.
23+
- Automatic TURN validation to prevent missing credentials (`username` / `credential`).
24+
- **Event system**
25+
- Re-emits PeerJS events: `open`, `close`, `disconnected`, `error`, and `session`.
26+
- **Session persistence**
27+
- Automatically reuses valid sessions via `sessionStorage` (with `exp` and `sig`).
28+
29+
### Changed
30+
- TypeScript refactor and dual-build system (ESM + CJS + Type definitions).
31+
- Re-login logic now restores wallet session if still valid.
32+
- Improved error handling and event propagation.
33+
34+
### Fixed
35+
- Prevented WebRTC error: “Both username and credential are required when the URL scheme is turn/turns.”
36+
- Cleared expired sessions from storage automatically.
37+
- Improved decoding and validation of `IdentityProof` objects.
38+
39+
---
40+
41+
## [0.1.1] - 2025-08-12
42+
### Added
43+
- **Initial public release of WindKit.**
44+
- A protocol for connecting Vexanium DApps to the Wind wallet.
45+
- Core features:
46+
- Cross-device login via VSR (Vexanium Signing Request).
47+
- Transaction signing (single or multiple actions).
48+
- Message signing.
49+
- Shared secret (ECDH) encryption.
50+
- PeerJS-based WebRTC signaling.
51+
- Published package: [`windkit`](https://www.npmjs.com/package/windkit).
52+
53+
---
54+
55+
### 🧩 Links
56+
- **Repository:** [https://github.com/windvex/windkit](https://github.com/windvex/windkit)
57+
- **npm:** [https://www.npmjs.com/package/windkit](https://www.npmjs.com/package/windkit)
58+
- **License:** [MIT](./LICENSE)

0 commit comments

Comments
 (0)