feat(types): coreEvalEnv

[turadg]

closes: #8643

Description

Provides a typedef file that puts into global env what is available within a Core-Eval

Eslint still needs to have the globals declared. I looked into the eslint-env directive, but that appears not to be extensible and is going away in v9 anyway.

Security Considerations

n/a

Scaling Considerations

n/a

Documentation Considerations

Something to put into docs.agoric.com?

Testing Considerations

CI

Upgrade Considerations

n/a

[dckc]

This looks really handy.

Of all my comments, Pick<Console, ...> is the one I suggest is worth making a change for.

re Upgrade Considerations: this becomes practically available for MN2 devs only once it's published to npm as part of our release process, right?

[dckc]

these things do run on XSnap, so it seems like these should be included:

    Base64: globalThis.Base64, // Present only on XSnap
    URL: globalThis.URL, // Absent only on XSnap

[dckc]

ah. not URL

and leaving Base64 undocumented seems OK, I guess.

[dckc]

The implementation provides a ses VirtualConsole. Is this Console type identical?

Boy is that hard to tell.

To be conservative, maybe Pick<Console, 'debug' | 'log' | 'info' | 'warn' | 'error'> is best?
The rest are noops or reduce to these.

[dckc]

What does this Assert refer to? github finds such a type in @agoric/assert... which seems to be a copy of a type in endo. OK, whatever.

[turadg]

It's getting the global one. I'll specify it's from ses

[dckc]

we're leaving allPowers.modules undocumented on purpose?

agoric-sdk/packages/vats/src/core/boot-chain.js

Lines 17 to 20 in ba3b776

	const modules = {
	behaviors: { ...behaviors },
	utils: { ...utils },
	};

this comment got lost somehow

[dckc]

Documentation Considerations

Something to put into docs.agoric.com?

yes... near https://docs.agoric.com/guides/coreeval/proposal.html
perhaps by way of a typedoc link

[turadg]

this becomes practically available for MN2 devs only once it's published to npm as part of our release process, right?

Yep, it should be available as a dev once this merges to master

[turadg]

@dckc I had to amend the PR because in CI the file reference was looking for coreevalenv not coreEvalEnv. Maybe tsc forces lowercse. On my Mac it worked because the FS is set to case insensitive but it failed in CI. I looked into tsc options and this one seems like it would fix it, but its enabled by default: https://www.typescriptlang.org/tsconfig/#forceConsistentCasingInFileNames

What I did instead was change the filename to kebab case. Probably better anyway.

I tried moving it to the package root so it's not a deep import, but that messed ran into the difference between the eslint and tsconfigs so I backed off. I figure we revisit when we eliminate deep imports from packages.