Auth: Change DX of user management

[thorwebdev]

Feature request

Is your feature request related to a problem? Please describe.

As it stands today, you have to do

try {
const {
  body: { user },
} = await supabase.auth.signup(
  'someone@email.com',
  'password'
)
...

To get the user object, and

...} catch (error) {
      console.log('Error message:', error.response.body.error_description);
    } 

to get to the error message.

Describe the solution you'd like

my preferred DX would be

const { error, user } = await supabase.auth.signup(
  'someone@email.com',
  'password'
);
if (error) alert(error);

However, I know that @awalias is a big fan of returning the whole response object, which I personally find rather distracting. Maybe we can do something like

const { error, user, raw_response } = await supabase.auth.signup(
  'someone@email.com',
  'password'
);
if (error) alert(error);

To give folks the option to access the raw object, but not overload folks who don't care about most of the stuff in the raw response. Wdyt? This probably warrants a new issue?

Describe alternatives you've considered

Solve via documentation? Not ideal IMO.

Additional context

Relates to supabase/supabase#143

[awalias]

as mentioned by @kiwicopple will also want to revisit signup(email, password) to allow different types of signup.

and also wrapping https://github.com/netlify/gotrue-js - note here that we may have to fork initially since our own gotrue api has diverged on some details (such as how email/password are passed in body as opposed to query params etc.)

[kiwicopple]

See ongoing PR here for GoTrue changes: supabase/auth-js#1

Should we shift the convo over there and roll the changes into our gotrue-js fork?

[kiwicopple]

Starting the new spec here: https://deploy-preview-210--supabase.netlify.app/ref/gotrue/signup/