feat: Add TypeScript definitions

[tbjers]

New Pull Request Checklist

• I am not disclosing a vulnerability.
• I am creating this PR in reference to an issue.

Issue Description

Related issue: #89
Closes: #89

Approach

TODOs before merging

• Add changes to documentation (guides, repository pages, in-code descriptions)

[parse-github-assistant]

I will reformat the title to use the proper commit message syntax.

[parse-github-assistant]

Thanks for opening this pull request!

• 🎉 We are excited about your hands-on contribution!

[codecov]

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (0f26c11) 100.00% compared to head (a98a43a) 100.00%.

❗ Current head a98a43a differs from pull request most recent head 320ce40. Consider uploading reports for the commit 320ce40 to get more accurate results

Additional details and impacted files

@@            Coverage Diff            @@
##           release       #90   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            8         8           
  Lines          546       546           
  Branches        47        47           
=========================================
  Hits           546       546           

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

[mtrezza]

Never mind #90 (comment), this repository has the release branch as the working branch, hence the comment.

[tbjers]

I am not sure if there is a need to update the documentation with anything. Thoughts, @mtrezza?

[mtrezza]

Wouldn't the typescript definition files normally be committed with the repository? Or how are generated?

[tbjers]

They are automatically generated by the npm build command, so they would be generated at the same time as the rest of the code in lib.

…

On Tue, Oct 10, 2023, at 18:30, Manuel wrote: Wouldn't the typescript definition files normally be committed with the repository? Or how are generated? — Reply to this email directly, view it on GitHub <#90 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAIQW7CXBYE4Z2UXJE4KXOLX6XD6RAVCNFSM6AAAAAA522DXWCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONJWGM2TMMJZG4>. You are receiving this because you authored the thread.Message ID: ***@***.***>

[mtrezza]

Got it; regarding docs I don't think there's anything that needs to be added. This doesn't contain any breaking changes for developers who are already using the package, correct?

[tbjers]

Correct.

…

On Tue, Oct 10, 2023, at 19:03, Manuel wrote: Got it; regarding docs I don't think there's anything that needs to be added. This will be a minor release without any breaking changes, correct? — Reply to this email directly, view it on GitHub <#90 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAIQW7D2GQB5GKEBTXTQV3TX6XH5NAVCNFSM6AAAAAA522DXWCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONJWGQYTIMRWHA>. You are receiving this because you authored the thread.Message ID: ***@***.***>

[mtrezza]

@sadortun could you review this PR please? I wonder whether TS files should be committed to the repo as the IDE will need them?

[sadortun]

@mtrezza Yes, the file should be added to the repository.

[tbjers]

@sadortun could you review this PR please? I wonder whether TS files should be committed to the repo as the IDE will need them?

cc: @sadortun The files do not need to be committed to the repository because they will be part of the package tarball as they are generated at the same time as everything else in lib/. My reasoning here is that we do not commit the generated code to the repository, either.

[sadortun]

@tbjers @mtrezza Ah, I was referring to tsconfig.json in this PR. And you're referring to .d.ts 😂

If .d.ts are generated by the build step, then you don't need them in the repo.

[mtrezza]

Thanks @sadortun for confirming, and thanks @tbjers for the PR; I'll go ahead and merge.

[parseplatformorg]

🎉 This pull request has been released in version 3.1.0