[ENH] reset back to previous JS api, keeping other improvements

[jeffchuber]

Description of changes

Upon further discussion - we decided we preferred the object-oriented JS API given our design constraints.

This PR reverts the api to the previous design while keeping the other improvements introduced in #2542

Test plan

Existing JS client test coverage

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs repository?

Yes

[github-actions]

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

• Can you think of any use case in which the code does not behave as intended? Have they been tested?
• Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
• If appropriate, are there adequate property based tests?
• If appropriate, are there adequate unit tests?
• Should any logging, debugging, tracing information be added or removed?
• Are error messages user-friendly?
• Have all documentation changes needed been made?
• Have all non-obvious changes been commented?

System Compatibility

• Are there any potential impacts on other parts of the system or backward compatibility?
• Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

• Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

[jeffchuber]

this has to be public for the Collection object to use it.

we could pass the api object to Collection - but i like the idea that if you change some client settings, that all Collection objects created through that client will start using these settings.

[codetheweb]

I worry a little that this could confuse users who see this pop up in their autocomplete, but I don't think there's a great solution besides making a third wrapper class over api. Not a blocking issue.

[jeffchuber]

yea - there is a way to pseudo-hide it using some typescript f****ery - but I think that is worse and less maintainable. what about renaming it to something like _InternalApi?

[codetheweb]

yeah underscoring seems like a good option for now

[jeffchuber]

this also can no longer be private.

[jeffchuber]

@codetheweb my todos (not blocking your review)

• ensure docs generation from the code works and looks good
• figure out why that linter didnt pass and caused a failed test

[codetheweb]

I worry a little that this could confuse users who see this pop up in their autocomplete, but I don't think there's a great solution besides making a third wrapper class over api. Not a blocking issue.

[spikechroma]

• [CLN] Broken JS test fix exploration #2756
• [ENH] reset back to previous JS api, keeping other improvements #2714 👈
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @jeffchuber and the rest of your teammates on Graphite