Skip to content

chore: various fixes and documentation updates - #7

Merged
HMAZonderland merged 7 commits into
mainfrom
chore/various-fixes
Jul 23, 2025
Merged

chore: various fixes and documentation updates#7
HMAZonderland merged 7 commits into
mainfrom
chore/various-fixes

Conversation

@HMAZonderland

@HMAZonderland HMAZonderland commented Jul 23, 2025

Copy link
Copy Markdown
Contributor

Summary

Various small fixes and documentation updates to improve the client library, including a security vulnerability fix.

Changes

  • Camera reset fix: Use proper reset() command instead of individual commands
  • Demo cleanup: Remove debug flags from example demos
  • README updates: Document all current API features including camera config, UI controls, and snapshot API
  • Code style: Use new ui config object in examples instead of legacy individual properties
  • Security fix: Update dependencies to fix ReDoS vulnerability in @eslint/plugin-kit

Commits

  1. fix: use proper camera reset command in demo
  2. chore: remove debug flag from snapshot demo
  3. chore: remove debug flag from camera controls demo
  4. docs: update README with current API features
  5. refactor: use new ui config style in ui-controls example
  6. chore: update dependencies to fix security vulnerability

All changes are backwards compatible and improve the developer experience.

Security details

  • Fixed ReDoS vulnerability in @eslint/plugin-kit (dev dependency only)
  • Updated eslint-plugin-unicorn to 60.0.0
  • Updated all other dev dependencies to latest versions
  • pnpm audit now shows no vulnerabilities

- Replace individual camera commands with single reset() call
- Camera now resets to model's actual base position
- Fixes issue where reset would go to hardcoded values instead of model defaults
- Remove debug: true from client initialization
- Clean up demo for production use
- Remove debug: true from client initialization
- Fix whitespace formatting
- Add camera configuration options to ClientOptions
- Add UI configuration with new ui object structure
- Document all UI control methods via client.viewer
- Update snapshot API documentation with correct usage
- Reorder methods: camera before snapshot for better flow
- Fix markdown linting issues
- Remove framework-specific examples
- Update client initialization to use ui object
- Group UI options in cleaner structure
- Follows new recommended configuration pattern
@HMAZonderland HMAZonderland self-assigned this Jul 23, 2025
@github-actions

github-actions Bot commented Jul 23, 2025

Copy link
Copy Markdown

Size Change: 0 B

Total Size: 145 kB

ℹ️ View Unchanged
Filename Size
./dist/virtualdisplay.client.cjs.js 42.5 kB
./dist/virtualdisplay.client.es.js 59.8 kB
./dist/virtualdisplay.client.umd.js 42.6 kB

compressed-size-action

@github-actions

github-actions Bot commented Jul 23, 2025

Copy link
Copy Markdown

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 90.56% 1065 / 1176
🔵 Statements 90.56% 1065 / 1176
🔵 Functions 86.3% 145 / 168
🔵 Branches 95.97% 286 / 298
File CoverageNo changed files found.
Generated in workflow #15 for commit 428d759 by the Vitest Coverage Report Action

- Update eslint-plugin-unicorn to 60.0.0
- Update other dev dependencies to latest versions
- Fixes ReDoS vulnerability in @eslint/plugin-kit
@HMAZonderland
HMAZonderland merged commit 325150b into main Jul 23, 2025
3 checks passed
@HMAZonderland
HMAZonderland deleted the chore/various-fixes branch July 23, 2025 21:34
HMAZonderland pushed a commit that referenced this pull request Aug 5, 2025
## [3.7.0](v3.6.0...v3.7.0) (2025-08-05)

### ✨ Features

* dynamic mapping - proxy release ([#9](#9)) ([a95f0e7](a95f0e7)), closes [#8](#8)

### 🔧 Maintenance

* various fixes and documentation updates ([#7](#7)) ([325150b](325150b))
@HMAZonderland

Copy link
Copy Markdown
Contributor Author

🎉 This PR is included in version 3.7.0 🎉

The release is available on:

Your pull request is in this release 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant