From 28bd73c021f4533b2e284da5bc5011eb0e59eac5 Mon Sep 17 00:00:00 2001 From: Inian Date: Tue, 16 Aug 2022 14:18:14 +0800 Subject: [PATCH] update auth docs --- .../generated/auth-getsession.mdx | 1 + .../_supabase_js/generated/auth-getuser.mdx | 28 +- .../generated/auth-onauthstatechange.mdx | 2 +- .../generated/auth-setsession.mdx | 4 +- .../generated/auth-signinwithoauth.mdx | 2 +- .../_supabase_js/generated/auth-signout.mdx | 3 +- .../_supabase_js/generated/auth-signup.mdx | 28 +- spec/enrichments/tsdoc_v2/combined.json | 14065 ++++------------ spec/enrichments/tsdoc_v2/gotrue.json | 11729 +++---------- .../tsdoc_v2/gotrue_dereferenced.json | 14065 ++++------------ 10 files changed, 9659 insertions(+), 30268 deletions(-) diff --git a/apps/reference/_supabase_js/generated/auth-getsession.mdx b/apps/reference/_supabase_js/generated/auth-getsession.mdx index 4e5654e02f9..5d8d38d679f 100644 --- a/apps/reference/_supabase_js/generated/auth-getsession.mdx +++ b/apps/reference/_supabase_js/generated/auth-getsession.mdx @@ -9,6 +9,7 @@ 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. ```js const session = supabase.auth.session() diff --git a/apps/reference/_supabase_js/generated/auth-getuser.mdx b/apps/reference/_supabase_js/generated/auth-getuser.mdx index 1d5ad12b971..4f3cc0eb488 100644 --- a/apps/reference/_supabase_js/generated/auth-getuser.mdx +++ b/apps/reference/_supabase_js/generated/auth-getuser.mdx @@ -8,12 +8,38 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Returns the user data, refreshing the session if necessary. +Gets the current user details if there is an existing session. ```js const user = supabase.auth.user() ``` +## Parameters + + + ## Notes This method gets the user object from memory. diff --git a/apps/reference/_supabase_js/generated/auth-onauthstatechange.mdx b/apps/reference/_supabase_js/generated/auth-onauthstatechange.mdx index fc7fee5a3c4..f5af3c038ce 100644 --- a/apps/reference/_supabase_js/generated/auth-onauthstatechange.mdx +++ b/apps/reference/_supabase_js/generated/auth-onauthstatechange.mdx @@ -34,7 +34,7 @@ supabase.auth.onAuthStateChange((event, session) => {
-No description provided. +A callback function to be invoked when an auth event happens.
diff --git a/apps/reference/_supabase_js/generated/auth-setsession.mdx b/apps/reference/_supabase_js/generated/auth-setsession.mdx index 20c7e7fda7a..8620b77dac4 100644 --- a/apps/reference/_supabase_js/generated/auth-setsession.mdx +++ b/apps/reference/_supabase_js/generated/auth-setsession.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' -Sets the session data from refresh_token and returns current Session and Error +Sets the session data from refresh_token and returns current session or an error if the refresh_token is invalid. ```js function apiFunction(req, res) { @@ -42,7 +42,7 @@ function apiFunction(req, res) {
-a JWT token +The refresh token returned by gotrue.
diff --git a/apps/reference/_supabase_js/generated/auth-signinwithoauth.mdx b/apps/reference/_supabase_js/generated/auth-signinwithoauth.mdx index 61e9a3e80e1..4b439d55e3c 100644 --- a/apps/reference/_supabase_js/generated/auth-signinwithoauth.mdx +++ b/apps/reference/_supabase_js/generated/auth-signinwithoauth.mdx @@ -56,7 +56,7 @@ No description provided.
-No description provided. +One of the providers supported by GoTrue.
diff --git a/apps/reference/_supabase_js/generated/auth-signout.mdx b/apps/reference/_supabase_js/generated/auth-signout.mdx index 9fd6a353104..f32bf014b8f 100644 --- a/apps/reference/_supabase_js/generated/auth-signout.mdx +++ b/apps/reference/_supabase_js/generated/auth-signout.mdx @@ -11,7 +11,8 @@ 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. -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 session JWT before it automatically expires +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. ```js const { error } = await supabase.auth.signOut() diff --git a/apps/reference/_supabase_js/generated/auth-signup.mdx b/apps/reference/_supabase_js/generated/auth-signup.mdx index 1b8f3c1843d..e548df2075e 100644 --- a/apps/reference/_supabase_js/generated/auth-signup.mdx +++ b/apps/reference/_supabase_js/generated/auth-signup.mdx @@ -56,27 +56,7 @@ No description provided.
-No description provided. - -
- - - -
  • -

    - - oidc - - - optional - - - OpenIDConnectCredentials - -

    -
    - -No description provided. +The user's email address.
    @@ -96,7 +76,7 @@ No description provided.
    -No description provided. +The user's password.
    @@ -116,7 +96,7 @@ No description provided.
    -No description provided. +The user's phone number.
    @@ -201,7 +181,7 @@ No description provided.
    -No description provided. +Verification token received when the user completes the captcha on the site.
    diff --git a/spec/enrichments/tsdoc_v2/combined.json b/spec/enrichments/tsdoc_v2/combined.json index 99fffd13c14..f56184be7d7 100644 --- a/spec/enrichments/tsdoc_v2/combined.json +++ b/spec/enrichments/tsdoc_v2/combined.json @@ -51599,14 +51599,14 @@ "originalName": "", "children": [ { - "id": 675, + "id": 447, "name": "AuthApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 676, + "id": 448, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -51620,14 +51620,14 @@ ], "signatures": [ { - "id": 677, + "id": 449, "name": "new AuthApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 678, + "id": 450, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -51638,7 +51638,7 @@ } }, { - "id": 679, + "id": 451, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -51651,50 +51651,24 @@ ], "type": { "type": "reference", - "id": 675, + "id": 447, "name": "AuthApiError" }, "overwrites": { "type": "reference", - "id": 672, + "id": 444, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 671, + "id": 443, "name": "AuthError.constructor" } }, { - "id": 687, - "name": "__isAuthError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "id": 674, - "name": "AuthError.__isAuthError" - } - }, - { - "id": 680, + "id": 452, "name": "status", "kind": 1024, "kindString": "Property", @@ -51712,7 +51686,7 @@ } }, { - "id": 681, + "id": 453, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -51726,7 +51700,7 @@ ], "signatures": [ { - "id": 682, + "id": 454, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -51734,14 +51708,14 @@ "type": { "type": "reflection", "declaration": { - "id": 683, + "id": 455, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 685, + "id": 457, "name": "message", "kind": 1024, "kindString": "Property", @@ -51760,7 +51734,7 @@ "defaultValue": "..." }, { - "id": 684, + "id": 456, "name": "name", "kind": 1024, "kindString": "Property", @@ -51779,7 +51753,7 @@ "defaultValue": "..." }, { - "id": 686, + "id": 458, "name": "status", "kind": 1024, "kindString": "Property", @@ -51803,9 +51777,9 @@ "title": "Properties", "kind": 1024, "children": [ - 685, - 684, - 686 + 457, + 456, + 458 ] } ] @@ -51820,22 +51794,21 @@ "title": "Constructors", "kind": 512, "children": [ - 676 + 448 ] }, { "title": "Properties", "kind": 1024, "children": [ - 687, - 680 + 452 ] }, { "title": "Methods", "kind": 2048, "children": [ - 681 + 453 ] } ], @@ -51849,20 +51822,20 @@ "extendedTypes": [ { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } ] }, { - "id": 670, + "id": 442, "name": "AuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 671, + "id": 443, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -51876,14 +51849,14 @@ ], "signatures": [ { - "id": 672, + "id": 444, "name": "new AuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 673, + "id": 445, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -51896,7 +51869,7 @@ ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" }, "overwrites": { @@ -51909,27 +51882,6 @@ "type": "reference", "name": "Error.constructor" } - }, - { - "id": 674, - "name": "__isAuthError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" } ], "groups": [ @@ -51937,14 +51889,7 @@ "title": "Constructors", "kind": 512, "children": [ - 671 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 674 + 443 ] } ], @@ -51966,30 +51911,30 @@ "extendedBy": [ { "type": "reference", - "id": 675, + "id": 447, "name": "AuthApiError" }, { "type": "reference", - "id": 688, + "id": 460, "name": "AuthUnknownError" }, { "type": "reference", - "id": 695, + "id": 467, "name": "CustomAuthError" } ] }, { - "id": 722, + "id": 494, "name": "AuthInvalidCredentialsError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 723, + "id": 495, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -52003,14 +51948,14 @@ ], "signatures": [ { - "id": 724, + "id": 496, "name": "new AuthInvalidCredentialsError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 725, + "id": 497, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -52023,50 +51968,24 @@ ], "type": { "type": "reference", - "id": 722, + "id": 494, "name": "AuthInvalidCredentialsError" }, "overwrites": { "type": "reference", - "id": 697, + "id": 469, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 696, + "id": 468, "name": "CustomAuthError.constructor" } }, { - "id": 734, - "name": "__isAuthError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "id": 709, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 726, + "id": 498, "name": "name", "kind": 1024, "kindString": "Property", @@ -52084,12 +52003,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 701, + "id": 473, "name": "CustomAuthError.name" } }, { - "id": 727, + "id": 499, "name": "status", "kind": 1024, "kindString": "Property", @@ -52107,12 +52026,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 702, + "id": 474, "name": "CustomAuthError.status" } }, { - "id": 728, + "id": 500, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -52126,7 +52045,7 @@ ], "signatures": [ { - "id": 729, + "id": 501, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -52134,14 +52053,14 @@ "type": { "type": "reflection", "declaration": { - "id": 730, + "id": 502, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 732, + "id": 504, "name": "message", "kind": 1024, "kindString": "Property", @@ -52160,7 +52079,7 @@ "defaultValue": "..." }, { - "id": 731, + "id": 503, "name": "name", "kind": 1024, "kindString": "Property", @@ -52179,7 +52098,7 @@ "defaultValue": "..." }, { - "id": 733, + "id": 505, "name": "status", "kind": 1024, "kindString": "Property", @@ -52203,9 +52122,9 @@ "title": "Properties", "kind": 1024, "children": [ - 732, - 731, - 733 + 504, + 503, + 505 ] } ] @@ -52213,14 +52132,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 704, + "id": 476, "name": "CustomAuthError.toJSON" } } ], "inheritedFrom": { "type": "reference", - "id": 703, + "id": 475, "name": "CustomAuthError.toJSON" } } @@ -52230,23 +52149,22 @@ "title": "Constructors", "kind": 512, "children": [ - 723 + 495 ] }, { "title": "Properties", "kind": 1024, "children": [ - 734, - 726, - 727 + 498, + 499 ] }, { "title": "Methods", "kind": 2048, "children": [ - 728 + 500 ] } ], @@ -52260,20 +52178,20 @@ "extendedTypes": [ { "type": "reference", - "id": 695, + "id": 467, "name": "CustomAuthError" } ] }, { - "id": 735, + "id": 507, "name": "AuthRetryableFetchError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 736, + "id": 508, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -52287,14 +52205,14 @@ ], "signatures": [ { - "id": 737, + "id": 509, "name": "new AuthRetryableFetchError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 738, + "id": 510, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -52305,7 +52223,7 @@ } }, { - "id": 739, + "id": 511, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -52318,50 +52236,24 @@ ], "type": { "type": "reference", - "id": 735, + "id": 507, "name": "AuthRetryableFetchError" }, "overwrites": { "type": "reference", - "id": 697, + "id": 469, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 696, + "id": 468, "name": "CustomAuthError.constructor" } }, { - "id": 748, - "name": "__isAuthError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "id": 709, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 740, + "id": 512, "name": "name", "kind": 1024, "kindString": "Property", @@ -52379,12 +52271,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 701, + "id": 473, "name": "CustomAuthError.name" } }, { - "id": 741, + "id": 513, "name": "status", "kind": 1024, "kindString": "Property", @@ -52402,12 +52294,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 702, + "id": 474, "name": "CustomAuthError.status" } }, { - "id": 742, + "id": 514, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -52421,7 +52313,7 @@ ], "signatures": [ { - "id": 743, + "id": 515, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -52429,14 +52321,14 @@ "type": { "type": "reflection", "declaration": { - "id": 744, + "id": 516, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 746, + "id": 518, "name": "message", "kind": 1024, "kindString": "Property", @@ -52455,7 +52347,7 @@ "defaultValue": "..." }, { - "id": 745, + "id": 517, "name": "name", "kind": 1024, "kindString": "Property", @@ -52474,7 +52366,7 @@ "defaultValue": "..." }, { - "id": 747, + "id": 519, "name": "status", "kind": 1024, "kindString": "Property", @@ -52498,9 +52390,9 @@ "title": "Properties", "kind": 1024, "children": [ - 746, - 745, - 747 + 518, + 517, + 519 ] } ] @@ -52508,14 +52400,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 704, + "id": 476, "name": "CustomAuthError.toJSON" } } ], "inheritedFrom": { "type": "reference", - "id": 703, + "id": 475, "name": "CustomAuthError.toJSON" } } @@ -52525,23 +52417,22 @@ "title": "Constructors", "kind": 512, "children": [ - 736 + 508 ] }, { "title": "Properties", "kind": 1024, "children": [ - 748, - 740, - 741 + 512, + 513 ] }, { "title": "Methods", "kind": 2048, "children": [ - 742 + 514 ] } ], @@ -52555,20 +52446,20 @@ "extendedTypes": [ { "type": "reference", - "id": 695, + "id": 467, "name": "CustomAuthError" } ] }, { - "id": 710, + "id": 482, "name": "AuthSessionMissingError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 711, + "id": 483, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -52582,57 +52473,31 @@ ], "signatures": [ { - "id": 712, + "id": 484, "name": "new AuthSessionMissingError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", - "id": 710, + "id": 482, "name": "AuthSessionMissingError" }, "overwrites": { "type": "reference", - "id": 697, + "id": 469, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 696, + "id": 468, "name": "CustomAuthError.constructor" } }, { - "id": 721, - "name": "__isAuthError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "id": 709, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 713, + "id": 485, "name": "name", "kind": 1024, "kindString": "Property", @@ -52650,12 +52515,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 701, + "id": 473, "name": "CustomAuthError.name" } }, { - "id": 714, + "id": 486, "name": "status", "kind": 1024, "kindString": "Property", @@ -52673,12 +52538,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 702, + "id": 474, "name": "CustomAuthError.status" } }, { - "id": 715, + "id": 487, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -52692,7 +52557,7 @@ ], "signatures": [ { - "id": 716, + "id": 488, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -52700,14 +52565,14 @@ "type": { "type": "reflection", "declaration": { - "id": 717, + "id": 489, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 719, + "id": 491, "name": "message", "kind": 1024, "kindString": "Property", @@ -52726,7 +52591,7 @@ "defaultValue": "..." }, { - "id": 718, + "id": 490, "name": "name", "kind": 1024, "kindString": "Property", @@ -52745,7 +52610,7 @@ "defaultValue": "..." }, { - "id": 720, + "id": 492, "name": "status", "kind": 1024, "kindString": "Property", @@ -52769,9 +52634,9 @@ "title": "Properties", "kind": 1024, "children": [ - 719, - 718, - 720 + 491, + 490, + 492 ] } ] @@ -52779,14 +52644,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 704, + "id": 476, "name": "CustomAuthError.toJSON" } } ], "inheritedFrom": { "type": "reference", - "id": 703, + "id": 475, "name": "CustomAuthError.toJSON" } } @@ -52796,23 +52661,22 @@ "title": "Constructors", "kind": 512, "children": [ - 711 + 483 ] }, { "title": "Properties", "kind": 1024, "children": [ - 721, - 713, - 714 + 485, + 486 ] }, { "title": "Methods", "kind": 2048, "children": [ - 715 + 487 ] } ], @@ -52826,20 +52690,20 @@ "extendedTypes": [ { "type": "reference", - "id": 695, + "id": 467, "name": "CustomAuthError" } ] }, { - "id": 688, + "id": 460, "name": "AuthUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 689, + "id": 461, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -52853,14 +52717,14 @@ ], "signatures": [ { - "id": 690, + "id": 462, "name": "new AuthUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 691, + "id": 463, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -52871,7 +52735,7 @@ } }, { - "id": 692, + "id": 464, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -52884,50 +52748,24 @@ ], "type": { "type": "reference", - "id": 688, + "id": 460, "name": "AuthUnknownError" }, "overwrites": { "type": "reference", - "id": 672, + "id": 444, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 671, + "id": 443, "name": "AuthError.constructor" } }, { - "id": 694, - "name": "__isAuthError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "id": 674, - "name": "AuthError.__isAuthError" - } - }, - { - "id": 693, + "id": 465, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -52950,15 +52788,14 @@ "title": "Constructors", "kind": 512, "children": [ - 689 + 461 ] }, { "title": "Properties", "kind": 1024, "children": [ - 694, - 693 + 465 ] } ], @@ -52972,20 +52809,20 @@ "extendedTypes": [ { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } ] }, { - "id": 695, + "id": 467, "name": "CustomAuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 696, + "id": 468, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -52999,14 +52836,14 @@ ], "signatures": [ { - "id": 697, + "id": 469, "name": "new CustomAuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 698, + "id": 470, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -53017,7 +52854,7 @@ } }, { - "id": 699, + "id": 471, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -53028,7 +52865,7 @@ } }, { - "id": 700, + "id": 472, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -53041,50 +52878,24 @@ ], "type": { "type": "reference", - "id": 695, + "id": 467, "name": "CustomAuthError" }, "overwrites": { "type": "reference", - "id": 672, + "id": 444, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 671, + "id": 443, "name": "AuthError.constructor" } }, { - "id": 709, - "name": "__isAuthError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "id": 674, - "name": "AuthError.__isAuthError" - } - }, - { - "id": 701, + "id": 473, "name": "name", "kind": 1024, "kindString": "Property", @@ -53106,7 +52917,7 @@ } }, { - "id": 702, + "id": 474, "name": "status", "kind": 1024, "kindString": "Property", @@ -53124,7 +52935,7 @@ } }, { - "id": 703, + "id": 475, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -53138,7 +52949,7 @@ ], "signatures": [ { - "id": 704, + "id": 476, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -53146,14 +52957,14 @@ "type": { "type": "reflection", "declaration": { - "id": 705, + "id": 477, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 707, + "id": 479, "name": "message", "kind": 1024, "kindString": "Property", @@ -53172,7 +52983,7 @@ "defaultValue": "..." }, { - "id": 706, + "id": 478, "name": "name", "kind": 1024, "kindString": "Property", @@ -53191,7 +53002,7 @@ "defaultValue": "..." }, { - "id": 708, + "id": 480, "name": "status", "kind": 1024, "kindString": "Property", @@ -53215,9 +53026,9 @@ "title": "Properties", "kind": 1024, "children": [ - 707, - 706, - 708 + 479, + 478, + 480 ] } ] @@ -53232,23 +53043,22 @@ "title": "Constructors", "kind": 512, "children": [ - 696 + 468 ] }, { "title": "Properties", "kind": 1024, "children": [ - 709, - 701, - 702 + 473, + 474 ] }, { "title": "Methods", "kind": 2048, "children": [ - 703 + 475 ] } ], @@ -53262,31 +53072,31 @@ "extendedTypes": [ { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } ], "extendedBy": [ { "type": "reference", - "id": 710, + "id": 482, "name": "AuthSessionMissingError" }, { "type": "reference", - "id": 722, + "id": 494, "name": "AuthInvalidCredentialsError" }, { "type": "reference", - "id": 735, + "id": 507, "name": "AuthRetryableFetchError" } ] }, { "id": 1, - "name": "GoTrueApi", + "name": "GoTrueAdminApi", "kind": 128, "kindString": "Class", "flags": {}, @@ -53299,15 +53109,15 @@ "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 21, + "fileName": "src/GoTrueAdminApi.ts", + "line": 13, "character": 2 } ], "signatures": [ { "id": 3, - "name": "new GoTrueApi", + "name": "new GoTrueAdminApi", "kind": 16384, "kindString": "Constructor signature", "flags": {}, @@ -53337,8 +53147,8 @@ }, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 30, + "fileName": "src/GoTrueAdminApi.ts", + "line": 22, "character": 4 } ], @@ -53427,8 +53237,8 @@ }, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 27, + "fileName": "src/GoTrueAdminApi.ts", + "line": 19, "character": 4 } ], @@ -53474,8 +53284,8 @@ "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 26, + "fileName": "src/GoTrueAdminApi.ts", + "line": 18, "character": 4 } ], @@ -53509,265 +53319,48 @@ ] }, { - "id": 21, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 19, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 22, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 23, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 24, - "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": 25, - "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": 17, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 18, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 19, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 20, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 16, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 26, - "name": "_createRequestHeaders", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 42, - "character": 10 - } - ], - "signatures": [ - { - "id": 27, - "name": "_createRequestHeaders", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Create a temporary object with all configured headers and\nadds the Authorization token to be used on request methods" - }, - "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": "reflection", - "declaration": { - "id": 29, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - } - ] - }, - { - "id": 230, + "id": 56, "name": "createUser", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 669, + "fileName": "src/GoTrueAdminApi.ts", + "line": 128, "character": 8 } ], "signatures": [ { - "id": 231, + "id": 57, "name": "createUser", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new user.", - "text": "This function should only be called on a server. Never expose your `service_role` key in the browser.\n" + "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": 232, + "id": 58, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The data you want to create the user with.\n" - }, "type": { "type": "reference", - "id": 582, + "id": 360, "name": "AdminUserAttributes", "dereferenced": { - "id": 582, + "id": 360, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 584, + "id": 362, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -53781,7 +53374,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 165, + "line": 187, "character": 2 } ], @@ -53791,7 +53384,7 @@ } }, { - "id": 591, + "id": 369, "name": "data", "kind": 1024, "kindString": "Property", @@ -53804,7 +53397,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 140, + "line": 162, "character": 2 } ], @@ -53814,12 +53407,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 581, + "id": 359, "name": "UserAttributes.data" } }, { - "id": 587, + "id": 365, "name": "email", "kind": 1024, "kindString": "Property", @@ -53832,7 +53425,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, + "line": 142, "character": 2 } ], @@ -53842,12 +53435,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 577, + "id": 355, "name": "UserAttributes.email" } }, { - "id": 590, + "id": 368, "name": "email_change_token", "kind": 1024, "kindString": "Property", @@ -53860,7 +53453,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 135, + "line": 157, "character": 2 } ], @@ -53870,12 +53463,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 580, + "id": 358, "name": "UserAttributes.email_change_token" } }, { - "id": 585, + "id": 363, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -53889,7 +53482,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 172, + "line": 194, "character": 2 } ], @@ -53899,7 +53492,7 @@ } }, { - "id": 589, + "id": 367, "name": "password", "kind": 1024, "kindString": "Property", @@ -53912,7 +53505,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 130, + "line": 152, "character": 2 } ], @@ -53922,12 +53515,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 579, + "id": 357, "name": "UserAttributes.password" } }, { - "id": 588, + "id": 366, "name": "phone", "kind": 1024, "kindString": "Property", @@ -53940,7 +53533,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 125, + "line": 147, "character": 2 } ], @@ -53950,12 +53543,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 578, + "id": 356, "name": "UserAttributes.phone" } }, { - "id": 586, + "id": 364, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -53969,7 +53562,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 179, + "line": 201, "character": 2 } ], @@ -53979,7 +53572,7 @@ } }, { - "id": 583, + "id": 361, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -53993,7 +53586,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 155, + "line": 177, "character": 2 } ], @@ -54008,29 +53601,29 @@ "title": "Properties", "kind": 1024, "children": [ - 584, - 591, - 587, - 590, - 585, - 589, - 588, - 586, - 583 + 362, + 369, + 365, + 368, + 363, + 367, + 366, + 364, + 361 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 143, + "line": 165, "character": 17 } ], "extendedTypes": [ { "type": "reference", - "id": 576, + "id": 354, "name": "UserAttributes" } ] @@ -54042,166 +53635,9 @@ "type": "reference", "typeArguments": [ { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 233, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 235, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 672, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - }, - { - "id": 236, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 672, - "character": 30 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 234, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 672, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 235, - 236, - 234 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 237, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 239, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 672, - "character": 60 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 240, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 672, - "character": 72 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 238, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 672, - "character": 48 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 239, - 240, - 238 - ] - } - ] - } - } - ] + "type": "reference", + "id": 296, + "name": "UserResponse" } ], "qualifiedName": "Promise", @@ -54212,38 +53648,37 @@ ] }, { - "id": 268, + "id": 78, "name": "deleteUser", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 771, + "fileName": "src/GoTrueAdminApi.ts", + "line": 218, "character": 8 } ], "signatures": [ { - "id": 269, + "id": 79, "name": "deleteUser", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Delete a user. Requires a `service_role` key.", - "text": "This function should only be called on a server. Never expose your `service_role` key in the browser.\n" + "shortText": "Delete a user. Requires a `service_role` key." }, "parameters": [ { - "id": 270, + "id": 80, "name": "uid", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The user uid you want to remove.\n" + "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", @@ -54255,127 +53690,9 @@ "type": "reference", "typeArguments": [ { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 271, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 273, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 774, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 272, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 773, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 273, - 272 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 274, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 276, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 776, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 275, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 776, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 276, - 275 - ] - } - ] - } - } - ] + "type": "reference", + "id": 296, + "name": "UserResponse" } ], "qualifiedName": "Promise", @@ -54386,21 +53703,21 @@ ] }, { - "id": 212, + "id": 38, "name": "generateLink", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 618, + "fileName": "src/GoTrueAdminApi.ts", + "line": 85, "character": 8 } ], "signatures": [ { - "id": 213, + "id": 39, "name": "generateLink", "kind": 4096, "kindString": "Call signature", @@ -54410,38 +53727,65 @@ }, "parameters": [ { - "id": 214, + "id": 40, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The link type (\"signup\" or \"magiclink\" or \"recovery\" or \"invite\")." - }, "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" + "type": "reference", + "id": 430, + "name": "GenerateLinkTypes", + "dereferenced": { + "id": 430, + "name": "GenerateLinkTypes", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "shortText": "The link type" }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 301, + "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": 215, + "id": 41, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -54455,7 +53799,7 @@ } }, { - "id": 216, + "id": 42, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -54463,14 +53807,14 @@ "type": { "type": "reflection", "declaration": { - "id": 217, + "id": 43, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 219, + "id": 45, "name": "data", "kind": 1024, "kindString": "Property", @@ -54482,8 +53826,8 @@ }, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 623, + "fileName": "src/GoTrueAdminApi.ts", + "line": 90, "character": 6 } ], @@ -54493,7 +53837,7 @@ } }, { - "id": 218, + "id": 44, "name": "password", "kind": 1024, "kindString": "Property", @@ -54505,8 +53849,8 @@ }, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 622, + "fileName": "src/GoTrueAdminApi.ts", + "line": 89, "character": 6 } ], @@ -54516,7 +53860,7 @@ } }, { - "id": 220, + "id": 46, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -54524,3192 +53868,15 @@ "isOptional": true }, "comment": { - "shortText": "The link type (\"signup\" or \"magiclink\" or \"recovery\" or \"invite\").\n" + "shortText": "The redirect url which should be appended to the generated link\n" }, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 624, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 219, - 218, - 220 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 221, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 222, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 628, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - }, - { - "id": 223, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 629, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 222, - 223 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 224, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 225, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 632, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - }, - { - "id": 226, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 633, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 225, - 226 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 227, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 228, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 635, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 229, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 635, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 228, - 229 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 30, - "name": "getUrlForProvider", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 54, - "character": 2 - } - ], - "signatures": [ - { - "id": 31, - "name": "getUrlForProvider", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Generates the relevant login URL for a third-party provider." - }, - "parameters": [ - { - "id": 32, - "name": "provider", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "One of the providers supported by GoTrue." - }, - "type": { - "type": "reference", - "id": 501, - "name": "Provider", - "dereferenced": { - "id": 501, - "name": "Provider", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 3, - "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": 33, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 34, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 37, - "name": "queryParams", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 59, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 38, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 39, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 40, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 35, - "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/GoTrueApi.ts", - "line": 57, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 36, - "name": "scopes", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A space-separated list of scopes granted to the OAuth application.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 58, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 37, - 35, - 36 - ] - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 277, - "name": "getUser", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 806, - "character": 8 - } - ], - "signatures": [ - { - "id": 278, - "name": "getUser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Gets the current user details.", - "text": "This method is called by the GoTrueClient `update` where\nthe jwt is set to this.currentSession.access_token\nand therefore, acts like getting the currently authenticated user\n" - }, - "parameters": [ - { - "id": 279, - "name": "jwt", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A valid, logged-in JWT. Typically, the access_token for the currentSession\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 280, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 282, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 809, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 281, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 808, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 282, - 281 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 283, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 285, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 811, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 284, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 811, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 285, - 284 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 249, - "name": "getUserById", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 715, - "character": 8 - } - ], - "signatures": [ - { - "id": 250, - "name": "getUserById", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Get user by id." - }, - "parameters": [ - { - "id": 251, - "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": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 252, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 254, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 717, - "character": 27 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 253, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 717, - "character": 15 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 254, - 253 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 255, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 257, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 717, - "character": 57 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 256, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 717, - "character": 45 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 257, - 256 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 176, - "name": "inviteUserByEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 505, - "character": 8 - } - ], - "signatures": [ - { - "id": 177, - "name": "inviteUserByEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends an invite link to an email address." - }, - "parameters": [ - { - "id": 178, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 179, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 180, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 182, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional user metadata\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 509, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 181, - "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/GoTrueApi.ts", - "line": 508, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 182, - 181 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 183, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 185, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 514, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 184, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 513, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 185, - 184 - ] - } - ] - } - }, - { - "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/GoTrueApi.ts", - "line": 516, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 187, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 516, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 188, - 187 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 241, - "name": "listUsers", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 693, - "character": 8 - } - ], - "signatures": [ - { - "id": 242, - "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": 243, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 245, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 693, - "character": 46 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 244, - "name": "users", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 693, - "character": 31 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 548, - "name": "User" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 245, - 244 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 246, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 248, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 693, - "character": 77 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 247, - "name": "users", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 693, - "character": 64 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 248, - 247 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 203, - "name": "refreshAccessToken", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 584, - "character": 8 - } - ], - "signatures": [ - { - "id": 204, - "name": "refreshAccessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Generates a new JWT." - }, - "parameters": [ - { - "id": 205, - "name": "refreshToken", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A valid refresh token that was returned on login.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 206, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 208, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 587, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 207, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 586, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 208, - 207 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 209, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 211, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 589, - "character": 23 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 210, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 589, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 211, - 210 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 189, - "name": "resetPasswordForEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 545, - "character": 8 - } - ], - "signatures": [ - { - "id": 190, - "name": "resetPasswordForEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a reset request to an email address." - }, - "parameters": [ - { - "id": 191, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 192, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 193, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 195, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 549, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 194, - "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.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 548, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 195, - 194 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 196, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 197, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 553, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 198, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 199, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 554, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 197, - 199 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 200, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 201, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 556, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 202, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 556, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 201, - 202 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 111, - "name": "sendMagicLinkEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 307, - "character": 8 - } - ], - "signatures": [ - { - "id": 112, - "name": "sendMagicLinkEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a magic login link to an email address." - }, - "parameters": [ - { - "id": 113, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 114, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 115, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 118, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 312, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 117, - "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.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 311, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 116, - "name": "shouldCreateUser", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A boolean flag to indicate whether to automatically create a user on magiclink / otp sign-ins if the user doesn't exist. Defaults to true." - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 310, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 118, - 117, - 116 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 119, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 120, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 316, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 121, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 122, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 317, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 120, - 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/GoTrueApi.ts", - "line": 319, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 125, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 319, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 124, - 125 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 126, - "name": "sendMobileOTP", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 354, - "character": 8 - } - ], - "signatures": [ - { - "id": 127, - "name": "sendMobileOTP", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a mobile OTP via SMS. Will register the account if it doesn't already exist" - }, - "parameters": [ - { - "id": 128, - "name": "phone", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The user's phone number WITH international prefix" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 129, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 130, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 132, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 358, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 131, - "name": "shouldCreateUser", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A boolean flag to indicate whether to automatically create a user on magiclink / otp sign-ins if the user doesn't exist. Defaults to true.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 357, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 132, - 131 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 133, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 134, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 362, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 135, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 136, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 363, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 134, - 136 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 137, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 138, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 365, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 139, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 365, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 138, - 139 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 59, - "name": "signInWithEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 140, - "character": 8 - } - ], - "signatures": [ - { - "id": 60, - "name": "signInWithEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs in an existing user using their email address." - }, - "parameters": [ - { - "id": 61, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 62, - "name": "password", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The password of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 63, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 64, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 65, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 144, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 65 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "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/GoTrueApi.ts", - "line": 148, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - }, - { - "id": 68, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 149, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 67, - 68 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 69, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 70, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 151, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 71, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 151, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 70, - 71 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 102, - "name": "signInWithOpenIDConnect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 267, - "character": 8 - } - ], - "signatures": [ - { - "id": 103, - "name": "signInWithOpenIDConnect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs in an OpenID Connect user using their id_token." - }, - "parameters": [ - { - "id": 104, - "name": "__namedParameters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 653, - "name": "OpenIDConnectCredentials", - "dereferenced": { - "id": 653, - "name": "OpenIDConnectCredentials", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 657, - "name": "client_id", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 265, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 654, - "name": "id_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 262, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 658, - "name": "issuer", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 266, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 655, - "name": "nonce", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 263, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 656, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 264, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 501, - "name": "Provider" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 657, - 654, - 658, - 655, - 656 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 261, - "character": 17 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 105, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 107, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 276, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 106, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 275, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 107, - 106 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 108, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 110, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 278, - "character": 23 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 109, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 278, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 110, - 109 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 89, - "name": "signInWithPhone", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 227, - "character": 8 - } - ], - "signatures": [ - { - "id": 90, - "name": "signInWithPhone", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs in an existing user using their phone number and password." - }, - "parameters": [ - { - "id": 91, - "name": "phone", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The phone number of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 92, - "name": "password", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The password of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 93, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 94, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 95, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on your site.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 231, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 95 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 96, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 98, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 236, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 97, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 235, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 98, - 97 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 99, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 101, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 238, - "character": 23 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 100, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 238, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 101, - 100 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 140, - "name": "signOut", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 394, - "character": 8 - } - ], - "signatures": [ - { - "id": 141, - "name": "signOut", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Removes a logged-in session." - }, - "parameters": [ - { - "id": 142, - "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": 143, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 144, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 394, - "character": 40 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 670, - "name": "AuthError" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 144 - ] - } - ] - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 41, - "name": "signUpWithEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 86, - "character": 8 - } - ], - "signatures": [ - { - "id": 42, - "name": "signUpWithEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new user using their email address.", - "returns": "A logged-in session if the server has \"autoconfirm\" ON" - }, - "parameters": [ - { - "id": 43, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 44, - "name": "password", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The password of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 45, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 46, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 49, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 92, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 48, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional user metadata.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", + "fileName": "src/GoTrueAdminApi.ts", "line": 91, "character": 6 } ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 47, - "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/GoTrueApi.ts", - "line": 90, - "character": 6 - } - ], "type": { "type": "intrinsic", "name": "string" @@ -57721,9 +53888,9 @@ "title": "Properties", "kind": 1024, "children": [ - 49, - 48, - 47 + 45, + 44, + 46 ] } ] @@ -57738,6 +53905,65 @@ { "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": 326, + "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": { @@ -57755,15 +53981,15 @@ "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 96, + "fileName": "src/GoTrueAdminApi.ts", + "line": 99, "character": 8 } ], "type": { "type": "reference", - "id": 548, - "name": "User" + "id": 307, + "name": "Session" } }, { @@ -57774,8 +54000,8 @@ "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 97, + "fileName": "src/GoTrueAdminApi.ts", + "line": 100, "character": 8 } ], @@ -57814,15 +54040,14 @@ "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 100, + "fileName": "src/GoTrueAdminApi.ts", + "line": 102, "character": 8 } ], "type": { - "type": "reference", - "id": 529, - "name": "Session" + "type": "literal", + "value": null } }, { @@ -57833,14 +54058,15 @@ "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 101, - "character": 8 + "fileName": "src/GoTrueAdminApi.ts", + "line": 102, + "character": 20 } ], "type": { - "type": "literal", - "value": null + "type": "reference", + "id": 442, + "name": "AuthError" } } ], @@ -57855,65 +54081,6 @@ } ] } - }, - { - "type": "reflection", - "declaration": { - "id": 56, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 57, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 103, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 58, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 103, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 57, - 58 - ] - } - ] - } } ] } @@ -57926,37 +54093,92 @@ ] }, { - "id": 72, - "name": "signUpWithPhone", + "id": 71, + "name": "getUserById", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 178, + "fileName": "src/GoTrueAdminApi.ts", + "line": 173, "character": 8 } ], "signatures": [ { - "id": 73, - "name": "signUpWithPhone", + "id": 72, + "name": "getUserById", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Signs up a new user using their phone number and a password." + "shortText": "Get user by id." }, "parameters": [ { - "id": 74, - "name": "phone", + "id": 73, + "name": "uid", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The phone number of the user." + "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": 296, + "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", @@ -57964,21 +54186,7 @@ } }, { - "id": 75, - "name": "password", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The password of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 76, + "id": 34, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -57986,34 +54194,14 @@ "type": { "type": "reflection", "declaration": { - "id": 77, + "id": 35, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 79, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 183, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 78, + "id": 37, "name": "data", "kind": 1024, "kindString": "Property", @@ -58021,12 +54209,12 @@ "isOptional": true }, "comment": { - "shortText": "Optional user metadata.\n" + "shortText": "Optional user metadata\n" }, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 182, + "fileName": "src/GoTrueAdminApi.ts", + "line": 59, "character": 6 } ], @@ -58034,6 +54222,29 @@ "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": [ @@ -58041,8 +54252,8 @@ "title": "Properties", "kind": 1024, "children": [ - 79, - 78 + 37, + 36 ] } ] @@ -58055,186 +54266,9 @@ "type": "reference", "typeArguments": [ { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 80, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 81, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 187, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - }, - { - "id": 82, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 188, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 81, - 82 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 83, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 84, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 191, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - }, - { - "id": 85, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 192, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 84, - 85 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 86, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 87, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 194, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 88, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 194, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 87, - 88 - ] - } - ] - } - } - ] + "type": "reference", + "id": 296, + "name": "UserResponse" } ], "qualifiedName": "Promise", @@ -58245,210 +54279,29 @@ ] }, { - "id": 286, - "name": "updateUser", + "id": 59, + "name": "listUsers", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 832, + "fileName": "src/GoTrueAdminApi.ts", + "line": 149, "character": 8 } ], "signatures": [ { - "id": 287, - "name": "updateUser", + "id": 60, + "name": "listUsers", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Updates the user data." + "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" }, - "parameters": [ - { - "id": 288, - "name": "jwt", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A valid, logged-in JWT." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 289, - "name": "attributes", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The data you want to update.\n" - }, - "type": { - "type": "reference", - "id": 576, - "name": "UserAttributes", - "dereferenced": { - "id": 576, - "name": "UserAttributes", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 581, - "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": 140, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 577, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's email." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 120, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 580, - "name": "email_change_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "An email change token." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 135, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 579, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 130, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 578, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's phone." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 125, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 581, - 577, - 580, - 579, - 578 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 116, - "character": 17 - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 582, - "name": "AdminUserAttributes" - } - ] - } - } - } - ], "type": { "type": "reference", "typeArguments": [ @@ -58458,48 +54311,86 @@ { "type": "reflection", "declaration": { - "id": 290, + "id": 61, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 292, + "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": 326, + "name": "User" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 64 + ] + } + ] + } + } + }, + { + "id": 65, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 838, - "character": 8 + "fileName": "src/GoTrueAdminApi.ts", + "line": 150, + "character": 31 } ], "type": { "type": "literal", "value": null } - }, - { - "id": 291, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 837, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } } ], "groups": [ @@ -58507,8 +54398,8 @@ "title": "Properties", "kind": 1024, "children": [ - 292, - 291 + 62, + 65 ] } ] @@ -58517,48 +54408,82 @@ { "type": "reflection", "declaration": { - "id": 293, + "id": 66, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 295, + "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/GoTrueApi.ts", - "line": 840, - "character": 20 + "fileName": "src/GoTrueAdminApi.ts", + "line": 150, + "character": 70 } ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } - }, - { - "id": 294, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 840, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } } ], "groups": [ @@ -58566,8 +54491,8 @@ "title": "Properties", "kind": 1024, "children": [ - 295, - 294 + 67, + 70 ] } ] @@ -58584,21 +54509,120 @@ ] }, { - "id": 258, + "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": 442, + "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/GoTrueApi.ts", - "line": 739, + "fileName": "src/GoTrueAdminApi.ts", + "line": 195, "character": 8 } ], "signatures": [ { - "id": 259, + "id": 75, "name": "updateUserById", "kind": 4096, "kindString": "Call signature", @@ -58608,7 +54632,7 @@ }, "parameters": [ { - "id": 260, + "id": 76, "name": "uid", "kind": 32768, "kindString": "Parameter", @@ -58619,7 +54643,7 @@ } }, { - "id": 261, + "id": 77, "name": "attributes", "kind": 32768, "kindString": "Parameter", @@ -58629,17 +54653,17 @@ }, "type": { "type": "reference", - "id": 582, + "id": 360, "name": "AdminUserAttributes", "dereferenced": { - "id": 582, + "id": 360, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 584, + "id": 362, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -58653,7 +54677,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 165, + "line": 187, "character": 2 } ], @@ -58663,7 +54687,7 @@ } }, { - "id": 591, + "id": 369, "name": "data", "kind": 1024, "kindString": "Property", @@ -58676,7 +54700,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 140, + "line": 162, "character": 2 } ], @@ -58686,12 +54710,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 581, + "id": 359, "name": "UserAttributes.data" } }, { - "id": 587, + "id": 365, "name": "email", "kind": 1024, "kindString": "Property", @@ -58704,7 +54728,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, + "line": 142, "character": 2 } ], @@ -58714,12 +54738,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 577, + "id": 355, "name": "UserAttributes.email" } }, { - "id": 590, + "id": 368, "name": "email_change_token", "kind": 1024, "kindString": "Property", @@ -58732,7 +54756,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 135, + "line": 157, "character": 2 } ], @@ -58742,12 +54766,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 580, + "id": 358, "name": "UserAttributes.email_change_token" } }, { - "id": 585, + "id": 363, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -58761,7 +54785,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 172, + "line": 194, "character": 2 } ], @@ -58771,7 +54795,7 @@ } }, { - "id": 589, + "id": 367, "name": "password", "kind": 1024, "kindString": "Property", @@ -58784,7 +54808,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 130, + "line": 152, "character": 2 } ], @@ -58794,12 +54818,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 579, + "id": 357, "name": "UserAttributes.password" } }, { - "id": 588, + "id": 366, "name": "phone", "kind": 1024, "kindString": "Property", @@ -58812,7 +54836,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 125, + "line": 147, "character": 2 } ], @@ -58822,12 +54846,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 578, + "id": 356, "name": "UserAttributes.phone" } }, { - "id": 586, + "id": 364, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -58841,7 +54865,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 179, + "line": 201, "character": 2 } ], @@ -58851,7 +54875,7 @@ } }, { - "id": 583, + "id": 361, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -58865,7 +54889,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 155, + "line": 177, "character": 2 } ], @@ -58880,29 +54904,29 @@ "title": "Properties", "kind": 1024, "children": [ - 584, - 591, - 587, - 590, - 585, - 589, - 588, - 586, - 583 + 362, + 369, + 365, + 368, + 363, + 367, + 366, + 364, + 361 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 143, + "line": 165, "character": 17 } ], "extendedTypes": [ { "type": "reference", - "id": 576, + "id": 354, "name": "UserAttributes" } ] @@ -58914,741 +54938,9 @@ "type": "reference", "typeArguments": [ { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 262, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 264, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 745, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 263, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 744, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 264, - 263 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 265, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 267, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 747, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 266, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 747, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 267, - 266 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 145, - "name": "verifyMobileOTP", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 418, - "character": 8 - } - ], - "signatures": [ - { - "id": 146, - "name": "verifyMobileOTP", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "deprecated", - "text": "Use `verifyOTP` instead!" - } - ] - }, - "parameters": [ - { - "id": 147, - "name": "phone", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The user's phone number WITH international prefix" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 148, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "token that user was sent to their mobile phone" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 149, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 150, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 151, - "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.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 422, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 151 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 152, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 153, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 426, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - }, - { - "id": 154, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 427, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 153, - 154 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 155, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 156, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 430, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - }, - { - "id": 157, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 431, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 156, - 157 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 158, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 159, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 433, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 160, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 433, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 159, - 160 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 161, - "name": "verifyOTP", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 463, - "character": 8 - } - ], - "signatures": [ - { - "id": 162, - "name": "verifyOTP", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Send User supplied Email / Mobile OTP to be verified" - }, - "parameters": [ - { - "id": 163, - "name": "__namedParameters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { "type": "reference", - "id": 640, - "name": "VerifyOTPParams", - "dereferenced": { - "id": 640, - "name": "VerifyOTPParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 245, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 641, - "name": "VerifyMobileOTPParams" - }, - { - "type": "reference", - "id": 646, - "name": "VerifyEmailOTPParams" - } - ] - } - } - } - }, - { - "id": 164, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 165, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 166, - "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.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 466, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 166 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 167, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 168, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 470, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - }, - { - "id": 169, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 471, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 168, - 169 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 170, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 171, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 474, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - }, - { - "id": 172, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 475, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 171, - 172 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 173, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 174, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 477, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 175, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 477, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 174, - 175 - ] - } - ] - } - } - ] + "id": 296, + "name": "UserResponse" } ], "qualifiedName": "Promise", @@ -59667,62 +54959,38 @@ 2 ] }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 21, - 17, - 16 - ] - }, { "title": "Methods", "kind": 2048, "children": [ - 26, - 230, - 268, - 212, - 30, - 277, - 249, - 176, - 241, - 203, - 189, - 111, - 126, + 56, + 78, + 38, + 71, + 31, 59, - 102, - 89, - 140, - 41, - 72, - 286, - 258, - 145, - 161 + 26, + 74 ] } ], "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 14, + "fileName": "src/GoTrueAdminApi.ts", + "line": 6, "character": 21 } ] }, { - "id": 296, + "id": 81, "name": "GoTrueClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 297, + "id": 82, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -59730,13 +54998,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 98, + "line": 104, "character": 2 } ], "signatures": [ { - "id": 298, + "id": 83, "name": "new GoTrueClient", "kind": 16384, "kindString": "Constructor signature", @@ -59746,7 +55014,7 @@ }, "parameters": [ { - "id": 299, + "id": 84, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -59754,14 +55022,14 @@ "type": { "type": "reflection", "declaration": { - "id": 300, + "id": 85, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 308, + "id": 93, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -59774,7 +55042,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 103, + "line": 109, "character": 4 } ], @@ -59784,7 +55052,7 @@ } }, { - "id": 307, + "id": 92, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -59797,7 +55065,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 102, + "line": 108, "character": 4 } ], @@ -59807,7 +55075,7 @@ } }, { - "id": 312, + "id": 97, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -59817,21 +55085,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 107, + "line": 113, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 313, + "id": 98, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 314, + "id": 99, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -59841,7 +55109,7 @@ }, "parameters": [ { - "id": 315, + "id": 100, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -59865,7 +55133,7 @@ } }, { - "id": 316, + "id": 101, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -59900,7 +55168,7 @@ } }, { - "id": 302, + "id": 87, "name": "headers", "kind": 1024, "kindString": "Property", @@ -59913,27 +55181,27 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 100, + "line": 106, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 303, + "id": 88, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 304, + "id": 89, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 305, + "id": 90, "name": "key", "kind": 32768, "flags": {}, @@ -59952,7 +55220,7 @@ } }, { - "id": 311, + "id": 96, "name": "multiTab", "kind": 1024, "kindString": "Property", @@ -59965,7 +55233,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 106, + "line": 112, "character": 4 } ], @@ -59975,7 +55243,7 @@ } }, { - "id": 309, + "id": 94, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -59988,7 +55256,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 104, + "line": 110, "character": 4 } ], @@ -59998,7 +55266,7 @@ } }, { - "id": 310, + "id": 95, "name": "storage", "kind": 1024, "kindString": "Property", @@ -60008,7 +55276,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 105, + "line": 111, "character": 4 } ], @@ -60051,7 +55319,7 @@ } }, { - "id": 306, + "id": 91, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -60064,7 +55332,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 101, + "line": 107, "character": 4 } ], @@ -60074,7 +55342,7 @@ } }, { - "id": 301, + "id": 86, "name": "url", "kind": 1024, "kindString": "Property", @@ -60087,7 +55355,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 99, + "line": 105, "character": 4 } ], @@ -60102,15 +55370,15 @@ "title": "Properties", "kind": 1024, "children": [ - 308, - 307, - 312, - 302, - 311, - 309, - 310, - 306, - 301 + 93, + 92, + 97, + 87, + 96, + 94, + 95, + 91, + 86 ] } ] @@ -60120,25 +55388,25 @@ ], "type": { "type": "reference", - "id": 296, + "id": 81, "name": "default" } } ] }, { - "id": 317, - "name": "api", + "id": 102, + "name": "admin", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Namespace for the GoTrue API methods.\nThese can be used for example to get a user from a JWT in a server environment or reset a user's password." + "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": 65, + "line": 66, "character": 2 } ], @@ -60149,2424 +55417,7 @@ } }, { - "id": 320, - "name": "autoRefreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 77, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 319, - "name": "inMemorySession", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "comment": { - "shortText": "The session object for the currently logged in user or null.\nOnly used if persistSession is false." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 75, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 529, - "name": "Session" - } - ] - } - }, - { - "id": 325, - "name": "networkRetries", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 83, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 321, - "name": "persistSession", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 78, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 324, - "name": "refreshTokenTimer", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 81, - "character": 12 - } - ], - "type": { - "type": "reference", - "qualifiedName": "global.NodeJS.Timeout", - "package": "@types/node", - "name": "Timeout" - } - }, - { - "id": 326, - "name": "refreshingDeferred", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 84, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 660, - "name": "CallRefreshTokenResult" - } - ], - "name": "Deferred" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 323, - "name": "stateChangeEmitters", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 80, - "character": 12 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 592, - "name": "Subscription" - } - ], - "qualifiedName": "Map", - "package": "typescript", - "name": "Map" - }, - "defaultValue": "..." - }, - { - "id": 322, - "name": "storage", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 79, - "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": "removeItem" - }, - { - "type": "literal", - "value": "setItem" - } - ] - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - ], - "name": "PromisifyMethods" - } - }, - { - "id": 318, - "name": "storageKey", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "comment": { - "shortText": "The storage key used to identity the values saved in localStorage" - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 69, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 480, - "name": "_callRefreshToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 775, - "character": 16 - } - ], - "signatures": [ - { - "id": 481, - "name": "_callRefreshToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 482, - "name": "refreshToken", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 660, - "name": "CallRefreshTokenResult" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 421, - "name": "_doesSessionExist", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 599, - "character": 10 - } - ], - "signatures": [ - { - "id": 422, - "name": "_doesSessionExist", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 423, - "name": "maybeSession", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "maybeSession", - "asserts": false, - "targetType": { - "type": "reference", - "id": 529, - "name": "Session" - } - } - } - ] - }, - { - "id": 424, - "name": "_handleEmailSignIn", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 610, - "character": 16 - } - ], - "signatures": [ - { - "id": 425, - "name": "_handleEmailSignIn", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 426, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 427, - "name": "password", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 428, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 429, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 430, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 614, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 430 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 503, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 467, - "name": "_handleOpenIDConnectSignIn", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 686, - "character": 16 - } - ], - "signatures": [ - { - "id": 468, - "name": "_handleOpenIDConnectSignIn", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 469, - "name": "__namedParameters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 653, - "name": "OpenIDConnectCredentials", - "dereferenced": { - "id": 653, - "name": "OpenIDConnectCredentials", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 657, - "name": "client_id", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 265, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 654, - "name": "id_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 262, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 658, - "name": "issuer", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 266, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 655, - "name": "nonce", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 263, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 656, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 264, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 501, - "name": "Provider" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 657, - 654, - 658, - 655, - 656 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 261, - "character": 17 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 470, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 473, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 696, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 472, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 695, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 529, - "name": "Session" - } - ] - } - }, - { - "id": 471, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 694, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 548, - "name": "User" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 473, - 472, - 471 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 474, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 477, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 698, - "character": 35 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 476, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 698, - "character": 20 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 475, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 698, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 477, - 476, - 475 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 431, - "name": "_handlePhoneSignIn", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 638, - "character": 16 - } - ], - "signatures": [ - { - "id": 432, - "name": "_handlePhoneSignIn", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 433, - "name": "phone", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 434, - "name": "password", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 435, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 436, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 437, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 642, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 437 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 438, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 439, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 649, - "character": 38 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 440, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 441, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 649, - "character": 46 - } - ], - "type": { - "type": "literal", - "value": null - }, - "defaultValue": "null" - }, - { - "id": 442, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 649, - "character": 61 - } - ], - "type": { - "type": "literal", - "value": null - }, - "defaultValue": "null" - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 441, - 442 - ] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 443, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 439, - 443 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 444, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 445, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 656, - "character": 15 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 446, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 447, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - }, - { - "id": 448, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 656, - "character": 32 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - }, - "defaultValue": "session.user" - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 447, - 448 - ] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 449, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 656, - "character": 54 - } - ], - "type": { - "type": "literal", - "value": null - }, - "defaultValue": "null" - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 445, - 449 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 450, - "name": "_handleProviderSignIn", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 666, - "character": 10 - } - ], - "signatures": [ - { - "id": 451, - "name": "_handleProviderSignIn", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 452, - "name": "provider", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 501, - "name": "Provider", - "dereferenced": { - "id": 501, - "name": "Provider", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 3, - "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": 453, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 454, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 457, - "name": "queryParams", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 671, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 458, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 459, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 460, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 455, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 669, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 456, - "name": "scopes", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 670, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 457, - 455, - 456 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 461, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 462, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 683, - "character": 13 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 463, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 464, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "reference", - "id": 501, - "name": "Provider" - } - }, - { - "id": 465, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 464, - 465 - ] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 466, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 683, - "character": 38 - } - ], - "type": { - "type": "literal", - "value": null - }, - "defaultValue": "null" - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 462, - 466 - ] - } - ] - } - } - } - ] - }, - { - "id": 499, - "name": "_handleVisibilityChange", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 883, - "character": 10 - } - ], - "signatures": [ - { - "id": 500, - "name": "_handleVisibilityChange", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "literal", - "value": false - } - ] - } - } - ] - }, - { - "id": 483, - "name": "_notifyAllSubscribers", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 815, - "character": 10 - } - ], - "signatures": [ - { - "id": 484, - "name": "_notifyAllSubscribers", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 485, - "name": "event", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 502, - "name": "AuthChangeEvent", - "dereferenced": { - "id": 502, - "name": "AuthChangeEvent", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 21, - "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": 486, - "name": "session", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 529, - "name": "Session" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 490, - "name": "_persistSession", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 843, - "character": 10 - } - ], - "signatures": [ - { - "id": 491, - "name": "_persistSession", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 492, - "name": "currentSession", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 529, - "name": "Session", - "dereferenced": { - "id": 529, - "name": "Session", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 531, - "name": "access_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 62, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 533, - "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": 70, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 532, - "name": "expires_in", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "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": 66, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "provider_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 61, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 534, - "name": "refresh_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 71, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 535, - "name": "token_type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 72, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 536, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 531, - 533, - 532, - 530, - 534, - 535, - 536 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 60, - "character": 17 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 478, - "name": "_recoverAndRefresh", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 730, - "character": 16 - } - ], - "signatures": [ - { - "id": 479, - "name": "_recoverAndRefresh", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Recovers the session from LocalStorage and refreshes\nNote: this method is async to accommodate for AsyncStorage e.g. in React native." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "literal", - "value": null - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 493, - "name": "_removeSession", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 847, - "character": 16 - } - ], - "signatures": [ - { - "id": 494, - "name": "_removeSession", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 487, - "name": "_saveSession", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 823, - "character": 10 - } - ], - "signatures": [ - { - "id": 488, - "name": "_saveSession", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "set currentSession and currentUser\nprocess to _startAutoRefreshToken if possible" - }, - "parameters": [ - { - "id": 489, - "name": "session", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 529, - "name": "Session", - "dereferenced": { - "id": 529, - "name": "Session", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 531, - "name": "access_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 62, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 533, - "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": 70, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 532, - "name": "expires_in", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "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": 66, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "provider_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 61, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 534, - "name": "refresh_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 71, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 535, - "name": "token_type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 72, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 536, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 531, - 533, - 532, - 530, - 534, - 535, - 536 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 60, - "character": 17 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 495, - "name": "_startAutoRefreshToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 863, - "character": 10 - } - ], - "signatures": [ - { - "id": 496, - "name": "_startAutoRefreshToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Clear and re-create refresh token timer" - }, - "parameters": [ - { - "id": 497, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "time intervals in milliseconds\n" - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 498, - "name": "session", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 529, - "name": "Session", - "dereferenced": { - "id": 529, - "name": "Session", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 531, - "name": "access_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 62, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 533, - "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": 70, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 532, - "name": "expires_in", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "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": 66, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "provider_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 61, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 534, - "name": "refresh_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 71, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 535, - "name": "token_type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 72, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 536, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 531, - 533, - 532, - 530, - 534, - 535, - 536 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 60, - "character": 17 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 350, + "id": 146, "name": "getSession", "kind": 2048, "kindString": "Method", @@ -62574,19 +55425,19 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 341, + "line": 368, "character": 8 } ], "signatures": [ { - "id": 351, + "id": 147, "name": "getSession", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the session data, refreshing it if necessary." + "shortText": "Returns the session data, refreshing it if necessary.\nIf no session is detected, the session returned will be null." }, "type": { "type": "reference", @@ -62597,14 +55448,68 @@ { "type": "reflection", "declaration": { - "id": 352, + "id": 148, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "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": "reference", + "id": 307, + "name": "Session" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 151 + ] + } + ] + } + } + }, + { + "id": 152, "name": "error", "kind": 1024, "kindString": "Property", @@ -62612,7 +55517,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 344, + "line": 373, "character": 8 } ], @@ -62620,25 +55525,6 @@ "type": "literal", "value": null } - }, - { - "id": 353, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 343, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } } ], "groups": [ @@ -62646,8 +55532,8 @@ "title": "Properties", "kind": 1024, "children": [ - 354, - 353 + 149, + 152 ] } ] @@ -62656,14 +55542,67 @@ { "type": "reflection", "declaration": { - "id": 355, + "id": 153, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "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", @@ -62671,33 +55610,15 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 348, + "line": 379, "character": 8 } ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } - }, - { - "id": 356, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 347, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } } ], "groups": [ @@ -62705,8 +55626,8 @@ "title": "Properties", "kind": 1024, "children": [ - 357, - 356 + 154, + 157 ] } ] @@ -62715,14 +55636,67 @@ { "type": "reflection", "declaration": { - "id": 358, + "id": 158, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 360, + "id": 159, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 382, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 160, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 161, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 383, + "character": 10 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 161 + ] + } + ] + } + } + }, + { + "id": 162, "name": "error", "kind": 1024, "kindString": "Property", @@ -62730,25 +55704,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 352, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 359, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 351, + "line": 385, "character": 8 } ], @@ -62763,8 +55719,8 @@ "title": "Properties", "kind": 1024, "children": [ - 360, - 359 + 159, + 162 ] } ] @@ -62781,219 +55737,7 @@ ] }, { - "id": 393, - "name": "getSessionFromUrl", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 489, - "character": 8 - } - ], - "signatures": [ - { - "id": 394, - "name": "getSessionFromUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Gets the session data from a URL string" - }, - "parameters": [ - { - "id": 395, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 396, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 397, - "name": "storeSession", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optionally store the session in the browser\n" - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 489, - "character": 38 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 397 - ] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 398, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 400, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 492, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 399, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 491, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 400, - 399 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 401, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 403, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 494, - "character": 23 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 402, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 494, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 403, - 402 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 361, + "id": 163, "name": "getUser", "kind": 2048, "kindString": "Method", @@ -63001,203 +55745,45 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 391, + "line": 425, "character": 8 } ], "signatures": [ { - "id": 362, + "id": 164, "name": "getUser", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the user data, refreshing the session if necessary." + "shortText": "Gets the current user details if there is an existing session." }, + "parameters": [ + { + "id": 165, + "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": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 394, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 364, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 393, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 365, - 364 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 366, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 398, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 367, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 397, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 368, - 367 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 369, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 371, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 402, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 370, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 401, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 371, - 370 - ] - } - ] - } - } - ] + "type": "reference", + "id": 296, + "name": "UserResponse" } ], "qualifiedName": "Promise", @@ -63208,7 +55794,7 @@ ] }, { - "id": 408, + "id": 184, "name": "onAuthStateChange", "kind": 2048, "kindString": "Method", @@ -63216,13 +55802,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 573, + "line": 599, "character": 2 } ], "signatures": [ { - "id": 409, + "id": 185, "name": "onAuthStateChange", "kind": 4096, "kindString": "Call signature", @@ -63233,41 +55819,44 @@ }, "parameters": [ { - "id": 410, + "id": 186, "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": 411, + "id": 187, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 412, + "id": 188, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 413, + "id": 189, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 502, + "id": 269, "name": "AuthChangeEvent" } }, { - "id": 414, + "id": 190, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -63281,7 +55870,7 @@ }, { "type": "reference", - "id": 529, + "id": 307, "name": "Session" } ] @@ -63304,14 +55893,14 @@ { "type": "reflection", "declaration": { - "id": 415, + "id": 191, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 417, + "id": 193, "name": "error", "kind": 1024, "kindString": "Property", @@ -63319,7 +55908,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 576, + "line": 602, "character": 8 } ], @@ -63329,7 +55918,7 @@ } }, { - "id": 416, + "id": 192, "name": "subscription", "kind": 1024, "kindString": "Property", @@ -63337,13 +55926,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 575, + "line": 601, "character": 8 } ], "type": { "type": "reference", - "id": 592, + "id": 370, "name": "Subscription" } } @@ -63353,8 +55942,8 @@ "title": "Properties", "kind": 1024, "children": [ - 417, - 416 + 193, + 192 ] } ] @@ -63363,14 +55952,14 @@ { "type": "reflection", "declaration": { - "id": 418, + "id": 194, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 420, + "id": 196, "name": "error", "kind": 1024, "kindString": "Property", @@ -63378,18 +55967,18 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 578, + "line": 604, "character": 28 } ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } }, { - "id": 419, + "id": 195, "name": "subscription", "kind": 1024, "kindString": "Property", @@ -63397,7 +55986,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 578, + "line": 604, "character": 8 } ], @@ -63412,8 +56001,8 @@ "title": "Properties", "kind": 1024, "children": [ - 420, - 419 + 196, + 195 ] } ] @@ -63425,42 +56014,118 @@ ] }, { - "id": 381, - "name": "setSession", + "id": 197, + "name": "resetPasswordForEmail", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 455, + "line": 631, "character": 8 } ], "signatures": [ { - "id": 382, - "name": "setSession", + "id": 198, + "name": "resetPasswordForEmail", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the session data from refresh_token and returns current Session and Error" + "shortText": "Sends a reset request to an email address." }, "parameters": [ { - "id": 383, - "name": "refresh_token", + "id": 199, + "name": "email", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "a JWT token\n" + "shortText": "The email address of the user." }, "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 200, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 201, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 203, + "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": 635, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 202, + "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": 634, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 203, + 202 + ] + } + ] + } + }, + "defaultValue": "{}" } ], "type": { @@ -63472,14 +56137,38 @@ { "type": "reflection", "declaration": { - "id": 384, + "id": 204, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 386, + "id": 205, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 639, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 206, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + }, + { + "id": 207, "name": "error", "kind": 1024, "kindString": "Property", @@ -63487,84 +56176,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 458, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 385, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 457, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 386, - 385 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 387, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 389, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 460, - "character": 23 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 388, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 460, + "line": 640, "character": 8 } ], @@ -63579,8 +56191,8 @@ "title": "Properties", "kind": 1024, "children": [ - 389, - 388 + 205, + 207 ] } ] @@ -63589,14 +56201,32 @@ { "type": "reflection", "declaration": { - "id": 390, + "id": 208, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 392, + "id": 209, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 642, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 210, "name": "error", "kind": 1024, "kindString": "Property", @@ -63604,33 +56234,15 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 461, - "character": 23 + "line": 642, + "character": 20 } ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } - }, - { - "id": 391, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 461, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } } ], "groups": [ @@ -63638,8 +56250,8 @@ "title": "Properties", "kind": 1024, "children": [ - 392, - 391 + 209, + 210 ] } ] @@ -63656,7 +56268,62 @@ ] }, { - "id": 338, + "id": 169, + "name": "setSession", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 488, + "character": 8 + } + ], + "signatures": [ + { + "id": 170, + "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": 171, + "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": 270, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 133, "name": "signInWithOAuth", "kind": 2048, "kindString": "Method", @@ -63664,13 +56331,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 240, + "line": 264, "character": 8 } ], "signatures": [ { - "id": 339, + "id": 134, "name": "signInWithOAuth", "kind": 4096, "kindString": "Call signature", @@ -63680,17 +56347,17 @@ }, "parameters": [ { - "id": 340, + "id": 135, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 629, + "id": 406, "name": "SignInWithOAuthCredentials", "dereferenced": { - "id": 629, + "id": 406, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -63698,21 +56365,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 235, + "line": 265, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 630, + "id": 407, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 632, + "id": 409, "name": "options", "kind": 1024, "kindString": "Property", @@ -63722,32 +56389,35 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 237, + "line": 268, "character": 2 } ], "type": { "type": "reference", - "id": 633, + "id": 410, "name": "SignInWithOAuthOptions" } }, { - "id": 631, + "id": 408, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "One of the providers supported by GoTrue." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 236, + "line": 267, "character": 2 } ], "type": { "type": "reference", - "id": 501, + "id": 268, "name": "Provider" } } @@ -63757,15 +56427,15 @@ "title": "Properties", "kind": 1024, "children": [ - 632, - 631 + 409, + 408 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 235, + "line": 265, "character": 41 } ] @@ -63780,7 +56450,7 @@ "typeArguments": [ { "type": "reference", - "id": 516, + "id": 283, "name": "OAuthResponse" } ], @@ -63792,7 +56462,7 @@ ] }, { - "id": 341, + "id": 136, "name": "signInWithOtp", "kind": 2048, "kindString": "Method", @@ -63800,13 +56470,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 256, + "line": 276, "character": 8 } ], "signatures": [ { - "id": 342, + "id": 137, "name": "signInWithOtp", "kind": 4096, "kindString": "Call signature", @@ -63816,17 +56486,17 @@ }, "parameters": [ { - "id": 343, + "id": 138, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 618, + "id": 395, "name": "SignInWithPasswordlessCredentials", "dereferenced": { - "id": 618, + "id": 395, "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", @@ -63834,7 +56504,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 220, + "line": 248, "character": 12 } ], @@ -63844,22 +56514,25 @@ { "type": "reflection", "declaration": { - "id": 619, + "id": 396, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 620, + "id": 397, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's email address." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 222, + "line": 251, "character": 6 } ], @@ -63869,7 +56542,7 @@ } }, { - "id": 621, + "id": 398, "name": "options", "kind": 1024, "kindString": "Property", @@ -63879,13 +56552,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 223, + "line": 252, "character": 6 } ], "type": { "type": "reference", - "id": 625, + "id": 402, "name": "SignInWithPasswordlessOptions" } } @@ -63895,15 +56568,15 @@ "title": "Properties", "kind": 1024, "children": [ - 620, - 621 + 397, + 398 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 221, + "line": 249, "character": 4 } ] @@ -63912,14 +56585,14 @@ { "type": "reflection", "declaration": { - "id": 622, + "id": 399, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 624, + "id": 401, "name": "options", "kind": 1024, "kindString": "Property", @@ -63929,26 +56602,29 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 227, + "line": 257, "character": 6 } ], "type": { "type": "reference", - "id": 625, + "id": 402, "name": "SignInWithPasswordlessOptions" } }, { - "id": 623, + "id": 400, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 226, + "line": 256, "character": 6 } ], @@ -63963,15 +56639,15 @@ "title": "Properties", "kind": 1024, "children": [ - 624, - 623 + 401, + 400 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 225, + "line": 254, "character": 4 } ] @@ -63988,7 +56664,7 @@ "typeArguments": [ { "type": "reference", - "id": 503, + "id": 270, "name": "AuthResponse" } ], @@ -64000,7 +56676,7 @@ ] }, { - "id": 335, + "id": 130, "name": "signInWithPassword", "kind": 2048, "kindString": "Method", @@ -64008,13 +56684,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 203, + "line": 216, "character": 8 } ], "signatures": [ { - "id": 336, + "id": 131, "name": "signInWithPassword", "kind": 4096, "kindString": "Call signature", @@ -64024,17 +56700,17 @@ }, "parameters": [ { - "id": 337, + "id": 132, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 607, + "id": 384, "name": "SignInWithPasswordCredentials", "dereferenced": { - "id": 607, + "id": 384, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -64042,7 +56718,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 206, + "line": 230, "character": 12 } ], @@ -64052,22 +56728,25 @@ { "type": "reflection", "declaration": { - "id": 608, + "id": 385, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 609, + "id": 386, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's email address." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 208, + "line": 233, "character": 6 } ], @@ -64077,7 +56756,7 @@ } }, { - "id": 611, + "id": 388, "name": "options", "kind": 1024, "kindString": "Property", @@ -64087,26 +56766,29 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 210, + "line": 236, "character": 6 } ], "type": { "type": "reference", - "id": 616, + "id": 393, "name": "SignInWithPasswordOptions" } }, { - "id": 610, + "id": 387, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's password." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 209, + "line": 235, "character": 6 } ], @@ -64121,16 +56803,16 @@ "title": "Properties", "kind": 1024, "children": [ - 609, - 611, - 610 + 386, + 388, + 387 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 207, + "line": 231, "character": 4 } ] @@ -64139,14 +56821,14 @@ { "type": "reflection", "declaration": { - "id": 612, + "id": 389, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 615, + "id": 392, "name": "options", "kind": 1024, "kindString": "Property", @@ -64156,26 +56838,29 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 215, + "line": 243, "character": 6 } ], "type": { "type": "reference", - "id": 616, + "id": 393, "name": "SignInWithPasswordOptions" } }, { - "id": 614, + "id": 391, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's password." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 214, + "line": 242, "character": 6 } ], @@ -64185,15 +56870,18 @@ } }, { - "id": 613, + "id": 390, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 213, + "line": 240, "character": 6 } ], @@ -64208,16 +56896,16 @@ "title": "Properties", "kind": 1024, "children": [ - 615, - 614, - 613 + 392, + 391, + 390 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 212, + "line": 238, "character": 4 } ] @@ -64234,7 +56922,7 @@ "typeArguments": [ { "type": "reference", - "id": 503, + "id": 270, "name": "AuthResponse" } ], @@ -64246,7 +56934,7 @@ ] }, { - "id": 404, + "id": 180, "name": "signOut", "kind": 2048, "kindString": "Method", @@ -64254,20 +56942,20 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 554, + "line": 579, "character": 8 } ], "signatures": [ { - "id": 405, + "id": 181, "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)`. There is no way to revoke a user's session JWT before it automatically expires\n" + "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", @@ -64275,14 +56963,14 @@ { "type": "reflection", "declaration": { - "id": 406, + "id": 182, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 407, + "id": 183, "name": "error", "kind": 1024, "kindString": "Property", @@ -64290,7 +56978,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 554, + "line": 579, "character": 29 } ], @@ -64303,7 +56991,7 @@ }, { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } ] @@ -64315,7 +57003,7 @@ "title": "Properties", "kind": 1024, "children": [ - 407 + 183 ] } ] @@ -64330,7 +57018,7 @@ ] }, { - "id": 327, + "id": 122, "name": "signUp", "kind": 2048, "kindString": "Method", @@ -64338,368 +57026,41 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 142, + "line": 151, "character": 8 } ], "signatures": [ { - "id": 328, + "id": 123, "name": "signUp", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new user." + "shortText": "Creates a new user.", + "returns": "A logged-in session if the server has \"autoconfirm\" ON" }, "parameters": [ { - "id": 329, + "id": 124, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 600, + "id": 378, "name": "UserCredentials", "dereferenced": { - "id": 600, + "id": 378, "name": "UserCredentials", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 601, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 198, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 606, - "name": "oidc", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 204, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 653, - "name": "OpenIDConnectCredentials" - } - }, - { - "id": 603, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 200, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 602, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 199, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 605, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The name of the provider." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 203, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 501, - "name": "Provider" - } - }, - { - "id": 604, - "name": "refreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 201, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 601, - 606, - 603, - 602, - 605, - 604 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 197, - "character": 17 - } - ] - } - } - }, - { - "id": 330, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 331, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 334, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 147, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 333, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional user metadata.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 146, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 332, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The redirect URL attached to the signup confirmation link. Does not redirect the user if it's a mobile signup." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 145, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 334, - 333, - 332 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 503, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 372, - "name": "update", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 420, - "character": 8 - } - ], - "signatures": [ - { - "id": 373, - "name": "update", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Updates user data, if there is a logged in user." - }, - "parameters": [ - { - "id": 374, - "name": "attributes", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 576, - "name": "UserAttributes", - "dereferenced": { - "id": 576, - "name": "UserAttributes", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 581, - "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": 140, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 577, + "id": 379, "name": "email", "kind": 1024, "kindString": "Property", @@ -64707,12 +57068,12 @@ "isOptional": true }, "comment": { - "shortText": "The user's email." + "shortText": "The user's email address." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, + "line": 221, "character": 2 } ], @@ -64722,30 +57083,7 @@ } }, { - "id": 580, - "name": "email_change_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "An email change token." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 135, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 579, + "id": 381, "name": "password", "kind": 1024, "kindString": "Property", @@ -64758,7 +57096,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 130, + "line": 225, "character": 2 } ], @@ -64768,7 +57106,7 @@ } }, { - "id": 578, + "id": 380, "name": "phone", "kind": 1024, "kindString": "Property", @@ -64776,12 +57114,56 @@ "isOptional": true }, "comment": { - "shortText": "The user's phone." + "shortText": "The user's phone number." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 125, + "line": 223, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 383, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The name of the provider." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 228, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 268, + "name": "Provider" + } + }, + { + "id": 382, + "name": "refreshToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 226, "character": 2 } ], @@ -64796,233 +57178,26 @@ "title": "Properties", "kind": 1024, "children": [ - 581, - 577, - 580, - 579, - 578 + 379, + 381, + 380, + 383, + 382 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 116, + "line": 219, "character": 17 } - ], - "extendedBy": [ - { - "type": "reference", - "id": 582, - "name": "AdminUserAttributes" - } ] } } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 375, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 377, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 423, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 376, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 422, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 377, - 376 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 378, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 380, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 425, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 379, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 425, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 380, - 379 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 344, - "name": "verifyOTP", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 295, - "character": 8 - } - ], - "signatures": [ - { - "id": 345, - "name": "verifyOTP", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Log in a user given a User supplied OTP received via mobile." - }, - "parameters": [ - { - "id": 346, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 640, - "name": "VerifyOTPParams", - "dereferenced": { - "id": 640, - "name": "VerifyOTPParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 245, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 641, - "name": "VerifyMobileOTPParams" - }, - { - "type": "reference", - "id": 646, - "name": "VerifyEmailOTPParams" - } - ] - } - } - } }, { - "id": 347, + "id": 125, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -65030,14 +57205,60 @@ "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 126, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 129, + "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/GoTrueClient.ts", + "line": 156, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 128, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Optional user metadata." + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 155, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 127, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -65045,12 +57266,12 @@ "isOptional": true }, "comment": { - "shortText": "A URL or mobile address to send the user to after they are confirmed.\n" + "shortText": "The redirect URL attached to the signup confirmation link. Does not redirect the user if it's a mobile signup." }, "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 298, + "line": 154, "character": 6 } ], @@ -65065,7 +57286,9 @@ "title": "Properties", "kind": 1024, "children": [ - 349 + 129, + 128, + 127 ] } ] @@ -65079,7 +57302,369 @@ "typeArguments": [ { "type": "reference", - "id": 503, + "id": 270, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 166, + "name": "updateUser", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 454, + "character": 8 + } + ], + "signatures": [ + { + "id": 167, + "name": "updateUser", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Updates user data, if there is a logged in user." + }, + "parameters": [ + { + "id": 168, + "name": "attributes", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 354, + "name": "UserAttributes", + "dereferenced": { + "id": 354, + "name": "UserAttributes", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 359, + "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": 355, + "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": 358, + "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": 357, + "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": 356, + "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": [ + 359, + 355, + 358, + 357, + 356 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 138, + "character": 17 + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 360, + "name": "AdminUserAttributes" + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 296, + "name": "UserResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 139, + "name": "verifyOtp", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 319, + "character": 8 + } + ], + "signatures": [ + { + "id": 140, + "name": "verifyOtp", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Log in a user given a User supplied OTP received via mobile." + }, + "parameters": [ + { + "id": 141, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 417, + "name": "VerifyOtpParams", + "dereferenced": { + "id": 417, + "name": "VerifyOtpParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 279, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 418, + "name": "VerifyMobileOtpParams" + }, + { + "type": "reference", + "id": 423, + "name": "VerifyEmailOtpParams" + } + ] + } + } + } + }, + { + "id": 142, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 143, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 145, + "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": 323, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 144, + "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": 322, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 145, + 144 + ] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 270, "name": "AuthResponse" } ], @@ -65096,74 +57681,52 @@ "title": "Constructors", "kind": 512, "children": [ - 297 + 82 ] }, { "title": "Properties", "kind": 1024, "children": [ - 317, - 320, - 319, - 325, - 321, - 324, - 326, - 323, - 322, - 318 + 102 ] }, { "title": "Methods", "kind": 2048, "children": [ - 480, - 421, - 424, - 467, - 431, - 450, - 499, - 483, - 490, - 478, - 493, - 487, - 495, - 350, - 393, - 361, - 408, - 381, - 338, - 341, - 335, - 404, - 327, - 372, - 344 + 146, + 163, + 184, + 197, + 169, + 133, + 136, + 130, + 180, + 122, + 166, + 139 ] } ], "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 60, + "line": 61, "character": 21 } ] }, { - "id": 582, + "id": 360, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 584, + "id": 362, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -65177,7 +57740,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 165, + "line": 187, "character": 2 } ], @@ -65187,7 +57750,7 @@ } }, { - "id": 591, + "id": 369, "name": "data", "kind": 1024, "kindString": "Property", @@ -65200,7 +57763,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 140, + "line": 162, "character": 2 } ], @@ -65210,12 +57773,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 581, + "id": 359, "name": "UserAttributes.data" } }, { - "id": 587, + "id": 365, "name": "email", "kind": 1024, "kindString": "Property", @@ -65228,7 +57791,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, + "line": 142, "character": 2 } ], @@ -65238,12 +57801,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 577, + "id": 355, "name": "UserAttributes.email" } }, { - "id": 590, + "id": 368, "name": "email_change_token", "kind": 1024, "kindString": "Property", @@ -65256,7 +57819,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 135, + "line": 157, "character": 2 } ], @@ -65266,12 +57829,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 580, + "id": 358, "name": "UserAttributes.email_change_token" } }, { - "id": 585, + "id": 363, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -65285,7 +57848,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 172, + "line": 194, "character": 2 } ], @@ -65295,7 +57858,7 @@ } }, { - "id": 589, + "id": 367, "name": "password", "kind": 1024, "kindString": "Property", @@ -65308,7 +57871,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 130, + "line": 152, "character": 2 } ], @@ -65318,12 +57881,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 579, + "id": 357, "name": "UserAttributes.password" } }, { - "id": 588, + "id": 366, "name": "phone", "kind": 1024, "kindString": "Property", @@ -65336,7 +57899,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 125, + "line": 147, "character": 2 } ], @@ -65346,12 +57909,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 578, + "id": 356, "name": "UserAttributes.phone" } }, { - "id": 586, + "id": 364, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -65365,7 +57928,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 179, + "line": 201, "character": 2 } ], @@ -65375,7 +57938,7 @@ } }, { - "id": 583, + "id": 361, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -65389,7 +57952,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 155, + "line": 177, "character": 2 } ], @@ -65404,176 +57967,53 @@ "title": "Properties", "kind": 1024, "children": [ - 584, - 591, - 587, - 590, - 585, - 589, - 588, - 586, - 583 + 362, + 369, + 365, + 368, + 363, + 367, + 366, + 364, + 361 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 143, + "line": 165, "character": 17 } ], "extendedTypes": [ { "type": "reference", - "id": 576, + "id": 354, "name": "UserAttributes" } ] }, { - "id": 653, - "name": "OpenIDConnectCredentials", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 657, - "name": "client_id", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 265, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 654, - "name": "id_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 262, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 658, - "name": "issuer", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 266, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 655, - "name": "nonce", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 263, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 656, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 264, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 501, - "name": "Provider" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 657, - 654, - 658, - 655, - 656 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 261, - "character": 17 - } - ] - }, - { - "id": 529, + "id": 307, "name": "Session", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 531, + "id": 309, "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": 62, + "line": 81, "character": 2 } ], @@ -65583,7 +58023,7 @@ } }, { - "id": 533, + "id": 312, "name": "expires_at", "kind": 1024, "kindString": "Property", @@ -65596,7 +58036,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 70, + "line": 93, "character": 2 } ], @@ -65606,20 +58046,18 @@ } }, { - "id": 532, + "id": 311, "name": "expires_in", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, + "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": 66, + "line": 89, "character": 2 } ], @@ -65629,7 +58067,7 @@ } }, { - "id": 530, + "id": 308, "name": "provider_token", "kind": 1024, "kindString": "Property", @@ -65639,7 +58077,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 61, + "line": 77, "character": 2 } ], @@ -65658,15 +58096,18 @@ } }, { - "id": 534, + "id": 310, "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": 71, + "line": 85, "character": 2 } ], @@ -65676,7 +58117,7 @@ } }, { - "id": 535, + "id": 313, "name": "token_type", "kind": 1024, "kindString": "Property", @@ -65684,7 +58125,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 72, + "line": 94, "character": 2 } ], @@ -65694,7 +58135,7 @@ } }, { - "id": 536, + "id": 314, "name": "user", "kind": 1024, "kindString": "Property", @@ -65702,13 +58143,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 73, + "line": 95, "character": 2 } ], "type": { "type": "reference", - "id": 548, + "id": 326, "name": "User" } } @@ -65718,63 +58159,66 @@ "title": "Properties", "kind": 1024, "children": [ - 531, - 533, - 532, - 530, - 534, - 535, - 536 + 309, + 312, + 311, + 308, + 310, + 313, + 314 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 60, + "line": 76, "character": 17 } ] }, { - "id": 633, + "id": 410, "name": "SignInWithOAuthOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 636, + "id": 413, "name": "queryParams", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "An object of query params" + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 242, + "line": 276, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 637, + "id": 414, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 638, + "id": 415, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 639, + "id": 416, "name": "key", "kind": 32768, "flags": {}, @@ -65793,17 +58237,20 @@ } }, { - "id": 634, + "id": 411, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "A URL to send the user to after they are confirmed (OAuth logins only)." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 240, + "line": 272, "character": 2 } ], @@ -65813,17 +58260,20 @@ } }, { - "id": 635, + "id": 412, "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": 241, + "line": 274, "character": 2 } ], @@ -65838,29 +58288,29 @@ "title": "Properties", "kind": 1024, "children": [ - 636, - 634, - 635 + 413, + 411, + 412 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 239, + "line": 270, "character": 17 } ] }, { - "id": 616, + "id": 393, "name": "SignInWithPasswordOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 617, + "id": 394, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -65870,7 +58320,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 218, + "line": 246, "character": 2 } ], @@ -65885,27 +58335,27 @@ "title": "Properties", "kind": 1024, "children": [ - 617 + 394 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 217, + "line": 245, "character": 17 } ] }, { - "id": 625, + "id": 402, "name": "SignInWithPasswordlessOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 628, + "id": 405, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -65915,7 +58365,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 233, + "line": 263, "character": 2 } ], @@ -65925,7 +58375,7 @@ } }, { - "id": 626, + "id": 403, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -65938,7 +58388,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 231, + "line": 261, "character": 2 } ], @@ -65948,7 +58398,7 @@ } }, { - "id": 627, + "id": 404, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -65958,7 +58408,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 232, + "line": 262, "character": 2 } ], @@ -65973,29 +58423,29 @@ "title": "Properties", "kind": 1024, "children": [ - 628, - 626, - 627 + 405, + 403, + 404 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 229, + "line": 259, "character": 17 } ] }, { - "id": 592, + "id": 370, "name": "Subscription", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 593, + "id": 371, "name": "id", "kind": 1024, "kindString": "Property", @@ -66006,7 +58456,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 186, + "line": 208, "character": 2 } ], @@ -66016,7 +58466,7 @@ } }, { - "id": 594, + "id": 372, "name": "callback", "kind": 2048, "kindString": "Method", @@ -66024,13 +58474,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 190, + "line": 212, "character": 2 } ], "signatures": [ { - "id": 595, + "id": 373, "name": "callback", "kind": 4096, "kindString": "Call signature", @@ -66040,17 +58490,17 @@ }, "parameters": [ { - "id": 596, + "id": 374, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 502, + "id": 269, "name": "AuthChangeEvent", "dereferenced": { - "id": 502, + "id": 269, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -66058,7 +58508,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 21, + "line": 22, "character": 12 } ], @@ -66095,7 +58545,7 @@ } }, { - "id": 597, + "id": 375, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -66109,7 +58559,7 @@ }, { "type": "reference", - "id": 529, + "id": 307, "name": "Session" } ] @@ -66124,7 +58574,7 @@ ] }, { - "id": 598, + "id": 376, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -66132,13 +58582,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 194, + "line": 216, "character": 2 } ], "signatures": [ { - "id": 599, + "id": 377, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -66159,35 +58609,35 @@ "title": "Properties", "kind": 1024, "children": [ - 593 + 371 ] }, { "title": "Methods", "kind": 2048, "children": [ - 594, - 598 + 372, + 376 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 182, + "line": 204, "character": 17 } ] }, { - "id": 548, + "id": 326, "name": "User", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 565, + "id": 343, "name": "action_link", "kind": 1024, "kindString": "Property", @@ -66197,7 +58647,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 103, + "line": 125, "character": 2 } ], @@ -66207,7 +58657,7 @@ } }, { - "id": 550, + "id": 328, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -66215,21 +58665,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 90, + "line": 112, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 551, + "id": 329, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 552, + "id": 330, "name": "provider", "kind": 1024, "kindString": "Property", @@ -66239,7 +58689,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 91, + "line": 113, "character": 4 } ], @@ -66254,19 +58704,19 @@ "title": "Properties", "kind": 1024, "children": [ - 552 + 330 ] } ], "indexSignature": { - "id": 553, + "id": 331, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 554, + "id": 332, "name": "key", "kind": 32768, "flags": {}, @@ -66285,7 +58735,7 @@ } }, { - "id": 559, + "id": 337, "name": "aud", "kind": 1024, "kindString": "Property", @@ -66293,7 +58743,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 97, + "line": 119, "character": 2 } ], @@ -66303,7 +58753,7 @@ } }, { - "id": 560, + "id": 338, "name": "confirmation_sent_at", "kind": 1024, "kindString": "Property", @@ -66313,7 +58763,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 98, + "line": 120, "character": 2 } ], @@ -66323,13 +58773,816 @@ } }, { - "id": 569, + "id": 347, "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": 346, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 128, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 344, + "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": 340, + "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": 348, + "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": 327, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 111, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 353, + "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": 315, + "name": "UserIdentity" + } + } + }, + { + "id": 342, + "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": 350, + "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": 341, + "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": 345, + "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": 349, + "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": 339, + "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": 351, + "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": 352, + "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": 333, + "name": "user_metadata", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 116, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 334, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 335, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 336, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 343, + 328, + 337, + 338, + 347, + 346, + 344, + 340, + 348, + 327, + 353, + 342, + 350, + 341, + 345, + 349, + 339, + 351, + 352, + 333 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 110, + "character": 17 + } + ] + }, + { + "id": 354, + "name": "UserAttributes", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 359, + "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": 355, + "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": 358, + "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": 357, + "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": 356, + "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": [ + 359, + 355, + 358, + 357, + 356 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 138, + "character": 17 + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 360, + "name": "AdminUserAttributes" + } + ] + }, + { + "id": 378, + "name": "UserCredentials", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 379, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 221, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 381, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 225, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 380, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 223, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 383, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The name of the provider." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 228, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 268, + "name": "Provider" + } + }, + { + "id": 382, + "name": "refreshToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 226, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 379, + 381, + 380, + 383, + 382 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 219, + "character": 17 + } + ] + }, + { + "id": 315, + "name": "UserIdentity", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 323, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 105, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 316, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 99, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 318, + "name": "identity_data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 101, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 319, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 320, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 321, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 324, + "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": 322, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 104, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 325, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, "sources": [ { "fileName": "src/lib/types.ts", @@ -66343,51 +59596,11 @@ } }, { - "id": 568, - "name": "created_at", + "id": 317, + "name": "user_id", "kind": 1024, "kindString": "Property", "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 106, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 566, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 104, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 562, - "name": "email_change_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -66399,37 +59612,48 @@ "type": "intrinsic", "name": "string" } - }, + } + ], + "groups": [ { - "id": 570, - "name": "email_confirmed_at", + "title": "Properties", "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 108, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, + "children": [ + 323, + 316, + 318, + 324, + 322, + 325, + 317 + ] + } + ], + "sources": [ { - "id": 549, - "name": "id", + "fileName": "src/lib/types.ts", + "line": 98, + "character": 17 + } + ] + }, + { + "id": 423, + "name": "VerifyEmailOtpParams", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 424, + "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 89, + "line": 291, "character": 2 } ], @@ -66439,91 +59663,7 @@ } }, { - "id": 575, - "name": "identities", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 113, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 537, - "name": "UserIdentity" - } - } - }, - { - "id": 564, - "name": "invited_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 102, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 572, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 110, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 563, - "name": "new_email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 101, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 567, + "id": 425, "name": "phone", "kind": 1024, "kindString": "Property", @@ -66533,140 +59673,50 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 105, + "line": 292, "character": 2 } ], "type": { "type": "intrinsic", - "name": "string" + "name": "undefined" } }, { - "id": 571, - "name": "phone_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 109, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 561, - "name": "recovery_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 99, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 573, - "name": "role", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 111, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 574, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 112, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 555, - "name": "user_metadata", + "id": 426, + "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 94, + "line": 293, "character": 2 } ], "type": { - "type": "reflection", - "declaration": { - "id": 556, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 557, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 558, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 427, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 294, + "character": 2 } + ], + "type": { + "type": "reference", + "id": 429, + "name": "EmailOtpType" } } ], @@ -66675,69 +59725,30 @@ "title": "Properties", "kind": 1024, "children": [ - 565, - 550, - 559, - 560, - 569, - 568, - 566, - 562, - 570, - 549, - 575, - 564, - 572, - 563, - 567, - 571, - 561, - 573, - 574, - 555 + 424, + 425, + 426, + 427 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 88, + "line": 290, "character": 17 } ] }, { - "id": 576, - "name": "UserAttributes", + "id": 418, + "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 581, - "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": 140, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 577, + "id": 419, "name": "email", "kind": 1024, "kindString": "Property", @@ -66745,35 +59756,33 @@ "isOptional": true }, "comment": { - "shortText": "The user's email." + "shortText": "The user's email address." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, + "line": 282, "character": 2 } ], "type": { "type": "intrinsic", - "name": "string" + "name": "undefined" } }, { - "id": 580, - "name": "email_change_token", + "id": 420, + "name": "phone", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, + "flags": {}, "comment": { - "shortText": "An email change token." + "shortText": "The user's phone number." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 135, + "line": 284, "character": 2 } ], @@ -66783,20 +59792,18 @@ } }, { - "id": 579, - "name": "password", + "id": 421, + "name": "token", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, + "flags": {}, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 130, + "line": 286, "character": 2 } ], @@ -66806,480 +59813,25 @@ } }, { - "id": 578, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's phone." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 125, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 581, - 577, - 580, - 579, - 578 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 116, - "character": 17 - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 582, - "name": "AdminUserAttributes" - } - ] - }, - { - "id": 600, - "name": "UserCredentials", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 601, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 198, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 606, - "name": "oidc", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 204, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 653, - "name": "OpenIDConnectCredentials" - } - }, - { - "id": 603, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 200, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 602, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 199, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 605, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The name of the provider." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 203, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 501, - "name": "Provider" - } - }, - { - "id": 604, - "name": "refreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 201, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 601, - 606, - 603, - 602, - 605, - 604 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 197, - "character": 17 - } - ] - }, - { - "id": 537, - "name": "UserIdentity", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 545, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 83, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 538, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "identity_data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 79, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 541, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 542, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 543, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 546, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 84, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 544, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 82, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 539, - "name": "user_id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 78, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 545, - 538, - 540, - 546, - 544, - 547, - 539 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 76, - "character": 17 - } - ] - }, - { - "id": 646, - "name": "VerifyEmailOTPParams", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 647, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 253, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 648, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 254, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 649, - "name": "token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 255, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 650, + "id": 422, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's verification type." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 256, + "line": 288, "character": 2 } ], "type": { "type": "reference", - "id": 652, - "name": "EmailOTPType" + "id": 428, + "name": "MobileOtpType" } } ], @@ -67288,128 +59840,23 @@ "title": "Properties", "kind": 1024, "children": [ - 647, - 648, - 649, - 650 + 419, + 420, + 421, + 422 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 252, + "line": 280, "character": 17 } ] }, { - "id": 641, - "name": "VerifyMobileOTPParams", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 642, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 247, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 643, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 248, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 644, - "name": "token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 249, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 645, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 250, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 651, - "name": "MobileOTPType" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 642, - 643, - 644, - 645 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 246, - "character": 17 - } - ] - }, - { - "id": 502, + "id": 269, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -67417,7 +59864,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 21, + "line": 22, "character": 12 } ], @@ -67452,7 +59899,7 @@ } }, { - "id": 503, + "id": 270, "name": "AuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -67460,7 +59907,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 29, + "line": 30, "character": 12 } ], @@ -67470,14 +59917,14 @@ { "type": "reflection", "declaration": { - "id": 504, + "id": 271, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 505, + "id": 272, "name": "data", "kind": 1024, "kindString": "Property", @@ -67485,25 +59932,53 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 31, + "line": 32, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 506, + "id": 273, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 508, + "id": 275, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 34, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 307, + "name": "Session" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 274, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -67516,35 +59991,7 @@ "types": [ { "type": "reference", - "id": 529, - "name": "Session" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 507, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 32, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 548, + "id": 326, "name": "User" }, { @@ -67560,15 +60007,15 @@ "title": "Properties", "kind": 1024, "children": [ - 508, - 507 + 275, + 274 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 31, + "line": 32, "character": 12 } ] @@ -67576,7 +60023,7 @@ } }, { - "id": 509, + "id": 276, "name": "error", "kind": 1024, "kindString": "Property", @@ -67584,7 +60031,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 35, + "line": 36, "character": 6 } ], @@ -67599,15 +60046,15 @@ "title": "Properties", "kind": 1024, "children": [ - 505, - 509 + 272, + 276 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 30, + "line": 31, "character": 4 } ] @@ -67616,14 +60063,14 @@ { "type": "reflection", "declaration": { - "id": 510, + "id": 277, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 511, + "id": 278, "name": "data", "kind": 1024, "kindString": "Property", @@ -67631,25 +60078,43 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 38, + "line": 39, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 512, + "id": 279, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 514, + "id": 281, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 41, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 280, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -67661,24 +60126,6 @@ "type": "literal", "value": null } - }, - { - "id": 513, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 39, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } } ], "groups": [ @@ -67686,15 +60133,15 @@ "title": "Properties", "kind": 1024, "children": [ - 514, - 513 + 281, + 280 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 38, + "line": 39, "character": 12 } ] @@ -67702,7 +60149,7 @@ } }, { - "id": 515, + "id": 282, "name": "error", "kind": 1024, "kindString": "Property", @@ -67710,13 +60157,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 42, + "line": 43, "character": 6 } ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } } @@ -67726,15 +60173,15 @@ "title": "Properties", "kind": 1024, "children": [ - 511, - 515 + 278, + 282 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 37, + "line": 38, "character": 4 } ] @@ -67744,7 +60191,7 @@ } }, { - "id": 660, + "id": 432, "name": "CallRefreshTokenResult", "kind": 4194304, "kindString": "Type alias", @@ -67752,7 +60199,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 280, + "line": 320, "character": 12 } ], @@ -67762,14 +60209,14 @@ { "type": "reflection", "declaration": { - "id": 661, + "id": 433, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 663, + "id": 435, "name": "error", "kind": 1024, "kindString": "Property", @@ -67777,7 +60224,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 283, + "line": 323, "character": 6 } ], @@ -67787,7 +60234,7 @@ } }, { - "id": 662, + "id": 434, "name": "session", "kind": 1024, "kindString": "Property", @@ -67795,13 +60242,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 282, + "line": 322, "character": 6 } ], "type": { "type": "reference", - "id": 529, + "id": 307, "name": "Session" } } @@ -67811,15 +60258,15 @@ "title": "Properties", "kind": 1024, "children": [ - 663, - 662 + 435, + 434 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 281, + "line": 321, "character": 4 } ] @@ -67828,14 +60275,14 @@ { "type": "reflection", "declaration": { - "id": 664, + "id": 436, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 666, + "id": 438, "name": "error", "kind": 1024, "kindString": "Property", @@ -67843,18 +60290,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 287, + "line": 327, "character": 6 } ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } }, { - "id": 665, + "id": 437, "name": "session", "kind": 1024, "kindString": "Property", @@ -67862,7 +60309,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 286, + "line": 326, "character": 6 } ], @@ -67877,15 +60324,15 @@ "title": "Properties", "kind": 1024, "children": [ - 666, - 665 + 438, + 437 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 285, + "line": 325, "character": 4 } ] @@ -67895,15 +60342,15 @@ } }, { - "id": 652, - "name": "EmailOTPType", + "id": 429, + "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 259, + "line": 298, "character": 12 } ], @@ -67934,15 +60381,61 @@ } }, { - "id": 651, - "name": "MobileOTPType", + "id": 430, + "name": "GenerateLinkTypes", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "shortText": "The link type" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 301, + "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": 428, + "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 258, + "line": 297, "character": 12 } ], @@ -67961,7 +60454,7 @@ } }, { - "id": 516, + "id": 283, "name": "OAuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -67969,7 +60462,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 45, + "line": 46, "character": 12 } ], @@ -67979,14 +60472,14 @@ { "type": "reflection", "declaration": { - "id": 517, + "id": 284, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 518, + "id": 285, "name": "data", "kind": 1024, "kindString": "Property", @@ -67994,21 +60487,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 47, + "line": 48, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 519, + "id": 286, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 520, + "id": 287, "name": "provider", "kind": 1024, "kindString": "Property", @@ -68016,18 +60509,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 48, + "line": 49, "character": 8 } ], "type": { "type": "reference", - "id": 501, + "id": 268, "name": "Provider" } }, { - "id": 521, + "id": 288, "name": "url", "kind": 1024, "kindString": "Property", @@ -68035,7 +60528,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 49, + "line": 50, "character": 8 } ], @@ -68050,15 +60543,15 @@ "title": "Properties", "kind": 1024, "children": [ - 520, - 521 + 287, + 288 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 47, + "line": 48, "character": 12 } ] @@ -68066,7 +60559,7 @@ } }, { - "id": 522, + "id": 289, "name": "error", "kind": 1024, "kindString": "Property", @@ -68074,7 +60567,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 51, + "line": 52, "character": 6 } ], @@ -68089,15 +60582,15 @@ "title": "Properties", "kind": 1024, "children": [ - 518, - 522 + 285, + 289 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 46, + "line": 47, "character": 4 } ] @@ -68106,14 +60599,14 @@ { "type": "reflection", "declaration": { - "id": 523, + "id": 290, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 524, + "id": 291, "name": "data", "kind": 1024, "kindString": "Property", @@ -68121,21 +60614,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 525, + "id": 292, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 526, + "id": 293, "name": "provider", "kind": 1024, "kindString": "Property", @@ -68143,18 +60636,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 55, + "line": 56, "character": 8 } ], "type": { "type": "reference", - "id": 501, + "id": 268, "name": "Provider" } }, { - "id": 527, + "id": 294, "name": "url", "kind": 1024, "kindString": "Property", @@ -68162,7 +60655,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 56, + "line": 57, "character": 8 } ], @@ -68177,15 +60670,15 @@ "title": "Properties", "kind": 1024, "children": [ - 526, - 527 + 293, + 294 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 12 } ] @@ -68193,7 +60686,7 @@ } }, { - "id": 528, + "id": 295, "name": "error", "kind": 1024, "kindString": "Property", @@ -68201,13 +60694,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 58, + "line": 59, "character": 6 } ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } } @@ -68217,15 +60710,15 @@ "title": "Properties", "kind": 1024, "children": [ - 524, - 528 + 291, + 295 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 53, + "line": 54, "character": 4 } ] @@ -68235,15 +60728,18 @@ } }, { - "id": 501, + "id": 268, "name": "Provider", "kind": 4194304, "kindString": "Type alias", "flags": {}, + "comment": { + "shortText": "One of the providers supported by GoTrue." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 3, + "line": 4, "character": 12 } ], @@ -68318,7 +60814,7 @@ } }, { - "id": 629, + "id": 406, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -68326,21 +60822,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 235, + "line": 265, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 630, + "id": 407, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 632, + "id": 409, "name": "options", "kind": 1024, "kindString": "Property", @@ -68350,32 +60846,35 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 237, + "line": 268, "character": 2 } ], "type": { "type": "reference", - "id": 633, + "id": 410, "name": "SignInWithOAuthOptions" } }, { - "id": 631, + "id": 408, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "One of the providers supported by GoTrue." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 236, + "line": 267, "character": 2 } ], "type": { "type": "reference", - "id": 501, + "id": 268, "name": "Provider" } } @@ -68385,15 +60884,15 @@ "title": "Properties", "kind": 1024, "children": [ - 632, - 631 + 409, + 408 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 235, + "line": 265, "character": 41 } ] @@ -68401,7 +60900,7 @@ } }, { - "id": 607, + "id": 384, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -68409,7 +60908,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 206, + "line": 230, "character": 12 } ], @@ -68419,22 +60918,25 @@ { "type": "reflection", "declaration": { - "id": 608, + "id": 385, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 609, + "id": 386, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's email address." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 208, + "line": 233, "character": 6 } ], @@ -68444,7 +60946,7 @@ } }, { - "id": 611, + "id": 388, "name": "options", "kind": 1024, "kindString": "Property", @@ -68454,26 +60956,29 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 210, + "line": 236, "character": 6 } ], "type": { "type": "reference", - "id": 616, + "id": 393, "name": "SignInWithPasswordOptions" } }, { - "id": 610, + "id": 387, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's password." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 209, + "line": 235, "character": 6 } ], @@ -68488,16 +60993,16 @@ "title": "Properties", "kind": 1024, "children": [ - 609, - 611, - 610 + 386, + 388, + 387 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 207, + "line": 231, "character": 4 } ] @@ -68506,14 +61011,14 @@ { "type": "reflection", "declaration": { - "id": 612, + "id": 389, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 615, + "id": 392, "name": "options", "kind": 1024, "kindString": "Property", @@ -68523,26 +61028,29 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 215, + "line": 243, "character": 6 } ], "type": { "type": "reference", - "id": 616, + "id": 393, "name": "SignInWithPasswordOptions" } }, { - "id": 614, + "id": 391, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's password." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 214, + "line": 242, "character": 6 } ], @@ -68552,15 +61060,18 @@ } }, { - "id": 613, + "id": 390, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 213, + "line": 240, "character": 6 } ], @@ -68575,16 +61086,16 @@ "title": "Properties", "kind": 1024, "children": [ - 615, - 614, - 613 + 392, + 391, + 390 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 212, + "line": 238, "character": 4 } ] @@ -68594,7 +61105,7 @@ } }, { - "id": 618, + "id": 395, "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", @@ -68602,7 +61113,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 220, + "line": 248, "character": 12 } ], @@ -68612,22 +61123,25 @@ { "type": "reflection", "declaration": { - "id": 619, + "id": 396, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 620, + "id": 397, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's email address." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 222, + "line": 251, "character": 6 } ], @@ -68637,7 +61151,7 @@ } }, { - "id": 621, + "id": 398, "name": "options", "kind": 1024, "kindString": "Property", @@ -68647,13 +61161,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 223, + "line": 252, "character": 6 } ], "type": { "type": "reference", - "id": 625, + "id": 402, "name": "SignInWithPasswordlessOptions" } } @@ -68663,15 +61177,15 @@ "title": "Properties", "kind": 1024, "children": [ - 620, - 621 + 397, + 398 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 221, + "line": 249, "character": 4 } ] @@ -68680,14 +61194,14 @@ { "type": "reflection", "declaration": { - "id": 622, + "id": 399, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 624, + "id": 401, "name": "options", "kind": 1024, "kindString": "Property", @@ -68697,26 +61211,29 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 227, + "line": 257, "character": 6 } ], "type": { "type": "reference", - "id": 625, + "id": 402, "name": "SignInWithPasswordlessOptions" } }, { - "id": 623, + "id": 400, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 226, + "line": 256, "character": 6 } ], @@ -68731,15 +61248,15 @@ "title": "Properties", "kind": 1024, "children": [ - 624, - 623 + 401, + 400 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 225, + "line": 254, "character": 4 } ] @@ -68749,7 +61266,7 @@ } }, { - "id": 659, + "id": 431, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -68757,7 +61274,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 278, + "line": 318, "character": 12 } ], @@ -68800,15 +61317,250 @@ } }, { - "id": 640, - "name": "VerifyOTPParams", + "id": 296, + "name": "UserResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 245, + "line": 62, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "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": 64, + "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": 65, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 326, + "name": "User" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 300 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 64, + "character": 12 + } + ] + } + } + }, + { + "id": 301, + "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": [ + 298, + 301 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 63, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 302, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 303, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 70, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 304, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 305, + "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": [ + 305 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 70, + "character": 12 + } + ] + } + } + }, + { + "id": 306, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 73, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 442, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 303, + 306 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 69, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 417, + "name": "VerifyOtpParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 279, "character": 12 } ], @@ -68817,19 +61569,19 @@ "types": [ { "type": "reference", - "id": 641, - "name": "VerifyMobileOTPParams" + "id": 418, + "name": "VerifyMobileOtpParams" }, { "type": "reference", - "id": 646, - "name": "VerifyEmailOTPParams" + "id": 423, + "name": "VerifyEmailOtpParams" } ] } }, { - "id": 667, + "id": 439, "name": "isAuthError", "kind": 64, "kindString": "Function", @@ -68843,14 +61595,14 @@ ], "signatures": [ { - "id": 668, + "id": 440, "name": "isAuthError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 669, + "id": 441, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -68867,7 +61619,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } } @@ -68880,59 +61632,60 @@ "title": "Classes", "kind": 128, "children": [ - 675, - 670, - 722, - 735, - 710, - 688, - 695, + 447, + 442, + 494, + 507, + 482, + 460, + 467, 1, - 296 + 81 ] }, { "title": "Interfaces", "kind": 256, "children": [ - 582, - 653, - 529, - 633, - 616, - 625, - 592, - 548, - 576, - 600, - 537, - 646, - 641 + 360, + 307, + 410, + 393, + 402, + 370, + 326, + 354, + 378, + 315, + 423, + 418 ] }, { "title": "Type Aliases", "kind": 4194304, "children": [ - 502, - 503, - 660, - 652, - 651, - 516, - 501, - 629, - 607, - 618, - 659, - 640 + 269, + 270, + 432, + 429, + 430, + 428, + 283, + 268, + 406, + 384, + 395, + 431, + 296, + 417 ] }, { "title": "Functions", "kind": 64, "children": [ - 667 + 439 ] } ], diff --git a/spec/enrichments/tsdoc_v2/gotrue.json b/spec/enrichments/tsdoc_v2/gotrue.json index 13a06b10d6e..9a55fe2628b 100644 --- a/spec/enrichments/tsdoc_v2/gotrue.json +++ b/spec/enrichments/tsdoc_v2/gotrue.json @@ -7,14 +7,14 @@ "originalName": "", "children": [ { - "id": 675, + "id": 447, "name": "AuthApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 676, + "id": 448, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -28,14 +28,14 @@ ], "signatures": [ { - "id": 677, + "id": 449, "name": "new AuthApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 678, + "id": 450, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -46,7 +46,7 @@ } }, { - "id": 679, + "id": 451, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -59,50 +59,24 @@ ], "type": { "type": "reference", - "id": 675, + "id": 447, "name": "AuthApiError" }, "overwrites": { "type": "reference", - "id": 672, + "id": 444, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 671, + "id": 443, "name": "AuthError.constructor" } }, { - "id": 687, - "name": "__isAuthError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "id": 674, - "name": "AuthError.__isAuthError" - } - }, - { - "id": 680, + "id": 452, "name": "status", "kind": 1024, "kindString": "Property", @@ -120,7 +94,7 @@ } }, { - "id": 681, + "id": 453, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -134,7 +108,7 @@ ], "signatures": [ { - "id": 682, + "id": 454, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -142,14 +116,14 @@ "type": { "type": "reflection", "declaration": { - "id": 683, + "id": 455, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 685, + "id": 457, "name": "message", "kind": 1024, "kindString": "Property", @@ -168,7 +142,7 @@ "defaultValue": "..." }, { - "id": 684, + "id": 456, "name": "name", "kind": 1024, "kindString": "Property", @@ -187,7 +161,7 @@ "defaultValue": "..." }, { - "id": 686, + "id": 458, "name": "status", "kind": 1024, "kindString": "Property", @@ -211,9 +185,9 @@ "title": "Properties", "kind": 1024, "children": [ - 685, - 684, - 686 + 457, + 456, + 458 ] } ] @@ -228,22 +202,21 @@ "title": "Constructors", "kind": 512, "children": [ - 676 + 448 ] }, { "title": "Properties", "kind": 1024, "children": [ - 687, - 680 + 452 ] }, { "title": "Methods", "kind": 2048, "children": [ - 681 + 453 ] } ], @@ -257,20 +230,20 @@ "extendedTypes": [ { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } ] }, { - "id": 670, + "id": 442, "name": "AuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 671, + "id": 443, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -284,14 +257,14 @@ ], "signatures": [ { - "id": 672, + "id": 444, "name": "new AuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 673, + "id": 445, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -304,7 +277,7 @@ ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" }, "overwrites": { @@ -317,27 +290,6 @@ "type": "reference", "name": "Error.constructor" } - }, - { - "id": 674, - "name": "__isAuthError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" } ], "groups": [ @@ -345,14 +297,7 @@ "title": "Constructors", "kind": 512, "children": [ - 671 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 674 + 443 ] } ], @@ -374,30 +319,30 @@ "extendedBy": [ { "type": "reference", - "id": 675, + "id": 447, "name": "AuthApiError" }, { "type": "reference", - "id": 688, + "id": 460, "name": "AuthUnknownError" }, { "type": "reference", - "id": 695, + "id": 467, "name": "CustomAuthError" } ] }, { - "id": 722, + "id": 494, "name": "AuthInvalidCredentialsError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 723, + "id": 495, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -411,14 +356,14 @@ ], "signatures": [ { - "id": 724, + "id": 496, "name": "new AuthInvalidCredentialsError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 725, + "id": 497, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -431,50 +376,24 @@ ], "type": { "type": "reference", - "id": 722, + "id": 494, "name": "AuthInvalidCredentialsError" }, "overwrites": { "type": "reference", - "id": 697, + "id": 469, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 696, + "id": 468, "name": "CustomAuthError.constructor" } }, { - "id": 734, - "name": "__isAuthError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "id": 709, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 726, + "id": 498, "name": "name", "kind": 1024, "kindString": "Property", @@ -492,12 +411,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 701, + "id": 473, "name": "CustomAuthError.name" } }, { - "id": 727, + "id": 499, "name": "status", "kind": 1024, "kindString": "Property", @@ -515,12 +434,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 702, + "id": 474, "name": "CustomAuthError.status" } }, { - "id": 728, + "id": 500, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -534,7 +453,7 @@ ], "signatures": [ { - "id": 729, + "id": 501, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -542,14 +461,14 @@ "type": { "type": "reflection", "declaration": { - "id": 730, + "id": 502, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 732, + "id": 504, "name": "message", "kind": 1024, "kindString": "Property", @@ -568,7 +487,7 @@ "defaultValue": "..." }, { - "id": 731, + "id": 503, "name": "name", "kind": 1024, "kindString": "Property", @@ -587,7 +506,7 @@ "defaultValue": "..." }, { - "id": 733, + "id": 505, "name": "status", "kind": 1024, "kindString": "Property", @@ -611,9 +530,9 @@ "title": "Properties", "kind": 1024, "children": [ - 732, - 731, - 733 + 504, + 503, + 505 ] } ] @@ -621,14 +540,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 704, + "id": 476, "name": "CustomAuthError.toJSON" } } ], "inheritedFrom": { "type": "reference", - "id": 703, + "id": 475, "name": "CustomAuthError.toJSON" } } @@ -638,23 +557,22 @@ "title": "Constructors", "kind": 512, "children": [ - 723 + 495 ] }, { "title": "Properties", "kind": 1024, "children": [ - 734, - 726, - 727 + 498, + 499 ] }, { "title": "Methods", "kind": 2048, "children": [ - 728 + 500 ] } ], @@ -668,20 +586,20 @@ "extendedTypes": [ { "type": "reference", - "id": 695, + "id": 467, "name": "CustomAuthError" } ] }, { - "id": 735, + "id": 507, "name": "AuthRetryableFetchError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 736, + "id": 508, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -695,14 +613,14 @@ ], "signatures": [ { - "id": 737, + "id": 509, "name": "new AuthRetryableFetchError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 738, + "id": 510, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -713,7 +631,7 @@ } }, { - "id": 739, + "id": 511, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -726,50 +644,24 @@ ], "type": { "type": "reference", - "id": 735, + "id": 507, "name": "AuthRetryableFetchError" }, "overwrites": { "type": "reference", - "id": 697, + "id": 469, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 696, + "id": 468, "name": "CustomAuthError.constructor" } }, { - "id": 748, - "name": "__isAuthError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "id": 709, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 740, + "id": 512, "name": "name", "kind": 1024, "kindString": "Property", @@ -787,12 +679,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 701, + "id": 473, "name": "CustomAuthError.name" } }, { - "id": 741, + "id": 513, "name": "status", "kind": 1024, "kindString": "Property", @@ -810,12 +702,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 702, + "id": 474, "name": "CustomAuthError.status" } }, { - "id": 742, + "id": 514, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -829,7 +721,7 @@ ], "signatures": [ { - "id": 743, + "id": 515, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -837,14 +729,14 @@ "type": { "type": "reflection", "declaration": { - "id": 744, + "id": 516, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 746, + "id": 518, "name": "message", "kind": 1024, "kindString": "Property", @@ -863,7 +755,7 @@ "defaultValue": "..." }, { - "id": 745, + "id": 517, "name": "name", "kind": 1024, "kindString": "Property", @@ -882,7 +774,7 @@ "defaultValue": "..." }, { - "id": 747, + "id": 519, "name": "status", "kind": 1024, "kindString": "Property", @@ -906,9 +798,9 @@ "title": "Properties", "kind": 1024, "children": [ - 746, - 745, - 747 + 518, + 517, + 519 ] } ] @@ -916,14 +808,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 704, + "id": 476, "name": "CustomAuthError.toJSON" } } ], "inheritedFrom": { "type": "reference", - "id": 703, + "id": 475, "name": "CustomAuthError.toJSON" } } @@ -933,23 +825,22 @@ "title": "Constructors", "kind": 512, "children": [ - 736 + 508 ] }, { "title": "Properties", "kind": 1024, "children": [ - 748, - 740, - 741 + 512, + 513 ] }, { "title": "Methods", "kind": 2048, "children": [ - 742 + 514 ] } ], @@ -963,20 +854,20 @@ "extendedTypes": [ { "type": "reference", - "id": 695, + "id": 467, "name": "CustomAuthError" } ] }, { - "id": 710, + "id": 482, "name": "AuthSessionMissingError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 711, + "id": 483, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -990,57 +881,31 @@ ], "signatures": [ { - "id": 712, + "id": 484, "name": "new AuthSessionMissingError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", - "id": 710, + "id": 482, "name": "AuthSessionMissingError" }, "overwrites": { "type": "reference", - "id": 697, + "id": 469, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 696, + "id": 468, "name": "CustomAuthError.constructor" } }, { - "id": 721, - "name": "__isAuthError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "id": 709, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 713, + "id": 485, "name": "name", "kind": 1024, "kindString": "Property", @@ -1058,12 +923,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 701, + "id": 473, "name": "CustomAuthError.name" } }, { - "id": 714, + "id": 486, "name": "status", "kind": 1024, "kindString": "Property", @@ -1081,12 +946,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 702, + "id": 474, "name": "CustomAuthError.status" } }, { - "id": 715, + "id": 487, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -1100,7 +965,7 @@ ], "signatures": [ { - "id": 716, + "id": 488, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -1108,14 +973,14 @@ "type": { "type": "reflection", "declaration": { - "id": 717, + "id": 489, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 719, + "id": 491, "name": "message", "kind": 1024, "kindString": "Property", @@ -1134,7 +999,7 @@ "defaultValue": "..." }, { - "id": 718, + "id": 490, "name": "name", "kind": 1024, "kindString": "Property", @@ -1153,7 +1018,7 @@ "defaultValue": "..." }, { - "id": 720, + "id": 492, "name": "status", "kind": 1024, "kindString": "Property", @@ -1177,9 +1042,9 @@ "title": "Properties", "kind": 1024, "children": [ - 719, - 718, - 720 + 491, + 490, + 492 ] } ] @@ -1187,14 +1052,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 704, + "id": 476, "name": "CustomAuthError.toJSON" } } ], "inheritedFrom": { "type": "reference", - "id": 703, + "id": 475, "name": "CustomAuthError.toJSON" } } @@ -1204,23 +1069,22 @@ "title": "Constructors", "kind": 512, "children": [ - 711 + 483 ] }, { "title": "Properties", "kind": 1024, "children": [ - 721, - 713, - 714 + 485, + 486 ] }, { "title": "Methods", "kind": 2048, "children": [ - 715 + 487 ] } ], @@ -1234,20 +1098,20 @@ "extendedTypes": [ { "type": "reference", - "id": 695, + "id": 467, "name": "CustomAuthError" } ] }, { - "id": 688, + "id": 460, "name": "AuthUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 689, + "id": 461, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1261,14 +1125,14 @@ ], "signatures": [ { - "id": 690, + "id": 462, "name": "new AuthUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 691, + "id": 463, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1279,7 +1143,7 @@ } }, { - "id": 692, + "id": 464, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -1292,50 +1156,24 @@ ], "type": { "type": "reference", - "id": 688, + "id": 460, "name": "AuthUnknownError" }, "overwrites": { "type": "reference", - "id": 672, + "id": 444, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 671, + "id": 443, "name": "AuthError.constructor" } }, { - "id": 694, - "name": "__isAuthError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "id": 674, - "name": "AuthError.__isAuthError" - } - }, - { - "id": 693, + "id": 465, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -1358,15 +1196,14 @@ "title": "Constructors", "kind": 512, "children": [ - 689 + 461 ] }, { "title": "Properties", "kind": 1024, "children": [ - 694, - 693 + 465 ] } ], @@ -1380,20 +1217,20 @@ "extendedTypes": [ { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } ] }, { - "id": 695, + "id": 467, "name": "CustomAuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 696, + "id": 468, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1407,14 +1244,14 @@ ], "signatures": [ { - "id": 697, + "id": 469, "name": "new CustomAuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 698, + "id": 470, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1425,7 +1262,7 @@ } }, { - "id": 699, + "id": 471, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -1436,7 +1273,7 @@ } }, { - "id": 700, + "id": 472, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -1449,50 +1286,24 @@ ], "type": { "type": "reference", - "id": 695, + "id": 467, "name": "CustomAuthError" }, "overwrites": { "type": "reference", - "id": 672, + "id": 444, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 671, + "id": 443, "name": "AuthError.constructor" } }, { - "id": 709, - "name": "__isAuthError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "id": 674, - "name": "AuthError.__isAuthError" - } - }, - { - "id": 701, + "id": 473, "name": "name", "kind": 1024, "kindString": "Property", @@ -1514,7 +1325,7 @@ } }, { - "id": 702, + "id": 474, "name": "status", "kind": 1024, "kindString": "Property", @@ -1532,7 +1343,7 @@ } }, { - "id": 703, + "id": 475, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -1546,7 +1357,7 @@ ], "signatures": [ { - "id": 704, + "id": 476, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -1554,14 +1365,14 @@ "type": { "type": "reflection", "declaration": { - "id": 705, + "id": 477, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 707, + "id": 479, "name": "message", "kind": 1024, "kindString": "Property", @@ -1580,7 +1391,7 @@ "defaultValue": "..." }, { - "id": 706, + "id": 478, "name": "name", "kind": 1024, "kindString": "Property", @@ -1599,7 +1410,7 @@ "defaultValue": "..." }, { - "id": 708, + "id": 480, "name": "status", "kind": 1024, "kindString": "Property", @@ -1623,9 +1434,9 @@ "title": "Properties", "kind": 1024, "children": [ - 707, - 706, - 708 + 479, + 478, + 480 ] } ] @@ -1640,23 +1451,22 @@ "title": "Constructors", "kind": 512, "children": [ - 696 + 468 ] }, { "title": "Properties", "kind": 1024, "children": [ - 709, - 701, - 702 + 473, + 474 ] }, { "title": "Methods", "kind": 2048, "children": [ - 703 + 475 ] } ], @@ -1670,31 +1480,31 @@ "extendedTypes": [ { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } ], "extendedBy": [ { "type": "reference", - "id": 710, + "id": 482, "name": "AuthSessionMissingError" }, { "type": "reference", - "id": 722, + "id": 494, "name": "AuthInvalidCredentialsError" }, { "type": "reference", - "id": 735, + "id": 507, "name": "AuthRetryableFetchError" } ] }, { "id": 1, - "name": "GoTrueApi", + "name": "GoTrueAdminApi", "kind": 128, "kindString": "Class", "flags": {}, @@ -1707,15 +1517,15 @@ "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 21, + "fileName": "src/GoTrueAdminApi.ts", + "line": 13, "character": 2 } ], "signatures": [ { "id": 3, - "name": "new GoTrueApi", + "name": "new GoTrueAdminApi", "kind": 16384, "kindString": "Constructor signature", "flags": {}, @@ -1745,8 +1555,8 @@ }, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 30, + "fileName": "src/GoTrueAdminApi.ts", + "line": 22, "character": 4 } ], @@ -1835,8 +1645,8 @@ }, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 27, + "fileName": "src/GoTrueAdminApi.ts", + "line": 19, "character": 4 } ], @@ -1882,8 +1692,8 @@ "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 26, + "fileName": "src/GoTrueAdminApi.ts", + "line": 18, "character": 4 } ], @@ -1917,255 +1727,38 @@ ] }, { - "id": 21, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 19, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 22, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 23, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 24, - "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": 25, - "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": 17, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 18, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 19, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 20, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 16, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 26, - "name": "_createRequestHeaders", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 42, - "character": 10 - } - ], - "signatures": [ - { - "id": 27, - "name": "_createRequestHeaders", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Create a temporary object with all configured headers and\nadds the Authorization token to be used on request methods" - }, - "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": "reflection", - "declaration": { - "id": 29, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - } - ] - }, - { - "id": 230, + "id": 56, "name": "createUser", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 669, + "fileName": "src/GoTrueAdminApi.ts", + "line": 128, "character": 8 } ], "signatures": [ { - "id": 231, + "id": 57, "name": "createUser", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new user.", - "text": "This function should only be called on a server. Never expose your `service_role` key in the browser.\n" + "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": 232, + "id": 58, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The data you want to create the user with.\n" - }, "type": { "type": "reference", - "id": 582, + "id": 360, "name": "AdminUserAttributes" } } @@ -2174,166 +1767,9 @@ "type": "reference", "typeArguments": [ { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 233, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 235, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 672, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - }, - { - "id": 236, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 672, - "character": 30 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 234, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 672, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 235, - 236, - 234 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 237, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 239, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 672, - "character": 60 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 240, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 672, - "character": 72 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 238, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 672, - "character": 48 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 239, - 240, - 238 - ] - } - ] - } - } - ] + "type": "reference", + "id": 296, + "name": "UserResponse" } ], "qualifiedName": "Promise", @@ -2344,38 +1780,37 @@ ] }, { - "id": 268, + "id": 78, "name": "deleteUser", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 771, + "fileName": "src/GoTrueAdminApi.ts", + "line": 218, "character": 8 } ], "signatures": [ { - "id": 269, + "id": 79, "name": "deleteUser", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Delete a user. Requires a `service_role` key.", - "text": "This function should only be called on a server. Never expose your `service_role` key in the browser.\n" + "shortText": "Delete a user. Requires a `service_role` key." }, "parameters": [ { - "id": 270, + "id": 80, "name": "uid", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The user uid you want to remove.\n" + "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", @@ -2387,127 +1822,9 @@ "type": "reference", "typeArguments": [ { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 271, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 273, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 774, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 272, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 773, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 273, - 272 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 274, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 276, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 776, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 275, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 776, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 276, - 275 - ] - } - ] - } - } - ] + "type": "reference", + "id": 296, + "name": "UserResponse" } ], "qualifiedName": "Promise", @@ -2518,21 +1835,21 @@ ] }, { - "id": 212, + "id": 38, "name": "generateLink", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 618, + "fileName": "src/GoTrueAdminApi.ts", + "line": 85, "character": 8 } ], "signatures": [ { - "id": 213, + "id": 39, "name": "generateLink", "kind": 4096, "kindString": "Call signature", @@ -2542,38 +1859,19 @@ }, "parameters": [ { - "id": 214, + "id": 40, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The link type (\"signup\" or \"magiclink\" or \"recovery\" or \"invite\")." - }, "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" - }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" - } - ] + "type": "reference", + "id": 430, + "name": "GenerateLinkTypes" } }, { - "id": 215, + "id": 41, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -2587,7 +1885,7 @@ } }, { - "id": 216, + "id": 42, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -2595,14 +1893,14 @@ "type": { "type": "reflection", "declaration": { - "id": 217, + "id": 43, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 219, + "id": 45, "name": "data", "kind": 1024, "kindString": "Property", @@ -2614,8 +1912,8 @@ }, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 623, + "fileName": "src/GoTrueAdminApi.ts", + "line": 90, "character": 6 } ], @@ -2625,7 +1923,7 @@ } }, { - "id": 218, + "id": 44, "name": "password", "kind": 1024, "kindString": "Property", @@ -2637,8 +1935,8 @@ }, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 622, + "fileName": "src/GoTrueAdminApi.ts", + "line": 89, "character": 6 } ], @@ -2648,7 +1946,7 @@ } }, { - "id": 220, + "id": 46, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -2656,2983 +1954,15 @@ "isOptional": true }, "comment": { - "shortText": "The link type (\"signup\" or \"magiclink\" or \"recovery\" or \"invite\").\n" + "shortText": "The redirect url which should be appended to the generated link\n" }, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 624, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 219, - 218, - 220 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 221, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 222, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 628, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - }, - { - "id": 223, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 629, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 222, - 223 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 224, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 225, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 632, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - }, - { - "id": 226, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 633, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 225, - 226 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 227, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 228, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 635, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 229, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 635, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 228, - 229 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 30, - "name": "getUrlForProvider", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 54, - "character": 2 - } - ], - "signatures": [ - { - "id": 31, - "name": "getUrlForProvider", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Generates the relevant login URL for a third-party provider." - }, - "parameters": [ - { - "id": 32, - "name": "provider", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "One of the providers supported by GoTrue." - }, - "type": { - "type": "reference", - "id": 501, - "name": "Provider" - } - }, - { - "id": 33, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 34, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 37, - "name": "queryParams", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 59, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 38, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 39, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 40, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 35, - "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/GoTrueApi.ts", - "line": 57, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 36, - "name": "scopes", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A space-separated list of scopes granted to the OAuth application.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 58, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 37, - 35, - 36 - ] - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 277, - "name": "getUser", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 806, - "character": 8 - } - ], - "signatures": [ - { - "id": 278, - "name": "getUser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Gets the current user details.", - "text": "This method is called by the GoTrueClient `update` where\nthe jwt is set to this.currentSession.access_token\nand therefore, acts like getting the currently authenticated user\n" - }, - "parameters": [ - { - "id": 279, - "name": "jwt", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A valid, logged-in JWT. Typically, the access_token for the currentSession\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 280, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 282, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 809, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 281, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 808, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 282, - 281 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 283, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 285, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 811, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 284, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 811, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 285, - 284 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 249, - "name": "getUserById", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 715, - "character": 8 - } - ], - "signatures": [ - { - "id": 250, - "name": "getUserById", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Get user by id." - }, - "parameters": [ - { - "id": 251, - "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": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 252, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 254, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 717, - "character": 27 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 253, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 717, - "character": 15 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 254, - 253 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 255, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 257, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 717, - "character": 57 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 256, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 717, - "character": 45 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 257, - 256 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 176, - "name": "inviteUserByEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 505, - "character": 8 - } - ], - "signatures": [ - { - "id": 177, - "name": "inviteUserByEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends an invite link to an email address." - }, - "parameters": [ - { - "id": 178, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 179, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 180, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 182, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional user metadata\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 509, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 181, - "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/GoTrueApi.ts", - "line": 508, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 182, - 181 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 183, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 185, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 514, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 184, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 513, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 185, - 184 - ] - } - ] - } - }, - { - "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/GoTrueApi.ts", - "line": 516, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 187, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 516, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 188, - 187 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 241, - "name": "listUsers", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 693, - "character": 8 - } - ], - "signatures": [ - { - "id": 242, - "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": 243, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 245, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 693, - "character": 46 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 244, - "name": "users", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 693, - "character": 31 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 548, - "name": "User" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 245, - 244 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 246, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 248, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 693, - "character": 77 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 247, - "name": "users", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 693, - "character": 64 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 248, - 247 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 203, - "name": "refreshAccessToken", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 584, - "character": 8 - } - ], - "signatures": [ - { - "id": 204, - "name": "refreshAccessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Generates a new JWT." - }, - "parameters": [ - { - "id": 205, - "name": "refreshToken", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A valid refresh token that was returned on login.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 206, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 208, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 587, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 207, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 586, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 208, - 207 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 209, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 211, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 589, - "character": 23 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 210, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 589, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 211, - 210 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 189, - "name": "resetPasswordForEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 545, - "character": 8 - } - ], - "signatures": [ - { - "id": 190, - "name": "resetPasswordForEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a reset request to an email address." - }, - "parameters": [ - { - "id": 191, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 192, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 193, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 195, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 549, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 194, - "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.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 548, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 195, - 194 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 196, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 197, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 553, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 198, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 199, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 554, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 197, - 199 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 200, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 201, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 556, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 202, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 556, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 201, - 202 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 111, - "name": "sendMagicLinkEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 307, - "character": 8 - } - ], - "signatures": [ - { - "id": 112, - "name": "sendMagicLinkEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a magic login link to an email address." - }, - "parameters": [ - { - "id": 113, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 114, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 115, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 118, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 312, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 117, - "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.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 311, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 116, - "name": "shouldCreateUser", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A boolean flag to indicate whether to automatically create a user on magiclink / otp sign-ins if the user doesn't exist. Defaults to true." - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 310, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 118, - 117, - 116 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 119, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 120, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 316, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 121, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 122, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 317, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 120, - 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/GoTrueApi.ts", - "line": 319, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 125, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 319, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 124, - 125 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 126, - "name": "sendMobileOTP", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 354, - "character": 8 - } - ], - "signatures": [ - { - "id": 127, - "name": "sendMobileOTP", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a mobile OTP via SMS. Will register the account if it doesn't already exist" - }, - "parameters": [ - { - "id": 128, - "name": "phone", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The user's phone number WITH international prefix" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 129, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 130, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 132, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 358, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 131, - "name": "shouldCreateUser", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A boolean flag to indicate whether to automatically create a user on magiclink / otp sign-ins if the user doesn't exist. Defaults to true.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 357, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 132, - 131 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 133, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 134, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 362, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 135, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 136, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 363, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 134, - 136 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 137, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 138, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 365, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 139, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 365, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 138, - 139 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 59, - "name": "signInWithEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 140, - "character": 8 - } - ], - "signatures": [ - { - "id": 60, - "name": "signInWithEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs in an existing user using their email address." - }, - "parameters": [ - { - "id": 61, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 62, - "name": "password", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The password of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 63, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 64, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 65, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 144, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 65 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "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/GoTrueApi.ts", - "line": 148, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - }, - { - "id": 68, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 149, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 67, - 68 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 69, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 70, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 151, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 71, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 151, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 70, - 71 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 102, - "name": "signInWithOpenIDConnect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 267, - "character": 8 - } - ], - "signatures": [ - { - "id": 103, - "name": "signInWithOpenIDConnect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs in an OpenID Connect user using their id_token." - }, - "parameters": [ - { - "id": 104, - "name": "__namedParameters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 653, - "name": "OpenIDConnectCredentials" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 105, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 107, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 276, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 106, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 275, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 107, - 106 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 108, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 110, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 278, - "character": 23 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 109, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 278, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 110, - 109 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 89, - "name": "signInWithPhone", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 227, - "character": 8 - } - ], - "signatures": [ - { - "id": 90, - "name": "signInWithPhone", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs in an existing user using their phone number and password." - }, - "parameters": [ - { - "id": 91, - "name": "phone", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The phone number of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 92, - "name": "password", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The password of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 93, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 94, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 95, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on your site.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 231, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 95 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 96, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 98, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 236, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 97, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 235, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 98, - 97 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 99, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 101, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 238, - "character": 23 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 100, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 238, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 101, - 100 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 140, - "name": "signOut", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 394, - "character": 8 - } - ], - "signatures": [ - { - "id": 141, - "name": "signOut", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Removes a logged-in session." - }, - "parameters": [ - { - "id": 142, - "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": 143, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 144, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 394, - "character": 40 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 670, - "name": "AuthError" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 144 - ] - } - ] - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 41, - "name": "signUpWithEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 86, - "character": 8 - } - ], - "signatures": [ - { - "id": 42, - "name": "signUpWithEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new user using their email address.", - "returns": "A logged-in session if the server has \"autoconfirm\" ON" - }, - "parameters": [ - { - "id": 43, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 44, - "name": "password", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The password of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 45, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 46, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 49, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 92, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 48, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional user metadata.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", + "fileName": "src/GoTrueAdminApi.ts", "line": 91, "character": 6 } ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 47, - "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/GoTrueApi.ts", - "line": 90, - "character": 6 - } - ], "type": { "type": "intrinsic", "name": "string" @@ -5644,9 +1974,9 @@ "title": "Properties", "kind": 1024, "children": [ - 49, - 48, - 47 + 45, + 44, + 46 ] } ] @@ -5661,6 +1991,65 @@ { "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": 326, + "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": { @@ -5678,15 +2067,15 @@ "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 96, + "fileName": "src/GoTrueAdminApi.ts", + "line": 99, "character": 8 } ], "type": { "type": "reference", - "id": 548, - "name": "User" + "id": 307, + "name": "Session" } }, { @@ -5697,8 +2086,8 @@ "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 97, + "fileName": "src/GoTrueAdminApi.ts", + "line": 100, "character": 8 } ], @@ -5737,15 +2126,14 @@ "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 100, + "fileName": "src/GoTrueAdminApi.ts", + "line": 102, "character": 8 } ], "type": { - "type": "reference", - "id": 529, - "name": "Session" + "type": "literal", + "value": null } }, { @@ -5756,14 +2144,15 @@ "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 101, - "character": 8 + "fileName": "src/GoTrueAdminApi.ts", + "line": 102, + "character": 20 } ], "type": { - "type": "literal", - "value": null + "type": "reference", + "id": 442, + "name": "AuthError" } } ], @@ -5778,65 +2167,6 @@ } ] } - }, - { - "type": "reflection", - "declaration": { - "id": 56, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 57, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 103, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 58, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 103, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 57, - 58 - ] - } - ] - } } ] } @@ -5849,37 +2179,92 @@ ] }, { - "id": 72, - "name": "signUpWithPhone", + "id": 71, + "name": "getUserById", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 178, + "fileName": "src/GoTrueAdminApi.ts", + "line": 173, "character": 8 } ], "signatures": [ { - "id": 73, - "name": "signUpWithPhone", + "id": 72, + "name": "getUserById", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Signs up a new user using their phone number and a password." + "shortText": "Get user by id." }, "parameters": [ { - "id": 74, - "name": "phone", + "id": 73, + "name": "uid", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The phone number of the user." + "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": 296, + "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", @@ -5887,21 +2272,7 @@ } }, { - "id": 75, - "name": "password", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The password of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 76, + "id": 34, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -5909,34 +2280,14 @@ "type": { "type": "reflection", "declaration": { - "id": 77, + "id": 35, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 79, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 183, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 78, + "id": 37, "name": "data", "kind": 1024, "kindString": "Property", @@ -5944,12 +2295,12 @@ "isOptional": true }, "comment": { - "shortText": "Optional user metadata.\n" + "shortText": "Optional user metadata\n" }, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 182, + "fileName": "src/GoTrueAdminApi.ts", + "line": 59, "character": 6 } ], @@ -5957,6 +2308,29 @@ "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": [ @@ -5964,8 +2338,8 @@ "title": "Properties", "kind": 1024, "children": [ - 79, - 78 + 37, + 36 ] } ] @@ -5978,186 +2352,9 @@ "type": "reference", "typeArguments": [ { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 80, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 81, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 187, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - }, - { - "id": 82, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 188, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 81, - 82 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 83, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 84, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 191, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - }, - { - "id": 85, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 192, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 84, - 85 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 86, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 87, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 194, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 88, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 194, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 87, - 88 - ] - } - ] - } - } - ] + "type": "reference", + "id": 296, + "name": "UserResponse" } ], "qualifiedName": "Promise", @@ -6168,59 +2365,29 @@ ] }, { - "id": 286, - "name": "updateUser", + "id": 59, + "name": "listUsers", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 832, + "fileName": "src/GoTrueAdminApi.ts", + "line": 149, "character": 8 } ], "signatures": [ { - "id": 287, - "name": "updateUser", + "id": 60, + "name": "listUsers", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Updates the user data." + "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" }, - "parameters": [ - { - "id": 288, - "name": "jwt", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A valid, logged-in JWT." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 289, - "name": "attributes", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The data you want to update.\n" - }, - "type": { - "type": "reference", - "id": 576, - "name": "UserAttributes" - } - } - ], "type": { "type": "reference", "typeArguments": [ @@ -6230,48 +2397,86 @@ { "type": "reflection", "declaration": { - "id": 290, + "id": 61, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 292, + "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": 326, + "name": "User" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 64 + ] + } + ] + } + } + }, + { + "id": 65, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 838, - "character": 8 + "fileName": "src/GoTrueAdminApi.ts", + "line": 150, + "character": 31 } ], "type": { "type": "literal", "value": null } - }, - { - "id": 291, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 837, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } } ], "groups": [ @@ -6279,8 +2484,8 @@ "title": "Properties", "kind": 1024, "children": [ - 292, - 291 + 62, + 65 ] } ] @@ -6289,48 +2494,82 @@ { "type": "reflection", "declaration": { - "id": 293, + "id": 66, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 295, + "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/GoTrueApi.ts", - "line": 840, - "character": 20 + "fileName": "src/GoTrueAdminApi.ts", + "line": 150, + "character": 70 } ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } - }, - { - "id": 294, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 840, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } } ], "groups": [ @@ -6338,8 +2577,8 @@ "title": "Properties", "kind": 1024, "children": [ - 295, - 294 + 67, + 70 ] } ] @@ -6356,21 +2595,120 @@ ] }, { - "id": 258, + "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": 442, + "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/GoTrueApi.ts", - "line": 739, + "fileName": "src/GoTrueAdminApi.ts", + "line": 195, "character": 8 } ], "signatures": [ { - "id": 259, + "id": 75, "name": "updateUserById", "kind": 4096, "kindString": "Call signature", @@ -6380,7 +2718,7 @@ }, "parameters": [ { - "id": 260, + "id": 76, "name": "uid", "kind": 32768, "kindString": "Parameter", @@ -6391,7 +2729,7 @@ } }, { - "id": 261, + "id": 77, "name": "attributes", "kind": 32768, "kindString": "Parameter", @@ -6401,7 +2739,7 @@ }, "type": { "type": "reference", - "id": 582, + "id": 360, "name": "AdminUserAttributes" } } @@ -6410,712 +2748,9 @@ "type": "reference", "typeArguments": [ { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 262, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 264, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 745, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 263, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 744, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 264, - 263 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 265, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 267, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 747, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 266, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 747, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 267, - 266 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 145, - "name": "verifyMobileOTP", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 418, - "character": 8 - } - ], - "signatures": [ - { - "id": 146, - "name": "verifyMobileOTP", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "deprecated", - "text": "Use `verifyOTP` instead!" - } - ] - }, - "parameters": [ - { - "id": 147, - "name": "phone", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The user's phone number WITH international prefix" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 148, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "token that user was sent to their mobile phone" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 149, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 150, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 151, - "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.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 422, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 151 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 152, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 153, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 426, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - }, - { - "id": 154, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 427, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 153, - 154 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 155, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 156, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 430, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - }, - { - "id": 157, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 431, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 156, - 157 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 158, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 159, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 433, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 160, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 433, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 159, - 160 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 161, - "name": "verifyOTP", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 463, - "character": 8 - } - ], - "signatures": [ - { - "id": 162, - "name": "verifyOTP", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Send User supplied Email / Mobile OTP to be verified" - }, - "parameters": [ - { - "id": 163, - "name": "__namedParameters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { "type": "reference", - "id": 640, - "name": "VerifyOTPParams" - } - }, - { - "id": 164, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 165, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 166, - "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.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 466, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 166 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 167, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 168, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 470, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - }, - { - "id": 169, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 471, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 168, - 169 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 170, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 171, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 474, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - }, - { - "id": 172, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 475, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 171, - 172 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 173, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 174, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 477, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 175, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 477, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 174, - 175 - ] - } - ] - } - } - ] + "id": 296, + "name": "UserResponse" } ], "qualifiedName": "Promise", @@ -7134,62 +2769,38 @@ 2 ] }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 21, - 17, - 16 - ] - }, { "title": "Methods", "kind": 2048, "children": [ - 26, - 230, - 268, - 212, - 30, - 277, - 249, - 176, - 241, - 203, - 189, - 111, - 126, + 56, + 78, + 38, + 71, + 31, 59, - 102, - 89, - 140, - 41, - 72, - 286, - 258, - 145, - 161 + 26, + 74 ] } ], "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 14, + "fileName": "src/GoTrueAdminApi.ts", + "line": 6, "character": 21 } ] }, { - "id": 296, + "id": 81, "name": "GoTrueClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 297, + "id": 82, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -7197,13 +2808,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 98, + "line": 104, "character": 2 } ], "signatures": [ { - "id": 298, + "id": 83, "name": "new GoTrueClient", "kind": 16384, "kindString": "Constructor signature", @@ -7213,7 +2824,7 @@ }, "parameters": [ { - "id": 299, + "id": 84, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -7221,14 +2832,14 @@ "type": { "type": "reflection", "declaration": { - "id": 300, + "id": 85, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 308, + "id": 93, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -7241,7 +2852,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 103, + "line": 109, "character": 4 } ], @@ -7251,7 +2862,7 @@ } }, { - "id": 307, + "id": 92, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -7264,7 +2875,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 102, + "line": 108, "character": 4 } ], @@ -7274,7 +2885,7 @@ } }, { - "id": 312, + "id": 97, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -7284,21 +2895,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 107, + "line": 113, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 313, + "id": 98, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 314, + "id": 99, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -7308,7 +2919,7 @@ }, "parameters": [ { - "id": 315, + "id": 100, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -7332,7 +2943,7 @@ } }, { - "id": 316, + "id": 101, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -7367,7 +2978,7 @@ } }, { - "id": 302, + "id": 87, "name": "headers", "kind": 1024, "kindString": "Property", @@ -7380,27 +2991,27 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 100, + "line": 106, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 303, + "id": 88, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 304, + "id": 89, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 305, + "id": 90, "name": "key", "kind": 32768, "flags": {}, @@ -7419,7 +3030,7 @@ } }, { - "id": 311, + "id": 96, "name": "multiTab", "kind": 1024, "kindString": "Property", @@ -7432,7 +3043,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 106, + "line": 112, "character": 4 } ], @@ -7442,7 +3053,7 @@ } }, { - "id": 309, + "id": 94, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -7455,7 +3066,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 104, + "line": 110, "character": 4 } ], @@ -7465,7 +3076,7 @@ } }, { - "id": 310, + "id": 95, "name": "storage", "kind": 1024, "kindString": "Property", @@ -7475,7 +3086,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 105, + "line": 111, "character": 4 } ], @@ -7518,7 +3129,7 @@ } }, { - "id": 306, + "id": 91, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -7531,7 +3142,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 101, + "line": 107, "character": 4 } ], @@ -7541,7 +3152,7 @@ } }, { - "id": 301, + "id": 86, "name": "url", "kind": 1024, "kindString": "Property", @@ -7554,7 +3165,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 99, + "line": 105, "character": 4 } ], @@ -7569,15 +3180,15 @@ "title": "Properties", "kind": 1024, "children": [ - 308, - 307, - 312, - 302, - 311, - 309, - 310, - 306, - 301 + 93, + 92, + 97, + 87, + 96, + 94, + 95, + 91, + 86 ] } ] @@ -7587,25 +3198,25 @@ ], "type": { "type": "reference", - "id": 296, + "id": 81, "name": "default" } } ] }, { - "id": 317, - "name": "api", + "id": 102, + "name": "admin", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Namespace for the GoTrue API methods.\nThese can be used for example to get a user from a JWT in a server environment or reset a user's password." + "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": 65, + "line": 66, "character": 2 } ], @@ -7616,1635 +3227,7 @@ } }, { - "id": 320, - "name": "autoRefreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 77, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 319, - "name": "inMemorySession", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "comment": { - "shortText": "The session object for the currently logged in user or null.\nOnly used if persistSession is false." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 75, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 529, - "name": "Session" - } - ] - } - }, - { - "id": 325, - "name": "networkRetries", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 83, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 321, - "name": "persistSession", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 78, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 324, - "name": "refreshTokenTimer", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 81, - "character": 12 - } - ], - "type": { - "type": "reference", - "qualifiedName": "global.NodeJS.Timeout", - "package": "@types/node", - "name": "Timeout" - } - }, - { - "id": 326, - "name": "refreshingDeferred", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 84, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 660, - "name": "CallRefreshTokenResult" - } - ], - "name": "Deferred" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 323, - "name": "stateChangeEmitters", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 80, - "character": 12 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 592, - "name": "Subscription" - } - ], - "qualifiedName": "Map", - "package": "typescript", - "name": "Map" - }, - "defaultValue": "..." - }, - { - "id": 322, - "name": "storage", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 79, - "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": "removeItem" - }, - { - "type": "literal", - "value": "setItem" - } - ] - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - ], - "name": "PromisifyMethods" - } - }, - { - "id": 318, - "name": "storageKey", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "comment": { - "shortText": "The storage key used to identity the values saved in localStorage" - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 69, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 480, - "name": "_callRefreshToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 775, - "character": 16 - } - ], - "signatures": [ - { - "id": 481, - "name": "_callRefreshToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 482, - "name": "refreshToken", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 660, - "name": "CallRefreshTokenResult" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 421, - "name": "_doesSessionExist", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 599, - "character": 10 - } - ], - "signatures": [ - { - "id": 422, - "name": "_doesSessionExist", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 423, - "name": "maybeSession", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "maybeSession", - "asserts": false, - "targetType": { - "type": "reference", - "id": 529, - "name": "Session" - } - } - } - ] - }, - { - "id": 424, - "name": "_handleEmailSignIn", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 610, - "character": 16 - } - ], - "signatures": [ - { - "id": 425, - "name": "_handleEmailSignIn", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 426, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 427, - "name": "password", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 428, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 429, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 430, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 614, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 430 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 503, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 467, - "name": "_handleOpenIDConnectSignIn", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 686, - "character": 16 - } - ], - "signatures": [ - { - "id": 468, - "name": "_handleOpenIDConnectSignIn", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 469, - "name": "__namedParameters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 653, - "name": "OpenIDConnectCredentials" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 470, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 473, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 696, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 472, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 695, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 529, - "name": "Session" - } - ] - } - }, - { - "id": 471, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 694, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 548, - "name": "User" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 473, - 472, - 471 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 474, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 477, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 698, - "character": 35 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 476, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 698, - "character": 20 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 475, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 698, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 477, - 476, - 475 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 431, - "name": "_handlePhoneSignIn", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 638, - "character": 16 - } - ], - "signatures": [ - { - "id": 432, - "name": "_handlePhoneSignIn", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 433, - "name": "phone", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 434, - "name": "password", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 435, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 436, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 437, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 642, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 437 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 438, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 439, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 649, - "character": 38 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 440, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 441, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 649, - "character": 46 - } - ], - "type": { - "type": "literal", - "value": null - }, - "defaultValue": "null" - }, - { - "id": 442, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 649, - "character": 61 - } - ], - "type": { - "type": "literal", - "value": null - }, - "defaultValue": "null" - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 441, - 442 - ] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 443, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 439, - 443 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 444, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 445, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 656, - "character": 15 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 446, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 447, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - }, - { - "id": 448, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 656, - "character": 32 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - }, - "defaultValue": "session.user" - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 447, - 448 - ] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 449, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 656, - "character": 54 - } - ], - "type": { - "type": "literal", - "value": null - }, - "defaultValue": "null" - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 445, - 449 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 450, - "name": "_handleProviderSignIn", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 666, - "character": 10 - } - ], - "signatures": [ - { - "id": 451, - "name": "_handleProviderSignIn", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 452, - "name": "provider", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 501, - "name": "Provider" - } - }, - { - "id": 453, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 454, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 457, - "name": "queryParams", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 671, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 458, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 459, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 460, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 455, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 669, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 456, - "name": "scopes", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 670, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 457, - 455, - 456 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 461, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 462, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 683, - "character": 13 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 463, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 464, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "reference", - "id": 501, - "name": "Provider" - } - }, - { - "id": 465, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 464, - 465 - ] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 466, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 683, - "character": 38 - } - ], - "type": { - "type": "literal", - "value": null - }, - "defaultValue": "null" - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 462, - 466 - ] - } - ] - } - } - } - ] - }, - { - "id": 499, - "name": "_handleVisibilityChange", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 883, - "character": 10 - } - ], - "signatures": [ - { - "id": 500, - "name": "_handleVisibilityChange", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "literal", - "value": false - } - ] - } - } - ] - }, - { - "id": 483, - "name": "_notifyAllSubscribers", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 815, - "character": 10 - } - ], - "signatures": [ - { - "id": 484, - "name": "_notifyAllSubscribers", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 485, - "name": "event", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 502, - "name": "AuthChangeEvent" - } - }, - { - "id": 486, - "name": "session", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 529, - "name": "Session" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 490, - "name": "_persistSession", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 843, - "character": 10 - } - ], - "signatures": [ - { - "id": 491, - "name": "_persistSession", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 492, - "name": "currentSession", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 478, - "name": "_recoverAndRefresh", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 730, - "character": 16 - } - ], - "signatures": [ - { - "id": 479, - "name": "_recoverAndRefresh", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Recovers the session from LocalStorage and refreshes\nNote: this method is async to accommodate for AsyncStorage e.g. in React native." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "literal", - "value": null - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 493, - "name": "_removeSession", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 847, - "character": 16 - } - ], - "signatures": [ - { - "id": 494, - "name": "_removeSession", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 487, - "name": "_saveSession", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 823, - "character": 10 - } - ], - "signatures": [ - { - "id": 488, - "name": "_saveSession", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "set currentSession and currentUser\nprocess to _startAutoRefreshToken if possible" - }, - "parameters": [ - { - "id": 489, - "name": "session", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 495, - "name": "_startAutoRefreshToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 863, - "character": 10 - } - ], - "signatures": [ - { - "id": 496, - "name": "_startAutoRefreshToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Clear and re-create refresh token timer" - }, - "parameters": [ - { - "id": 497, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "time intervals in milliseconds\n" - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 498, - "name": "session", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 350, + "id": 146, "name": "getSession", "kind": 2048, "kindString": "Method", @@ -9252,19 +3235,19 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 341, + "line": 368, "character": 8 } ], "signatures": [ { - "id": 351, + "id": 147, "name": "getSession", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the session data, refreshing it if necessary." + "shortText": "Returns the session data, refreshing it if necessary.\nIf no session is detected, the session returned will be null." }, "type": { "type": "reference", @@ -9275,14 +3258,68 @@ { "type": "reflection", "declaration": { - "id": 352, + "id": 148, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "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": "reference", + "id": 307, + "name": "Session" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 151 + ] + } + ] + } + } + }, + { + "id": 152, "name": "error", "kind": 1024, "kindString": "Property", @@ -9290,7 +3327,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 344, + "line": 373, "character": 8 } ], @@ -9298,25 +3335,6 @@ "type": "literal", "value": null } - }, - { - "id": 353, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 343, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } } ], "groups": [ @@ -9324,8 +3342,8 @@ "title": "Properties", "kind": 1024, "children": [ - 354, - 353 + 149, + 152 ] } ] @@ -9334,14 +3352,67 @@ { "type": "reflection", "declaration": { - "id": 355, + "id": 153, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "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", @@ -9349,33 +3420,15 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 348, + "line": 379, "character": 8 } ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } - }, - { - "id": 356, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 347, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } } ], "groups": [ @@ -9383,8 +3436,8 @@ "title": "Properties", "kind": 1024, "children": [ - 357, - 356 + 154, + 157 ] } ] @@ -9393,14 +3446,67 @@ { "type": "reflection", "declaration": { - "id": 358, + "id": 158, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 360, + "id": 159, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 382, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 160, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 161, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 383, + "character": 10 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 161 + ] + } + ] + } + } + }, + { + "id": 162, "name": "error", "kind": 1024, "kindString": "Property", @@ -9408,25 +3514,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 352, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 359, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 351, + "line": 385, "character": 8 } ], @@ -9441,8 +3529,8 @@ "title": "Properties", "kind": 1024, "children": [ - 360, - 359 + 159, + 162 ] } ] @@ -9459,219 +3547,7 @@ ] }, { - "id": 393, - "name": "getSessionFromUrl", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 489, - "character": 8 - } - ], - "signatures": [ - { - "id": 394, - "name": "getSessionFromUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Gets the session data from a URL string" - }, - "parameters": [ - { - "id": 395, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 396, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 397, - "name": "storeSession", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optionally store the session in the browser\n" - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 489, - "character": 38 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 397 - ] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 398, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 400, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 492, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 399, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 491, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 400, - 399 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 401, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 403, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 494, - "character": 23 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 402, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 494, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 403, - 402 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 361, + "id": 163, "name": "getUser", "kind": 2048, "kindString": "Method", @@ -9679,203 +3555,45 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 391, + "line": 425, "character": 8 } ], "signatures": [ { - "id": 362, + "id": 164, "name": "getUser", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the user data, refreshing the session if necessary." + "shortText": "Gets the current user details if there is an existing session." }, + "parameters": [ + { + "id": 165, + "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": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 394, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 364, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 393, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 365, - 364 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 366, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 398, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 367, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 397, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 368, - 367 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 369, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 371, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 402, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 370, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 401, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 371, - 370 - ] - } - ] - } - } - ] + "type": "reference", + "id": 296, + "name": "UserResponse" } ], "qualifiedName": "Promise", @@ -9886,7 +3604,7 @@ ] }, { - "id": 408, + "id": 184, "name": "onAuthStateChange", "kind": 2048, "kindString": "Method", @@ -9894,13 +3612,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 573, + "line": 599, "character": 2 } ], "signatures": [ { - "id": 409, + "id": 185, "name": "onAuthStateChange", "kind": 4096, "kindString": "Call signature", @@ -9911,41 +3629,44 @@ }, "parameters": [ { - "id": 410, + "id": 186, "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": 411, + "id": 187, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 412, + "id": 188, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 413, + "id": 189, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 502, + "id": 269, "name": "AuthChangeEvent" } }, { - "id": 414, + "id": 190, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -9959,7 +3680,7 @@ }, { "type": "reference", - "id": 529, + "id": 307, "name": "Session" } ] @@ -9982,14 +3703,14 @@ { "type": "reflection", "declaration": { - "id": 415, + "id": 191, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 417, + "id": 193, "name": "error", "kind": 1024, "kindString": "Property", @@ -9997,7 +3718,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 576, + "line": 602, "character": 8 } ], @@ -10007,7 +3728,7 @@ } }, { - "id": 416, + "id": 192, "name": "subscription", "kind": 1024, "kindString": "Property", @@ -10015,13 +3736,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 575, + "line": 601, "character": 8 } ], "type": { "type": "reference", - "id": 592, + "id": 370, "name": "Subscription" } } @@ -10031,8 +3752,8 @@ "title": "Properties", "kind": 1024, "children": [ - 417, - 416 + 193, + 192 ] } ] @@ -10041,14 +3762,14 @@ { "type": "reflection", "declaration": { - "id": 418, + "id": 194, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 420, + "id": 196, "name": "error", "kind": 1024, "kindString": "Property", @@ -10056,18 +3777,18 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 578, + "line": 604, "character": 28 } ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } }, { - "id": 419, + "id": 195, "name": "subscription", "kind": 1024, "kindString": "Property", @@ -10075,7 +3796,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 578, + "line": 604, "character": 8 } ], @@ -10090,8 +3811,8 @@ "title": "Properties", "kind": 1024, "children": [ - 420, - 419 + 196, + 195 ] } ] @@ -10103,42 +3824,118 @@ ] }, { - "id": 381, - "name": "setSession", + "id": 197, + "name": "resetPasswordForEmail", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 455, + "line": 631, "character": 8 } ], "signatures": [ { - "id": 382, - "name": "setSession", + "id": 198, + "name": "resetPasswordForEmail", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the session data from refresh_token and returns current Session and Error" + "shortText": "Sends a reset request to an email address." }, "parameters": [ { - "id": 383, - "name": "refresh_token", + "id": 199, + "name": "email", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "a JWT token\n" + "shortText": "The email address of the user." }, "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 200, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 201, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 203, + "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": 635, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 202, + "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": 634, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 203, + 202 + ] + } + ] + } + }, + "defaultValue": "{}" } ], "type": { @@ -10150,14 +3947,38 @@ { "type": "reflection", "declaration": { - "id": 384, + "id": 204, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 386, + "id": 205, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 639, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 206, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + }, + { + "id": 207, "name": "error", "kind": 1024, "kindString": "Property", @@ -10165,84 +3986,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 458, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 385, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 457, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 386, - 385 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 387, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 389, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 460, - "character": 23 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 388, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 460, + "line": 640, "character": 8 } ], @@ -10257,8 +4001,8 @@ "title": "Properties", "kind": 1024, "children": [ - 389, - 388 + 205, + 207 ] } ] @@ -10267,14 +4011,32 @@ { "type": "reflection", "declaration": { - "id": 390, + "id": 208, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 392, + "id": 209, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 642, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 210, "name": "error", "kind": 1024, "kindString": "Property", @@ -10282,33 +4044,15 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 461, - "character": 23 + "line": 642, + "character": 20 } ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } - }, - { - "id": 391, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 461, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } } ], "groups": [ @@ -10316,8 +4060,8 @@ "title": "Properties", "kind": 1024, "children": [ - 392, - 391 + 209, + 210 ] } ] @@ -10334,7 +4078,62 @@ ] }, { - "id": 338, + "id": 169, + "name": "setSession", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 488, + "character": 8 + } + ], + "signatures": [ + { + "id": 170, + "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": 171, + "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": 270, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 133, "name": "signInWithOAuth", "kind": 2048, "kindString": "Method", @@ -10342,13 +4141,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 240, + "line": 264, "character": 8 } ], "signatures": [ { - "id": 339, + "id": 134, "name": "signInWithOAuth", "kind": 4096, "kindString": "Call signature", @@ -10358,14 +4157,14 @@ }, "parameters": [ { - "id": 340, + "id": 135, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 629, + "id": 406, "name": "SignInWithOAuthCredentials" } } @@ -10375,7 +4174,7 @@ "typeArguments": [ { "type": "reference", - "id": 516, + "id": 283, "name": "OAuthResponse" } ], @@ -10387,7 +4186,7 @@ ] }, { - "id": 341, + "id": 136, "name": "signInWithOtp", "kind": 2048, "kindString": "Method", @@ -10395,13 +4194,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 256, + "line": 276, "character": 8 } ], "signatures": [ { - "id": 342, + "id": 137, "name": "signInWithOtp", "kind": 4096, "kindString": "Call signature", @@ -10411,14 +4210,14 @@ }, "parameters": [ { - "id": 343, + "id": 138, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 618, + "id": 395, "name": "SignInWithPasswordlessCredentials" } } @@ -10428,7 +4227,7 @@ "typeArguments": [ { "type": "reference", - "id": 503, + "id": 270, "name": "AuthResponse" } ], @@ -10440,7 +4239,7 @@ ] }, { - "id": 335, + "id": 130, "name": "signInWithPassword", "kind": 2048, "kindString": "Method", @@ -10448,13 +4247,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 203, + "line": 216, "character": 8 } ], "signatures": [ { - "id": 336, + "id": 131, "name": "signInWithPassword", "kind": 4096, "kindString": "Call signature", @@ -10464,14 +4263,14 @@ }, "parameters": [ { - "id": 337, + "id": 132, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 607, + "id": 384, "name": "SignInWithPasswordCredentials" } } @@ -10481,7 +4280,7 @@ "typeArguments": [ { "type": "reference", - "id": 503, + "id": 270, "name": "AuthResponse" } ], @@ -10493,7 +4292,7 @@ ] }, { - "id": 404, + "id": 180, "name": "signOut", "kind": 2048, "kindString": "Method", @@ -10501,20 +4300,20 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 554, + "line": 579, "character": 8 } ], "signatures": [ { - "id": 405, + "id": 181, "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)`. There is no way to revoke a user's session JWT before it automatically expires\n" + "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", @@ -10522,14 +4321,14 @@ { "type": "reflection", "declaration": { - "id": 406, + "id": 182, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 407, + "id": 183, "name": "error", "kind": 1024, "kindString": "Property", @@ -10537,7 +4336,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 554, + "line": 579, "character": 29 } ], @@ -10550,7 +4349,7 @@ }, { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } ] @@ -10562,7 +4361,7 @@ "title": "Properties", "kind": 1024, "children": [ - 407 + 183 ] } ] @@ -10577,7 +4376,7 @@ ] }, { - "id": 327, + "id": 122, "name": "signUp", "kind": 2048, "kindString": "Method", @@ -10585,35 +4384,36 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 142, + "line": 151, "character": 8 } ], "signatures": [ { - "id": 328, + "id": 123, "name": "signUp", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new user." + "shortText": "Creates a new user.", + "returns": "A logged-in session if the server has \"autoconfirm\" ON" }, "parameters": [ { - "id": 329, + "id": 124, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 600, + "id": 378, "name": "UserCredentials" } }, { - "id": 330, + "id": 125, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -10621,24 +4421,27 @@ "type": { "type": "reflection", "declaration": { - "id": 331, + "id": 126, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 334, + "id": 129, "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/GoTrueClient.ts", - "line": 147, + "line": 156, "character": 6 } ], @@ -10648,7 +4451,7 @@ } }, { - "id": 333, + "id": 128, "name": "data", "kind": 1024, "kindString": "Property", @@ -10656,12 +4459,12 @@ "isOptional": true }, "comment": { - "shortText": "Optional user metadata.\n" + "shortText": "Optional user metadata." }, "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 146, + "line": 155, "character": 6 } ], @@ -10671,7 +4474,7 @@ } }, { - "id": 332, + "id": 127, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -10684,7 +4487,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 145, + "line": 154, "character": 6 } ], @@ -10699,9 +4502,9 @@ "title": "Properties", "kind": 1024, "children": [ - 334, - 333, - 332 + 129, + 128, + 127 ] } ] @@ -10715,7 +4518,7 @@ "typeArguments": [ { "type": "reference", - "id": 503, + "id": 270, "name": "AuthResponse" } ], @@ -10727,22 +4530,22 @@ ] }, { - "id": 372, - "name": "update", + "id": 166, + "name": "updateUser", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 420, + "line": 454, "character": 8 } ], "signatures": [ { - "id": 373, - "name": "update", + "id": 167, + "name": "updateUser", "kind": 4096, "kindString": "Call signature", "flags": {}, @@ -10751,14 +4554,14 @@ }, "parameters": [ { - "id": 374, + "id": 168, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 576, + "id": 354, "name": "UserAttributes" } } @@ -10767,127 +4570,9 @@ "type": "reference", "typeArguments": [ { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 375, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 377, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 423, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 376, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 422, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 377, - 376 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 378, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 380, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 425, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 379, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 425, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 380, - 379 - ] - } - ] - } - } - ] + "type": "reference", + "id": 296, + "name": "UserResponse" } ], "qualifiedName": "Promise", @@ -10898,22 +4583,22 @@ ] }, { - "id": 344, - "name": "verifyOTP", + "id": 139, + "name": "verifyOtp", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 295, + "line": 319, "character": 8 } ], "signatures": [ { - "id": 345, - "name": "verifyOTP", + "id": 140, + "name": "verifyOtp", "kind": 4096, "kindString": "Call signature", "flags": {}, @@ -10922,19 +4607,19 @@ }, "parameters": [ { - "id": 346, + "id": 141, "name": "params", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 640, - "name": "VerifyOTPParams" + "id": 417, + "name": "VerifyOtpParams" } }, { - "id": 347, + "id": 142, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -10942,14 +4627,37 @@ "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 143, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 145, + "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": 323, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 144, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -10957,12 +4665,12 @@ "isOptional": true }, "comment": { - "shortText": "A URL or mobile address to send the user to after they are confirmed.\n" + "shortText": "A URL to send the user to after they are confirmed." }, "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 298, + "line": 322, "character": 6 } ], @@ -10977,7 +4685,8 @@ "title": "Properties", "kind": 1024, "children": [ - 349 + 145, + 144 ] } ] @@ -10991,7 +4700,7 @@ "typeArguments": [ { "type": "reference", - "id": 503, + "id": 270, "name": "AuthResponse" } ], @@ -11008,74 +4717,52 @@ "title": "Constructors", "kind": 512, "children": [ - 297 + 82 ] }, { "title": "Properties", "kind": 1024, "children": [ - 317, - 320, - 319, - 325, - 321, - 324, - 326, - 323, - 322, - 318 + 102 ] }, { "title": "Methods", "kind": 2048, "children": [ - 480, - 421, - 424, - 467, - 431, - 450, - 499, - 483, - 490, - 478, - 493, - 487, - 495, - 350, - 393, - 361, - 408, - 381, - 338, - 341, - 335, - 404, - 327, - 372, - 344 + 146, + 163, + 184, + 197, + 169, + 133, + 136, + 130, + 180, + 122, + 166, + 139 ] } ], "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 60, + "line": 61, "character": 21 } ] }, { - "id": 582, + "id": 360, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 584, + "id": 362, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -11089,7 +4776,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 165, + "line": 187, "character": 2 } ], @@ -11099,7 +4786,7 @@ } }, { - "id": 591, + "id": 369, "name": "data", "kind": 1024, "kindString": "Property", @@ -11112,7 +4799,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 140, + "line": 162, "character": 2 } ], @@ -11122,12 +4809,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 581, + "id": 359, "name": "UserAttributes.data" } }, { - "id": 587, + "id": 365, "name": "email", "kind": 1024, "kindString": "Property", @@ -11140,7 +4827,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, + "line": 142, "character": 2 } ], @@ -11150,12 +4837,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 577, + "id": 355, "name": "UserAttributes.email" } }, { - "id": 590, + "id": 368, "name": "email_change_token", "kind": 1024, "kindString": "Property", @@ -11168,7 +4855,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 135, + "line": 157, "character": 2 } ], @@ -11178,12 +4865,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 580, + "id": 358, "name": "UserAttributes.email_change_token" } }, { - "id": 585, + "id": 363, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -11197,7 +4884,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 172, + "line": 194, "character": 2 } ], @@ -11207,7 +4894,7 @@ } }, { - "id": 589, + "id": 367, "name": "password", "kind": 1024, "kindString": "Property", @@ -11220,7 +4907,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 130, + "line": 152, "character": 2 } ], @@ -11230,12 +4917,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 579, + "id": 357, "name": "UserAttributes.password" } }, { - "id": 588, + "id": 366, "name": "phone", "kind": 1024, "kindString": "Property", @@ -11248,7 +4935,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 125, + "line": 147, "character": 2 } ], @@ -11258,12 +4945,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 578, + "id": 356, "name": "UserAttributes.phone" } }, { - "id": 586, + "id": 364, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -11277,7 +4964,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 179, + "line": 201, "character": 2 } ], @@ -11287,7 +4974,7 @@ } }, { - "id": 583, + "id": 361, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -11301,7 +4988,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 155, + "line": 177, "character": 2 } ], @@ -11316,176 +5003,53 @@ "title": "Properties", "kind": 1024, "children": [ - 584, - 591, - 587, - 590, - 585, - 589, - 588, - 586, - 583 + 362, + 369, + 365, + 368, + 363, + 367, + 366, + 364, + 361 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 143, + "line": 165, "character": 17 } ], "extendedTypes": [ { "type": "reference", - "id": 576, + "id": 354, "name": "UserAttributes" } ] }, { - "id": 653, - "name": "OpenIDConnectCredentials", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 657, - "name": "client_id", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 265, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 654, - "name": "id_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 262, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 658, - "name": "issuer", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 266, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 655, - "name": "nonce", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 263, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 656, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 264, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 501, - "name": "Provider" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 657, - 654, - 658, - 655, - 656 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 261, - "character": 17 - } - ] - }, - { - "id": 529, + "id": 307, "name": "Session", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 531, + "id": 309, "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": 62, + "line": 81, "character": 2 } ], @@ -11495,7 +5059,7 @@ } }, { - "id": 533, + "id": 312, "name": "expires_at", "kind": 1024, "kindString": "Property", @@ -11508,7 +5072,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 70, + "line": 93, "character": 2 } ], @@ -11518,20 +5082,18 @@ } }, { - "id": 532, + "id": 311, "name": "expires_in", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, + "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": 66, + "line": 89, "character": 2 } ], @@ -11541,7 +5103,7 @@ } }, { - "id": 530, + "id": 308, "name": "provider_token", "kind": 1024, "kindString": "Property", @@ -11551,7 +5113,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 61, + "line": 77, "character": 2 } ], @@ -11570,15 +5132,18 @@ } }, { - "id": 534, + "id": 310, "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": 71, + "line": 85, "character": 2 } ], @@ -11588,7 +5153,7 @@ } }, { - "id": 535, + "id": 313, "name": "token_type", "kind": 1024, "kindString": "Property", @@ -11596,7 +5161,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 72, + "line": 94, "character": 2 } ], @@ -11606,7 +5171,7 @@ } }, { - "id": 536, + "id": 314, "name": "user", "kind": 1024, "kindString": "Property", @@ -11614,13 +5179,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 73, + "line": 95, "character": 2 } ], "type": { "type": "reference", - "id": 548, + "id": 326, "name": "User" } } @@ -11630,63 +5195,66 @@ "title": "Properties", "kind": 1024, "children": [ - 531, - 533, - 532, - 530, - 534, - 535, - 536 + 309, + 312, + 311, + 308, + 310, + 313, + 314 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 60, + "line": 76, "character": 17 } ] }, { - "id": 633, + "id": 410, "name": "SignInWithOAuthOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 636, + "id": 413, "name": "queryParams", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "An object of query params" + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 242, + "line": 276, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 637, + "id": 414, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 638, + "id": 415, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 639, + "id": 416, "name": "key", "kind": 32768, "flags": {}, @@ -11705,17 +5273,20 @@ } }, { - "id": 634, + "id": 411, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "A URL to send the user to after they are confirmed (OAuth logins only)." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 240, + "line": 272, "character": 2 } ], @@ -11725,17 +5296,20 @@ } }, { - "id": 635, + "id": 412, "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": 241, + "line": 274, "character": 2 } ], @@ -11750,29 +5324,29 @@ "title": "Properties", "kind": 1024, "children": [ - 636, - 634, - 635 + 413, + 411, + 412 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 239, + "line": 270, "character": 17 } ] }, { - "id": 616, + "id": 393, "name": "SignInWithPasswordOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 617, + "id": 394, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -11782,7 +5356,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 218, + "line": 246, "character": 2 } ], @@ -11797,27 +5371,27 @@ "title": "Properties", "kind": 1024, "children": [ - 617 + 394 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 217, + "line": 245, "character": 17 } ] }, { - "id": 625, + "id": 402, "name": "SignInWithPasswordlessOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 628, + "id": 405, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -11827,7 +5401,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 233, + "line": 263, "character": 2 } ], @@ -11837,7 +5411,7 @@ } }, { - "id": 626, + "id": 403, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -11850,7 +5424,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 231, + "line": 261, "character": 2 } ], @@ -11860,7 +5434,7 @@ } }, { - "id": 627, + "id": 404, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -11870,7 +5444,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 232, + "line": 262, "character": 2 } ], @@ -11885,29 +5459,29 @@ "title": "Properties", "kind": 1024, "children": [ - 628, - 626, - 627 + 405, + 403, + 404 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 229, + "line": 259, "character": 17 } ] }, { - "id": 592, + "id": 370, "name": "Subscription", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 593, + "id": 371, "name": "id", "kind": 1024, "kindString": "Property", @@ -11918,7 +5492,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 186, + "line": 208, "character": 2 } ], @@ -11928,7 +5502,7 @@ } }, { - "id": 594, + "id": 372, "name": "callback", "kind": 2048, "kindString": "Method", @@ -11936,13 +5510,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 190, + "line": 212, "character": 2 } ], "signatures": [ { - "id": 595, + "id": 373, "name": "callback", "kind": 4096, "kindString": "Call signature", @@ -11952,19 +5526,19 @@ }, "parameters": [ { - "id": 596, + "id": 374, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 502, + "id": 269, "name": "AuthChangeEvent" } }, { - "id": 597, + "id": 375, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -11978,7 +5552,7 @@ }, { "type": "reference", - "id": 529, + "id": 307, "name": "Session" } ] @@ -11993,7 +5567,7 @@ ] }, { - "id": 598, + "id": 376, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -12001,13 +5575,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 194, + "line": 216, "character": 2 } ], "signatures": [ { - "id": 599, + "id": 377, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -12028,35 +5602,35 @@ "title": "Properties", "kind": 1024, "children": [ - 593 + 371 ] }, { "title": "Methods", "kind": 2048, "children": [ - 594, - 598 + 372, + 376 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 182, + "line": 204, "character": 17 } ] }, { - "id": 548, + "id": 326, "name": "User", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 565, + "id": 343, "name": "action_link", "kind": 1024, "kindString": "Property", @@ -12066,7 +5640,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 103, + "line": 125, "character": 2 } ], @@ -12076,7 +5650,7 @@ } }, { - "id": 550, + "id": 328, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -12084,21 +5658,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 90, + "line": 112, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 551, + "id": 329, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 552, + "id": 330, "name": "provider", "kind": 1024, "kindString": "Property", @@ -12108,7 +5682,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 91, + "line": 113, "character": 4 } ], @@ -12123,19 +5697,19 @@ "title": "Properties", "kind": 1024, "children": [ - 552 + 330 ] } ], "indexSignature": { - "id": 553, + "id": 331, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 554, + "id": 332, "name": "key", "kind": 32768, "flags": {}, @@ -12154,7 +5728,7 @@ } }, { - "id": 559, + "id": 337, "name": "aud", "kind": 1024, "kindString": "Property", @@ -12162,7 +5736,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 97, + "line": 119, "character": 2 } ], @@ -12172,7 +5746,7 @@ } }, { - "id": 560, + "id": 338, "name": "confirmation_sent_at", "kind": 1024, "kindString": "Property", @@ -12182,7 +5756,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 98, + "line": 120, "character": 2 } ], @@ -12192,13 +5766,816 @@ } }, { - "id": 569, + "id": 347, "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": 346, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 128, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 344, + "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": 340, + "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": 348, + "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": 327, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 111, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 353, + "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": 315, + "name": "UserIdentity" + } + } + }, + { + "id": 342, + "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": 350, + "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": 341, + "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": 345, + "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": 349, + "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": 339, + "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": 351, + "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": 352, + "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": 333, + "name": "user_metadata", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 116, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 334, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 335, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 336, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 343, + 328, + 337, + 338, + 347, + 346, + 344, + 340, + 348, + 327, + 353, + 342, + 350, + 341, + 345, + 349, + 339, + 351, + 352, + 333 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 110, + "character": 17 + } + ] + }, + { + "id": 354, + "name": "UserAttributes", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 359, + "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": 355, + "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": 358, + "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": 357, + "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": 356, + "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": [ + 359, + 355, + 358, + 357, + 356 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 138, + "character": 17 + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 360, + "name": "AdminUserAttributes" + } + ] + }, + { + "id": 378, + "name": "UserCredentials", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 379, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 221, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 381, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 225, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 380, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 223, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 383, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The name of the provider." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 228, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 268, + "name": "Provider" + } + }, + { + "id": 382, + "name": "refreshToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 226, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 379, + 381, + 380, + 383, + 382 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 219, + "character": 17 + } + ] + }, + { + "id": 315, + "name": "UserIdentity", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 323, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 105, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 316, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 99, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 318, + "name": "identity_data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 101, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 319, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 320, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 321, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 324, + "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": 322, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 104, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 325, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, "sources": [ { "fileName": "src/lib/types.ts", @@ -12212,51 +6589,11 @@ } }, { - "id": 568, - "name": "created_at", + "id": 317, + "name": "user_id", "kind": 1024, "kindString": "Property", "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 106, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 566, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 104, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 562, - "name": "email_change_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -12268,37 +6605,48 @@ "type": "intrinsic", "name": "string" } - }, + } + ], + "groups": [ { - "id": 570, - "name": "email_confirmed_at", + "title": "Properties", "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 108, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, + "children": [ + 323, + 316, + 318, + 324, + 322, + 325, + 317 + ] + } + ], + "sources": [ { - "id": 549, - "name": "id", + "fileName": "src/lib/types.ts", + "line": 98, + "character": 17 + } + ] + }, + { + "id": 423, + "name": "VerifyEmailOtpParams", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 424, + "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 89, + "line": 291, "character": 2 } ], @@ -12308,91 +6656,7 @@ } }, { - "id": 575, - "name": "identities", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 113, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 537, - "name": "UserIdentity" - } - } - }, - { - "id": 564, - "name": "invited_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 102, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 572, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 110, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 563, - "name": "new_email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 101, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 567, + "id": 425, "name": "phone", "kind": 1024, "kindString": "Property", @@ -12402,140 +6666,50 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 105, + "line": 292, "character": 2 } ], "type": { "type": "intrinsic", - "name": "string" + "name": "undefined" } }, { - "id": 571, - "name": "phone_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 109, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 561, - "name": "recovery_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 99, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 573, - "name": "role", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 111, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 574, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 112, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 555, - "name": "user_metadata", + "id": 426, + "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 94, + "line": 293, "character": 2 } ], "type": { - "type": "reflection", - "declaration": { - "id": 556, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 557, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 558, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 427, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 294, + "character": 2 } + ], + "type": { + "type": "reference", + "id": 429, + "name": "EmailOtpType" } } ], @@ -12544,69 +6718,30 @@ "title": "Properties", "kind": 1024, "children": [ - 565, - 550, - 559, - 560, - 569, - 568, - 566, - 562, - 570, - 549, - 575, - 564, - 572, - 563, - 567, - 571, - 561, - 573, - 574, - 555 + 424, + 425, + 426, + 427 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 88, + "line": 290, "character": 17 } ] }, { - "id": 576, - "name": "UserAttributes", + "id": 418, + "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 581, - "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": 140, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 577, + "id": 419, "name": "email", "kind": 1024, "kindString": "Property", @@ -12614,35 +6749,33 @@ "isOptional": true }, "comment": { - "shortText": "The user's email." + "shortText": "The user's email address." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, + "line": 282, "character": 2 } ], "type": { "type": "intrinsic", - "name": "string" + "name": "undefined" } }, { - "id": 580, - "name": "email_change_token", + "id": 420, + "name": "phone", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, + "flags": {}, "comment": { - "shortText": "An email change token." + "shortText": "The user's phone number." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 135, + "line": 284, "character": 2 } ], @@ -12652,20 +6785,18 @@ } }, { - "id": 579, - "name": "password", + "id": 421, + "name": "token", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, + "flags": {}, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 130, + "line": 286, "character": 2 } ], @@ -12675,480 +6806,25 @@ } }, { - "id": 578, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's phone." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 125, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 581, - 577, - 580, - 579, - 578 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 116, - "character": 17 - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 582, - "name": "AdminUserAttributes" - } - ] - }, - { - "id": 600, - "name": "UserCredentials", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 601, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 198, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 606, - "name": "oidc", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 204, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 653, - "name": "OpenIDConnectCredentials" - } - }, - { - "id": 603, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 200, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 602, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 199, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 605, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The name of the provider." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 203, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 501, - "name": "Provider" - } - }, - { - "id": 604, - "name": "refreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 201, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 601, - 606, - 603, - 602, - 605, - 604 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 197, - "character": 17 - } - ] - }, - { - "id": 537, - "name": "UserIdentity", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 545, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 83, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 538, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "identity_data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 79, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 541, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 542, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 543, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 546, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 84, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 544, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 82, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 539, - "name": "user_id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 78, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 545, - 538, - 540, - 546, - 544, - 547, - 539 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 76, - "character": 17 - } - ] - }, - { - "id": 646, - "name": "VerifyEmailOTPParams", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 647, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 253, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 648, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 254, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 649, - "name": "token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 255, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 650, + "id": 422, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's verification type." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 256, + "line": 288, "character": 2 } ], "type": { "type": "reference", - "id": 652, - "name": "EmailOTPType" + "id": 428, + "name": "MobileOtpType" } } ], @@ -13157,128 +6833,23 @@ "title": "Properties", "kind": 1024, "children": [ - 647, - 648, - 649, - 650 + 419, + 420, + 421, + 422 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 252, + "line": 280, "character": 17 } ] }, { - "id": 641, - "name": "VerifyMobileOTPParams", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 642, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 247, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 643, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 248, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 644, - "name": "token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 249, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 645, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 250, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 651, - "name": "MobileOTPType" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 642, - 643, - 644, - 645 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 246, - "character": 17 - } - ] - }, - { - "id": 502, + "id": 269, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -13286,7 +6857,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 21, + "line": 22, "character": 12 } ], @@ -13321,7 +6892,7 @@ } }, { - "id": 503, + "id": 270, "name": "AuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -13329,7 +6900,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 29, + "line": 30, "character": 12 } ], @@ -13339,14 +6910,14 @@ { "type": "reflection", "declaration": { - "id": 504, + "id": 271, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 505, + "id": 272, "name": "data", "kind": 1024, "kindString": "Property", @@ -13354,25 +6925,53 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 31, + "line": 32, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 506, + "id": 273, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 508, + "id": 275, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 34, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 307, + "name": "Session" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 274, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -13385,35 +6984,7 @@ "types": [ { "type": "reference", - "id": 529, - "name": "Session" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 507, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 32, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 548, + "id": 326, "name": "User" }, { @@ -13429,15 +7000,15 @@ "title": "Properties", "kind": 1024, "children": [ - 508, - 507 + 275, + 274 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 31, + "line": 32, "character": 12 } ] @@ -13445,7 +7016,7 @@ } }, { - "id": 509, + "id": 276, "name": "error", "kind": 1024, "kindString": "Property", @@ -13453,7 +7024,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 35, + "line": 36, "character": 6 } ], @@ -13468,15 +7039,15 @@ "title": "Properties", "kind": 1024, "children": [ - 505, - 509 + 272, + 276 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 30, + "line": 31, "character": 4 } ] @@ -13485,14 +7056,14 @@ { "type": "reflection", "declaration": { - "id": 510, + "id": 277, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 511, + "id": 278, "name": "data", "kind": 1024, "kindString": "Property", @@ -13500,25 +7071,43 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 38, + "line": 39, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 512, + "id": 279, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 514, + "id": 281, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 41, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 280, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -13530,24 +7119,6 @@ "type": "literal", "value": null } - }, - { - "id": 513, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 39, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } } ], "groups": [ @@ -13555,15 +7126,15 @@ "title": "Properties", "kind": 1024, "children": [ - 514, - 513 + 281, + 280 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 38, + "line": 39, "character": 12 } ] @@ -13571,7 +7142,7 @@ } }, { - "id": 515, + "id": 282, "name": "error", "kind": 1024, "kindString": "Property", @@ -13579,13 +7150,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 42, + "line": 43, "character": 6 } ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } } @@ -13595,15 +7166,15 @@ "title": "Properties", "kind": 1024, "children": [ - 511, - 515 + 278, + 282 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 37, + "line": 38, "character": 4 } ] @@ -13613,7 +7184,7 @@ } }, { - "id": 660, + "id": 432, "name": "CallRefreshTokenResult", "kind": 4194304, "kindString": "Type alias", @@ -13621,7 +7192,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 280, + "line": 320, "character": 12 } ], @@ -13631,14 +7202,14 @@ { "type": "reflection", "declaration": { - "id": 661, + "id": 433, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 663, + "id": 435, "name": "error", "kind": 1024, "kindString": "Property", @@ -13646,7 +7217,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 283, + "line": 323, "character": 6 } ], @@ -13656,7 +7227,7 @@ } }, { - "id": 662, + "id": 434, "name": "session", "kind": 1024, "kindString": "Property", @@ -13664,13 +7235,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 282, + "line": 322, "character": 6 } ], "type": { "type": "reference", - "id": 529, + "id": 307, "name": "Session" } } @@ -13680,15 +7251,15 @@ "title": "Properties", "kind": 1024, "children": [ - 663, - 662 + 435, + 434 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 281, + "line": 321, "character": 4 } ] @@ -13697,14 +7268,14 @@ { "type": "reflection", "declaration": { - "id": 664, + "id": 436, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 666, + "id": 438, "name": "error", "kind": 1024, "kindString": "Property", @@ -13712,18 +7283,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 287, + "line": 327, "character": 6 } ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } }, { - "id": 665, + "id": 437, "name": "session", "kind": 1024, "kindString": "Property", @@ -13731,7 +7302,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 286, + "line": 326, "character": 6 } ], @@ -13746,15 +7317,15 @@ "title": "Properties", "kind": 1024, "children": [ - 666, - 665 + 438, + 437 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 285, + "line": 325, "character": 4 } ] @@ -13764,15 +7335,15 @@ } }, { - "id": 652, - "name": "EmailOTPType", + "id": 429, + "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 259, + "line": 298, "character": 12 } ], @@ -13803,15 +7374,61 @@ } }, { - "id": 651, - "name": "MobileOTPType", + "id": 430, + "name": "GenerateLinkTypes", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "shortText": "The link type" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 301, + "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": 428, + "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 258, + "line": 297, "character": 12 } ], @@ -13830,7 +7447,7 @@ } }, { - "id": 516, + "id": 283, "name": "OAuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -13838,7 +7455,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 45, + "line": 46, "character": 12 } ], @@ -13848,14 +7465,14 @@ { "type": "reflection", "declaration": { - "id": 517, + "id": 284, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 518, + "id": 285, "name": "data", "kind": 1024, "kindString": "Property", @@ -13863,21 +7480,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 47, + "line": 48, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 519, + "id": 286, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 520, + "id": 287, "name": "provider", "kind": 1024, "kindString": "Property", @@ -13885,18 +7502,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 48, + "line": 49, "character": 8 } ], "type": { "type": "reference", - "id": 501, + "id": 268, "name": "Provider" } }, { - "id": 521, + "id": 288, "name": "url", "kind": 1024, "kindString": "Property", @@ -13904,7 +7521,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 49, + "line": 50, "character": 8 } ], @@ -13919,15 +7536,15 @@ "title": "Properties", "kind": 1024, "children": [ - 520, - 521 + 287, + 288 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 47, + "line": 48, "character": 12 } ] @@ -13935,7 +7552,7 @@ } }, { - "id": 522, + "id": 289, "name": "error", "kind": 1024, "kindString": "Property", @@ -13943,7 +7560,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 51, + "line": 52, "character": 6 } ], @@ -13958,15 +7575,15 @@ "title": "Properties", "kind": 1024, "children": [ - 518, - 522 + 285, + 289 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 46, + "line": 47, "character": 4 } ] @@ -13975,14 +7592,14 @@ { "type": "reflection", "declaration": { - "id": 523, + "id": 290, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 524, + "id": 291, "name": "data", "kind": 1024, "kindString": "Property", @@ -13990,21 +7607,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 525, + "id": 292, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 526, + "id": 293, "name": "provider", "kind": 1024, "kindString": "Property", @@ -14012,18 +7629,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 55, + "line": 56, "character": 8 } ], "type": { "type": "reference", - "id": 501, + "id": 268, "name": "Provider" } }, { - "id": 527, + "id": 294, "name": "url", "kind": 1024, "kindString": "Property", @@ -14031,7 +7648,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 56, + "line": 57, "character": 8 } ], @@ -14046,15 +7663,15 @@ "title": "Properties", "kind": 1024, "children": [ - 526, - 527 + 293, + 294 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 12 } ] @@ -14062,7 +7679,7 @@ } }, { - "id": 528, + "id": 295, "name": "error", "kind": 1024, "kindString": "Property", @@ -14070,13 +7687,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 58, + "line": 59, "character": 6 } ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } } @@ -14086,15 +7703,15 @@ "title": "Properties", "kind": 1024, "children": [ - 524, - 528 + 291, + 295 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 53, + "line": 54, "character": 4 } ] @@ -14104,15 +7721,18 @@ } }, { - "id": 501, + "id": 268, "name": "Provider", "kind": 4194304, "kindString": "Type alias", "flags": {}, + "comment": { + "shortText": "One of the providers supported by GoTrue." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 3, + "line": 4, "character": 12 } ], @@ -14187,7 +7807,7 @@ } }, { - "id": 629, + "id": 406, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -14195,21 +7815,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 235, + "line": 265, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 630, + "id": 407, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 632, + "id": 409, "name": "options", "kind": 1024, "kindString": "Property", @@ -14219,32 +7839,35 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 237, + "line": 268, "character": 2 } ], "type": { "type": "reference", - "id": 633, + "id": 410, "name": "SignInWithOAuthOptions" } }, { - "id": 631, + "id": 408, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "One of the providers supported by GoTrue." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 236, + "line": 267, "character": 2 } ], "type": { "type": "reference", - "id": 501, + "id": 268, "name": "Provider" } } @@ -14254,15 +7877,15 @@ "title": "Properties", "kind": 1024, "children": [ - 632, - 631 + 409, + 408 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 235, + "line": 265, "character": 41 } ] @@ -14270,7 +7893,7 @@ } }, { - "id": 607, + "id": 384, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -14278,7 +7901,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 206, + "line": 230, "character": 12 } ], @@ -14288,22 +7911,25 @@ { "type": "reflection", "declaration": { - "id": 608, + "id": 385, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 609, + "id": 386, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's email address." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 208, + "line": 233, "character": 6 } ], @@ -14313,7 +7939,7 @@ } }, { - "id": 611, + "id": 388, "name": "options", "kind": 1024, "kindString": "Property", @@ -14323,26 +7949,29 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 210, + "line": 236, "character": 6 } ], "type": { "type": "reference", - "id": 616, + "id": 393, "name": "SignInWithPasswordOptions" } }, { - "id": 610, + "id": 387, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's password." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 209, + "line": 235, "character": 6 } ], @@ -14357,16 +7986,16 @@ "title": "Properties", "kind": 1024, "children": [ - 609, - 611, - 610 + 386, + 388, + 387 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 207, + "line": 231, "character": 4 } ] @@ -14375,14 +8004,14 @@ { "type": "reflection", "declaration": { - "id": 612, + "id": 389, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 615, + "id": 392, "name": "options", "kind": 1024, "kindString": "Property", @@ -14392,26 +8021,29 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 215, + "line": 243, "character": 6 } ], "type": { "type": "reference", - "id": 616, + "id": 393, "name": "SignInWithPasswordOptions" } }, { - "id": 614, + "id": 391, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's password." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 214, + "line": 242, "character": 6 } ], @@ -14421,15 +8053,18 @@ } }, { - "id": 613, + "id": 390, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 213, + "line": 240, "character": 6 } ], @@ -14444,16 +8079,16 @@ "title": "Properties", "kind": 1024, "children": [ - 615, - 614, - 613 + 392, + 391, + 390 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 212, + "line": 238, "character": 4 } ] @@ -14463,7 +8098,7 @@ } }, { - "id": 618, + "id": 395, "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", @@ -14471,7 +8106,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 220, + "line": 248, "character": 12 } ], @@ -14481,22 +8116,25 @@ { "type": "reflection", "declaration": { - "id": 619, + "id": 396, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 620, + "id": 397, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's email address." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 222, + "line": 251, "character": 6 } ], @@ -14506,7 +8144,7 @@ } }, { - "id": 621, + "id": 398, "name": "options", "kind": 1024, "kindString": "Property", @@ -14516,13 +8154,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 223, + "line": 252, "character": 6 } ], "type": { "type": "reference", - "id": 625, + "id": 402, "name": "SignInWithPasswordlessOptions" } } @@ -14532,15 +8170,15 @@ "title": "Properties", "kind": 1024, "children": [ - 620, - 621 + 397, + 398 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 221, + "line": 249, "character": 4 } ] @@ -14549,14 +8187,14 @@ { "type": "reflection", "declaration": { - "id": 622, + "id": 399, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 624, + "id": 401, "name": "options", "kind": 1024, "kindString": "Property", @@ -14566,26 +8204,29 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 227, + "line": 257, "character": 6 } ], "type": { "type": "reference", - "id": 625, + "id": 402, "name": "SignInWithPasswordlessOptions" } }, { - "id": 623, + "id": 400, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 226, + "line": 256, "character": 6 } ], @@ -14600,15 +8241,15 @@ "title": "Properties", "kind": 1024, "children": [ - 624, - 623 + 401, + 400 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 225, + "line": 254, "character": 4 } ] @@ -14618,7 +8259,7 @@ } }, { - "id": 659, + "id": 431, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -14626,7 +8267,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 278, + "line": 318, "character": 12 } ], @@ -14669,15 +8310,250 @@ } }, { - "id": 640, - "name": "VerifyOTPParams", + "id": 296, + "name": "UserResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 245, + "line": 62, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "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": 64, + "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": 65, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 326, + "name": "User" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 300 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 64, + "character": 12 + } + ] + } + } + }, + { + "id": 301, + "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": [ + 298, + 301 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 63, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 302, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 303, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 70, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 304, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 305, + "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": [ + 305 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 70, + "character": 12 + } + ] + } + } + }, + { + "id": 306, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 73, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 442, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 303, + 306 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 69, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 417, + "name": "VerifyOtpParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 279, "character": 12 } ], @@ -14686,19 +8562,19 @@ "types": [ { "type": "reference", - "id": 641, - "name": "VerifyMobileOTPParams" + "id": 418, + "name": "VerifyMobileOtpParams" }, { "type": "reference", - "id": 646, - "name": "VerifyEmailOTPParams" + "id": 423, + "name": "VerifyEmailOtpParams" } ] } }, { - "id": 667, + "id": 439, "name": "isAuthError", "kind": 64, "kindString": "Function", @@ -14712,14 +8588,14 @@ ], "signatures": [ { - "id": 668, + "id": 440, "name": "isAuthError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 669, + "id": 441, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -14736,7 +8612,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } } @@ -14749,59 +8625,60 @@ "title": "Classes", "kind": 128, "children": [ - 675, - 670, - 722, - 735, - 710, - 688, - 695, + 447, + 442, + 494, + 507, + 482, + 460, + 467, 1, - 296 + 81 ] }, { "title": "Interfaces", "kind": 256, "children": [ - 582, - 653, - 529, - 633, - 616, - 625, - 592, - 548, - 576, - 600, - 537, - 646, - 641 + 360, + 307, + 410, + 393, + 402, + 370, + 326, + 354, + 378, + 315, + 423, + 418 ] }, { "title": "Type Aliases", "kind": 4194304, "children": [ - 502, - 503, - 660, - 652, - 651, - 516, - 501, - 629, - 607, - 618, - 659, - 640 + 269, + 270, + 432, + 429, + 430, + 428, + 283, + 268, + 406, + 384, + 395, + 431, + 296, + 417 ] }, { "title": "Functions", "kind": 64, "children": [ - 667 + 439 ] } ], diff --git a/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json b/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json index 07985054fc8..f06e90f80a8 100644 --- a/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json +++ b/spec/enrichments/tsdoc_v2/gotrue_dereferenced.json @@ -7,14 +7,14 @@ "originalName": "", "children": [ { - "id": 675, + "id": 447, "name": "AuthApiError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 676, + "id": 448, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -28,14 +28,14 @@ ], "signatures": [ { - "id": 677, + "id": 449, "name": "new AuthApiError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 678, + "id": 450, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -46,7 +46,7 @@ } }, { - "id": 679, + "id": 451, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -59,50 +59,24 @@ ], "type": { "type": "reference", - "id": 675, + "id": 447, "name": "AuthApiError" }, "overwrites": { "type": "reference", - "id": 672, + "id": 444, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 671, + "id": 443, "name": "AuthError.constructor" } }, { - "id": 687, - "name": "__isAuthError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "id": 674, - "name": "AuthError.__isAuthError" - } - }, - { - "id": 680, + "id": 452, "name": "status", "kind": 1024, "kindString": "Property", @@ -120,7 +94,7 @@ } }, { - "id": 681, + "id": 453, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -134,7 +108,7 @@ ], "signatures": [ { - "id": 682, + "id": 454, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -142,14 +116,14 @@ "type": { "type": "reflection", "declaration": { - "id": 683, + "id": 455, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 685, + "id": 457, "name": "message", "kind": 1024, "kindString": "Property", @@ -168,7 +142,7 @@ "defaultValue": "..." }, { - "id": 684, + "id": 456, "name": "name", "kind": 1024, "kindString": "Property", @@ -187,7 +161,7 @@ "defaultValue": "..." }, { - "id": 686, + "id": 458, "name": "status", "kind": 1024, "kindString": "Property", @@ -211,9 +185,9 @@ "title": "Properties", "kind": 1024, "children": [ - 685, - 684, - 686 + 457, + 456, + 458 ] } ] @@ -228,22 +202,21 @@ "title": "Constructors", "kind": 512, "children": [ - 676 + 448 ] }, { "title": "Properties", "kind": 1024, "children": [ - 687, - 680 + 452 ] }, { "title": "Methods", "kind": 2048, "children": [ - 681 + 453 ] } ], @@ -257,20 +230,20 @@ "extendedTypes": [ { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } ] }, { - "id": 670, + "id": 442, "name": "AuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 671, + "id": 443, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -284,14 +257,14 @@ ], "signatures": [ { - "id": 672, + "id": 444, "name": "new AuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 673, + "id": 445, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -304,7 +277,7 @@ ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" }, "overwrites": { @@ -317,27 +290,6 @@ "type": "reference", "name": "Error.constructor" } - }, - { - "id": 674, - "name": "__isAuthError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" } ], "groups": [ @@ -345,14 +297,7 @@ "title": "Constructors", "kind": 512, "children": [ - 671 - ] - }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 674 + 443 ] } ], @@ -374,30 +319,30 @@ "extendedBy": [ { "type": "reference", - "id": 675, + "id": 447, "name": "AuthApiError" }, { "type": "reference", - "id": 688, + "id": 460, "name": "AuthUnknownError" }, { "type": "reference", - "id": 695, + "id": 467, "name": "CustomAuthError" } ] }, { - "id": 722, + "id": 494, "name": "AuthInvalidCredentialsError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 723, + "id": 495, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -411,14 +356,14 @@ ], "signatures": [ { - "id": 724, + "id": 496, "name": "new AuthInvalidCredentialsError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 725, + "id": 497, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -431,50 +376,24 @@ ], "type": { "type": "reference", - "id": 722, + "id": 494, "name": "AuthInvalidCredentialsError" }, "overwrites": { "type": "reference", - "id": 697, + "id": 469, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 696, + "id": 468, "name": "CustomAuthError.constructor" } }, { - "id": 734, - "name": "__isAuthError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "id": 709, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 726, + "id": 498, "name": "name", "kind": 1024, "kindString": "Property", @@ -492,12 +411,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 701, + "id": 473, "name": "CustomAuthError.name" } }, { - "id": 727, + "id": 499, "name": "status", "kind": 1024, "kindString": "Property", @@ -515,12 +434,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 702, + "id": 474, "name": "CustomAuthError.status" } }, { - "id": 728, + "id": 500, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -534,7 +453,7 @@ ], "signatures": [ { - "id": 729, + "id": 501, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -542,14 +461,14 @@ "type": { "type": "reflection", "declaration": { - "id": 730, + "id": 502, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 732, + "id": 504, "name": "message", "kind": 1024, "kindString": "Property", @@ -568,7 +487,7 @@ "defaultValue": "..." }, { - "id": 731, + "id": 503, "name": "name", "kind": 1024, "kindString": "Property", @@ -587,7 +506,7 @@ "defaultValue": "..." }, { - "id": 733, + "id": 505, "name": "status", "kind": 1024, "kindString": "Property", @@ -611,9 +530,9 @@ "title": "Properties", "kind": 1024, "children": [ - 732, - 731, - 733 + 504, + 503, + 505 ] } ] @@ -621,14 +540,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 704, + "id": 476, "name": "CustomAuthError.toJSON" } } ], "inheritedFrom": { "type": "reference", - "id": 703, + "id": 475, "name": "CustomAuthError.toJSON" } } @@ -638,23 +557,22 @@ "title": "Constructors", "kind": 512, "children": [ - 723 + 495 ] }, { "title": "Properties", "kind": 1024, "children": [ - 734, - 726, - 727 + 498, + 499 ] }, { "title": "Methods", "kind": 2048, "children": [ - 728 + 500 ] } ], @@ -668,20 +586,20 @@ "extendedTypes": [ { "type": "reference", - "id": 695, + "id": 467, "name": "CustomAuthError" } ] }, { - "id": 735, + "id": 507, "name": "AuthRetryableFetchError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 736, + "id": 508, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -695,14 +613,14 @@ ], "signatures": [ { - "id": 737, + "id": 509, "name": "new AuthRetryableFetchError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 738, + "id": 510, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -713,7 +631,7 @@ } }, { - "id": 739, + "id": 511, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -726,50 +644,24 @@ ], "type": { "type": "reference", - "id": 735, + "id": 507, "name": "AuthRetryableFetchError" }, "overwrites": { "type": "reference", - "id": 697, + "id": 469, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 696, + "id": 468, "name": "CustomAuthError.constructor" } }, { - "id": 748, - "name": "__isAuthError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "id": 709, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 740, + "id": 512, "name": "name", "kind": 1024, "kindString": "Property", @@ -787,12 +679,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 701, + "id": 473, "name": "CustomAuthError.name" } }, { - "id": 741, + "id": 513, "name": "status", "kind": 1024, "kindString": "Property", @@ -810,12 +702,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 702, + "id": 474, "name": "CustomAuthError.status" } }, { - "id": 742, + "id": 514, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -829,7 +721,7 @@ ], "signatures": [ { - "id": 743, + "id": 515, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -837,14 +729,14 @@ "type": { "type": "reflection", "declaration": { - "id": 744, + "id": 516, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 746, + "id": 518, "name": "message", "kind": 1024, "kindString": "Property", @@ -863,7 +755,7 @@ "defaultValue": "..." }, { - "id": 745, + "id": 517, "name": "name", "kind": 1024, "kindString": "Property", @@ -882,7 +774,7 @@ "defaultValue": "..." }, { - "id": 747, + "id": 519, "name": "status", "kind": 1024, "kindString": "Property", @@ -906,9 +798,9 @@ "title": "Properties", "kind": 1024, "children": [ - 746, - 745, - 747 + 518, + 517, + 519 ] } ] @@ -916,14 +808,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 704, + "id": 476, "name": "CustomAuthError.toJSON" } } ], "inheritedFrom": { "type": "reference", - "id": 703, + "id": 475, "name": "CustomAuthError.toJSON" } } @@ -933,23 +825,22 @@ "title": "Constructors", "kind": 512, "children": [ - 736 + 508 ] }, { "title": "Properties", "kind": 1024, "children": [ - 748, - 740, - 741 + 512, + 513 ] }, { "title": "Methods", "kind": 2048, "children": [ - 742 + 514 ] } ], @@ -963,20 +854,20 @@ "extendedTypes": [ { "type": "reference", - "id": 695, + "id": 467, "name": "CustomAuthError" } ] }, { - "id": 710, + "id": 482, "name": "AuthSessionMissingError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 711, + "id": 483, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -990,57 +881,31 @@ ], "signatures": [ { - "id": 712, + "id": 484, "name": "new AuthSessionMissingError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "type": { "type": "reference", - "id": 710, + "id": 482, "name": "AuthSessionMissingError" }, "overwrites": { "type": "reference", - "id": 697, + "id": 469, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 696, + "id": 468, "name": "CustomAuthError.constructor" } }, { - "id": 721, - "name": "__isAuthError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "id": 709, - "name": "CustomAuthError.__isAuthError" - } - }, - { - "id": 713, + "id": 485, "name": "name", "kind": 1024, "kindString": "Property", @@ -1058,12 +923,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 701, + "id": 473, "name": "CustomAuthError.name" } }, { - "id": 714, + "id": 486, "name": "status", "kind": 1024, "kindString": "Property", @@ -1081,12 +946,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 702, + "id": 474, "name": "CustomAuthError.status" } }, { - "id": 715, + "id": 487, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -1100,7 +965,7 @@ ], "signatures": [ { - "id": 716, + "id": 488, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -1108,14 +973,14 @@ "type": { "type": "reflection", "declaration": { - "id": 717, + "id": 489, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 719, + "id": 491, "name": "message", "kind": 1024, "kindString": "Property", @@ -1134,7 +999,7 @@ "defaultValue": "..." }, { - "id": 718, + "id": 490, "name": "name", "kind": 1024, "kindString": "Property", @@ -1153,7 +1018,7 @@ "defaultValue": "..." }, { - "id": 720, + "id": 492, "name": "status", "kind": 1024, "kindString": "Property", @@ -1177,9 +1042,9 @@ "title": "Properties", "kind": 1024, "children": [ - 719, - 718, - 720 + 491, + 490, + 492 ] } ] @@ -1187,14 +1052,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 704, + "id": 476, "name": "CustomAuthError.toJSON" } } ], "inheritedFrom": { "type": "reference", - "id": 703, + "id": 475, "name": "CustomAuthError.toJSON" } } @@ -1204,23 +1069,22 @@ "title": "Constructors", "kind": 512, "children": [ - 711 + 483 ] }, { "title": "Properties", "kind": 1024, "children": [ - 721, - 713, - 714 + 485, + 486 ] }, { "title": "Methods", "kind": 2048, "children": [ - 715 + 487 ] } ], @@ -1234,20 +1098,20 @@ "extendedTypes": [ { "type": "reference", - "id": 695, + "id": 467, "name": "CustomAuthError" } ] }, { - "id": 688, + "id": 460, "name": "AuthUnknownError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 689, + "id": 461, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1261,14 +1125,14 @@ ], "signatures": [ { - "id": 690, + "id": 462, "name": "new AuthUnknownError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 691, + "id": 463, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1279,7 +1143,7 @@ } }, { - "id": 692, + "id": 464, "name": "originalError", "kind": 32768, "kindString": "Parameter", @@ -1292,50 +1156,24 @@ ], "type": { "type": "reference", - "id": 688, + "id": 460, "name": "AuthUnknownError" }, "overwrites": { "type": "reference", - "id": 672, + "id": 444, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 671, + "id": 443, "name": "AuthError.constructor" } }, { - "id": 694, - "name": "__isAuthError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "id": 674, - "name": "AuthError.__isAuthError" - } - }, - { - "id": 693, + "id": 465, "name": "originalError", "kind": 1024, "kindString": "Property", @@ -1358,15 +1196,14 @@ "title": "Constructors", "kind": 512, "children": [ - 689 + 461 ] }, { "title": "Properties", "kind": 1024, "children": [ - 694, - 693 + 465 ] } ], @@ -1380,20 +1217,20 @@ "extendedTypes": [ { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } ] }, { - "id": 695, + "id": 467, "name": "CustomAuthError", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 696, + "id": 468, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1407,14 +1244,14 @@ ], "signatures": [ { - "id": 697, + "id": 469, "name": "new CustomAuthError", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "parameters": [ { - "id": 698, + "id": 470, "name": "message", "kind": 32768, "kindString": "Parameter", @@ -1425,7 +1262,7 @@ } }, { - "id": 699, + "id": 471, "name": "name", "kind": 32768, "kindString": "Parameter", @@ -1436,7 +1273,7 @@ } }, { - "id": 700, + "id": 472, "name": "status", "kind": 32768, "kindString": "Parameter", @@ -1449,50 +1286,24 @@ ], "type": { "type": "reference", - "id": 695, + "id": 467, "name": "CustomAuthError" }, "overwrites": { "type": "reference", - "id": 672, + "id": 444, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", - "id": 671, + "id": 443, "name": "AuthError.constructor" } }, { - "id": 709, - "name": "__isAuthError", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/lib/errors.ts", - "line": 2, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true", - "inheritedFrom": { - "type": "reference", - "id": 674, - "name": "AuthError.__isAuthError" - } - }, - { - "id": 701, + "id": 473, "name": "name", "kind": 1024, "kindString": "Property", @@ -1514,7 +1325,7 @@ } }, { - "id": 702, + "id": 474, "name": "status", "kind": 1024, "kindString": "Property", @@ -1532,7 +1343,7 @@ } }, { - "id": 703, + "id": 475, "name": "toJSON", "kind": 2048, "kindString": "Method", @@ -1546,7 +1357,7 @@ ], "signatures": [ { - "id": 704, + "id": 476, "name": "toJSON", "kind": 4096, "kindString": "Call signature", @@ -1554,14 +1365,14 @@ "type": { "type": "reflection", "declaration": { - "id": 705, + "id": 477, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 707, + "id": 479, "name": "message", "kind": 1024, "kindString": "Property", @@ -1580,7 +1391,7 @@ "defaultValue": "..." }, { - "id": 706, + "id": 478, "name": "name", "kind": 1024, "kindString": "Property", @@ -1599,7 +1410,7 @@ "defaultValue": "..." }, { - "id": 708, + "id": 480, "name": "status", "kind": 1024, "kindString": "Property", @@ -1623,9 +1434,9 @@ "title": "Properties", "kind": 1024, "children": [ - 707, - 706, - 708 + 479, + 478, + 480 ] } ] @@ -1640,23 +1451,22 @@ "title": "Constructors", "kind": 512, "children": [ - 696 + 468 ] }, { "title": "Properties", "kind": 1024, "children": [ - 709, - 701, - 702 + 473, + 474 ] }, { "title": "Methods", "kind": 2048, "children": [ - 703 + 475 ] } ], @@ -1670,31 +1480,31 @@ "extendedTypes": [ { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } ], "extendedBy": [ { "type": "reference", - "id": 710, + "id": 482, "name": "AuthSessionMissingError" }, { "type": "reference", - "id": 722, + "id": 494, "name": "AuthInvalidCredentialsError" }, { "type": "reference", - "id": 735, + "id": 507, "name": "AuthRetryableFetchError" } ] }, { "id": 1, - "name": "GoTrueApi", + "name": "GoTrueAdminApi", "kind": 128, "kindString": "Class", "flags": {}, @@ -1707,15 +1517,15 @@ "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 21, + "fileName": "src/GoTrueAdminApi.ts", + "line": 13, "character": 2 } ], "signatures": [ { "id": 3, - "name": "new GoTrueApi", + "name": "new GoTrueAdminApi", "kind": 16384, "kindString": "Constructor signature", "flags": {}, @@ -1745,8 +1555,8 @@ }, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 30, + "fileName": "src/GoTrueAdminApi.ts", + "line": 22, "character": 4 } ], @@ -1835,8 +1645,8 @@ }, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 27, + "fileName": "src/GoTrueAdminApi.ts", + "line": 19, "character": 4 } ], @@ -1882,8 +1692,8 @@ "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 26, + "fileName": "src/GoTrueAdminApi.ts", + "line": 18, "character": 4 } ], @@ -1917,265 +1727,48 @@ ] }, { - "id": 21, - "name": "fetch", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 19, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 22, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "signatures": [ - { - "id": 23, - "name": "__type", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 24, - "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": 25, - "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": 17, - "name": "headers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 16, - "character": 12 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 18, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 19, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 20, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 16, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 15, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 26, - "name": "_createRequestHeaders", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 42, - "character": 10 - } - ], - "signatures": [ - { - "id": 27, - "name": "_createRequestHeaders", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Create a temporary object with all configured headers and\nadds the Authorization token to be used on request methods" - }, - "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": "reflection", - "declaration": { - "id": 29, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - } - ] - }, - { - "id": 230, + "id": 56, "name": "createUser", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 669, + "fileName": "src/GoTrueAdminApi.ts", + "line": 128, "character": 8 } ], "signatures": [ { - "id": 231, + "id": 57, "name": "createUser", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new user.", - "text": "This function should only be called on a server. Never expose your `service_role` key in the browser.\n" + "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": 232, + "id": 58, "name": "attributes", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The data you want to create the user with.\n" - }, "type": { "type": "reference", - "id": 582, + "id": 360, "name": "AdminUserAttributes", "dereferenced": { - "id": 582, + "id": 360, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 584, + "id": 362, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -2189,7 +1782,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 165, + "line": 187, "character": 2 } ], @@ -2199,7 +1792,7 @@ } }, { - "id": 591, + "id": 369, "name": "data", "kind": 1024, "kindString": "Property", @@ -2212,7 +1805,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 140, + "line": 162, "character": 2 } ], @@ -2222,12 +1815,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 581, + "id": 359, "name": "UserAttributes.data" } }, { - "id": 587, + "id": 365, "name": "email", "kind": 1024, "kindString": "Property", @@ -2240,7 +1833,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, + "line": 142, "character": 2 } ], @@ -2250,12 +1843,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 577, + "id": 355, "name": "UserAttributes.email" } }, { - "id": 590, + "id": 368, "name": "email_change_token", "kind": 1024, "kindString": "Property", @@ -2268,7 +1861,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 135, + "line": 157, "character": 2 } ], @@ -2278,12 +1871,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 580, + "id": 358, "name": "UserAttributes.email_change_token" } }, { - "id": 585, + "id": 363, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -2297,7 +1890,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 172, + "line": 194, "character": 2 } ], @@ -2307,7 +1900,7 @@ } }, { - "id": 589, + "id": 367, "name": "password", "kind": 1024, "kindString": "Property", @@ -2320,7 +1913,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 130, + "line": 152, "character": 2 } ], @@ -2330,12 +1923,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 579, + "id": 357, "name": "UserAttributes.password" } }, { - "id": 588, + "id": 366, "name": "phone", "kind": 1024, "kindString": "Property", @@ -2348,7 +1941,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 125, + "line": 147, "character": 2 } ], @@ -2358,12 +1951,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 578, + "id": 356, "name": "UserAttributes.phone" } }, { - "id": 586, + "id": 364, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -2377,7 +1970,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 179, + "line": 201, "character": 2 } ], @@ -2387,7 +1980,7 @@ } }, { - "id": 583, + "id": 361, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -2401,7 +1994,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 155, + "line": 177, "character": 2 } ], @@ -2416,29 +2009,29 @@ "title": "Properties", "kind": 1024, "children": [ - 584, - 591, - 587, - 590, - 585, - 589, - 588, - 586, - 583 + 362, + 369, + 365, + 368, + 363, + 367, + 366, + 364, + 361 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 143, + "line": 165, "character": 17 } ], "extendedTypes": [ { "type": "reference", - "id": 576, + "id": 354, "name": "UserAttributes" } ] @@ -2450,166 +2043,9 @@ "type": "reference", "typeArguments": [ { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 233, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 235, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 672, - "character": 18 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - }, - { - "id": 236, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 672, - "character": 30 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 234, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 672, - "character": 6 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 235, - 236, - 234 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 237, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 239, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 672, - "character": 60 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 240, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 672, - "character": 72 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 238, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 672, - "character": 48 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 239, - 240, - 238 - ] - } - ] - } - } - ] + "type": "reference", + "id": 296, + "name": "UserResponse" } ], "qualifiedName": "Promise", @@ -2620,38 +2056,37 @@ ] }, { - "id": 268, + "id": 78, "name": "deleteUser", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 771, + "fileName": "src/GoTrueAdminApi.ts", + "line": 218, "character": 8 } ], "signatures": [ { - "id": 269, + "id": 79, "name": "deleteUser", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Delete a user. Requires a `service_role` key.", - "text": "This function should only be called on a server. Never expose your `service_role` key in the browser.\n" + "shortText": "Delete a user. Requires a `service_role` key." }, "parameters": [ { - "id": 270, + "id": 80, "name": "uid", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The user uid you want to remove.\n" + "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", @@ -2663,127 +2098,9 @@ "type": "reference", "typeArguments": [ { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 271, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 273, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 774, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 272, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 773, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 273, - 272 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 274, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 276, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 776, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 275, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 776, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 276, - 275 - ] - } - ] - } - } - ] + "type": "reference", + "id": 296, + "name": "UserResponse" } ], "qualifiedName": "Promise", @@ -2794,21 +2111,21 @@ ] }, { - "id": 212, + "id": 38, "name": "generateLink", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 618, + "fileName": "src/GoTrueAdminApi.ts", + "line": 85, "character": 8 } ], "signatures": [ { - "id": 213, + "id": 39, "name": "generateLink", "kind": 4096, "kindString": "Call signature", @@ -2818,38 +2135,65 @@ }, "parameters": [ { - "id": 214, + "id": 40, "name": "type", "kind": 32768, "kindString": "Parameter", "flags": {}, - "comment": { - "shortText": "The link type (\"signup\" or \"magiclink\" or \"recovery\" or \"invite\")." - }, "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "signup" + "type": "reference", + "id": 430, + "name": "GenerateLinkTypes", + "dereferenced": { + "id": 430, + "name": "GenerateLinkTypes", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "shortText": "The link type" }, - { - "type": "literal", - "value": "invite" - }, - { - "type": "literal", - "value": "magiclink" - }, - { - "type": "literal", - "value": "recovery" + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 301, + "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": 215, + "id": 41, "name": "email", "kind": 32768, "kindString": "Parameter", @@ -2863,7 +2207,7 @@ } }, { - "id": 216, + "id": 42, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -2871,14 +2215,14 @@ "type": { "type": "reflection", "declaration": { - "id": 217, + "id": 43, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 219, + "id": 45, "name": "data", "kind": 1024, "kindString": "Property", @@ -2890,8 +2234,8 @@ }, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 623, + "fileName": "src/GoTrueAdminApi.ts", + "line": 90, "character": 6 } ], @@ -2901,7 +2245,7 @@ } }, { - "id": 218, + "id": 44, "name": "password", "kind": 1024, "kindString": "Property", @@ -2913,8 +2257,8 @@ }, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 622, + "fileName": "src/GoTrueAdminApi.ts", + "line": 89, "character": 6 } ], @@ -2924,7 +2268,7 @@ } }, { - "id": 220, + "id": 46, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -2932,3192 +2276,15 @@ "isOptional": true }, "comment": { - "shortText": "The link type (\"signup\" or \"magiclink\" or \"recovery\" or \"invite\").\n" + "shortText": "The redirect url which should be appended to the generated link\n" }, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 624, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 219, - 218, - 220 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 221, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 222, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 628, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - }, - { - "id": 223, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 629, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 222, - 223 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 224, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 225, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 632, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - }, - { - "id": 226, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 633, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 225, - 226 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 227, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 228, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 635, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 229, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 635, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 228, - 229 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 30, - "name": "getUrlForProvider", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 54, - "character": 2 - } - ], - "signatures": [ - { - "id": 31, - "name": "getUrlForProvider", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Generates the relevant login URL for a third-party provider." - }, - "parameters": [ - { - "id": 32, - "name": "provider", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "One of the providers supported by GoTrue." - }, - "type": { - "type": "reference", - "id": 501, - "name": "Provider", - "dereferenced": { - "id": 501, - "name": "Provider", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 3, - "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": 33, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 34, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 37, - "name": "queryParams", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 59, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 38, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 39, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 40, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 35, - "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/GoTrueApi.ts", - "line": 57, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 36, - "name": "scopes", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A space-separated list of scopes granted to the OAuth application.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 58, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 37, - 35, - 36 - ] - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 277, - "name": "getUser", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 806, - "character": 8 - } - ], - "signatures": [ - { - "id": 278, - "name": "getUser", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Gets the current user details.", - "text": "This method is called by the GoTrueClient `update` where\nthe jwt is set to this.currentSession.access_token\nand therefore, acts like getting the currently authenticated user\n" - }, - "parameters": [ - { - "id": 279, - "name": "jwt", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A valid, logged-in JWT. Typically, the access_token for the currentSession\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 280, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 282, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 809, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 281, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 808, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 282, - 281 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 283, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 285, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 811, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 284, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 811, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 285, - 284 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 249, - "name": "getUserById", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 715, - "character": 8 - } - ], - "signatures": [ - { - "id": 250, - "name": "getUserById", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Get user by id." - }, - "parameters": [ - { - "id": 251, - "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": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 252, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 254, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 717, - "character": 27 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 253, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 717, - "character": 15 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 254, - 253 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 255, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 257, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 717, - "character": 57 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 256, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 717, - "character": 45 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 257, - 256 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 176, - "name": "inviteUserByEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 505, - "character": 8 - } - ], - "signatures": [ - { - "id": 177, - "name": "inviteUserByEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends an invite link to an email address." - }, - "parameters": [ - { - "id": 178, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 179, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 180, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 182, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional user metadata\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 509, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 181, - "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/GoTrueApi.ts", - "line": 508, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 182, - 181 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 183, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 185, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 514, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 184, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 513, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 185, - 184 - ] - } - ] - } - }, - { - "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/GoTrueApi.ts", - "line": 516, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 187, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 516, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 188, - 187 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 241, - "name": "listUsers", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 693, - "character": 8 - } - ], - "signatures": [ - { - "id": 242, - "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": 243, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 245, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 693, - "character": 46 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 244, - "name": "users", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 693, - "character": 31 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 548, - "name": "User" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 245, - 244 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 246, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 248, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 693, - "character": 77 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 247, - "name": "users", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 693, - "character": 64 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 248, - 247 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 203, - "name": "refreshAccessToken", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 584, - "character": 8 - } - ], - "signatures": [ - { - "id": 204, - "name": "refreshAccessToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Generates a new JWT." - }, - "parameters": [ - { - "id": 205, - "name": "refreshToken", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A valid refresh token that was returned on login.\n" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 206, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 208, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 587, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 207, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 586, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 208, - 207 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 209, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 211, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 589, - "character": 23 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 210, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 589, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 211, - 210 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 189, - "name": "resetPasswordForEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 545, - "character": 8 - } - ], - "signatures": [ - { - "id": 190, - "name": "resetPasswordForEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a reset request to an email address." - }, - "parameters": [ - { - "id": 191, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 192, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 193, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 195, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 549, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 194, - "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.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 548, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 195, - 194 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 196, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 197, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 553, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 198, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 199, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 554, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 197, - 199 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 200, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 201, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 556, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 202, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 556, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 201, - 202 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 111, - "name": "sendMagicLinkEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 307, - "character": 8 - } - ], - "signatures": [ - { - "id": 112, - "name": "sendMagicLinkEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a magic login link to an email address." - }, - "parameters": [ - { - "id": 113, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 114, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 115, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 118, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 312, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 117, - "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.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 311, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 116, - "name": "shouldCreateUser", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A boolean flag to indicate whether to automatically create a user on magiclink / otp sign-ins if the user doesn't exist. Defaults to true." - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 310, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 118, - 117, - 116 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 119, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 120, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 316, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 121, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 122, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 317, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 120, - 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/GoTrueApi.ts", - "line": 319, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 125, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 319, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 124, - 125 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 126, - "name": "sendMobileOTP", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 354, - "character": 8 - } - ], - "signatures": [ - { - "id": 127, - "name": "sendMobileOTP", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Sends a mobile OTP via SMS. Will register the account if it doesn't already exist" - }, - "parameters": [ - { - "id": 128, - "name": "phone", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The user's phone number WITH international prefix" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 129, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 130, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 132, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 358, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 131, - "name": "shouldCreateUser", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "A boolean flag to indicate whether to automatically create a user on magiclink / otp sign-ins if the user doesn't exist. Defaults to true.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 357, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 132, - 131 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 133, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 134, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 362, - "character": 8 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 135, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {} - } - } - }, - { - "id": 136, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 363, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 134, - 136 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 137, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 138, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 365, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 139, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 365, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 138, - 139 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 59, - "name": "signInWithEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 140, - "character": 8 - } - ], - "signatures": [ - { - "id": 60, - "name": "signInWithEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs in an existing user using their email address." - }, - "parameters": [ - { - "id": 61, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 62, - "name": "password", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The password of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 63, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 64, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 65, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 144, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 65 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "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/GoTrueApi.ts", - "line": 148, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - }, - { - "id": 68, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 149, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 67, - 68 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 69, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 70, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 151, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 71, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 151, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 70, - 71 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 102, - "name": "signInWithOpenIDConnect", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 267, - "character": 8 - } - ], - "signatures": [ - { - "id": 103, - "name": "signInWithOpenIDConnect", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs in an OpenID Connect user using their id_token." - }, - "parameters": [ - { - "id": 104, - "name": "__namedParameters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 653, - "name": "OpenIDConnectCredentials", - "dereferenced": { - "id": 653, - "name": "OpenIDConnectCredentials", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 657, - "name": "client_id", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 265, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 654, - "name": "id_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 262, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 658, - "name": "issuer", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 266, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 655, - "name": "nonce", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 263, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 656, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 264, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 501, - "name": "Provider" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 657, - 654, - 658, - 655, - 656 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 261, - "character": 17 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 105, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 107, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 276, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 106, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 275, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 107, - 106 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 108, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 110, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 278, - "character": 23 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 109, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 278, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 110, - 109 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 89, - "name": "signInWithPhone", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 227, - "character": 8 - } - ], - "signatures": [ - { - "id": 90, - "name": "signInWithPhone", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Logs in an existing user using their phone number and password." - }, - "parameters": [ - { - "id": 91, - "name": "phone", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The phone number of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 92, - "name": "password", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The password of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 93, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 94, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 95, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Verification token received when the user completes the captcha on your site.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 231, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 95 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 96, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 98, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 236, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 97, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 235, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 98, - 97 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 99, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 101, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 238, - "character": 23 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 100, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 238, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 101, - 100 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 140, - "name": "signOut", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 394, - "character": 8 - } - ], - "signatures": [ - { - "id": 141, - "name": "signOut", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Removes a logged-in session." - }, - "parameters": [ - { - "id": 142, - "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": 143, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 144, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 394, - "character": 40 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 670, - "name": "AuthError" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 144 - ] - } - ] - } - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 41, - "name": "signUpWithEmail", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 86, - "character": 8 - } - ], - "signatures": [ - { - "id": 42, - "name": "signUpWithEmail", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Creates a new user using their email address.", - "returns": "A logged-in session if the server has \"autoconfirm\" ON" - }, - "parameters": [ - { - "id": 43, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The email address of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 44, - "name": "password", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The password of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 45, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 46, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 49, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 92, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 48, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional user metadata.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", + "fileName": "src/GoTrueAdminApi.ts", "line": 91, "character": 6 } ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 47, - "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/GoTrueApi.ts", - "line": 90, - "character": 6 - } - ], "type": { "type": "intrinsic", "name": "string" @@ -6129,9 +2296,9 @@ "title": "Properties", "kind": 1024, "children": [ - 49, - 48, - 47 + 45, + 44, + 46 ] } ] @@ -6146,6 +2313,65 @@ { "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": 326, + "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": { @@ -6163,15 +2389,15 @@ "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 96, + "fileName": "src/GoTrueAdminApi.ts", + "line": 99, "character": 8 } ], "type": { "type": "reference", - "id": 548, - "name": "User" + "id": 307, + "name": "Session" } }, { @@ -6182,8 +2408,8 @@ "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 97, + "fileName": "src/GoTrueAdminApi.ts", + "line": 100, "character": 8 } ], @@ -6222,15 +2448,14 @@ "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 100, + "fileName": "src/GoTrueAdminApi.ts", + "line": 102, "character": 8 } ], "type": { - "type": "reference", - "id": 529, - "name": "Session" + "type": "literal", + "value": null } }, { @@ -6241,14 +2466,15 @@ "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 101, - "character": 8 + "fileName": "src/GoTrueAdminApi.ts", + "line": 102, + "character": 20 } ], "type": { - "type": "literal", - "value": null + "type": "reference", + "id": 442, + "name": "AuthError" } } ], @@ -6263,65 +2489,6 @@ } ] } - }, - { - "type": "reflection", - "declaration": { - "id": 56, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 57, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 103, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 58, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 103, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 57, - 58 - ] - } - ] - } } ] } @@ -6334,37 +2501,92 @@ ] }, { - "id": 72, - "name": "signUpWithPhone", + "id": 71, + "name": "getUserById", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 178, + "fileName": "src/GoTrueAdminApi.ts", + "line": 173, "character": 8 } ], "signatures": [ { - "id": 73, - "name": "signUpWithPhone", + "id": 72, + "name": "getUserById", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Signs up a new user using their phone number and a password." + "shortText": "Get user by id." }, "parameters": [ { - "id": 74, - "name": "phone", + "id": 73, + "name": "uid", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The phone number of the user." + "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": 296, + "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", @@ -6372,21 +2594,7 @@ } }, { - "id": 75, - "name": "password", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The password of the user." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 76, + "id": 34, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -6394,34 +2602,14 @@ "type": { "type": "reflection", "declaration": { - "id": 77, + "id": 35, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 79, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 183, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 78, + "id": 37, "name": "data", "kind": 1024, "kindString": "Property", @@ -6429,12 +2617,12 @@ "isOptional": true }, "comment": { - "shortText": "Optional user metadata.\n" + "shortText": "Optional user metadata\n" }, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 182, + "fileName": "src/GoTrueAdminApi.ts", + "line": 59, "character": 6 } ], @@ -6442,6 +2630,29 @@ "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": [ @@ -6449,8 +2660,8 @@ "title": "Properties", "kind": 1024, "children": [ - 79, - 78 + 37, + 36 ] } ] @@ -6463,186 +2674,9 @@ "type": "reference", "typeArguments": [ { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 80, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 81, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 187, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - }, - { - "id": 82, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 188, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 81, - 82 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 83, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 84, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 191, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - }, - { - "id": 85, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 192, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 84, - 85 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 86, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 87, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 194, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 88, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 194, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 87, - 88 - ] - } - ] - } - } - ] + "type": "reference", + "id": 296, + "name": "UserResponse" } ], "qualifiedName": "Promise", @@ -6653,210 +2687,29 @@ ] }, { - "id": 286, - "name": "updateUser", + "id": 59, + "name": "listUsers", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 832, + "fileName": "src/GoTrueAdminApi.ts", + "line": 149, "character": 8 } ], "signatures": [ { - "id": 287, - "name": "updateUser", + "id": 60, + "name": "listUsers", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Updates the user data." + "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" }, - "parameters": [ - { - "id": 288, - "name": "jwt", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "A valid, logged-in JWT." - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 289, - "name": "attributes", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The data you want to update.\n" - }, - "type": { - "type": "reference", - "id": 576, - "name": "UserAttributes", - "dereferenced": { - "id": 576, - "name": "UserAttributes", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 581, - "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": 140, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 577, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's email." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 120, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 580, - "name": "email_change_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "An email change token." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 135, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 579, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's password." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 130, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 578, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's phone." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 125, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 581, - 577, - 580, - 579, - 578 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 116, - "character": 17 - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 582, - "name": "AdminUserAttributes" - } - ] - } - } - } - ], "type": { "type": "reference", "typeArguments": [ @@ -6866,48 +2719,86 @@ { "type": "reflection", "declaration": { - "id": 290, + "id": 61, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 292, + "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": 326, + "name": "User" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 64 + ] + } + ] + } + } + }, + { + "id": 65, "name": "error", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 838, - "character": 8 + "fileName": "src/GoTrueAdminApi.ts", + "line": 150, + "character": 31 } ], "type": { "type": "literal", "value": null } - }, - { - "id": 291, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 837, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } } ], "groups": [ @@ -6915,8 +2806,8 @@ "title": "Properties", "kind": 1024, "children": [ - 292, - 291 + 62, + 65 ] } ] @@ -6925,48 +2816,82 @@ { "type": "reflection", "declaration": { - "id": 293, + "id": 66, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 295, + "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/GoTrueApi.ts", - "line": 840, - "character": 20 + "fileName": "src/GoTrueAdminApi.ts", + "line": 150, + "character": 70 } ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } - }, - { - "id": 294, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 840, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } } ], "groups": [ @@ -6974,8 +2899,8 @@ "title": "Properties", "kind": 1024, "children": [ - 295, - 294 + 67, + 70 ] } ] @@ -6992,21 +2917,120 @@ ] }, { - "id": 258, + "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": 442, + "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/GoTrueApi.ts", - "line": 739, + "fileName": "src/GoTrueAdminApi.ts", + "line": 195, "character": 8 } ], "signatures": [ { - "id": 259, + "id": 75, "name": "updateUserById", "kind": 4096, "kindString": "Call signature", @@ -7016,7 +3040,7 @@ }, "parameters": [ { - "id": 260, + "id": 76, "name": "uid", "kind": 32768, "kindString": "Parameter", @@ -7027,7 +3051,7 @@ } }, { - "id": 261, + "id": 77, "name": "attributes", "kind": 32768, "kindString": "Parameter", @@ -7037,17 +3061,17 @@ }, "type": { "type": "reference", - "id": 582, + "id": 360, "name": "AdminUserAttributes", "dereferenced": { - "id": 582, + "id": 360, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 584, + "id": 362, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -7061,7 +3085,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 165, + "line": 187, "character": 2 } ], @@ -7071,7 +3095,7 @@ } }, { - "id": 591, + "id": 369, "name": "data", "kind": 1024, "kindString": "Property", @@ -7084,7 +3108,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 140, + "line": 162, "character": 2 } ], @@ -7094,12 +3118,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 581, + "id": 359, "name": "UserAttributes.data" } }, { - "id": 587, + "id": 365, "name": "email", "kind": 1024, "kindString": "Property", @@ -7112,7 +3136,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, + "line": 142, "character": 2 } ], @@ -7122,12 +3146,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 577, + "id": 355, "name": "UserAttributes.email" } }, { - "id": 590, + "id": 368, "name": "email_change_token", "kind": 1024, "kindString": "Property", @@ -7140,7 +3164,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 135, + "line": 157, "character": 2 } ], @@ -7150,12 +3174,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 580, + "id": 358, "name": "UserAttributes.email_change_token" } }, { - "id": 585, + "id": 363, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -7169,7 +3193,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 172, + "line": 194, "character": 2 } ], @@ -7179,7 +3203,7 @@ } }, { - "id": 589, + "id": 367, "name": "password", "kind": 1024, "kindString": "Property", @@ -7192,7 +3216,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 130, + "line": 152, "character": 2 } ], @@ -7202,12 +3226,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 579, + "id": 357, "name": "UserAttributes.password" } }, { - "id": 588, + "id": 366, "name": "phone", "kind": 1024, "kindString": "Property", @@ -7220,7 +3244,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 125, + "line": 147, "character": 2 } ], @@ -7230,12 +3254,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 578, + "id": 356, "name": "UserAttributes.phone" } }, { - "id": 586, + "id": 364, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -7249,7 +3273,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 179, + "line": 201, "character": 2 } ], @@ -7259,7 +3283,7 @@ } }, { - "id": 583, + "id": 361, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -7273,7 +3297,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 155, + "line": 177, "character": 2 } ], @@ -7288,29 +3312,29 @@ "title": "Properties", "kind": 1024, "children": [ - 584, - 591, - 587, - 590, - 585, - 589, - 588, - 586, - 583 + 362, + 369, + 365, + 368, + 363, + 367, + 366, + 364, + 361 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 143, + "line": 165, "character": 17 } ], "extendedTypes": [ { "type": "reference", - "id": 576, + "id": 354, "name": "UserAttributes" } ] @@ -7322,741 +3346,9 @@ "type": "reference", "typeArguments": [ { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 262, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 264, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 745, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 263, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 744, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 264, - 263 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 265, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 267, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 747, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 266, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 747, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 267, - 266 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 145, - "name": "verifyMobileOTP", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 418, - "character": 8 - } - ], - "signatures": [ - { - "id": 146, - "name": "verifyMobileOTP", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "tags": [ - { - "tag": "deprecated", - "text": "Use `verifyOTP` instead!" - } - ] - }, - "parameters": [ - { - "id": 147, - "name": "phone", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The user's phone number WITH international prefix" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 148, - "name": "token", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "token that user was sent to their mobile phone" - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 149, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 150, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 151, - "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.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 422, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 151 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 152, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 153, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 426, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - }, - { - "id": 154, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 427, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 153, - 154 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 155, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 156, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 430, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - }, - { - "id": 157, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 431, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 156, - 157 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 158, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 159, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 433, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 160, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 433, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 159, - 160 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 161, - "name": "verifyOTP", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 463, - "character": 8 - } - ], - "signatures": [ - { - "id": 162, - "name": "verifyOTP", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Send User supplied Email / Mobile OTP to be verified" - }, - "parameters": [ - { - "id": 163, - "name": "__namedParameters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { "type": "reference", - "id": 640, - "name": "VerifyOTPParams", - "dereferenced": { - "id": 640, - "name": "VerifyOTPParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 245, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 641, - "name": "VerifyMobileOTPParams" - }, - { - "type": "reference", - "id": 646, - "name": "VerifyEmailOTPParams" - } - ] - } - } - } - }, - { - "id": 164, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 165, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 166, - "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.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 466, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 166 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 167, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 168, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 470, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - }, - { - "id": 169, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 471, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 168, - 169 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 170, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 171, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 474, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - }, - { - "id": 172, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 475, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 171, - 172 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 173, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 174, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 477, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 175, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueApi.ts", - "line": 477, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 174, - 175 - ] - } - ] - } - } - ] + "id": 296, + "name": "UserResponse" } ], "qualifiedName": "Promise", @@ -8075,62 +3367,38 @@ 2 ] }, - { - "title": "Properties", - "kind": 1024, - "children": [ - 21, - 17, - 16 - ] - }, { "title": "Methods", "kind": 2048, "children": [ - 26, - 230, - 268, - 212, - 30, - 277, - 249, - 176, - 241, - 203, - 189, - 111, - 126, + 56, + 78, + 38, + 71, + 31, 59, - 102, - 89, - 140, - 41, - 72, - 286, - 258, - 145, - 161 + 26, + 74 ] } ], "sources": [ { - "fileName": "src/GoTrueApi.ts", - "line": 14, + "fileName": "src/GoTrueAdminApi.ts", + "line": 6, "character": 21 } ] }, { - "id": 296, + "id": 81, "name": "GoTrueClient", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 297, + "id": 82, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -8138,13 +3406,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 98, + "line": 104, "character": 2 } ], "signatures": [ { - "id": 298, + "id": 83, "name": "new GoTrueClient", "kind": 16384, "kindString": "Constructor signature", @@ -8154,7 +3422,7 @@ }, "parameters": [ { - "id": 299, + "id": 84, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -8162,14 +3430,14 @@ "type": { "type": "reflection", "declaration": { - "id": 300, + "id": 85, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 308, + "id": 93, "name": "autoRefreshToken", "kind": 1024, "kindString": "Property", @@ -8182,7 +3450,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 103, + "line": 109, "character": 4 } ], @@ -8192,7 +3460,7 @@ } }, { - "id": 307, + "id": 92, "name": "detectSessionInUrl", "kind": 1024, "kindString": "Property", @@ -8205,7 +3473,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 102, + "line": 108, "character": 4 } ], @@ -8215,7 +3483,7 @@ } }, { - "id": 312, + "id": 97, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -8225,21 +3493,21 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 107, + "line": 113, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 313, + "id": 98, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 314, + "id": 99, "name": "__type", "kind": 4096, "kindString": "Call signature", @@ -8249,7 +3517,7 @@ }, "parameters": [ { - "id": 315, + "id": 100, "name": "input", "kind": 32768, "kindString": "Parameter", @@ -8273,7 +3541,7 @@ } }, { - "id": 316, + "id": 101, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -8308,7 +3576,7 @@ } }, { - "id": 302, + "id": 87, "name": "headers", "kind": 1024, "kindString": "Property", @@ -8321,27 +3589,27 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 100, + "line": 106, "character": 4 } ], "type": { "type": "reflection", "declaration": { - "id": 303, + "id": 88, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 304, + "id": 89, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 305, + "id": 90, "name": "key", "kind": 32768, "flags": {}, @@ -8360,7 +3628,7 @@ } }, { - "id": 311, + "id": 96, "name": "multiTab", "kind": 1024, "kindString": "Property", @@ -8373,7 +3641,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 106, + "line": 112, "character": 4 } ], @@ -8383,7 +3651,7 @@ } }, { - "id": 309, + "id": 94, "name": "persistSession", "kind": 1024, "kindString": "Property", @@ -8396,7 +3664,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 104, + "line": 110, "character": 4 } ], @@ -8406,7 +3674,7 @@ } }, { - "id": 310, + "id": 95, "name": "storage", "kind": 1024, "kindString": "Property", @@ -8416,7 +3684,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 105, + "line": 111, "character": 4 } ], @@ -8459,7 +3727,7 @@ } }, { - "id": 306, + "id": 91, "name": "storageKey", "kind": 1024, "kindString": "Property", @@ -8472,7 +3740,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 101, + "line": 107, "character": 4 } ], @@ -8482,7 +3750,7 @@ } }, { - "id": 301, + "id": 86, "name": "url", "kind": 1024, "kindString": "Property", @@ -8495,7 +3763,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 99, + "line": 105, "character": 4 } ], @@ -8510,15 +3778,15 @@ "title": "Properties", "kind": 1024, "children": [ - 308, - 307, - 312, - 302, - 311, - 309, - 310, - 306, - 301 + 93, + 92, + 97, + 87, + 96, + 94, + 95, + 91, + 86 ] } ] @@ -8528,25 +3796,25 @@ ], "type": { "type": "reference", - "id": 296, + "id": 81, "name": "default" } } ] }, { - "id": 317, - "name": "api", + "id": 102, + "name": "admin", "kind": 1024, "kindString": "Property", "flags": {}, "comment": { - "shortText": "Namespace for the GoTrue API methods.\nThese can be used for example to get a user from a JWT in a server environment or reset a user's password." + "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": 65, + "line": 66, "character": 2 } ], @@ -8557,2424 +3825,7 @@ } }, { - "id": 320, - "name": "autoRefreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 77, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 319, - "name": "inMemorySession", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "comment": { - "shortText": "The session object for the currently logged in user or null.\nOnly used if persistSession is false." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 75, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 529, - "name": "Session" - } - ] - } - }, - { - "id": 325, - "name": "networkRetries", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 83, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 321, - "name": "persistSession", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 78, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 324, - "name": "refreshTokenTimer", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true, - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 81, - "character": 12 - } - ], - "type": { - "type": "reference", - "qualifiedName": "global.NodeJS.Timeout", - "package": "@types/node", - "name": "Timeout" - } - }, - { - "id": 326, - "name": "refreshingDeferred", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 84, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 660, - "name": "CallRefreshTokenResult" - } - ], - "name": "Deferred" - } - ] - }, - "defaultValue": "null" - }, - { - "id": 323, - "name": "stateChangeEmitters", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 80, - "character": 12 - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "id": 592, - "name": "Subscription" - } - ], - "qualifiedName": "Map", - "package": "typescript", - "name": "Map" - }, - "defaultValue": "..." - }, - { - "id": 322, - "name": "storage", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 79, - "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": "removeItem" - }, - { - "type": "literal", - "value": "setItem" - } - ] - } - ], - "qualifiedName": "Pick", - "package": "typescript", - "name": "Pick" - } - ], - "name": "PromisifyMethods" - } - }, - { - "id": 318, - "name": "storageKey", - "kind": 1024, - "kindString": "Property", - "flags": { - "isProtected": true - }, - "comment": { - "shortText": "The storage key used to identity the values saved in localStorage" - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 69, - "character": 12 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 480, - "name": "_callRefreshToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 775, - "character": 16 - } - ], - "signatures": [ - { - "id": 481, - "name": "_callRefreshToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 482, - "name": "refreshToken", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 660, - "name": "CallRefreshTokenResult" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 421, - "name": "_doesSessionExist", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 599, - "character": 10 - } - ], - "signatures": [ - { - "id": 422, - "name": "_doesSessionExist", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 423, - "name": "maybeSession", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "maybeSession", - "asserts": false, - "targetType": { - "type": "reference", - "id": 529, - "name": "Session" - } - } - } - ] - }, - { - "id": 424, - "name": "_handleEmailSignIn", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 610, - "character": 16 - } - ], - "signatures": [ - { - "id": 425, - "name": "_handleEmailSignIn", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 426, - "name": "email", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 427, - "name": "password", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 428, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 429, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 430, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 614, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 430 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 503, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 467, - "name": "_handleOpenIDConnectSignIn", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 686, - "character": 16 - } - ], - "signatures": [ - { - "id": 468, - "name": "_handleOpenIDConnectSignIn", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 469, - "name": "__namedParameters", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 653, - "name": "OpenIDConnectCredentials", - "dereferenced": { - "id": 653, - "name": "OpenIDConnectCredentials", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 657, - "name": "client_id", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 265, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 654, - "name": "id_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 262, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 658, - "name": "issuer", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 266, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 655, - "name": "nonce", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 263, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 656, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 264, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 501, - "name": "Provider" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 657, - 654, - 658, - 655, - 656 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 261, - "character": 17 - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 470, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 473, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 696, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 472, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 695, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 529, - "name": "Session" - } - ] - } - }, - { - "id": 471, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 694, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 548, - "name": "User" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 473, - 472, - 471 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 474, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 477, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 698, - "character": 35 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 476, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 698, - "character": 20 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 475, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 698, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 477, - 476, - 475 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 431, - "name": "_handlePhoneSignIn", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 638, - "character": 16 - } - ], - "signatures": [ - { - "id": 432, - "name": "_handlePhoneSignIn", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 433, - "name": "phone", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 434, - "name": "password", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 435, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 436, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 437, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 642, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 437 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 438, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 439, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 649, - "character": 38 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 440, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 441, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 649, - "character": 46 - } - ], - "type": { - "type": "literal", - "value": null - }, - "defaultValue": "null" - }, - { - "id": 442, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 649, - "character": 61 - } - ], - "type": { - "type": "literal", - "value": null - }, - "defaultValue": "null" - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 441, - 442 - ] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 443, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 439, - 443 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 444, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 445, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 656, - "character": 15 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 446, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 447, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - }, - { - "id": 448, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 656, - "character": 32 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - }, - "defaultValue": "session.user" - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 447, - 448 - ] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 449, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 656, - "character": 54 - } - ], - "type": { - "type": "literal", - "value": null - }, - "defaultValue": "null" - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 445, - 449 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 450, - "name": "_handleProviderSignIn", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 666, - "character": 10 - } - ], - "signatures": [ - { - "id": 451, - "name": "_handleProviderSignIn", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 452, - "name": "provider", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 501, - "name": "Provider", - "dereferenced": { - "id": 501, - "name": "Provider", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 3, - "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": 453, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 454, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 457, - "name": "queryParams", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 671, - "character": 6 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 458, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 459, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 460, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - } - } - }, - { - "id": 455, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 669, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 456, - "name": "scopes", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 670, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 457, - 455, - 456 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 461, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 462, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 683, - "character": 13 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 463, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 464, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "reference", - "id": 501, - "name": "Provider" - } - }, - { - "id": 465, - "name": "url", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 464, - 465 - ] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 466, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 683, - "character": 38 - } - ], - "type": { - "type": "literal", - "value": null - }, - "defaultValue": "null" - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 462, - 466 - ] - } - ] - } - } - } - ] - }, - { - "id": 499, - "name": "_handleVisibilityChange", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 883, - "character": 10 - } - ], - "signatures": [ - { - "id": 500, - "name": "_handleVisibilityChange", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "literal", - "value": false - } - ] - } - } - ] - }, - { - "id": 483, - "name": "_notifyAllSubscribers", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 815, - "character": 10 - } - ], - "signatures": [ - { - "id": 484, - "name": "_notifyAllSubscribers", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 485, - "name": "event", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 502, - "name": "AuthChangeEvent", - "dereferenced": { - "id": 502, - "name": "AuthChangeEvent", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 21, - "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": 486, - "name": "session", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "id": 529, - "name": "Session" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 490, - "name": "_persistSession", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 843, - "character": 10 - } - ], - "signatures": [ - { - "id": 491, - "name": "_persistSession", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "parameters": [ - { - "id": 492, - "name": "currentSession", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 529, - "name": "Session", - "dereferenced": { - "id": 529, - "name": "Session", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 531, - "name": "access_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 62, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 533, - "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": 70, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 532, - "name": "expires_in", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "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": 66, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "provider_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 61, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 534, - "name": "refresh_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 71, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 535, - "name": "token_type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 72, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 536, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 531, - 533, - 532, - 530, - 534, - 535, - 536 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 60, - "character": 17 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 478, - "name": "_recoverAndRefresh", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 730, - "character": 16 - } - ], - "signatures": [ - { - "id": 479, - "name": "_recoverAndRefresh", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Recovers the session from LocalStorage and refreshes\nNote: this method is async to accommodate for AsyncStorage e.g. in React native." - }, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "literal", - "value": null - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 493, - "name": "_removeSession", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 847, - "character": 16 - } - ], - "signatures": [ - { - "id": 494, - "name": "_removeSession", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 487, - "name": "_saveSession", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 823, - "character": 10 - } - ], - "signatures": [ - { - "id": 488, - "name": "_saveSession", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "set currentSession and currentUser\nprocess to _startAutoRefreshToken if possible" - }, - "parameters": [ - { - "id": 489, - "name": "session", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 529, - "name": "Session", - "dereferenced": { - "id": 529, - "name": "Session", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 531, - "name": "access_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 62, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 533, - "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": 70, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 532, - "name": "expires_in", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "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": 66, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "provider_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 61, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 534, - "name": "refresh_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 71, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 535, - "name": "token_type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 72, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 536, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 531, - 533, - 532, - 530, - 534, - 535, - 536 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 60, - "character": 17 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 495, - "name": "_startAutoRefreshToken", - "kind": 2048, - "kindString": "Method", - "flags": { - "isPrivate": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 863, - "character": 10 - } - ], - "signatures": [ - { - "id": 496, - "name": "_startAutoRefreshToken", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Clear and re-create refresh token timer" - }, - "parameters": [ - { - "id": 497, - "name": "value", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "time intervals in milliseconds\n" - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 498, - "name": "session", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 529, - "name": "Session", - "dereferenced": { - "id": 529, - "name": "Session", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 531, - "name": "access_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 62, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 533, - "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": 70, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 532, - "name": "expires_in", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "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": 66, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 530, - "name": "provider_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 61, - "character": 2 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 534, - "name": "refresh_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 71, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 535, - "name": "token_type", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 72, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 536, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 73, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 531, - 533, - 532, - 530, - 534, - 535, - 536 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 60, - "character": 17 - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 350, + "id": 146, "name": "getSession", "kind": 2048, "kindString": "Method", @@ -10982,19 +3833,19 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 341, + "line": 368, "character": 8 } ], "signatures": [ { - "id": 351, + "id": 147, "name": "getSession", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the session data, refreshing it if necessary." + "shortText": "Returns the session data, refreshing it if necessary.\nIf no session is detected, the session returned will be null." }, "type": { "type": "reference", @@ -11005,14 +3856,68 @@ { "type": "reflection", "declaration": { - "id": 352, + "id": 148, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 354, + "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": "reference", + "id": 307, + "name": "Session" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 151 + ] + } + ] + } + } + }, + { + "id": 152, "name": "error", "kind": 1024, "kindString": "Property", @@ -11020,7 +3925,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 344, + "line": 373, "character": 8 } ], @@ -11028,25 +3933,6 @@ "type": "literal", "value": null } - }, - { - "id": 353, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 343, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } } ], "groups": [ @@ -11054,8 +3940,8 @@ "title": "Properties", "kind": 1024, "children": [ - 354, - 353 + 149, + 152 ] } ] @@ -11064,14 +3950,67 @@ { "type": "reflection", "declaration": { - "id": 355, + "id": 153, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 357, + "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", @@ -11079,33 +4018,15 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 348, + "line": 379, "character": 8 } ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } - }, - { - "id": 356, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 347, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } } ], "groups": [ @@ -11113,8 +4034,8 @@ "title": "Properties", "kind": 1024, "children": [ - 357, - 356 + 154, + 157 ] } ] @@ -11123,14 +4044,67 @@ { "type": "reflection", "declaration": { - "id": 358, + "id": 158, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 360, + "id": 159, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 382, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 160, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 161, + "name": "session", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 383, + "character": 10 + } + ], + "type": { + "type": "literal", + "value": null + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 161 + ] + } + ] + } + } + }, + { + "id": 162, "name": "error", "kind": 1024, "kindString": "Property", @@ -11138,25 +4112,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 352, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 359, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 351, + "line": 385, "character": 8 } ], @@ -11171,8 +4127,8 @@ "title": "Properties", "kind": 1024, "children": [ - 360, - 359 + 159, + 162 ] } ] @@ -11189,219 +4145,7 @@ ] }, { - "id": 393, - "name": "getSessionFromUrl", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 489, - "character": 8 - } - ], - "signatures": [ - { - "id": 394, - "name": "getSessionFromUrl", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Gets the session data from a URL string" - }, - "parameters": [ - { - "id": 395, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 396, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 397, - "name": "storeSession", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optionally store the session in the browser\n" - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 489, - "character": 38 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 397 - ] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 398, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 400, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 492, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 399, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 491, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 400, - 399 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 401, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 403, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 494, - "character": 23 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 402, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 494, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 403, - 402 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 361, + "id": 163, "name": "getUser", "kind": 2048, "kindString": "Method", @@ -11409,203 +4153,45 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 391, + "line": 425, "character": 8 } ], "signatures": [ { - "id": 362, + "id": 164, "name": "getUser", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Returns the user data, refreshing the session if necessary." + "shortText": "Gets the current user details if there is an existing session." }, + "parameters": [ + { + "id": 165, + "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": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 363, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 365, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 394, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 364, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 393, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 365, - 364 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 366, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 368, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 398, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 367, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 397, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 368, - 367 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 369, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 371, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 402, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 370, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 401, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 371, - 370 - ] - } - ] - } - } - ] + "type": "reference", + "id": 296, + "name": "UserResponse" } ], "qualifiedName": "Promise", @@ -11616,7 +4202,7 @@ ] }, { - "id": 408, + "id": 184, "name": "onAuthStateChange", "kind": 2048, "kindString": "Method", @@ -11624,13 +4210,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 573, + "line": 599, "character": 2 } ], "signatures": [ { - "id": 409, + "id": 185, "name": "onAuthStateChange", "kind": 4096, "kindString": "Call signature", @@ -11641,41 +4227,44 @@ }, "parameters": [ { - "id": 410, + "id": 186, "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": 411, + "id": 187, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 412, + "id": 188, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 413, + "id": 189, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 502, + "id": 269, "name": "AuthChangeEvent" } }, { - "id": 414, + "id": 190, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -11689,7 +4278,7 @@ }, { "type": "reference", - "id": 529, + "id": 307, "name": "Session" } ] @@ -11712,14 +4301,14 @@ { "type": "reflection", "declaration": { - "id": 415, + "id": 191, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 417, + "id": 193, "name": "error", "kind": 1024, "kindString": "Property", @@ -11727,7 +4316,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 576, + "line": 602, "character": 8 } ], @@ -11737,7 +4326,7 @@ } }, { - "id": 416, + "id": 192, "name": "subscription", "kind": 1024, "kindString": "Property", @@ -11745,13 +4334,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 575, + "line": 601, "character": 8 } ], "type": { "type": "reference", - "id": 592, + "id": 370, "name": "Subscription" } } @@ -11761,8 +4350,8 @@ "title": "Properties", "kind": 1024, "children": [ - 417, - 416 + 193, + 192 ] } ] @@ -11771,14 +4360,14 @@ { "type": "reflection", "declaration": { - "id": 418, + "id": 194, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 420, + "id": 196, "name": "error", "kind": 1024, "kindString": "Property", @@ -11786,18 +4375,18 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 578, + "line": 604, "character": 28 } ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } }, { - "id": 419, + "id": 195, "name": "subscription", "kind": 1024, "kindString": "Property", @@ -11805,7 +4394,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 578, + "line": 604, "character": 8 } ], @@ -11820,8 +4409,8 @@ "title": "Properties", "kind": 1024, "children": [ - 420, - 419 + 196, + 195 ] } ] @@ -11833,42 +4422,118 @@ ] }, { - "id": 381, - "name": "setSession", + "id": 197, + "name": "resetPasswordForEmail", "kind": 2048, "kindString": "Method", "flags": {}, "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 455, + "line": 631, "character": 8 } ], "signatures": [ { - "id": 382, - "name": "setSession", + "id": 198, + "name": "resetPasswordForEmail", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the session data from refresh_token and returns current Session and Error" + "shortText": "Sends a reset request to an email address." }, "parameters": [ { - "id": 383, - "name": "refresh_token", + "id": 199, + "name": "email", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "a JWT token\n" + "shortText": "The email address of the user." }, "type": { "type": "intrinsic", "name": "string" } + }, + { + "id": 200, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 201, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 203, + "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": 635, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 202, + "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": 634, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 203, + 202 + ] + } + ] + } + }, + "defaultValue": "{}" } ], "type": { @@ -11880,14 +4545,38 @@ { "type": "reflection", "declaration": { - "id": 384, + "id": 204, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 386, + "id": 205, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 639, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 206, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {} + } + } + }, + { + "id": 207, "name": "error", "kind": 1024, "kindString": "Property", @@ -11895,84 +4584,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 458, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 385, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 457, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 529, - "name": "Session" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 386, - 385 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 387, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 389, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 460, - "character": 23 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 388, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 460, + "line": 640, "character": 8 } ], @@ -11987,8 +4599,8 @@ "title": "Properties", "kind": 1024, "children": [ - 389, - 388 + 205, + 207 ] } ] @@ -11997,14 +4609,32 @@ { "type": "reflection", "declaration": { - "id": 390, + "id": 208, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 392, + "id": 209, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 642, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 210, "name": "error", "kind": 1024, "kindString": "Property", @@ -12012,33 +4642,15 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 461, - "character": 23 + "line": 642, + "character": 20 } ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } - }, - { - "id": 391, - "name": "session", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 461, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } } ], "groups": [ @@ -12046,8 +4658,8 @@ "title": "Properties", "kind": 1024, "children": [ - 392, - 391 + 209, + 210 ] } ] @@ -12064,7 +4676,62 @@ ] }, { - "id": 338, + "id": 169, + "name": "setSession", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 488, + "character": 8 + } + ], + "signatures": [ + { + "id": 170, + "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": 171, + "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": 270, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 133, "name": "signInWithOAuth", "kind": 2048, "kindString": "Method", @@ -12072,13 +4739,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 240, + "line": 264, "character": 8 } ], "signatures": [ { - "id": 339, + "id": 134, "name": "signInWithOAuth", "kind": 4096, "kindString": "Call signature", @@ -12088,17 +4755,17 @@ }, "parameters": [ { - "id": 340, + "id": 135, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 629, + "id": 406, "name": "SignInWithOAuthCredentials", "dereferenced": { - "id": 629, + "id": 406, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -12106,21 +4773,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 235, + "line": 265, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 630, + "id": 407, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 632, + "id": 409, "name": "options", "kind": 1024, "kindString": "Property", @@ -12130,32 +4797,35 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 237, + "line": 268, "character": 2 } ], "type": { "type": "reference", - "id": 633, + "id": 410, "name": "SignInWithOAuthOptions" } }, { - "id": 631, + "id": 408, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "One of the providers supported by GoTrue." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 236, + "line": 267, "character": 2 } ], "type": { "type": "reference", - "id": 501, + "id": 268, "name": "Provider" } } @@ -12165,15 +4835,15 @@ "title": "Properties", "kind": 1024, "children": [ - 632, - 631 + 409, + 408 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 235, + "line": 265, "character": 41 } ] @@ -12188,7 +4858,7 @@ "typeArguments": [ { "type": "reference", - "id": 516, + "id": 283, "name": "OAuthResponse" } ], @@ -12200,7 +4870,7 @@ ] }, { - "id": 341, + "id": 136, "name": "signInWithOtp", "kind": 2048, "kindString": "Method", @@ -12208,13 +4878,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 256, + "line": 276, "character": 8 } ], "signatures": [ { - "id": 342, + "id": 137, "name": "signInWithOtp", "kind": 4096, "kindString": "Call signature", @@ -12224,17 +4894,17 @@ }, "parameters": [ { - "id": 343, + "id": 138, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 618, + "id": 395, "name": "SignInWithPasswordlessCredentials", "dereferenced": { - "id": 618, + "id": 395, "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", @@ -12242,7 +4912,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 220, + "line": 248, "character": 12 } ], @@ -12252,22 +4922,25 @@ { "type": "reflection", "declaration": { - "id": 619, + "id": 396, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 620, + "id": 397, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's email address." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 222, + "line": 251, "character": 6 } ], @@ -12277,7 +4950,7 @@ } }, { - "id": 621, + "id": 398, "name": "options", "kind": 1024, "kindString": "Property", @@ -12287,13 +4960,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 223, + "line": 252, "character": 6 } ], "type": { "type": "reference", - "id": 625, + "id": 402, "name": "SignInWithPasswordlessOptions" } } @@ -12303,15 +4976,15 @@ "title": "Properties", "kind": 1024, "children": [ - 620, - 621 + 397, + 398 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 221, + "line": 249, "character": 4 } ] @@ -12320,14 +4993,14 @@ { "type": "reflection", "declaration": { - "id": 622, + "id": 399, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 624, + "id": 401, "name": "options", "kind": 1024, "kindString": "Property", @@ -12337,26 +5010,29 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 227, + "line": 257, "character": 6 } ], "type": { "type": "reference", - "id": 625, + "id": 402, "name": "SignInWithPasswordlessOptions" } }, { - "id": 623, + "id": 400, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 226, + "line": 256, "character": 6 } ], @@ -12371,15 +5047,15 @@ "title": "Properties", "kind": 1024, "children": [ - 624, - 623 + 401, + 400 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 225, + "line": 254, "character": 4 } ] @@ -12396,7 +5072,7 @@ "typeArguments": [ { "type": "reference", - "id": 503, + "id": 270, "name": "AuthResponse" } ], @@ -12408,7 +5084,7 @@ ] }, { - "id": 335, + "id": 130, "name": "signInWithPassword", "kind": 2048, "kindString": "Method", @@ -12416,13 +5092,13 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 203, + "line": 216, "character": 8 } ], "signatures": [ { - "id": 336, + "id": 131, "name": "signInWithPassword", "kind": 4096, "kindString": "Call signature", @@ -12432,17 +5108,17 @@ }, "parameters": [ { - "id": 337, + "id": 132, "name": "credentials", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 607, + "id": 384, "name": "SignInWithPasswordCredentials", "dereferenced": { - "id": 607, + "id": 384, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -12450,7 +5126,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 206, + "line": 230, "character": 12 } ], @@ -12460,22 +5136,25 @@ { "type": "reflection", "declaration": { - "id": 608, + "id": 385, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 609, + "id": 386, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's email address." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 208, + "line": 233, "character": 6 } ], @@ -12485,7 +5164,7 @@ } }, { - "id": 611, + "id": 388, "name": "options", "kind": 1024, "kindString": "Property", @@ -12495,26 +5174,29 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 210, + "line": 236, "character": 6 } ], "type": { "type": "reference", - "id": 616, + "id": 393, "name": "SignInWithPasswordOptions" } }, { - "id": 610, + "id": 387, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's password." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 209, + "line": 235, "character": 6 } ], @@ -12529,16 +5211,16 @@ "title": "Properties", "kind": 1024, "children": [ - 609, - 611, - 610 + 386, + 388, + 387 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 207, + "line": 231, "character": 4 } ] @@ -12547,14 +5229,14 @@ { "type": "reflection", "declaration": { - "id": 612, + "id": 389, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 615, + "id": 392, "name": "options", "kind": 1024, "kindString": "Property", @@ -12564,26 +5246,29 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 215, + "line": 243, "character": 6 } ], "type": { "type": "reference", - "id": 616, + "id": 393, "name": "SignInWithPasswordOptions" } }, { - "id": 614, + "id": 391, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's password." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 214, + "line": 242, "character": 6 } ], @@ -12593,15 +5278,18 @@ } }, { - "id": 613, + "id": 390, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 213, + "line": 240, "character": 6 } ], @@ -12616,16 +5304,16 @@ "title": "Properties", "kind": 1024, "children": [ - 615, - 614, - 613 + 392, + 391, + 390 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 212, + "line": 238, "character": 4 } ] @@ -12642,7 +5330,7 @@ "typeArguments": [ { "type": "reference", - "id": 503, + "id": 270, "name": "AuthResponse" } ], @@ -12654,7 +5342,7 @@ ] }, { - "id": 404, + "id": 180, "name": "signOut", "kind": 2048, "kindString": "Method", @@ -12662,20 +5350,20 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 554, + "line": 579, "character": 8 } ], "signatures": [ { - "id": 405, + "id": 181, "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)`. There is no way to revoke a user's session JWT before it automatically expires\n" + "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", @@ -12683,14 +5371,14 @@ { "type": "reflection", "declaration": { - "id": 406, + "id": 182, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 407, + "id": 183, "name": "error", "kind": 1024, "kindString": "Property", @@ -12698,7 +5386,7 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 554, + "line": 579, "character": 29 } ], @@ -12711,7 +5399,7 @@ }, { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } ] @@ -12723,7 +5411,7 @@ "title": "Properties", "kind": 1024, "children": [ - 407 + 183 ] } ] @@ -12738,7 +5426,7 @@ ] }, { - "id": 327, + "id": 122, "name": "signUp", "kind": 2048, "kindString": "Method", @@ -12746,368 +5434,41 @@ "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 142, + "line": 151, "character": 8 } ], "signatures": [ { - "id": 328, + "id": 123, "name": "signUp", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Creates a new user." + "shortText": "Creates a new user.", + "returns": "A logged-in session if the server has \"autoconfirm\" ON" }, "parameters": [ { - "id": 329, + "id": 124, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 600, + "id": 378, "name": "UserCredentials", "dereferenced": { - "id": 600, + "id": 378, "name": "UserCredentials", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 601, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 198, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 606, - "name": "oidc", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 204, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 653, - "name": "OpenIDConnectCredentials" - } - }, - { - "id": 603, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 200, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 602, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 199, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 605, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The name of the provider." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 203, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 501, - "name": "Provider" - } - }, - { - "id": 604, - "name": "refreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 201, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 601, - 606, - 603, - 602, - 605, - 604 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 197, - "character": 17 - } - ] - } - } - }, - { - "id": 330, - "name": "options", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 331, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 334, - "name": "captchaToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 147, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 333, - "name": "data", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Optional user metadata.\n" - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 146, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 332, - "name": "redirectTo", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The redirect URL attached to the signup confirmation link. Does not redirect the user if it's a mobile signup." - }, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 145, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 334, - 333, - 332 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "id": 503, - "name": "AuthResponse" - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 372, - "name": "update", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 420, - "character": 8 - } - ], - "signatures": [ - { - "id": 373, - "name": "update", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Updates user data, if there is a logged in user." - }, - "parameters": [ - { - "id": 374, - "name": "attributes", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 576, - "name": "UserAttributes", - "dereferenced": { - "id": 576, - "name": "UserAttributes", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 581, - "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": 140, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 577, + "id": 379, "name": "email", "kind": 1024, "kindString": "Property", @@ -13115,12 +5476,12 @@ "isOptional": true }, "comment": { - "shortText": "The user's email." + "shortText": "The user's email address." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, + "line": 221, "character": 2 } ], @@ -13130,30 +5491,7 @@ } }, { - "id": 580, - "name": "email_change_token", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "An email change token." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 135, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 579, + "id": 381, "name": "password", "kind": 1024, "kindString": "Property", @@ -13166,7 +5504,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 130, + "line": 225, "character": 2 } ], @@ -13176,7 +5514,7 @@ } }, { - "id": 578, + "id": 380, "name": "phone", "kind": 1024, "kindString": "Property", @@ -13184,12 +5522,56 @@ "isOptional": true }, "comment": { - "shortText": "The user's phone." + "shortText": "The user's phone number." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 125, + "line": 223, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 383, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The name of the provider." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 228, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 268, + "name": "Provider" + } + }, + { + "id": 382, + "name": "refreshToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 226, "character": 2 } ], @@ -13204,233 +5586,26 @@ "title": "Properties", "kind": 1024, "children": [ - 581, - 577, - 580, - 579, - 578 + 379, + 381, + 380, + 383, + 382 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 116, + "line": 219, "character": 17 } - ], - "extendedBy": [ - { - "type": "reference", - "id": 582, - "name": "AdminUserAttributes" - } ] } } - } - ], - "type": { - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 375, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 377, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 423, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - }, - { - "id": 376, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 422, - "character": 8 - } - ], - "type": { - "type": "reference", - "id": 548, - "name": "User" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 377, - 376 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 378, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "children": [ - { - "id": 380, - "name": "error", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 425, - "character": 20 - } - ], - "type": { - "type": "reference", - "id": 670, - "name": "AuthError" - } - }, - { - "id": 379, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 425, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 380, - 379 - ] - } - ] - } - } - ] - } - ], - "qualifiedName": "Promise", - "package": "typescript", - "name": "Promise" - } - } - ] - }, - { - "id": 344, - "name": "verifyOTP", - "kind": 2048, - "kindString": "Method", - "flags": {}, - "sources": [ - { - "fileName": "src/GoTrueClient.ts", - "line": 295, - "character": 8 - } - ], - "signatures": [ - { - "id": 345, - "name": "verifyOTP", - "kind": 4096, - "kindString": "Call signature", - "flags": {}, - "comment": { - "shortText": "Log in a user given a User supplied OTP received via mobile." - }, - "parameters": [ - { - "id": 346, - "name": "params", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "type": { - "type": "reference", - "id": 640, - "name": "VerifyOTPParams", - "dereferenced": { - "id": 640, - "name": "VerifyOTPParams", - "kind": 4194304, - "kindString": "Type alias", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 245, - "character": 12 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 641, - "name": "VerifyMobileOTPParams" - }, - { - "type": "reference", - "id": 646, - "name": "VerifyEmailOTPParams" - } - ] - } - } - } }, { - "id": 347, + "id": 125, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -13438,14 +5613,60 @@ "type": { "type": "reflection", "declaration": { - "id": 348, + "id": 126, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 349, + "id": 129, + "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/GoTrueClient.ts", + "line": 156, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 128, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "Optional user metadata." + }, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 155, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 127, "name": "redirectTo", "kind": 1024, "kindString": "Property", @@ -13453,12 +5674,12 @@ "isOptional": true }, "comment": { - "shortText": "A URL or mobile address to send the user to after they are confirmed.\n" + "shortText": "The redirect URL attached to the signup confirmation link. Does not redirect the user if it's a mobile signup." }, "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 298, + "line": 154, "character": 6 } ], @@ -13473,7 +5694,9 @@ "title": "Properties", "kind": 1024, "children": [ - 349 + 129, + 128, + 127 ] } ] @@ -13487,7 +5710,369 @@ "typeArguments": [ { "type": "reference", - "id": 503, + "id": 270, + "name": "AuthResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 166, + "name": "updateUser", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 454, + "character": 8 + } + ], + "signatures": [ + { + "id": 167, + "name": "updateUser", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Updates user data, if there is a logged in user." + }, + "parameters": [ + { + "id": 168, + "name": "attributes", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 354, + "name": "UserAttributes", + "dereferenced": { + "id": 354, + "name": "UserAttributes", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 359, + "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": 355, + "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": 358, + "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": 357, + "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": 356, + "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": [ + 359, + 355, + 358, + 357, + 356 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 138, + "character": 17 + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 360, + "name": "AdminUserAttributes" + } + ] + } + } + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 296, + "name": "UserResponse" + } + ], + "qualifiedName": "Promise", + "package": "typescript", + "name": "Promise" + } + } + ] + }, + { + "id": 139, + "name": "verifyOtp", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/GoTrueClient.ts", + "line": 319, + "character": 8 + } + ], + "signatures": [ + { + "id": 140, + "name": "verifyOtp", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Log in a user given a User supplied OTP received via mobile." + }, + "parameters": [ + { + "id": 141, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 417, + "name": "VerifyOtpParams", + "dereferenced": { + "id": 417, + "name": "VerifyOtpParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 279, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 418, + "name": "VerifyMobileOtpParams" + }, + { + "type": "reference", + "id": 423, + "name": "VerifyEmailOtpParams" + } + ] + } + } + } + }, + { + "id": 142, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 143, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 145, + "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": 323, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 144, + "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": 322, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 145, + 144 + ] + } + ] + } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 270, "name": "AuthResponse" } ], @@ -13504,74 +6089,52 @@ "title": "Constructors", "kind": 512, "children": [ - 297 + 82 ] }, { "title": "Properties", "kind": 1024, "children": [ - 317, - 320, - 319, - 325, - 321, - 324, - 326, - 323, - 322, - 318 + 102 ] }, { "title": "Methods", "kind": 2048, "children": [ - 480, - 421, - 424, - 467, - 431, - 450, - 499, - 483, - 490, - 478, - 493, - 487, - 495, - 350, - 393, - 361, - 408, - 381, - 338, - 341, - 335, - 404, - 327, - 372, - 344 + 146, + 163, + 184, + 197, + 169, + 133, + 136, + 130, + 180, + 122, + 166, + 139 ] } ], "sources": [ { "fileName": "src/GoTrueClient.ts", - "line": 60, + "line": 61, "character": 21 } ] }, { - "id": 582, + "id": 360, "name": "AdminUserAttributes", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 584, + "id": 362, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -13585,7 +6148,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 165, + "line": 187, "character": 2 } ], @@ -13595,7 +6158,7 @@ } }, { - "id": 591, + "id": 369, "name": "data", "kind": 1024, "kindString": "Property", @@ -13608,7 +6171,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 140, + "line": 162, "character": 2 } ], @@ -13618,12 +6181,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 581, + "id": 359, "name": "UserAttributes.data" } }, { - "id": 587, + "id": 365, "name": "email", "kind": 1024, "kindString": "Property", @@ -13636,7 +6199,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, + "line": 142, "character": 2 } ], @@ -13646,12 +6209,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 577, + "id": 355, "name": "UserAttributes.email" } }, { - "id": 590, + "id": 368, "name": "email_change_token", "kind": 1024, "kindString": "Property", @@ -13664,7 +6227,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 135, + "line": 157, "character": 2 } ], @@ -13674,12 +6237,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 580, + "id": 358, "name": "UserAttributes.email_change_token" } }, { - "id": 585, + "id": 363, "name": "email_confirm", "kind": 1024, "kindString": "Property", @@ -13693,7 +6256,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 172, + "line": 194, "character": 2 } ], @@ -13703,7 +6266,7 @@ } }, { - "id": 589, + "id": 367, "name": "password", "kind": 1024, "kindString": "Property", @@ -13716,7 +6279,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 130, + "line": 152, "character": 2 } ], @@ -13726,12 +6289,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 579, + "id": 357, "name": "UserAttributes.password" } }, { - "id": 588, + "id": 366, "name": "phone", "kind": 1024, "kindString": "Property", @@ -13744,7 +6307,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 125, + "line": 147, "character": 2 } ], @@ -13754,12 +6317,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 578, + "id": 356, "name": "UserAttributes.phone" } }, { - "id": 586, + "id": 364, "name": "phone_confirm", "kind": 1024, "kindString": "Property", @@ -13773,7 +6336,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 179, + "line": 201, "character": 2 } ], @@ -13783,7 +6346,7 @@ } }, { - "id": 583, + "id": 361, "name": "user_metadata", "kind": 1024, "kindString": "Property", @@ -13797,7 +6360,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 155, + "line": 177, "character": 2 } ], @@ -13812,176 +6375,53 @@ "title": "Properties", "kind": 1024, "children": [ - 584, - 591, - 587, - 590, - 585, - 589, - 588, - 586, - 583 + 362, + 369, + 365, + 368, + 363, + 367, + 366, + 364, + 361 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 143, + "line": 165, "character": 17 } ], "extendedTypes": [ { "type": "reference", - "id": 576, + "id": 354, "name": "UserAttributes" } ] }, { - "id": 653, - "name": "OpenIDConnectCredentials", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 657, - "name": "client_id", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 265, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 654, - "name": "id_token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 262, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 658, - "name": "issuer", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 266, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 655, - "name": "nonce", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 263, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 656, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 264, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 501, - "name": "Provider" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 657, - 654, - 658, - 655, - 656 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 261, - "character": 17 - } - ] - }, - { - "id": 529, + "id": 307, "name": "Session", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 531, + "id": 309, "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": 62, + "line": 81, "character": 2 } ], @@ -13991,7 +6431,7 @@ } }, { - "id": 533, + "id": 312, "name": "expires_at", "kind": 1024, "kindString": "Property", @@ -14004,7 +6444,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 70, + "line": 93, "character": 2 } ], @@ -14014,20 +6454,18 @@ } }, { - "id": 532, + "id": 311, "name": "expires_in", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, + "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": 66, + "line": 89, "character": 2 } ], @@ -14037,7 +6475,7 @@ } }, { - "id": 530, + "id": 308, "name": "provider_token", "kind": 1024, "kindString": "Property", @@ -14047,7 +6485,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 61, + "line": 77, "character": 2 } ], @@ -14066,15 +6504,18 @@ } }, { - "id": 534, + "id": 310, "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": 71, + "line": 85, "character": 2 } ], @@ -14084,7 +6525,7 @@ } }, { - "id": 535, + "id": 313, "name": "token_type", "kind": 1024, "kindString": "Property", @@ -14092,7 +6533,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 72, + "line": 94, "character": 2 } ], @@ -14102,7 +6543,7 @@ } }, { - "id": 536, + "id": 314, "name": "user", "kind": 1024, "kindString": "Property", @@ -14110,13 +6551,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 73, + "line": 95, "character": 2 } ], "type": { "type": "reference", - "id": 548, + "id": 326, "name": "User" } } @@ -14126,63 +6567,66 @@ "title": "Properties", "kind": 1024, "children": [ - 531, - 533, - 532, - 530, - 534, - 535, - 536 + 309, + 312, + 311, + 308, + 310, + 313, + 314 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 60, + "line": 76, "character": 17 } ] }, { - "id": 633, + "id": 410, "name": "SignInWithOAuthOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 636, + "id": 413, "name": "queryParams", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "An object of query params" + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 242, + "line": 276, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 637, + "id": 414, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "indexSignature": { - "id": 638, + "id": 415, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 639, + "id": 416, "name": "key", "kind": 32768, "flags": {}, @@ -14201,17 +6645,20 @@ } }, { - "id": 634, + "id": 411, "name": "redirectTo", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "A URL to send the user to after they are confirmed (OAuth logins only)." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 240, + "line": 272, "character": 2 } ], @@ -14221,17 +6668,20 @@ } }, { - "id": 635, + "id": 412, "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": 241, + "line": 274, "character": 2 } ], @@ -14246,29 +6696,29 @@ "title": "Properties", "kind": 1024, "children": [ - 636, - 634, - 635 + 413, + 411, + 412 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 239, + "line": 270, "character": 17 } ] }, { - "id": 616, + "id": 393, "name": "SignInWithPasswordOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 617, + "id": 394, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -14278,7 +6728,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 218, + "line": 246, "character": 2 } ], @@ -14293,27 +6743,27 @@ "title": "Properties", "kind": 1024, "children": [ - 617 + 394 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 217, + "line": 245, "character": 17 } ] }, { - "id": 625, + "id": 402, "name": "SignInWithPasswordlessOptions", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 628, + "id": 405, "name": "captchaToken", "kind": 1024, "kindString": "Property", @@ -14323,7 +6773,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 233, + "line": 263, "character": 2 } ], @@ -14333,7 +6783,7 @@ } }, { - "id": 626, + "id": 403, "name": "emailRedirectTo", "kind": 1024, "kindString": "Property", @@ -14346,7 +6796,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 231, + "line": 261, "character": 2 } ], @@ -14356,7 +6806,7 @@ } }, { - "id": 627, + "id": 404, "name": "shouldCreateUser", "kind": 1024, "kindString": "Property", @@ -14366,7 +6816,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 232, + "line": 262, "character": 2 } ], @@ -14381,29 +6831,29 @@ "title": "Properties", "kind": 1024, "children": [ - 628, - 626, - 627 + 405, + 403, + 404 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 229, + "line": 259, "character": 17 } ] }, { - "id": 592, + "id": 370, "name": "Subscription", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 593, + "id": 371, "name": "id", "kind": 1024, "kindString": "Property", @@ -14414,7 +6864,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 186, + "line": 208, "character": 2 } ], @@ -14424,7 +6874,7 @@ } }, { - "id": 594, + "id": 372, "name": "callback", "kind": 2048, "kindString": "Method", @@ -14432,13 +6882,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 190, + "line": 212, "character": 2 } ], "signatures": [ { - "id": 595, + "id": 373, "name": "callback", "kind": 4096, "kindString": "Call signature", @@ -14448,17 +6898,17 @@ }, "parameters": [ { - "id": 596, + "id": 374, "name": "event", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 502, + "id": 269, "name": "AuthChangeEvent", "dereferenced": { - "id": 502, + "id": 269, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -14466,7 +6916,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 21, + "line": 22, "character": 12 } ], @@ -14503,7 +6953,7 @@ } }, { - "id": 597, + "id": 375, "name": "session", "kind": 32768, "kindString": "Parameter", @@ -14517,7 +6967,7 @@ }, { "type": "reference", - "id": 529, + "id": 307, "name": "Session" } ] @@ -14532,7 +6982,7 @@ ] }, { - "id": 598, + "id": 376, "name": "unsubscribe", "kind": 2048, "kindString": "Method", @@ -14540,13 +6990,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 194, + "line": 216, "character": 2 } ], "signatures": [ { - "id": 599, + "id": 377, "name": "unsubscribe", "kind": 4096, "kindString": "Call signature", @@ -14567,35 +7017,35 @@ "title": "Properties", "kind": 1024, "children": [ - 593 + 371 ] }, { "title": "Methods", "kind": 2048, "children": [ - 594, - 598 + 372, + 376 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 182, + "line": 204, "character": 17 } ] }, { - "id": 548, + "id": 326, "name": "User", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 565, + "id": 343, "name": "action_link", "kind": 1024, "kindString": "Property", @@ -14605,7 +7055,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 103, + "line": 125, "character": 2 } ], @@ -14615,7 +7065,7 @@ } }, { - "id": 550, + "id": 328, "name": "app_metadata", "kind": 1024, "kindString": "Property", @@ -14623,21 +7073,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 90, + "line": 112, "character": 2 } ], "type": { "type": "reflection", "declaration": { - "id": 551, + "id": 329, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 552, + "id": 330, "name": "provider", "kind": 1024, "kindString": "Property", @@ -14647,7 +7097,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 91, + "line": 113, "character": 4 } ], @@ -14662,19 +7112,19 @@ "title": "Properties", "kind": 1024, "children": [ - 552 + 330 ] } ], "indexSignature": { - "id": 553, + "id": 331, "name": "__index", "kind": 8192, "kindString": "Index signature", "flags": {}, "parameters": [ { - "id": 554, + "id": 332, "name": "key", "kind": 32768, "flags": {}, @@ -14693,7 +7143,7 @@ } }, { - "id": 559, + "id": 337, "name": "aud", "kind": 1024, "kindString": "Property", @@ -14701,7 +7151,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 97, + "line": 119, "character": 2 } ], @@ -14711,7 +7161,7 @@ } }, { - "id": 560, + "id": 338, "name": "confirmation_sent_at", "kind": 1024, "kindString": "Property", @@ -14721,7 +7171,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 98, + "line": 120, "character": 2 } ], @@ -14731,13 +7181,816 @@ } }, { - "id": 569, + "id": 347, "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": 346, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 128, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 344, + "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": 340, + "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": 348, + "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": 327, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 111, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 353, + "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": 315, + "name": "UserIdentity" + } + } + }, + { + "id": 342, + "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": 350, + "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": 341, + "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": 345, + "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": 349, + "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": 339, + "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": 351, + "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": 352, + "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": 333, + "name": "user_metadata", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 116, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 334, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 335, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 336, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 343, + 328, + 337, + 338, + 347, + 346, + 344, + 340, + 348, + 327, + 353, + 342, + 350, + 341, + 345, + 349, + 339, + 351, + 352, + 333 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 110, + "character": 17 + } + ] + }, + { + "id": 354, + "name": "UserAttributes", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 359, + "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": 355, + "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": 358, + "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": 357, + "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": 356, + "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": [ + 359, + 355, + 358, + 357, + 356 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 138, + "character": 17 + } + ], + "extendedBy": [ + { + "type": "reference", + "id": 360, + "name": "AdminUserAttributes" + } + ] + }, + { + "id": 378, + "name": "UserCredentials", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 379, + "name": "email", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's email address." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 221, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 381, + "name": "password", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's password." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 225, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 380, + "name": "phone", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The user's phone number." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 223, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 383, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The name of the provider." + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 228, + "character": 2 + } + ], + "type": { + "type": "reference", + "id": 268, + "name": "Provider" + } + }, + { + "id": 382, + "name": "refreshToken", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 226, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 379, + 381, + 380, + 383, + 382 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 219, + "character": 17 + } + ] + }, + { + "id": 315, + "name": "UserIdentity", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 323, + "name": "created_at", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 105, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 316, + "name": "id", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 99, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 318, + "name": "identity_data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 101, + "character": 2 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 319, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "indexSignature": { + "id": 320, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": {}, + "parameters": [ + { + "id": 321, + "name": "key", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + } + } + }, + { + "id": 324, + "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": 322, + "name": "provider", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 104, + "character": 2 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 325, + "name": "updated_at", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, "sources": [ { "fileName": "src/lib/types.ts", @@ -14751,51 +8004,11 @@ } }, { - "id": 568, - "name": "created_at", + "id": 317, + "name": "user_id", "kind": 1024, "kindString": "Property", "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 106, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 566, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 104, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 562, - "name": "email_change_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, "sources": [ { "fileName": "src/lib/types.ts", @@ -14807,37 +8020,48 @@ "type": "intrinsic", "name": "string" } - }, + } + ], + "groups": [ { - "id": 570, - "name": "email_confirmed_at", + "title": "Properties", "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 108, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, + "children": [ + 323, + 316, + 318, + 324, + 322, + 325, + 317 + ] + } + ], + "sources": [ { - "id": 549, - "name": "id", + "fileName": "src/lib/types.ts", + "line": 98, + "character": 17 + } + ] + }, + { + "id": 423, + "name": "VerifyEmailOtpParams", + "kind": 256, + "kindString": "Interface", + "flags": {}, + "children": [ + { + "id": 424, + "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 89, + "line": 291, "character": 2 } ], @@ -14847,91 +8071,7 @@ } }, { - "id": 575, - "name": "identities", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 113, - "character": 2 - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "id": 537, - "name": "UserIdentity" - } - } - }, - { - "id": 564, - "name": "invited_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 102, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 572, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 110, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 563, - "name": "new_email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 101, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 567, + "id": 425, "name": "phone", "kind": 1024, "kindString": "Property", @@ -14941,140 +8081,50 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 105, + "line": 292, "character": 2 } ], "type": { "type": "intrinsic", - "name": "string" + "name": "undefined" } }, { - "id": 571, - "name": "phone_confirmed_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 109, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 561, - "name": "recovery_sent_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 99, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 573, - "name": "role", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 111, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 574, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 112, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 555, - "name": "user_metadata", + "id": 426, + "name": "token", "kind": 1024, "kindString": "Property", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 94, + "line": 293, "character": 2 } ], "type": { - "type": "reflection", - "declaration": { - "id": 556, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 557, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 558, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 427, + "name": "type", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 294, + "character": 2 } + ], + "type": { + "type": "reference", + "id": 429, + "name": "EmailOtpType" } } ], @@ -15083,69 +8133,30 @@ "title": "Properties", "kind": 1024, "children": [ - 565, - 550, - 559, - 560, - 569, - 568, - 566, - 562, - 570, - 549, - 575, - 564, - 572, - 563, - 567, - 571, - 561, - 573, - 574, - 555 + 424, + 425, + 426, + 427 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 88, + "line": 290, "character": 17 } ] }, { - "id": 576, - "name": "UserAttributes", + "id": 418, + "name": "VerifyMobileOtpParams", "kind": 256, "kindString": "Interface", "flags": {}, "children": [ { - "id": 581, - "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": 140, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 577, + "id": 419, "name": "email", "kind": 1024, "kindString": "Property", @@ -15153,35 +8164,33 @@ "isOptional": true }, "comment": { - "shortText": "The user's email." + "shortText": "The user's email address." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 120, + "line": 282, "character": 2 } ], "type": { "type": "intrinsic", - "name": "string" + "name": "undefined" } }, { - "id": 580, - "name": "email_change_token", + "id": 420, + "name": "phone", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, + "flags": {}, "comment": { - "shortText": "An email change token." + "shortText": "The user's phone number." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 135, + "line": 284, "character": 2 } ], @@ -15191,20 +8200,18 @@ } }, { - "id": 579, - "name": "password", + "id": 421, + "name": "token", "kind": 1024, "kindString": "Property", - "flags": { - "isOptional": true - }, + "flags": {}, "comment": { "shortText": "The user's password." }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 130, + "line": 286, "character": 2 } ], @@ -15214,480 +8221,25 @@ } }, { - "id": 578, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The user's phone." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 125, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 581, - 577, - 580, - 579, - 578 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 116, - "character": 17 - } - ], - "extendedBy": [ - { - "type": "reference", - "id": 582, - "name": "AdminUserAttributes" - } - ] - }, - { - "id": 600, - "name": "UserCredentials", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 601, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 198, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 606, - "name": "oidc", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 204, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 653, - "name": "OpenIDConnectCredentials" - } - }, - { - "id": 603, - "name": "password", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 200, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 602, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 199, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 605, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "The name of the provider." - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 203, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 501, - "name": "Provider" - } - }, - { - "id": 604, - "name": "refreshToken", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 201, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 601, - 606, - 603, - 602, - 605, - 604 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 197, - "character": 17 - } - ] - }, - { - "id": 537, - "name": "UserIdentity", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 545, - "name": "created_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 83, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 538, - "name": "id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 77, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 540, - "name": "identity_data", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 79, - "character": 2 - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 541, - "name": "__type", - "kind": 65536, - "kindString": "Type literal", - "flags": {}, - "indexSignature": { - "id": 542, - "name": "__index", - "kind": 8192, - "kindString": "Index signature", - "flags": {}, - "parameters": [ - { - "id": 543, - "name": "key", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - } - } - }, - { - "id": 546, - "name": "last_sign_in_at", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 84, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 544, - "name": "provider", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 82, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 547, - "name": "updated_at", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 85, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 539, - "name": "user_id", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 78, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 545, - 538, - 540, - 546, - 544, - 547, - 539 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 76, - "character": 17 - } - ] - }, - { - "id": 646, - "name": "VerifyEmailOTPParams", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 647, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 253, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 648, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 254, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 649, - "name": "token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 255, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 650, + "id": 422, "name": "type", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's verification type." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 256, + "line": 288, "character": 2 } ], "type": { "type": "reference", - "id": 652, - "name": "EmailOTPType" + "id": 428, + "name": "MobileOtpType" } } ], @@ -15696,128 +8248,23 @@ "title": "Properties", "kind": 1024, "children": [ - 647, - 648, - 649, - 650 + 419, + 420, + 421, + 422 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 252, + "line": 280, "character": 17 } ] }, { - "id": 641, - "name": "VerifyMobileOTPParams", - "kind": 256, - "kindString": "Interface", - "flags": {}, - "children": [ - { - "id": 642, - "name": "email", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 247, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "undefined" - } - }, - { - "id": 643, - "name": "phone", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 248, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 644, - "name": "token", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 249, - "character": 2 - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 645, - "name": "type", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 250, - "character": 2 - } - ], - "type": { - "type": "reference", - "id": 651, - "name": "MobileOTPType" - } - } - ], - "groups": [ - { - "title": "Properties", - "kind": 1024, - "children": [ - 642, - 643, - 644, - 645 - ] - } - ], - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 246, - "character": 17 - } - ] - }, - { - "id": 502, + "id": 269, "name": "AuthChangeEvent", "kind": 4194304, "kindString": "Type alias", @@ -15825,7 +8272,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 21, + "line": 22, "character": 12 } ], @@ -15860,7 +8307,7 @@ } }, { - "id": 503, + "id": 270, "name": "AuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -15868,7 +8315,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 29, + "line": 30, "character": 12 } ], @@ -15878,14 +8325,14 @@ { "type": "reflection", "declaration": { - "id": 504, + "id": 271, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 505, + "id": 272, "name": "data", "kind": 1024, "kindString": "Property", @@ -15893,25 +8340,53 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 31, + "line": 32, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 506, + "id": 273, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 508, + "id": 275, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 34, + "character": 8 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 307, + "name": "Session" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 274, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -15924,35 +8399,7 @@ "types": [ { "type": "reference", - "id": 529, - "name": "Session" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 507, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 32, - "character": 8 - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "id": 548, + "id": 326, "name": "User" }, { @@ -15968,15 +8415,15 @@ "title": "Properties", "kind": 1024, "children": [ - 508, - 507 + 275, + 274 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 31, + "line": 32, "character": 12 } ] @@ -15984,7 +8431,7 @@ } }, { - "id": 509, + "id": 276, "name": "error", "kind": 1024, "kindString": "Property", @@ -15992,7 +8439,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 35, + "line": 36, "character": 6 } ], @@ -16007,15 +8454,15 @@ "title": "Properties", "kind": 1024, "children": [ - 505, - 509 + 272, + 276 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 30, + "line": 31, "character": 4 } ] @@ -16024,14 +8471,14 @@ { "type": "reflection", "declaration": { - "id": 510, + "id": 277, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 511, + "id": 278, "name": "data", "kind": 1024, "kindString": "Property", @@ -16039,25 +8486,43 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 38, + "line": 39, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 512, + "id": 279, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 514, + "id": 281, "name": "session", "kind": 1024, "kindString": "Property", "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 41, + "character": 8 + } + ], + "type": { + "type": "literal", + "value": null + } + }, + { + "id": 280, + "name": "user", + "kind": 1024, + "kindString": "Property", + "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", @@ -16069,24 +8534,6 @@ "type": "literal", "value": null } - }, - { - "id": 513, - "name": "user", - "kind": 1024, - "kindString": "Property", - "flags": {}, - "sources": [ - { - "fileName": "src/lib/types.ts", - "line": 39, - "character": 8 - } - ], - "type": { - "type": "literal", - "value": null - } } ], "groups": [ @@ -16094,15 +8541,15 @@ "title": "Properties", "kind": 1024, "children": [ - 514, - 513 + 281, + 280 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 38, + "line": 39, "character": 12 } ] @@ -16110,7 +8557,7 @@ } }, { - "id": 515, + "id": 282, "name": "error", "kind": 1024, "kindString": "Property", @@ -16118,13 +8565,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 42, + "line": 43, "character": 6 } ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } } @@ -16134,15 +8581,15 @@ "title": "Properties", "kind": 1024, "children": [ - 511, - 515 + 278, + 282 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 37, + "line": 38, "character": 4 } ] @@ -16152,7 +8599,7 @@ } }, { - "id": 660, + "id": 432, "name": "CallRefreshTokenResult", "kind": 4194304, "kindString": "Type alias", @@ -16160,7 +8607,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 280, + "line": 320, "character": 12 } ], @@ -16170,14 +8617,14 @@ { "type": "reflection", "declaration": { - "id": 661, + "id": 433, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 663, + "id": 435, "name": "error", "kind": 1024, "kindString": "Property", @@ -16185,7 +8632,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 283, + "line": 323, "character": 6 } ], @@ -16195,7 +8642,7 @@ } }, { - "id": 662, + "id": 434, "name": "session", "kind": 1024, "kindString": "Property", @@ -16203,13 +8650,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 282, + "line": 322, "character": 6 } ], "type": { "type": "reference", - "id": 529, + "id": 307, "name": "Session" } } @@ -16219,15 +8666,15 @@ "title": "Properties", "kind": 1024, "children": [ - 663, - 662 + 435, + 434 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 281, + "line": 321, "character": 4 } ] @@ -16236,14 +8683,14 @@ { "type": "reflection", "declaration": { - "id": 664, + "id": 436, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 666, + "id": 438, "name": "error", "kind": 1024, "kindString": "Property", @@ -16251,18 +8698,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 287, + "line": 327, "character": 6 } ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } }, { - "id": 665, + "id": 437, "name": "session", "kind": 1024, "kindString": "Property", @@ -16270,7 +8717,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 286, + "line": 326, "character": 6 } ], @@ -16285,15 +8732,15 @@ "title": "Properties", "kind": 1024, "children": [ - 666, - 665 + 438, + 437 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 285, + "line": 325, "character": 4 } ] @@ -16303,15 +8750,15 @@ } }, { - "id": 652, - "name": "EmailOTPType", + "id": 429, + "name": "EmailOtpType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 259, + "line": 298, "character": 12 } ], @@ -16342,15 +8789,61 @@ } }, { - "id": 651, - "name": "MobileOTPType", + "id": 430, + "name": "GenerateLinkTypes", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "comment": { + "shortText": "The link type" + }, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 301, + "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": 428, + "name": "MobileOtpType", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 258, + "line": 297, "character": 12 } ], @@ -16369,7 +8862,7 @@ } }, { - "id": 516, + "id": 283, "name": "OAuthResponse", "kind": 4194304, "kindString": "Type alias", @@ -16377,7 +8870,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 45, + "line": 46, "character": 12 } ], @@ -16387,14 +8880,14 @@ { "type": "reflection", "declaration": { - "id": 517, + "id": 284, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 518, + "id": 285, "name": "data", "kind": 1024, "kindString": "Property", @@ -16402,21 +8895,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 47, + "line": 48, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 519, + "id": 286, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 520, + "id": 287, "name": "provider", "kind": 1024, "kindString": "Property", @@ -16424,18 +8917,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 48, + "line": 49, "character": 8 } ], "type": { "type": "reference", - "id": 501, + "id": 268, "name": "Provider" } }, { - "id": 521, + "id": 288, "name": "url", "kind": 1024, "kindString": "Property", @@ -16443,7 +8936,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 49, + "line": 50, "character": 8 } ], @@ -16458,15 +8951,15 @@ "title": "Properties", "kind": 1024, "children": [ - 520, - 521 + 287, + 288 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 47, + "line": 48, "character": 12 } ] @@ -16474,7 +8967,7 @@ } }, { - "id": 522, + "id": 289, "name": "error", "kind": 1024, "kindString": "Property", @@ -16482,7 +8975,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 51, + "line": 52, "character": 6 } ], @@ -16497,15 +8990,15 @@ "title": "Properties", "kind": 1024, "children": [ - 518, - 522 + 285, + 289 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 46, + "line": 47, "character": 4 } ] @@ -16514,14 +9007,14 @@ { "type": "reflection", "declaration": { - "id": 523, + "id": 290, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 524, + "id": 291, "name": "data", "kind": 1024, "kindString": "Property", @@ -16529,21 +9022,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 6 } ], "type": { "type": "reflection", "declaration": { - "id": 525, + "id": 292, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 526, + "id": 293, "name": "provider", "kind": 1024, "kindString": "Property", @@ -16551,18 +9044,18 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 55, + "line": 56, "character": 8 } ], "type": { "type": "reference", - "id": 501, + "id": 268, "name": "Provider" } }, { - "id": 527, + "id": 294, "name": "url", "kind": 1024, "kindString": "Property", @@ -16570,7 +9063,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 56, + "line": 57, "character": 8 } ], @@ -16585,15 +9078,15 @@ "title": "Properties", "kind": 1024, "children": [ - 526, - 527 + 293, + 294 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 54, + "line": 55, "character": 12 } ] @@ -16601,7 +9094,7 @@ } }, { - "id": 528, + "id": 295, "name": "error", "kind": 1024, "kindString": "Property", @@ -16609,13 +9102,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 58, + "line": 59, "character": 6 } ], "type": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } } @@ -16625,15 +9118,15 @@ "title": "Properties", "kind": 1024, "children": [ - 524, - 528 + 291, + 295 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 53, + "line": 54, "character": 4 } ] @@ -16643,15 +9136,18 @@ } }, { - "id": 501, + "id": 268, "name": "Provider", "kind": 4194304, "kindString": "Type alias", "flags": {}, + "comment": { + "shortText": "One of the providers supported by GoTrue." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 3, + "line": 4, "character": 12 } ], @@ -16726,7 +9222,7 @@ } }, { - "id": 629, + "id": 406, "name": "SignInWithOAuthCredentials", "kind": 4194304, "kindString": "Type alias", @@ -16734,21 +9230,21 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 235, + "line": 265, "character": 12 } ], "type": { "type": "reflection", "declaration": { - "id": 630, + "id": 407, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 632, + "id": 409, "name": "options", "kind": 1024, "kindString": "Property", @@ -16758,32 +9254,35 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 237, + "line": 268, "character": 2 } ], "type": { "type": "reference", - "id": 633, + "id": 410, "name": "SignInWithOAuthOptions" } }, { - "id": 631, + "id": 408, "name": "provider", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "One of the providers supported by GoTrue." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 236, + "line": 267, "character": 2 } ], "type": { "type": "reference", - "id": 501, + "id": 268, "name": "Provider" } } @@ -16793,15 +9292,15 @@ "title": "Properties", "kind": 1024, "children": [ - 632, - 631 + 409, + 408 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 235, + "line": 265, "character": 41 } ] @@ -16809,7 +9308,7 @@ } }, { - "id": 607, + "id": 384, "name": "SignInWithPasswordCredentials", "kind": 4194304, "kindString": "Type alias", @@ -16817,7 +9316,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 206, + "line": 230, "character": 12 } ], @@ -16827,22 +9326,25 @@ { "type": "reflection", "declaration": { - "id": 608, + "id": 385, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 609, + "id": 386, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's email address." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 208, + "line": 233, "character": 6 } ], @@ -16852,7 +9354,7 @@ } }, { - "id": 611, + "id": 388, "name": "options", "kind": 1024, "kindString": "Property", @@ -16862,26 +9364,29 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 210, + "line": 236, "character": 6 } ], "type": { "type": "reference", - "id": 616, + "id": 393, "name": "SignInWithPasswordOptions" } }, { - "id": 610, + "id": 387, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's password." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 209, + "line": 235, "character": 6 } ], @@ -16896,16 +9401,16 @@ "title": "Properties", "kind": 1024, "children": [ - 609, - 611, - 610 + 386, + 388, + 387 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 207, + "line": 231, "character": 4 } ] @@ -16914,14 +9419,14 @@ { "type": "reflection", "declaration": { - "id": 612, + "id": 389, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 615, + "id": 392, "name": "options", "kind": 1024, "kindString": "Property", @@ -16931,26 +9436,29 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 215, + "line": 243, "character": 6 } ], "type": { "type": "reference", - "id": 616, + "id": 393, "name": "SignInWithPasswordOptions" } }, { - "id": 614, + "id": 391, "name": "password", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's password." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 214, + "line": 242, "character": 6 } ], @@ -16960,15 +9468,18 @@ } }, { - "id": 613, + "id": 390, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 213, + "line": 240, "character": 6 } ], @@ -16983,16 +9494,16 @@ "title": "Properties", "kind": 1024, "children": [ - 615, - 614, - 613 + 392, + 391, + 390 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 212, + "line": 238, "character": 4 } ] @@ -17002,7 +9513,7 @@ } }, { - "id": 618, + "id": 395, "name": "SignInWithPasswordlessCredentials", "kind": 4194304, "kindString": "Type alias", @@ -17010,7 +9521,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 220, + "line": 248, "character": 12 } ], @@ -17020,22 +9531,25 @@ { "type": "reflection", "declaration": { - "id": 619, + "id": 396, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 620, + "id": 397, "name": "email", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's email address." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 222, + "line": 251, "character": 6 } ], @@ -17045,7 +9559,7 @@ } }, { - "id": 621, + "id": 398, "name": "options", "kind": 1024, "kindString": "Property", @@ -17055,13 +9569,13 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 223, + "line": 252, "character": 6 } ], "type": { "type": "reference", - "id": 625, + "id": 402, "name": "SignInWithPasswordlessOptions" } } @@ -17071,15 +9585,15 @@ "title": "Properties", "kind": 1024, "children": [ - 620, - 621 + 397, + 398 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 221, + "line": 249, "character": 4 } ] @@ -17088,14 +9602,14 @@ { "type": "reflection", "declaration": { - "id": 622, + "id": 399, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 624, + "id": 401, "name": "options", "kind": 1024, "kindString": "Property", @@ -17105,26 +9619,29 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 227, + "line": 257, "character": 6 } ], "type": { "type": "reference", - "id": 625, + "id": 402, "name": "SignInWithPasswordlessOptions" } }, { - "id": 623, + "id": 400, "name": "phone", "kind": 1024, "kindString": "Property", "flags": {}, + "comment": { + "shortText": "The user's phone number." + }, "sources": [ { "fileName": "src/lib/types.ts", - "line": 226, + "line": 256, "character": 6 } ], @@ -17139,15 +9656,15 @@ "title": "Properties", "kind": 1024, "children": [ - 624, - 623 + 401, + 400 ] } ], "sources": [ { "fileName": "src/lib/types.ts", - "line": 225, + "line": 254, "character": 4 } ] @@ -17157,7 +9674,7 @@ } }, { - "id": 659, + "id": 431, "name": "SupportedStorage", "kind": 4194304, "kindString": "Type alias", @@ -17165,7 +9682,7 @@ "sources": [ { "fileName": "src/lib/types.ts", - "line": 278, + "line": 318, "character": 12 } ], @@ -17208,15 +9725,250 @@ } }, { - "id": 640, - "name": "VerifyOTPParams", + "id": 296, + "name": "UserResponse", "kind": 4194304, "kindString": "Type alias", "flags": {}, "sources": [ { "fileName": "src/lib/types.ts", - "line": 245, + "line": 62, + "character": 12 + } + ], + "type": { + "type": "union", + "types": [ + { + "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": 64, + "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": 65, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 326, + "name": "User" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 300 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 64, + "character": 12 + } + ] + } + } + }, + { + "id": 301, + "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": [ + 298, + 301 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 63, + "character": 4 + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 302, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 303, + "name": "data", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 70, + "character": 6 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 304, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": {}, + "children": [ + { + "id": 305, + "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": [ + 305 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 70, + "character": 12 + } + ] + } + } + }, + { + "id": 306, + "name": "error", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 73, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 442, + "name": "AuthError" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 303, + 306 + ] + } + ], + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 69, + "character": 4 + } + ] + } + } + ] + } + }, + { + "id": 417, + "name": "VerifyOtpParams", + "kind": 4194304, + "kindString": "Type alias", + "flags": {}, + "sources": [ + { + "fileName": "src/lib/types.ts", + "line": 279, "character": 12 } ], @@ -17225,19 +9977,19 @@ "types": [ { "type": "reference", - "id": 641, - "name": "VerifyMobileOTPParams" + "id": 418, + "name": "VerifyMobileOtpParams" }, { "type": "reference", - "id": 646, - "name": "VerifyEmailOTPParams" + "id": 423, + "name": "VerifyEmailOtpParams" } ] } }, { - "id": 667, + "id": 439, "name": "isAuthError", "kind": 64, "kindString": "Function", @@ -17251,14 +10003,14 @@ ], "signatures": [ { - "id": 668, + "id": 440, "name": "isAuthError", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 669, + "id": 441, "name": "error", "kind": 32768, "kindString": "Parameter", @@ -17275,7 +10027,7 @@ "asserts": false, "targetType": { "type": "reference", - "id": 670, + "id": 442, "name": "AuthError" } } @@ -17288,59 +10040,60 @@ "title": "Classes", "kind": 128, "children": [ - 675, - 670, - 722, - 735, - 710, - 688, - 695, + 447, + 442, + 494, + 507, + 482, + 460, + 467, 1, - 296 + 81 ] }, { "title": "Interfaces", "kind": 256, "children": [ - 582, - 653, - 529, - 633, - 616, - 625, - 592, - 548, - 576, - 600, - 537, - 646, - 641 + 360, + 307, + 410, + 393, + 402, + 370, + 326, + 354, + 378, + 315, + 423, + 418 ] }, { "title": "Type Aliases", "kind": 4194304, "children": [ - 502, - 503, - 660, - 652, - 651, - 516, - 501, - 629, - 607, - 618, - 659, - 640 + 269, + 270, + 432, + 429, + 430, + 428, + 283, + 268, + 406, + 384, + 395, + 431, + 296, + 417 ] }, { "title": "Functions", "kind": 64, "children": [ - 667 + 439 ] } ],