Add Script alias

[marklundin]

Having some discussions with @willeastcott, with the new ESM Script, we want to keep the default script boilerplate as clean as possible. This PR exports an alias for ScriptType named Script

import { Script } from 'playcanvas';

class Rotator extends Script {
  initialize() {
    ...
  }
}

UPDATE:
ScriptType has been added to the deprecation.js file
Improved dicunmentation for Script to include ESM example

I confirm I have read the contributing guidelines and signed the Contributor License Agreement.

[kpal81xd]

What was the reason for this?

[mvaligursky]

Looks good.
Should we rename ScriptType to Script in that module, and export it as ScriptType for compatibility?

[willeastcott]

Should we rename ScriptType to Script in that module, and export it as ScriptType for compatibility?

Yeah, because otherwise, the API ref will continue to show ScriptType. The aliasing should be done in the backwards compatibility module.

[marklundin]

@willeastcott are we happy to simply rename the class and keep the script-type.js filename?

[mvaligursky]

Rename filename as well, we keep those in sync.

[willeastcott]

Maybe do:

• script.js -> script-create.js (or script-register.js)
• script-type.js -> script.js

[willeastcott]

BTW, we should consider deprecating and hiding registerScript.

[mvaligursky]

We also need to consider the impact in the Editor. Will the Editor be able to still use at least few previous engine versions? Do we need to add some type checking to it or similar? Maybe it all just works, but we need to check.

[marklundin]

• script.js -> script-create.js (or script-register.js)
• script-type.js -> script.js

Makes sense, although strictly speaking this would be a breaking change right?

We also need to consider the impact in the Editor. Will the Editor be able to still use at least few previous engine versions? Do we need to add some type checking to it or similar? Maybe it all just works, but we need to check.

Yeah it should be fine, editor only uses ScriptType when parsing and pc.Script === pc.ScriptType

[marklundin]

Actually maybe not a breaking change since we haven't yet published the ESM build . Mainly thinking about `import { Script } from 'playcanvas/framework/script/script-type.js'

[kpal81xd]

Actually maybe not a breaking change since we haven't yet published the ESM build . Mainly thinking about `import { Script } from 'playcanvas/framework/script/script-type.js'

You would never do this normally it would be import { Script } from 'playcanvas'. Theoretically with the way the engine exports the unbundled version you can navigate through all the files to import just that file but its not guaranteed that file names wont change

PR needs more work based on feedback.

[marklundin]

This has now been updated

• Renamed script.js -> script-create.js
• Renamed script-type.js -> script.js
• Updated jsdoc references of {ScriptType} => {Script}

Verified with type docs...

*Note that now ScriptType does not exist, it does not generate a corresponding url. It would be great to retain the original, to indicated to users that it has been renamed

[marklundin]

jsdocs update

[marklundin]

Any more updates on this @willeastcott? Keen to get this merged

[willeastcott]

Nice! LGTM.