-
Notifications
You must be signed in to change notification settings - Fork 167
Add viewer-settings subpath exposing the vendored viewer's settings api #308
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| /** | ||
| * The viewer's settings api — types, shared defaults, validation and authoring ranges — | ||
| * re-exported from the vendored viewer. Producers building on this package author their | ||
| * experience settings against the exact viewer version embedded in html exports, without | ||
| * needing a viewer dependency of their own. | ||
| */ | ||
| export * from '@playcanvas/supersplat-viewer/settings'; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| /** | ||
| * Packaging tests for the viewer-settings subpath re-export. | ||
| */ | ||
|
|
||
| import assert from 'node:assert'; | ||
| import { existsSync } from 'node:fs'; | ||
| import { dirname, join } from 'node:path'; | ||
| import { describe, it } from 'node:test'; | ||
| import { fileURLToPath } from 'node:url'; | ||
|
|
||
| import * as viewer from '@playcanvas/supersplat-viewer/settings'; | ||
|
|
||
| // self-referencing import: resolves through this package's exports map, as a consumer would | ||
| import * as reexport from '@playcanvas/splat-transform/viewer-settings'; | ||
|
|
||
| const __dirname = dirname(fileURLToPath(import.meta.url)); | ||
|
|
||
| describe('viewer-settings subpath', () => { | ||
| it('re-exports the complete viewer settings api', () => { | ||
|
slimbuck marked this conversation as resolved.
|
||
| for (const key of Object.keys(viewer)) { | ||
| assert.ok(key in reexport, `missing export: ${key}`); | ||
| } | ||
| }); | ||
|
|
||
| it('agrees with the viewer on shared defaults', () => { | ||
| assert.deepStrictEqual(reexport.defaultSettings(), viewer.defaultSettings()); | ||
| assert.deepStrictEqual(reexport.defaultPostEffectSettings(), viewer.defaultPostEffectSettings()); | ||
| }); | ||
|
|
||
| it('ships a flattened declaration next to the bundle', () => { | ||
| assert.ok(existsSync(join(__dirname, '..', 'dist', 'viewer-settings.d.ts')), | ||
| 'dist/viewer-settings.d.ts should be copied by the build'); | ||
| }); | ||
| }); | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.