refactor(patterns): Deprecate sloppy interface guard option

[rekmarks]

Refs: #1831, Agoric/agoric-sdk#11931

Description

We wish to visibly deprecate the sloppy option of @endo/patterns interface guards. To avoid an explosion of @typedef blocks, we migrate the @endo/patterns types to TypeScript and then add the minimally required @deprecated tags.

Security Considerations

N/A

Scaling Considerations

N/A

Documentation Considerations

N/A

Testing Considerations

This modifies the implementation of the @endo/patterns types, but should not modify them. Since the number of lines changed is larged, we should attempt to convince ourselves that the types are in fact the same.

Compatibility Considerations

N/A

Upgrade Considerations

Deprecates but does not remove the sloppy option. NEWS.md is updated.

[mhofman]

I still prefer to have an export * from './types.js' in index.js (with types.js being a stub export {})

[mhofman]

This should be removed if switching to index.js re-exporting types.js

[mhofman]

FYI I prefer types tests to import from the entrypoint like a dependency would.

[rekmarks]

@mhofman I made your requested changes in 598ce27 but am now getting CI failures during prepack:

➤ YN0000: @endo/patterns@workspace:packages/patterns STDOUT error TS5055: Cannot write file '/home/runner/work/endo/endo/packages/patterns/src/patterns/types.d.ts' because it would overwrite input file.
➤ YN0000: @endo/patterns@workspace:packages/patterns STDOUT error TS5055: Cannot write file '/home/runner/work/endo/endo/packages/patterns/src/types.d.ts' because it would overwrite input file.

I can't seem to find any differences in the tsconfig files of other packages that use your preferred pattern, such as compartment-mapper. Is it the file names that are the problem?

Also, other packages, e.g. daemon appear to use the pattern I first resorted to. Are we trying to move to one vs. the other?

[mhofman]

I think the confusion is where a manual .d.ts / .js pair is needed, and where .ts is sufficicient.

• .d.ts / stub .js only for the entrypoint. No meaningful content, just .d.ts re-exporting .js files, which are actually authored as .ts. There cannot be a .ts of the same name. We usually name this one types-index.{d.ts,js}
• .ts (without any .js sibling) for type definitions. It cannot contain any runtime code. The prepack step will generate a .d.ts file (which should be equivalent to the .ts file), and a .js files (which should be empty).

Does that make sense?

[rekmarks]

@mhofman I see. There were no existing examples of the index-types.* pattern in endo, but I applied it in a2ea252.

[turadg]

LGTM, thanks

[mhofman]

I have not reviewed the actual change of the types.js -> types.ts.