From 2812617d0fd8cce21eff58e92d2ce00311479c6e Mon Sep 17 00:00:00 2001 From: Kang Ming Date: Tue, 30 Aug 2022 13:40:08 +0800 Subject: [PATCH] docs: update auth docs for supabase-js v2 (#8648) * docs: cleanup auth docs * docs: update auth docs * Update spec/supabase_js_v2_legacy.yml Co-authored-by: dng * Update spec/supabase_js_v2_legacy.yml Co-authored-by: dng * Update spec/supabase_js_v2_legacy.yml Co-authored-by: dng * Update spec/supabase_js_v2_legacy.yml Co-authored-by: dng * Update spec/supabase_js_v2_legacy.yml Co-authored-by: dng * Update spec/supabase_js_v2_legacy.yml Co-authored-by: dng * Update spec/supabase_js_v2_legacy.yml Co-authored-by: dng * Update spec/supabase_js_v2_legacy.yml Co-authored-by: dng * Update spec/supabase_js_v2_legacy.yml Co-authored-by: dng * Update spec/supabase_js_v2_legacy.yml Co-authored-by: dng * Update spec/supabase_js_v2_legacy.yml Co-authored-by: dng * Update spec/supabase_js_v2_legacy.yml * update auth docs * add supabase auth admin api overview page * resolve PR comments * resolve PR comments * update auth docs with latest tsdocs Co-authored-by: dng --- .../generated/auth-admin-createuser.mdx | 50 +- .../generated/auth-admin-deleteuser.mdx | 9 +- .../generated/auth-admin-generatelink.mdx | 224 +- .../generated/auth-admin-getuserbyid.mdx | 9 +- .../auth-admin-inviteuserbyemail.mdx | 7 +- .../generated/auth-admin-listusers.mdx | 15 +- .../generated/auth-admin-updateuserbyid.mdx | 45 +- .../generated/auth-getsession.mdx | 4 +- .../_supabase_js/generated/auth-getuser.mdx | 4 +- .../generated/auth-onauthstatechange.mdx | 4 + .../generated/auth-resetpasswordforemail.mdx | 10 +- .../generated/auth-setsession.mdx | 19 +- .../generated/auth-signinwithoauth.mdx | 17 +- .../generated/auth-signinwithotp.mdx | 19 +- .../generated/auth-signinwithpassword.mdx | 14 +- .../_supabase_js/generated/auth-signout.mdx | 6 +- .../_supabase_js/generated/auth-signup.mdx | 25 +- .../generated/auth-updateuser.mdx | 42 +- .../_supabase_js/generated/auth-verifyotp.mdx | 66 +- .../generated/removeallchannels.mdx | 2 +- .../_supabase_js/generated/removechannel.mdx | 2 +- .../generated/supabase-auth-admin-api.mdx | 14 + apps/reference/nav/supabase_js_sidebars.js | 1 + spec/enrichments/tsdoc_v2/combined.json | 8969 ++++--- spec/enrichments/tsdoc_v2/gotrue.json | 19755 +++++++++------- .../tsdoc_v2/gotrue_dereferenced.json | 8969 ++++--- spec/supabase_js_v2_legacy.yml | 148 +- 27 files changed, 21602 insertions(+), 16847 deletions(-) create mode 100644 apps/reference/_supabase_js/generated/supabase-auth-admin-api.mdx diff --git a/apps/reference/_supabase_js/generated/auth-admin-createuser.mdx b/apps/reference/_supabase_js/generated/auth-admin-createuser.mdx index 20d8633252b..e690ec05e4b 100644 --- a/apps/reference/_supabase_js/generated/auth-admin-createuser.mdx +++ b/apps/reference/_supabase_js/generated/auth-admin-createuser.mdx @@ -58,11 +58,11 @@ No description provided.
-A custom data object for app_metadata that. +A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column. Only a service role can modify. -Can be any JSON that includes app-specific info, such as identity providers, roles, and other +The `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other access control information.
@@ -83,7 +83,9 @@ access control information.
-A custom data object for user_metadata that a user can modify. Can be any JSON. +A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column. + +The `data` should be a JSON object that includes user-specific info, such as their first and last name.
@@ -109,26 +111,6 @@ The user's email. -
  • -

    - - email_change_token - - - optional - - - string - -

    -
    - -An email change token. - -
    - -
    • -

  • @@ -143,7 +125,7 @@ An email change token.

    -Sets if a user has confirmed their email address. +Confirms the user's email address if set to true. Only a service role can modify. @@ -205,7 +187,7 @@ The user's phone.
    -Sets if a user has confirmed their phone number. +Confirms the user's phone number if set to true. Only a service role can modify. @@ -227,13 +209,13 @@ Only a service role can modify.
    -A custom data object for user_metadata. - -Can be any JSON. +A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column. Only a service role can modify. -Note: When using the GoTrueAdminApi and wanting to modify a user's user_metadata, +The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name. + +Note: When using the GoTrueAdminApi and wanting to modify a user's metadata, this attribute is used instead of UserAttributes data.
    @@ -248,13 +230,11 @@ this attribute is used instead of UserAttributes data. ## Notes -- Requires a `service_role` key. -- This function should be called on a server. Never expose your `service_role` key in the browser. -- If you do not provide the `email_confirm` and `phone_confirm` options to this function, both will default to false. +- To confirm the user's email address or phone number, set `email_confirm` or `phone_confirm` to true. Both arguments default to false. ## Examples -### Create a new user. +### Create a new user with custom user metadata ```js const { data, error } = await supabase.auth.admin.createUser({ @@ -264,7 +244,7 @@ const { data, error } = await supabase.auth.admin.createUser({ }) ``` -### Auto-confirm email. +### Auto-confirm the user's email ```js const { data, error } = await supabase.auth.admin.createUser({ @@ -273,7 +253,7 @@ const { data, error } = await supabase.auth.admin.createUser({ }) ``` -### Auto-confirm phone. +### Auto-confirm the user's phone number ```js const { data, error } = await supabase.auth.admin.createUser({ diff --git a/apps/reference/_supabase_js/generated/auth-admin-deleteuser.mdx b/apps/reference/_supabase_js/generated/auth-admin-deleteuser.mdx index 637e8524f4e..d7e96b605e4 100644 --- a/apps/reference/_supabase_js/generated/auth-admin-deleteuser.mdx +++ b/apps/reference/_supabase_js/generated/auth-admin-deleteuser.mdx @@ -23,7 +23,7 @@ const { data, error } = await supabase.auth.admin.deleteUser(

  • - uid + id required @@ -34,7 +34,7 @@ const { data, error } = await supabase.auth.admin.deleteUser(

    -The user uid you want to remove. +The user id you want to remove. This function should only be called on a server. Never expose your `service_role` key in the browser. @@ -46,12 +46,11 @@ This function should only be called on a server. Never expose your `service_role ## Notes -- Requires a `service_role` key. -- This function should be called on a server. Never expose your `service_role` key in the browser. +- The `deleteUser()` method requires the user's ID, which maps to the `auth.users.id` column. ## Examples -### Remove a user completely. +### Removes a user ```js const { data, error } = await supabase.auth.admin.deleteUser( diff --git a/apps/reference/_supabase_js/generated/auth-admin-generatelink.mdx b/apps/reference/_supabase_js/generated/auth-admin-generatelink.mdx index 112547c92c1..912ecf90e03 100644 --- a/apps/reference/_supabase_js/generated/auth-admin-generatelink.mdx +++ b/apps/reference/_supabase_js/generated/auth-admin-generatelink.mdx @@ -8,7 +8,7 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Generates links to be sent via email or other. +Generates email links and OTPs to be sent via a custom email provider. ```js const { data, error } = await supabase.auth.admin.generateLink( @@ -27,178 +27,13 @@ const { data, error } = await supabase.auth.admin.generateLink(

  • - GenerateLinkType + GenerateLinkParams required - signup | invite | magiclink | recovery | email_change_current | email_change_new - -

    -
    - -The link type - -
    - -
      -
      Properties
      - -
    • -

      - - email_change_new - - - required - - - literal - -

      -
      - -No description provided. - -
      - -
      • - -
    • -

      - - email_change_current - - - required - - - literal - -

      -
      - -No description provided. - -
      - -
      • - -
    • -

      - - recovery - - - required - - - literal - -

      -
      - -No description provided. - -
      - -
      • - -
    • -

      - - magiclink - - - required - - - literal - -

      -
      - -No description provided. - -
      - -
      • - -
    • -

      - - invite - - - required - - - literal - -

      -
      - -No description provided. - -
      - -
      • - -
    • -

      - - signup - - - required - - - literal - -

      -
      - -No description provided. - -
      - -
      • - -
    - -
    • - -
  • -

    - - email - - - required - - - string - -

    -
    - -The user's email. - -
    - -
    • - -
  • -

    - - options - - - required - - - object + GenerateSignupLinkParams | GenerateInviteOrMagiclinkParams | GenerateRecoveryLinkParams | GenerateEmailChangeLinkParams

    @@ -213,10 +48,10 @@ No description provided.

  • - data + GenerateSignupLinkParams - - optional + + required object @@ -224,7 +59,7 @@ No description provided.

    -Optional user metadata. For signup only. +No description provided.
    @@ -233,18 +68,18 @@ Optional user metadata. For signup only.

  • - password + GenerateRecoveryLinkParams - - optional + + required - string + object

    -User password. For signup only. +No description provided.
    @@ -253,18 +88,38 @@ User password. For signup only.

  • - redirectTo + GenerateInviteOrMagiclinkParams - - optional + + required - string + object

    -The redirect url which should be appended to the generated link +No description provided. + +
    + +
    • + +
  • +

    + + GenerateEmailChangeLinkParams + + + required + + + object + +

    +
    + +No description provided.
    @@ -276,11 +131,6 @@ The redirect url which should be appended to the generated link -## Notes - -- Requires a `service_role` key. -- This function should only be called on a server. Never expose your `service_role` key in the browser. - ## Examples ### Generate a signup link. diff --git a/apps/reference/_supabase_js/generated/auth-admin-getuserbyid.mdx b/apps/reference/_supabase_js/generated/auth-admin-getuserbyid.mdx index 679a72505cf..d4a31673288 100644 --- a/apps/reference/_supabase_js/generated/auth-admin-getuserbyid.mdx +++ b/apps/reference/_supabase_js/generated/auth-admin-getuserbyid.mdx @@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem' Get user by id. ```js -const { user, error } = await supabase.auth.admin.getUserById(1) +const { data, error } = await supabase.auth.admin.getUserById(1) ``` ## Parameters @@ -44,14 +44,13 @@ This function should only be called on a server. Never expose your `service_role ## Notes -- Fetches the user object from the database instead of local storage. -- Note that user() fetches the user object from local storage which might not be the most updated. -- Requires the user's access_token. +- Fetches the user object from the database based on the user's id. +- The `getUserById()` method requires the user's id which maps to the `auth.users.id` column. ## Examples ### Fetch the user object using the access_token jwt. ```js -const { user, error } = await supabase.auth.admin.getUserById(1) +const { data, error } = await supabase.auth.admin.getUserById(1) ``` diff --git a/apps/reference/_supabase_js/generated/auth-admin-inviteuserbyemail.mdx b/apps/reference/_supabase_js/generated/auth-admin-inviteuserbyemail.mdx index 05b02be5a3f..d35c8d80387 100644 --- a/apps/reference/_supabase_js/generated/auth-admin-inviteuserbyemail.mdx +++ b/apps/reference/_supabase_js/generated/auth-admin-inviteuserbyemail.mdx @@ -95,7 +95,7 @@ Optional user metadata
    -A URL or mobile address to send the user to after they are confirmed. +A URL or mobile deeplink to send the user to after they are confirmed.
    @@ -109,12 +109,11 @@ A URL or mobile address to send the user to after they are confirmed. ## Notes -- Requires a `service_role` key. -- This function should only be called on a server. Never expose your `service_role` key in the browser. +- Sends an invite link to the user's email address. ## Examples -### Basic example. +### Invite a user ```js const { data, error } = await supabase.auth.admin.inviteUserByEmail( diff --git a/apps/reference/_supabase_js/generated/auth-admin-listusers.mdx b/apps/reference/_supabase_js/generated/auth-admin-listusers.mdx index ffaaef8e50d..8865b657add 100644 --- a/apps/reference/_supabase_js/generated/auth-admin-listusers.mdx +++ b/apps/reference/_supabase_js/generated/auth-admin-listusers.mdx @@ -13,18 +13,19 @@ Get a list of users. This function should only be called on a server. Never expose your `service_role` key in the browser. ```js -const { data: user, error } = await supabase.auth.admin.listUsers() +const { + data: { users }, + error, +} = await supabase.auth.admin.listUsers() ``` -## Notes - -- Requires a `service_role` key. -- This function should be called on a server. Never expose your `service_role` key in the browser. - ## Examples ### Get a full list of users. ```js -const { data: user, error } = await supabase.auth.admin.listUsers() +const { + data: { users }, + error, +} = await supabase.auth.admin.listUsers() ``` diff --git a/apps/reference/_supabase_js/generated/auth-admin-updateuserbyid.mdx b/apps/reference/_supabase_js/generated/auth-admin-updateuserbyid.mdx index a55efaa8800..d6ca9bd9078 100644 --- a/apps/reference/_supabase_js/generated/auth-admin-updateuserbyid.mdx +++ b/apps/reference/_supabase_js/generated/auth-admin-updateuserbyid.mdx @@ -76,11 +76,11 @@ No description provided.
    -A custom data object for app_metadata that. +A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column. Only a service role can modify. -Can be any JSON that includes app-specific info, such as identity providers, roles, and other +The `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other access control information.
    @@ -101,7 +101,9 @@ access control information.
    -A custom data object for user_metadata that a user can modify. Can be any JSON. +A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column. + +The `data` should be a JSON object that includes user-specific info, such as their first and last name.
    @@ -127,26 +129,6 @@ The user's email.
    • -
  • -

    - - email_change_token - - - optional - - - string - -

    -
    - -An email change token. - -
    - -
    • -

  • @@ -161,7 +143,7 @@ An email change token.

    -Sets if a user has confirmed their email address. +Confirms the user's email address if set to true. Only a service role can modify. @@ -223,7 +205,7 @@ The user's phone.
    -Sets if a user has confirmed their phone number. +Confirms the user's phone number if set to true. Only a service role can modify. @@ -245,13 +227,13 @@ Only a service role can modify.
    -A custom data object for user_metadata. - -Can be any JSON. +A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column. Only a service role can modify. -Note: When using the GoTrueAdminApi and wanting to modify a user's user_metadata, +The `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name. + +Note: When using the GoTrueAdminApi and wanting to modify a user's metadata, this attribute is used instead of UserAttributes data.
    @@ -264,11 +246,6 @@ this attribute is used instead of UserAttributes data. -## Notes - -- Requires a `service_role` key. -- This function should only be called on a server. Never expose your `service_role` key in the browser. - ## Examples ### Updates a user's email. diff --git a/apps/reference/_supabase_js/generated/auth-getsession.mdx b/apps/reference/_supabase_js/generated/auth-getsession.mdx index ce751ce0b5d..5d48abae16e 100644 --- a/apps/reference/_supabase_js/generated/auth-getsession.mdx +++ b/apps/reference/_supabase_js/generated/auth-getsession.mdx @@ -8,8 +8,8 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Returns the session data, refreshing it if necessary. -If no session is detected, the session returned will be null. +Returns the session, refreshing it if necessary. +The session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out. ```js const { data, error } = await supabase.auth.getSession() diff --git a/apps/reference/_supabase_js/generated/auth-getuser.mdx b/apps/reference/_supabase_js/generated/auth-getuser.mdx index a9c49d269e6..c43a4e02a74 100644 --- a/apps/reference/_supabase_js/generated/auth-getuser.mdx +++ b/apps/reference/_supabase_js/generated/auth-getuser.mdx @@ -44,8 +44,8 @@ Takes in an optional access token jwt. If no jwt is provided, getUser() will att ## Notes -- This method gets the user object using the current session. -- Fetches the user object from the database instead of local storage. +- This method gets the user object from the current session. +- Fetches the user object from the database instead of local session. ## Examples diff --git a/apps/reference/_supabase_js/generated/auth-onauthstatechange.mdx b/apps/reference/_supabase_js/generated/auth-onauthstatechange.mdx index f5af3c038ce..d35e657fde6 100644 --- a/apps/reference/_supabase_js/generated/auth-onauthstatechange.mdx +++ b/apps/reference/_supabase_js/generated/auth-onauthstatechange.mdx @@ -42,6 +42,10 @@ A callback function to be invoked when an auth event happens. +## Notes + +- Types of auth events: `SIGNED_IN`, `SIGNED_OUT`, `TOKEN_REFRESHED`, `USER_UPDATED`, `USER_DELETED`, `PASSWORD_RECOVERY` + ## Examples ### Listen to auth changes diff --git a/apps/reference/_supabase_js/generated/auth-resetpasswordforemail.mdx b/apps/reference/_supabase_js/generated/auth-resetpasswordforemail.mdx index ebdec52c8f0..cda380e0313 100644 --- a/apps/reference/_supabase_js/generated/auth-resetpasswordforemail.mdx +++ b/apps/reference/_supabase_js/generated/auth-resetpasswordforemail.mdx @@ -8,7 +8,7 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Sends a reset request to an email address. +Sends a password reset request to an email address. ```js const { error, data } = await supabase.auth.resetPasswordForEmail(email, options: { @@ -95,7 +95,7 @@ Verification token received when the user completes the captcha on the site.
    -A URL to send the user to after they are confirmed. +The URL to send the user to after they click the password reset link.
    @@ -109,15 +109,15 @@ A URL to send the user to after they are confirmed. ## Notes -Sends a reset request to an email address. +Sends a password reset request to an email address. -When the user clicks the reset link in the email they will be forwarded to the site url or the redirect url specified: +When the user clicks the password reset link in the email, they are redirected to the [`SITE_URL`](https://supabase.com/docs/reference/auth/config#site_url) by default. You can modify your `SITE_URL` or add additional redirect URLs in [your project](https://app.supabase.com/project/_/auth/settings). `#access_token=x&refresh_token=y&expires_in=z&token_type=bearer&type=recovery` Your app must detect `type=recovery` in the fragment and display a password reset form to the user. -You should then use the access_token in the url and new password to update the user as follows: +You should then [update the user](/docs/reference/javascript/next/auth-updateuser) as follows: ```js const { error, data } = await supabase.auth.updateUser({ diff --git a/apps/reference/_supabase_js/generated/auth-setsession.mdx b/apps/reference/_supabase_js/generated/auth-setsession.mdx index 7b6da3a7aa0..220ded4d77a 100644 --- a/apps/reference/_supabase_js/generated/auth-setsession.mdx +++ b/apps/reference/_supabase_js/generated/auth-setsession.mdx @@ -8,11 +8,10 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Sets the session data from refresh_token and returns current session or an error if the refresh_token is invalid. +Sets the session data from refresh token and returns current session or an error if the refresh token is invalid. ```js - const { data, error } = supabase.auth.setSession(refresh_token) -} +const { data, error } = supabase.auth.setSession(refresh_token) ``` ## Parameters @@ -33,7 +32,7 @@ Sets the session data from refresh_token and returns current session or an error
    -The refresh token returned by gotrue. +A refresh token returned by supabase auth.
    @@ -41,13 +40,19 @@ The refresh token returned by gotrue. +## Notes + +- `setSession()` takes in a refresh token and uses it to get a new session. +- The refresh token can only be used once to obtain a new session. +- Refresh token rotation (see [`REFRESH_TOKEN_ROTATION_ENABLED`](https://supabase.com/docs/reference/auth/config#refresh_token_rotation_enabled)) is enabled by default on all projects to guard against replay attacks. +- You can configure the [`REFRESH_TOKEN_REUSE_INTERVAL`](https://supabase.com/docs/reference/auth/config#refresh_token_reuse_interval) which provides a short window in which the same refresh token can be used multiple times in the event of concurrency or offline issues. + ## Examples -### Basic example. +### Refresh the session Sets the session data from refresh_token and returns current session or an error if the refresh_token is invalid. ```js - const { data, error } = supabase.auth.setSession(refresh_token) -} +const { data, error } = supabase.auth.setSession(refresh_token) ``` diff --git a/apps/reference/_supabase_js/generated/auth-signinwithoauth.mdx b/apps/reference/_supabase_js/generated/auth-signinwithoauth.mdx index 69afe49fd83..bcdceac369c 100644 --- a/apps/reference/_supabase_js/generated/auth-signinwithoauth.mdx +++ b/apps/reference/_supabase_js/generated/auth-signinwithoauth.mdx @@ -116,7 +116,7 @@ An object of query params
    -A URL to send the user to after they are confirmed (OAuth logins only). +A URL to send the user to after they are confirmed.
    @@ -159,7 +159,7 @@ A space-separated list of scopes granted to the OAuth application. ## Examples -### Sign in using a third-party provider. +### Sign in using a third-party provider ```js const { data, error } = await supabase.auth.signInWithOAuth({ @@ -167,14 +167,13 @@ const { data, error } = await supabase.auth.signInWithOAuth({ }) ``` -### Sign in using a third-party provider with redirect. +### Sign in using a third-party provider with redirect -The `redirectTo` param will only applied on the callback made from the third-party provider. It does not redirect the user immediately after invoking this method. -In order for the `redirectTo` param to be allowed, one needs to include it in an allowlist. Supabase supports this for -any URL path on your website (the URL must either be on the same domain as your Site URL [see Auth>Settings in dashboard], or must match one of the Additional Redirect URLs [also in Auth>Settings]). +When the third-party provider successfully authenticates the user, the provider will redirect the user to the URL specified in the `redirectTo` parameter. This parameter defaults to the [`SITE_URL`](https://supabase.com/docs/reference/auth/config#site_url). It does not redirect the user immediately after invoking this method. +You can modify the `SITE_URL` or add additional redirect urls in [your project](https://app.supabase.com/project/_/auth/settings). ```js -const { user, session, error } = await supabase.auth.signInWithOAuth({ +const { data, error } = await supabase.auth.signInWithOAuth({ provider: 'github' options: { redirectTo: 'https://example.com/welcome' @@ -182,10 +181,10 @@ const { user, session, error } = await supabase.auth.signInWithOAuth({ } ``` -### Sign in with scopes. +### Sign in with scopes If you need additional data from an OAuth provider, you can include a space-separated list of scopes in your request to get back an OAuth provider token. -You may also need to specify the scopes in the provider's OAuth app settings, depending on the provider. +You may also need to specify the scopes in the provider's OAuth app settings, depending on the provider. The list of scopes will be documented by the third-party provider you are using and specifying scopes will enable you to use the OAuth provider token to call additional APIs supported by the third-party provider to get more information. ```js const { data, error } = await supabase.auth.signInWithOAuth({ diff --git a/apps/reference/_supabase_js/generated/auth-signinwithotp.mdx b/apps/reference/_supabase_js/generated/auth-signinwithotp.mdx index ae90d3fafba..26531fedd98 100644 --- a/apps/reference/_supabase_js/generated/auth-signinwithotp.mdx +++ b/apps/reference/_supabase_js/generated/auth-signinwithotp.mdx @@ -8,7 +8,10 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Passwordless method for logging in an existing user. +Log in a user using magiclink or a one-time password (OTP). +If the `{{ .ConfirmationURL }}` variable is specified in the email template, a magiclink will be sent. +If the `{{ .Token }}` variable is specified in the email template, an OTP will be sent. +If you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins. ```js const { data, error } = await supabase.auth.signInWithOtp({ @@ -289,17 +292,17 @@ If set to false, this method will not create a new user. Defaults to true. ## Notes -- This method is used for passwordless sign-ins where an otp is sent to the user's email or phone number. - Requires either an email or phone number. -- If you're using an email, you can configure whether you want the user to receive a magiclink or an otp. -- If you're using phone, you can configure whether you want the user to receive a magiclink or an otp. -- The magic link's destination URL is determined by the SITE_URL config variable. To change this, you can go to Authentication -> Settings on [app.supabase.com](https://app.supabase.com) +- This method is used for passwordless sign-ins where a OTP is sent to the user's email or phone number. +- If you're using an email, you can configure whether you want the user to receive a magiclink or a OTP. +- If you're using phone, you can configure whether you want the user to receive a OTP. +- The magic link's destination URL is determined by the [`SITE_URL`](https://supabase.com/docs/reference/auth/config#site_url). You can modify the `SITE_URL` or add additional redirect urls in [your project](https://app.supabase.com/project/_/auth/settings). ## Examples ### Sign in with email. -The user will be sent an otp to their email. By default, a given user can only request an otp once every 60 seconds. +The user will be sent an email which contains either a magiclink or a OTP or both. By default, a given user can only request a OTP once every 60 seconds. ```js const { data, error } = await supabase.auth.signInWithOtp({ @@ -307,9 +310,9 @@ const { data, error } = await supabase.auth.signInWithOtp({ }) ``` -### Sign in with sms otp. +### Sign in with SMS OTP. -The user will be sent an otp to their phone number. By default, a given user can only request an otp once every 60 seconds. +The user will be sent a SMS which contains a OTP. By default, a given user can only request a OTP once every 60 seconds. ```js const { data, error } = await supabase.auth.signInWithPassword({ diff --git a/apps/reference/_supabase_js/generated/auth-signinwithpassword.mdx b/apps/reference/_supabase_js/generated/auth-signinwithpassword.mdx index 1211aefcea0..08546b8140a 100644 --- a/apps/reference/_supabase_js/generated/auth-signinwithpassword.mdx +++ b/apps/reference/_supabase_js/generated/auth-signinwithpassword.mdx @@ -8,7 +8,7 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Log in an existing user, or login via a third-party provider. +Log in an existing user with an email and password or phone and password. ```js const { data, error } = await supabase.auth.signInWithPassword({ @@ -274,9 +274,7 @@ Verification token received when the user completes the captcha on the site. ## Examples -### Sign in with Email. - -Sign in with email and password. After a user has verified their email, they can use the [`signInWithPassword()`](/docs/reference/javascript/auth-signin#sign-in-using-phone) method. +### Sign in with email and password ```js const { data, error } = await supabase.auth.signInWithPassword({ @@ -285,9 +283,7 @@ const { data, error } = await supabase.auth.signInWithPassword({ }) ``` -### Sign in with Phone. - -Supabase supports Phone Auth. After a user has verified their number, they can use the [`signIn()`](/docs/reference/javascript/auth-signin#sign-in-using-phone) method. +### Sign in with phone and password ```js const { data, error } = await supabase.auth.signInWithPassword({ @@ -295,8 +291,8 @@ const { data, error } = await supabase.auth.signInWithPassword({ password: 'some-password', }) -// After receiving an SMS with One Time Password. -let { data, error } = await supabase.auth.verifyOtp({ +// After receiving a SMS with a OTP. +const { data, error } = await supabase.auth.verifyOtp({ phone: '+13334445555', token: '123456', }) diff --git a/apps/reference/_supabase_js/generated/auth-signout.mdx b/apps/reference/_supabase_js/generated/auth-signout.mdx index f32bf014b8f..c8b9f3de082 100644 --- a/apps/reference/_supabase_js/generated/auth-signout.mdx +++ b/apps/reference/_supabase_js/generated/auth-signout.mdx @@ -9,7 +9,7 @@ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' Inside a browser context, `signOut()` will remove the logged in user from the browser session -and log them out - removing all items from localstorage and then trigger a "SIGNED_OUT" event. +and log them out - removing all items from localstorage and then trigger a `"SIGNED_OUT"` event. For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to `auth.api.signOut(JWT: string)`. There is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason. @@ -18,6 +18,10 @@ There is no way to revoke a user's access token jwt until it expires. It is reco const { error } = await supabase.auth.signOut() ``` +## Notes + +- In order to use the `signOut()` method, the user needs to be signed in first. + ## Examples ### Sign out diff --git a/apps/reference/_supabase_js/generated/auth-signup.mdx b/apps/reference/_supabase_js/generated/auth-signup.mdx index c4f9ae57b01..e2155d6bb28 100644 --- a/apps/reference/_supabase_js/generated/auth-signup.mdx +++ b/apps/reference/_supabase_js/generated/auth-signup.mdx @@ -158,7 +158,9 @@ Verification token received when the user completes the captcha on the site.
    -The user's metadata. +A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column. + +The `data` should be a JSON object that includes user-specific info, such as their first and last name.
    @@ -288,7 +290,9 @@ Verification token received when the user completes the captcha on the site.
    -The user's metadata. +A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column. + +The `data` should be a JSON object that includes user-specific info, such as their first and last name.
    @@ -330,14 +334,15 @@ The redirect url embedded in the email link ## Notes -- By default, the user will need to verify their email address before logging in. If you would like to change this, you can disable "Email Confirmations" by going to Authentication -> Settings on [app.supabase.com](https://app.supabase.com) -- If "Email Confirmations" is turned on, a `user` is returned but `session` will be null -- If "Email Confirmations" is turned off, both a `user` and a `session` will be returned -- When the user confirms their email address, they will be redirected to localhost:3000 by default. To change this, you can go to Authentication -> Settings on [app.supabase.com](https://app.supabase.com) +- By default, the user needs to verify their email address before logging in. To turn this off, disable **Confirm email** in [your project](https://app.supabase.com/project/_/auth/settings). +- **Confirm email** determines if users need to confirm their email address after signing up. + - If **Confirm email** is enabled, a `user` is returned but `session` is null. + - If **Confirm email** is disabled, both a `user` and a `session` are returned. +- When the user confirms their email address, they are redirected to the [`SITE_URL`](https://supabase.com/docs/reference/auth/config#site_url) by default. You can modify your `SITE_URL` or add additional redirect URLs in [your project](https://app.supabase.com/project/_/auth/settings). - If signUp() is called for an existing confirmed user: - - If "Enable email confirmations" is enabled on the "Authentication" -> "Settings" page, an obfuscated / fake user object will be returned. - - If "Enable email confirmations" is disabled, an error with a message "User already registered" will be returned. -- To check if a user already exists, refer to getUser(). + - If **Confirm email** is enabled in [your project](https://app.supabase.com/project/_/auth/settings), an obfuscated/fake user object is returned. + - If **Confirm email** is disabled, the error message, `User already registered` is returned. +- To fetch the currently logged-in user, refer to [`getUser()`](/docs/reference/javascript/next/auth-getuser). ## Examples @@ -350,7 +355,7 @@ const { data, error } = await supabase.auth.signUp({ }) ``` -### Sign up with additional user meta data. +### Sign up with additional user metadata. ```js const { data, error } = await supabase.auth.signUp({ diff --git a/apps/reference/_supabase_js/generated/auth-updateuser.mdx b/apps/reference/_supabase_js/generated/auth-updateuser.mdx index 6d7030cc734..1a5021bc07e 100644 --- a/apps/reference/_supabase_js/generated/auth-updateuser.mdx +++ b/apps/reference/_supabase_js/generated/auth-updateuser.mdx @@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem' Updates user data, if there is a logged in user. ```js -const { user, error } = await supabase.auth.updateUser({ +const { data, error } = await supabase.auth.updateUser({ data: { hello: 'world' }, }) ``` @@ -55,7 +55,9 @@ No description provided.
    -A custom data object for user_metadata that a user can modify. Can be any JSON. +A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column. + +The `data` should be a JSON object that includes user-specific info, such as their first and last name.
    @@ -81,26 +83,6 @@ The user's email.
    • -
  • -

    - - email_change_token - - - optional - - - string - -

    -
    - -An email change token. - -
    - -
    • -

  • @@ -149,15 +131,13 @@ The user's phone. ## Notes -User email: Email updates will send an email to both the user's current and new email with a confirmation link by default. -To toggle this behavior off and only send a single confirmation link to the new email, toggle "Double confirm email changes" under "Authentication" -> "Settings" off. - -User metadata: It's generally better to store user data in a table inside your public schema (i.e. `public.users`). -Use the `update()` method if you have data which rarely changes or is specific only to the logged in user. +- In order to use the `updateUser()` method, the user needs to be signed in first. +- Email updates will send an email to both the user's current and new email with a confirmation link by default. + To only send a single confirmation link to the user's new email, you can toggle the "Secure email change" setting in [your project](https://app.supabase.com/project/_/auth/settings). ## Examples -### Update email for authenticated user. +### Update the email of an authenticated user Sends a "Confirm Email Change" email to the new email address. @@ -167,7 +147,7 @@ const { data, error } = await supabase.auth.updateUser({ }) ``` -### Update password for authenticated user. +### Update the password of an authenticated user ```js const { data, error } = await supabase.auth.updateUser({ @@ -175,10 +155,10 @@ const { data, error } = await supabase.auth.updateUser({ }) ``` -### Update a user's metadata. +### Update the user's metadata. ```js -const { user, error } = await supabase.auth.updateUser({ +const { data, error } = await supabase.auth.updateUser({ data: { hello: 'world' }, }) ``` diff --git a/apps/reference/_supabase_js/generated/auth-verifyotp.mdx b/apps/reference/_supabase_js/generated/auth-verifyotp.mdx index 09d150c9393..8fde34f03eb 100644 --- a/apps/reference/_supabase_js/generated/auth-verifyotp.mdx +++ b/apps/reference/_supabase_js/generated/auth-verifyotp.mdx @@ -87,72 +87,12 @@ No description provided.

    • -
  • -

    - - options - - - required - - - object - -

    -
    - -No description provided. - -
    - -
      -
      Properties
      - -
    • -

      - - captchaToken - - - optional - - - string - -

      -
      - -Verification token received when the user completes the captcha on the site. - -
      - -
      • - -
    • -

      - - redirectTo - - - optional - - - string - -

      -
      - -A URL to send the user to after they are confirmed. - -
      - -
      • -
    -
    • +## Notes - +- The `verifyOtp` method takes in different verification types. If a phone number is used, the type can either be `sms` or `phone_change`. If an email address is used, the type can be one of the following: `signup`, `magiclink`, `recovery`, `invite` or `email_change`. +- The verification type used should be determined based on the corresponding auth method called before `verifyOtp` to sign up / sign-in a user. ## Examples diff --git a/apps/reference/_supabase_js/generated/removeallchannels.mdx b/apps/reference/_supabase_js/generated/removeallchannels.mdx index 7083c443c91..b1651609f85 100644 --- a/apps/reference/_supabase_js/generated/removeallchannels.mdx +++ b/apps/reference/_supabase_js/generated/removeallchannels.mdx @@ -20,7 +20,7 @@ supabase.removeAllChannels() ## Examples -### Removes all channels +### Remove all channels ```js supabase.removeAllChannels() diff --git a/apps/reference/_supabase_js/generated/removechannel.mdx b/apps/reference/_supabase_js/generated/removechannel.mdx index 8572858e763..17d20d2bf69 100644 --- a/apps/reference/_supabase_js/generated/removechannel.mdx +++ b/apps/reference/_supabase_js/generated/removechannel.mdx @@ -831,7 +831,7 @@ No description provided. ## Examples -### Remove a channel +### Removes a channel ```js supabase.removeChannel(myChannel) diff --git a/apps/reference/_supabase_js/generated/supabase-auth-admin-api.mdx b/apps/reference/_supabase_js/generated/supabase-auth-admin-api.mdx new file mode 100644 index 00000000000..f191296b7db --- /dev/null +++ b/apps/reference/_supabase_js/generated/supabase-auth-admin-api.mdx @@ -0,0 +1,14 @@ +--- +id: supabase-auth-admin-api +title: 'Overview' +slug: /supabase-auth-admin-api +custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_js_v2_legacy.yml +--- + +import Tabs from '@theme/Tabs' +import TabItem from '@theme/TabItem' + +## Notes + +- Any method under the `supabase.auth.admin` namespace requires a `service_role` key. +- These methods are considered admin methods and should be called on a trusted server. Never expose your `service_role` key in the browser. diff --git a/apps/reference/nav/supabase_js_sidebars.js b/apps/reference/nav/supabase_js_sidebars.js index 6c67d8eed46..dc9d9f70f4e 100644 --- a/apps/reference/nav/supabase_js_sidebars.js +++ b/apps/reference/nav/supabase_js_sidebars.js @@ -52,6 +52,7 @@ const sidebars = { type: 'category', label: 'Auth (Server Only)', items: [ + 'generated/supabase-auth-admin-api', 'generated/auth-admin-listusers', 'generated/auth-admin-createuser', 'generated/auth-admin-deleteuser', diff --git a/spec/enrichments/tsdoc_v2/combined.json b/spec/enrichments/tsdoc_v2/combined.json index d6ed0102d2b..987fdebd8f1 100644 --- a/spec/enrichments/tsdoc_v2/combined.json +++ b/spec/enrichments/tsdoc_v2/combined.json @@ -51599,14 +51599,14 @@ "originalName": "", "children": [ { - "id": 455, + "id": 499, "name": "AuthApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 456, + "id": 500, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -51620,14 +51620,14 @@ ], "signatures": [ { - "id": 457, + "id": 501, "name": "new AuthApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 458, + "id": 502, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -51638,7 +51638,7 @@ } }, { - "id": 459, + "id": 503, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -51651,24 +51651,24 @@ ], "type": { "type": "reference", - "id": 455, + "id": 499, "name": "AuthApiError" }, "overwrites": { "type": "reference", - "id": 452, + "id": 496, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 451, + "id": 495, "name": "AuthError.constructor" } }, { - "id": 460, + "id": 504, "name": "status", "kind": 1024, "kindString": "Property", @@ -51686,7 +51686,7 @@ } }, { - "id": 461, + "id": 505, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -51700,7 +51700,7 @@ ], "signatures": [ { - "id": 462, + "id": 506, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -51708,14 +51708,14 @@ "type": { "type": "reflection", "declaration": { - "id": 463, + "id": 507, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 465, + "id": 509, "name": "message", "kind": 1024, "kindString": "Property", @@ -51734,7 +51734,7 @@ "defaultValue": "..." }, { - "id": 464, + "id": 508, "name": "name", "kind": 1024, "kindString": "Property", @@ -51753,7 +51753,7 @@ "defaultValue": "..." }, { - "id": 466, + "id": 510, "name": "status", "kind": 1024, "kindString": "Property", @@ -51777,9 +51777,9 @@ "title": "Properties", "kind": 1024, "children": [ - 465, - 464, - 466 + 509, + 508, + 510 ] } ] @@ -51794,21 +51794,21 @@ "title": "Constructors", "kind": 512, "children": [ - 456 + 500 ] }, { "title": "Properties", "kind": 1024, "children": [ - 460 + 504 ] }, { "title": "Methods", "kind": 2048, "children": [ - 461 + 505 ] } ], @@ -51822,20 +51822,20 @@ "extendedTypes": [ { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } ] }, { - "id": 450, + "id": 494, "name": "AuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 451, + "id": 495, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -51849,14 +51849,14 @@ ], "signatures": [ { - "id": 452, + "id": 496, "name": "new AuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 453, + "id": 497, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -51869,7 +51869,7 @@ ], "type": { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" }, "overwrites": { @@ -51889,7 +51889,7 @@ "title": "Constructors", "kind": 512, "children": [ - 451 + 495 ] } ], @@ -51911,30 +51911,30 @@ "extendedBy": [ { "type": "reference", - "id": 455, + "id": 499, "name": "AuthApiError" }, { "type": "reference", - "id": 468, + "id": 512, "name": "AuthUnknownError" }, { "type": "reference", - "id": 475, + "id": 519, "name": "CustomAuthError" } ] }, { - "id": 502, - "name": "AuthInvalidCredentialsError", + "id": 559, + "name": "AuthImplicitGrantRedirectError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 503, + "id": 560, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -51942,277 +51942,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 67, + "line": 74, "character": 2 } ], "signatures": [ { - "id": 504, - "name": "new AuthInvalidCredentialsError", + "id": 561, + "name": "new AuthImplicitGrantRedirectError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 505, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 502, - "name": "AuthInvalidCredentialsError" - }, - "overwrites": { - "type": "reference", - "id": 477, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 476, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 506, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 43, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 481, - "name": "CustomAuthError.name" - } - }, - { - "id": 507, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 44, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 482, - "name": "CustomAuthError.status" - } - }, - { - "id": 508, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 51, - "character": 2 - } - ], - "signatures": [ - { - "id": 509, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 510, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 512, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 54, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 511, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 53, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 513, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 55, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 512, - 511, - 513 - ] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 484, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 483, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 503 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 506, - 507 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 508 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 66, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 475, - "name": "CustomAuthError" - } - ] - }, - { - "id": 515, - "name": "AuthRetryableFetchError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 516, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 73, - "character": 2 - } - ], - "signatures": [ - { - "id": 517, - "name": "new AuthRetryableFetchError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 518, + "id": 562, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -52223,37 +51966,183 @@ } }, { - "id": 519, - "name": "status", + "id": 563, + "name": "details", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "intrinsic", - "name": "number" - } + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 564, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 566, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 74, + "character": 57 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 565, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 74, + "character": 42 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 566, + 565 + ] + } + ] + } + } + ] + }, + "defaultValue": "null" } ], "type": { "type": "reference", - "id": 515, - "name": "AuthRetryableFetchError" + "id": 559, + "name": "AuthImplicitGrantRedirectError" }, "overwrites": { "type": "reference", - "id": 477, + "id": 521, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 476, + "id": 520, "name": "CustomAuthError.constructor" } }, { - "id": 520, + "id": 567, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 73, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 568, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 570, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 73, + "character": 28 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 569, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 73, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 570, + 569 + ] + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 581, "name": "name", "kind": 1024, "kindString": "Property", @@ -52271,12 +52160,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 481, + "id": 525, "name": "CustomAuthError.name" } }, { - "id": 521, + "id": 582, "name": "status", "kind": 1024, "kindString": "Property", @@ -52294,12 +52183,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 482, + "id": 526, "name": "CustomAuthError.status" } }, { - "id": 522, + "id": 571, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -52307,13 +52196,13 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 79, "character": 2 } ], "signatures": [ { - "id": 523, + "id": 572, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -52321,14 +52210,96 @@ "type": { "type": "reflection", "declaration": { - "id": 524, + "id": 573, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 526, + "id": 577, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 84, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 578, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 580, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 73, + "character": 28 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 579, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 73, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 580, + 579 + ] + } + ] + } + } + ] + }, + "defaultValue": "..." + }, + { + "id": 575, "name": "message", "kind": 1024, "kindString": "Property", @@ -52336,7 +52307,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 54, + "line": 82, "character": 6 } ], @@ -52347,7 +52318,7 @@ "defaultValue": "..." }, { - "id": 525, + "id": 574, "name": "name", "kind": 1024, "kindString": "Property", @@ -52355,7 +52326,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 53, + "line": 81, "character": 6 } ], @@ -52366,7 +52337,7 @@ "defaultValue": "..." }, { - "id": 527, + "id": 576, "name": "status", "kind": 1024, "kindString": "Property", @@ -52374,7 +52345,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 55, + "line": 83, "character": 6 } ], @@ -52390,24 +52361,25 @@ "title": "Properties", "kind": 1024, "children": [ - 526, - 525, - 527 + 577, + 575, + 574, + 576 ] } ] } }, - "inheritedFrom": { + "overwrites": { "type": "reference", - "id": 484, + "id": 528, "name": "CustomAuthError.toJSON" } } ], - "inheritedFrom": { + "overwrites": { "type": "reference", - "id": 483, + "id": 527, "name": "CustomAuthError.toJSON" } } @@ -52417,22 +52389,23 @@ "title": "Constructors", "kind": 512, "children": [ - 516 + 560 ] }, { "title": "Properties", "kind": 1024, "children": [ - 520, - 521 + 567, + 581, + 582 ] }, { "title": "Methods", "kind": 2048, "children": [ - 522 + 571 ] } ], @@ -52446,20 +52419,20 @@ "extendedTypes": [ { "type": "reference", - "id": 475, + "id": 519, "name": "CustomAuthError" } ] }, { - "id": 490, - "name": "AuthSessionMissingError", + "id": 546, + "name": "AuthInvalidCredentialsError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 491, + "id": 547, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -52467,37 +52440,50 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 61, + "line": 67, "character": 2 } ], "signatures": [ { - "id": 492, - "name": "new AuthSessionMissingError", + "id": 548, + "name": "new AuthInvalidCredentialsError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, + "parameters": [ + { + "id": 549, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], "type": { "type": "reference", - "id": 490, - "name": "AuthSessionMissingError" + "id": 546, + "name": "AuthInvalidCredentialsError" }, "overwrites": { "type": "reference", - "id": 477, + "id": 521, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 476, + "id": 520, "name": "CustomAuthError.constructor" } }, { - "id": 493, + "id": 550, "name": "name", "kind": 1024, "kindString": "Property", @@ -52515,12 +52501,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 481, + "id": 525, "name": "CustomAuthError.name" } }, { - "id": 494, + "id": 551, "name": "status", "kind": 1024, "kindString": "Property", @@ -52538,12 +52524,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 482, + "id": 526, "name": "CustomAuthError.status" } }, { - "id": 495, + "id": 552, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -52557,7 +52543,7 @@ ], "signatures": [ { - "id": 496, + "id": 553, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -52565,14 +52551,14 @@ "type": { "type": "reflection", "declaration": { - "id": 497, + "id": 554, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 499, + "id": 556, "name": "message", "kind": 1024, "kindString": "Property", @@ -52591,7 +52577,7 @@ "defaultValue": "..." }, { - "id": 498, + "id": 555, "name": "name", "kind": 1024, "kindString": "Property", @@ -52610,7 +52596,7 @@ "defaultValue": "..." }, { - "id": 500, + "id": 557, "name": "status", "kind": 1024, "kindString": "Property", @@ -52634,9 +52620,9 @@ "title": "Properties", "kind": 1024, "children": [ - 499, - 498, - 500 + 556, + 555, + 557 ] } ] @@ -52644,14 +52630,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 484, + "id": 528, "name": "CustomAuthError.toJSON" } } ], "inheritedFrom": { "type": "reference", - "id": 483, + "id": 527, "name": "CustomAuthError.toJSON" } } @@ -52661,22 +52647,534 @@ "title": "Constructors", "kind": 512, "children": [ - 491 + 547 ] }, { "title": "Properties", "kind": 1024, "children": [ - 493, - 494 + 550, + 551 ] }, { "title": "Methods", "kind": 2048, "children": [ - 495 + 552 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 66, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 519, + "name": "CustomAuthError" + } + ] + }, + { + "id": 584, + "name": "AuthRetryableFetchError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 585, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 90, + "character": 2 + } + ], + "signatures": [ + { + "id": 586, + "name": "new AuthRetryableFetchError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 587, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 588, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "reference", + "id": 584, + "name": "AuthRetryableFetchError" + }, + "overwrites": { + "type": "reference", + "id": 521, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 520, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 589, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 43, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 525, + "name": "CustomAuthError.name" + } + }, + { + "id": 590, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 44, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 526, + "name": "CustomAuthError.status" + } + }, + { + "id": 591, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 51, + "character": 2 + } + ], + "signatures": [ + { + "id": 592, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 593, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 595, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 54, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 594, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 53, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 596, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 55, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 595, + 594, + 596 + ] + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "id": 528, + "name": "CustomAuthError.toJSON" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 527, + "name": "CustomAuthError.toJSON" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 585 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 589, + 590 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 591 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 519, + "name": "CustomAuthError" + } + ] + }, + { + "id": 534, + "name": "AuthSessionMissingError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 535, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 61, + "character": 2 + } + ], + "signatures": [ + { + "id": 536, + "name": "new AuthSessionMissingError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "type": { + "type": "reference", + "id": 534, + "name": "AuthSessionMissingError" + }, + "overwrites": { + "type": "reference", + "id": 521, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 520, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 537, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 43, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 525, + "name": "CustomAuthError.name" + } + }, + { + "id": 538, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 44, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 526, + "name": "CustomAuthError.status" + } + }, + { + "id": 539, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 51, + "character": 2 + } + ], + "signatures": [ + { + "id": 540, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 541, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 543, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 54, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 542, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 53, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 544, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 55, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 543, + 542, + 544 + ] + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "id": 528, + "name": "CustomAuthError.toJSON" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 527, + "name": "CustomAuthError.toJSON" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 535 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 537, + 538 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 539 ] } ], @@ -52690,20 +53188,20 @@ "extendedTypes": [ { "type": "reference", - "id": 475, + "id": 519, "name": "CustomAuthError" } ] }, { - "id": 468, + "id": 512, "name": "AuthUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 469, + "id": 513, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -52717,14 +53215,14 @@ ], "signatures": [ { - "id": 470, + "id": 514, "name": "new AuthUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 471, + "id": 515, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -52735,7 +53233,7 @@ } }, { - "id": 472, + "id": 516, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -52748,24 +53246,24 @@ ], "type": { "type": "reference", - "id": 468, + "id": 512, "name": "AuthUnknownError" }, "overwrites": { "type": "reference", - "id": 452, + "id": 496, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 451, + "id": 495, "name": "AuthError.constructor" } }, { - "id": 473, + "id": 517, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -52788,14 +53286,14 @@ "title": "Constructors", "kind": 512, "children": [ - 469 + 513 ] }, { "title": "Properties", "kind": 1024, "children": [ - 473 + 517 ] } ], @@ -52809,20 +53307,20 @@ "extendedTypes": [ { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } ] }, { - "id": 475, + "id": 519, "name": "CustomAuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 476, + "id": 520, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -52836,14 +53334,14 @@ ], "signatures": [ { - "id": 477, + "id": 521, "name": "new CustomAuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 478, + "id": 522, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -52854,7 +53352,7 @@ } }, { - "id": 479, + "id": 523, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -52865,7 +53363,7 @@ } }, { - "id": 480, + "id": 524, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -52878,24 +53376,24 @@ ], "type": { "type": "reference", - "id": 475, + "id": 519, "name": "CustomAuthError" }, "overwrites": { "type": "reference", - "id": 452, + "id": 496, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 451, + "id": 495, "name": "AuthError.constructor" } }, { - "id": 481, + "id": 525, "name": "name", "kind": 1024, "kindString": "Property", @@ -52917,7 +53415,7 @@ } }, { - "id": 482, + "id": 526, "name": "status", "kind": 1024, "kindString": "Property", @@ -52935,7 +53433,7 @@ } }, { - "id": 483, + "id": 527, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -52949,7 +53447,7 @@ ], "signatures": [ { - "id": 484, + "id": 528, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -52957,14 +53455,14 @@ "type": { "type": "reflection", "declaration": { - "id": 485, + "id": 529, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 487, + "id": 531, "name": "message", "kind": 1024, "kindString": "Property", @@ -52983,7 +53481,7 @@ "defaultValue": "..." }, { - "id": 486, + "id": 530, "name": "name", "kind": 1024, "kindString": "Property", @@ -53002,7 +53500,7 @@ "defaultValue": "..." }, { - "id": 488, + "id": 532, "name": "status", "kind": 1024, "kindString": "Property", @@ -53026,9 +53524,9 @@ "title": "Properties", "kind": 1024, "children": [ - 487, - 486, - 488 + 531, + 530, + 532 ] } ] @@ -53043,22 +53541,22 @@ "title": "Constructors", "kind": 512, "children": [ - 476 + 520 ] }, { "title": "Properties", "kind": 1024, "children": [ - 481, - 482 + 525, + 526 ] }, { "title": "Methods", "kind": 2048, "children": [ - 483 + 527 ] } ], @@ -53072,24 +53570,29 @@ "extendedTypes": [ { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } ], "extendedBy": [ { "type": "reference", - "id": 490, + "id": 534, "name": "AuthSessionMissingError" }, { "type": "reference", - "id": 502, + "id": 546, "name": "AuthInvalidCredentialsError" }, { "type": "reference", - "id": 515, + "id": 559, + "name": "AuthImplicitGrantRedirectError" + }, + { + "type": "reference", + "id": 584, "name": "AuthRetryableFetchError" } ] @@ -53110,7 +53613,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 13, + "line": 19, "character": 2 } ], @@ -53148,7 +53651,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 22, + "line": 28, "character": 4 } ], @@ -53238,7 +53741,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 19, + "line": 25, "character": 4 } ], @@ -53285,7 +53788,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 18, + "line": 24, "character": 4 } ], @@ -53319,7 +53822,7 @@ ] }, { - "id": 56, + "id": 41, "name": "createUser", "kind": 2048, "kindString": "Method", @@ -53327,13 +53830,13 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 128, + "line": 126, "character": 8 } ], "signatures": [ { - "id": 57, + "id": 42, "name": "createUser", "kind": 4096, "kindString": "Call signature", @@ -53343,24 +53846,24 @@ }, "parameters": [ { - "id": 58, + "id": 43, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 355, + "id": 343, "name": "AdminUserAttributes", "dereferenced": { - "id": 355, + "id": 343, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 357, + "id": 345, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -53368,13 +53871,13 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object for app_metadata that.", - "text": "Only a service role can modify.\n\nCan be any JSON that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" + "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", + "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 187, + "line": 205, "character": 2 } ], @@ -53384,7 +53887,7 @@ } }, { - "id": 364, + "id": 351, "name": "data", "kind": 1024, "kindString": "Property", @@ -53392,12 +53895,13 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object for user_metadata that a user can modify. Can be any JSON." + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 162, + "line": 180, "character": 2 } ], @@ -53407,12 +53911,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 354, + "id": 342, "name": "UserAttributes.data" } }, { - "id": 360, + "id": 348, "name": "email", "kind": 1024, "kindString": "Property", @@ -53425,7 +53929,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 142, + "line": 162, "character": 2 } ], @@ -53435,40 +53939,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 350, + "id": 339, "name": "UserAttributes.email" } }, { - "id": 363, - "name": "email_change_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "An email change token." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 157, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 353, - "name": "UserAttributes.email_change_token" - } - }, - { - "id": 358, + "id": 346, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -53476,13 +53952,13 @@ "isOptional": true }, "comment": { - "shortText": "Sets if a user has confirmed their email address.", + "shortText": "Confirms the user's email address if set to true.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 194, + "line": 212, "character": 2 } ], @@ -53492,7 +53968,7 @@ } }, { - "id": 362, + "id": 350, "name": "password", "kind": 1024, "kindString": "Property", @@ -53505,7 +53981,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 152, + "line": 172, "character": 2 } ], @@ -53515,12 +53991,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 352, + "id": 341, "name": "UserAttributes.password" } }, { - "id": 361, + "id": 349, "name": "phone", "kind": 1024, "kindString": "Property", @@ -53533,7 +54009,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 147, + "line": 167, "character": 2 } ], @@ -53543,12 +54019,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 351, + "id": 340, "name": "UserAttributes.phone" } }, { - "id": 359, + "id": 347, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -53556,13 +54032,13 @@ "isOptional": true }, "comment": { - "shortText": "Sets if a user has confirmed their phone number.", + "shortText": "Confirms the user's phone number if set to true.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 201, + "line": 219, "character": 2 } ], @@ -53572,7 +54048,7 @@ } }, { - "id": 356, + "id": 344, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -53580,13 +54056,13 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object for user_metadata.", - "text": "Can be any JSON.\n\nOnly a service role can modify.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's user_metadata,\nthis attribute is used instead of UserAttributes data.\n\n" + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "Only a service role can modify.\n\nThe `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 177, + "line": 195, "character": 2 } ], @@ -53601,29 +54077,28 @@ "title": "Properties", "kind": 1024, "children": [ - 357, - 364, - 360, - 363, - 358, - 362, - 361, - 359, - 356 + 345, + 351, + 348, + 346, + 350, + 349, + 347, + 344 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 165, + "line": 183, "character": 17 } ], "extendedTypes": [ { "type": "reference", - "id": 349, + "id": 338, "name": "UserAttributes" } ] @@ -53636,7 +54111,7 @@ "typeArguments": [ { "type": "reference", - "id": 291, + "id": 280, "name": "UserResponse" } ], @@ -53648,7 +54123,7 @@ ] }, { - "id": 78, + "id": 63, "name": "deleteUser", "kind": 2048, "kindString": "Method", @@ -53656,13 +54131,13 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 218, + "line": 216, "character": 8 } ], "signatures": [ { - "id": 79, + "id": 64, "name": "deleteUser", "kind": 4096, "kindString": "Call signature", @@ -53672,13 +54147,13 @@ }, "parameters": [ { - "id": 80, - "name": "uid", + "id": 65, + "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The user uid you want to remove.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" + "shortText": "The user id you want to remove.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" }, "type": { "type": "intrinsic", @@ -53691,7 +54166,7 @@ "typeArguments": [ { "type": "reference", - "id": 291, + "id": 280, "name": "UserResponse" } ], @@ -53711,7 +54186,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 85, + "line": 92, "character": 8 } ], @@ -53723,32 +54198,29 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Generates links to be sent via email or other." + "shortText": "Generates email links and OTPs to be sent via a custom email provider." }, "parameters": [ { "id": 40, - "name": "type", + "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 438, - "name": "GenerateLinkType", + "id": 458, + "name": "GenerateLinkParams", "dereferenced": { - "id": 438, - "name": "GenerateLinkType", + "id": 458, + "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, - "comment": { - "shortText": "The link type" - }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 327, + "line": 407, "character": 12 } ], @@ -53756,333 +54228,38 @@ "type": "union", "types": [ { - "type": "literal", - "value": "signup" + "type": "reference", + "id": 433, + "name": "GenerateSignupLinkParams" }, { - "type": "literal", - "value": "invite" + "type": "reference", + "id": 439, + "name": "GenerateInviteOrMagiclinkParams" }, { - "type": "literal", - "value": "magiclink" + "type": "reference", + "id": 444, + "name": "GenerateRecoveryLinkParams" }, { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" + "type": "reference", + "id": 449, + "name": "GenerateEmailChangeLinkParams" } ] } } } - }, - { - "id": 41, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The user's email." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 42, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 43, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 45, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional user metadata. For signup only." - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 90, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 44, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "User password. For signup only." - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 89, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 46, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The redirect url which should be appended to the generated link\n" - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 91, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 45, - 44, - 46 - ] - } - ] - } - }, - "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 47, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 48, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 95, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 321, - "name": "User" - } - }, - { - "id": 49, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 96, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 48, - 49 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 50, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 51, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 99, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 302, - "name": "Session" - } - }, - { - "id": 52, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 100, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 51, - 52 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 53, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 54, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 102, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 55, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 102, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 450, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 54, - 55 - ] - } - ] - } - } - ] + "type": "reference", + "id": 459, + "name": "GenerateLinkResponse" } ], "qualifiedName": "Promise", @@ -54093,7 +54270,7 @@ ] }, { - "id": 71, + "id": 56, "name": "getUserById", "kind": 2048, "kindString": "Method", @@ -54101,13 +54278,13 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 173, + "line": 171, "character": 8 } ], "signatures": [ { - "id": 72, + "id": 57, "name": "getUserById", "kind": 4096, "kindString": "Call signature", @@ -54117,7 +54294,7 @@ }, "parameters": [ { - "id": 73, + "id": 58, "name": "uid", "kind": 32768, "kindString": "Parameter", @@ -54136,7 +54313,7 @@ "typeArguments": [ { "type": "reference", - "id": 291, + "id": 280, "name": "UserResponse" } ], @@ -54156,7 +54333,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 55, + "line": 62, "character": 8 } ], @@ -54214,7 +54391,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 59, + "line": 66, "character": 6 } ], @@ -54232,12 +54409,12 @@ "isOptional": true }, "comment": { - "shortText": "A URL or mobile address to send the user to after they are confirmed." + "shortText": "A URL or mobile deeplink to send the user to after they are confirmed." }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 58, + "line": 65, "character": 6 } ], @@ -54267,7 +54444,7 @@ "typeArguments": [ { "type": "reference", - "id": 291, + "id": 280, "name": "UserResponse" } ], @@ -54279,7 +54456,7 @@ ] }, { - "id": 59, + "id": 44, "name": "listUsers", "kind": 2048, "kindString": "Method", @@ -54287,13 +54464,13 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 149, + "line": 147, "character": 8 } ], "signatures": [ { - "id": 60, + "id": 45, "name": "listUsers", "kind": 4096, "kindString": "Call signature", @@ -54311,14 +54488,14 @@ { "type": "reflection", "declaration": { - "id": 61, + "id": 46, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 62, + "id": 47, "name": "data", "kind": 1024, "kindString": "Property", @@ -54326,21 +54503,21 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 150, + "line": 148, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 63, + "id": 48, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 64, + "id": 49, "name": "users", "kind": 1024, "kindString": "Property", @@ -54348,7 +54525,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 150, + "line": 148, "character": 14 } ], @@ -54356,7 +54533,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 321, + "id": 310, "name": "User" } } @@ -54367,7 +54544,7 @@ "title": "Properties", "kind": 1024, "children": [ - 64 + 49 ] } ] @@ -54375,7 +54552,7 @@ } }, { - "id": 65, + "id": 50, "name": "error", "kind": 1024, "kindString": "Property", @@ -54383,7 +54560,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 150, + "line": 148, "character": 31 } ], @@ -54398,8 +54575,8 @@ "title": "Properties", "kind": 1024, "children": [ - 62, - 65 + 47, + 50 ] } ] @@ -54408,14 +54585,14 @@ { "type": "reflection", "declaration": { - "id": 66, + "id": 51, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 67, + "id": 52, "name": "data", "kind": 1024, "kindString": "Property", @@ -54423,21 +54600,21 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 150, + "line": 148, "character": 49 } ], "type": { "type": "reflection", "declaration": { - "id": 68, + "id": 53, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 69, + "id": 54, "name": "users", "kind": 1024, "kindString": "Property", @@ -54445,7 +54622,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 150, + "line": 148, "character": 57 } ], @@ -54459,7 +54636,7 @@ "title": "Properties", "kind": 1024, "children": [ - 69 + 54 ] } ] @@ -54467,7 +54644,7 @@ } }, { - "id": 70, + "id": 55, "name": "error", "kind": 1024, "kindString": "Property", @@ -54475,13 +54652,13 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 150, + "line": 148, "character": 70 } ], "type": { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } } @@ -54491,8 +54668,8 @@ "title": "Properties", "kind": 1024, "children": [ - 67, - 70 + 52, + 55 ] } ] @@ -54517,7 +54694,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 33, + "line": 39, "character": 8 } ], @@ -54568,7 +54745,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 33, + "line": 39, "character": 40 } ], @@ -54581,7 +54758,7 @@ }, { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } ] @@ -54608,7 +54785,7 @@ ] }, { - "id": 74, + "id": 59, "name": "updateUserById", "kind": 2048, "kindString": "Method", @@ -54616,13 +54793,13 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 195, + "line": 193, "character": 8 } ], "signatures": [ { - "id": 75, + "id": 60, "name": "updateUserById", "kind": 4096, "kindString": "Call signature", @@ -54632,7 +54809,7 @@ }, "parameters": [ { - "id": 76, + "id": 61, "name": "uid", "kind": 32768, "kindString": "Parameter", @@ -54643,7 +54820,7 @@ } }, { - "id": 77, + "id": 62, "name": "attributes", "kind": 32768, "kindString": "Parameter", @@ -54653,17 +54830,17 @@ }, "type": { "type": "reference", - "id": 355, + "id": 343, "name": "AdminUserAttributes", "dereferenced": { - "id": 355, + "id": 343, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 357, + "id": 345, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -54671,13 +54848,13 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object for app_metadata that.", - "text": "Only a service role can modify.\n\nCan be any JSON that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" + "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", + "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 187, + "line": 205, "character": 2 } ], @@ -54687,7 +54864,7 @@ } }, { - "id": 364, + "id": 351, "name": "data", "kind": 1024, "kindString": "Property", @@ -54695,12 +54872,13 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object for user_metadata that a user can modify. Can be any JSON." + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 162, + "line": 180, "character": 2 } ], @@ -54710,12 +54888,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 354, + "id": 342, "name": "UserAttributes.data" } }, { - "id": 360, + "id": 348, "name": "email", "kind": 1024, "kindString": "Property", @@ -54728,7 +54906,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 142, + "line": 162, "character": 2 } ], @@ -54738,40 +54916,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 350, + "id": 339, "name": "UserAttributes.email" } }, { - "id": 363, - "name": "email_change_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "An email change token." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 157, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 353, - "name": "UserAttributes.email_change_token" - } - }, - { - "id": 358, + "id": 346, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -54779,13 +54929,13 @@ "isOptional": true }, "comment": { - "shortText": "Sets if a user has confirmed their email address.", + "shortText": "Confirms the user's email address if set to true.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 194, + "line": 212, "character": 2 } ], @@ -54795,7 +54945,7 @@ } }, { - "id": 362, + "id": 350, "name": "password", "kind": 1024, "kindString": "Property", @@ -54808,7 +54958,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 152, + "line": 172, "character": 2 } ], @@ -54818,12 +54968,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 352, + "id": 341, "name": "UserAttributes.password" } }, { - "id": 361, + "id": 349, "name": "phone", "kind": 1024, "kindString": "Property", @@ -54836,7 +54986,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 147, + "line": 167, "character": 2 } ], @@ -54846,12 +54996,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 351, + "id": 340, "name": "UserAttributes.phone" } }, { - "id": 359, + "id": 347, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -54859,13 +55009,13 @@ "isOptional": true }, "comment": { - "shortText": "Sets if a user has confirmed their phone number.", + "shortText": "Confirms the user's phone number if set to true.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 201, + "line": 219, "character": 2 } ], @@ -54875,7 +55025,7 @@ } }, { - "id": 356, + "id": 344, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -54883,13 +55033,13 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object for user_metadata.", - "text": "Can be any JSON.\n\nOnly a service role can modify.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's user_metadata,\nthis attribute is used instead of UserAttributes data.\n\n" + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "Only a service role can modify.\n\nThe `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 177, + "line": 195, "character": 2 } ], @@ -54904,29 +55054,28 @@ "title": "Properties", "kind": 1024, "children": [ - 357, - 364, - 360, - 363, - 358, - 362, - 361, - 359, - 356 + 345, + 351, + 348, + 346, + 350, + 349, + 347, + 344 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 165, + "line": 183, "character": 17 } ], "extendedTypes": [ { "type": "reference", - "id": 349, + "id": 338, "name": "UserAttributes" } ] @@ -54939,7 +55088,7 @@ "typeArguments": [ { "type": "reference", - "id": 291, + "id": 280, "name": "UserResponse" } ], @@ -54963,34 +55112,34 @@ "title": "Methods", "kind": 2048, "children": [ - 56, - 78, + 41, + 63, 38, - 71, + 56, 31, - 59, + 44, 26, - 74 + 59 ] } ], "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 6, + "line": 12, "character": 21 } ] }, { - "id": 81, + "id": 66, "name": "GoTrueClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 82, + "id": 67, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -55004,7 +55153,7 @@ ], "signatures": [ { - "id": 83, + "id": 68, "name": "new GoTrueClient", "kind": 16384, "kindString": "Constructor signature", @@ -55014,388 +55163,274 @@ }, "parameters": [ { - "id": 84, + "id": 69, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reflection", - "declaration": { - "id": 85, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "type": "reference", + "id": 241, + "name": "GoTrueClientOptions", + "dereferenced": { + "id": 241, + "name": "GoTrueClientOptions", + "kind": 4194304, + "kindString": "Type alias", "flags": {}, - "children": [ + "sources": [ { - "id": 93, - "name": "autoRefreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set to \"true\" if you want to automatically refresh the token before expiring." - }, - "sources": [ + "fileName": "src/lib/types.ts", + "line": 31, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 242, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ { - "fileName": "src/GoTrueClient.ts", - "line": 109, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 92, - "name": "detectSessionInUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set to \"true\" if you want to automatically detects OAuth grants in the URL and signs in the user." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 108, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 97, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 113, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 98, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ + "id": 250, + "name": "autoRefreshToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ { - "id": 99, + "fileName": "src/lib/types.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 249, + "name": "detectSessionInUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 39, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 253, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 47, + "character": 2 + } + ], + "type": { + "type": "reference", + "name": "Fetch" + } + }, + { + "id": 244, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 35, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 245, "name": "__type", - "kind": 4096, - "kindString": "Call signature", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "comment": { - "shortText": "A custom fetch implementation.\n" - }, - "parameters": [ + "sources": [ { - "id": 100, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 101, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } + "fileName": "src/lib/types.ts", + "line": 35, + "character": 12 } ], - "type": { - "type": "reference", - "typeArguments": [ + "indexSignature": { + "id": 246, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "id": 247, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 87, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Any additional headers to send to the GoTrue server." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 106, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 88, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 89, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 90, - "name": "key", - "kind": 32768, - "flags": {}, "type": { "type": "intrinsic", "name": "string" } } - ], - "type": { - "type": "intrinsic", - "name": "string" } } - } - } - }, - { - "id": 96, - "name": "multiTab", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set to \"false\" if you want to disable multi-tab/window events." - }, - "sources": [ + }, { - "fileName": "src/GoTrueClient.ts", - "line": 112, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 94, - "name": "persistSession", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set to \"true\" if you want to automatically save the user session into local storage. If set to false, session will just be saved in memory." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 110, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 95, - "name": "storage", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 111, - "character": 4 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Storage", - "package": "typescript", - "name": "Storage" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "getItem" - }, - { - "type": "literal", - "value": "removeItem" - }, - { - "type": "literal", - "value": "setItem" - } - ] - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "id": 251, + "name": "persistSession", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 43, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" } - ], - "name": "PromisifyMethods" - } - }, - { - "id": 91, - "name": "storageKey", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional key name used for storing tokens in local storage" - }, - "sources": [ + }, { - "fileName": "src/GoTrueClient.ts", - "line": 107, - "character": 4 + "id": 252, + "name": "storage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 45, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 480, + "name": "SupportedStorage" + } + }, + { + "id": 248, + "name": "storageKey", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 37, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 243, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 33, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } } ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 86, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The URL of the GoTrue server." - }, - "sources": [ + "groups": [ { - "fileName": "src/GoTrueClient.ts", - "line": 105, - "character": 4 + "title": "Properties", + "kind": 1024, + "children": [ + 250, + 249, + 253, + 244, + 251, + 252, + 248, + 243 + ] } ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 93, - 92, - 97, - 87, - 96, - 94, - 95, - 91, - 86 + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 31, + "character": 34 + } ] } - ] + } } } } ], "type": { "type": "reference", - "id": 81, + "id": 66, "name": "default" } } ] }, { - "id": 102, + "id": 70, "name": "admin", "kind": 1024, "kindString": "Property", @@ -55406,7 +55441,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 66, + "line": 68, "character": 2 } ], @@ -55417,7 +55452,7 @@ } }, { - "id": 141, + "id": 111, "name": "getSession", "kind": 2048, "kindString": "Method", @@ -55425,19 +55460,19 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 362, + "line": 407, "character": 8 } ], "signatures": [ { - "id": 142, + "id": 112, "name": "getSession", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the session data, refreshing it if necessary.\nIf no session is detected, the session returned will be null." + "shortText": "Returns the session, refreshing it if necessary.\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out." }, "type": { "type": "reference", @@ -55448,14 +55483,14 @@ { "type": "reflection", "declaration": { - "id": 143, + "id": 113, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 144, + "id": 114, "name": "data", "kind": 1024, "kindString": "Property", @@ -55463,21 +55498,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 364, + "line": 409, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 145, + "id": 115, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 146, + "id": 116, "name": "session", "kind": 1024, "kindString": "Property", @@ -55485,13 +55520,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 365, + "line": 410, "character": 10 } ], "type": { "type": "reference", - "id": 302, + "id": 291, "name": "Session" } } @@ -55501,7 +55536,7 @@ "title": "Properties", "kind": 1024, "children": [ - 146 + 116 ] } ] @@ -55509,7 +55544,7 @@ } }, { - "id": 147, + "id": 117, "name": "error", "kind": 1024, "kindString": "Property", @@ -55517,7 +55552,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 367, + "line": 412, "character": 8 } ], @@ -55532,8 +55567,8 @@ "title": "Properties", "kind": 1024, "children": [ - 144, - 147 + 114, + 117 ] } ] @@ -55542,14 +55577,14 @@ { "type": "reflection", "declaration": { - "id": 148, + "id": 118, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 149, + "id": 119, "name": "data", "kind": 1024, "kindString": "Property", @@ -55557,21 +55592,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 370, + "line": 415, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 150, + "id": 120, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 151, + "id": 121, "name": "session", "kind": 1024, "kindString": "Property", @@ -55579,7 +55614,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 371, + "line": 416, "character": 10 } ], @@ -55594,7 +55629,7 @@ "title": "Properties", "kind": 1024, "children": [ - 151 + 121 ] } ] @@ -55602,7 +55637,7 @@ } }, { - "id": 152, + "id": 122, "name": "error", "kind": 1024, "kindString": "Property", @@ -55610,13 +55645,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 373, + "line": 418, "character": 8 } ], "type": { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } } @@ -55626,8 +55661,8 @@ "title": "Properties", "kind": 1024, "children": [ - 149, - 152 + 119, + 122 ] } ] @@ -55636,14 +55671,14 @@ { "type": "reflection", "declaration": { - "id": 153, + "id": 123, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 154, + "id": 124, "name": "data", "kind": 1024, "kindString": "Property", @@ -55651,21 +55686,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 376, + "line": 421, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 155, + "id": 125, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 156, + "id": 126, "name": "session", "kind": 1024, "kindString": "Property", @@ -55673,7 +55708,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 377, + "line": 422, "character": 10 } ], @@ -55688,7 +55723,7 @@ "title": "Properties", "kind": 1024, "children": [ - 156 + 126 ] } ] @@ -55696,7 +55731,7 @@ } }, { - "id": 157, + "id": 127, "name": "error", "kind": 1024, "kindString": "Property", @@ -55704,7 +55739,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 379, + "line": 424, "character": 8 } ], @@ -55719,8 +55754,8 @@ "title": "Properties", "kind": 1024, "children": [ - 154, - 157 + 124, + 127 ] } ] @@ -55737,7 +55772,7 @@ ] }, { - "id": 158, + "id": 128, "name": "getUser", "kind": 2048, "kindString": "Method", @@ -55745,13 +55780,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 419, + "line": 470, "character": 8 } ], "signatures": [ { - "id": 159, + "id": 129, "name": "getUser", "kind": 4096, "kindString": "Call signature", @@ -55761,7 +55796,7 @@ }, "parameters": [ { - "id": 160, + "id": 130, "name": "jwt", "kind": 32768, "kindString": "Parameter", @@ -55782,7 +55817,7 @@ "typeArguments": [ { "type": "reference", - "id": 291, + "id": 280, "name": "UserResponse" } ], @@ -55794,7 +55829,46 @@ ] }, { - "id": 179, + "id": 92, + "name": "initialize", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 130, + "character": 2 + } + ], + "signatures": [ + { + "id": 93, + "name": "initialize", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Initializes the client session either from the url or from storage.\nThis method is automatically called when instantiating the client, but should also be called\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 481, + "name": "InitializeResult" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 157, "name": "onAuthStateChange", "kind": 2048, "kindString": "Method", @@ -55802,61 +55876,60 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 593, + "line": 665, "character": 2 } ], "signatures": [ { - "id": 180, + "id": 158, "name": "onAuthStateChange", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Receive a notification every time an auth event happens.", - "returns": "A subscription object which can be used to unsubscribe itself.\n" + "shortText": "Receive a notification every time an auth event happens." }, "parameters": [ { - "id": 181, + "id": 159, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A callback function to be invoked when an auth event happens." + "shortText": "A callback function to be invoked when an auth event happens.\n" }, "type": { "type": "reflection", "declaration": { - "id": 182, + "id": 160, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 183, + "id": 161, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 184, + "id": 162, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 264, + "id": 240, "name": "AuthChangeEvent" } }, { - "id": 185, + "id": 163, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -55870,7 +55943,7 @@ }, { "type": "reference", - "id": 302, + "id": 291, "name": "Session" } ] @@ -55888,133 +55961,85 @@ } ], "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 186, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "type": "reflection", + "declaration": { + "id": 164, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 165, + "name": "data", + "kind": 1024, + "kindString": "Property", "flags": {}, - "children": [ + "sources": [ { - "id": 188, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 596, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 187, - "name": "subscription", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 595, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 365, - "name": "Subscription" - } + "fileName": "src/GoTrueClient.ts", + "line": 666, + "character": 4 } ], - "groups": [ - { - "title": "Properties", - "kind": 1024, + "type": { + "type": "reflection", + "declaration": { + "id": 166, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, "children": [ - 188, - 187 + { + "id": 167, + "name": "subscription", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 666, + "character": 12 + } + ], + "type": { + "type": "reference", + "id": 352, + "name": "Subscription" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 167 + ] + } ] } - ] + } } - }, - { - "type": "reflection", - "declaration": { - "id": 189, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, "children": [ - { - "id": 191, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 598, - "character": 28 - } - ], - "type": { - "type": "reference", - "id": 450, - "name": "AuthError" - } - }, - { - "id": 190, - "name": "subscription", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 598, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 191, - 190 - ] - } + 165 ] } - } - ] + ] + } } } ] }, { - "id": 192, + "id": 168, "name": "resetPasswordForEmail", "kind": 2048, "kindString": "Method", @@ -56022,23 +56047,23 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 625, + "line": 688, "character": 8 } ], "signatures": [ { - "id": 193, + "id": 169, "name": "resetPasswordForEmail", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sends a reset request to an email address." + "shortText": "Sends a password reset request to an email address." }, "parameters": [ { - "id": 194, + "id": 170, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -56052,7 +56077,7 @@ } }, { - "id": 195, + "id": 171, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -56060,14 +56085,14 @@ "type": { "type": "reflection", "declaration": { - "id": 196, + "id": 172, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 198, + "id": 174, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -56080,7 +56105,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 629, + "line": 692, "character": 6 } ], @@ -56090,7 +56115,7 @@ } }, { - "id": 197, + "id": 173, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -56098,12 +56123,12 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "shortText": "The URL to send the user to after they click the password reset link." }, "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 628, + "line": 691, "character": 6 } ], @@ -56118,8 +56143,8 @@ "title": "Properties", "kind": 1024, "children": [ - 198, - 197 + 174, + 173 ] } ] @@ -56137,14 +56162,14 @@ { "type": "reflection", "declaration": { - "id": 199, + "id": 175, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 200, + "id": 176, "name": "data", "kind": 1024, "kindString": "Property", @@ -56152,14 +56177,14 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 633, + "line": 696, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 201, + "id": 177, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -56168,7 +56193,7 @@ } }, { - "id": 202, + "id": 178, "name": "error", "kind": 1024, "kindString": "Property", @@ -56176,7 +56201,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 634, + "line": 697, "character": 8 } ], @@ -56191,8 +56216,8 @@ "title": "Properties", "kind": 1024, "children": [ - 200, - 202 + 176, + 178 ] } ] @@ -56201,14 +56226,14 @@ { "type": "reflection", "declaration": { - "id": 203, + "id": 179, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 204, + "id": 180, "name": "data", "kind": 1024, "kindString": "Property", @@ -56216,7 +56241,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 636, + "line": 699, "character": 8 } ], @@ -56226,7 +56251,7 @@ } }, { - "id": 205, + "id": 181, "name": "error", "kind": 1024, "kindString": "Property", @@ -56234,13 +56259,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 636, + "line": 699, "character": 20 } ], "type": { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } } @@ -56250,8 +56275,8 @@ "title": "Properties", "kind": 1024, "children": [ - 204, - 205 + 180, + 181 ] } ] @@ -56268,7 +56293,7 @@ ] }, { - "id": 164, + "id": 134, "name": "setSession", "kind": 2048, "kindString": "Method", @@ -56276,29 +56301,29 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 482, + "line": 534, "character": 8 } ], "signatures": [ { - "id": 165, + "id": 135, "name": "setSession", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the session data from refresh_token and returns current session or an error if the refresh_token is invalid." + "shortText": "Sets the session data from refresh token and returns current session or an error if the refresh token is invalid." }, "parameters": [ { - "id": 166, + "id": 136, "name": "refresh_token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The refresh token returned by gotrue.\n" + "shortText": "A refresh token returned by supabase auth.\n" }, "type": { "type": "intrinsic", @@ -56311,7 +56336,7 @@ "typeArguments": [ { "type": "reference", - "id": 265, + "id": 254, "name": "AuthResponse" } ], @@ -56323,7 +56348,7 @@ ] }, { - "id": 128, + "id": 102, "name": "signInWithOAuth", "kind": 2048, "kindString": "Method", @@ -56331,13 +56356,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 258, + "line": 306, "character": 8 } ], "signatures": [ { - "id": 129, + "id": 103, "name": "signInWithOAuth", "kind": 4096, "kindString": "Call signature", @@ -56347,17 +56372,17 @@ }, "parameters": [ { - "id": 130, + "id": 104, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 416, + "id": 403, "name": "SignInWithOAuthCredentials", "dereferenced": { - "id": 416, + "id": 403, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -56365,21 +56390,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 292, + "line": 318, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 417, + "id": 404, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 419, + "id": 406, "name": "options", "kind": 1024, "kindString": "Property", @@ -56389,21 +56414,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 295, + "line": 321, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 420, + "id": 407, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 423, + "id": 410, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -56416,14 +56441,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 301, + "line": 327, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 424, + "id": 411, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -56431,19 +56456,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 301, + "line": 327, "character": 18 } ], "indexSignature": { - "id": 425, + "id": 412, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 426, + "id": 413, "name": "key", "kind": 32768, "flags": {}, @@ -56462,7 +56487,7 @@ } }, { - "id": 421, + "id": 408, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -56470,12 +56495,12 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed (OAuth logins only)." + "shortText": "A URL to send the user to after they are confirmed." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 297, + "line": 323, "character": 4 } ], @@ -56485,7 +56510,7 @@ } }, { - "id": 422, + "id": 409, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -56498,7 +56523,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 299, + "line": 325, "character": 4 } ], @@ -56513,16 +56538,16 @@ "title": "Properties", "kind": 1024, "children": [ - 423, - 421, - 422 + 410, + 408, + 409 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 295, + "line": 321, "character": 12 } ] @@ -56530,7 +56555,7 @@ } }, { - "id": 418, + "id": 405, "name": "provider", "kind": 1024, "kindString": "Property", @@ -56541,13 +56566,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 294, + "line": 320, "character": 2 } ], "type": { "type": "reference", - "id": 263, + "id": 239, "name": "Provider" } } @@ -56557,15 +56582,15 @@ "title": "Properties", "kind": 1024, "children": [ - 419, - 418 + 406, + 405 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 292, + "line": 318, "character": 41 } ] @@ -56580,7 +56605,7 @@ "typeArguments": [ { "type": "reference", - "id": 278, + "id": 267, "name": "OAuthResponse" } ], @@ -56592,7 +56617,7 @@ ] }, { - "id": 131, + "id": 105, "name": "signInWithOtp", "kind": 2048, "kindString": "Method", @@ -56600,401 +56625,23 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 270, + "line": 321, "character": 8 } ], "signatures": [ { - "id": 132, + "id": 106, "name": "signInWithOtp", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Passwordless method for logging in an existing user." + "shortText": "Log in a user using magiclink or a one-time password (OTP).\nIf the `{{ .ConfirmationURL }}` variable is specified in the email template, a magiclink will be sent.\nIf the `{{ .Token }}` variable is specified in the email template, an OTP will be sent.\nIf you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins." }, "parameters": [ { - "id": 133, - "name": "credentials", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 402, - "name": "SignInWithPasswordlessCredentials", - "dereferenced": { - "id": 402, - "name": "SignInWithPasswordlessCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 268, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 403, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 404, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 271, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 405, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 272, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 406, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 409, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 278, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 407, - "name": "emailRedirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The redirect url embedded in the email link" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 274, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 408, - "name": "shouldCreateUser", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 276, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 409, - 407, - 408 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 272, - "character": 16 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 404, - 405 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 269, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 410, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 412, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 284, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 413, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 415, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 288, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 414, - "name": "shouldCreateUser", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 286, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 415, - 414 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 284, - "character": 16 - } - ] - } - } - }, - { - "id": 411, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 283, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 412, - 411 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 281, - "character": 4 - } - ] - } - } - ] - } - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 265, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 125, - "name": "signInWithPassword", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 210, - "character": 8 - } - ], - "signatures": [ - { - "id": 126, - "name": "signInWithPassword", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Log in an existing user, or login via a third-party provider." - }, - "parameters": [ - { - "id": 127, + "id": 107, "name": "credentials", "kind": 32768, "kindString": "Parameter", @@ -57002,17 +56649,17 @@ "type": { "type": "reference", "id": 389, - "name": "SignInWithPasswordCredentials", + "name": "SignInWithPasswordlessCredentials", "dereferenced": { "id": 389, - "name": "SignInWithPasswordCredentials", + "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 246, + "line": 294, "character": 12 } ], @@ -57040,7 +56687,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 249, + "line": 297, "character": 6 } ], @@ -57050,7 +56697,7 @@ } }, { - "id": 393, + "id": 392, "name": "options", "kind": 1024, "kindString": "Property", @@ -57060,21 +56707,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 252, + "line": 298, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 394, + "id": 393, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 395, + "id": 396, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -57087,7 +56734,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 254, + "line": 304, "character": 8 } ], @@ -57095,6 +56742,52 @@ "type": "intrinsic", "name": "string" } + }, + { + "id": 394, + "name": "emailRedirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The redirect url embedded in the email link" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 300, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 395, + "name": "shouldCreateUser", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If set to false, this method will not create a new user. Defaults to true." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 302, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ @@ -57102,6 +56795,8 @@ "title": "Properties", "kind": 1024, "children": [ + 396, + 394, 395 ] } @@ -57109,33 +56804,12 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 252, + "line": 298, "character": 16 } ] } } - }, - { - "id": 392, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 251, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } } ], "groups": [ @@ -57144,7 +56818,6 @@ "kind": 1024, "children": [ 391, - 393, 392 ] } @@ -57152,7 +56825,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 247, + "line": 295, "character": 4 } ] @@ -57161,7 +56834,7 @@ { "type": "reflection", "declaration": { - "id": 396, + "id": 397, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -57178,7 +56851,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 262, + "line": 310, "character": 6 } ], @@ -57192,7 +56865,7 @@ "flags": {}, "children": [ { - "id": 401, + "id": 402, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -57205,7 +56878,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 264, + "line": 314, "character": 8 } ], @@ -57213,6 +56886,29 @@ "type": "intrinsic", "name": "string" } + }, + { + "id": 401, + "name": "shouldCreateUser", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If set to false, this method will not create a new user. Defaults to true." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 312, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ @@ -57220,6 +56916,7 @@ "title": "Properties", "kind": 1024, "children": [ + 402, 401 ] } @@ -57227,7 +56924,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 262, + "line": 310, "character": 16 } ] @@ -57236,27 +56933,6 @@ }, { "id": 398, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 261, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 397, "name": "phone", "kind": 1024, "kindString": "Property", @@ -57267,7 +56943,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 259, + "line": 309, "character": 6 } ], @@ -57283,15 +56959,14 @@ "kind": 1024, "children": [ 399, - 398, - 397 + 398 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 257, + "line": 307, "character": 4 } ] @@ -57308,7 +56983,7 @@ "typeArguments": [ { "type": "reference", - "id": 265, + "id": 254, "name": "AuthResponse" } ], @@ -57320,134 +56995,49 @@ ] }, { - "id": 175, - "name": "signOut", + "id": 99, + "name": "signInWithPassword", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 573, + "line": 256, "character": 8 } ], "signatures": [ { - "id": 176, - "name": "signOut", + "id": 100, + "name": "signInWithPassword", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Inside a browser context, `signOut()` will remove the logged in user from the browser session\nand log them out - removing all items from localstorage and then trigger a \"SIGNED_OUT\" event.", - "text": "For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to `auth.api.signOut(JWT: string)`.\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 177, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 178, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 573, - "character": 29 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 450, - "name": "AuthError" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 178 - ] - } - ] - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 122, - "name": "signUp", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 147, - "character": 8 - } - ], - "signatures": [ - { - "id": 123, - "name": "signUp", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new user.", - "returns": "A logged-in session if the server has \"autoconfirm\" ON" + "shortText": "Log in an existing user with an email and password or phone and password." }, "parameters": [ { - "id": 124, + "id": 101, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 373, - "name": "SignUpWithPasswordCredentials", + "id": 376, + "name": "SignInWithPasswordCredentials", "dereferenced": { - "id": 373, - "name": "SignUpWithPasswordCredentials", + "id": 376, + "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 219, + "line": 272, "character": 12 } ], @@ -57457,14 +57047,14 @@ { "type": "reflection", "declaration": { - "id": 374, + "id": 377, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 375, + "id": 378, "name": "email", "kind": 1024, "kindString": "Property", @@ -57475,7 +57065,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 222, + "line": 275, "character": 6 } ], @@ -57485,7 +57075,7 @@ } }, { - "id": 377, + "id": 380, "name": "options", "kind": 1024, "kindString": "Property", @@ -57495,21 +57085,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 225, + "line": 278, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 378, + "id": 381, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 381, + "id": 382, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -57522,53 +57112,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 231, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 380, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's metadata." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 229, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 379, - "name": "emailRedirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The redirect url embedded in the email link" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 227, + "line": 280, "character": 8 } ], @@ -57583,16 +57127,14 @@ "title": "Properties", "kind": 1024, "children": [ - 381, - 380, - 379 + 382 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 225, + "line": 278, "character": 16 } ] @@ -57600,7 +57142,7 @@ } }, { - "id": 376, + "id": 379, "name": "password", "kind": 1024, "kindString": "Property", @@ -57611,7 +57153,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 224, + "line": 277, "character": 6 } ], @@ -57626,16 +57168,16 @@ "title": "Properties", "kind": 1024, "children": [ - 375, - 377, - 376 + 378, + 380, + 379 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 220, + "line": 273, "character": 4 } ] @@ -57644,14 +57186,14 @@ { "type": "reflection", "declaration": { - "id": 382, + "id": 383, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 385, + "id": 386, "name": "options", "kind": 1024, "kindString": "Property", @@ -57661,14 +57203,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 239, + "line": 288, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 386, + "id": 387, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -57688,7 +57230,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 243, + "line": 290, "character": 8 } ], @@ -57696,29 +57238,6 @@ "type": "intrinsic", "name": "string" } - }, - { - "id": 387, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's metadata." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 241, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } } ], "groups": [ @@ -57726,15 +57245,14 @@ "title": "Properties", "kind": 1024, "children": [ - 388, - 387 + 388 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 239, + "line": 288, "character": 16 } ] @@ -57742,7 +57260,7 @@ } }, { - "id": 384, + "id": 385, "name": "password", "kind": 1024, "kindString": "Property", @@ -57753,7 +57271,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 238, + "line": 287, "character": 6 } ], @@ -57763,7 +57281,7 @@ } }, { - "id": 383, + "id": 384, "name": "phone", "kind": 1024, "kindString": "Property", @@ -57774,7 +57292,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 236, + "line": 285, "character": 6 } ], @@ -57789,16 +57307,16 @@ "title": "Properties", "kind": 1024, "children": [ + 386, 385, - 384, - 383 + 384 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 234, + "line": 283, "character": 4 } ] @@ -57815,7 +57333,7 @@ "typeArguments": [ { "type": "reference", - "id": 265, + "id": 254, "name": "AuthResponse" } ], @@ -57827,7 +57345,516 @@ ] }, { - "id": 161, + "id": 153, + "name": "signOut", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 646, + "character": 8 + } + ], + "signatures": [ + { + "id": 154, + "name": "signOut", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Inside a browser context, `signOut()` will remove the logged in user from the browser session\nand log them out - removing all items from localstorage and then trigger a `\"SIGNED_OUT\"` event.", + "text": "For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to `auth.api.signOut(JWT: string)`.\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 155, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 156, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 646, + "character": 29 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 494, + "name": "AuthError" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 156 + ] + } + ] + } + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 96, + "name": "signUp", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 193, + "character": 8 + } + ], + "signatures": [ + { + "id": 97, + "name": "signUp", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Creates a new user.", + "returns": "A logged-in session if the server has \"autoconfirm\" ON" + }, + "parameters": [ + { + "id": 98, + "name": "credentials", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 360, + "name": "SignUpWithPasswordCredentials", + "dereferenced": { + "id": 360, + "name": "SignUpWithPasswordCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 237, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 361, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 362, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 240, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 364, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 243, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 365, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 368, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 253, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 367, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 251, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 366, + "name": "emailRedirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The redirect url embedded in the email link" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 245, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 368, + 367, + 366 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 243, + "character": 16 + } + ] + } + } + }, + { + "id": 363, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 242, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 362, + 364, + 363 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 238, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 369, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 372, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 261, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 373, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 375, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 269, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 374, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 267, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 375, + 374 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 261, + "character": 16 + } + ] + } + } + }, + { + "id": 371, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 260, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 370, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 258, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 372, + 371, + 370 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 256, + "character": 4 + } + ] + } + } + ] + } + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 254, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 131, "name": "updateUser", "kind": 2048, "kindString": "Method", @@ -57835,13 +57862,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 448, + "line": 499, "character": 8 } ], "signatures": [ { - "id": 162, + "id": 132, "name": "updateUser", "kind": 4096, "kindString": "Call signature", @@ -57851,24 +57878,24 @@ }, "parameters": [ { - "id": 163, + "id": 133, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 349, + "id": 338, "name": "UserAttributes", "dereferenced": { - "id": 349, + "id": 338, "name": "UserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 354, + "id": 342, "name": "data", "kind": 1024, "kindString": "Property", @@ -57876,12 +57903,13 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object for user_metadata that a user can modify. Can be any JSON." + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 162, + "line": 180, "character": 2 } ], @@ -57891,7 +57919,7 @@ } }, { - "id": 350, + "id": 339, "name": "email", "kind": 1024, "kindString": "Property", @@ -57904,7 +57932,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 142, + "line": 162, "character": 2 } ], @@ -57914,30 +57942,7 @@ } }, { - "id": 353, - "name": "email_change_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "An email change token." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 157, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 352, + "id": 341, "name": "password", "kind": 1024, "kindString": "Property", @@ -57950,7 +57955,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 152, + "line": 172, "character": 2 } ], @@ -57960,7 +57965,7 @@ } }, { - "id": 351, + "id": 340, "name": "phone", "kind": 1024, "kindString": "Property", @@ -57973,7 +57978,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 147, + "line": 167, "character": 2 } ], @@ -57988,25 +57993,24 @@ "title": "Properties", "kind": 1024, "children": [ - 354, - 350, - 353, - 352, - 351 + 342, + 339, + 341, + 340 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 138, + "line": 158, "character": 17 } ], "extendedBy": [ { "type": "reference", - "id": 355, + "id": 343, "name": "AdminUserAttributes" } ] @@ -58019,7 +58023,7 @@ "typeArguments": [ { "type": "reference", - "id": 291, + "id": 280, "name": "UserResponse" } ], @@ -58031,7 +58035,7 @@ ] }, { - "id": 134, + "id": 108, "name": "verifyOtp", "kind": 2048, "kindString": "Method", @@ -58039,13 +58043,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 313, + "line": 363, "character": 8 } ], "signatures": [ { - "id": 135, + "id": 109, "name": "verifyOtp", "kind": 4096, "kindString": "Call signature", @@ -58055,17 +58059,17 @@ }, "parameters": [ { - "id": 136, + "id": 110, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 427, + "id": 414, "name": "VerifyOtpParams", "dereferenced": { - "id": 427, + "id": 414, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -58073,7 +58077,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 305, + "line": 331, "character": 12 } ], @@ -58082,94 +58086,18 @@ "types": [ { "type": "reference", - "id": 428, + "id": 415, "name": "VerifyMobileOtpParams" }, { "type": "reference", - "id": 432, + "id": 423, "name": "VerifyEmailOtpParams" } ] } } } - }, - { - "id": 137, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 138, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 140, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 317, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 139, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A URL to send the user to after they are confirmed." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 316, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 140, - 139 - ] - } - ] - } - }, - "defaultValue": "{}" } ], "type": { @@ -58177,7 +58105,7 @@ "typeArguments": [ { "type": "reference", - "id": 265, + "id": 254, "name": "AuthResponse" } ], @@ -58194,52 +58122,53 @@ "title": "Constructors", "kind": 512, "children": [ - 82 + 67 ] }, { "title": "Properties", "kind": 1024, "children": [ - 102 + 70 ] }, { "title": "Methods", "kind": 2048, "children": [ - 141, - 158, - 179, - 192, - 164, + 111, 128, + 92, + 157, + 168, + 134, + 102, + 105, + 99, + 153, + 96, 131, - 125, - 175, - 122, - 161, - 134 + 108 ] } ], "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 61, + "line": 63, "character": 21 } ] }, { - "id": 355, + "id": 343, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 357, + "id": 345, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -58247,13 +58176,13 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object for app_metadata that.", - "text": "Only a service role can modify.\n\nCan be any JSON that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" + "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", + "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 187, + "line": 205, "character": 2 } ], @@ -58263,7 +58192,7 @@ } }, { - "id": 364, + "id": 351, "name": "data", "kind": 1024, "kindString": "Property", @@ -58271,12 +58200,13 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object for user_metadata that a user can modify. Can be any JSON." + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 162, + "line": 180, "character": 2 } ], @@ -58286,12 +58216,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 354, + "id": 342, "name": "UserAttributes.data" } }, { - "id": 360, + "id": 348, "name": "email", "kind": 1024, "kindString": "Property", @@ -58304,7 +58234,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 142, + "line": 162, "character": 2 } ], @@ -58314,40 +58244,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 350, + "id": 339, "name": "UserAttributes.email" } }, { - "id": 363, - "name": "email_change_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "An email change token." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 157, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 353, - "name": "UserAttributes.email_change_token" - } - }, - { - "id": 358, + "id": 346, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -58355,13 +58257,13 @@ "isOptional": true }, "comment": { - "shortText": "Sets if a user has confirmed their email address.", + "shortText": "Confirms the user's email address if set to true.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 194, + "line": 212, "character": 2 } ], @@ -58371,7 +58273,7 @@ } }, { - "id": 362, + "id": 350, "name": "password", "kind": 1024, "kindString": "Property", @@ -58384,7 +58286,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 152, + "line": 172, "character": 2 } ], @@ -58394,12 +58296,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 352, + "id": 341, "name": "UserAttributes.password" } }, { - "id": 361, + "id": 349, "name": "phone", "kind": 1024, "kindString": "Property", @@ -58412,7 +58314,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 147, + "line": 167, "character": 2 } ], @@ -58422,12 +58324,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 351, + "id": 340, "name": "UserAttributes.phone" } }, { - "id": 359, + "id": 347, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -58435,13 +58337,13 @@ "isOptional": true }, "comment": { - "shortText": "Sets if a user has confirmed their phone number.", + "shortText": "Confirms the user's phone number if set to true.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 201, + "line": 219, "character": 2 } ], @@ -58451,7 +58353,7 @@ } }, { - "id": 356, + "id": 344, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -58459,13 +58361,13 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object for user_metadata.", - "text": "Can be any JSON.\n\nOnly a service role can modify.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's user_metadata,\nthis attribute is used instead of UserAttributes data.\n\n" + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "Only a service role can modify.\n\nThe `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 177, + "line": 195, "character": 2 } ], @@ -58480,42 +58382,114 @@ "title": "Properties", "kind": 1024, "children": [ - 357, - 364, - 360, - 363, - 358, - 362, - 361, - 359, - 356 + 345, + 351, + 348, + 346, + 350, + 349, + 347, + 344 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 165, + "line": 183, "character": 17 } ], "extendedTypes": [ { "type": "reference", - "id": 349, + "id": 338, "name": "UserAttributes" } ] }, { - "id": 302, + "id": 455, + "name": "GenerateLinkOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 456, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 402, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 457, + "name": "redirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The URL which will be appended to the email link generated." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 404, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 456, + 457 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 396, + "character": 17 + } + ] + }, + { + "id": 291, "name": "Session", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 304, + "id": 293, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -58526,7 +58500,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 81, + "line": 101, "character": 2 } ], @@ -58536,7 +58510,7 @@ } }, { - "id": 307, + "id": 296, "name": "expires_at", "kind": 1024, "kindString": "Property", @@ -58549,7 +58523,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 93, + "line": 113, "character": 2 } ], @@ -58559,7 +58533,7 @@ } }, { - "id": 306, + "id": 295, "name": "expires_in", "kind": 1024, "kindString": "Property", @@ -58570,7 +58544,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 89, + "line": 109, "character": 2 } ], @@ -58580,7 +58554,7 @@ } }, { - "id": 303, + "id": 292, "name": "provider_token", "kind": 1024, "kindString": "Property", @@ -58590,7 +58564,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 77, + "line": 97, "character": 2 } ], @@ -58609,7 +58583,7 @@ } }, { - "id": 305, + "id": 294, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -58620,7 +58594,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 85, + "line": 105, "character": 2 } ], @@ -58630,7 +58604,7 @@ } }, { - "id": 308, + "id": 297, "name": "token_type", "kind": 1024, "kindString": "Property", @@ -58638,7 +58612,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 94, + "line": 114, "character": 2 } ], @@ -58648,7 +58622,7 @@ } }, { - "id": 309, + "id": 298, "name": "user", "kind": 1024, "kindString": "Property", @@ -58656,13 +58630,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 95, + "line": 115, "character": 2 } ], "type": { "type": "reference", - "id": 321, + "id": 310, "name": "User" } } @@ -58672,33 +58646,33 @@ "title": "Properties", "kind": 1024, "children": [ - 304, - 307, - 306, - 303, - 305, - 308, - 309 + 293, + 296, + 295, + 292, + 294, + 297, + 298 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 76, + "line": 96, "character": 17 } ] }, { - "id": 365, + "id": 352, "name": "Subscription", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 366, + "id": 353, "name": "id", "kind": 1024, "kindString": "Property", @@ -58709,7 +58683,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 208, + "line": 226, "character": 2 } ], @@ -58719,7 +58693,7 @@ } }, { - "id": 367, + "id": 354, "name": "callback", "kind": 2048, "kindString": "Method", @@ -58727,13 +58701,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 212, + "line": 230, "character": 2 } ], "signatures": [ { - "id": 368, + "id": 355, "name": "callback", "kind": 4096, "kindString": "Call signature", @@ -58743,17 +58717,17 @@ }, "parameters": [ { - "id": 369, + "id": 356, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 264, + "id": 240, "name": "AuthChangeEvent", "dereferenced": { - "id": 264, + "id": 240, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -58761,7 +58735,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 22, + "line": 23, "character": 12 } ], @@ -58798,7 +58772,7 @@ } }, { - "id": 370, + "id": 357, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -58812,7 +58786,7 @@ }, { "type": "reference", - "id": 302, + "id": 291, "name": "Session" } ] @@ -58827,7 +58801,7 @@ ] }, { - "id": 371, + "id": 358, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -58835,13 +58809,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 216, + "line": 234, "character": 2 } ], "signatures": [ { - "id": 372, + "id": 359, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -58862,35 +58836,35 @@ "title": "Properties", "kind": 1024, "children": [ - 366 + 353 ] }, { "title": "Methods", "kind": 2048, "children": [ - 367, - 371 + 354, + 358 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 204, + "line": 222, "character": 17 } ] }, { - "id": 321, + "id": 310, "name": "User", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 338, + "id": 327, "name": "action_link", "kind": 1024, "kindString": "Property", @@ -58900,7 +58874,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 125, + "line": 145, "character": 2 } ], @@ -58910,7 +58884,7 @@ } }, { - "id": 323, + "id": 312, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -58918,21 +58892,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 112, + "line": 132, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 324, + "id": 313, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 325, + "id": 314, "name": "provider", "kind": 1024, "kindString": "Property", @@ -58942,7 +58916,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 113, + "line": 133, "character": 4 } ], @@ -58957,673 +58931,10 @@ "title": "Properties", "kind": 1024, "children": [ - 325 + 314 ] } ], - "indexSignature": { - "id": 326, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 327, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 332, - "name": "aud", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 119, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 333, - "name": "confirmation_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 120, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 342, - "name": "confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 129, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 341, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 128, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 339, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 126, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 335, - "name": "email_change_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 122, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 343, - "name": "email_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 130, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 322, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 111, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 348, - "name": "identities", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 135, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 310, - "name": "UserIdentity" - } - } - }, - { - "id": 337, - "name": "invited_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 124, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 345, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 132, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 336, - "name": "new_email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 123, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 340, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 127, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 344, - "name": "phone_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 131, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 334, - "name": "recovery_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 121, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 346, - "name": "role", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 133, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 347, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 134, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 328, - "name": "user_metadata", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 116, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 329, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 330, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 331, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 338, - 323, - 332, - 333, - 342, - 341, - 339, - 335, - 343, - 322, - 348, - 337, - 345, - 336, - 340, - 344, - 334, - 346, - 347, - 328 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 110, - "character": 17 - } - ] - }, - { - "id": 349, - "name": "UserAttributes", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 354, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object for user_metadata that a user can modify. Can be any JSON." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 162, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 350, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's email." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 142, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 353, - "name": "email_change_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "An email change token." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 157, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 352, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 152, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 351, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's phone." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 147, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 354, - 350, - 353, - 352, - 351 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 138, - "character": 17 - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 355, - "name": "AdminUserAttributes" - } - ] - }, - { - "id": 310, - "name": "UserIdentity", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 318, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 105, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 311, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 99, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 313, - "name": "identity_data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 101, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 314, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, "indexSignature": { "id": 315, "name": "__index", @@ -59651,15 +58962,335 @@ } }, { - "id": 319, - "name": "last_sign_in_at", + "id": 321, + "name": "aud", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 106, + "line": 139, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 322, + "name": "confirmation_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 140, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 331, + "name": "confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 149, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 330, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 148, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 328, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 146, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 324, + "name": "email_change_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 142, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 332, + "name": "email_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 150, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 311, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 131, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 337, + "name": "identities", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 155, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 299, + "name": "UserIdentity" + } + } + }, + { + "id": 326, + "name": "invited_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 144, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 334, + "name": "last_sign_in_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 152, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 325, + "name": "new_email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 143, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 329, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 147, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 333, + "name": "phone_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 151, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 323, + "name": "recovery_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 141, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 335, + "name": "role", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 153, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 336, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 154, "character": 2 } ], @@ -59670,34 +59301,134 @@ }, { "id": 317, - "name": "provider", + "name": "user_metadata", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 104, + "line": 136, "character": 2 } ], "type": { - "type": "intrinsic", - "name": "string" + "type": "reflection", + "declaration": { + "id": 318, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 319, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 320, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } } - }, + } + ], + "groups": [ { - "id": 320, - "name": "updated_at", + "title": "Properties", + "kind": 1024, + "children": [ + 327, + 312, + 321, + 322, + 331, + 330, + 328, + 324, + 332, + 311, + 337, + 326, + 334, + 325, + 329, + 333, + 323, + 335, + 336, + 317 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 130, + "character": 17 + } + ] + }, + { + "id": 338, + "name": "UserAttributes", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 342, + "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 107, + "line": 180, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 339, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's email." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 162, "character": 2 } ], @@ -59707,15 +59438,43 @@ } }, { - "id": 312, - "name": "user_id", + "id": 341, + "name": "password", "kind": 1024, "kindString": "Property", - "flags": {}, + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's password." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 100, + "line": 172, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 340, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's phone." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 167, "character": 2 } ], @@ -59730,33 +59489,225 @@ "title": "Properties", "kind": 1024, "children": [ - 318, - 311, - 313, - 319, - 317, - 320, - 312 + 342, + 339, + 341, + 340 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 98, + "line": 158, + "character": 17 + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 343, + "name": "AdminUserAttributes" + } + ] + }, + { + "id": 299, + "name": "UserIdentity", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 307, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 125, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 300, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 119, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 302, + "name": "identity_data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 121, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 303, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 304, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 305, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 308, + "name": "last_sign_in_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 126, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 306, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 124, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 309, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 127, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 301, + "name": "user_id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 120, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 307, + 300, + 302, + 308, + 306, + 309, + 301 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 118, "character": 17 } ] }, { - "id": 432, + "id": 423, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 433, + "id": 424, "name": "email", "kind": 1024, "kindString": "Property", @@ -59767,7 +59718,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 316, + "line": 348, "character": 2 } ], @@ -59777,7 +59728,91 @@ } }, { - "id": 434, + "id": 427, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 353, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 428, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 430, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 357, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 429, + "name": "redirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A URL to send the user to after they are confirmed." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 355, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 430, + 429 + ] + } + ] + } + } + }, + { + "id": 425, "name": "token", "kind": 1024, "kindString": "Property", @@ -59788,7 +59823,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 318, + "line": 350, "character": 2 } ], @@ -59798,7 +59833,7 @@ } }, { - "id": 435, + "id": 426, "name": "type", "kind": 1024, "kindString": "Property", @@ -59809,13 +59844,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 320, + "line": 352, "character": 2 } ], "type": { "type": "reference", - "id": 437, + "id": 432, "name": "EmailOtpType" } } @@ -59825,29 +59860,114 @@ "title": "Properties", "kind": 1024, "children": [ - 433, - 434, - 435 + 424, + 427, + 425, + 426 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 314, + "line": 346, "character": 17 } ] }, { - "id": 428, + "id": 415, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 429, + "id": 419, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 339, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 420, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 422, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 343, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 421, + "name": "redirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A URL to send the user to after they are confirmed." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 341, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 422, + 421 + ] + } + ] + } + } + }, + { + "id": 416, "name": "phone", "kind": 1024, "kindString": "Property", @@ -59858,7 +59978,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 308, + "line": 334, "character": 2 } ], @@ -59868,7 +59988,7 @@ } }, { - "id": 430, + "id": 417, "name": "token", "kind": 1024, "kindString": "Property", @@ -59879,7 +59999,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 310, + "line": 336, "character": 2 } ], @@ -59889,7 +60009,7 @@ } }, { - "id": 431, + "id": 418, "name": "type", "kind": 1024, "kindString": "Property", @@ -59900,13 +60020,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 312, + "line": 338, "character": 2 } ], "type": { "type": "reference", - "id": 436, + "id": 431, "name": "MobileOtpType" } } @@ -59916,22 +60036,23 @@ "title": "Properties", "kind": 1024, "children": [ - 429, - 430, - 431 + 419, + 416, + 417, + 418 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 306, + "line": 332, "character": 17 } ] }, { - "id": 264, + "id": 240, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -59939,7 +60060,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 22, + "line": 23, "character": 12 } ], @@ -59974,7 +60095,7 @@ } }, { - "id": 265, + "id": 254, "name": "AuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -59982,7 +60103,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 30, + "line": 50, "character": 12 } ], @@ -59992,14 +60113,14 @@ { "type": "reflection", "declaration": { - "id": 266, + "id": 255, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 267, + "id": 256, "name": "data", "kind": 1024, "kindString": "Property", @@ -60007,21 +60128,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 32, + "line": 52, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 268, + "id": 257, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 270, + "id": 259, "name": "session", "kind": 1024, "kindString": "Property", @@ -60029,7 +60150,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 34, + "line": 54, "character": 8 } ], @@ -60038,7 +60159,7 @@ "types": [ { "type": "reference", - "id": 302, + "id": 291, "name": "Session" }, { @@ -60049,7 +60170,7 @@ } }, { - "id": 269, + "id": 258, "name": "user", "kind": 1024, "kindString": "Property", @@ -60057,7 +60178,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 33, + "line": 53, "character": 8 } ], @@ -60066,7 +60187,7 @@ "types": [ { "type": "reference", - "id": 321, + "id": 310, "name": "User" }, { @@ -60082,15 +60203,15 @@ "title": "Properties", "kind": 1024, "children": [ - 270, - 269 + 259, + 258 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 32, + "line": 52, "character": 12 } ] @@ -60098,7 +60219,7 @@ } }, { - "id": 271, + "id": 260, "name": "error", "kind": 1024, "kindString": "Property", @@ -60106,7 +60227,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 36, + "line": 56, "character": 6 } ], @@ -60121,15 +60242,15 @@ "title": "Properties", "kind": 1024, "children": [ - 267, - 271 + 256, + 260 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 31, + "line": 51, "character": 4 } ] @@ -60138,14 +60259,14 @@ { "type": "reflection", "declaration": { - "id": 272, + "id": 261, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 273, + "id": 262, "name": "data", "kind": 1024, "kindString": "Property", @@ -60153,21 +60274,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 39, + "line": 59, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 274, + "id": 263, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 276, + "id": 265, "name": "session", "kind": 1024, "kindString": "Property", @@ -60175,7 +60296,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 41, + "line": 61, "character": 8 } ], @@ -60185,7 +60306,7 @@ } }, { - "id": 275, + "id": 264, "name": "user", "kind": 1024, "kindString": "Property", @@ -60193,7 +60314,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 40, + "line": 60, "character": 8 } ], @@ -60208,15 +60329,15 @@ "title": "Properties", "kind": 1024, "children": [ - 276, - 275 + 265, + 264 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 39, + "line": 59, "character": 12 } ] @@ -60224,7 +60345,7 @@ } }, { - "id": 277, + "id": 266, "name": "error", "kind": 1024, "kindString": "Property", @@ -60232,13 +60353,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 43, + "line": 63, "character": 6 } ], "type": { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } } @@ -60248,15 +60369,15 @@ "title": "Properties", "kind": 1024, "children": [ - 273, - 277 + 262, + 266 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 38, + "line": 58, "character": 4 } ] @@ -60266,7 +60387,7 @@ } }, { - "id": 440, + "id": 484, "name": "CallRefreshTokenResult", "kind": 4194304, "kindString": "Type alias", @@ -60274,7 +60395,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 346, + "line": 472, "character": 12 } ], @@ -60284,14 +60405,14 @@ { "type": "reflection", "declaration": { - "id": 441, + "id": 485, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 443, + "id": 487, "name": "error", "kind": 1024, "kindString": "Property", @@ -60299,7 +60420,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 349, + "line": 475, "character": 6 } ], @@ -60309,7 +60430,7 @@ } }, { - "id": 442, + "id": 486, "name": "session", "kind": 1024, "kindString": "Property", @@ -60317,13 +60438,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 348, + "line": 474, "character": 6 } ], "type": { "type": "reference", - "id": 302, + "id": 291, "name": "Session" } } @@ -60333,15 +60454,15 @@ "title": "Properties", "kind": 1024, "children": [ - 443, - 442 + 487, + 486 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 347, + "line": 473, "character": 4 } ] @@ -60350,14 +60471,14 @@ { "type": "reflection", "declaration": { - "id": 444, + "id": 488, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 446, + "id": 490, "name": "error", "kind": 1024, "kindString": "Property", @@ -60365,18 +60486,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 353, + "line": 479, "character": 6 } ], "type": { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } }, { - "id": 445, + "id": 489, "name": "session", "kind": 1024, "kindString": "Property", @@ -60384,7 +60505,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 352, + "line": 478, "character": 6 } ], @@ -60399,15 +60520,15 @@ "title": "Properties", "kind": 1024, "children": [ - 446, - 445 + 490, + 489 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 351, + "line": 477, "character": 4 } ] @@ -60417,7 +60538,7 @@ } }, { - "id": 437, + "id": 432, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -60425,7 +60546,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 324, + "line": 362, "character": 12 } ], @@ -60456,18 +60577,764 @@ } }, { - "id": 438, - "name": "GenerateLinkType", + "id": 449, + "name": "GenerateEmailChangeLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 385, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 450, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 452, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 388, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 453, + "name": "newEmail", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 392, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 454, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 393, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 455, + "name": "GenerateLinkOptions" + }, + { + "type": "literal", + "value": "redirectTo" + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 451, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 386, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "email_change_current" + }, + { + "type": "literal", + "value": "email_change_new" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 452, + 453, + 454, + 451 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 385, + "character": 44 + } + ] + } + } + }, + { + "id": 439, + "name": "GenerateInviteOrMagiclinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 371, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 440, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 442, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 374, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 443, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 375, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 455, + "name": "GenerateLinkOptions" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "data" + }, + { + "type": "literal", + "value": "redirectTo" + } + ] + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 441, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 372, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "invite" + }, + { + "type": "literal", + "value": "magiclink" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 442, + 443, + 441 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 371, + "character": 46 + } + ] + } + } + }, + { + "id": 458, + "name": "GenerateLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 407, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 433, + "name": "GenerateSignupLinkParams" + }, + { + "type": "reference", + "id": 439, + "name": "GenerateInviteOrMagiclinkParams" + }, + { + "type": "reference", + "id": 444, + "name": "GenerateRecoveryLinkParams" + }, + { + "type": "reference", + "id": 449, + "name": "GenerateEmailChangeLinkParams" + } + ] + } + }, + { + "id": 472, + "name": "GenerateLinkProperties", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "shortText": "The link type" + "shortText": "The properties related to the email link generated" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 327, + "line": 430, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 473, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 474, + "name": "action_link", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The email link to send to the user.\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 435, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 475, + "name": "email_otp", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The raw email OTP.\nYou should send this in the email if you want your users to verify using an OTP instead of the action link." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 440, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 476, + "name": "hashed_token", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The hashed token appended to the action link." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 444, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 477, + "name": "redirect_to", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The URL appended to the action link." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 446, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 478, + "name": "verification_type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The verification type that the email link is associated to." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 448, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 479, + "name": "GenerateLinkType" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 474, + 475, + 476, + 477, + 478 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 430, + "character": 37 + } + ] + } + } + }, + { + "id": 459, + "name": "GenerateLinkResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 413, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 460, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 461, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 415, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 462, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 463, + "name": "properties", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 416, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 472, + "name": "GenerateLinkProperties" + } + }, + { + "id": 464, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 417, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 310, + "name": "User" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 463, + 464 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 415, + "character": 12 + } + ] + } + } + }, + { + "id": 465, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 419, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 461, + 465 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 414, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 466, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 467, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 422, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 468, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 469, + "name": "properties", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 423, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 470, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 424, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 469, + 470 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 422, + "character": 12 + } + ] + } + } + }, + { + "id": 471, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 426, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 494, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 467, + 471 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 421, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 479, + "name": "GenerateLinkType", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 451, "character": 12 } ], @@ -60502,7 +61369,580 @@ } }, { - "id": 436, + "id": 444, + "name": "GenerateRecoveryLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 378, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 445, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 447, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 381, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 448, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 382, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 455, + "name": "GenerateLinkOptions" + }, + { + "type": "literal", + "value": "redirectTo" + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 446, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 379, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "recovery" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 447, + 448, + 446 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 378, + "character": 41 + } + ] + } + } + }, + { + "id": 433, + "name": "GenerateSignupLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 364, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 434, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 436, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 366, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 438, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 368, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 455, + "name": "GenerateLinkOptions" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "data" + }, + { + "type": "literal", + "value": "redirectTo" + } + ] + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 437, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 367, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 435, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 365, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "signup" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 436, + 438, + 437, + 435 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 364, + "character": 39 + } + ] + } + } + }, + { + "id": 241, + "name": "GoTrueClientOptions", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 31, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 242, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 250, + "name": "autoRefreshToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 249, + "name": "detectSessionInUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 39, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 253, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 47, + "character": 2 + } + ], + "type": { + "type": "reference", + "name": "Fetch" + } + }, + { + "id": 244, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 35, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 245, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 35, + "character": 12 + } + ], + "indexSignature": { + "id": 246, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 247, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + } + }, + { + "id": 251, + "name": "persistSession", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 43, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 252, + "name": "storage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 45, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 480, + "name": "SupportedStorage" + } + }, + { + "id": 248, + "name": "storageKey", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 37, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 243, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 33, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 250, + 249, + 253, + 244, + 251, + 252, + 248, + 243 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 31, + "character": 34 + } + ] + } + } + }, + { + "id": 481, + "name": "InitializeResult", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 470, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 482, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 483, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 470, + "character": 33 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 494, + "name": "AuthError" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 483 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 470, + "character": 31 + } + ] + } + } + }, + { + "id": 431, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -60510,7 +61950,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 323, + "line": 361, "character": 12 } ], @@ -60529,7 +61969,7 @@ } }, { - "id": 278, + "id": 267, "name": "OAuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -60537,7 +61977,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 46, + "line": 66, "character": 12 } ], @@ -60547,14 +61987,14 @@ { "type": "reflection", "declaration": { - "id": 279, + "id": 268, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 280, + "id": 269, "name": "data", "kind": 1024, "kindString": "Property", @@ -60562,21 +62002,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 48, + "line": 68, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 281, + "id": 270, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 282, + "id": 271, "name": "provider", "kind": 1024, "kindString": "Property", @@ -60584,18 +62024,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 49, + "line": 69, "character": 8 } ], "type": { "type": "reference", - "id": 263, + "id": 239, "name": "Provider" } }, { - "id": 283, + "id": 272, "name": "url", "kind": 1024, "kindString": "Property", @@ -60603,7 +62043,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 50, + "line": 70, "character": 8 } ], @@ -60618,15 +62058,15 @@ "title": "Properties", "kind": 1024, "children": [ - 282, - 283 + 271, + 272 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 48, + "line": 68, "character": 12 } ] @@ -60634,7 +62074,7 @@ } }, { - "id": 284, + "id": 273, "name": "error", "kind": 1024, "kindString": "Property", @@ -60642,7 +62082,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 52, + "line": 72, "character": 6 } ], @@ -60657,15 +62097,15 @@ "title": "Properties", "kind": 1024, "children": [ - 280, - 284 + 269, + 273 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 47, + "line": 67, "character": 4 } ] @@ -60674,14 +62114,14 @@ { "type": "reflection", "declaration": { - "id": 285, + "id": 274, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 286, + "id": 275, "name": "data", "kind": 1024, "kindString": "Property", @@ -60689,21 +62129,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 55, + "line": 75, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 287, + "id": 276, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 288, + "id": 277, "name": "provider", "kind": 1024, "kindString": "Property", @@ -60711,18 +62151,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 56, + "line": 76, "character": 8 } ], "type": { "type": "reference", - "id": 263, + "id": 239, "name": "Provider" } }, { - "id": 289, + "id": 278, "name": "url", "kind": 1024, "kindString": "Property", @@ -60730,7 +62170,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 57, + "line": 77, "character": 8 } ], @@ -60745,15 +62185,15 @@ "title": "Properties", "kind": 1024, "children": [ - 288, - 289 + 277, + 278 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 55, + "line": 75, "character": 12 } ] @@ -60761,7 +62201,7 @@ } }, { - "id": 290, + "id": 279, "name": "error", "kind": 1024, "kindString": "Property", @@ -60769,13 +62209,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 59, + "line": 79, "character": 6 } ], "type": { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } } @@ -60785,15 +62225,15 @@ "title": "Properties", "kind": 1024, "children": [ - 286, - 290 + 275, + 279 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 74, "character": 4 } ] @@ -60803,7 +62243,7 @@ } }, { - "id": 263, + "id": 239, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -60814,7 +62254,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 4, + "line": 5, "character": 12 } ], @@ -60889,7 +62329,7 @@ } }, { - "id": 416, + "id": 403, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -60897,21 +62337,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 292, + "line": 318, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 417, + "id": 404, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 419, + "id": 406, "name": "options", "kind": 1024, "kindString": "Property", @@ -60921,21 +62361,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 295, + "line": 321, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 420, + "id": 407, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 423, + "id": 410, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -60948,14 +62388,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 301, + "line": 327, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 424, + "id": 411, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -60963,19 +62403,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 301, + "line": 327, "character": 18 } ], "indexSignature": { - "id": 425, + "id": 412, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 426, + "id": 413, "name": "key", "kind": 32768, "flags": {}, @@ -60994,7 +62434,7 @@ } }, { - "id": 421, + "id": 408, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -61002,12 +62442,12 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed (OAuth logins only)." + "shortText": "A URL to send the user to after they are confirmed." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 297, + "line": 323, "character": 4 } ], @@ -61017,7 +62457,7 @@ } }, { - "id": 422, + "id": 409, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -61030,7 +62470,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 299, + "line": 325, "character": 4 } ], @@ -61045,16 +62485,16 @@ "title": "Properties", "kind": 1024, "children": [ - 423, - 421, - 422 + 410, + 408, + 409 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 295, + "line": 321, "character": 12 } ] @@ -61062,7 +62502,7 @@ } }, { - "id": 418, + "id": 405, "name": "provider", "kind": 1024, "kindString": "Property", @@ -61073,13 +62513,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 294, + "line": 320, "character": 2 } ], "type": { "type": "reference", - "id": 263, + "id": 239, "name": "Provider" } } @@ -61089,15 +62529,15 @@ "title": "Properties", "kind": 1024, "children": [ - 419, - 418 + 406, + 405 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 292, + "line": 318, "character": 41 } ] @@ -61105,7 +62545,7 @@ } }, { - "id": 389, + "id": 376, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -61113,7 +62553,304 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 246, + "line": 272, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 377, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 378, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 275, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 380, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 278, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 381, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 382, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 280, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 382 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 278, + "character": 16 + } + ] + } + } + }, + { + "id": 379, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 277, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 378, + 380, + 379 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 273, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 383, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 386, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 288, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 387, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 388, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 290, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 388 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 288, + "character": 16 + } + ] + } + } + }, + { + "id": 385, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 287, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 384, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 285, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 386, + 385, + 384 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 283, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 389, + "name": "SignInWithPasswordlessCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 294, "character": 12 } ], @@ -61141,7 +62878,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 249, + "line": 297, "character": 6 } ], @@ -61151,7 +62888,7 @@ } }, { - "id": 393, + "id": 392, "name": "options", "kind": 1024, "kindString": "Property", @@ -61161,21 +62898,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 252, + "line": 298, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 394, + "id": 393, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 395, + "id": 396, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -61188,7 +62925,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 254, + "line": 304, "character": 8 } ], @@ -61196,6 +62933,52 @@ "type": "intrinsic", "name": "string" } + }, + { + "id": 394, + "name": "emailRedirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The redirect url embedded in the email link" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 300, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 395, + "name": "shouldCreateUser", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If set to false, this method will not create a new user. Defaults to true." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 302, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ @@ -61203,6 +62986,8 @@ "title": "Properties", "kind": 1024, "children": [ + 396, + 394, 395 ] } @@ -61210,33 +62995,12 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 252, + "line": 298, "character": 16 } ] } } - }, - { - "id": 392, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 251, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } } ], "groups": [ @@ -61245,7 +63009,6 @@ "kind": 1024, "children": [ 391, - 393, 392 ] } @@ -61253,7 +63016,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 247, + "line": 295, "character": 4 } ] @@ -61262,7 +63025,7 @@ { "type": "reflection", "declaration": { - "id": 396, + "id": 397, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -61279,7 +63042,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 262, + "line": 310, "character": 6 } ], @@ -61293,7 +63056,7 @@ "flags": {}, "children": [ { - "id": 401, + "id": 402, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -61306,7 +63069,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 264, + "line": 314, "character": 8 } ], @@ -61314,6 +63077,29 @@ "type": "intrinsic", "name": "string" } + }, + { + "id": 401, + "name": "shouldCreateUser", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If set to false, this method will not create a new user. Defaults to true." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 312, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ @@ -61321,6 +63107,7 @@ "title": "Properties", "kind": 1024, "children": [ + 402, 401 ] } @@ -61328,7 +63115,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 262, + "line": 310, "character": 16 } ] @@ -61337,27 +63124,6 @@ }, { "id": 398, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 261, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 397, "name": "phone", "kind": 1024, "kindString": "Property", @@ -61368,7 +63134,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 259, + "line": 309, "character": 6 } ], @@ -61384,15 +63150,14 @@ "kind": 1024, "children": [ 399, - 398, - 397 + 398 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 257, + "line": 307, "character": 4 } ] @@ -61402,332 +63167,7 @@ } }, { - "id": 402, - "name": "SignInWithPasswordlessCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 268, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 403, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 404, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 271, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 405, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 272, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 406, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 409, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 278, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 407, - "name": "emailRedirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The redirect url embedded in the email link" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 274, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 408, - "name": "shouldCreateUser", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 276, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 409, - 407, - 408 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 272, - "character": 16 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 404, - 405 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 269, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 410, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 412, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 284, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 413, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 415, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 288, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 414, - "name": "shouldCreateUser", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 286, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 415, - 414 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 284, - "character": 16 - } - ] - } - } - }, - { - "id": 411, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 283, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 412, - 411 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 281, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 373, + "id": 360, "name": "SignUpWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -61735,7 +63175,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 219, + "line": 237, "character": 12 } ], @@ -61745,14 +63185,14 @@ { "type": "reflection", "declaration": { - "id": 374, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 375, + "id": 362, "name": "email", "kind": 1024, "kindString": "Property", @@ -61763,7 +63203,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 222, + "line": 240, "character": 6 } ], @@ -61773,7 +63213,7 @@ } }, { - "id": 377, + "id": 364, "name": "options", "kind": 1024, "kindString": "Property", @@ -61783,21 +63223,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 225, + "line": 243, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 378, + "id": 365, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 381, + "id": 368, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -61810,7 +63250,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 231, + "line": 253, "character": 8 } ], @@ -61820,7 +63260,7 @@ } }, { - "id": 380, + "id": 367, "name": "data", "kind": 1024, "kindString": "Property", @@ -61828,12 +63268,13 @@ "isOptional": true }, "comment": { - "shortText": "The user's metadata." + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 229, + "line": 251, "character": 8 } ], @@ -61843,7 +63284,7 @@ } }, { - "id": 379, + "id": 366, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -61856,7 +63297,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 227, + "line": 245, "character": 8 } ], @@ -61871,16 +63312,16 @@ "title": "Properties", "kind": 1024, "children": [ - 381, - 380, - 379 + 368, + 367, + 366 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 225, + "line": 243, "character": 16 } ] @@ -61888,7 +63329,7 @@ } }, { - "id": 376, + "id": 363, "name": "password", "kind": 1024, "kindString": "Property", @@ -61899,7 +63340,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 224, + "line": 242, "character": 6 } ], @@ -61914,16 +63355,16 @@ "title": "Properties", "kind": 1024, "children": [ - 375, - 377, - 376 + 362, + 364, + 363 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 220, + "line": 238, "character": 4 } ] @@ -61932,14 +63373,14 @@ { "type": "reflection", "declaration": { - "id": 382, + "id": 369, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 385, + "id": 372, "name": "options", "kind": 1024, "kindString": "Property", @@ -61949,21 +63390,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 239, + "line": 261, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 386, + "id": 373, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 388, + "id": 375, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -61976,7 +63417,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 243, + "line": 269, "character": 8 } ], @@ -61986,7 +63427,7 @@ } }, { - "id": 387, + "id": 374, "name": "data", "kind": 1024, "kindString": "Property", @@ -61994,12 +63435,13 @@ "isOptional": true }, "comment": { - "shortText": "The user's metadata." + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 241, + "line": 267, "character": 8 } ], @@ -62014,15 +63456,15 @@ "title": "Properties", "kind": 1024, "children": [ - 388, - 387 + 375, + 374 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 239, + "line": 261, "character": 16 } ] @@ -62030,7 +63472,7 @@ } }, { - "id": 384, + "id": 371, "name": "password", "kind": 1024, "kindString": "Property", @@ -62041,7 +63483,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 238, + "line": 260, "character": 6 } ], @@ -62051,7 +63493,7 @@ } }, { - "id": 383, + "id": 370, "name": "phone", "kind": 1024, "kindString": "Property", @@ -62062,7 +63504,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 236, + "line": 258, "character": 6 } ], @@ -62077,16 +63519,16 @@ "title": "Properties", "kind": 1024, "children": [ - 385, - 384, - 383 + 372, + 371, + 370 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 234, + "line": 256, "character": 4 } ] @@ -62096,7 +63538,7 @@ } }, { - "id": 439, + "id": 480, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -62104,7 +63546,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 344, + "line": 468, "character": 12 } ], @@ -62147,7 +63589,7 @@ } }, { - "id": 291, + "id": 280, "name": "UserResponse", "kind": 4194304, "kindString": "Type alias", @@ -62155,7 +63597,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 62, + "line": 82, "character": 12 } ], @@ -62165,14 +63607,14 @@ { "type": "reflection", "declaration": { - "id": 292, + "id": 281, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 293, + "id": 282, "name": "data", "kind": 1024, "kindString": "Property", @@ -62180,21 +63622,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 64, + "line": 84, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 294, + "id": 283, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 295, + "id": 284, "name": "user", "kind": 1024, "kindString": "Property", @@ -62202,13 +63644,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 65, + "line": 85, "character": 8 } ], "type": { "type": "reference", - "id": 321, + "id": 310, "name": "User" } } @@ -62218,14 +63660,14 @@ "title": "Properties", "kind": 1024, "children": [ - 295 + 284 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 64, + "line": 84, "character": 12 } ] @@ -62233,7 +63675,7 @@ } }, { - "id": 296, + "id": 285, "name": "error", "kind": 1024, "kindString": "Property", @@ -62241,7 +63683,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 67, + "line": 87, "character": 6 } ], @@ -62256,15 +63698,15 @@ "title": "Properties", "kind": 1024, "children": [ - 293, - 296 + 282, + 285 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 63, + "line": 83, "character": 4 } ] @@ -62273,14 +63715,14 @@ { "type": "reflection", "declaration": { - "id": 297, + "id": 286, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 298, + "id": 287, "name": "data", "kind": 1024, "kindString": "Property", @@ -62288,21 +63730,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 70, + "line": 90, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 299, + "id": 288, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 300, + "id": 289, "name": "user", "kind": 1024, "kindString": "Property", @@ -62310,7 +63752,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 71, + "line": 91, "character": 8 } ], @@ -62325,14 +63767,14 @@ "title": "Properties", "kind": 1024, "children": [ - 300 + 289 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 70, + "line": 90, "character": 12 } ] @@ -62340,7 +63782,7 @@ } }, { - "id": 301, + "id": 290, "name": "error", "kind": 1024, "kindString": "Property", @@ -62348,13 +63790,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 73, + "line": 93, "character": 6 } ], "type": { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } } @@ -62364,15 +63806,15 @@ "title": "Properties", "kind": 1024, "children": [ - 298, - 301 + 287, + 290 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 69, + "line": 89, "character": 4 } ] @@ -62382,7 +63824,7 @@ } }, { - "id": 427, + "id": 414, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -62390,7 +63832,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 305, + "line": 331, "character": 12 } ], @@ -62399,19 +63841,19 @@ "types": [ { "type": "reference", - "id": 428, + "id": 415, "name": "VerifyMobileOtpParams" }, { "type": "reference", - "id": 432, + "id": 423, "name": "VerifyEmailOtpParams" } ] } }, { - "id": 447, + "id": 491, "name": "isAuthError", "kind": 64, "kindString": "Function", @@ -62425,14 +63867,14 @@ ], "signatures": [ { - "id": 448, + "id": 492, "name": "isAuthError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 449, + "id": 493, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -62449,7 +63891,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } } @@ -62462,57 +63904,68 @@ "title": "Classes", "kind": 128, "children": [ - 455, - 450, - 502, - 515, - 490, - 468, - 475, + 499, + 494, + 559, + 546, + 584, + 534, + 512, + 519, 1, - 81 + 66 ] }, { "title": "Interfaces", "kind": 256, "children": [ - 355, - 302, - 365, - 321, - 349, + 343, + 455, + 291, + 352, 310, - 432, - 428 + 338, + 299, + 423, + 415 ] }, { "title": "Type Aliases", "kind": 4194304, "children": [ - 264, - 265, - 440, - 437, - 438, - 436, - 278, - 263, - 416, - 389, - 402, - 373, + 240, + 254, + 484, + 432, + 449, 439, - 291, - 427 + 458, + 472, + 459, + 479, + 444, + 433, + 241, + 481, + 431, + 267, + 239, + 403, + 376, + 389, + 360, + 480, + 280, + 414 ] }, { "title": "Functions", "kind": 64, "children": [ - 447 + 491 ] } ], diff --git a/spec/enrichments/tsdoc_v2/gotrue.json b/spec/enrichments/tsdoc_v2/gotrue.json index 81b5b0c0bbb..1d3d6c68861 100644 --- a/spec/enrichments/tsdoc_v2/gotrue.json +++ b/spec/enrichments/tsdoc_v2/gotrue.json @@ -3,8904 +3,11001 @@ "name": "@supabase/gotrue-js", "kind": 1, "kindString": "Project", - "flags": {}, + "flags": { + + }, "originalName": "", "children": [ - { - "id": 455, - "name": "AuthApiError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 456, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 17, - "character": 2 - } - ], - "signatures": [ - { - "id": 457, - "name": "new AuthApiError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 458, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 459, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "id": 455, - "name": "AuthApiError" - }, - "overwrites": { - "type": "reference", - "id": 452, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 451, - "name": "AuthError.constructor" - } - }, - { - "id": 460, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 15, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 461, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 23, - "character": 2 - } - ], - "signatures": [ - { - "id": 462, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 463, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 465, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 26, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 464, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 25, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 466, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 27, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 465, - 464, - 466 - ] - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 456 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 460 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 461 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 14, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 450, - "name": "AuthError" - } - ] + { + "id": 499, + "name": "AuthApiError", + "kind": 128, + "kindString": "Class", + "flags": { + }, - { - "id": 450, - "name": "AuthError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 451, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 4, - "character": 2 - } - ], - "signatures": [ - { - "id": 452, - "name": "new AuthError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 453, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 450, - "name": "AuthError" - }, - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "name": "Error.constructor" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 451 - ] - } - ], + "children": [ + { + "id": 500, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": { + + }, "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 1, - "character": 13 - } + { + "fileName": "src/lib/errors.ts", + "line": 17, + "character": 2 + } ], - "extendedTypes": [ - { - "type": "reference", - "qualifiedName": "Error", - "package": "typescript", - "name": "Error" - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 455, - "name": "AuthApiError" + "signatures": [ + { + "id": 501, + "name": "new AuthApiError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": { + }, - { - "type": "reference", - "id": 468, - "name": "AuthUnknownError" - }, - { - "type": "reference", - "id": 475, - "name": "CustomAuthError" - } - ] - }, - { - "id": 502, - "name": "AuthInvalidCredentialsError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 503, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 67, - "character": 2 - } - ], - "signatures": [ - { - "id": 504, - "name": "new AuthInvalidCredentialsError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 505, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 502, - "name": "AuthInvalidCredentialsError" - }, - "overwrites": { - "type": "reference", - "id": 477, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 476, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 506, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 43, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 481, - "name": "CustomAuthError.name" - } - }, - { - "id": 507, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 44, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 482, - "name": "CustomAuthError.status" - } - }, - { - "id": 508, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 51, - "character": 2 - } - ], - "signatures": [ - { - "id": 509, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 510, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 512, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 54, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 511, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 53, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 513, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 55, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 512, - 511, - 513 - ] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 484, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 483, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 503 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 506, - 507 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 508 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 66, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 475, - "name": "CustomAuthError" - } - ] - }, - { - "id": 515, - "name": "AuthRetryableFetchError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 516, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 73, - "character": 2 - } - ], - "signatures": [ - { - "id": 517, - "name": "new AuthRetryableFetchError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 518, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 519, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "id": 515, - "name": "AuthRetryableFetchError" - }, - "overwrites": { - "type": "reference", - "id": 477, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 476, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 520, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 43, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 481, - "name": "CustomAuthError.name" - } - }, - { - "id": 521, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 44, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 482, - "name": "CustomAuthError.status" - } - }, - { - "id": 522, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 51, - "character": 2 - } - ], - "signatures": [ - { - "id": 523, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 524, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 526, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 54, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 525, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 53, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 527, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 55, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 526, - 525, - 527 - ] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 484, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 483, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 516 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 520, - 521 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 522 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 72, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 475, - "name": "CustomAuthError" - } - ] - }, - { - "id": 490, - "name": "AuthSessionMissingError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 491, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 61, - "character": 2 - } - ], - "signatures": [ - { - "id": 492, - "name": "new AuthSessionMissingError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "type": { - "type": "reference", - "id": 490, - "name": "AuthSessionMissingError" - }, - "overwrites": { - "type": "reference", - "id": 477, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 476, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 493, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 43, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 481, - "name": "CustomAuthError.name" - } - }, - { - "id": 494, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 44, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 482, - "name": "CustomAuthError.status" - } - }, - { - "id": 495, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 51, - "character": 2 - } - ], - "signatures": [ - { - "id": 496, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 497, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 499, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 54, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 498, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 53, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 500, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 55, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 499, - 498, - 500 - ] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 484, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 483, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 491 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 493, - 494 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 495 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 60, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 475, - "name": "CustomAuthError" - } - ] - }, - { - "id": 468, - "name": "AuthUnknownError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 469, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 35, - "character": 2 - } - ], - "signatures": [ - { - "id": 470, - "name": "new AuthUnknownError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 471, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 472, - "name": "originalError", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "id": 468, - "name": "AuthUnknownError" - }, - "overwrites": { - "type": "reference", - "id": 452, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 451, - "name": "AuthError.constructor" - } - }, - { - "id": 473, - "name": "originalError", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 33, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 469 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 473 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 32, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 450, - "name": "AuthError" - } - ] - }, - { - "id": 475, - "name": "CustomAuthError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 476, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 45, - "character": 2 - } - ], - "signatures": [ - { - "id": 477, - "name": "new CustomAuthError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 478, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 479, - "name": "name", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 480, - "name": "status", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "id": 475, - "name": "CustomAuthError" - }, - "overwrites": { - "type": "reference", - "id": 452, - "name": "AuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 451, - "name": "AuthError.constructor" - } - }, - { - "id": 481, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 43, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "name": "AuthError.name" - } - }, - { - "id": 482, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 44, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 483, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 51, - "character": 2 - } - ], - "signatures": [ - { - "id": 484, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 485, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 487, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 54, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 486, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 53, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 488, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 55, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 487, - 486, - 488 - ] - } - ] - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 476 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 481, - 482 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 483 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 42, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 450, - "name": "AuthError" - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 490, - "name": "AuthSessionMissingError" - }, - { - "type": "reference", + "parameters": [ + { "id": 502, - "name": "AuthInvalidCredentialsError" + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 503, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "reference", + "id": 499, + "name": "AuthApiError" }, - { - "type": "reference", - "id": 515, - "name": "AuthRetryableFetchError" - } - ] - }, - { - "id": 1, - "name": "GoTrueAdminApi", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 2, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 13, - "character": 2 - } - ], - "signatures": [ - { - "id": 3, - "name": "new GoTrueAdminApi", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 4, - "name": "__namedParameters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 5, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 11, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 22, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 12, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 13, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 14, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 15, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 7, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 19, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 8, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 9, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 10, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 6, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 18, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 11, - 7, - 6 - ] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default" - } - } - ] - }, - { - "id": 56, - "name": "createUser", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 128, - "character": 8 - } - ], - "signatures": [ - { - "id": 57, - "name": "createUser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new user.\nThis function should only be called on a server. Never expose your `service_role` key in the browser." - }, - "parameters": [ - { - "id": 58, - "name": "attributes", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 355, - "name": "AdminUserAttributes" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 291, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 78, - "name": "deleteUser", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 218, - "character": 8 - } - ], - "signatures": [ - { - "id": 79, - "name": "deleteUser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Delete a user. Requires a `service_role` key." - }, - "parameters": [ - { - "id": 80, - "name": "uid", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The user uid you want to remove.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 291, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 38, - "name": "generateLink", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 85, - "character": 8 - } - ], - "signatures": [ - { - "id": 39, - "name": "generateLink", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Generates links to be sent via email or other." - }, - "parameters": [ - { - "id": 40, - "name": "type", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 438, - "name": "GenerateLinkType" - } - }, - { - "id": 41, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The user's email." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 42, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 43, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 45, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional user metadata. For signup only." - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 90, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 44, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "User password. For signup only." - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 89, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 46, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The redirect url which should be appended to the generated link\n" - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 91, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 45, - 44, - 46 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 47, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 48, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 95, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 321, - "name": "User" - } - }, - { - "id": 49, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 96, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 48, - 49 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 50, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 51, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 99, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 302, - "name": "Session" - } - }, - { - "id": 52, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 100, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 51, - 52 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 53, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 54, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 102, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 55, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 102, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 450, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 54, - 55 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 71, - "name": "getUserById", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 173, - "character": 8 - } - ], - "signatures": [ - { - "id": 72, - "name": "getUserById", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Get user by id." - }, - "parameters": [ - { - "id": 73, - "name": "uid", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 291, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 31, - "name": "inviteUserByEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 55, - "character": 8 - } - ], - "signatures": [ - { - "id": 32, - "name": "inviteUserByEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends an invite link to an email address." - }, - "parameters": [ - { - "id": 33, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 34, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 35, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 37, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional user metadata\n" - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 59, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 36, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A URL or mobile address to send the user to after they are confirmed." - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 58, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 37, - 36 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 291, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 59, - "name": "listUsers", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 149, - "character": 8 - } - ], - "signatures": [ - { - "id": 60, - "name": "listUsers", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Get a list of users.", - "text": "This function should only be called on a server. Never expose your `service_role` key in the browser.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 61, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 62, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 150, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 63, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 64, - "name": "users", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 150, - "character": 14 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 321, - "name": "User" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 64 - ] - } - ] - } - } - }, - { - "id": 65, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 150, - "character": 31 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 62, - 65 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 66, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 67, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 150, - "character": 49 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 68, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 69, - "name": "users", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 150, - "character": 57 - } - ], - "type": { - "type": "tuple" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 69 - ] - } - ] - } - } - }, - { - "id": 70, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 150, - "character": 70 - } - ], - "type": { - "type": "reference", - "id": 450, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 67, - 70 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 26, - "name": "signOut", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 33, - "character": 8 - } - ], - "signatures": [ - { - "id": 27, - "name": "signOut", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Removes a logged-in session." - }, - "parameters": [ - { - "id": 28, - "name": "jwt", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A valid, logged-in JWT.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 29, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 30, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 33, - "character": 40 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 450, - "name": "AuthError" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 30 - ] - } - ] - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 74, - "name": "updateUserById", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 195, - "character": 8 - } - ], - "signatures": [ - { - "id": 75, - "name": "updateUserById", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Updates the user data." - }, - "parameters": [ - { - "id": 76, - "name": "uid", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 77, - "name": "attributes", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The data you want to update.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" - }, - "type": { - "type": "reference", - "id": 355, - "name": "AdminUserAttributes" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 291, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] + "overwrites": { + "type": "reference", + "id": 496, + "name": "AuthError.constructor" } + } ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 2 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 56, - 78, - 38, - 71, - 31, - 59, - 26, - 74 - ] - } - ], - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 6, - "character": 21 - } - ] - }, - { - "id": 81, - "name": "GoTrueClient", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 82, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 104, - "character": 2 - } - ], - "signatures": [ - { - "id": 83, - "name": "new GoTrueClient", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "comment": { - "shortText": "Create a new client for use in the browser." - }, - "parameters": [ - { - "id": 84, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 85, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 93, - "name": "autoRefreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set to \"true\" if you want to automatically refresh the token before expiring." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 109, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 92, - "name": "detectSessionInUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set to \"true\" if you want to automatically detects OAuth grants in the URL and signs in the user." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 108, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 97, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 113, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 98, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 99, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "A custom fetch implementation.\n" - }, - "parameters": [ - { - "id": 100, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 101, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 87, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Any additional headers to send to the GoTrue server." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 106, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 88, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 89, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 90, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 96, - "name": "multiTab", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set to \"false\" if you want to disable multi-tab/window events." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 112, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 94, - "name": "persistSession", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set to \"true\" if you want to automatically save the user session into local storage. If set to false, session will just be saved in memory." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 110, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 95, - "name": "storage", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 111, - "character": 4 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Storage", - "package": "typescript", - "name": "Storage" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "getItem" - }, - { - "type": "literal", - "value": "removeItem" - }, - { - "type": "literal", - "value": "setItem" - } - ] - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - ], - "name": "PromisifyMethods" - } - }, - { - "id": 91, - "name": "storageKey", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional key name used for storing tokens in local storage" - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 107, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 86, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The URL of the GoTrue server." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 105, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 93, - 92, - 97, - 87, - 96, - 94, - 95, - 91, - 86 - ] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "id": 81, - "name": "default" - } - } - ] - }, - { - "id": 102, - "name": "admin", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "Namespace for the GoTrue admin methods.\nThese methods should only be used in a trusted server-side environment." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 66, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 1, - "name": "default" - } - }, - { - "id": 141, - "name": "getSession", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 362, - "character": 8 - } - ], - "signatures": [ - { - "id": 142, - "name": "getSession", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Returns the session data, refreshing it if necessary.\nIf no session is detected, the session returned will be null." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 143, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 144, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 364, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 145, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 146, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 365, - "character": 10 - } - ], - "type": { - "type": "reference", - "id": 302, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 146 - ] - } - ] - } - } - }, - { - "id": 147, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 367, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 144, - 147 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 148, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 149, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 370, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 150, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 151, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 371, - "character": 10 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 151 - ] - } - ] - } - } - }, - { - "id": 152, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 373, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 450, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 149, - 152 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 153, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 154, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 376, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 155, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 156, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 377, - "character": 10 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 156 - ] - } - ] - } - } - }, - { - "id": 157, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 379, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 154, - 157 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 158, - "name": "getUser", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 419, - "character": 8 - } - ], - "signatures": [ - { - "id": 159, - "name": "getUser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Gets the current user details if there is an existing session." - }, - "parameters": [ - { - "id": 160, - "name": "jwt", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Takes in an optional access token jwt. If no jwt is provided, getUser() will attempt to get the jwt from the current session.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 291, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 179, - "name": "onAuthStateChange", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 593, - "character": 2 - } - ], - "signatures": [ - { - "id": 180, - "name": "onAuthStateChange", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Receive a notification every time an auth event happens.", - "returns": "A subscription object which can be used to unsubscribe itself.\n" - }, - "parameters": [ - { - "id": 181, - "name": "callback", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A callback function to be invoked when an auth event happens." - }, - "type": { - "type": "reflection", - "declaration": { - "id": 182, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 183, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 184, - "name": "event", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 264, - "name": "AuthChangeEvent" - } - }, - { - "id": 185, - "name": "session", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 302, - "name": "Session" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 186, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 188, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 596, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 187, - "name": "subscription", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 595, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 365, - "name": "Subscription" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 188, - 187 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 189, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 191, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 598, - "character": 28 - } - ], - "type": { - "type": "reference", - "id": 450, - "name": "AuthError" - } - }, - { - "id": 190, - "name": "subscription", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 598, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 191, - 190 - ] - } - ] - } - } - ] - } - } - ] - }, - { - "id": 192, - "name": "resetPasswordForEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 625, - "character": 8 - } - ], - "signatures": [ - { - "id": 193, - "name": "resetPasswordForEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a reset request to an email address." - }, - "parameters": [ - { - "id": 194, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 195, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 196, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 198, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 629, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 197, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A URL to send the user to after they are confirmed." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 628, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 198, - 197 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 199, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 200, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 633, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 201, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 202, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 634, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 200, - 202 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 203, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 204, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 636, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 205, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 636, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 450, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 204, - 205 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 164, - "name": "setSession", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 482, - "character": 8 - } - ], - "signatures": [ - { - "id": 165, - "name": "setSession", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sets the session data from refresh_token and returns current session or an error if the refresh_token is invalid." - }, - "parameters": [ - { - "id": 166, - "name": "refresh_token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The refresh token returned by gotrue.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 265, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 128, - "name": "signInWithOAuth", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 258, - "character": 8 - } - ], - "signatures": [ - { - "id": 129, - "name": "signInWithOAuth", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Log in an existing user via a third-party provider." - }, - "parameters": [ - { - "id": 130, - "name": "credentials", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 416, - "name": "SignInWithOAuthCredentials" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 278, - "name": "OAuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 131, - "name": "signInWithOtp", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 270, - "character": 8 - } - ], - "signatures": [ - { - "id": 132, - "name": "signInWithOtp", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Passwordless method for logging in an existing user." - }, - "parameters": [ - { - "id": 133, - "name": "credentials", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 402, - "name": "SignInWithPasswordlessCredentials" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 265, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 125, - "name": "signInWithPassword", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 210, - "character": 8 - } - ], - "signatures": [ - { - "id": 126, - "name": "signInWithPassword", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Log in an existing user, or login via a third-party provider." - }, - "parameters": [ - { - "id": 127, - "name": "credentials", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 389, - "name": "SignInWithPasswordCredentials" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 265, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 175, - "name": "signOut", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 573, - "character": 8 - } - ], - "signatures": [ - { - "id": 176, - "name": "signOut", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Inside a browser context, `signOut()` will remove the logged in user from the browser session\nand log them out - removing all items from localstorage and then trigger a \"SIGNED_OUT\" event.", - "text": "For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to `auth.api.signOut(JWT: string)`.\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 177, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 178, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 573, - "character": 29 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 450, - "name": "AuthError" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 178 - ] - } - ] - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 122, - "name": "signUp", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 147, - "character": 8 - } - ], - "signatures": [ - { - "id": 123, - "name": "signUp", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new user.", - "returns": "A logged-in session if the server has \"autoconfirm\" ON" - }, - "parameters": [ - { - "id": 124, - "name": "credentials", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 373, - "name": "SignUpWithPasswordCredentials" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 265, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 161, - "name": "updateUser", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 448, - "character": 8 - } - ], - "signatures": [ - { - "id": 162, - "name": "updateUser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Updates user data, if there is a logged in user." - }, - "parameters": [ - { - "id": 163, - "name": "attributes", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 349, - "name": "UserAttributes" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 291, - "name": "UserResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 134, - "name": "verifyOtp", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 313, - "character": 8 - } - ], - "signatures": [ - { - "id": 135, - "name": "verifyOtp", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Log in a user given a User supplied OTP received via mobile." - }, - "parameters": [ - { - "id": 136, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 427, - "name": "VerifyOtpParams" - } - }, - { - "id": 137, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 138, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 140, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 317, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 139, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A URL to send the user to after they are confirmed." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 316, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 140, - 139 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 265, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 82 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 102 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 141, - 158, - 179, - 192, - 164, - 128, - 131, - 125, - 175, - 122, - 161, - 134 - ] - } - ], - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 61, - "character": 21 - } - ] - }, - { - "id": 355, - "name": "AdminUserAttributes", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 357, - "name": "app_metadata", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object for app_metadata that.", - "text": "Only a service role can modify.\n\nCan be any JSON that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 187, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 364, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object for user_metadata that a user can modify. Can be any JSON." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 162, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - }, - "inheritedFrom": { - "type": "reference", - "id": 354, - "name": "UserAttributes.data" - } - }, - { - "id": 360, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's email." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 142, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 350, - "name": "UserAttributes.email" - } - }, - { - "id": 363, - "name": "email_change_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "An email change token." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 157, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 353, - "name": "UserAttributes.email_change_token" - } - }, - { - "id": 358, - "name": "email_confirm", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Sets if a user has confirmed their email address.", - "text": "Only a service role can modify.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 194, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 362, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 152, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 352, - "name": "UserAttributes.password" - } - }, - { - "id": 361, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's phone." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 147, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 351, - "name": "UserAttributes.phone" - } - }, - { - "id": 359, - "name": "phone_confirm", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Sets if a user has confirmed their phone number.", - "text": "Only a service role can modify.\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 201, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 356, - "name": "user_metadata", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object for user_metadata.", - "text": "Can be any JSON.\n\nOnly a service role can modify.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's user_metadata,\nthis attribute is used instead of UserAttributes data.\n\n" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 177, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 357, - 364, - 360, - 363, - 358, - 362, - 361, - 359, - 356 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 165, - "character": 17 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 349, - "name": "UserAttributes" - } - ] - }, - { - "id": 302, - "name": "Session", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 304, - "name": "access_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 81, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 307, - "name": "expires_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 93, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 306, - "name": "expires_in", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 89, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 303, - "name": "provider_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 305, - "name": "refresh_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "A one-time used refresh token that never expires." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 308, - "name": "token_type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 94, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 309, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 95, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 321, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 304, - 307, - 306, - 303, - 305, - 308, - 309 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 76, - "character": 17 - } - ] - }, - { - "id": 365, - "name": "Subscription", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 366, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The subscriber UUID. This will be set by the client." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 208, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 367, - "name": "callback", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 212, - "character": 2 - } - ], - "signatures": [ - { - "id": 368, - "name": "callback", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "The function to call every time there is an event. eg: (eventName) => {}" - }, - "parameters": [ - { - "id": 369, - "name": "event", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 264, - "name": "AuthChangeEvent" - } - }, - { - "id": 370, - "name": "session", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 302, - "name": "Session" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 371, - "name": "unsubscribe", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 216, - "character": 2 - } - ], - "signatures": [ - { - "id": 372, - "name": "unsubscribe", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Call this to remove the listener." - }, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 366 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 367, - 371 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 204, - "character": 17 - } - ] - }, - { - "id": 321, - "name": "User", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 338, - "name": "action_link", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 125, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 323, - "name": "app_metadata", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 112, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 324, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 325, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 113, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 325 - ] - } - ], - "indexSignature": { - "id": 326, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 327, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 332, - "name": "aud", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 119, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 333, - "name": "confirmation_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 120, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 342, - "name": "confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 129, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 341, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 128, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 339, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 126, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 335, - "name": "email_change_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 122, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 343, - "name": "email_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 130, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 322, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 111, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 348, - "name": "identities", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 135, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 310, - "name": "UserIdentity" - } - } - }, - { - "id": 337, - "name": "invited_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 124, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 345, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 132, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 336, - "name": "new_email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 123, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 340, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 127, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 344, - "name": "phone_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 131, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 334, - "name": "recovery_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 121, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 346, - "name": "role", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 133, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 347, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 134, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 328, - "name": "user_metadata", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 116, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 329, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 330, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 331, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 338, - 323, - 332, - 333, - 342, - 341, - 339, - 335, - 343, - 322, - 348, - 337, - 345, - 336, - 340, - 344, - 334, - 346, - 347, - 328 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 110, - "character": 17 - } - ] - }, - { - "id": 349, - "name": "UserAttributes", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 354, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object for user_metadata that a user can modify. Can be any JSON." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 162, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 350, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's email." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 142, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 353, - "name": "email_change_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "An email change token." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 157, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 352, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 152, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 351, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's phone." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 147, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 354, - 350, - 353, - 352, - 351 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 138, - "character": 17 - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 355, - "name": "AdminUserAttributes" - } - ] - }, - { - "id": 310, - "name": "UserIdentity", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 318, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 105, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 311, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 99, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 313, - "name": "identity_data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 101, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 314, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 315, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 316, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 319, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 106, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 317, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 104, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 320, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 107, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 312, - "name": "user_id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 100, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 318, - 311, - 313, - 319, - 317, - 320, - 312 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 98, - "character": 17 - } - ] - }, - { - "id": 432, - "name": "VerifyEmailOtpParams", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 433, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 316, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 434, - "name": "token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The otp sent to the user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 318, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 435, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's verification type." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 320, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 437, - "name": "EmailOtpType" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 433, - 434, - 435 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 314, - "character": 17 - } - ] - }, - { - "id": 428, - "name": "VerifyMobileOtpParams", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 429, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 308, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 430, - "name": "token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The otp sent to the user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 310, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 431, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's verification type." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 312, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 436, - "name": "MobileOtpType" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 429, - 430, - 431 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 306, - "character": 17 - } - ] - }, - { - "id": 264, - "name": "AuthChangeEvent", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 22, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "PASSWORD_RECOVERY" - }, - { - "type": "literal", - "value": "SIGNED_IN" - }, - { - "type": "literal", - "value": "SIGNED_OUT" - }, - { - "type": "literal", - "value": "TOKEN_REFRESHED" - }, - { - "type": "literal", - "value": "USER_UPDATED" - }, - { - "type": "literal", - "value": "USER_DELETED" - } - ] + "overwrites": { + "type": "reference", + "id": 495, + "name": "AuthError.constructor" } - }, - { - "id": 265, - "name": "AuthResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 30, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 266, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 267, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 32, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 268, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 270, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 34, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 302, - "name": "Session" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 269, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 33, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 321, - "name": "User" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 270, - 269 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 32, - "character": 12 - } - ] - } - } - }, - { - "id": 271, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 36, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 267, - 271 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 31, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 272, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 273, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 39, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 274, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 276, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 41, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 275, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 40, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 276, - 275 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 39, - "character": 12 - } - ] - } - } - }, - { - "id": 277, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 43, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 450, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 273, - 277 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 38, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 440, - "name": "CallRefreshTokenResult", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 346, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 441, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 443, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 349, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 442, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 348, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 302, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 443, - 442 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 347, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 444, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 446, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 353, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 450, - "name": "AuthError" - } - }, - { - "id": 445, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 352, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 446, - 445 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 351, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 437, - "name": "EmailOtpType", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 324, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change" - } - ] - } - }, - { - "id": 438, - "name": "GenerateLinkType", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "shortText": "The link type" + }, + { + "id": 504, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": { + }, "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 327, - "character": 12 - } + { + "fileName": "src/lib/errors.ts", + "line": 15, + "character": 2 + } ], "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" - } - ] + "type": "intrinsic", + "name": "number" } - }, - { - "id": 436, - "name": "MobileOtpType", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 323, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "sms" - }, - { - "type": "literal", - "value": "phone_change" - } - ] - } - }, - { - "id": 278, - "name": "OAuthResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 46, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 279, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 280, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 48, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 281, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 282, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 49, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 263, - "name": "Provider" - } - }, - { - "id": 283, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 50, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 282, - 283 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 48, - "character": 12 - } - ] - } - } - }, - { - "id": 284, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 52, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 280, - 284 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 47, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 285, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 286, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 55, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 287, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 288, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 56, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 263, - "name": "Provider" - } - }, - { - "id": 289, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 57, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 288, - 289 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 55, - "character": 12 - } - ] - } - } - }, - { - "id": 290, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 59, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 450, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 286, - 290 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 54, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 263, - "name": "Provider", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "comment": { - "shortText": "One of the providers supported by GoTrue." + }, + { + "id": 505, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": { + }, "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 4, - "character": 12 - } + { + "fileName": "src/lib/errors.ts", + "line": 23, + "character": 2 + } ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "apple" - }, - { - "type": "literal", - "value": "azure" - }, - { - "type": "literal", - "value": "bitbucket" - }, - { - "type": "literal", - "value": "discord" - }, - { - "type": "literal", - "value": "facebook" - }, - { - "type": "literal", - "value": "github" - }, - { - "type": "literal", - "value": "gitlab" - }, - { - "type": "literal", - "value": "google" - }, - { - "type": "literal", - "value": "keycloak" - }, - { - "type": "literal", - "value": "linkedin" - }, - { - "type": "literal", - "value": "notion" - }, - { - "type": "literal", - "value": "slack" - }, - { - "type": "literal", - "value": "spotify" - }, - { - "type": "literal", - "value": "twitch" - }, - { - "type": "literal", - "value": "twitter" - }, - { - "type": "literal", - "value": "workos" - } - ] - } - }, - { - "id": 416, - "name": "SignInWithOAuthCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 292, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 417, + "signatures": [ + { + "id": 506, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "type": { + "type": "reflection", + "declaration": { + "id": 507, "name": "__type", "kind": 65536, "kindString": "Type literal", - "flags": {}, + "flags": { + + }, "children": [ + { + "id": 509, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 26, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 508, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 25, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 510, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 27, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 509, + 508, + 510 + ] + } + ] + } + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 500 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 504 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 505 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 14, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 494, + "name": "AuthError" + } + ] + }, + { + "id": 494, + "name": "AuthError", + "kind": 128, + "kindString": "Class", + "flags": { + + }, + "children": [ + { + "id": 495, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 4, + "character": 2 + } + ], + "signatures": [ + { + "id": 496, + "name": "new AuthError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": { + + }, + "parameters": [ + { + "id": 497, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 494, + "name": "AuthError" + }, + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "name": "Error.constructor" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 495 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 1, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "qualifiedName": "Error", + "package": "typescript", + "name": "Error" + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 499, + "name": "AuthApiError" + }, + { + "type": "reference", + "id": 512, + "name": "AuthUnknownError" + }, + { + "type": "reference", + "id": 519, + "name": "CustomAuthError" + } + ] + }, + { + "id": 559, + "name": "AuthImplicitGrantRedirectError", + "kind": 128, + "kindString": "Class", + "flags": { + + }, + "children": [ + { + "id": 560, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 74, + "character": 2 + } + ], + "signatures": [ + { + "id": 561, + "name": "new AuthImplicitGrantRedirectError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": { + + }, + "parameters": [ + { + "id": 562, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 563, + "name": "details", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "union", + "types": [ { - "id": 419, - "name": "options", + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 564, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 566, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 74, + "character": 57 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 565, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 74, + "character": 42 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 566, + 565 + ] + } + ] + } + } + ] + }, + "defaultValue": "null" + } + ], + "type": { + "type": "reference", + "id": 559, + "name": "AuthImplicitGrantRedirectError" + }, + "overwrites": { + "type": "reference", + "id": 521, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 520, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 567, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 73, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 568, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 570, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 73, + "character": 28 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 569, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 73, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 570, + 569 + ] + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 581, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 43, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 525, + "name": "CustomAuthError.name" + } + }, + { + "id": 582, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 44, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 526, + "name": "CustomAuthError.status" + } + }, + { + "id": 571, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 79, + "character": 2 + } + ], + "signatures": [ + { + "id": 572, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "type": { + "type": "reflection", + "declaration": { + "id": 573, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 577, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 84, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 578, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 580, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 73, + "character": 28 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 579, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 73, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 580, + 579 + ] + } + ] + } + } + ] + }, + "defaultValue": "..." + }, + { + "id": 575, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 82, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 574, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 81, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 576, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 83, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 577, + 575, + 574, + 576 + ] + } + ] + } + }, + "overwrites": { + "type": "reference", + "id": 528, + "name": "CustomAuthError.toJSON" + } + } + ], + "overwrites": { + "type": "reference", + "id": 527, + "name": "CustomAuthError.toJSON" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 560 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 567, + 581, + 582 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 571 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 72, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 519, + "name": "CustomAuthError" + } + ] + }, + { + "id": 546, + "name": "AuthInvalidCredentialsError", + "kind": 128, + "kindString": "Class", + "flags": { + + }, + "children": [ + { + "id": 547, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 67, + "character": 2 + } + ], + "signatures": [ + { + "id": 548, + "name": "new AuthInvalidCredentialsError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": { + + }, + "parameters": [ + { + "id": 549, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 546, + "name": "AuthInvalidCredentialsError" + }, + "overwrites": { + "type": "reference", + "id": 521, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 520, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 550, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 43, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 525, + "name": "CustomAuthError.name" + } + }, + { + "id": 551, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 44, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 526, + "name": "CustomAuthError.status" + } + }, + { + "id": 552, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 51, + "character": 2 + } + ], + "signatures": [ + { + "id": 553, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "type": { + "type": "reflection", + "declaration": { + "id": 554, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 556, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 54, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 555, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 53, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 557, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 55, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 556, + 555, + 557 + ] + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "id": 528, + "name": "CustomAuthError.toJSON" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 527, + "name": "CustomAuthError.toJSON" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 547 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 550, + 551 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 552 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 66, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 519, + "name": "CustomAuthError" + } + ] + }, + { + "id": 584, + "name": "AuthRetryableFetchError", + "kind": 128, + "kindString": "Class", + "flags": { + + }, + "children": [ + { + "id": 585, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 90, + "character": 2 + } + ], + "signatures": [ + { + "id": 586, + "name": "new AuthRetryableFetchError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": { + + }, + "parameters": [ + { + "id": 587, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 588, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "reference", + "id": 584, + "name": "AuthRetryableFetchError" + }, + "overwrites": { + "type": "reference", + "id": 521, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 520, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 589, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 43, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 525, + "name": "CustomAuthError.name" + } + }, + { + "id": 590, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 44, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 526, + "name": "CustomAuthError.status" + } + }, + { + "id": 591, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 51, + "character": 2 + } + ], + "signatures": [ + { + "id": 592, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "type": { + "type": "reflection", + "declaration": { + "id": 593, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 595, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 54, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 594, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 53, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 596, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 55, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 595, + 594, + 596 + ] + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "id": 528, + "name": "CustomAuthError.toJSON" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 527, + "name": "CustomAuthError.toJSON" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 585 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 589, + 590 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 591 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 519, + "name": "CustomAuthError" + } + ] + }, + { + "id": 534, + "name": "AuthSessionMissingError", + "kind": 128, + "kindString": "Class", + "flags": { + + }, + "children": [ + { + "id": 535, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 61, + "character": 2 + } + ], + "signatures": [ + { + "id": 536, + "name": "new AuthSessionMissingError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": { + + }, + "type": { + "type": "reference", + "id": 534, + "name": "AuthSessionMissingError" + }, + "overwrites": { + "type": "reference", + "id": 521, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 520, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 537, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 43, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 525, + "name": "CustomAuthError.name" + } + }, + { + "id": 538, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 44, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 526, + "name": "CustomAuthError.status" + } + }, + { + "id": 539, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 51, + "character": 2 + } + ], + "signatures": [ + { + "id": 540, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "type": { + "type": "reflection", + "declaration": { + "id": 541, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 543, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 54, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 542, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 53, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 544, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 55, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 543, + 542, + 544 + ] + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "id": 528, + "name": "CustomAuthError.toJSON" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 527, + "name": "CustomAuthError.toJSON" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 535 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 537, + 538 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 539 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 60, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 519, + "name": "CustomAuthError" + } + ] + }, + { + "id": 512, + "name": "AuthUnknownError", + "kind": 128, + "kindString": "Class", + "flags": { + + }, + "children": [ + { + "id": 513, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 35, + "character": 2 + } + ], + "signatures": [ + { + "id": 514, + "name": "new AuthUnknownError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": { + + }, + "parameters": [ + { + "id": 515, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 516, + "name": "originalError", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "id": 512, + "name": "AuthUnknownError" + }, + "overwrites": { + "type": "reference", + "id": 496, + "name": "AuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 495, + "name": "AuthError.constructor" + } + }, + { + "id": 517, + "name": "originalError", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 33, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 513 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 517 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 32, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 494, + "name": "AuthError" + } + ] + }, + { + "id": 519, + "name": "CustomAuthError", + "kind": 128, + "kindString": "Class", + "flags": { + + }, + "children": [ + { + "id": 520, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 45, + "character": 2 + } + ], + "signatures": [ + { + "id": 521, + "name": "new CustomAuthError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": { + + }, + "parameters": [ + { + "id": 522, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 523, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 524, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "reference", + "id": 519, + "name": "CustomAuthError" + }, + "overwrites": { + "type": "reference", + "id": 496, + "name": "AuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 495, + "name": "AuthError.constructor" + } + }, + { + "id": 525, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 43, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "overwrites": { + "type": "reference", + "name": "AuthError.name" + } + }, + { + "id": 526, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 44, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 527, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 51, + "character": 2 + } + ], + "signatures": [ + { + "id": 528, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "type": { + "type": "reflection", + "declaration": { + "id": 529, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 531, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 54, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 530, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 53, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 532, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 55, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 531, + 530, + 532 + ] + } + ] + } + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 520 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 525, + 526 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 527 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 42, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 494, + "name": "AuthError" + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 534, + "name": "AuthSessionMissingError" + }, + { + "type": "reference", + "id": 546, + "name": "AuthInvalidCredentialsError" + }, + { + "type": "reference", + "id": 559, + "name": "AuthImplicitGrantRedirectError" + }, + { + "type": "reference", + "id": 584, + "name": "AuthRetryableFetchError" + } + ] + }, + { + "id": 1, + "name": "GoTrueAdminApi", + "kind": 128, + "kindString": "Class", + "flags": { + + }, + "children": [ + { + "id": 2, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 19, + "character": 2 + } + ], + "signatures": [ + { + "id": 3, + "name": "new GoTrueAdminApi", + "kind": 16384, + "kindString": "Constructor signature", + "flags": { + + }, + "parameters": [ + { + "id": 4, + "name": "__namedParameters", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "reflection", + "declaration": { + "id": 5, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 11, + "name": "fetch", "kind": 1024, "kindString": "Property", "flags": { - "isOptional": true + "isOptional": true }, "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 295, - "character": 2 - } + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 28, + "character": 4 + } ], "type": { - "type": "reflection", - "declaration": { - "id": 420, + "type": "reflection", + "declaration": { + "id": 12, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "signatures": [ + { + "id": 13, "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 423, - "name": "queryParams", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "An object of query params" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 301, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 424, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 301, - "character": 18 - } - ], - "indexSignature": { - "id": 425, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 426, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "parameters": [ + { + "id": 14, + "name": "input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + }, - { - "id": 421, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" }, - "comment": { - "shortText": "A URL to send the user to after they are confirmed (OAuth logins only)." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 297, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" } + ] + } + }, + { + "id": 15, + "name": "init", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true }, - { - "id": 422, - "name": "scopes", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A space-separated list of scopes granted to the OAuth application." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 299, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } + "type": { + "type": "reference", + "qualifiedName": "RequestInit", + "package": "typescript", + "name": "RequestInit" } + } ], - "groups": [ + "type": { + "type": "reference", + "typeArguments": [ { - "title": "Properties", - "kind": 1024, - "children": [ - 423, - 421, - 422 - ] + "type": "reference", + "qualifiedName": "Response", + "package": "typescript", + "name": "Response" } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 295, - "character": 12 - } - ] - } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } } - }, - { - "id": 418, - "name": "provider", + }, + { + "id": 7, + "name": "headers", "kind": 1024, "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "One of the providers supported by GoTrue." + "flags": { + "isOptional": true }, "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 294, - "character": 2 - } + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 25, + "character": 4 + } ], "type": { - "type": "reference", - "id": 263, - "name": "Provider" + "type": "reflection", + "declaration": { + "id": 8, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "indexSignature": { + "id": 9, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": { + + }, + "parameters": [ + { + "id": 10, + "name": "key", + "kind": 32768, + "flags": { + + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } } - } - ], - "groups": [ - { + }, + { + "id": 6, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 24, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { "title": "Properties", "kind": 1024, "children": [ - 419, - 418 + 11, + 7, + 6 ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 292, - "character": 41 - } - ] - } - } - }, - { - "id": 389, - "name": "SignInWithPasswordCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 246, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 390, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 391, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 249, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 393, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 252, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 394, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 395, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 254, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 395 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 252, - "character": 16 - } - ] - } - } - }, - { - "id": 392, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 251, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 391, - 393, - 392 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 247, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 396, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 399, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 262, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 400, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 401, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 264, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 401 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 262, - "character": 16 - } - ] - } - } - }, - { - "id": 398, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 261, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 397, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 259, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 399, - 398, - 397 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 257, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 402, - "name": "SignInWithPasswordlessCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 268, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 403, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 404, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 271, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 405, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 272, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 406, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 409, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 278, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 407, - "name": "emailRedirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The redirect url embedded in the email link" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 274, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 408, - "name": "shouldCreateUser", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 276, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 409, - 407, - 408 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 272, - "character": 16 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 404, - 405 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 269, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 410, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 412, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 284, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 413, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 415, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 288, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 414, - "name": "shouldCreateUser", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 286, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 415, - 414 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 284, - "character": 16 - } - ] - } - } - }, - { - "id": 411, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 283, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 412, - 411 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 281, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 373, - "name": "SignUpWithPasswordCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 219, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 374, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 375, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 222, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 377, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 225, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 378, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 381, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 231, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 380, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's metadata." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 229, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 379, - "name": "emailRedirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The redirect url embedded in the email link" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 227, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 381, - 380, - 379 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 225, - "character": 16 - } - ] - } - } - }, - { - "id": 376, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 224, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 375, - 377, - 376 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 220, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 382, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 385, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 239, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 386, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 388, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 243, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 387, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's metadata." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 241, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 388, - 387 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 239, - "character": 16 - } - ] - } - } - }, - { - "id": 384, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 238, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 383, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 236, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 385, - 384, - 383 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 234, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 439, - "name": "SupportedStorage", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 344, - "character": 12 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Storage", - "package": "typescript", - "name": "Storage" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "getItem" - }, - { - "type": "literal", - "value": "setItem" - }, - { - "type": "literal", - "value": "removeItem" - } - ] - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + } + ] + } } + } ], - "name": "PromisifyMethods" - } - }, - { - "id": 291, - "name": "UserResponse", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 62, - "character": 12 + "type": { + "type": "reference", + "id": 1, + "name": "default" } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 292, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 293, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 64, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 294, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 295, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 65, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 321, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 295 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 64, - "character": 12 - } - ] - } - } - }, - { - "id": 296, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 67, - "character": 6 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 293, - 296 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 63, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 297, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 298, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 70, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 299, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 300, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 71, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 300 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 70, - "character": 12 - } - ] - } - } - }, - { - "id": 301, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 73, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 450, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 298, - 301 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 69, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 427, - "name": "VerifyOtpParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, + } + ] + }, + { + "id": 41, + "name": "createUser", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 305, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 428, - "name": "VerifyMobileOtpParams" - }, - { - "type": "reference", - "id": 432, - "name": "VerifyEmailOtpParams" - } - ] - } - }, - { - "id": 447, - "name": "isAuthError", - "kind": 64, - "kindString": "Function", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 10, - "character": 16 - } + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 126, + "character": 8 + } ], "signatures": [ - { - "id": 448, - "name": "isAuthError", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 449, - "name": "error", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, + { + "id": 42, + "name": "createUser", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "Creates a new user.\nThis function should only be called on a server. Never expose your `service_role` key in the browser." + }, + "parameters": [ + { + "id": 43, + "name": "attributes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "reference", + "id": 343, + "name": "AdminUserAttributes" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 280, + "name": "UserResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 63, + "name": "deleteUser", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 216, + "character": 8 + } + ], + "signatures": [ + { + "id": 64, + "name": "deleteUser", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "Delete a user. Requires a `service_role` key." + }, + "parameters": [ + { + "id": 65, + "name": "id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "comment": { + "shortText": "The user id you want to remove.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 280, + "name": "UserResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 38, + "name": "generateLink", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 92, + "character": 8 + } + ], + "signatures": [ + { + "id": 39, + "name": "generateLink", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "Generates email links and OTPs to be sent via a custom email provider." + }, + "parameters": [ + { + "id": 40, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "reference", + "id": 458, + "name": "GenerateLinkParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 459, + "name": "GenerateLinkResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 56, + "name": "getUserById", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 171, + "character": 8 + } + ], + "signatures": [ + { + "id": 57, + "name": "getUserById", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "Get user by id." + }, + "parameters": [ + { + "id": 58, + "name": "uid", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "comment": { + "shortText": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 280, + "name": "UserResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 31, + "name": "inviteUserByEmail", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 62, + "character": 8 + } + ], + "signatures": [ + { + "id": 32, + "name": "inviteUserByEmail", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "Sends an invite link to an email address." + }, + "parameters": [ + { + "id": 33, + "name": "email", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "comment": { + "shortText": "The email address of the user." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 34, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "reflection", + "declaration": { + "id": 35, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 37, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Optional user metadata\n" + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 66, + "character": 6 + } + ], "type": { - "type": "intrinsic", - "name": "unknown" + "type": "intrinsic", + "name": "object" } + }, + { + "id": 36, + "name": "redirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A URL or mobile deeplink to send the user to after they are confirmed." + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 65, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 37, + 36 + ] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 280, + "name": "UserResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 44, + "name": "listUsers", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 147, + "character": 8 + } + ], + "signatures": [ + { + "id": 45, + "name": "listUsers", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "Get a list of users.", + "text": "This function should only be called on a server. Never expose your `service_role` key in the browser.\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 46, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 47, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 148, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 48, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 49, + "name": "users", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 148, + "character": 14 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 310, + "name": "User" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 49 + ] + } + ] + } + } + }, + { + "id": 50, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 148, + "character": 31 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 47, + 50 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 51, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 52, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 148, + "character": 49 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 53, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 54, + "name": "users", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 148, + "character": 57 + } + ], + "type": { + "type": "tuple" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 54 + ] + } + ] + } + } + }, + { + "id": 55, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 148, + "character": 70 + } + ], + "type": { + "type": "reference", + "id": 494, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 52, + 55 + ] + } + ] + } } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 26, + "name": "signOut", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 39, + "character": 8 + } + ], + "signatures": [ + { + "id": 27, + "name": "signOut", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "Removes a logged-in session." + }, + "parameters": [ + { + "id": 28, + "name": "jwt", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "comment": { + "shortText": "A valid, logged-in JWT.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 29, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 30, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 39, + "character": 40 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 494, + "name": "AuthError" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 30 + ] + } + ] + } + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 59, + "name": "updateUserById", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 193, + "character": 8 + } + ], + "signatures": [ + { + "id": 60, + "name": "updateUserById", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "Updates the user data." + }, + "parameters": [ + { + "id": 61, + "name": "uid", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 62, + "name": "attributes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "comment": { + "shortText": "The data you want to update.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" + }, + "type": { + "type": "reference", + "id": 343, + "name": "AdminUserAttributes" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 280, + "name": "UserResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 2 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 41, + 63, + 38, + 56, + 31, + 44, + 26, + 59 + ] + } + ], + "sources": [ + { + "fileName": "src/GoTrueAdminApi.ts", + "line": 12, + "character": 21 + } + ] + }, + { + "id": 66, + "name": "GoTrueClient", + "kind": 128, + "kindString": "Class", + "flags": { + + }, + "children": [ + { + "id": 67, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 104, + "character": 2 + } + ], + "signatures": [ + { + "id": 68, + "name": "new GoTrueClient", + "kind": 16384, + "kindString": "Constructor signature", + "flags": { + + }, + "comment": { + "shortText": "Create a new client for use in the browser." + }, + "parameters": [ + { + "id": 69, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "reference", + "id": 241, + "name": "GoTrueClientOptions" + } + } + ], + "type": { + "type": "reference", + "id": 66, + "name": "default" + } + } + ] + }, + { + "id": 70, + "name": "admin", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "Namespace for the GoTrue admin methods.\nThese methods should only be used in a trusted server-side environment." + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 68, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 1, + "name": "default" + } + }, + { + "id": 111, + "name": "getSession", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 407, + "character": 8 + } + ], + "signatures": [ + { + "id": 112, + "name": "getSession", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "Returns the session, refreshing it if necessary.\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 113, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 114, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 409, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 115, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 116, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 410, + "character": 10 + } + ], + "type": { + "type": "reference", + "id": 291, + "name": "Session" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 116 + ] + } + ] + } + } + }, + { + "id": 117, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 412, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 114, + 117 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 118, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 119, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 415, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 120, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 121, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 416, + "character": 10 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 121 + ] + } + ] + } + } + }, + { + "id": 122, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 418, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 494, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 119, + 122 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 123, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 124, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 421, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 125, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 126, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 422, + "character": 10 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 126 + ] + } + ] + } + } + }, + { + "id": 127, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 424, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 124, + 127 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 128, + "name": "getUser", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 470, + "character": 8 + } + ], + "signatures": [ + { + "id": 129, + "name": "getUser", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "Gets the current user details if there is an existing session." + }, + "parameters": [ + { + "id": 130, + "name": "jwt", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Takes in an optional access token jwt. If no jwt is provided, getUser() will attempt to get the jwt from the current session.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 280, + "name": "UserResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 92, + "name": "initialize", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 130, + "character": 2 + } + ], + "signatures": [ + { + "id": 93, + "name": "initialize", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "Initializes the client session either from the url or from storage.\nThis method is automatically called when instantiating the client, but should also be called\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 481, + "name": "InitializeResult" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 157, + "name": "onAuthStateChange", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 665, + "character": 2 + } + ], + "signatures": [ + { + "id": 158, + "name": "onAuthStateChange", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "Receive a notification every time an auth event happens." + }, + "parameters": [ + { + "id": 159, + "name": "callback", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "comment": { + "shortText": "A callback function to be invoked when an auth event happens.\n" + }, + "type": { + "type": "reflection", + "declaration": { + "id": 160, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "signatures": [ + { + "id": 161, + "name": "__type", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "parameters": [ + { + "id": 162, + "name": "event", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "reference", + "id": 240, + "name": "AuthChangeEvent" + } + }, + { + "id": 163, + "name": "session", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 291, + "name": "Session" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 164, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 165, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 666, + "character": 4 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 166, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 167, + "name": "subscription", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 666, + "character": 12 + } + ], + "type": { + "type": "reference", + "id": 352, + "name": "Subscription" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 167 + ] + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 165 + ] + } + ] + } + } + } + ] + }, + { + "id": 168, + "name": "resetPasswordForEmail", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 688, + "character": 8 + } + ], + "signatures": [ + { + "id": 169, + "name": "resetPasswordForEmail", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "Sends a password reset request to an email address." + }, + "parameters": [ + { + "id": 170, + "name": "email", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "comment": { + "shortText": "The email address of the user." + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 171, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "reflection", + "declaration": { + "id": 172, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 174, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site.\n" + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 692, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 173, + "name": "redirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The URL to send the user to after they click the password reset link." + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 691, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 174, + 173 + ] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 175, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 176, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 696, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 177, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + } + } + } + }, + { + "id": 178, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 697, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 176, + 178 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 179, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 180, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 699, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 181, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 699, + "character": 20 + } + ], + "type": { + "type": "reference", + "id": 494, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 180, + 181 + ] + } + ] + } + } + ] + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 134, + "name": "setSession", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 534, + "character": 8 + } + ], + "signatures": [ + { + "id": 135, + "name": "setSession", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "Sets the session data from refresh token and returns current session or an error if the refresh token is invalid." + }, + "parameters": [ + { + "id": 136, + "name": "refresh_token", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "comment": { + "shortText": "A refresh token returned by supabase auth.\n" + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 254, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 102, + "name": "signInWithOAuth", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 306, + "character": 8 + } + ], + "signatures": [ + { + "id": 103, + "name": "signInWithOAuth", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "Log in an existing user via a third-party provider." + }, + "parameters": [ + { + "id": 104, + "name": "credentials", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "reference", + "id": 403, + "name": "SignInWithOAuthCredentials" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 267, + "name": "OAuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 105, + "name": "signInWithOtp", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 321, + "character": 8 + } + ], + "signatures": [ + { + "id": 106, + "name": "signInWithOtp", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "Log in a user using magiclink or a one-time password (OTP).\nIf the `{{ .ConfirmationURL }}` variable is specified in the email template, a magiclink will be sent.\nIf the `{{ .Token }}` variable is specified in the email template, an OTP will be sent.\nIf you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins." + }, + "parameters": [ + { + "id": 107, + "name": "credentials", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "reference", + "id": 389, + "name": "SignInWithPasswordlessCredentials" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 254, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 99, + "name": "signInWithPassword", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 256, + "character": 8 + } + ], + "signatures": [ + { + "id": 100, + "name": "signInWithPassword", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "Log in an existing user with an email and password or phone and password." + }, + "parameters": [ + { + "id": 101, + "name": "credentials", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "reference", + "id": 376, + "name": "SignInWithPasswordCredentials" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 254, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 153, + "name": "signOut", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 646, + "character": 8 + } + ], + "signatures": [ + { + "id": 154, + "name": "signOut", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "Inside a browser context, `signOut()` will remove the logged in user from the browser session\nand log them out - removing all items from localstorage and then trigger a `\"SIGNED_OUT\"` event.", + "text": "For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to `auth.api.signOut(JWT: string)`.\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 155, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 156, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 646, + "character": 29 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 494, + "name": "AuthError" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 156 + ] + } + ] + } + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 96, + "name": "signUp", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 193, + "character": 8 + } + ], + "signatures": [ + { + "id": 97, + "name": "signUp", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "Creates a new user.", + "returns": "A logged-in session if the server has \"autoconfirm\" ON" + }, + "parameters": [ + { + "id": 98, + "name": "credentials", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "reference", + "id": 360, + "name": "SignUpWithPasswordCredentials" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 254, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 131, + "name": "updateUser", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 499, + "character": 8 + } + ], + "signatures": [ + { + "id": 132, + "name": "updateUser", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "Updates user data, if there is a logged in user." + }, + "parameters": [ + { + "id": 133, + "name": "attributes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "reference", + "id": 338, + "name": "UserAttributes" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 280, + "name": "UserResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 108, + "name": "verifyOtp", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 363, + "character": 8 + } + ], + "signatures": [ + { + "id": 109, + "name": "verifyOtp", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "Log in a user given a User supplied OTP received via mobile." + }, + "parameters": [ + { + "id": 110, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "reference", + "id": 414, + "name": "VerifyOtpParams" + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 254, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 67 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 70 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 111, + 128, + 92, + 157, + 168, + 134, + 102, + 105, + 99, + 153, + 96, + 131, + 108 + ] + } + ], + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 63, + "character": 21 + } + ] + }, + { + "id": 343, + "name": "AdminUserAttributes", + "kind": 256, + "kindString": "Interface", + "flags": { + + }, + "children": [ + { + "id": 345, + "name": "app_metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", + "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 205, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 351, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 180, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + }, + "inheritedFrom": { + "type": "reference", + "id": 342, + "name": "UserAttributes.data" + } + }, + { + "id": 348, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's email." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 162, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 339, + "name": "UserAttributes.email" + } + }, + { + "id": 346, + "name": "email_confirm", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Confirms the user's email address if set to true.", + "text": "Only a service role can modify.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 212, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 350, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 172, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 341, + "name": "UserAttributes.password" + } + }, + { + "id": 349, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's phone." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 167, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 340, + "name": "UserAttributes.phone" + } + }, + { + "id": 347, + "name": "phone_confirm", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Confirms the user's phone number if set to true.", + "text": "Only a service role can modify.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 219, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 344, + "name": "user_metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "Only a service role can modify.\n\nThe `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 195, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 345, + 351, + 348, + 346, + 350, + 349, + 347, + 344 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 183, + "character": 17 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 338, + "name": "UserAttributes" + } + ] + }, + { + "id": 455, + "name": "GenerateLinkOptions", + "kind": 256, + "kindString": "Interface", + "flags": { + + }, + "children": [ + { + "id": 456, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 402, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 457, + "name": "redirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The URL which will be appended to the email link generated." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 404, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 456, + 457 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 396, + "character": 17 + } + ] + }, + { + "id": 291, + "name": "Session", + "kind": 256, + "kindString": "Interface", + "flags": { + + }, + "children": [ + { + "id": 293, + "name": "access_token", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 101, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 296, + "name": "expires_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A timestamp of when the token will expire. Returned when a login is confirmed." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 113, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 295, + "name": "expires_in", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 109, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 292, + "name": "provider_token", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 97, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 294, + "name": "refresh_token", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "A one-time used refresh token that never expires." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 105, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 297, + "name": "token_type", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 114, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 298, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 115, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 310, + "name": "User" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 293, + 296, + 295, + 292, + 294, + 297, + 298 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 96, + "character": 17 + } + ] + }, + { + "id": 352, + "name": "Subscription", + "kind": 256, + "kindString": "Interface", + "flags": { + + }, + "children": [ + { + "id": 353, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The subscriber UUID. This will be set by the client." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 226, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 354, + "name": "callback", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 230, + "character": 2 + } + ], + "signatures": [ + { + "id": 355, + "name": "callback", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "The function to call every time there is an event. eg: (eventName) => {}" + }, + "parameters": [ + { + "id": 356, + "name": "event", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "reference", + "id": 240, + "name": "AuthChangeEvent" + } + }, + { + "id": 357, + "name": "session", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 291, + "name": "Session" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 358, + "name": "unsubscribe", + "kind": 2048, + "kindString": "Method", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 234, + "character": 2 + } + ], + "signatures": [ + { + "id": 359, + "name": "unsubscribe", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "comment": { + "shortText": "Call this to remove the listener." + }, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 353 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 354, + 358 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 222, + "character": 17 + } + ] + }, + { + "id": 310, + "name": "User", + "kind": 256, + "kindString": "Interface", + "flags": { + + }, + "children": [ + { + "id": 327, + "name": "action_link", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 145, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 312, + "name": "app_metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 132, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 313, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 314, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 133, + "character": 4 + } ], "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "id": 450, - "name": "AuthError" - } + "type": "intrinsic", + "name": "string" } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 314 + ] + } + ], + "indexSignature": { + "id": 315, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": { + + }, + "parameters": [ + { + "id": 316, + "name": "key", + "kind": 32768, + "flags": { + + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } } + } + } + }, + { + "id": 321, + "name": "aud", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 139, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 322, + "name": "confirmation_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 140, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 331, + "name": "confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 149, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 330, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 148, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 328, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 146, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 324, + "name": "email_change_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 142, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 332, + "name": "email_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 150, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 311, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 131, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 337, + "name": "identities", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 155, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 299, + "name": "UserIdentity" + } + } + }, + { + "id": 326, + "name": "invited_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 144, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 334, + "name": "last_sign_in_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 152, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 325, + "name": "new_email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 143, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 329, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 147, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 333, + "name": "phone_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 151, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 323, + "name": "recovery_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 141, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 335, + "name": "role", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 153, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 336, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 154, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 317, + "name": "user_metadata", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 136, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 318, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "indexSignature": { + "id": 319, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": { + + }, + "parameters": [ + { + "id": 320, + "name": "key", + "kind": 32768, + "flags": { + + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 327, + 312, + 321, + 322, + 331, + 330, + 328, + 324, + 332, + 311, + 337, + 326, + 334, + 325, + 329, + 333, + 323, + 335, + 336, + 317 ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 130, + "character": 17 + } + ] + }, + { + "id": 338, + "name": "UserAttributes", + "kind": 256, + "kindString": "Interface", + "flags": { + + }, + "children": [ + { + "id": 342, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 180, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 339, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's email." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 162, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 341, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 172, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 340, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's phone." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 167, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 342, + 339, + 341, + 340 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 158, + "character": 17 + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 343, + "name": "AdminUserAttributes" + } + ] + }, + { + "id": 299, + "name": "UserIdentity", + "kind": 256, + "kindString": "Interface", + "flags": { + + }, + "children": [ + { + "id": 307, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 125, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 300, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 119, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 302, + "name": "identity_data", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 121, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 303, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "indexSignature": { + "id": 304, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": { + + }, + "parameters": [ + { + "id": 305, + "name": "key", + "kind": 32768, + "flags": { + + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 308, + "name": "last_sign_in_at", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 126, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 306, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 124, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 309, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 127, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 301, + "name": "user_id", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 120, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 307, + 300, + 302, + 308, + 306, + 309, + 301 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 118, + "character": 17 + } + ] + }, + { + "id": 423, + "name": "VerifyEmailOtpParams", + "kind": 256, + "kindString": "Interface", + "flags": { + + }, + "children": [ + { + "id": 424, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 348, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 427, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 353, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 428, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 430, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 357, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 429, + "name": "redirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A URL to send the user to after they are confirmed." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 355, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 430, + 429 + ] + } + ] + } + } + }, + { + "id": 425, + "name": "token", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The otp sent to the user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 350, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 426, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The user's verification type." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 352, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 432, + "name": "EmailOtpType" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 424, + 427, + 425, + 426 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 346, + "character": 17 + } + ] + }, + { + "id": 415, + "name": "VerifyMobileOtpParams", + "kind": 256, + "kindString": "Interface", + "flags": { + + }, + "children": [ + { + "id": 419, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 339, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 420, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 422, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 343, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 421, + "name": "redirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A URL to send the user to after they are confirmed." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 341, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 422, + 421 + ] + } + ] + } + } + }, + { + "id": 416, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 334, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 417, + "name": "token", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The otp sent to the user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 336, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 418, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The user's verification type." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 338, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 431, + "name": "MobileOtpType" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 419, + 416, + 417, + 418 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 332, + "character": 17 + } + ] + }, + { + "id": 240, + "name": "AuthChangeEvent", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 23, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "PASSWORD_RECOVERY" + }, + { + "type": "literal", + "value": "SIGNED_IN" + }, + { + "type": "literal", + "value": "SIGNED_OUT" + }, + { + "type": "literal", + "value": "TOKEN_REFRESHED" + }, + { + "type": "literal", + "value": "USER_UPDATED" + }, + { + "type": "literal", + "value": "USER_DELETED" + } + ] } + }, + { + "id": 254, + "name": "AuthResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 50, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 255, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 256, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 52, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 257, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 259, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 54, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 291, + "name": "Session" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 258, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 53, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 310, + "name": "User" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 259, + 258 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 52, + "character": 12 + } + ] + } + } + }, + { + "id": 260, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 56, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 256, + 260 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 51, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 261, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 262, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 59, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 263, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 265, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 61, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 264, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 60, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 265, + 264 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 59, + "character": 12 + } + ] + } + } + }, + { + "id": 266, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 63, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 494, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 262, + 266 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 58, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 484, + "name": "CallRefreshTokenResult", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 472, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 485, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 487, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 475, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 486, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 474, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 291, + "name": "Session" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 487, + 486 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 473, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 488, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 490, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 479, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 494, + "name": "AuthError" + } + }, + { + "id": 489, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 478, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 490, + 489 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 477, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 432, + "name": "EmailOtpType", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 362, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "signup" + }, + { + "type": "literal", + "value": "invite" + }, + { + "type": "literal", + "value": "magiclink" + }, + { + "type": "literal", + "value": "recovery" + }, + { + "type": "literal", + "value": "email_change" + } + ] + } + }, + { + "id": 449, + "name": "GenerateEmailChangeLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 385, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 450, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 452, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The user's email" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 388, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 453, + "name": "newEmail", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 392, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 454, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 393, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 455, + "name": "GenerateLinkOptions" + }, + { + "type": "literal", + "value": "redirectTo" + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 451, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 386, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "email_change_current" + }, + { + "type": "literal", + "value": "email_change_new" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 452, + 453, + 454, + 451 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 385, + "character": 44 + } + ] + } + } + }, + { + "id": 439, + "name": "GenerateInviteOrMagiclinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 371, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 440, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 442, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The user's email" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 374, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 443, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 375, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 455, + "name": "GenerateLinkOptions" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "data" + }, + { + "type": "literal", + "value": "redirectTo" + } + ] + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 441, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 372, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "invite" + }, + { + "type": "literal", + "value": "magiclink" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 442, + 443, + 441 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 371, + "character": 46 + } + ] + } + } + }, + { + "id": 458, + "name": "GenerateLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 407, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 433, + "name": "GenerateSignupLinkParams" + }, + { + "type": "reference", + "id": 439, + "name": "GenerateInviteOrMagiclinkParams" + }, + { + "type": "reference", + "id": 444, + "name": "GenerateRecoveryLinkParams" + }, + { + "type": "reference", + "id": 449, + "name": "GenerateEmailChangeLinkParams" + } + ] + } + }, + { + "id": 472, + "name": "GenerateLinkProperties", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "comment": { + "shortText": "The properties related to the email link generated" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 430, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 473, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 474, + "name": "action_link", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The email link to send to the user.\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 435, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 475, + "name": "email_otp", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The raw email OTP.\nYou should send this in the email if you want your users to verify using an OTP instead of the action link." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 440, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 476, + "name": "hashed_token", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The hashed token appended to the action link." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 444, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 477, + "name": "redirect_to", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The URL appended to the action link." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 446, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 478, + "name": "verification_type", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The verification type that the email link is associated to." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 448, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 479, + "name": "GenerateLinkType" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 474, + 475, + 476, + 477, + 478 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 430, + "character": 37 + } + ] + } + } + }, + { + "id": 459, + "name": "GenerateLinkResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 413, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 460, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 461, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 415, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 462, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 463, + "name": "properties", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 416, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 472, + "name": "GenerateLinkProperties" + } + }, + { + "id": 464, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 417, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 310, + "name": "User" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 463, + 464 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 415, + "character": 12 + } + ] + } + } + }, + { + "id": 465, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 419, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 461, + 465 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 414, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 466, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 467, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 422, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 468, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 469, + "name": "properties", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 423, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 470, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 424, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 469, + 470 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 422, + "character": 12 + } + ] + } + } + }, + { + "id": 471, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 426, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 494, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 467, + 471 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 421, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 479, + "name": "GenerateLinkType", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 451, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "signup" + }, + { + "type": "literal", + "value": "invite" + }, + { + "type": "literal", + "value": "magiclink" + }, + { + "type": "literal", + "value": "recovery" + }, + { + "type": "literal", + "value": "email_change_current" + }, + { + "type": "literal", + "value": "email_change_new" + } + ] + } + }, + { + "id": 444, + "name": "GenerateRecoveryLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 378, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 445, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 447, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The user's email" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 381, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 448, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 382, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 455, + "name": "GenerateLinkOptions" + }, + { + "type": "literal", + "value": "redirectTo" + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 446, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 379, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "recovery" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 447, + 448, + 446 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 378, + "character": 41 + } + ] + } + } + }, + { + "id": 433, + "name": "GenerateSignupLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 364, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 434, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 436, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 366, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 438, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 368, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 455, + "name": "GenerateLinkOptions" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "data" + }, + { + "type": "literal", + "value": "redirectTo" + } + ] + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 437, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 367, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 435, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 365, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "signup" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 436, + 438, + 437, + 435 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 364, + "character": 39 + } + ] + } + } + }, + { + "id": 241, + "name": "GoTrueClientOptions", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 31, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 242, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 250, + "name": "autoRefreshToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 249, + "name": "detectSessionInUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 39, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 253, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 47, + "character": 2 + } + ], + "type": { + "type": "reference", + "name": "Fetch" + } + }, + { + "id": 244, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 35, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 245, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 35, + "character": 12 + } + ], + "indexSignature": { + "id": 246, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": { + + }, + "parameters": [ + { + "id": 247, + "name": "key", + "kind": 32768, + "flags": { + + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + } + }, + { + "id": 251, + "name": "persistSession", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 43, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 252, + "name": "storage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 45, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 480, + "name": "SupportedStorage" + } + }, + { + "id": 248, + "name": "storageKey", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 37, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 243, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 33, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 250, + 249, + 253, + 244, + 251, + 252, + 248, + 243 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 31, + "character": 34 + } + ] + } + } + }, + { + "id": 481, + "name": "InitializeResult", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 470, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 482, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 483, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 470, + "character": 33 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 494, + "name": "AuthError" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 483 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 470, + "character": 31 + } + ] + } + } + }, + { + "id": 431, + "name": "MobileOtpType", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 361, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "sms" + }, + { + "type": "literal", + "value": "phone_change" + } + ] + } + }, + { + "id": 267, + "name": "OAuthResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 66, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 268, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 269, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 68, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 270, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 271, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 69, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 239, + "name": "Provider" + } + }, + { + "id": 272, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 70, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 271, + 272 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 68, + "character": 12 + } + ] + } + } + }, + { + "id": 273, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 72, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 269, + 273 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 67, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 274, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 275, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 75, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 276, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 277, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 76, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 239, + "name": "Provider" + } + }, + { + "id": 278, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 77, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 277, + 278 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 75, + "character": 12 + } + ] + } + } + }, + { + "id": 279, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 79, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 494, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 275, + 279 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 74, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 239, + "name": "Provider", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "comment": { + "shortText": "One of the providers supported by GoTrue." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 5, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "apple" + }, + { + "type": "literal", + "value": "azure" + }, + { + "type": "literal", + "value": "bitbucket" + }, + { + "type": "literal", + "value": "discord" + }, + { + "type": "literal", + "value": "facebook" + }, + { + "type": "literal", + "value": "github" + }, + { + "type": "literal", + "value": "gitlab" + }, + { + "type": "literal", + "value": "google" + }, + { + "type": "literal", + "value": "keycloak" + }, + { + "type": "literal", + "value": "linkedin" + }, + { + "type": "literal", + "value": "notion" + }, + { + "type": "literal", + "value": "slack" + }, + { + "type": "literal", + "value": "spotify" + }, + { + "type": "literal", + "value": "twitch" + }, + { + "type": "literal", + "value": "twitter" + }, + { + "type": "literal", + "value": "workos" + } + ] + } + }, + { + "id": 403, + "name": "SignInWithOAuthCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 318, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 404, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 406, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 321, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 407, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 410, + "name": "queryParams", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "An object of query params" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 327, + "character": 4 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 411, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 327, + "character": 18 + } + ], + "indexSignature": { + "id": 412, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": { + + }, + "parameters": [ + { + "id": 413, + "name": "key", + "kind": 32768, + "flags": { + + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + } + }, + { + "id": 408, + "name": "redirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A URL to send the user to after they are confirmed." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 323, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 409, + "name": "scopes", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A space-separated list of scopes granted to the OAuth application." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 325, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 410, + 408, + 409 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 321, + "character": 12 + } + ] + } + } + }, + { + "id": 405, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "One of the providers supported by GoTrue." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 320, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 239, + "name": "Provider" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 406, + 405 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 318, + "character": 41 + } + ] + } + } + }, + { + "id": 376, + "name": "SignInWithPasswordCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 272, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 377, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 378, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 275, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 380, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 278, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 381, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 382, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 280, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 382 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 278, + "character": 16 + } + ] + } + } + }, + { + "id": 379, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 277, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 378, + 380, + 379 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 273, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 383, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 386, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 288, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 387, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 388, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 290, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 388 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 288, + "character": 16 + } + ] + } + } + }, + { + "id": 385, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 287, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 384, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 285, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 386, + 385, + 384 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 283, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 389, + "name": "SignInWithPasswordlessCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 294, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 390, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 391, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 297, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 392, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 298, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 393, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 396, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 304, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 394, + "name": "emailRedirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The redirect url embedded in the email link" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 300, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 395, + "name": "shouldCreateUser", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If set to false, this method will not create a new user. Defaults to true." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 302, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 396, + 394, + 395 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 298, + "character": 16 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 391, + 392 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 295, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 397, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 399, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 310, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 400, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 402, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 314, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 401, + "name": "shouldCreateUser", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If set to false, this method will not create a new user. Defaults to true." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 312, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 402, + 401 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 310, + "character": 16 + } + ] + } + } + }, + { + "id": 398, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 309, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 399, + 398 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 307, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 360, + "name": "SignUpWithPasswordCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 237, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 361, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 362, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 240, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 364, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 243, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 365, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 368, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 253, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 367, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 251, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 366, + "name": "emailRedirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The redirect url embedded in the email link" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 245, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 368, + 367, + 366 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 243, + "character": 16 + } + ] + } + } + }, + { + "id": 363, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 242, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 362, + 364, + 363 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 238, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 369, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 372, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 261, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 373, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 375, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 269, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 374, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 267, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 375, + 374 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 261, + "character": 16 + } + ] + } + } + }, + { + "id": 371, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 260, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 370, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 258, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 372, + 371, + 370 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 256, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 480, + "name": "SupportedStorage", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 468, + "character": 12 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "qualifiedName": "Storage", + "package": "typescript", + "name": "Storage" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "getItem" + }, + { + "type": "literal", + "value": "setItem" + }, + { + "type": "literal", + "value": "removeItem" + } + ] + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + ], + "name": "PromisifyMethods" + } + }, + { + "id": 280, + "name": "UserResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 82, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 281, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 282, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 84, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 283, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 284, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 85, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 310, + "name": "User" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 284 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 84, + "character": 12 + } + ] + } + } + }, + { + "id": 285, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 87, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 282, + 285 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 83, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 286, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 287, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 288, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + + }, + "children": [ + { + "id": 289, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 91, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 289 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 90, + "character": 12 + } + ] + } + } + }, + { + "id": 290, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 93, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 494, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 287, + 290 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 89, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 414, + "name": "VerifyOtpParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 331, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 415, + "name": "VerifyMobileOtpParams" + }, + { + "type": "reference", + "id": 423, + "name": "VerifyEmailOtpParams" + } + ] + } + }, + { + "id": 491, + "name": "isAuthError", + "kind": 64, + "kindString": "Function", + "flags": { + + }, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 10, + "character": 16 + } + ], + "signatures": [ + { + "id": 492, + "name": "isAuthError", + "kind": 4096, + "kindString": "Call signature", + "flags": { + + }, + "parameters": [ + { + "id": 493, + "name": "error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "predicate", + "name": "error", + "asserts": false, + "targetType": { + "type": "reference", + "id": 494, + "name": "AuthError" + } + } + } + ] + } ], "groups": [ - { - "title": "Classes", - "kind": 128, - "children": [ - 455, - 450, - 502, - 515, - 490, - 468, - 475, - 1, - 81 - ] - }, - { - "title": "Interfaces", - "kind": 256, - "children": [ - 355, - 302, - 365, - 321, - 349, - 310, - 432, - 428 - ] - }, - { - "title": "Type Aliases", - "kind": 4194304, - "children": [ - 264, - 265, - 440, - 437, - 438, - 436, - 278, - 263, - 416, - 389, - 402, - 373, - 439, - 291, - 427 - ] - }, - { - "title": "Functions", - "kind": 64, - "children": [ - 447 - ] - } + { + "title": "Classes", + "kind": 128, + "children": [ + 499, + 494, + 559, + 546, + 584, + 534, + 512, + 519, + 1, + 66 + ] + }, + { + "title": "Interfaces", + "kind": 256, + "children": [ + 343, + 455, + 291, + 352, + 310, + 338, + 299, + 423, + 415 + ] + }, + { + "title": "Type Aliases", + "kind": 4194304, + "children": [ + 240, + 254, + 484, + 432, + 449, + 439, + 458, + 472, + 459, + 479, + 444, + 433, + 241, + 481, + 431, + 267, + 239, + 403, + 376, + 389, + 360, + 480, + 280, + 414 + ] + }, + { + "title": "Functions", + "kind": 64, + "children": [ + 491 + ] + } ], "sources": [ - { - "fileName": "src/index.ts", - "line": 1, - "character": 0 - } + { + "fileName": "src/index.ts", + "line": 1, + "character": 0 + } ] -} \ No newline at end of file + } \ No newline at end of file diff --git a/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json b/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json index a874ab0aa38..80140fb9800 100644 --- a/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json +++ b/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json @@ -7,14 +7,14 @@ "originalName": "", "children": [ { - "id": 455, + "id": 499, "name": "AuthApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 456, + "id": 500, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -28,14 +28,14 @@ ], "signatures": [ { - "id": 457, + "id": 501, "name": "new AuthApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 458, + "id": 502, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -46,7 +46,7 @@ } }, { - "id": 459, + "id": 503, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -59,24 +59,24 @@ ], "type": { "type": "reference", - "id": 455, + "id": 499, "name": "AuthApiError" }, "overwrites": { "type": "reference", - "id": 452, + "id": 496, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 451, + "id": 495, "name": "AuthError.constructor" } }, { - "id": 460, + "id": 504, "name": "status", "kind": 1024, "kindString": "Property", @@ -94,7 +94,7 @@ } }, { - "id": 461, + "id": 505, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -108,7 +108,7 @@ ], "signatures": [ { - "id": 462, + "id": 506, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -116,14 +116,14 @@ "type": { "type": "reflection", "declaration": { - "id": 463, + "id": 507, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 465, + "id": 509, "name": "message", "kind": 1024, "kindString": "Property", @@ -142,7 +142,7 @@ "defaultValue": "..." }, { - "id": 464, + "id": 508, "name": "name", "kind": 1024, "kindString": "Property", @@ -161,7 +161,7 @@ "defaultValue": "..." }, { - "id": 466, + "id": 510, "name": "status", "kind": 1024, "kindString": "Property", @@ -185,9 +185,9 @@ "title": "Properties", "kind": 1024, "children": [ - 465, - 464, - 466 + 509, + 508, + 510 ] } ] @@ -202,21 +202,21 @@ "title": "Constructors", "kind": 512, "children": [ - 456 + 500 ] }, { "title": "Properties", "kind": 1024, "children": [ - 460 + 504 ] }, { "title": "Methods", "kind": 2048, "children": [ - 461 + 505 ] } ], @@ -230,20 +230,20 @@ "extendedTypes": [ { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } ] }, { - "id": 450, + "id": 494, "name": "AuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 451, + "id": 495, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -257,14 +257,14 @@ ], "signatures": [ { - "id": 452, + "id": 496, "name": "new AuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 453, + "id": 497, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -277,7 +277,7 @@ ], "type": { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" }, "overwrites": { @@ -297,7 +297,7 @@ "title": "Constructors", "kind": 512, "children": [ - 451 + 495 ] } ], @@ -319,30 +319,30 @@ "extendedBy": [ { "type": "reference", - "id": 455, + "id": 499, "name": "AuthApiError" }, { "type": "reference", - "id": 468, + "id": 512, "name": "AuthUnknownError" }, { "type": "reference", - "id": 475, + "id": 519, "name": "CustomAuthError" } ] }, { - "id": 502, - "name": "AuthInvalidCredentialsError", + "id": 559, + "name": "AuthImplicitGrantRedirectError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 503, + "id": 560, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -350,277 +350,20 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 67, + "line": 74, "character": 2 } ], "signatures": [ { - "id": 504, - "name": "new AuthInvalidCredentialsError", + "id": 561, + "name": "new AuthImplicitGrantRedirectError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 505, - "name": "message", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "id": 502, - "name": "AuthInvalidCredentialsError" - }, - "overwrites": { - "type": "reference", - "id": 477, - "name": "CustomAuthError.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "id": 476, - "name": "CustomAuthError.constructor" - } - }, - { - "id": 506, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 43, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 481, - "name": "CustomAuthError.name" - } - }, - { - "id": 507, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 44, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "id": 482, - "name": "CustomAuthError.status" - } - }, - { - "id": 508, - "name": "toJSON", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 51, - "character": 2 - } - ], - "signatures": [ - { - "id": 509, - "name": "toJSON", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 510, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 512, - "name": "message", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 54, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 511, - "name": "name", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 53, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "..." - }, - { - "id": 513, - "name": "status", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 55, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 512, - 511, - 513 - ] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "id": 484, - "name": "CustomAuthError.toJSON" - } - } - ], - "inheritedFrom": { - "type": "reference", - "id": 483, - "name": "CustomAuthError.toJSON" - } - } - ], - "groups": [ - { - "title": "Constructors", - "kind": 512, - "children": [ - 503 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 506, - 507 - ] - }, - { - "title": "Methods", - "kind": 2048, - "children": [ - 508 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 66, - "character": 13 - } - ], - "extendedTypes": [ - { - "type": "reference", - "id": 475, - "name": "CustomAuthError" - } - ] - }, - { - "id": 515, - "name": "AuthRetryableFetchError", - "kind": 128, - "kindString": "Class", - "flags": {}, - "children": [ - { - "id": 516, - "name": "constructor", - "kind": 512, - "kindString": "Constructor", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 73, - "character": 2 - } - ], - "signatures": [ - { - "id": 517, - "name": "new AuthRetryableFetchError", - "kind": 16384, - "kindString": "Constructor signature", - "flags": {}, - "parameters": [ - { - "id": 518, + "id": 562, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -631,37 +374,183 @@ } }, { - "id": 519, - "name": "status", + "id": 563, + "name": "details", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "intrinsic", - "name": "number" - } + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 564, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 566, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 74, + "character": 57 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 565, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 74, + "character": 42 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 566, + 565 + ] + } + ] + } + } + ] + }, + "defaultValue": "null" } ], "type": { "type": "reference", - "id": 515, - "name": "AuthRetryableFetchError" + "id": 559, + "name": "AuthImplicitGrantRedirectError" }, "overwrites": { "type": "reference", - "id": 477, + "id": 521, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 476, + "id": 520, "name": "CustomAuthError.constructor" } }, { - "id": 520, + "id": 567, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 73, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 568, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 570, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 73, + "character": 28 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 569, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 73, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 570, + 569 + ] + } + ] + } + } + ] + }, + "defaultValue": "null" + }, + { + "id": 581, "name": "name", "kind": 1024, "kindString": "Property", @@ -679,12 +568,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 481, + "id": 525, "name": "CustomAuthError.name" } }, { - "id": 521, + "id": 582, "name": "status", "kind": 1024, "kindString": "Property", @@ -702,12 +591,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 482, + "id": 526, "name": "CustomAuthError.status" } }, { - "id": 522, + "id": 571, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -715,13 +604,13 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 51, + "line": 79, "character": 2 } ], "signatures": [ { - "id": 523, + "id": 572, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -729,14 +618,96 @@ "type": { "type": "reflection", "declaration": { - "id": 524, + "id": 573, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 526, + "id": 577, + "name": "details", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 84, + "character": 6 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reflection", + "declaration": { + "id": 578, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 580, + "name": "code", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 73, + "character": 28 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 579, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 73, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 580, + 579 + ] + } + ] + } + } + ] + }, + "defaultValue": "..." + }, + { + "id": 575, "name": "message", "kind": 1024, "kindString": "Property", @@ -744,7 +715,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 54, + "line": 82, "character": 6 } ], @@ -755,7 +726,7 @@ "defaultValue": "..." }, { - "id": 525, + "id": 574, "name": "name", "kind": 1024, "kindString": "Property", @@ -763,7 +734,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 53, + "line": 81, "character": 6 } ], @@ -774,7 +745,7 @@ "defaultValue": "..." }, { - "id": 527, + "id": 576, "name": "status", "kind": 1024, "kindString": "Property", @@ -782,7 +753,7 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 55, + "line": 83, "character": 6 } ], @@ -798,24 +769,25 @@ "title": "Properties", "kind": 1024, "children": [ - 526, - 525, - 527 + 577, + 575, + 574, + 576 ] } ] } }, - "inheritedFrom": { + "overwrites": { "type": "reference", - "id": 484, + "id": 528, "name": "CustomAuthError.toJSON" } } ], - "inheritedFrom": { + "overwrites": { "type": "reference", - "id": 483, + "id": 527, "name": "CustomAuthError.toJSON" } } @@ -825,22 +797,23 @@ "title": "Constructors", "kind": 512, "children": [ - 516 + 560 ] }, { "title": "Properties", "kind": 1024, "children": [ - 520, - 521 + 567, + 581, + 582 ] }, { "title": "Methods", "kind": 2048, "children": [ - 522 + 571 ] } ], @@ -854,20 +827,20 @@ "extendedTypes": [ { "type": "reference", - "id": 475, + "id": 519, "name": "CustomAuthError" } ] }, { - "id": 490, - "name": "AuthSessionMissingError", + "id": 546, + "name": "AuthInvalidCredentialsError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 491, + "id": 547, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -875,37 +848,50 @@ "sources": [ { "fileName": "src/lib/errors.ts", - "line": 61, + "line": 67, "character": 2 } ], "signatures": [ { - "id": 492, - "name": "new AuthSessionMissingError", + "id": 548, + "name": "new AuthInvalidCredentialsError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, + "parameters": [ + { + "id": 549, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], "type": { "type": "reference", - "id": 490, - "name": "AuthSessionMissingError" + "id": 546, + "name": "AuthInvalidCredentialsError" }, "overwrites": { "type": "reference", - "id": 477, + "id": 521, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 476, + "id": 520, "name": "CustomAuthError.constructor" } }, { - "id": 493, + "id": 550, "name": "name", "kind": 1024, "kindString": "Property", @@ -923,12 +909,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 481, + "id": 525, "name": "CustomAuthError.name" } }, { - "id": 494, + "id": 551, "name": "status", "kind": 1024, "kindString": "Property", @@ -946,12 +932,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 482, + "id": 526, "name": "CustomAuthError.status" } }, { - "id": 495, + "id": 552, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -965,7 +951,7 @@ ], "signatures": [ { - "id": 496, + "id": 553, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -973,14 +959,14 @@ "type": { "type": "reflection", "declaration": { - "id": 497, + "id": 554, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 499, + "id": 556, "name": "message", "kind": 1024, "kindString": "Property", @@ -999,7 +985,7 @@ "defaultValue": "..." }, { - "id": 498, + "id": 555, "name": "name", "kind": 1024, "kindString": "Property", @@ -1018,7 +1004,7 @@ "defaultValue": "..." }, { - "id": 500, + "id": 557, "name": "status", "kind": 1024, "kindString": "Property", @@ -1042,9 +1028,9 @@ "title": "Properties", "kind": 1024, "children": [ - 499, - 498, - 500 + 556, + 555, + 557 ] } ] @@ -1052,14 +1038,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 484, + "id": 528, "name": "CustomAuthError.toJSON" } } ], "inheritedFrom": { "type": "reference", - "id": 483, + "id": 527, "name": "CustomAuthError.toJSON" } } @@ -1069,22 +1055,534 @@ "title": "Constructors", "kind": 512, "children": [ - 491 + 547 ] }, { "title": "Properties", "kind": 1024, "children": [ - 493, - 494 + 550, + 551 ] }, { "title": "Methods", "kind": 2048, "children": [ - 495 + 552 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 66, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 519, + "name": "CustomAuthError" + } + ] + }, + { + "id": 584, + "name": "AuthRetryableFetchError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 585, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 90, + "character": 2 + } + ], + "signatures": [ + { + "id": 586, + "name": "new AuthRetryableFetchError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "parameters": [ + { + "id": 587, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 588, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "reference", + "id": 584, + "name": "AuthRetryableFetchError" + }, + "overwrites": { + "type": "reference", + "id": 521, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 520, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 589, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 43, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 525, + "name": "CustomAuthError.name" + } + }, + { + "id": 590, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 44, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 526, + "name": "CustomAuthError.status" + } + }, + { + "id": 591, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 51, + "character": 2 + } + ], + "signatures": [ + { + "id": 592, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 593, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 595, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 54, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 594, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 53, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 596, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 55, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 595, + 594, + 596 + ] + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "id": 528, + "name": "CustomAuthError.toJSON" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 527, + "name": "CustomAuthError.toJSON" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 585 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 589, + 590 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 591 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 89, + "character": 13 + } + ], + "extendedTypes": [ + { + "type": "reference", + "id": 519, + "name": "CustomAuthError" + } + ] + }, + { + "id": 534, + "name": "AuthSessionMissingError", + "kind": 128, + "kindString": "Class", + "flags": {}, + "children": [ + { + "id": 535, + "name": "constructor", + "kind": 512, + "kindString": "Constructor", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 61, + "character": 2 + } + ], + "signatures": [ + { + "id": 536, + "name": "new AuthSessionMissingError", + "kind": 16384, + "kindString": "Constructor signature", + "flags": {}, + "type": { + "type": "reference", + "id": 534, + "name": "AuthSessionMissingError" + }, + "overwrites": { + "type": "reference", + "id": 521, + "name": "CustomAuthError.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "id": 520, + "name": "CustomAuthError.constructor" + } + }, + { + "id": 537, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 43, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "id": 525, + "name": "CustomAuthError.name" + } + }, + { + "id": 538, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 44, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "id": 526, + "name": "CustomAuthError.status" + } + }, + { + "id": 539, + "name": "toJSON", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 51, + "character": 2 + } + ], + "signatures": [ + { + "id": 540, + "name": "toJSON", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 541, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 543, + "name": "message", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 54, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 542, + "name": "name", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 53, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "..." + }, + { + "id": 544, + "name": "status", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/errors.ts", + "line": 55, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 543, + 542, + 544 + ] + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "id": 528, + "name": "CustomAuthError.toJSON" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 527, + "name": "CustomAuthError.toJSON" + } + } + ], + "groups": [ + { + "title": "Constructors", + "kind": 512, + "children": [ + 535 + ] + }, + { + "title": "Properties", + "kind": 1024, + "children": [ + 537, + 538 + ] + }, + { + "title": "Methods", + "kind": 2048, + "children": [ + 539 ] } ], @@ -1098,20 +1596,20 @@ "extendedTypes": [ { "type": "reference", - "id": 475, + "id": 519, "name": "CustomAuthError" } ] }, { - "id": 468, + "id": 512, "name": "AuthUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 469, + "id": 513, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1125,14 +1623,14 @@ ], "signatures": [ { - "id": 470, + "id": 514, "name": "new AuthUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 471, + "id": 515, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1143,7 +1641,7 @@ } }, { - "id": 472, + "id": 516, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -1156,24 +1654,24 @@ ], "type": { "type": "reference", - "id": 468, + "id": 512, "name": "AuthUnknownError" }, "overwrites": { "type": "reference", - "id": 452, + "id": 496, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 451, + "id": 495, "name": "AuthError.constructor" } }, { - "id": 473, + "id": 517, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -1196,14 +1694,14 @@ "title": "Constructors", "kind": 512, "children": [ - 469 + 513 ] }, { "title": "Properties", "kind": 1024, "children": [ - 473 + 517 ] } ], @@ -1217,20 +1715,20 @@ "extendedTypes": [ { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } ] }, { - "id": 475, + "id": 519, "name": "CustomAuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 476, + "id": 520, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1244,14 +1742,14 @@ ], "signatures": [ { - "id": 477, + "id": 521, "name": "new CustomAuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 478, + "id": 522, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1262,7 +1760,7 @@ } }, { - "id": 479, + "id": 523, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -1273,7 +1771,7 @@ } }, { - "id": 480, + "id": 524, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -1286,24 +1784,24 @@ ], "type": { "type": "reference", - "id": 475, + "id": 519, "name": "CustomAuthError" }, "overwrites": { "type": "reference", - "id": 452, + "id": 496, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 451, + "id": 495, "name": "AuthError.constructor" } }, { - "id": 481, + "id": 525, "name": "name", "kind": 1024, "kindString": "Property", @@ -1325,7 +1823,7 @@ } }, { - "id": 482, + "id": 526, "name": "status", "kind": 1024, "kindString": "Property", @@ -1343,7 +1841,7 @@ } }, { - "id": 483, + "id": 527, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -1357,7 +1855,7 @@ ], "signatures": [ { - "id": 484, + "id": 528, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -1365,14 +1863,14 @@ "type": { "type": "reflection", "declaration": { - "id": 485, + "id": 529, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 487, + "id": 531, "name": "message", "kind": 1024, "kindString": "Property", @@ -1391,7 +1889,7 @@ "defaultValue": "..." }, { - "id": 486, + "id": 530, "name": "name", "kind": 1024, "kindString": "Property", @@ -1410,7 +1908,7 @@ "defaultValue": "..." }, { - "id": 488, + "id": 532, "name": "status", "kind": 1024, "kindString": "Property", @@ -1434,9 +1932,9 @@ "title": "Properties", "kind": 1024, "children": [ - 487, - 486, - 488 + 531, + 530, + 532 ] } ] @@ -1451,22 +1949,22 @@ "title": "Constructors", "kind": 512, "children": [ - 476 + 520 ] }, { "title": "Properties", "kind": 1024, "children": [ - 481, - 482 + 525, + 526 ] }, { "title": "Methods", "kind": 2048, "children": [ - 483 + 527 ] } ], @@ -1480,24 +1978,29 @@ "extendedTypes": [ { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } ], "extendedBy": [ { "type": "reference", - "id": 490, + "id": 534, "name": "AuthSessionMissingError" }, { "type": "reference", - "id": 502, + "id": 546, "name": "AuthInvalidCredentialsError" }, { "type": "reference", - "id": 515, + "id": 559, + "name": "AuthImplicitGrantRedirectError" + }, + { + "type": "reference", + "id": 584, "name": "AuthRetryableFetchError" } ] @@ -1518,7 +2021,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 13, + "line": 19, "character": 2 } ], @@ -1556,7 +2059,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 22, + "line": 28, "character": 4 } ], @@ -1646,7 +2149,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 19, + "line": 25, "character": 4 } ], @@ -1693,7 +2196,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 18, + "line": 24, "character": 4 } ], @@ -1727,7 +2230,7 @@ ] }, { - "id": 56, + "id": 41, "name": "createUser", "kind": 2048, "kindString": "Method", @@ -1735,13 +2238,13 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 128, + "line": 126, "character": 8 } ], "signatures": [ { - "id": 57, + "id": 42, "name": "createUser", "kind": 4096, "kindString": "Call signature", @@ -1751,24 +2254,24 @@ }, "parameters": [ { - "id": 58, + "id": 43, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 355, + "id": 343, "name": "AdminUserAttributes", "dereferenced": { - "id": 355, + "id": 343, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 357, + "id": 345, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -1776,13 +2279,13 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object for app_metadata that.", - "text": "Only a service role can modify.\n\nCan be any JSON that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" + "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", + "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 187, + "line": 205, "character": 2 } ], @@ -1792,7 +2295,7 @@ } }, { - "id": 364, + "id": 351, "name": "data", "kind": 1024, "kindString": "Property", @@ -1800,12 +2303,13 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object for user_metadata that a user can modify. Can be any JSON." + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 162, + "line": 180, "character": 2 } ], @@ -1815,12 +2319,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 354, + "id": 342, "name": "UserAttributes.data" } }, { - "id": 360, + "id": 348, "name": "email", "kind": 1024, "kindString": "Property", @@ -1833,7 +2337,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 142, + "line": 162, "character": 2 } ], @@ -1843,40 +2347,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 350, + "id": 339, "name": "UserAttributes.email" } }, { - "id": 363, - "name": "email_change_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "An email change token." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 157, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 353, - "name": "UserAttributes.email_change_token" - } - }, - { - "id": 358, + "id": 346, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -1884,13 +2360,13 @@ "isOptional": true }, "comment": { - "shortText": "Sets if a user has confirmed their email address.", + "shortText": "Confirms the user's email address if set to true.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 194, + "line": 212, "character": 2 } ], @@ -1900,7 +2376,7 @@ } }, { - "id": 362, + "id": 350, "name": "password", "kind": 1024, "kindString": "Property", @@ -1913,7 +2389,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 152, + "line": 172, "character": 2 } ], @@ -1923,12 +2399,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 352, + "id": 341, "name": "UserAttributes.password" } }, { - "id": 361, + "id": 349, "name": "phone", "kind": 1024, "kindString": "Property", @@ -1941,7 +2417,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 147, + "line": 167, "character": 2 } ], @@ -1951,12 +2427,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 351, + "id": 340, "name": "UserAttributes.phone" } }, { - "id": 359, + "id": 347, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -1964,13 +2440,13 @@ "isOptional": true }, "comment": { - "shortText": "Sets if a user has confirmed their phone number.", + "shortText": "Confirms the user's phone number if set to true.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 201, + "line": 219, "character": 2 } ], @@ -1980,7 +2456,7 @@ } }, { - "id": 356, + "id": 344, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -1988,13 +2464,13 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object for user_metadata.", - "text": "Can be any JSON.\n\nOnly a service role can modify.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's user_metadata,\nthis attribute is used instead of UserAttributes data.\n\n" + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "Only a service role can modify.\n\nThe `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 177, + "line": 195, "character": 2 } ], @@ -2009,29 +2485,28 @@ "title": "Properties", "kind": 1024, "children": [ - 357, - 364, - 360, - 363, - 358, - 362, - 361, - 359, - 356 + 345, + 351, + 348, + 346, + 350, + 349, + 347, + 344 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 165, + "line": 183, "character": 17 } ], "extendedTypes": [ { "type": "reference", - "id": 349, + "id": 338, "name": "UserAttributes" } ] @@ -2044,7 +2519,7 @@ "typeArguments": [ { "type": "reference", - "id": 291, + "id": 280, "name": "UserResponse" } ], @@ -2056,7 +2531,7 @@ ] }, { - "id": 78, + "id": 63, "name": "deleteUser", "kind": 2048, "kindString": "Method", @@ -2064,13 +2539,13 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 218, + "line": 216, "character": 8 } ], "signatures": [ { - "id": 79, + "id": 64, "name": "deleteUser", "kind": 4096, "kindString": "Call signature", @@ -2080,13 +2555,13 @@ }, "parameters": [ { - "id": 80, - "name": "uid", + "id": 65, + "name": "id", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The user uid you want to remove.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" + "shortText": "The user id you want to remove.\n\nThis function should only be called on a server. Never expose your `service_role` key in the browser.\n" }, "type": { "type": "intrinsic", @@ -2099,7 +2574,7 @@ "typeArguments": [ { "type": "reference", - "id": 291, + "id": 280, "name": "UserResponse" } ], @@ -2119,7 +2594,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 85, + "line": 92, "character": 8 } ], @@ -2131,32 +2606,29 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Generates links to be sent via email or other." + "shortText": "Generates email links and OTPs to be sent via a custom email provider." }, "parameters": [ { "id": 40, - "name": "type", + "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 438, - "name": "GenerateLinkType", + "id": 458, + "name": "GenerateLinkParams", "dereferenced": { - "id": 438, - "name": "GenerateLinkType", + "id": 458, + "name": "GenerateLinkParams", "kind": 4194304, "kindString": "Type alias", "flags": {}, - "comment": { - "shortText": "The link type" - }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 327, + "line": 407, "character": 12 } ], @@ -2164,333 +2636,38 @@ "type": "union", "types": [ { - "type": "literal", - "value": "signup" + "type": "reference", + "id": 433, + "name": "GenerateSignupLinkParams" }, { - "type": "literal", - "value": "invite" + "type": "reference", + "id": 439, + "name": "GenerateInviteOrMagiclinkParams" }, { - "type": "literal", - "value": "magiclink" + "type": "reference", + "id": 444, + "name": "GenerateRecoveryLinkParams" }, { - "type": "literal", - "value": "recovery" - }, - { - "type": "literal", - "value": "email_change_current" - }, - { - "type": "literal", - "value": "email_change_new" + "type": "reference", + "id": 449, + "name": "GenerateEmailChangeLinkParams" } ] } } } - }, - { - "id": 41, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The user's email." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 42, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 43, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 45, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional user metadata. For signup only." - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 90, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 44, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "User password. For signup only." - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 89, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 46, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The redirect url which should be appended to the generated link\n" - }, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 91, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 45, - 44, - 46 - ] - } - ] - } - }, - "defaultValue": "{}" } ], "type": { "type": "reference", "typeArguments": [ { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 47, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 48, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 95, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 321, - "name": "User" - } - }, - { - "id": 49, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 96, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 48, - 49 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 50, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 51, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 99, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 302, - "name": "Session" - } - }, - { - "id": 52, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 100, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 51, - 52 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 53, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 54, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 102, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 55, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueAdminApi.ts", - "line": 102, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 450, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 54, - 55 - ] - } - ] - } - } - ] + "type": "reference", + "id": 459, + "name": "GenerateLinkResponse" } ], "qualifiedName": "Promise", @@ -2501,7 +2678,7 @@ ] }, { - "id": 71, + "id": 56, "name": "getUserById", "kind": 2048, "kindString": "Method", @@ -2509,13 +2686,13 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 173, + "line": 171, "character": 8 } ], "signatures": [ { - "id": 72, + "id": 57, "name": "getUserById", "kind": 4096, "kindString": "Call signature", @@ -2525,7 +2702,7 @@ }, "parameters": [ { - "id": 73, + "id": 58, "name": "uid", "kind": 32768, "kindString": "Parameter", @@ -2544,7 +2721,7 @@ "typeArguments": [ { "type": "reference", - "id": 291, + "id": 280, "name": "UserResponse" } ], @@ -2564,7 +2741,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 55, + "line": 62, "character": 8 } ], @@ -2622,7 +2799,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 59, + "line": 66, "character": 6 } ], @@ -2640,12 +2817,12 @@ "isOptional": true }, "comment": { - "shortText": "A URL or mobile address to send the user to after they are confirmed." + "shortText": "A URL or mobile deeplink to send the user to after they are confirmed." }, "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 58, + "line": 65, "character": 6 } ], @@ -2675,7 +2852,7 @@ "typeArguments": [ { "type": "reference", - "id": 291, + "id": 280, "name": "UserResponse" } ], @@ -2687,7 +2864,7 @@ ] }, { - "id": 59, + "id": 44, "name": "listUsers", "kind": 2048, "kindString": "Method", @@ -2695,13 +2872,13 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 149, + "line": 147, "character": 8 } ], "signatures": [ { - "id": 60, + "id": 45, "name": "listUsers", "kind": 4096, "kindString": "Call signature", @@ -2719,14 +2896,14 @@ { "type": "reflection", "declaration": { - "id": 61, + "id": 46, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 62, + "id": 47, "name": "data", "kind": 1024, "kindString": "Property", @@ -2734,21 +2911,21 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 150, + "line": 148, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 63, + "id": 48, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 64, + "id": 49, "name": "users", "kind": 1024, "kindString": "Property", @@ -2756,7 +2933,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 150, + "line": 148, "character": 14 } ], @@ -2764,7 +2941,7 @@ "type": "array", "elementType": { "type": "reference", - "id": 321, + "id": 310, "name": "User" } } @@ -2775,7 +2952,7 @@ "title": "Properties", "kind": 1024, "children": [ - 64 + 49 ] } ] @@ -2783,7 +2960,7 @@ } }, { - "id": 65, + "id": 50, "name": "error", "kind": 1024, "kindString": "Property", @@ -2791,7 +2968,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 150, + "line": 148, "character": 31 } ], @@ -2806,8 +2983,8 @@ "title": "Properties", "kind": 1024, "children": [ - 62, - 65 + 47, + 50 ] } ] @@ -2816,14 +2993,14 @@ { "type": "reflection", "declaration": { - "id": 66, + "id": 51, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 67, + "id": 52, "name": "data", "kind": 1024, "kindString": "Property", @@ -2831,21 +3008,21 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 150, + "line": 148, "character": 49 } ], "type": { "type": "reflection", "declaration": { - "id": 68, + "id": 53, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 69, + "id": 54, "name": "users", "kind": 1024, "kindString": "Property", @@ -2853,7 +3030,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 150, + "line": 148, "character": 57 } ], @@ -2867,7 +3044,7 @@ "title": "Properties", "kind": 1024, "children": [ - 69 + 54 ] } ] @@ -2875,7 +3052,7 @@ } }, { - "id": 70, + "id": 55, "name": "error", "kind": 1024, "kindString": "Property", @@ -2883,13 +3060,13 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 150, + "line": 148, "character": 70 } ], "type": { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } } @@ -2899,8 +3076,8 @@ "title": "Properties", "kind": 1024, "children": [ - 67, - 70 + 52, + 55 ] } ] @@ -2925,7 +3102,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 33, + "line": 39, "character": 8 } ], @@ -2976,7 +3153,7 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 33, + "line": 39, "character": 40 } ], @@ -2989,7 +3166,7 @@ }, { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } ] @@ -3016,7 +3193,7 @@ ] }, { - "id": 74, + "id": 59, "name": "updateUserById", "kind": 2048, "kindString": "Method", @@ -3024,13 +3201,13 @@ "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 195, + "line": 193, "character": 8 } ], "signatures": [ { - "id": 75, + "id": 60, "name": "updateUserById", "kind": 4096, "kindString": "Call signature", @@ -3040,7 +3217,7 @@ }, "parameters": [ { - "id": 76, + "id": 61, "name": "uid", "kind": 32768, "kindString": "Parameter", @@ -3051,7 +3228,7 @@ } }, { - "id": 77, + "id": 62, "name": "attributes", "kind": 32768, "kindString": "Parameter", @@ -3061,17 +3238,17 @@ }, "type": { "type": "reference", - "id": 355, + "id": 343, "name": "AdminUserAttributes", "dereferenced": { - "id": 355, + "id": 343, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 357, + "id": 345, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -3079,13 +3256,13 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object for app_metadata that.", - "text": "Only a service role can modify.\n\nCan be any JSON that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" + "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", + "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 187, + "line": 205, "character": 2 } ], @@ -3095,7 +3272,7 @@ } }, { - "id": 364, + "id": 351, "name": "data", "kind": 1024, "kindString": "Property", @@ -3103,12 +3280,13 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object for user_metadata that a user can modify. Can be any JSON." + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 162, + "line": 180, "character": 2 } ], @@ -3118,12 +3296,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 354, + "id": 342, "name": "UserAttributes.data" } }, { - "id": 360, + "id": 348, "name": "email", "kind": 1024, "kindString": "Property", @@ -3136,7 +3314,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 142, + "line": 162, "character": 2 } ], @@ -3146,40 +3324,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 350, + "id": 339, "name": "UserAttributes.email" } }, { - "id": 363, - "name": "email_change_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "An email change token." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 157, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 353, - "name": "UserAttributes.email_change_token" - } - }, - { - "id": 358, + "id": 346, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -3187,13 +3337,13 @@ "isOptional": true }, "comment": { - "shortText": "Sets if a user has confirmed their email address.", + "shortText": "Confirms the user's email address if set to true.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 194, + "line": 212, "character": 2 } ], @@ -3203,7 +3353,7 @@ } }, { - "id": 362, + "id": 350, "name": "password", "kind": 1024, "kindString": "Property", @@ -3216,7 +3366,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 152, + "line": 172, "character": 2 } ], @@ -3226,12 +3376,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 352, + "id": 341, "name": "UserAttributes.password" } }, { - "id": 361, + "id": 349, "name": "phone", "kind": 1024, "kindString": "Property", @@ -3244,7 +3394,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 147, + "line": 167, "character": 2 } ], @@ -3254,12 +3404,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 351, + "id": 340, "name": "UserAttributes.phone" } }, { - "id": 359, + "id": 347, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -3267,13 +3417,13 @@ "isOptional": true }, "comment": { - "shortText": "Sets if a user has confirmed their phone number.", + "shortText": "Confirms the user's phone number if set to true.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 201, + "line": 219, "character": 2 } ], @@ -3283,7 +3433,7 @@ } }, { - "id": 356, + "id": 344, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -3291,13 +3441,13 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object for user_metadata.", - "text": "Can be any JSON.\n\nOnly a service role can modify.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's user_metadata,\nthis attribute is used instead of UserAttributes data.\n\n" + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "Only a service role can modify.\n\nThe `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 177, + "line": 195, "character": 2 } ], @@ -3312,29 +3462,28 @@ "title": "Properties", "kind": 1024, "children": [ - 357, - 364, - 360, - 363, - 358, - 362, - 361, - 359, - 356 + 345, + 351, + 348, + 346, + 350, + 349, + 347, + 344 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 165, + "line": 183, "character": 17 } ], "extendedTypes": [ { "type": "reference", - "id": 349, + "id": 338, "name": "UserAttributes" } ] @@ -3347,7 +3496,7 @@ "typeArguments": [ { "type": "reference", - "id": 291, + "id": 280, "name": "UserResponse" } ], @@ -3371,34 +3520,34 @@ "title": "Methods", "kind": 2048, "children": [ - 56, - 78, + 41, + 63, 38, - 71, + 56, 31, - 59, + 44, 26, - 74 + 59 ] } ], "sources": [ { "fileName": "src/GoTrueAdminApi.ts", - "line": 6, + "line": 12, "character": 21 } ] }, { - "id": 81, + "id": 66, "name": "GoTrueClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 82, + "id": 67, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -3412,7 +3561,7 @@ ], "signatures": [ { - "id": 83, + "id": 68, "name": "new GoTrueClient", "kind": 16384, "kindString": "Constructor signature", @@ -3422,388 +3571,274 @@ }, "parameters": [ { - "id": 84, + "id": 69, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reflection", - "declaration": { - "id": 85, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "type": "reference", + "id": 241, + "name": "GoTrueClientOptions", + "dereferenced": { + "id": 241, + "name": "GoTrueClientOptions", + "kind": 4194304, + "kindString": "Type alias", "flags": {}, - "children": [ + "sources": [ { - "id": 93, - "name": "autoRefreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set to \"true\" if you want to automatically refresh the token before expiring." - }, - "sources": [ + "fileName": "src/lib/types.ts", + "line": 31, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 242, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ { - "fileName": "src/GoTrueClient.ts", - "line": 109, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 92, - "name": "detectSessionInUrl", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set to \"true\" if you want to automatically detects OAuth grants in the URL and signs in the user." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 108, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 97, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 113, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 98, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ + "id": 250, + "name": "autoRefreshToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ { - "id": 99, + "fileName": "src/lib/types.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 249, + "name": "detectSessionInUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 39, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 253, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 47, + "character": 2 + } + ], + "type": { + "type": "reference", + "name": "Fetch" + } + }, + { + "id": 244, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 35, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 245, "name": "__type", - "kind": 4096, - "kindString": "Call signature", + "kind": 65536, + "kindString": "Type literal", "flags": {}, - "comment": { - "shortText": "A custom fetch implementation.\n" - }, - "parameters": [ + "sources": [ { - "id": 100, - "name": "input", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" - }, - { - "type": "reference", - "qualifiedName": "URL", - "package": "typescript", - "name": "URL" - } - ] - } - }, - { - "id": 101, - "name": "init", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "qualifiedName": "RequestInit", - "package": "typescript", - "name": "RequestInit" - } + "fileName": "src/lib/types.ts", + "line": 35, + "character": 12 } ], - "type": { - "type": "reference", - "typeArguments": [ + "indexSignature": { + "id": 246, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ { - "type": "reference", - "qualifiedName": "Response", - "package": "typescript", - "name": "Response" + "id": 247, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } } ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - } - } - }, - { - "id": 87, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Any additional headers to send to the GoTrue server." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 106, - "character": 4 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 88, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 89, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 90, - "name": "key", - "kind": 32768, - "flags": {}, "type": { "type": "intrinsic", "name": "string" } } - ], - "type": { - "type": "intrinsic", - "name": "string" } } - } - } - }, - { - "id": 96, - "name": "multiTab", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set to \"false\" if you want to disable multi-tab/window events." - }, - "sources": [ + }, { - "fileName": "src/GoTrueClient.ts", - "line": 112, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 94, - "name": "persistSession", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Set to \"true\" if you want to automatically save the user session into local storage. If set to false, session will just be saved in memory." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 110, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 95, - "name": "storage", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 111, - "character": 4 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "qualifiedName": "Storage", - "package": "typescript", - "name": "Storage" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "getItem" - }, - { - "type": "literal", - "value": "removeItem" - }, - { - "type": "literal", - "value": "setItem" - } - ] - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" + "id": 251, + "name": "persistSession", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 43, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" } - ], - "name": "PromisifyMethods" - } - }, - { - "id": 91, - "name": "storageKey", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional key name used for storing tokens in local storage" - }, - "sources": [ + }, { - "fileName": "src/GoTrueClient.ts", - "line": 107, - "character": 4 + "id": 252, + "name": "storage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 45, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 480, + "name": "SupportedStorage" + } + }, + { + "id": 248, + "name": "storageKey", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 37, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 243, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 33, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } } ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 86, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The URL of the GoTrue server." - }, - "sources": [ + "groups": [ { - "fileName": "src/GoTrueClient.ts", - "line": 105, - "character": 4 + "title": "Properties", + "kind": 1024, + "children": [ + 250, + 249, + 253, + 244, + 251, + 252, + 248, + 243 + ] } ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 93, - 92, - 97, - 87, - 96, - 94, - 95, - 91, - 86 + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 31, + "character": 34 + } ] } - ] + } } } } ], "type": { "type": "reference", - "id": 81, + "id": 66, "name": "default" } } ] }, { - "id": 102, + "id": 70, "name": "admin", "kind": 1024, "kindString": "Property", @@ -3814,7 +3849,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 66, + "line": 68, "character": 2 } ], @@ -3825,7 +3860,7 @@ } }, { - "id": 141, + "id": 111, "name": "getSession", "kind": 2048, "kindString": "Method", @@ -3833,19 +3868,19 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 362, + "line": 407, "character": 8 } ], "signatures": [ { - "id": 142, + "id": 112, "name": "getSession", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the session data, refreshing it if necessary.\nIf no session is detected, the session returned will be null." + "shortText": "Returns the session, refreshing it if necessary.\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out." }, "type": { "type": "reference", @@ -3856,14 +3891,14 @@ { "type": "reflection", "declaration": { - "id": 143, + "id": 113, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 144, + "id": 114, "name": "data", "kind": 1024, "kindString": "Property", @@ -3871,21 +3906,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 364, + "line": 409, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 145, + "id": 115, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 146, + "id": 116, "name": "session", "kind": 1024, "kindString": "Property", @@ -3893,13 +3928,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 365, + "line": 410, "character": 10 } ], "type": { "type": "reference", - "id": 302, + "id": 291, "name": "Session" } } @@ -3909,7 +3944,7 @@ "title": "Properties", "kind": 1024, "children": [ - 146 + 116 ] } ] @@ -3917,7 +3952,7 @@ } }, { - "id": 147, + "id": 117, "name": "error", "kind": 1024, "kindString": "Property", @@ -3925,7 +3960,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 367, + "line": 412, "character": 8 } ], @@ -3940,8 +3975,8 @@ "title": "Properties", "kind": 1024, "children": [ - 144, - 147 + 114, + 117 ] } ] @@ -3950,14 +3985,14 @@ { "type": "reflection", "declaration": { - "id": 148, + "id": 118, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 149, + "id": 119, "name": "data", "kind": 1024, "kindString": "Property", @@ -3965,21 +4000,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 370, + "line": 415, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 150, + "id": 120, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 151, + "id": 121, "name": "session", "kind": 1024, "kindString": "Property", @@ -3987,7 +4022,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 371, + "line": 416, "character": 10 } ], @@ -4002,7 +4037,7 @@ "title": "Properties", "kind": 1024, "children": [ - 151 + 121 ] } ] @@ -4010,7 +4045,7 @@ } }, { - "id": 152, + "id": 122, "name": "error", "kind": 1024, "kindString": "Property", @@ -4018,13 +4053,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 373, + "line": 418, "character": 8 } ], "type": { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } } @@ -4034,8 +4069,8 @@ "title": "Properties", "kind": 1024, "children": [ - 149, - 152 + 119, + 122 ] } ] @@ -4044,14 +4079,14 @@ { "type": "reflection", "declaration": { - "id": 153, + "id": 123, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 154, + "id": 124, "name": "data", "kind": 1024, "kindString": "Property", @@ -4059,21 +4094,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 376, + "line": 421, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 155, + "id": 125, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 156, + "id": 126, "name": "session", "kind": 1024, "kindString": "Property", @@ -4081,7 +4116,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 377, + "line": 422, "character": 10 } ], @@ -4096,7 +4131,7 @@ "title": "Properties", "kind": 1024, "children": [ - 156 + 126 ] } ] @@ -4104,7 +4139,7 @@ } }, { - "id": 157, + "id": 127, "name": "error", "kind": 1024, "kindString": "Property", @@ -4112,7 +4147,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 379, + "line": 424, "character": 8 } ], @@ -4127,8 +4162,8 @@ "title": "Properties", "kind": 1024, "children": [ - 154, - 157 + 124, + 127 ] } ] @@ -4145,7 +4180,7 @@ ] }, { - "id": 158, + "id": 128, "name": "getUser", "kind": 2048, "kindString": "Method", @@ -4153,13 +4188,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 419, + "line": 470, "character": 8 } ], "signatures": [ { - "id": 159, + "id": 129, "name": "getUser", "kind": 4096, "kindString": "Call signature", @@ -4169,7 +4204,7 @@ }, "parameters": [ { - "id": 160, + "id": 130, "name": "jwt", "kind": 32768, "kindString": "Parameter", @@ -4190,7 +4225,7 @@ "typeArguments": [ { "type": "reference", - "id": 291, + "id": 280, "name": "UserResponse" } ], @@ -4202,7 +4237,46 @@ ] }, { - "id": 179, + "id": 92, + "name": "initialize", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 130, + "character": 2 + } + ], + "signatures": [ + { + "id": 93, + "name": "initialize", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Initializes the client session either from the url or from storage.\nThis method is automatically called when instantiating the client, but should also be called\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)." + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 481, + "name": "InitializeResult" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 157, "name": "onAuthStateChange", "kind": 2048, "kindString": "Method", @@ -4210,61 +4284,60 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 593, + "line": 665, "character": 2 } ], "signatures": [ { - "id": 180, + "id": 158, "name": "onAuthStateChange", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Receive a notification every time an auth event happens.", - "returns": "A subscription object which can be used to unsubscribe itself.\n" + "shortText": "Receive a notification every time an auth event happens." }, "parameters": [ { - "id": 181, + "id": 159, "name": "callback", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "A callback function to be invoked when an auth event happens." + "shortText": "A callback function to be invoked when an auth event happens.\n" }, "type": { "type": "reflection", "declaration": { - "id": 182, + "id": 160, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 183, + "id": 161, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 184, + "id": 162, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 264, + "id": 240, "name": "AuthChangeEvent" } }, { - "id": 185, + "id": 163, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -4278,7 +4351,7 @@ }, { "type": "reference", - "id": 302, + "id": 291, "name": "Session" } ] @@ -4296,133 +4369,85 @@ } ], "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 186, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", + "type": "reflection", + "declaration": { + "id": 164, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 165, + "name": "data", + "kind": 1024, + "kindString": "Property", "flags": {}, - "children": [ + "sources": [ { - "id": 188, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 596, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 187, - "name": "subscription", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 595, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 365, - "name": "Subscription" - } + "fileName": "src/GoTrueClient.ts", + "line": 666, + "character": 4 } ], - "groups": [ - { - "title": "Properties", - "kind": 1024, + "type": { + "type": "reflection", + "declaration": { + "id": 166, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, "children": [ - 188, - 187 + { + "id": 167, + "name": "subscription", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 666, + "character": 12 + } + ], + "type": { + "type": "reference", + "id": 352, + "name": "Subscription" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 167 + ] + } ] } - ] + } } - }, - { - "type": "reflection", - "declaration": { - "id": 189, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, "children": [ - { - "id": 191, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 598, - "character": 28 - } - ], - "type": { - "type": "reference", - "id": 450, - "name": "AuthError" - } - }, - { - "id": 190, - "name": "subscription", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 598, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 191, - 190 - ] - } + 165 ] } - } - ] + ] + } } } ] }, { - "id": 192, + "id": 168, "name": "resetPasswordForEmail", "kind": 2048, "kindString": "Method", @@ -4430,23 +4455,23 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 625, + "line": 688, "character": 8 } ], "signatures": [ { - "id": 193, + "id": 169, "name": "resetPasswordForEmail", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sends a reset request to an email address." + "shortText": "Sends a password reset request to an email address." }, "parameters": [ { - "id": 194, + "id": 170, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -4460,7 +4485,7 @@ } }, { - "id": 195, + "id": 171, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -4468,14 +4493,14 @@ "type": { "type": "reflection", "declaration": { - "id": 196, + "id": 172, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 198, + "id": 174, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -4488,7 +4513,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 629, + "line": 692, "character": 6 } ], @@ -4498,7 +4523,7 @@ } }, { - "id": 197, + "id": 173, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -4506,12 +4531,12 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed." + "shortText": "The URL to send the user to after they click the password reset link." }, "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 628, + "line": 691, "character": 6 } ], @@ -4526,8 +4551,8 @@ "title": "Properties", "kind": 1024, "children": [ - 198, - 197 + 174, + 173 ] } ] @@ -4545,14 +4570,14 @@ { "type": "reflection", "declaration": { - "id": 199, + "id": 175, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 200, + "id": 176, "name": "data", "kind": 1024, "kindString": "Property", @@ -4560,14 +4585,14 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 633, + "line": 696, "character": 8 } ], "type": { "type": "reflection", "declaration": { - "id": 201, + "id": 177, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -4576,7 +4601,7 @@ } }, { - "id": 202, + "id": 178, "name": "error", "kind": 1024, "kindString": "Property", @@ -4584,7 +4609,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 634, + "line": 697, "character": 8 } ], @@ -4599,8 +4624,8 @@ "title": "Properties", "kind": 1024, "children": [ - 200, - 202 + 176, + 178 ] } ] @@ -4609,14 +4634,14 @@ { "type": "reflection", "declaration": { - "id": 203, + "id": 179, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 204, + "id": 180, "name": "data", "kind": 1024, "kindString": "Property", @@ -4624,7 +4649,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 636, + "line": 699, "character": 8 } ], @@ -4634,7 +4659,7 @@ } }, { - "id": 205, + "id": 181, "name": "error", "kind": 1024, "kindString": "Property", @@ -4642,13 +4667,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 636, + "line": 699, "character": 20 } ], "type": { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } } @@ -4658,8 +4683,8 @@ "title": "Properties", "kind": 1024, "children": [ - 204, - 205 + 180, + 181 ] } ] @@ -4676,7 +4701,7 @@ ] }, { - "id": 164, + "id": 134, "name": "setSession", "kind": 2048, "kindString": "Method", @@ -4684,29 +4709,29 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 482, + "line": 534, "character": 8 } ], "signatures": [ { - "id": 165, + "id": 135, "name": "setSession", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the session data from refresh_token and returns current session or an error if the refresh_token is invalid." + "shortText": "Sets the session data from refresh token and returns current session or an error if the refresh token is invalid." }, "parameters": [ { - "id": 166, + "id": 136, "name": "refresh_token", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The refresh token returned by gotrue.\n" + "shortText": "A refresh token returned by supabase auth.\n" }, "type": { "type": "intrinsic", @@ -4719,7 +4744,7 @@ "typeArguments": [ { "type": "reference", - "id": 265, + "id": 254, "name": "AuthResponse" } ], @@ -4731,7 +4756,7 @@ ] }, { - "id": 128, + "id": 102, "name": "signInWithOAuth", "kind": 2048, "kindString": "Method", @@ -4739,13 +4764,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 258, + "line": 306, "character": 8 } ], "signatures": [ { - "id": 129, + "id": 103, "name": "signInWithOAuth", "kind": 4096, "kindString": "Call signature", @@ -4755,17 +4780,17 @@ }, "parameters": [ { - "id": 130, + "id": 104, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 416, + "id": 403, "name": "SignInWithOAuthCredentials", "dereferenced": { - "id": 416, + "id": 403, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -4773,21 +4798,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 292, + "line": 318, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 417, + "id": 404, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 419, + "id": 406, "name": "options", "kind": 1024, "kindString": "Property", @@ -4797,21 +4822,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 295, + "line": 321, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 420, + "id": 407, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 423, + "id": 410, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -4824,14 +4849,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 301, + "line": 327, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 424, + "id": 411, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -4839,19 +4864,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 301, + "line": 327, "character": 18 } ], "indexSignature": { - "id": 425, + "id": 412, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 426, + "id": 413, "name": "key", "kind": 32768, "flags": {}, @@ -4870,7 +4895,7 @@ } }, { - "id": 421, + "id": 408, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -4878,12 +4903,12 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed (OAuth logins only)." + "shortText": "A URL to send the user to after they are confirmed." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 297, + "line": 323, "character": 4 } ], @@ -4893,7 +4918,7 @@ } }, { - "id": 422, + "id": 409, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -4906,7 +4931,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 299, + "line": 325, "character": 4 } ], @@ -4921,16 +4946,16 @@ "title": "Properties", "kind": 1024, "children": [ - 423, - 421, - 422 + 410, + 408, + 409 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 295, + "line": 321, "character": 12 } ] @@ -4938,7 +4963,7 @@ } }, { - "id": 418, + "id": 405, "name": "provider", "kind": 1024, "kindString": "Property", @@ -4949,13 +4974,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 294, + "line": 320, "character": 2 } ], "type": { "type": "reference", - "id": 263, + "id": 239, "name": "Provider" } } @@ -4965,15 +4990,15 @@ "title": "Properties", "kind": 1024, "children": [ - 419, - 418 + 406, + 405 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 292, + "line": 318, "character": 41 } ] @@ -4988,7 +5013,7 @@ "typeArguments": [ { "type": "reference", - "id": 278, + "id": 267, "name": "OAuthResponse" } ], @@ -5000,7 +5025,7 @@ ] }, { - "id": 131, + "id": 105, "name": "signInWithOtp", "kind": 2048, "kindString": "Method", @@ -5008,401 +5033,23 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 270, + "line": 321, "character": 8 } ], "signatures": [ { - "id": 132, + "id": 106, "name": "signInWithOtp", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Passwordless method for logging in an existing user." + "shortText": "Log in a user using magiclink or a one-time password (OTP).\nIf the `{{ .ConfirmationURL }}` variable is specified in the email template, a magiclink will be sent.\nIf the `{{ .Token }}` variable is specified in the email template, an OTP will be sent.\nIf you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins." }, "parameters": [ { - "id": 133, - "name": "credentials", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 402, - "name": "SignInWithPasswordlessCredentials", - "dereferenced": { - "id": 402, - "name": "SignInWithPasswordlessCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 268, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 403, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 404, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 271, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 405, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 272, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 406, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 409, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 278, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 407, - "name": "emailRedirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The redirect url embedded in the email link" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 274, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 408, - "name": "shouldCreateUser", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 276, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 409, - 407, - 408 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 272, - "character": 16 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 404, - 405 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 269, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 410, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 412, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 284, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 413, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 415, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 288, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 414, - "name": "shouldCreateUser", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 286, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 415, - 414 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 284, - "character": 16 - } - ] - } - } - }, - { - "id": 411, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 283, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 412, - 411 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 281, - "character": 4 - } - ] - } - } - ] - } - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 265, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 125, - "name": "signInWithPassword", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 210, - "character": 8 - } - ], - "signatures": [ - { - "id": 126, - "name": "signInWithPassword", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Log in an existing user, or login via a third-party provider." - }, - "parameters": [ - { - "id": 127, + "id": 107, "name": "credentials", "kind": 32768, "kindString": "Parameter", @@ -5410,17 +5057,17 @@ "type": { "type": "reference", "id": 389, - "name": "SignInWithPasswordCredentials", + "name": "SignInWithPasswordlessCredentials", "dereferenced": { "id": 389, - "name": "SignInWithPasswordCredentials", + "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 246, + "line": 294, "character": 12 } ], @@ -5448,7 +5095,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 249, + "line": 297, "character": 6 } ], @@ -5458,7 +5105,7 @@ } }, { - "id": 393, + "id": 392, "name": "options", "kind": 1024, "kindString": "Property", @@ -5468,21 +5115,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 252, + "line": 298, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 394, + "id": 393, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 395, + "id": 396, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -5495,7 +5142,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 254, + "line": 304, "character": 8 } ], @@ -5503,6 +5150,52 @@ "type": "intrinsic", "name": "string" } + }, + { + "id": 394, + "name": "emailRedirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The redirect url embedded in the email link" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 300, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 395, + "name": "shouldCreateUser", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If set to false, this method will not create a new user. Defaults to true." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 302, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ @@ -5510,6 +5203,8 @@ "title": "Properties", "kind": 1024, "children": [ + 396, + 394, 395 ] } @@ -5517,33 +5212,12 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 252, + "line": 298, "character": 16 } ] } } - }, - { - "id": 392, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 251, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } } ], "groups": [ @@ -5552,7 +5226,6 @@ "kind": 1024, "children": [ 391, - 393, 392 ] } @@ -5560,7 +5233,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 247, + "line": 295, "character": 4 } ] @@ -5569,7 +5242,7 @@ { "type": "reflection", "declaration": { - "id": 396, + "id": 397, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -5586,7 +5259,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 262, + "line": 310, "character": 6 } ], @@ -5600,7 +5273,7 @@ "flags": {}, "children": [ { - "id": 401, + "id": 402, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -5613,7 +5286,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 264, + "line": 314, "character": 8 } ], @@ -5621,6 +5294,29 @@ "type": "intrinsic", "name": "string" } + }, + { + "id": 401, + "name": "shouldCreateUser", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If set to false, this method will not create a new user. Defaults to true." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 312, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ @@ -5628,6 +5324,7 @@ "title": "Properties", "kind": 1024, "children": [ + 402, 401 ] } @@ -5635,7 +5332,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 262, + "line": 310, "character": 16 } ] @@ -5644,27 +5341,6 @@ }, { "id": 398, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 261, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 397, "name": "phone", "kind": 1024, "kindString": "Property", @@ -5675,7 +5351,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 259, + "line": 309, "character": 6 } ], @@ -5691,15 +5367,14 @@ "kind": 1024, "children": [ 399, - 398, - 397 + 398 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 257, + "line": 307, "character": 4 } ] @@ -5716,7 +5391,7 @@ "typeArguments": [ { "type": "reference", - "id": 265, + "id": 254, "name": "AuthResponse" } ], @@ -5728,134 +5403,49 @@ ] }, { - "id": 175, - "name": "signOut", + "id": 99, + "name": "signInWithPassword", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 573, + "line": 256, "character": 8 } ], "signatures": [ { - "id": 176, - "name": "signOut", + "id": 100, + "name": "signInWithPassword", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Inside a browser context, `signOut()` will remove the logged in user from the browser session\nand log them out - removing all items from localstorage and then trigger a \"SIGNED_OUT\" event.", - "text": "For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to `auth.api.signOut(JWT: string)`.\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n" - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 177, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 178, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 573, - "character": 29 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 450, - "name": "AuthError" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 178 - ] - } - ] - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 122, - "name": "signUp", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 147, - "character": 8 - } - ], - "signatures": [ - { - "id": 123, - "name": "signUp", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new user.", - "returns": "A logged-in session if the server has \"autoconfirm\" ON" + "shortText": "Log in an existing user with an email and password or phone and password." }, "parameters": [ { - "id": 124, + "id": 101, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 373, - "name": "SignUpWithPasswordCredentials", + "id": 376, + "name": "SignInWithPasswordCredentials", "dereferenced": { - "id": 373, - "name": "SignUpWithPasswordCredentials", + "id": 376, + "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 219, + "line": 272, "character": 12 } ], @@ -5865,14 +5455,14 @@ { "type": "reflection", "declaration": { - "id": 374, + "id": 377, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 375, + "id": 378, "name": "email", "kind": 1024, "kindString": "Property", @@ -5883,7 +5473,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 222, + "line": 275, "character": 6 } ], @@ -5893,7 +5483,7 @@ } }, { - "id": 377, + "id": 380, "name": "options", "kind": 1024, "kindString": "Property", @@ -5903,21 +5493,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 225, + "line": 278, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 378, + "id": 381, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 381, + "id": 382, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -5930,53 +5520,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 231, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 380, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's metadata." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 229, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 379, - "name": "emailRedirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The redirect url embedded in the email link" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 227, + "line": 280, "character": 8 } ], @@ -5991,16 +5535,14 @@ "title": "Properties", "kind": 1024, "children": [ - 381, - 380, - 379 + 382 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 225, + "line": 278, "character": 16 } ] @@ -6008,7 +5550,7 @@ } }, { - "id": 376, + "id": 379, "name": "password", "kind": 1024, "kindString": "Property", @@ -6019,7 +5561,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 224, + "line": 277, "character": 6 } ], @@ -6034,16 +5576,16 @@ "title": "Properties", "kind": 1024, "children": [ - 375, - 377, - 376 + 378, + 380, + 379 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 220, + "line": 273, "character": 4 } ] @@ -6052,14 +5594,14 @@ { "type": "reflection", "declaration": { - "id": 382, + "id": 383, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 385, + "id": 386, "name": "options", "kind": 1024, "kindString": "Property", @@ -6069,14 +5611,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 239, + "line": 288, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 386, + "id": 387, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -6096,7 +5638,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 243, + "line": 290, "character": 8 } ], @@ -6104,29 +5646,6 @@ "type": "intrinsic", "name": "string" } - }, - { - "id": 387, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's metadata." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 241, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } } ], "groups": [ @@ -6134,15 +5653,14 @@ "title": "Properties", "kind": 1024, "children": [ - 388, - 387 + 388 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 239, + "line": 288, "character": 16 } ] @@ -6150,7 +5668,7 @@ } }, { - "id": 384, + "id": 385, "name": "password", "kind": 1024, "kindString": "Property", @@ -6161,7 +5679,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 238, + "line": 287, "character": 6 } ], @@ -6171,7 +5689,7 @@ } }, { - "id": 383, + "id": 384, "name": "phone", "kind": 1024, "kindString": "Property", @@ -6182,7 +5700,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 236, + "line": 285, "character": 6 } ], @@ -6197,16 +5715,16 @@ "title": "Properties", "kind": 1024, "children": [ + 386, 385, - 384, - 383 + 384 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 234, + "line": 283, "character": 4 } ] @@ -6223,7 +5741,7 @@ "typeArguments": [ { "type": "reference", - "id": 265, + "id": 254, "name": "AuthResponse" } ], @@ -6235,7 +5753,516 @@ ] }, { - "id": 161, + "id": 153, + "name": "signOut", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 646, + "character": 8 + } + ], + "signatures": [ + { + "id": 154, + "name": "signOut", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Inside a browser context, `signOut()` will remove the logged in user from the browser session\nand log them out - removing all items from localstorage and then trigger a `\"SIGNED_OUT\"` event.", + "text": "For server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to `auth.api.signOut(JWT: string)`.\nThere is no way to revoke a user's access token jwt until it expires. It is recommended to set a shorter expiry on the jwt for this reason.\n" + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 155, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 156, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 646, + "character": 29 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "id": 494, + "name": "AuthError" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 156 + ] + } + ] + } + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 96, + "name": "signUp", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 193, + "character": 8 + } + ], + "signatures": [ + { + "id": 97, + "name": "signUp", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Creates a new user.", + "returns": "A logged-in session if the server has \"autoconfirm\" ON" + }, + "parameters": [ + { + "id": 98, + "name": "credentials", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 360, + "name": "SignUpWithPasswordCredentials", + "dereferenced": { + "id": 360, + "name": "SignUpWithPasswordCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 237, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 361, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 362, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 240, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 364, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 243, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 365, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 368, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 253, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 367, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 251, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 366, + "name": "emailRedirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The redirect url embedded in the email link" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 245, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 368, + 367, + 366 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 243, + "character": 16 + } + ] + } + } + }, + { + "id": 363, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 242, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 362, + 364, + 363 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 238, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 369, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 372, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 261, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 373, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 375, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 269, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 374, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 267, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 375, + 374 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 261, + "character": 16 + } + ] + } + } + }, + { + "id": 371, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 260, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 370, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 258, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 372, + 371, + 370 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 256, + "character": 4 + } + ] + } + } + ] + } + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 254, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 131, "name": "updateUser", "kind": 2048, "kindString": "Method", @@ -6243,13 +6270,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 448, + "line": 499, "character": 8 } ], "signatures": [ { - "id": 162, + "id": 132, "name": "updateUser", "kind": 4096, "kindString": "Call signature", @@ -6259,24 +6286,24 @@ }, "parameters": [ { - "id": 163, + "id": 133, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 349, + "id": 338, "name": "UserAttributes", "dereferenced": { - "id": 349, + "id": 338, "name": "UserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 354, + "id": 342, "name": "data", "kind": 1024, "kindString": "Property", @@ -6284,12 +6311,13 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object for user_metadata that a user can modify. Can be any JSON." + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 162, + "line": 180, "character": 2 } ], @@ -6299,7 +6327,7 @@ } }, { - "id": 350, + "id": 339, "name": "email", "kind": 1024, "kindString": "Property", @@ -6312,7 +6340,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 142, + "line": 162, "character": 2 } ], @@ -6322,30 +6350,7 @@ } }, { - "id": 353, - "name": "email_change_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "An email change token." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 157, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 352, + "id": 341, "name": "password", "kind": 1024, "kindString": "Property", @@ -6358,7 +6363,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 152, + "line": 172, "character": 2 } ], @@ -6368,7 +6373,7 @@ } }, { - "id": 351, + "id": 340, "name": "phone", "kind": 1024, "kindString": "Property", @@ -6381,7 +6386,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 147, + "line": 167, "character": 2 } ], @@ -6396,25 +6401,24 @@ "title": "Properties", "kind": 1024, "children": [ - 354, - 350, - 353, - 352, - 351 + 342, + 339, + 341, + 340 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 138, + "line": 158, "character": 17 } ], "extendedBy": [ { "type": "reference", - "id": 355, + "id": 343, "name": "AdminUserAttributes" } ] @@ -6427,7 +6431,7 @@ "typeArguments": [ { "type": "reference", - "id": 291, + "id": 280, "name": "UserResponse" } ], @@ -6439,7 +6443,7 @@ ] }, { - "id": 134, + "id": 108, "name": "verifyOtp", "kind": 2048, "kindString": "Method", @@ -6447,13 +6451,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 313, + "line": 363, "character": 8 } ], "signatures": [ { - "id": 135, + "id": 109, "name": "verifyOtp", "kind": 4096, "kindString": "Call signature", @@ -6463,17 +6467,17 @@ }, "parameters": [ { - "id": 136, + "id": 110, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 427, + "id": 414, "name": "VerifyOtpParams", "dereferenced": { - "id": 427, + "id": 414, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -6481,7 +6485,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 305, + "line": 331, "character": 12 } ], @@ -6490,94 +6494,18 @@ "types": [ { "type": "reference", - "id": 428, + "id": 415, "name": "VerifyMobileOtpParams" }, { "type": "reference", - "id": 432, + "id": 423, "name": "VerifyEmailOtpParams" } ] } } } - }, - { - "id": 137, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 138, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 140, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 317, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 139, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A URL to send the user to after they are confirmed." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 316, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 140, - 139 - ] - } - ] - } - }, - "defaultValue": "{}" } ], "type": { @@ -6585,7 +6513,7 @@ "typeArguments": [ { "type": "reference", - "id": 265, + "id": 254, "name": "AuthResponse" } ], @@ -6602,52 +6530,53 @@ "title": "Constructors", "kind": 512, "children": [ - 82 + 67 ] }, { "title": "Properties", "kind": 1024, "children": [ - 102 + 70 ] }, { "title": "Methods", "kind": 2048, "children": [ - 141, - 158, - 179, - 192, - 164, + 111, 128, + 92, + 157, + 168, + 134, + 102, + 105, + 99, + 153, + 96, 131, - 125, - 175, - 122, - 161, - 134 + 108 ] } ], "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 61, + "line": 63, "character": 21 } ] }, { - "id": 355, + "id": 343, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 357, + "id": 345, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -6655,13 +6584,13 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object for app_metadata that.", - "text": "Only a service role can modify.\n\nCan be any JSON that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" + "shortText": "A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.", + "text": "Only a service role can modify.\n\nThe `app_metadata` should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information.\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 187, + "line": 205, "character": 2 } ], @@ -6671,7 +6600,7 @@ } }, { - "id": 364, + "id": 351, "name": "data", "kind": 1024, "kindString": "Property", @@ -6679,12 +6608,13 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object for user_metadata that a user can modify. Can be any JSON." + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 162, + "line": 180, "character": 2 } ], @@ -6694,12 +6624,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 354, + "id": 342, "name": "UserAttributes.data" } }, { - "id": 360, + "id": 348, "name": "email", "kind": 1024, "kindString": "Property", @@ -6712,7 +6642,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 142, + "line": 162, "character": 2 } ], @@ -6722,40 +6652,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 350, + "id": 339, "name": "UserAttributes.email" } }, { - "id": 363, - "name": "email_change_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "An email change token." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 157, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "id": 353, - "name": "UserAttributes.email_change_token" - } - }, - { - "id": 358, + "id": 346, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -6763,13 +6665,13 @@ "isOptional": true }, "comment": { - "shortText": "Sets if a user has confirmed their email address.", + "shortText": "Confirms the user's email address if set to true.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 194, + "line": 212, "character": 2 } ], @@ -6779,7 +6681,7 @@ } }, { - "id": 362, + "id": 350, "name": "password", "kind": 1024, "kindString": "Property", @@ -6792,7 +6694,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 152, + "line": 172, "character": 2 } ], @@ -6802,12 +6704,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 352, + "id": 341, "name": "UserAttributes.password" } }, { - "id": 361, + "id": 349, "name": "phone", "kind": 1024, "kindString": "Property", @@ -6820,7 +6722,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 147, + "line": 167, "character": 2 } ], @@ -6830,12 +6732,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 351, + "id": 340, "name": "UserAttributes.phone" } }, { - "id": 359, + "id": 347, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -6843,13 +6745,13 @@ "isOptional": true }, "comment": { - "shortText": "Sets if a user has confirmed their phone number.", + "shortText": "Confirms the user's phone number if set to true.", "text": "Only a service role can modify.\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 201, + "line": 219, "character": 2 } ], @@ -6859,7 +6761,7 @@ } }, { - "id": 356, + "id": 344, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -6867,13 +6769,13 @@ "isOptional": true }, "comment": { - "shortText": "A custom data object for user_metadata.", - "text": "Can be any JSON.\n\nOnly a service role can modify.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's user_metadata,\nthis attribute is used instead of UserAttributes data.\n\n" + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "Only a service role can modify.\n\nThe `user_metadata` should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data.\n\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 177, + "line": 195, "character": 2 } ], @@ -6888,42 +6790,114 @@ "title": "Properties", "kind": 1024, "children": [ - 357, - 364, - 360, - 363, - 358, - 362, - 361, - 359, - 356 + 345, + 351, + 348, + 346, + 350, + 349, + 347, + 344 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 165, + "line": 183, "character": 17 } ], "extendedTypes": [ { "type": "reference", - "id": 349, + "id": 338, "name": "UserAttributes" } ] }, { - "id": 302, + "id": 455, + "name": "GenerateLinkOptions", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 456, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 402, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 457, + "name": "redirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The URL which will be appended to the email link generated." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 404, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 456, + 457 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 396, + "character": 17 + } + ] + }, + { + "id": 291, "name": "Session", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 304, + "id": 293, "name": "access_token", "kind": 1024, "kindString": "Property", @@ -6934,7 +6908,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 81, + "line": 101, "character": 2 } ], @@ -6944,7 +6918,7 @@ } }, { - "id": 307, + "id": 296, "name": "expires_at", "kind": 1024, "kindString": "Property", @@ -6957,7 +6931,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 93, + "line": 113, "character": 2 } ], @@ -6967,7 +6941,7 @@ } }, { - "id": 306, + "id": 295, "name": "expires_in", "kind": 1024, "kindString": "Property", @@ -6978,7 +6952,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 89, + "line": 109, "character": 2 } ], @@ -6988,7 +6962,7 @@ } }, { - "id": 303, + "id": 292, "name": "provider_token", "kind": 1024, "kindString": "Property", @@ -6998,7 +6972,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 77, + "line": 97, "character": 2 } ], @@ -7017,7 +6991,7 @@ } }, { - "id": 305, + "id": 294, "name": "refresh_token", "kind": 1024, "kindString": "Property", @@ -7028,7 +7002,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 85, + "line": 105, "character": 2 } ], @@ -7038,7 +7012,7 @@ } }, { - "id": 308, + "id": 297, "name": "token_type", "kind": 1024, "kindString": "Property", @@ -7046,7 +7020,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 94, + "line": 114, "character": 2 } ], @@ -7056,7 +7030,7 @@ } }, { - "id": 309, + "id": 298, "name": "user", "kind": 1024, "kindString": "Property", @@ -7064,13 +7038,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 95, + "line": 115, "character": 2 } ], "type": { "type": "reference", - "id": 321, + "id": 310, "name": "User" } } @@ -7080,33 +7054,33 @@ "title": "Properties", "kind": 1024, "children": [ - 304, - 307, - 306, - 303, - 305, - 308, - 309 + 293, + 296, + 295, + 292, + 294, + 297, + 298 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 76, + "line": 96, "character": 17 } ] }, { - "id": 365, + "id": 352, "name": "Subscription", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 366, + "id": 353, "name": "id", "kind": 1024, "kindString": "Property", @@ -7117,7 +7091,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 208, + "line": 226, "character": 2 } ], @@ -7127,7 +7101,7 @@ } }, { - "id": 367, + "id": 354, "name": "callback", "kind": 2048, "kindString": "Method", @@ -7135,13 +7109,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 212, + "line": 230, "character": 2 } ], "signatures": [ { - "id": 368, + "id": 355, "name": "callback", "kind": 4096, "kindString": "Call signature", @@ -7151,17 +7125,17 @@ }, "parameters": [ { - "id": 369, + "id": 356, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 264, + "id": 240, "name": "AuthChangeEvent", "dereferenced": { - "id": 264, + "id": 240, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -7169,7 +7143,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 22, + "line": 23, "character": 12 } ], @@ -7206,7 +7180,7 @@ } }, { - "id": 370, + "id": 357, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -7220,7 +7194,7 @@ }, { "type": "reference", - "id": 302, + "id": 291, "name": "Session" } ] @@ -7235,7 +7209,7 @@ ] }, { - "id": 371, + "id": 358, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -7243,13 +7217,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 216, + "line": 234, "character": 2 } ], "signatures": [ { - "id": 372, + "id": 359, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -7270,35 +7244,35 @@ "title": "Properties", "kind": 1024, "children": [ - 366 + 353 ] }, { "title": "Methods", "kind": 2048, "children": [ - 367, - 371 + 354, + 358 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 204, + "line": 222, "character": 17 } ] }, { - "id": 321, + "id": 310, "name": "User", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 338, + "id": 327, "name": "action_link", "kind": 1024, "kindString": "Property", @@ -7308,7 +7282,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 125, + "line": 145, "character": 2 } ], @@ -7318,7 +7292,7 @@ } }, { - "id": 323, + "id": 312, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -7326,21 +7300,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 112, + "line": 132, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 324, + "id": 313, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 325, + "id": 314, "name": "provider", "kind": 1024, "kindString": "Property", @@ -7350,7 +7324,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 113, + "line": 133, "character": 4 } ], @@ -7365,673 +7339,10 @@ "title": "Properties", "kind": 1024, "children": [ - 325 + 314 ] } ], - "indexSignature": { - "id": 326, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 327, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 332, - "name": "aud", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 119, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 333, - "name": "confirmation_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 120, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 342, - "name": "confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 129, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 341, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 128, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 339, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 126, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 335, - "name": "email_change_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 122, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 343, - "name": "email_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 130, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 322, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 111, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 348, - "name": "identities", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 135, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 310, - "name": "UserIdentity" - } - } - }, - { - "id": 337, - "name": "invited_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 124, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 345, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 132, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 336, - "name": "new_email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 123, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 340, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 127, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 344, - "name": "phone_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 131, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 334, - "name": "recovery_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 121, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 346, - "name": "role", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 133, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 347, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 134, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 328, - "name": "user_metadata", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 116, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 329, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 330, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 331, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 338, - 323, - 332, - 333, - 342, - 341, - 339, - 335, - 343, - 322, - 348, - 337, - 345, - 336, - 340, - 344, - 334, - 346, - 347, - 328 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 110, - "character": 17 - } - ] - }, - { - "id": 349, - "name": "UserAttributes", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 354, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A custom data object for user_metadata that a user can modify. Can be any JSON." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 162, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 350, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's email." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 142, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 353, - "name": "email_change_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "An email change token." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 157, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 352, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 152, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 351, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's phone." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 147, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 354, - 350, - 353, - 352, - 351 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 138, - "character": 17 - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 355, - "name": "AdminUserAttributes" - } - ] - }, - { - "id": 310, - "name": "UserIdentity", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 318, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 105, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 311, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 99, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 313, - "name": "identity_data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 101, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 314, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, "indexSignature": { "id": 315, "name": "__index", @@ -8059,15 +7370,335 @@ } }, { - "id": 319, - "name": "last_sign_in_at", + "id": 321, + "name": "aud", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 106, + "line": 139, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 322, + "name": "confirmation_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 140, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 331, + "name": "confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 149, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 330, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 148, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 328, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 146, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 324, + "name": "email_change_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 142, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 332, + "name": "email_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 150, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 311, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 131, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 337, + "name": "identities", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 155, + "character": 2 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "id": 299, + "name": "UserIdentity" + } + } + }, + { + "id": 326, + "name": "invited_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 144, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 334, + "name": "last_sign_in_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 152, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 325, + "name": "new_email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 143, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 329, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 147, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 333, + "name": "phone_confirmed_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 151, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 323, + "name": "recovery_sent_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 141, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 335, + "name": "role", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 153, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 336, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 154, "character": 2 } ], @@ -8078,34 +7709,134 @@ }, { "id": 317, - "name": "provider", + "name": "user_metadata", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 104, + "line": 136, "character": 2 } ], "type": { - "type": "intrinsic", - "name": "string" + "type": "reflection", + "declaration": { + "id": 318, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 319, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 320, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } } - }, + } + ], + "groups": [ { - "id": 320, - "name": "updated_at", + "title": "Properties", + "kind": 1024, + "children": [ + 327, + 312, + 321, + 322, + 331, + 330, + 328, + 324, + 332, + 311, + 337, + 326, + 334, + 325, + 329, + 333, + 323, + 335, + 336, + 317 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 130, + "character": 17 + } + ] + }, + { + "id": 338, + "name": "UserAttributes", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 342, + "name": "data", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n\n" + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 107, + "line": 180, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 339, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's email." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 162, "character": 2 } ], @@ -8115,15 +7846,43 @@ } }, { - "id": 312, - "name": "user_id", + "id": 341, + "name": "password", "kind": 1024, "kindString": "Property", - "flags": {}, + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's password." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 100, + "line": 172, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 340, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's phone." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 167, "character": 2 } ], @@ -8138,33 +7897,225 @@ "title": "Properties", "kind": 1024, "children": [ - 318, - 311, - 313, - 319, - 317, - 320, - 312 + 342, + 339, + 341, + 340 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 98, + "line": 158, + "character": 17 + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 343, + "name": "AdminUserAttributes" + } + ] + }, + { + "id": 299, + "name": "UserIdentity", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 307, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 125, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 300, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 119, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 302, + "name": "identity_data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 121, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 303, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 304, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 305, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 308, + "name": "last_sign_in_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 126, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 306, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 124, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 309, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 127, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 301, + "name": "user_id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 120, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 307, + 300, + 302, + 308, + 306, + 309, + 301 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 118, "character": 17 } ] }, { - "id": 432, + "id": 423, "name": "VerifyEmailOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 433, + "id": 424, "name": "email", "kind": 1024, "kindString": "Property", @@ -8175,7 +8126,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 316, + "line": 348, "character": 2 } ], @@ -8185,7 +8136,91 @@ } }, { - "id": 434, + "id": 427, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 353, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 428, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 430, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 357, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 429, + "name": "redirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A URL to send the user to after they are confirmed." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 355, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 430, + 429 + ] + } + ] + } + } + }, + { + "id": 425, "name": "token", "kind": 1024, "kindString": "Property", @@ -8196,7 +8231,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 318, + "line": 350, "character": 2 } ], @@ -8206,7 +8241,7 @@ } }, { - "id": 435, + "id": 426, "name": "type", "kind": 1024, "kindString": "Property", @@ -8217,13 +8252,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 320, + "line": 352, "character": 2 } ], "type": { "type": "reference", - "id": 437, + "id": 432, "name": "EmailOtpType" } } @@ -8233,29 +8268,114 @@ "title": "Properties", "kind": 1024, "children": [ - 433, - 434, - 435 + 424, + 427, + 425, + 426 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 314, + "line": 346, "character": 17 } ] }, { - "id": 428, + "id": 415, "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 429, + "id": 419, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 339, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 420, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 422, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 343, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 421, + "name": "redirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "A URL to send the user to after they are confirmed." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 341, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 422, + 421 + ] + } + ] + } + } + }, + { + "id": 416, "name": "phone", "kind": 1024, "kindString": "Property", @@ -8266,7 +8386,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 308, + "line": 334, "character": 2 } ], @@ -8276,7 +8396,7 @@ } }, { - "id": 430, + "id": 417, "name": "token", "kind": 1024, "kindString": "Property", @@ -8287,7 +8407,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 310, + "line": 336, "character": 2 } ], @@ -8297,7 +8417,7 @@ } }, { - "id": 431, + "id": 418, "name": "type", "kind": 1024, "kindString": "Property", @@ -8308,13 +8428,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 312, + "line": 338, "character": 2 } ], "type": { "type": "reference", - "id": 436, + "id": 431, "name": "MobileOtpType" } } @@ -8324,22 +8444,23 @@ "title": "Properties", "kind": 1024, "children": [ - 429, - 430, - 431 + 419, + 416, + 417, + 418 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 306, + "line": 332, "character": 17 } ] }, { - "id": 264, + "id": 240, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -8347,7 +8468,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 22, + "line": 23, "character": 12 } ], @@ -8382,7 +8503,7 @@ } }, { - "id": 265, + "id": 254, "name": "AuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -8390,7 +8511,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 30, + "line": 50, "character": 12 } ], @@ -8400,14 +8521,14 @@ { "type": "reflection", "declaration": { - "id": 266, + "id": 255, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 267, + "id": 256, "name": "data", "kind": 1024, "kindString": "Property", @@ -8415,21 +8536,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 32, + "line": 52, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 268, + "id": 257, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 270, + "id": 259, "name": "session", "kind": 1024, "kindString": "Property", @@ -8437,7 +8558,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 34, + "line": 54, "character": 8 } ], @@ -8446,7 +8567,7 @@ "types": [ { "type": "reference", - "id": 302, + "id": 291, "name": "Session" }, { @@ -8457,7 +8578,7 @@ } }, { - "id": 269, + "id": 258, "name": "user", "kind": 1024, "kindString": "Property", @@ -8465,7 +8586,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 33, + "line": 53, "character": 8 } ], @@ -8474,7 +8595,7 @@ "types": [ { "type": "reference", - "id": 321, + "id": 310, "name": "User" }, { @@ -8490,15 +8611,15 @@ "title": "Properties", "kind": 1024, "children": [ - 270, - 269 + 259, + 258 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 32, + "line": 52, "character": 12 } ] @@ -8506,7 +8627,7 @@ } }, { - "id": 271, + "id": 260, "name": "error", "kind": 1024, "kindString": "Property", @@ -8514,7 +8635,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 36, + "line": 56, "character": 6 } ], @@ -8529,15 +8650,15 @@ "title": "Properties", "kind": 1024, "children": [ - 267, - 271 + 256, + 260 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 31, + "line": 51, "character": 4 } ] @@ -8546,14 +8667,14 @@ { "type": "reflection", "declaration": { - "id": 272, + "id": 261, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 273, + "id": 262, "name": "data", "kind": 1024, "kindString": "Property", @@ -8561,21 +8682,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 39, + "line": 59, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 274, + "id": 263, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 276, + "id": 265, "name": "session", "kind": 1024, "kindString": "Property", @@ -8583,7 +8704,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 41, + "line": 61, "character": 8 } ], @@ -8593,7 +8714,7 @@ } }, { - "id": 275, + "id": 264, "name": "user", "kind": 1024, "kindString": "Property", @@ -8601,7 +8722,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 40, + "line": 60, "character": 8 } ], @@ -8616,15 +8737,15 @@ "title": "Properties", "kind": 1024, "children": [ - 276, - 275 + 265, + 264 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 39, + "line": 59, "character": 12 } ] @@ -8632,7 +8753,7 @@ } }, { - "id": 277, + "id": 266, "name": "error", "kind": 1024, "kindString": "Property", @@ -8640,13 +8761,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 43, + "line": 63, "character": 6 } ], "type": { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } } @@ -8656,15 +8777,15 @@ "title": "Properties", "kind": 1024, "children": [ - 273, - 277 + 262, + 266 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 38, + "line": 58, "character": 4 } ] @@ -8674,7 +8795,7 @@ } }, { - "id": 440, + "id": 484, "name": "CallRefreshTokenResult", "kind": 4194304, "kindString": "Type alias", @@ -8682,7 +8803,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 346, + "line": 472, "character": 12 } ], @@ -8692,14 +8813,14 @@ { "type": "reflection", "declaration": { - "id": 441, + "id": 485, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 443, + "id": 487, "name": "error", "kind": 1024, "kindString": "Property", @@ -8707,7 +8828,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 349, + "line": 475, "character": 6 } ], @@ -8717,7 +8838,7 @@ } }, { - "id": 442, + "id": 486, "name": "session", "kind": 1024, "kindString": "Property", @@ -8725,13 +8846,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 348, + "line": 474, "character": 6 } ], "type": { "type": "reference", - "id": 302, + "id": 291, "name": "Session" } } @@ -8741,15 +8862,15 @@ "title": "Properties", "kind": 1024, "children": [ - 443, - 442 + 487, + 486 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 347, + "line": 473, "character": 4 } ] @@ -8758,14 +8879,14 @@ { "type": "reflection", "declaration": { - "id": 444, + "id": 488, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 446, + "id": 490, "name": "error", "kind": 1024, "kindString": "Property", @@ -8773,18 +8894,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 353, + "line": 479, "character": 6 } ], "type": { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } }, { - "id": 445, + "id": 489, "name": "session", "kind": 1024, "kindString": "Property", @@ -8792,7 +8913,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 352, + "line": 478, "character": 6 } ], @@ -8807,15 +8928,15 @@ "title": "Properties", "kind": 1024, "children": [ - 446, - 445 + 490, + 489 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 351, + "line": 477, "character": 4 } ] @@ -8825,7 +8946,7 @@ } }, { - "id": 437, + "id": 432, "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", @@ -8833,7 +8954,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 324, + "line": 362, "character": 12 } ], @@ -8864,18 +8985,764 @@ } }, { - "id": 438, - "name": "GenerateLinkType", + "id": 449, + "name": "GenerateEmailChangeLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 385, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 450, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 452, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 388, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 453, + "name": "newEmail", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 392, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 454, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 393, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 455, + "name": "GenerateLinkOptions" + }, + { + "type": "literal", + "value": "redirectTo" + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 451, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 386, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "email_change_current" + }, + { + "type": "literal", + "value": "email_change_new" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 452, + 453, + 454, + 451 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 385, + "character": 44 + } + ] + } + } + }, + { + "id": 439, + "name": "GenerateInviteOrMagiclinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 371, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 440, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 442, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 374, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 443, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 375, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 455, + "name": "GenerateLinkOptions" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "data" + }, + { + "type": "literal", + "value": "redirectTo" + } + ] + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 441, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 372, + "character": 2 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "invite" + }, + { + "type": "literal", + "value": "magiclink" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 442, + 443, + 441 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 371, + "character": 46 + } + ] + } + } + }, + { + "id": 458, + "name": "GenerateLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 407, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 433, + "name": "GenerateSignupLinkParams" + }, + { + "type": "reference", + "id": 439, + "name": "GenerateInviteOrMagiclinkParams" + }, + { + "type": "reference", + "id": 444, + "name": "GenerateRecoveryLinkParams" + }, + { + "type": "reference", + "id": 449, + "name": "GenerateEmailChangeLinkParams" + } + ] + } + }, + { + "id": 472, + "name": "GenerateLinkProperties", "kind": 4194304, "kindString": "Type alias", "flags": {}, "comment": { - "shortText": "The link type" + "shortText": "The properties related to the email link generated" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 327, + "line": 430, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 473, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 474, + "name": "action_link", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The email link to send to the user.\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 435, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 475, + "name": "email_otp", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The raw email OTP.\nYou should send this in the email if you want your users to verify using an OTP instead of the action link." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 440, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 476, + "name": "hashed_token", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The hashed token appended to the action link." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 444, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 477, + "name": "redirect_to", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The URL appended to the action link." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 446, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 478, + "name": "verification_type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The verification type that the email link is associated to." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 448, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 479, + "name": "GenerateLinkType" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 474, + 475, + 476, + 477, + 478 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 430, + "character": 37 + } + ] + } + } + }, + { + "id": 459, + "name": "GenerateLinkResponse", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 413, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 460, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 461, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 415, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 462, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 463, + "name": "properties", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 416, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 472, + "name": "GenerateLinkProperties" + } + }, + { + "id": 464, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 417, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 310, + "name": "User" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 463, + 464 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 415, + "character": 12 + } + ] + } + } + }, + { + "id": 465, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 419, + "character": 6 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 461, + 465 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 414, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 466, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 467, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 422, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 468, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 469, + "name": "properties", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 423, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 470, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 424, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 469, + 470 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 422, + "character": 12 + } + ] + } + } + }, + { + "id": 471, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 426, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 494, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 467, + 471 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 421, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 479, + "name": "GenerateLinkType", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 451, "character": 12 } ], @@ -8910,7 +9777,580 @@ } }, { - "id": 436, + "id": 444, + "name": "GenerateRecoveryLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 378, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 445, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 447, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 381, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 448, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 382, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 455, + "name": "GenerateLinkOptions" + }, + { + "type": "literal", + "value": "redirectTo" + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 446, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 379, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "recovery" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 447, + 448, + 446 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 378, + "character": 41 + } + ] + } + } + }, + { + "id": 433, + "name": "GenerateSignupLinkParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 364, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 434, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 436, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 366, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 438, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 368, + "character": 2 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 455, + "name": "GenerateLinkOptions" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "data" + }, + { + "type": "literal", + "value": "redirectTo" + } + ] + } + ], + "qualifiedName": "Pick", + "package": "typescript", + "name": "Pick" + } + }, + { + "id": 437, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 367, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 435, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 365, + "character": 2 + } + ], + "type": { + "type": "literal", + "value": "signup" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 436, + 438, + 437, + 435 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 364, + "character": 39 + } + ] + } + } + }, + { + "id": 241, + "name": "GoTrueClientOptions", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 31, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 242, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 250, + "name": "autoRefreshToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 41, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 249, + "name": "detectSessionInUrl", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 39, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 253, + "name": "fetch", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 47, + "character": 2 + } + ], + "type": { + "type": "reference", + "name": "Fetch" + } + }, + { + "id": 244, + "name": "headers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 35, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 245, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 35, + "character": 12 + } + ], + "indexSignature": { + "id": 246, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 247, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + } + } + }, + { + "id": 251, + "name": "persistSession", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 43, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 252, + "name": "storage", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 45, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 480, + "name": "SupportedStorage" + } + }, + { + "id": 248, + "name": "storageKey", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 37, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 243, + "name": "url", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 33, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 250, + 249, + 253, + 244, + 251, + 252, + 248, + 243 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 31, + "character": 34 + } + ] + } + } + }, + { + "id": 481, + "name": "InitializeResult", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 470, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 482, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 483, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 470, + "character": 33 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 494, + "name": "AuthError" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 483 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 470, + "character": 31 + } + ] + } + } + }, + { + "id": 431, "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", @@ -8918,7 +10358,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 323, + "line": 361, "character": 12 } ], @@ -8937,7 +10377,7 @@ } }, { - "id": 278, + "id": 267, "name": "OAuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -8945,7 +10385,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 46, + "line": 66, "character": 12 } ], @@ -8955,14 +10395,14 @@ { "type": "reflection", "declaration": { - "id": 279, + "id": 268, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 280, + "id": 269, "name": "data", "kind": 1024, "kindString": "Property", @@ -8970,21 +10410,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 48, + "line": 68, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 281, + "id": 270, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 282, + "id": 271, "name": "provider", "kind": 1024, "kindString": "Property", @@ -8992,18 +10432,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 49, + "line": 69, "character": 8 } ], "type": { "type": "reference", - "id": 263, + "id": 239, "name": "Provider" } }, { - "id": 283, + "id": 272, "name": "url", "kind": 1024, "kindString": "Property", @@ -9011,7 +10451,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 50, + "line": 70, "character": 8 } ], @@ -9026,15 +10466,15 @@ "title": "Properties", "kind": 1024, "children": [ - 282, - 283 + 271, + 272 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 48, + "line": 68, "character": 12 } ] @@ -9042,7 +10482,7 @@ } }, { - "id": 284, + "id": 273, "name": "error", "kind": 1024, "kindString": "Property", @@ -9050,7 +10490,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 52, + "line": 72, "character": 6 } ], @@ -9065,15 +10505,15 @@ "title": "Properties", "kind": 1024, "children": [ - 280, - 284 + 269, + 273 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 47, + "line": 67, "character": 4 } ] @@ -9082,14 +10522,14 @@ { "type": "reflection", "declaration": { - "id": 285, + "id": 274, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 286, + "id": 275, "name": "data", "kind": 1024, "kindString": "Property", @@ -9097,21 +10537,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 55, + "line": 75, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 287, + "id": 276, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 288, + "id": 277, "name": "provider", "kind": 1024, "kindString": "Property", @@ -9119,18 +10559,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 56, + "line": 76, "character": 8 } ], "type": { "type": "reference", - "id": 263, + "id": 239, "name": "Provider" } }, { - "id": 289, + "id": 278, "name": "url", "kind": 1024, "kindString": "Property", @@ -9138,7 +10578,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 57, + "line": 77, "character": 8 } ], @@ -9153,15 +10593,15 @@ "title": "Properties", "kind": 1024, "children": [ - 288, - 289 + 277, + 278 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 55, + "line": 75, "character": 12 } ] @@ -9169,7 +10609,7 @@ } }, { - "id": 290, + "id": 279, "name": "error", "kind": 1024, "kindString": "Property", @@ -9177,13 +10617,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 59, + "line": 79, "character": 6 } ], "type": { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } } @@ -9193,15 +10633,15 @@ "title": "Properties", "kind": 1024, "children": [ - 286, - 290 + 275, + 279 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 74, "character": 4 } ] @@ -9211,7 +10651,7 @@ } }, { - "id": 263, + "id": 239, "name": "Provider", "kind": 4194304, "kindString": "Type alias", @@ -9222,7 +10662,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 4, + "line": 5, "character": 12 } ], @@ -9297,7 +10737,7 @@ } }, { - "id": 416, + "id": 403, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -9305,21 +10745,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 292, + "line": 318, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 417, + "id": 404, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 419, + "id": 406, "name": "options", "kind": 1024, "kindString": "Property", @@ -9329,21 +10769,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 295, + "line": 321, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 420, + "id": 407, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 423, + "id": 410, "name": "queryParams", "kind": 1024, "kindString": "Property", @@ -9356,14 +10796,14 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 301, + "line": 327, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 424, + "id": 411, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -9371,19 +10811,19 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 301, + "line": 327, "character": 18 } ], "indexSignature": { - "id": 425, + "id": 412, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 426, + "id": 413, "name": "key", "kind": 32768, "flags": {}, @@ -9402,7 +10842,7 @@ } }, { - "id": 421, + "id": 408, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -9410,12 +10850,12 @@ "isOptional": true }, "comment": { - "shortText": "A URL to send the user to after they are confirmed (OAuth logins only)." + "shortText": "A URL to send the user to after they are confirmed." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 297, + "line": 323, "character": 4 } ], @@ -9425,7 +10865,7 @@ } }, { - "id": 422, + "id": 409, "name": "scopes", "kind": 1024, "kindString": "Property", @@ -9438,7 +10878,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 299, + "line": 325, "character": 4 } ], @@ -9453,16 +10893,16 @@ "title": "Properties", "kind": 1024, "children": [ - 423, - 421, - 422 + 410, + 408, + 409 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 295, + "line": 321, "character": 12 } ] @@ -9470,7 +10910,7 @@ } }, { - "id": 418, + "id": 405, "name": "provider", "kind": 1024, "kindString": "Property", @@ -9481,13 +10921,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 294, + "line": 320, "character": 2 } ], "type": { "type": "reference", - "id": 263, + "id": 239, "name": "Provider" } } @@ -9497,15 +10937,15 @@ "title": "Properties", "kind": 1024, "children": [ - 419, - 418 + 406, + 405 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 292, + "line": 318, "character": 41 } ] @@ -9513,7 +10953,7 @@ } }, { - "id": 389, + "id": 376, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -9521,7 +10961,304 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 246, + "line": 272, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 377, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 378, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 275, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 380, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 278, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 381, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 382, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 280, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 382 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 278, + "character": 16 + } + ] + } + } + }, + { + "id": 379, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 277, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 378, + 380, + 379 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 273, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 383, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 386, + "name": "options", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 288, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 387, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 388, + "name": "captchaToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Verification token received when the user completes the captcha on the site." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 290, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 388 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 288, + "character": 16 + } + ] + } + } + }, + { + "id": 385, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 287, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 384, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 285, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 386, + 385, + 384 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 283, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 389, + "name": "SignInWithPasswordlessCredentials", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 294, "character": 12 } ], @@ -9549,7 +11286,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 249, + "line": 297, "character": 6 } ], @@ -9559,7 +11296,7 @@ } }, { - "id": 393, + "id": 392, "name": "options", "kind": 1024, "kindString": "Property", @@ -9569,21 +11306,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 252, + "line": 298, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 394, + "id": 393, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 395, + "id": 396, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -9596,7 +11333,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 254, + "line": 304, "character": 8 } ], @@ -9604,6 +11341,52 @@ "type": "intrinsic", "name": "string" } + }, + { + "id": 394, + "name": "emailRedirectTo", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The redirect url embedded in the email link" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 300, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 395, + "name": "shouldCreateUser", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If set to false, this method will not create a new user. Defaults to true." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 302, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ @@ -9611,6 +11394,8 @@ "title": "Properties", "kind": 1024, "children": [ + 396, + 394, 395 ] } @@ -9618,33 +11403,12 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 252, + "line": 298, "character": 16 } ] } } - }, - { - "id": 392, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 251, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } } ], "groups": [ @@ -9653,7 +11417,6 @@ "kind": 1024, "children": [ 391, - 393, 392 ] } @@ -9661,7 +11424,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 247, + "line": 295, "character": 4 } ] @@ -9670,7 +11433,7 @@ { "type": "reflection", "declaration": { - "id": 396, + "id": 397, "name": "__type", "kind": 65536, "kindString": "Type literal", @@ -9687,7 +11450,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 262, + "line": 310, "character": 6 } ], @@ -9701,7 +11464,7 @@ "flags": {}, "children": [ { - "id": 401, + "id": 402, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -9714,7 +11477,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 264, + "line": 314, "character": 8 } ], @@ -9722,6 +11485,29 @@ "type": "intrinsic", "name": "string" } + }, + { + "id": 401, + "name": "shouldCreateUser", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If set to false, this method will not create a new user. Defaults to true." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 312, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ @@ -9729,6 +11515,7 @@ "title": "Properties", "kind": 1024, "children": [ + 402, 401 ] } @@ -9736,7 +11523,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 262, + "line": 310, "character": 16 } ] @@ -9745,27 +11532,6 @@ }, { "id": 398, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 261, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 397, "name": "phone", "kind": 1024, "kindString": "Property", @@ -9776,7 +11542,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 259, + "line": 309, "character": 6 } ], @@ -9792,15 +11558,14 @@ "kind": 1024, "children": [ 399, - 398, - 397 + 398 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 257, + "line": 307, "character": 4 } ] @@ -9810,332 +11575,7 @@ } }, { - "id": 402, - "name": "SignInWithPasswordlessCredentials", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 268, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 403, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 404, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's email address." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 271, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 405, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 272, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 406, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 409, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 278, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 407, - "name": "emailRedirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The redirect url embedded in the email link" - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 274, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 408, - "name": "shouldCreateUser", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 276, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 409, - 407, - 408 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 272, - "character": 16 - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 404, - 405 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 269, - "character": 4 - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 410, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 412, - "name": "options", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 284, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 413, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 415, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on the site." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 288, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 414, - "name": "shouldCreateUser", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "If set to false, this method will not create a new user. Defaults to true." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 286, - "character": 8 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 415, - 414 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 284, - "character": 16 - } - ] - } - } - }, - { - "id": 411, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "comment": { - "shortText": "The user's phone number." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 283, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 412, - 411 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 281, - "character": 4 - } - ] - } - } - ] - } - }, - { - "id": 373, + "id": 360, "name": "SignUpWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -10143,7 +11583,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 219, + "line": 237, "character": 12 } ], @@ -10153,14 +11593,14 @@ { "type": "reflection", "declaration": { - "id": 374, + "id": 361, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 375, + "id": 362, "name": "email", "kind": 1024, "kindString": "Property", @@ -10171,7 +11611,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 222, + "line": 240, "character": 6 } ], @@ -10181,7 +11621,7 @@ } }, { - "id": 377, + "id": 364, "name": "options", "kind": 1024, "kindString": "Property", @@ -10191,21 +11631,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 225, + "line": 243, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 378, + "id": 365, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 381, + "id": 368, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -10218,7 +11658,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 231, + "line": 253, "character": 8 } ], @@ -10228,7 +11668,7 @@ } }, { - "id": 380, + "id": 367, "name": "data", "kind": 1024, "kindString": "Property", @@ -10236,12 +11676,13 @@ "isOptional": true }, "comment": { - "shortText": "The user's metadata." + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 229, + "line": 251, "character": 8 } ], @@ -10251,7 +11692,7 @@ } }, { - "id": 379, + "id": 366, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -10264,7 +11705,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 227, + "line": 245, "character": 8 } ], @@ -10279,16 +11720,16 @@ "title": "Properties", "kind": 1024, "children": [ - 381, - 380, - 379 + 368, + 367, + 366 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 225, + "line": 243, "character": 16 } ] @@ -10296,7 +11737,7 @@ } }, { - "id": 376, + "id": 363, "name": "password", "kind": 1024, "kindString": "Property", @@ -10307,7 +11748,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 224, + "line": 242, "character": 6 } ], @@ -10322,16 +11763,16 @@ "title": "Properties", "kind": 1024, "children": [ - 375, - 377, - 376 + 362, + 364, + 363 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 220, + "line": 238, "character": 4 } ] @@ -10340,14 +11781,14 @@ { "type": "reflection", "declaration": { - "id": 382, + "id": 369, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 385, + "id": 372, "name": "options", "kind": 1024, "kindString": "Property", @@ -10357,21 +11798,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 239, + "line": 261, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 386, + "id": 373, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 388, + "id": 375, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -10384,7 +11825,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 243, + "line": 269, "character": 8 } ], @@ -10394,7 +11835,7 @@ } }, { - "id": 387, + "id": 374, "name": "data", "kind": 1024, "kindString": "Property", @@ -10402,12 +11843,13 @@ "isOptional": true }, "comment": { - "shortText": "The user's metadata." + "shortText": "A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.", + "text": "The `data` should be a JSON object that includes user-specific info, such as their first and last name.\n" }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 241, + "line": 267, "character": 8 } ], @@ -10422,15 +11864,15 @@ "title": "Properties", "kind": 1024, "children": [ - 388, - 387 + 375, + 374 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 239, + "line": 261, "character": 16 } ] @@ -10438,7 +11880,7 @@ } }, { - "id": 384, + "id": 371, "name": "password", "kind": 1024, "kindString": "Property", @@ -10449,7 +11891,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 238, + "line": 260, "character": 6 } ], @@ -10459,7 +11901,7 @@ } }, { - "id": 383, + "id": 370, "name": "phone", "kind": 1024, "kindString": "Property", @@ -10470,7 +11912,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 236, + "line": 258, "character": 6 } ], @@ -10485,16 +11927,16 @@ "title": "Properties", "kind": 1024, "children": [ - 385, - 384, - 383 + 372, + 371, + 370 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 234, + "line": 256, "character": 4 } ] @@ -10504,7 +11946,7 @@ } }, { - "id": 439, + "id": 480, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -10512,7 +11954,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 344, + "line": 468, "character": 12 } ], @@ -10555,7 +11997,7 @@ } }, { - "id": 291, + "id": 280, "name": "UserResponse", "kind": 4194304, "kindString": "Type alias", @@ -10563,7 +12005,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 62, + "line": 82, "character": 12 } ], @@ -10573,14 +12015,14 @@ { "type": "reflection", "declaration": { - "id": 292, + "id": 281, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 293, + "id": 282, "name": "data", "kind": 1024, "kindString": "Property", @@ -10588,21 +12030,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 64, + "line": 84, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 294, + "id": 283, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 295, + "id": 284, "name": "user", "kind": 1024, "kindString": "Property", @@ -10610,13 +12052,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 65, + "line": 85, "character": 8 } ], "type": { "type": "reference", - "id": 321, + "id": 310, "name": "User" } } @@ -10626,14 +12068,14 @@ "title": "Properties", "kind": 1024, "children": [ - 295 + 284 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 64, + "line": 84, "character": 12 } ] @@ -10641,7 +12083,7 @@ } }, { - "id": 296, + "id": 285, "name": "error", "kind": 1024, "kindString": "Property", @@ -10649,7 +12091,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 67, + "line": 87, "character": 6 } ], @@ -10664,15 +12106,15 @@ "title": "Properties", "kind": 1024, "children": [ - 293, - 296 + 282, + 285 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 63, + "line": 83, "character": 4 } ] @@ -10681,14 +12123,14 @@ { "type": "reflection", "declaration": { - "id": 297, + "id": 286, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 298, + "id": 287, "name": "data", "kind": 1024, "kindString": "Property", @@ -10696,21 +12138,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 70, + "line": 90, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 299, + "id": 288, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 300, + "id": 289, "name": "user", "kind": 1024, "kindString": "Property", @@ -10718,7 +12160,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 71, + "line": 91, "character": 8 } ], @@ -10733,14 +12175,14 @@ "title": "Properties", "kind": 1024, "children": [ - 300 + 289 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 70, + "line": 90, "character": 12 } ] @@ -10748,7 +12190,7 @@ } }, { - "id": 301, + "id": 290, "name": "error", "kind": 1024, "kindString": "Property", @@ -10756,13 +12198,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 73, + "line": 93, "character": 6 } ], "type": { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } } @@ -10772,15 +12214,15 @@ "title": "Properties", "kind": 1024, "children": [ - 298, - 301 + 287, + 290 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 69, + "line": 89, "character": 4 } ] @@ -10790,7 +12232,7 @@ } }, { - "id": 427, + "id": 414, "name": "VerifyOtpParams", "kind": 4194304, "kindString": "Type alias", @@ -10798,7 +12240,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 305, + "line": 331, "character": 12 } ], @@ -10807,19 +12249,19 @@ "types": [ { "type": "reference", - "id": 428, + "id": 415, "name": "VerifyMobileOtpParams" }, { "type": "reference", - "id": 432, + "id": 423, "name": "VerifyEmailOtpParams" } ] } }, { - "id": 447, + "id": 491, "name": "isAuthError", "kind": 64, "kindString": "Function", @@ -10833,14 +12275,14 @@ ], "signatures": [ { - "id": 448, + "id": 492, "name": "isAuthError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 449, + "id": 493, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -10857,7 +12299,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 450, + "id": 494, "name": "AuthError" } } @@ -10870,57 +12312,68 @@ "title": "Classes", "kind": 128, "children": [ - 455, - 450, - 502, - 515, - 490, - 468, - 475, + 499, + 494, + 559, + 546, + 584, + 534, + 512, + 519, 1, - 81 + 66 ] }, { "title": "Interfaces", "kind": 256, "children": [ - 355, - 302, - 365, - 321, - 349, + 343, + 455, + 291, + 352, 310, - 432, - 428 + 338, + 299, + 423, + 415 ] }, { "title": "Type Aliases", "kind": 4194304, "children": [ - 264, - 265, - 440, - 437, - 438, - 436, - 278, - 263, - 416, - 389, - 402, - 373, + 240, + 254, + 484, + 432, + 449, 439, - 291, - 427 + 458, + 472, + 459, + 479, + 444, + 433, + 241, + 481, + 431, + 267, + 239, + 403, + 376, + 389, + 360, + 480, + 280, + 414 ] }, { "title": "Functions", "kind": 64, "children": [ - 447 + 491 ] } ], diff --git a/spec/supabase_js_v2_legacy.yml b/spec/supabase_js_v2_legacy.yml index 27afe50bd59..0925a05d134 100644 --- a/spec/supabase_js_v2_legacy.yml +++ b/spec/supabase_js_v2_legacy.yml @@ -85,14 +85,15 @@ pages: title: 'signUp()' $ref: '@supabase/gotrue-js.GoTrueClient.signUp' notes: | - - By default, the user will need to verify their email address before logging in. If you would like to change this, you can disable "Email Confirmations" by going to Authentication -> Settings on [app.supabase.com](https://app.supabase.com) - - If "Email Confirmations" is turned on, a `user` is returned but `session` will be null - - If "Email Confirmations" is turned off, both a `user` and a `session` will be returned - - When the user confirms their email address, they will be redirected to localhost:3000 by default. To change this, you can go to Authentication -> Settings on [app.supabase.com](https://app.supabase.com) + - By default, the user needs to verify their email address before logging in. To turn this off, disable **Confirm email** in [your project](https://app.supabase.com/project/_/auth/settings). + - **Confirm email** determines if users need to confirm their email address after signing up. + - If **Confirm email** is enabled, a `user` is returned but `session` is null. + - If **Confirm email** is disabled, both a `user` and a `session` are returned. + - When the user confirms their email address, they are redirected to the [`SITE_URL`](https://supabase.com/docs/reference/auth/config#site_url) by default. You can modify your `SITE_URL` or add additional redirect URLs in [your project](https://app.supabase.com/project/_/auth/settings). - If signUp() is called for an existing confirmed user: - - If "Enable email confirmations" is enabled on the "Authentication" -> "Settings" page, an obfuscated / fake user object will be returned. - - If "Enable email confirmations" is disabled, an error with a message "User already registered" will be returned. - - To check if a user already exists, refer to getUser(). + - If **Confirm email** is enabled in [your project](https://app.supabase.com/project/_/auth/settings), an obfuscated/fake user object is returned. + - If **Confirm email** is disabled, the error message, `User already registered` is returned. + - To fetch the currently logged-in user, refer to [`getUser()`](/docs/reference/javascript/next/auth-getuser). examples: - name: Sign up. isSpotlight: true @@ -103,7 +104,7 @@ pages: password: 'example-password', }) ``` - - name: Sign up with additional user meta data. + - name: Sign up with additional user metadata. isSpotlight: false js: | ```js @@ -126,10 +127,8 @@ pages: notes: | - Requires either an email and password or a phone number and password. examples: - - name: Sign in with Email. + - name: Sign in with email and password isSpotlight: true - description: | - Sign in with email and password. After a user has verified their email, they can use the [`signInWithPassword()`](/docs/reference/javascript/auth-signin#sign-in-using-phone) method. js: | ```js const { data, error } = await supabase.auth.signInWithPassword({ @@ -137,10 +136,8 @@ pages: password: 'example-password', }) ``` - - name: Sign in with Phone. + - name: Sign in with phone and password isSpotlight: false - description: | - Supabase supports Phone Auth. After a user has verified their number, they can use the [`signIn()`](/docs/reference/javascript/auth-signin#sign-in-using-phone) method. js: | ```js const { data, error } = await supabase.auth.signInWithPassword({ @@ -148,8 +145,8 @@ pages: password: 'some-password', }) - // After receiving an SMS with One Time Password. - let { data, error } = await supabase.auth.verifyOtp({ + // After receiving a SMS with a OTP. + const { data, error } = await supabase.auth.verifyOtp({ phone: '+13334445555', token: '123456', }) @@ -158,24 +155,24 @@ pages: title: 'signInWithOtp()' $ref: '@supabase/gotrue-js.GoTrueClient.signInWithOtp' notes: | - - This method is used for passwordless sign-ins where an otp is sent to the user's email or phone number. - Requires either an email or phone number. - - If you're using an email, you can configure whether you want the user to receive a magiclink or an otp. - - If you're using phone, you can configure whether you want the user to receive a magiclink or an otp. - - The magic link's destination URL is determined by the SITE_URL config variable. To change this, you can go to Authentication -> Settings on [app.supabase.com](https://app.supabase.com) + - This method is used for passwordless sign-ins where a OTP is sent to the user's email or phone number. + - If you're using an email, you can configure whether you want the user to receive a magiclink or a OTP. + - If you're using phone, you can configure whether you want the user to receive a OTP. + - The magic link's destination URL is determined by the [`SITE_URL`](https://supabase.com/docs/reference/auth/config#site_url). You can modify the `SITE_URL` or add additional redirect urls in [your project](https://app.supabase.com/project/_/auth/settings). examples: - name: Sign in with email. isSpotlight: true - description: The user will be sent an otp to their email. By default, a given user can only request an otp once every 60 seconds. + description: The user will be sent an email which contains either a magiclink or a OTP or both. By default, a given user can only request a OTP once every 60 seconds. js: | ```js const { data, error } = await supabase.auth.signInWithOtp({ email: 'example@email.com', }) ``` - - name: Sign in with sms otp. + - name: Sign in with SMS OTP. isSpotlight: false - description: The user will be sent an otp to their phone number. By default, a given user can only request an otp once every 60 seconds. + description: The user will be sent a SMS which contains a OTP. By default, a given user can only request a OTP once every 60 seconds. js: | ```js const { data, error } = await supabase.auth.signInWithPassword({ @@ -189,7 +186,7 @@ pages: - This method is used for signing in using a third-party provider. - Supabase supports many different [third-party providers](https://supabase.com/docs/guides/auth#providers). examples: - - name: Sign in using a third-party provider. + - name: Sign in using a third-party provider isSpotlight: true js: | ```js @@ -197,26 +194,25 @@ pages: provider: 'github' }) ``` - - name: Sign in using a third-party provider with redirect. + - name: Sign in using a third-party provider with redirect isSpotlight: false description: | - The `redirectTo` param will only applied on the callback made from the third-party provider. It does not redirect the user immediately after invoking this method. - In order for the `redirectTo` param to be allowed, one needs to include it in an allowlist. Supabase supports this for - any URL path on your website (the URL must either be on the same domain as your Site URL [see Auth>Settings in dashboard], or must match one of the Additional Redirect URLs [also in Auth>Settings]). + When the third-party provider successfully authenticates the user, the provider will redirect the user to the URL specified in the `redirectTo` parameter. This parameter defaults to the [`SITE_URL`](https://supabase.com/docs/reference/auth/config#site_url). It does not redirect the user immediately after invoking this method. + You can modify the `SITE_URL` or add additional redirect urls in [your project](https://app.supabase.com/project/_/auth/settings). js: | ```js - const { user, session, error } = await supabase.auth.signInWithOAuth({ + const { data, error } = await supabase.auth.signInWithOAuth({ provider: 'github' options: { redirectTo: 'https://example.com/welcome' } } ``` - - name: Sign in with scopes. + - name: Sign in with scopes isSpotlight: false description: | If you need additional data from an OAuth provider, you can include a space-separated list of scopes in your request to get back an OAuth provider token. - You may also need to specify the scopes in the provider's OAuth app settings, depending on the provider. + You may also need to specify the scopes in the provider's OAuth app settings, depending on the provider. The list of scopes will be documented by the third-party provider you are using and specifying scopes will enable you to use the OAuth provider token to call additional APIs supported by the third-party provider to get more information. js: | ```js const { data, error } = await supabase.auth.signInWithOAuth({ @@ -230,6 +226,8 @@ pages: auth.signOut(): title: 'signOut()' $ref: '@supabase/gotrue-js.GoTrueClient.signOut' + notes: | + - In order to use the `signOut()` method, the user needs to be signed in first. examples: - name: Sign out isSpotlight: true @@ -240,6 +238,9 @@ pages: auth.verifyOtp(): title: 'verifyOtp()' $ref: '@supabase/gotrue-js.GoTrueClient.verifyOtp' + notes: | + - The `verifyOtp` method takes in different verification types. If a phone number is used, the type can either be `sms` or `phone_change`. If an email address is used, the type can be one of the following: `signup`, `magiclink`, `recovery`, `invite` or `email_change`. + - The verification type used should be determined based on the corresponding auth method called before `verifyOtp` to sign up / sign-in a user. examples: - name: Verify Sms One-Time Password (OTP) isSpotlight: true @@ -267,8 +268,8 @@ pages: title: 'getUser()' $ref: '@supabase/gotrue-js.GoTrueClient.getUser' notes: | - - This method gets the user object using the current session. - - Fetches the user object from the database instead of local storage. + - This method gets the user object from the current session. + - Fetches the user object from the database instead of local session. examples: - name: Get the logged in user with the current existing session isSpotlight: true @@ -286,49 +287,52 @@ pages: title: 'updateUser()' $ref: '@supabase/gotrue-js.GoTrueClient.updateUser' notes: | - User email: Email updates will send an email to both the user's current and new email with a confirmation link by default. - To toggle this behavior off and only send a single confirmation link to the new email, toggle "Double confirm email changes" under "Authentication" -> "Settings" off. - - - User metadata: It's generally better to store user data in a table inside your public schema (i.e. `public.users`). - Use the `update()` method if you have data which rarely changes or is specific only to the logged in user. + - In order to use the `updateUser()` method, the user needs to be signed in first. + - Email updates will send an email to both the user's current and new email with a confirmation link by default. + To only send a single confirmation link to the user's new email, you can toggle the "Secure email change" setting in [your project](https://app.supabase.com/project/_/auth/settings). examples: - - name: Update email for authenticated user. + - name: Update the email of an authenticated user description: Sends a "Confirm Email Change" email to the new email address. isSpotlight: false js: | ```js const { data, error } = await supabase.auth.updateUser({email: 'new@email.com'}) ``` - - name: Update password for authenticated user. + - name: Update the password of an authenticated user isSpotlight: false js: | ```js const { data, error } = await supabase.auth.updateUser({password: 'new password'}) ``` - - name: Update a user's metadata. + - name: Update the user's metadata. isSpotlight: true js: | ```js - const { user, error } = await supabase.auth.updateUser({ + const { data, error } = await supabase.auth.updateUser({ data: { hello: 'world' } }) ``` auth.setSession(): title: 'setSession()' $ref: '@supabase/gotrue-js.GoTrueClient.setSession' + notes: | + - `setSession()` takes in a refresh token and uses it to get a new session. + - The refresh token can only be used once to obtain a new session. + - Refresh token rotation (see [`REFRESH_TOKEN_ROTATION_ENABLED`](https://supabase.com/docs/reference/auth/config#refresh_token_rotation_enabled)) is enabled by default on all projects to guard against replay attacks. + - You can configure the [`REFRESH_TOKEN_REUSE_INTERVAL`](https://supabase.com/docs/reference/auth/config#refresh_token_reuse_interval) which provides a short window in which the same refresh token can be used multiple times in the event of concurrency or offline issues. examples: - - name: Basic example. + - name: Refresh the session description: Sets the session data from refresh_token and returns current session or an error if the refresh_token is invalid. isSpotlight: true js: | ```js const { data, error } = supabase.auth.setSession(refresh_token) - } ``` auth.onAuthStateChange(): title: 'onAuthStateChange()' $ref: '@supabase/gotrue-js.GoTrueClient.onAuthStateChange' + notes: | + - Types of auth events: `SIGNED_IN`, `SIGNED_OUT`, `TOKEN_REFRESHED`, `USER_UPDATED`, `USER_DELETED`, `PASSWORD_RECOVERY` examples: - name: Listen to auth changes isSpotlight: true @@ -380,43 +384,43 @@ pages: if (event == 'PASSWORD_RECOVERY') console.log('PASSWORD_RECOVERY', session) }) ``` + Supabase Auth Admin Api: + title: 'Overview' + notes: | + - Any method under the `supabase.auth.admin` namespace requires a `service_role` key. + - These methods are considered admin methods and should be called on a trusted server. Never expose your `service_role` key in the browser. + auth.admin.getUserById(): title: 'getUserById()' $ref: '@supabase/gotrue-js.GoTrueAdminApi.getUserById' notes: | - - Fetches the user object from the database instead of local storage. - - Note that user() fetches the user object from local storage which might not be the most updated. - - Requires the user's access_token. + - Fetches the user object from the database based on the user's id. + - The `getUserById()` method requires the user's id which maps to the `auth.users.id` column. examples: - name: Fetch the user object using the access_token jwt. isSpotlight: true js: | ```js - const { user, error } = await supabase.auth.admin.getUserById(1) + const { data, error } = await supabase.auth.admin.getUserById(1) ``` auth.admin.listUsers(): title: 'listUsers()' $ref: '@supabase/gotrue-js.GoTrueAdminApi.listUsers' - notes: | - - Requires a `service_role` key. - - This function should be called on a server. Never expose your `service_role` key in the browser. examples: - name: Get a full list of users. isSpotlight: true js: | ```js - const { data: user, error } = await supabase.auth.admin.listUsers() + const { data: { users }, error } = await supabase.auth.admin.listUsers() ``` auth.admin.createUser(): title: 'createUser()' $ref: '@supabase/gotrue-js.GoTrueAdminApi.createUser' notes: | - - Requires a `service_role` key. - - This function should be called on a server. Never expose your `service_role` key in the browser. - - If you do not provide the `email_confirm` and `phone_confirm` options to this function, both will default to false. + - To confirm the user's email address or phone number, set `email_confirm` or `phone_confirm` to true. Both arguments default to false. examples: - - name: Create a new user. + - name: Create a new user with custom user metadata isSpotlight: true js: | ```js @@ -426,7 +430,7 @@ pages: user_metadata: { name: 'Yoda' } }) ``` - - name: Auto-confirm email. + - name: Auto-confirm the user's email js: | ```js const { data, error } = await supabase.auth.admin.createUser({ @@ -434,7 +438,7 @@ pages: email_confirm: true }) ``` - - name: Auto-confirm phone. + - name: Auto-confirm the user's phone number js: | ```js const { data, error } = await supabase.auth.admin.createUser({ @@ -446,10 +450,9 @@ pages: title: 'deleteUser()' $ref: '@supabase/gotrue-js.GoTrueAdminApi.deleteUser' notes: | - - Requires a `service_role` key. - - This function should be called on a server. Never expose your `service_role` key in the browser. + - The `deleteUser()` method requires the user's ID, which maps to the `auth.users.id` column. examples: - - name: Remove a user completely. + - name: Removes a user isSpotlight: true js: | ```js @@ -462,10 +465,9 @@ pages: title: 'inviteUserByEmail()' $ref: '@supabase/gotrue-js.GoTrueAdminApi.inviteUserByEmail' notes: | - - Requires a `service_role` key. - - This function should only be called on a server. Never expose your `service_role` key in the browser. + - Sends an invite link to the user's email address. examples: - - name: Basic example. + - name: Invite a user isSpotlight: true js: | ```js @@ -476,15 +478,15 @@ pages: title: 'resetPasswordForEmail()' $ref: '@supabase/gotrue-js.GoTrueClient.resetPasswordForEmail' notes: | - Sends a reset request to an email address. + Sends a password reset request to an email address. - When the user clicks the reset link in the email they will be forwarded to the site url or the redirect url specified: + When the user clicks the password reset link in the email, they are redirected to the [`SITE_URL`](https://supabase.com/docs/reference/auth/config#site_url) by default. You can modify your `SITE_URL` or add additional redirect URLs in [your project](https://app.supabase.com/project/_/auth/settings). `#access_token=x&refresh_token=y&expires_in=z&token_type=bearer&type=recovery` Your app must detect `type=recovery` in the fragment and display a password reset form to the user. - You should then use the access_token in the url and new password to update the user as follows: + You should then [update the user](/docs/reference/javascript/next/auth-updateuser) as follows: ```js const { error, data } = await supabase.auth.updateUser({ password : new_password }) @@ -502,9 +504,6 @@ pages: auth.admin.generateLink(): title: 'generateLink()' $ref: '@supabase/gotrue-js.GoTrueAdminApi.generateLink' - notes: | - - Requires a `service_role` key. - - This function should only be called on a server. Never expose your `service_role` key in the browser. examples: - name: Generate a signup link. isSpotlight: true @@ -531,9 +530,6 @@ pages: auth.admin.updateUserById(): title: 'updateUserById()' $ref: '@supabase/gotrue-js.GoTrueAdminApi.updateUserById' - notes: | - - Requires a `service_role` key. - - This function should only be called on a server. Never expose your `service_role` key in the browser. examples: - name: Updates a user's email. isSpotlight: false @@ -1088,7 +1084,7 @@ pages: notes: | - Removing a channel is a great way to maintain the performance of your project's Realtime service as well as your database if you're listening to Postgres changes. Supabase will automatically handle cleanup 30 seconds after a client is disconnected, but unused channels may cause degradation as more clients are simultaneously subscribed. examples: - - name: Remove a channel + - name: Removes a channel isSpotlight: true js: | ```js @@ -1101,7 +1097,7 @@ pages: notes: | - Removing channels is a great way to maintain the performance of your project's Realtime service as well as your database if you're listening to Postgres changes. Supabase will automatically handle cleanup 30 seconds after a client is disconnected, but unused channels may cause degradation as more clients are simultaneously subscribed. examples: - - name: Removes all channels + - name: Remove all channels isSpotlight: true js: | ```js