Additional types

[JamieMagee]

The majority of these types were straightforward to add, and should be self-explanatory to review. However, there were a few places where I had to workaround some issues. I've left comments at the relevant places in the code.

Other than that, I also:

• Added @tsconfig/strictest
• disabled strictNullChecks as it's not really possible to enforce in JavaScript
• Added custom types for:
  • @clearlydefined/spdx as it doesn't ship with them (I will contribute then back to clearlydefined/spdx afterwards)
  • painless-config as the types it ships with are incorrect and the upstream repository is archived
  • winston-azure-application-insights as it doesn't ship with them

[jeffmendoza]

It would be good to have a docs/typescript-usage.md doc that covers

• Where we are in the referenced "migration" documentation
• What we have decided to do and not do
• What the current usage is.

[JamieMagee]

It would be good to have a docs/typescript-usage.md doc that covers

* Where we are in the referenced "migration" documentation

* What we have decided to do and not do

* What the current usage is.

Good idea! But I'll handle that in a separate PR. This one has already grown quite large.

EDIT: @jeffmendoza ready for review #1336

[qtomlinson]

Thank you for the detailed and excellent work! Several of my comments focus on the declaration of private properties or methods in different parts of the code. Let me know if you need any clarification.

[qtomlinson]

Consider omitting private properties from the declaration, cache and defaultTtlSeconds?

[qtomlinson]

Consider omitting private properties from the declaration, _client and _clientReady?

[JamieMagee]

@qtomlinson Thank you for the review. I think I've addressed all your comments. The ones I haven't addressed are related to adding types for private methods. I'll try and reply to all of those here, instead of each comment individually.

It's not necessary to add types for private fields and methods, but I did it for a few reasons:

• Future-proofing for a TypeScript migration
• Better tooling and IDE integration
• I was already here, and it wasn't much additional effort 😅

[qtomlinson]

@JamieMagee Thank you for incorporating the review comments.

Declaring private fields or methods within the types file can reduce readability. For instance, the GradleCoordinatesMapper class contains only two public methods:

map(coordinates: GradleCoordinates): Promise<EntityCoordinates | null>
getMavenMetadata(pluginId: string): Promise<string | FetchResponse<string> | null>

This is easier to understand compared to a scenario where there are 2 public and 8 private methods.

Nonetheless, this is not a critical issue. I appreciate the detailed and excellent changes you've made!