fix: make docs not output confusing information in xrpl client

[justinr1234]

High Level Overview of Change

Docs are super confusing today. They don't output the correct information due to how functions are assigned to the class. We're also missing docs for several function. Additionally, there's overuse over overloaded functions which get output as separate functions in the docs page making it cluttered and difficult to follow.

TODO

• add a before and after image of the documentation

Context of Change

• Refactor class methods to live on the class instead of imported and assigned to member variables
• Replace function overloads with typescript conditional types
• Improve jsdoc strings for multiple functions
• Improve missing test for requestNextPage

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Refactor (non-breaking change that only restructures code)
• Tests (You added tests for code that already exists, or your new feature included in this PR)
• Documentation Updates
• Release

Test Plan

• CI passes
• Docs page looks right and works well

Before

After (properly marked as member functions and not variable constants)

Before (submit bare documentation)

After (documentation and examples are shown)

Before (request has a bajillion overloads and is missing an example)

After (request is clean and has example)

Before (multiple client methods missing examples)

After (all client methods have examples)

[justinr1234]

Closes #2337

[justinr1234]

I will add a separate PR to generate the docs

[pdp2121]

Hmm I'm not sure if this is the only way to generate better docs but this solution will make a long index files (most of functions in this file are abstraction, with exception for making a request and connect/disconnect) and also it would be a bit confusing imo to have the fundWallet or autofill files in sugar folder without the fundWallet and autofill function (seems more like utils files for me)

[justinr1234]

Hmm I'm not sure if this is the only way to generate better docs but this solution will make a long index files (most of functions in this file are abstraction, with exception for making a request and connect/disconnect) and also it would be a bit confusing imo to have the fundWallet or autofill files in sugar folder without the fundWallet and autofill function (seems more like utils files for me)

I’m fairly sure this is the only way, but open to another solution if you have one.

Aside from that, I tried to balance making it smaller by refactoring certain internal details to a separate file.

[pdp2121]

Hmm I'm not sure if this is the only way to generate better docs but this solution will make a long index files (most of functions in this file are abstraction, with exception for making a request and connect/disconnect) and also it would be a bit confusing imo to have the fundWallet or autofill files in sugar folder without the fundWallet and autofill function (seems more like utils files for me)

I’m fairly sure this is the only way, but open to another solution if you have one.

Aside from that, I tried to balance making it smaller by refactoring certain internal details to a separate file.

I'm not familiar with docs generation so if that's the only way to output desired output, please go ahead with it.

[ckniffen]

Can you add a before and after image of the documentation?

[socket-security]

New dependencies detected. Learn more about Socket for GitHub ↗︎

Packages	Version	New capabilities	Transitives	Size	Publisher
run-s	0.0.0	None	+0	491 B	mysticatea

[JST5000]

Notes on what I did during the merge to resolve the trickier conflicts:

1. I replaced the fundWallet function that was moved to the Client with the updated version from previous 3.0 changes to remove the HTTP polyfill.
2. I removed a couple lodash imports which spawned from the merge (both from flatMap so switched to the es2019 syntax of .flatMap instead)
3. I made sure to double check that the removed imports in the package.json from other 3.0 changes stayed out

I've become a contributor, so can't review myself

[ckniffen]

What caused this to remove many entries? The only dependency change was "run-s": "^0.0.0", which I would think might add entries and not remove.

[JST5000]

Ah, I may have chosen the wrong version to merge then - there was a package-lock conflict and I assumed the 3.0 version would be shorter.

[JST5000]

I'm not sure why it still changed - but I used the 3.0 version and ran npm i - does that new result look sensible, or is there something I accidentally changed?

[ckniffen]

Try copying the 3.0 version of the file and run npm i again and see what happens

[JST5000]

@ckniffen Just did that again, and this was still the result. I think it's the correct updates now as it's mostly updating things to 'dev' dependencies or updating the 'integrity' line, which seems minor. (Along with adding run-s)