zh-web-sdk 2.12.6 → 2.13.1

package/.github/CHANGELOG_TEMPLATE.md

@@ -0,0 +1,73 @@
+# Changelog Entry Template
+
+Use this template when adding a new version to CHANGELOG.md
+
+---
+
+## [X.Y.Z] - YYYY-MM-DD
+
+### Added
+- New feature that allows users to [describe user benefit] [#PR_NUMBER]
+- Another feature description focusing on customer value
+
+### Changed
+- Updated [feature/behavior] to [improvement description]
+- [Behavior change] now [new behavior] instead of [old behavior]
+
+### Deprecated
+- [Feature name] is deprecated and will be removed in version [X.Y.Z]
+- Migration path: Use [alternative approach] instead
+- See [documentation link] for details
+
+### Removed
+- Removed [feature name] (deprecated since version [X.Y.Z])
+- See [migration guide link] for alternatives
+
+### Fixed
+- Fixed issue where [problem description] [#PR_NUMBER]
+- Resolved [bug description] affecting [user impact]
+
+### Security
+- Updated [dependency name] to address [vulnerability type]
+- Fixed [security issue description]
+
+---
+
+## Guidelines
+
+### Writing Tips
+
+1. **Focus on User Impact**
+   - ✅ Good: "Fixed SDK positioning to prevent scrolling issues"
+   - ❌ Avoid: "Refactored internal positioning logic"
+
+2. **Be Specific and Clear**
+   - ✅ Good: "Added bank account linking feature for direct deposits"
+   - ❌ Avoid: "Added new feature"
+
+
+### Breaking Changes
+
+For MAJOR version releases, clearly mark breaking changes:
+
+```markdown
+## [3.0.0] - 2026-XX-XX
+
+### Changed
+- ⚠️ **BREAKING**: Renamed `cryptoBuyJWT` parameter to `jwt` in SDK configuration
+
+**Migration Guide:**
+\`\`\`typescript
+// Before (v2.x)
+const sdk = new ZeroHashSDK({
+  cryptoBuyJWT: token
+})
+
+// After (v3.x)
+const sdk = new ZeroHashSDK({
+  jwt: token
+})
+\`\`\`
+
+See [Migration Guide v2 to v3](link) for full details.
+```

package/CHANGELOG.md

@@ -0,0 +1,87 @@
+# Changelog
+
+All notable changes to the zerohash Web SDK 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).
+
+
+## [2.13.1] - 2026-01-08
+
+### Added
+- Adds new changelog template and guidelines
+
+## [2.13.0] - 2026-01-02
+
+### Fixed
+- Fixed SDK wrapper positioning to prevent it from being scrolled out of view by the parent application [#81]
+- The SDK now uses fixed positioning instead of absolute positioning, ensuring it remains visible even when the parent page scrolls
+
+### Security
+- Updated development dependencies to address security vulnerabilities
+
+## [2.12.6] - 2025-10-27
+
+### Security
+- Addressed security vulnerabilities identified by automated dependency scanning [#78]
+- Updated multiple dependencies to their latest secure versions
+
+## [2.12.5] - 2025-10-22
+
+### Changed
+- Reverted bank transfer feature naming change from v2.12.3 due to compatibility concerns [#77]
+- Restored original `fiat-account-link` terminology for existing integrations
+
+## [2.12.4] - 2025-10-21
+
+### Fixed
+- Improved border styling consistency between mobile and desktop views
+- Enhanced visual appearance across different device types
+
+## [2.12.3] - 2025-10-01
+
+### Changed
+- Renamed fiat account linking feature to "bank-transfer" for improved clarity [#74]
+- Updated terminology to better reflect the feature's purpose
+
+## [2.12.2] - 2025-09-30
+
+### Added
+- New fiat account linking feature for connecting bank accounts [#73]
+- Enables users to link their bank accounts directly through the SDK
+
+## [2.12.1] - 2025-09-11
+
+### Fixed
+- Refined corner styling and border radius for improved visual consistency
+- Enhanced UI polish across SDK components
+
+## [2.12.0] - 2025-07-07
+
+### Added
+- Introduced support for new "PAY" application name [#71]
+- Extended SDK compatibility for additional zerohash product offerings
+
+## [2.11.2] - 2025-07-02
+
+### Changed
+- Improved integration with World App's MiniKit for better mobile experience [#70]
+- Enhanced message passing between SDK and World App mini applications
+- Optimized communication protocol for mobile wallets
+
+## [2.11.1] - 2025-07-02
+
+### Changed
+- Enhanced World App message handling with improved error recovery [#69]
+- Removed overly restrictive origin checks that could block legitimate messages
+- Improved reliability of cross-frame communication
+
+## [2.11.0] - 2025-07-01
+
+### Security
+- Added origin validation for World App event handlers [#68]
+- Enhanced security when processing events from World App integration
+- Prevents potential cross-site scripting attacks through event handling
+
+---
+

package/README.md

@@ -48,6 +48,9 @@ The ZeroHash SDK uses [Semantic Versioning 2.0.0](https://semver.org/). Version
 - **MINOR** version increments when we add new functionality in a backward-compatible manner (e.g., `1.0.0` to `1.1.0`).
 - **PATCH** version increments when we make backward-compatible bug fixes (e.g., `1.0.0` to `1.0.1`).
 
+## Changelog
+[zerohash Documentation Changelog](https://docs.zerohash.com/reference/changelog)
+
 ## Mobile Usage
 For more details on how to use it on mobile apps, please refer to our full documentation: 
-[ZeroHash SDK Documentation](https://docs.zerohash.com/reference/sdk-overview).
+[zerohash SDK Documentation](https://docs.zerohash.com/reference/sdk-overview).

package/RELEASING.md

@@ -0,0 +1,39 @@
+# Release Process
+
+This document describes the process for releasing new versions of the zerohash Web SDK.
+
+## Release Steps
+
+### 1. Update CHANGELOG.md
+
+Add a new version section at the top of `CHANGELOG.md`:
+
+```markdown
+## [X.Y.Z] - YYYY-MM-DD
+
+### Added
+- New feature description [#PR_NUMBER]
+
+### Fixed
+- Bug fix description [#PR_NUMBER]
+
+### Changed
+- Behavior change description
+```
+
+See `.github/CHANGELOG_TEMPLATE.md` for detailed guidelines.
+
+**Commit the changelog:**
+
+```bash
+git add CHANGELOG.md
+git commit -m "docs: update CHANGELOG for vX.Y.Z"
+git push origin main
+```
+
+### 2. Update ReadMe Changelog
+
+1. Go to ReadMe dashboard: https://dash.readme.com/
+2. Navigate to the Changelog section
+3. Create new changelog entry with content from `CHANGELOG.md`
+4. Publish the entry