ESM script base class

[marklundin]

This PR proposes a new Script base class for ESM Scripts. Attributes are declared via jsdoc tags as opposed to Script.attributes.add(). ScriptType class persists for legacy support. The new Script base class:

• does not use the ScriptAttributes class
• does not override class members with getters/setters. Fixes [RFC] JSDoc Script Attributes editor#1148
• is compatible with JSDoc style attributes
• is assigned any attributes based upon the json schema in it's corresponding asset

API Changes

• New ESM Script Class
  A new minimal base. Attributes are declared via jsdoc tags. Runtime attributes via Script.attributes.add() is removed. Fixes ScriptType does not support class syntax #6316

• assignRawToValue - New method that takes a script instance, a schema and value and assigns a new value on the script instance`

• ScriptRegistry.addSchema/getSchema - Stores and fetches an attributes schema from it's associated asset <scriptName, schema>

Files renaming

For consistency, the following files have been renamed
script.js -> script-create.js - Contains legacy pc.createScript() and pc.registerScript()
script.js contains new Script base class
script-type.js contains legacy ScriptType class

Tests

npm run test:karma

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
engine	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 21, 2024 4:05pm

[Maksims]

What would be the impact to users in terms of migrations or API changes?

[marklundin]

What would be the impact to users in terms of migrations or API changes?

pc.createScript() will still work and return a ScriptType which should function in the same way. ESM users will use Script as a base class without any ScriptAttribute functionality (events, rawToValue deep copying)

[willeastcott]

Approving with a final round of comments.