Skip to content
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

[Async] Add async types to Player base types for asset level compatibility #467

Open
sugarmanz opened this issue Jul 31, 2024 · 3 comments
Labels
enhancement New feature or request

Comments

@sugarmanz
Copy link
Member

The Player content validator works by consuming Player & Player plugin types. In order to support async assets (using AsyncNodePlugin), we'll need to export the async spec (below) to the base Player types:

{
  "id": "some-async-asset",
  "async": true
}
@sugarmanz sugarmanz added the enhancement New feature or request label Jul 31, 2024
@KetanReddy
Copy link
Member

The base Player types right now don't export a lot of specific information about the inner workings of Player so if we didn't want to define the Async Node type there, we could add it as a transform to in the LSP to just add the async node info to the AssetWrapperOrSwtich type when loaded

@sugarmanz
Copy link
Member Author

That would be interesting -- given that this is functionality powered by an optional plugin, I'd almost opt for this strategy so that we don't conflate core Player types with superfluous types? Is there a way we could configure the validator to conditionally handle async assets if enabled?

@KetanReddy
Copy link
Member

Yep! The LSP supports adding transforms for XLR types that will be loaded in so we could distribute a plugin to do that. It would just be required to load that plugin before loading in any types but that is already a documented requirement.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants