@virtualdisplay.io/client 3.6.0 → 4.0.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (21) hide show
  1. package/CHANGELOG.md +46 -74
  2. package/LICENSE +1 -1
  3. package/README.md +278 -340
  4. package/dist/index.d.ts +151 -497
  5. package/dist/virtualdisplay.client.cjs.js +1 -7
  6. package/dist/virtualdisplay.client.cjs.js.map +1 -1
  7. package/dist/virtualdisplay.client.es.js +1 -7859
  8. package/dist/virtualdisplay.client.es.js.map +1 -1
  9. package/dist/virtualdisplay.client.umd.js +1 -7
  10. package/dist/virtualdisplay.client.umd.js.map +1 -1
  11. package/package.json +14 -98
  12. package/README.npm.md +0 -483
  13. package/node_modules/@virtualdisplay-io/logger/CHANGELOG.md +0 -82
  14. package/node_modules/@virtualdisplay-io/logger/LICENSE +0 -21
  15. package/node_modules/@virtualdisplay-io/logger/README.md +0 -314
  16. package/node_modules/@virtualdisplay-io/logger/dist/index.d.ts +0 -167
  17. package/node_modules/@virtualdisplay-io/logger/dist/virtualdisplay.logger.cjs.js +0 -4
  18. package/node_modules/@virtualdisplay-io/logger/dist/virtualdisplay.logger.cjs.js.map +0 -1
  19. package/node_modules/@virtualdisplay-io/logger/dist/virtualdisplay.logger.es.js +0 -377
  20. package/node_modules/@virtualdisplay-io/logger/dist/virtualdisplay.logger.es.js.map +0 -1
  21. package/node_modules/@virtualdisplay-io/logger/package.json +0 -79
package/CHANGELOG.md CHANGED
@@ -1,132 +1,104 @@
1
1
  # Changelog
2
2
 
3
- All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
3
+ ## 4.0.0-alpha.1
4
+
5
+ ### Major Changes
6
+
7
+ Metadata-driven configuration replaces direct scene node manipulation. The client now receives available attributes and values from the server via a mapping message, instead of managing 3D nodes directly.
8
+
9
+ ### Breaking changes
10
+
11
+ - **Attribute-only API**: replaces the previous node-based approach with `select()`, `onChange()`, `getValues()`
12
+ - **Removed `isReady` getter** — use `onReady(callback)` instead
13
+ - **Removed `getQueueStatus`** — no longer part of the public API
14
+ - **Package scope changed** from `@virtualdisplay-io/client` to `@virtualdisplay.io/client`
15
+
16
+ ### New features
17
+
18
+ - Metadata-driven mapping: server sends available attributes and values automatically
19
+ - Camera control API: `camera.rotate()`, `camera.tilt()`, `camera.zoom()`
20
+ - Snapshot API: `snapshot.take()` with `photo.onDeveloped()` callback
21
+ - Viewer configuration: AR, fullscreen, loading indicator controls
22
+ - `onMutationFailed` callback for error handling
23
+
24
+ All notable changes to this project will be documented in this file.
25
+
26
+ ## [3.7.0](https://github.com/virtualdisplay-io/client/compare/v3.6.0...v3.7.0) (2025-08-05)
27
+
28
+ ### ✨ Features
29
+
30
+ - dynamic mapping - proxy release ([#9](https://github.com/virtualdisplay-io/client/issues/9)) ([a95f0e7](https://github.com/virtualdisplay-io/client/commit/a95f0e7a7672b844571b11307637083c6b487f3f)), closes [#8](https://github.com/virtualdisplay-io/client/issues/8)
31
+
32
+ ### 🔧 Maintenance
33
+
34
+ - various fixes and documentation updates ([#7](https://github.com/virtualdisplay-io/client/issues/7)) ([325150b](https://github.com/virtualdisplay-io/client/commit/325150b41bd557e7426e6dae6780cd4fd7660deb))
4
35
 
5
36
  ## [3.6.0](https://github.com/virtualdisplay-io/client/compare/v3.5.1...v3.6.0) (2025-07-23)
6
37
 
7
38
  ### ✨ Features
8
39
 
9
- * add camera configuration support ([#6](https://github.com/virtualdisplay-io/client/issues/6)) ([a6bce4b](https://github.com/virtualdisplay-io/client/commit/a6bce4bfd0d55362e76c893ddf5ed28409dc8bec))
40
+ - add camera configuration support ([#6](https://github.com/virtualdisplay-io/client/issues/6)) ([a6bce4b](https://github.com/virtualdisplay-io/client/commit/a6bce4bfd0d55362e76c893ddf5ed28409dc8bec))
10
41
 
11
42
  ## [3.5.1](https://github.com/virtualdisplay-io/client/compare/v3.5.0...v3.5.1) (2025-07-18)
12
43
 
13
44
  ### ♻️ Code Refactoring
14
45
 
15
- * remove validation of outgoing message types ([#5](https://github.com/virtualdisplay-io/client/issues/5)) ([5f4f985](https://github.com/virtualdisplay-io/client/commit/5f4f9853d65af676aec3a865864f43461fdb6ca5))
46
+ - remove validation of outgoing message types ([#5](https://github.com/virtualdisplay-io/client/issues/5)) ([5f4f985](https://github.com/virtualdisplay-io/client/commit/5f4f9853d65af676aec3a865864f43461fdb6ca5))
16
47
 
17
48
  ## [3.5.0](https://github.com/virtualdisplay-io/client/compare/v3.4.1...v3.5.0) (2025-07-16)
18
49
 
19
50
  ### ✨ Features
20
51
 
21
- * camera control API ([#4](https://github.com/virtualdisplay-io/client/issues/4)) ([1e4c147](https://github.com/virtualdisplay-io/client/commit/1e4c14747cad2a4617c4cc763522b50941adaa7f))
52
+ - camera control API ([#4](https://github.com/virtualdisplay-io/client/issues/4)) ([1e4c147](https://github.com/virtualdisplay-io/client/commit/1e4c14747cad2a4617c4cc763522b50941adaa7f))
22
53
 
23
54
  ## [3.4.1](https://github.com/virtualdisplay-io/client/compare/v3.4.0...v3.4.1) (2025-07-10)
24
55
 
25
56
  ### 🐛 Bug Fixes
26
57
 
27
- * EventBus once handlers and logging improvements ([#3](https://github.com/virtualdisplay-io/client/issues/3)) ([5a99d8d](https://github.com/virtualdisplay-io/client/commit/5a99d8d6ef82d058799734b54c98ca171d17dd36))
58
+ - EventBus once handlers and logging improvements ([#3](https://github.com/virtualdisplay-io/client/issues/3)) ([5a99d8d](https://github.com/virtualdisplay-io/client/commit/5a99d8d6ef82d058799734b54c98ca171d17dd36))
28
59
 
29
60
  ## [3.4.0](https://github.com/virtualdisplay-io/client/compare/v3.3.0...v3.4.0) (2025-07-09)
30
61
 
31
62
  ### ✨ Features
32
63
 
33
- * implement UI configuration via PostMessage CONFIG messages ([#2](https://github.com/virtualdisplay-io/client/issues/2)) ([abc2294](https://github.com/virtualdisplay-io/client/commit/abc229414f9f70c54f37db903c46c0612c5eb6cf))
64
+ - implement UI configuration via PostMessage CONFIG messages ([#2](https://github.com/virtualdisplay-io/client/issues/2)) ([abc2294](https://github.com/virtualdisplay-io/client/commit/abc229414f9f70c54f37db903c46c0612c5eb6cf))
34
65
 
35
66
  ## [3.3.0](https://github.com/virtualdisplay-io/client/compare/v3.2.2...v3.3.0) (2025-07-07)
36
67
 
37
68
  ### ✨ Features
38
69
 
39
- * add isInitial flag to StateMessage ([#50](https://github.com/virtualdisplay-io/client/issues/50)) ([8590354](https://github.com/virtualdisplay-io/client/commit/859035423e161f43791433baac203b2adb95c9fd))
70
+ - add isInitial flag to StateMessage ([#50](https://github.com/virtualdisplay-io/client/issues/50)) ([8590354](https://github.com/virtualdisplay-io/client/commit/859035423e161f43791433baac203b2adb95c9fd))
40
71
 
41
72
  ## [3.2.2](https://github.com/virtualdisplay-io/client/compare/v3.2.1...v3.2.2) (2025-07-01)
42
73
 
43
74
  ### 🐛 Bug Fixes
44
75
 
45
- * change default logger level to warn ([#49](https://github.com/virtualdisplay-io/client/issues/49)) ([a567db2](https://github.com/virtualdisplay-io/client/commit/a567db23a50173e3b167238af2197e545bda6320))
76
+ - change default logger level to warn ([#49](https://github.com/virtualdisplay-io/client/issues/49)) ([a567db2](https://github.com/virtualdisplay-io/client/commit/a567db23a50173e3b167238af2197e545bda6320))
46
77
 
47
78
  ## [3.2.1](https://github.com/virtualdisplay-io/client/compare/v3.2.0...v3.2.1) (2025-06-30)
48
79
 
49
80
  ### 🐛 Bug Fixes
50
81
 
51
- * prevent .env from being used in production builds ([#48](https://github.com/virtualdisplay-io/client/issues/48)) ([7ab54d0](https://github.com/virtualdisplay-io/client/commit/7ab54d02a9aad94daf5a53899fefa9299f9bf73f))
82
+ - prevent .env from being used in production builds ([#48](https://github.com/virtualdisplay-io/client/issues/48)) ([7ab54d0](https://github.com/virtualdisplay-io/client/commit/7ab54d02a9aad94daf5a53899fefa9299f9bf73f))
52
83
 
53
84
  ## [3.2.0](https://github.com/virtualdisplay-io/client/compare/v3.1.0...v3.2.0) (2025-06-27)
54
85
 
55
86
  ### ✨ Features
56
87
 
57
- * publish client package to npm registry ([#45](https://github.com/virtualdisplay-io/client/issues/45)) ([825810b](https://github.com/virtualdisplay-io/client/commit/825810b0ca56da8e50f34f2afac9f75a87acbc40))
88
+ - publish client package to npm registry ([#45](https://github.com/virtualdisplay-io/client/issues/45)) ([825810b](https://github.com/virtualdisplay-io/client/commit/825810b0ca56da8e50f34f2afac9f75a87acbc40))
58
89
 
59
90
  ### 🐛 Bug Fixes
60
91
 
61
- * improve GitHub Actions authentication and remove .env.act ([#47](https://github.com/virtualdisplay-io/client/issues/47)) ([3acc86e](https://github.com/virtualdisplay-io/client/commit/3acc86e5c27a26af0b77cc23ddff397eee141de5))
62
- * use GITHUB_TOKEN for checkout action ([#46](https://github.com/virtualdisplay-io/client/issues/46)) ([f8d60fb](https://github.com/virtualdisplay-io/client/commit/f8d60fba2547950137de10838bcfc874e78d9f33))
92
+ - improve GitHub Actions authentication and remove .env.act ([#47](https://github.com/virtualdisplay-io/client/issues/47)) ([3acc86e](https://github.com/virtualdisplay-io/client/commit/3acc86e5c27a26af0b77cc23ddff397eee141de5))
93
+ - use GITHUB_TOKEN for checkout action ([#46](https://github.com/virtualdisplay-io/client/issues/46)) ([f8d60fb](https://github.com/virtualdisplay-io/client/commit/f8d60fba2547950137de10838bcfc874e78d9f33))
63
94
 
64
95
  ### 📝 Documentation
65
96
 
66
- * update README version reference to v3.1 ([#44](https://github.com/virtualdisplay-io/client/issues/44)) ([1652c15](https://github.com/virtualdisplay-io/client/commit/1652c157890ca43d1e366b302a37f02465d6450b))
97
+ - update README version reference to v3.1 ([#44](https://github.com/virtualdisplay-io/client/issues/44)) ([1652c15](https://github.com/virtualdisplay-io/client/commit/1652c157890ca43d1e366b302a37f02465d6450b))
67
98
 
68
99
  ## [3.1.0](https://github.com/virtualdisplay-io/client/compare/v3.0.0...v3.1.0) (2025-06-25)
69
100
 
70
- ### ⚠ BREAKING CHANGES
71
-
72
- * Complete API redesign with the following changes:
73
- - Removed isReady getter - use onReady callback instead
74
- - Removed getQueueStatus method - internal implementation detail
75
- - Removed toJSON from ModelNode - not needed for public API
76
- - Complete restructure from core/ to src/ with domain-driven design
77
- - New attribute-based API is now the only way to interact with 3D models
78
- - Fire-and-forget messaging pattern for all operations
79
- - JSON Schema validation for mapping configuration
80
-
81
- Features:
82
- - Simplified color configurator demo (300 lines → 160 lines)
83
- - Bundled @virtualdisplay-io/logger package
84
- - Domain-driven directory structure
85
- - Proper error handling with error codes
86
- - Event-driven architecture with EventBus
87
- - onChange callbacks for real-time UI synchronization
88
- - Comprehensive test coverage
89
-
90
- Documentation:
91
- - Complete README rewrite focusing on actual functionality
92
- - Added terminology standards for consistent communication
93
- - Removed unimplemented accessibility claims
94
- - Clear separation between simple and configurable products
95
-
96
- * fix: update lockfile after removing translator dependency
97
-
98
- * docs: update README for v4.0 release
99
-
100
- * fix: add GitHub registry configuration for @virtualdisplay-io scope
101
-
102
- * fix: add npm authentication to bundle-size workflow and package permissions
103
-
104
- * fix: use GITHUB_TOKEN for npm auth and add trailing slash to registry URL
105
-
106
- * chore: update lockfile with fresh install
107
-
108
- * fix: use GH_PAT instead of GITHUB_TOKEN for package authentication
109
-
110
- - Replace GITHUB_TOKEN with GH_PAT in all workflows to avoid conflicts with GitHub's reserved token
111
- - Update CI, release, and bundle-size workflows to use new token variable
112
- - Add .env.act for local testing with act
113
- - Required because GitHub's automatic GITHUB_TOKEN cannot access private organization packages
114
-
115
- * fix: remove push trigger from bundle-size workflow
116
-
117
- - Bundle size analysis should only run on pull requests
118
- - Prevents duplicate runs and confusion about which branch is being tested
119
- - Aligns with CI/CD best practices for PR-based workflows
120
-
121
- ### ✨ Features
122
-
123
- * v4.0.0 - simplified architecture and attribute-only API ([#41](https://github.com/virtualdisplay-io/client/issues/41)) ([dc649c1](https://github.com/virtualdisplay-io/client/commit/dc649c1b863b2427bf6e0350960c4d2e2a2dacb8))
124
-
125
101
  ### 🐛 Bug Fixes
126
102
 
127
- * add missing conventional-changelog-conventionalcommits dependency ([8a15743](https://github.com/virtualdisplay-io/client/commit/8a15743de3984c742ccb5de0537333f321108cd4))
128
- * use NODE_AUTH_TOKEN for npm authentication ([#43](https://github.com/virtualdisplay-io/client/issues/43)) ([c148c6c](https://github.com/virtualdisplay-io/client/commit/c148c6cba6b6b4d1fc431ca5618ad2c3c26638c2))
129
-
130
- ### 🔧 Maintenance
131
-
132
- * trigger release workflow to test GH_PAT secret ([9b07140](https://github.com/virtualdisplay-io/client/commit/9b07140e01d72ccc3774f20733afd197f52c4cde))
103
+ - add missing conventional-changelog-conventionalcommits dependency ([8a15743](https://github.com/virtualdisplay-io/client/commit/8a15743de3984c742ccb5de0537333f321108cd4))
104
+ - use NODE_AUTH_TOKEN for npm authentication ([#43](https://github.com/virtualdisplay-io/client/issues/43)) ([c148c6c](https://github.com/virtualdisplay-io/client/commit/c148c6cba6b6b4d1fc431ca5618ad2c3c26638c2))
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2025 Virtualdisplay
3
+ Copyright (c) 2025-2026 Virtualdisplay
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal