feat: Add TypeScript definitions

[dplewis]

Pull Request

• Report security issues confidentially.
• Any contribution is under this license.
• Link this pull request to an issue.

Issue

Generated types currently break typescript projects

Closes: #9672

Approach

Ensure index.js, ParseServer.js and LiveQuery/ParseLiveQueryServer.js are typed.

[parse-github-assistant]

🚀 Thanks for opening this pull request!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.57%. Comparing base (2f2a92a) to head (630d591).

Additional details and impacted files

@@            Coverage Diff             @@
##            alpha    #9693      +/-   ##
==========================================
- Coverage   93.15%   92.57%   -0.59%     
==========================================
  Files         187      187              
  Lines       15066    15079      +13     
  Branches        0      174     +174     
==========================================
- Hits        14035    13959      -76     
- Misses       1031     1104      +73     
- Partials        0       16      +16     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[yog27ray]

@dplewis use of any as a type should be avoided.

[dplewis]

@yog27ray i know but this is a foundational PR. Feel free to change it after we merge

[mtrezza]

Do the type files need to be manually generated calling npm run build:types and then be committed as part of a PR? Would it be better to generate the type files as part of the release workflow and commit them? Or build the types in the CI and make sure there's no difference to the committed type files, to ensure types are always committed correctly, like with the options definitions.

[mtrezza]

Why add this manual type file instead of waiting until it can be generated? I understand this requires contributors to manually keep this in sync with the code base and reviewers to consider this sync as a review step, right? I'm not sure we can ensure that.

[dplewis]

I tried to do Options/index.js to .ts and it broke the docs. At least we can generate something. It’s almost impossible to turn that file to ts

[mtrezza]

We'll move away from the custom options logic in the future anyway. We could keep the file you added, but I'm sure that it will get out of sync over time. This could then be fixed every now and then if someone complains. A process much like DefinitelyTyped. I don't see it as a viable manual review step however. For contributors we can add it to the contribution guidelines, as least for reference.

[mtrezza]

@dplewis Could you add an entry to the CONTRIBUTING guide which files are currently manually maintained and should be updated manually in case of any change of which namespaces. e.g. Parse.Cloud? Then I think this is good to merge.