Add async init method to set up client

PermanentOrg / node-sdk

Node.js SDK for Permanent.org

GNU Affero General Public License v3.0

4 stars 2 forks source link

Add async init method to set up client #11

Closed andrewatwood closed 3 years ago

andrewatwood commented 3 years ago

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...) Feature
What is the current behavior? (You can also link to an open issue here) No init method, the client doesn't require any setup (as it has no real methods ;) ) beyond credentials
What is the new behavior (if this is a feature change)? Adds an init method that the user must call before proceeding. The init method is required to actually prepare the client to useful things in the session, rather than just validate that the session exists. AuthResource requires ArchiveRepo endpoints to switch to the archive provided in the client config.

andrewatwood commented 3 years ago

I realize now the branch name doesn't match! Realized I had to re-order these changes after starting, whoops.

jasonaowen commented 3 years ago

I've asked @slifty to take a look so I can focus on uploads. Thanks, @slifty!

slifty commented 3 years ago

Reviewing now -- in the mean time it looks like there are some lint errors worth cleaning up!

andrewatwood commented 3 years ago

Lint error cleaned up!

andrewatwood commented 3 years ago

A small bike shed comment around API token in test and the name of the change method of the archive source.

More importantly though: I'm trying to wrap my head around the references to archives inside of the authentication resource. This might be aided by some class-level documentation that indicates what each resource is responsible for.

Left some comments, as well as added some class-level documentation with the same ideas, let me know if it clears anything up or if you'd still like to see some re-organization.

xmunoz commented 3 years ago

Looks like this is stalled. @slifty can you take another look?