{ "id": 0, "name": "@supabase/auth-js", "variant": "project", "kind": 1, "flags": {}, "children": [ { "id": 1676, "name": "AuthApiError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error returned directly from the GoTrue REST API." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nimport { AuthApiError } from '@supabase/auth-js'\n\nthrow new AuthApiError('Invalid credentials', 400, 'invalid_credentials')\n```" } ] } ] }, "children": [ { "id": 1677, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 53, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L53" } ], "signatures": [ { "id": 1678, "name": "AuthApiError", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 53, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L53" } ], "parameters": [ { "id": 1679, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1680, "name": "status", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "number" } }, { "id": 1681, "name": "code", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "type": { "type": "reference", "target": 1676, "name": "AuthApiError", "package": "@supabase/auth-js" }, "overwrites": { "type": "reference", "target": 1668, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", "target": 1667, "name": "AuthError.constructor" } }, { "id": 1683, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " }, { "kind": "inline-tag", "tag": "@link", "text": "#status" }, { "kind": "text", "text": " will also be undefined." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 21, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L21" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "target": { "sourceFileName": "src/lib/error-codes.ts", "qualifiedName": "ErrorCode" }, "name": "ErrorCode", "package": "@supabase/auth-js" }, { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reflection", "declaration": { "id": 1684, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {} } } ] } ] }, "inheritedFrom": { "type": "reference", "target": 1672, "name": "AuthError.code" } }, { "id": 1682, "name": "status", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "HTTP status code that caused the error." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 51, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L51" } ], "type": { "type": "intrinsic", "name": "number" }, "overwrites": { "type": "reference", "target": 1674, "name": "AuthError.status" } } ], "groups": [ { "title": "Constructors", "children": [1677] }, { "title": "Properties", "children": [1683, 1682] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 50, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L50" } ], "extendedTypes": [ { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } ] }, { "id": 1666, "name": "AuthError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Base error thrown by Supabase Auth helpers." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nimport { AuthError } from '@supabase/auth-js'\n\nthrow new AuthError('Unexpected auth error', 500, 'unexpected')\n```" } ] } ] }, "children": [ { "id": 1667, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 28, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L28" } ], "signatures": [ { "id": 1668, "name": "AuthError", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 28, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L28" } ], "parameters": [ { "id": 1669, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1670, "name": "status", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 1671, "name": "code", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" }, "overwrites": { "type": "reference", "target": -1, "name": "Error.constructor" } } ], "overwrites": { "type": "reference", "target": -1, "name": "Error.constructor" } }, { "id": 1672, "name": "code", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " }, { "kind": "inline-tag", "tag": "@link", "text": "#status" }, { "kind": "text", "text": " will also be undefined." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 21, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L21" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "target": { "sourceFileName": "src/lib/error-codes.ts", "qualifiedName": "ErrorCode" }, "name": "ErrorCode", "package": "@supabase/auth-js" }, { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reflection", "declaration": { "id": 1673, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {} } } ] } ] } }, { "id": 1674, "name": "status", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "HTTP status code that caused the error." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 24, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L24" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } } ], "groups": [ { "title": "Constructors", "children": [1667] }, { "title": "Properties", "children": [1672, 1674] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 14, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L14" } ], "extendedTypes": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Error" }, "name": "Error", "package": "typescript" } ], "extendedBy": [ { "type": "reference", "target": 1676, "name": "AuthApiError" }, { "type": "reference", "target": 1686, "name": "AuthUnknownError" }, { "type": "reference", "target": 1696, "name": "CustomAuthError" } ] }, { "id": 1733, "name": "AuthImplicitGrantRedirectError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when implicit grant redirects contain an error." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nimport { AuthImplicitGrantRedirectError } from '@supabase/auth-js'\n\nthrow new AuthImplicitGrantRedirectError('OAuth redirect failed', {\n error: 'access_denied',\n code: 'oauth_error',\n})\n```" } ] } ] }, "children": [ { "id": 1734, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 177, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L177" } ], "signatures": [ { "id": 1735, "name": "AuthImplicitGrantRedirectError", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 177, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L177" } ], "parameters": [ { "id": 1736, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1737, "name": "details", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 1738, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1740, "name": "code", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 177, "character": 57, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L177" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1739, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 177, "character": 42, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L177" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1740, 1739] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 177, "character": 40, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L177" } ] } } ] }, "defaultValue": "null" } ], "type": { "type": "reference", "target": 1733, "name": "AuthImplicitGrantRedirectError", "package": "@supabase/auth-js" }, "overwrites": { "type": "reference", "target": 1698, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", "target": 1697, "name": "CustomAuthError.constructor" } }, { "id": 1757, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " }, { "kind": "inline-tag", "tag": "@link", "text": "#status" }, { "kind": "text", "text": " will also be undefined." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 21, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L21" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "target": { "sourceFileName": "src/lib/error-codes.ts", "qualifiedName": "ErrorCode" }, "name": "ErrorCode", "package": "@supabase/auth-js" }, { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reflection", "declaration": { "id": 1758, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {} } } ] } ] }, "inheritedFrom": { "type": "reference", "target": 1705, "name": "CustomAuthError.code" } }, { "id": 1741, "name": "details", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 176, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L176" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 1742, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1744, "name": "code", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 176, "character": 28, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L176" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1743, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 176, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L176" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1744, 1743] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 176, "character": 11, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L176" } ] } } ] }, "defaultValue": "null" }, { "id": 1755, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 100, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L100" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 1703, "name": "CustomAuthError.name" } }, { "id": 1756, "name": "status", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "HTTP status code that caused the error." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 101, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L101" } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 1704, "name": "CustomAuthError.status" } }, { "id": 1745, "name": "toJSON", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 182, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L182" } ], "signatures": [ { "id": 1746, "name": "toJSON", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 182, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L182" } ], "type": { "type": "reflection", "declaration": { "id": 1747, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1751, "name": "details", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 187, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L187" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 1752, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1754, "name": "code", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 176, "character": 28, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L176" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1753, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 176, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L176" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1754, 1753] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 176, "character": 11, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L176" } ] } } ] }, "defaultValue": "..." }, { "id": 1749, "name": "message", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 185, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L185" } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1748, "name": "name", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 184, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L184" } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1750, "name": "status", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 186, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L186" } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "..." } ], "groups": [ { "title": "Properties", "children": [1751, 1749, 1748, 1750] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 183, "character": 11, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L183" } ] } } } ] } ], "groups": [ { "title": "Constructors", "children": [1734] }, { "title": "Properties", "children": [1757, 1741, 1755, 1756] }, { "title": "Methods", "children": [1745] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 175, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L175" } ], "extendedTypes": [ { "type": "reference", "target": 1696, "name": "CustomAuthError", "package": "@supabase/auth-js" } ] }, { "id": 1724, "name": "AuthInvalidCredentialsError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when email/password credentials are invalid." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nimport { AuthInvalidCredentialsError } from '@supabase/auth-js'\n\nthrow new AuthInvalidCredentialsError('Email or password is incorrect')\n```" } ] } ] }, "children": [ { "id": 1725, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 157, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L157" } ], "signatures": [ { "id": 1726, "name": "AuthInvalidCredentialsError", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 157, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L157" } ], "parameters": [ { "id": 1727, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": 1724, "name": "AuthInvalidCredentialsError", "package": "@supabase/auth-js" }, "overwrites": { "type": "reference", "target": 1698, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", "target": 1697, "name": "CustomAuthError.constructor" } }, { "id": 1730, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " }, { "kind": "inline-tag", "tag": "@link", "text": "#status" }, { "kind": "text", "text": " will also be undefined." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 21, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L21" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "target": { "sourceFileName": "src/lib/error-codes.ts", "qualifiedName": "ErrorCode" }, "name": "ErrorCode", "package": "@supabase/auth-js" }, { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reflection", "declaration": { "id": 1731, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {} } } ] } ] }, "inheritedFrom": { "type": "reference", "target": 1705, "name": "CustomAuthError.code" } }, { "id": 1728, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 100, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L100" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 1703, "name": "CustomAuthError.name" } }, { "id": 1729, "name": "status", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "HTTP status code that caused the error." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 101, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L101" } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 1704, "name": "CustomAuthError.status" } } ], "groups": [ { "title": "Constructors", "children": [1725] }, { "title": "Properties", "children": [1730, 1728, 1729] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 156, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L156" } ], "extendedTypes": [ { "type": "reference", "target": 1696, "name": "CustomAuthError", "package": "@supabase/auth-js" } ] }, { "id": 1817, "name": "AuthInvalidJwtError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a JWT cannot be verified or parsed." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nimport { AuthInvalidJwtError } from '@supabase/auth-js'\n\nthrow new AuthInvalidJwtError('Token signature is invalid')\n```" } ] } ] }, "children": [ { "id": 1818, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 321, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L321" } ], "signatures": [ { "id": 1819, "name": "AuthInvalidJwtError", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 321, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L321" } ], "parameters": [ { "id": 1820, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": 1817, "name": "AuthInvalidJwtError", "package": "@supabase/auth-js" }, "overwrites": { "type": "reference", "target": 1698, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", "target": 1697, "name": "CustomAuthError.constructor" } }, { "id": 1823, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " }, { "kind": "inline-tag", "tag": "@link", "text": "#status" }, { "kind": "text", "text": " will also be undefined." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 21, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L21" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "target": { "sourceFileName": "src/lib/error-codes.ts", "qualifiedName": "ErrorCode" }, "name": "ErrorCode", "package": "@supabase/auth-js" }, { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reflection", "declaration": { "id": 1824, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {} } } ] } ] }, "inheritedFrom": { "type": "reference", "target": 1705, "name": "CustomAuthError.code" } }, { "id": 1821, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 100, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L100" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 1703, "name": "CustomAuthError.name" } }, { "id": 1822, "name": "status", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "HTTP status code that caused the error." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 101, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L101" } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 1704, "name": "CustomAuthError.status" } } ], "groups": [ { "title": "Constructors", "children": [1818] }, { "title": "Properties", "children": [1823, 1821, 1822] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 320, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L320" } ], "extendedTypes": [ { "type": "reference", "target": 1696, "name": "CustomAuthError", "package": "@supabase/auth-js" } ] }, { "id": 1716, "name": "AuthInvalidTokenResponseError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when the token response is malformed." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nimport { AuthInvalidTokenResponseError } from '@supabase/auth-js'\n\nthrow new AuthInvalidTokenResponseError()\n```" } ] } ] }, "children": [ { "id": 1717, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 141, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L141" } ], "signatures": [ { "id": 1718, "name": "AuthInvalidTokenResponseError", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 141, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L141" } ], "type": { "type": "reference", "target": 1716, "name": "AuthInvalidTokenResponseError", "package": "@supabase/auth-js" }, "overwrites": { "type": "reference", "target": 1698, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", "target": 1697, "name": "CustomAuthError.constructor" } }, { "id": 1721, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " }, { "kind": "inline-tag", "tag": "@link", "text": "#status" }, { "kind": "text", "text": " will also be undefined." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 21, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L21" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "target": { "sourceFileName": "src/lib/error-codes.ts", "qualifiedName": "ErrorCode" }, "name": "ErrorCode", "package": "@supabase/auth-js" }, { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reflection", "declaration": { "id": 1722, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {} } } ] } ] }, "inheritedFrom": { "type": "reference", "target": 1705, "name": "CustomAuthError.code" } }, { "id": 1719, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 100, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L100" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 1703, "name": "CustomAuthError.name" } }, { "id": 1720, "name": "status", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "HTTP status code that caused the error." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 101, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L101" } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 1704, "name": "CustomAuthError.status" } } ], "groups": [ { "title": "Constructors", "children": [1717] }, { "title": "Properties", "children": [1721, 1719, 1720] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 140, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L140" } ], "extendedTypes": [ { "type": "reference", "target": 1696, "name": "CustomAuthError", "package": "@supabase/auth-js" } ] }, { "id": 1787, "name": "AuthPKCECodeVerifierMissingError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when the PKCE code verifier is not found in storage.\nThis typically happens when the auth flow was initiated in a different\nbrowser, device, or the storage was cleared." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nimport { AuthPKCECodeVerifierMissingError } from '@supabase/auth-js'\n\nthrow new AuthPKCECodeVerifierMissingError()\n```" } ] } ] }, "children": [ { "id": 1788, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 239, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L239" } ], "signatures": [ { "id": 1789, "name": "AuthPKCECodeVerifierMissingError", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 239, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L239" } ], "type": { "type": "reference", "target": 1787, "name": "AuthPKCECodeVerifierMissingError", "package": "@supabase/auth-js" }, "overwrites": { "type": "reference", "target": 1698, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", "target": 1697, "name": "CustomAuthError.constructor" } }, { "id": 1792, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " }, { "kind": "inline-tag", "tag": "@link", "text": "#status" }, { "kind": "text", "text": " will also be undefined." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 21, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L21" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "target": { "sourceFileName": "src/lib/error-codes.ts", "qualifiedName": "ErrorCode" }, "name": "ErrorCode", "package": "@supabase/auth-js" }, { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reflection", "declaration": { "id": 1793, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {} } } ] } ] }, "inheritedFrom": { "type": "reference", "target": 1705, "name": "CustomAuthError.code" } }, { "id": 1790, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 100, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L100" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 1703, "name": "CustomAuthError.name" } }, { "id": 1791, "name": "status", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "HTTP status code that caused the error." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 101, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L101" } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 1704, "name": "CustomAuthError.status" } } ], "groups": [ { "title": "Constructors", "children": [1788] }, { "title": "Properties", "children": [1792, 1790, 1791] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 238, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L238" } ], "extendedTypes": [ { "type": "reference", "target": 1696, "name": "CustomAuthError", "package": "@supabase/auth-js" } ] }, { "id": 1760, "name": "AuthPKCEGrantCodeExchangeError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown during PKCE code exchanges." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nimport { AuthPKCEGrantCodeExchangeError } from '@supabase/auth-js'\n\nthrow new AuthPKCEGrantCodeExchangeError('PKCE exchange failed')\n```" } ] } ] }, "children": [ { "id": 1761, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 211, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L211" } ], "signatures": [ { "id": 1762, "name": "AuthPKCEGrantCodeExchangeError", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 211, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L211" } ], "parameters": [ { "id": 1763, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1764, "name": "details", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 1765, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1767, "name": "code", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 211, "character": 57, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L211" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1766, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 211, "character": 42, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L211" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1767, 1766] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 211, "character": 40, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L211" } ] } } ] }, "defaultValue": "null" } ], "type": { "type": "reference", "target": 1760, "name": "AuthPKCEGrantCodeExchangeError", "package": "@supabase/auth-js" }, "overwrites": { "type": "reference", "target": 1698, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", "target": 1697, "name": "CustomAuthError.constructor" } }, { "id": 1784, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " }, { "kind": "inline-tag", "tag": "@link", "text": "#status" }, { "kind": "text", "text": " will also be undefined." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 21, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L21" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "target": { "sourceFileName": "src/lib/error-codes.ts", "qualifiedName": "ErrorCode" }, "name": "ErrorCode", "package": "@supabase/auth-js" }, { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reflection", "declaration": { "id": 1785, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {} } } ] } ] }, "inheritedFrom": { "type": "reference", "target": 1705, "name": "CustomAuthError.code" } }, { "id": 1768, "name": "details", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 209, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L209" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 1769, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1771, "name": "code", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 209, "character": 28, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L209" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1770, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 209, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L209" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1771, 1770] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 209, "character": 11, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L209" } ] } } ] }, "defaultValue": "null" }, { "id": 1782, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 100, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L100" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 1703, "name": "CustomAuthError.name" } }, { "id": 1783, "name": "status", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "HTTP status code that caused the error." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 101, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L101" } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 1704, "name": "CustomAuthError.status" } }, { "id": 1772, "name": "toJSON", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 216, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L216" } ], "signatures": [ { "id": 1773, "name": "toJSON", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 216, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L216" } ], "type": { "type": "reflection", "declaration": { "id": 1774, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1778, "name": "details", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 221, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L221" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 1779, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1781, "name": "code", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 209, "character": 28, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L209" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1780, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 209, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L209" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1781, 1780] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 209, "character": 11, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L209" } ] } } ] }, "defaultValue": "..." }, { "id": 1776, "name": "message", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 219, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L219" } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1775, "name": "name", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 218, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L218" } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1777, "name": "status", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 220, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L220" } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "..." } ], "groups": [ { "title": "Properties", "children": [1778, 1776, 1775, 1777] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 217, "character": 11, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L217" } ] } } } ] } ], "groups": [ { "title": "Constructors", "children": [1761] }, { "title": "Properties", "children": [1784, 1768, 1782, 1783] }, { "title": "Methods", "children": [1772] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 208, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L208" } ], "extendedTypes": [ { "type": "reference", "target": 1696, "name": "CustomAuthError", "package": "@supabase/auth-js" } ] }, { "id": 1795, "name": "AuthRetryableFetchError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a transient fetch issue occurs." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nimport { AuthRetryableFetchError } from '@supabase/auth-js'\n\nthrow new AuthRetryableFetchError('Service temporarily unavailable', 503)\n```" } ] } ] }, "children": [ { "id": 1796, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 269, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L269" } ], "signatures": [ { "id": 1797, "name": "AuthRetryableFetchError", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 269, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L269" } ], "parameters": [ { "id": 1798, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1799, "name": "status", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "number" } } ], "type": { "type": "reference", "target": 1795, "name": "AuthRetryableFetchError", "package": "@supabase/auth-js" }, "overwrites": { "type": "reference", "target": 1698, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", "target": 1697, "name": "CustomAuthError.constructor" } }, { "id": 1802, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " }, { "kind": "inline-tag", "tag": "@link", "text": "#status" }, { "kind": "text", "text": " will also be undefined." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 21, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L21" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "target": { "sourceFileName": "src/lib/error-codes.ts", "qualifiedName": "ErrorCode" }, "name": "ErrorCode", "package": "@supabase/auth-js" }, { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reflection", "declaration": { "id": 1803, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {} } } ] } ] }, "inheritedFrom": { "type": "reference", "target": 1705, "name": "CustomAuthError.code" } }, { "id": 1800, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 100, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L100" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 1703, "name": "CustomAuthError.name" } }, { "id": 1801, "name": "status", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "HTTP status code that caused the error." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 101, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L101" } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 1704, "name": "CustomAuthError.status" } } ], "groups": [ { "title": "Constructors", "children": [1796] }, { "title": "Properties", "children": [1802, 1800, 1801] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 268, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L268" } ], "extendedTypes": [ { "type": "reference", "target": 1696, "name": "CustomAuthError", "package": "@supabase/auth-js" } ] }, { "id": 1708, "name": "AuthSessionMissingError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when an operation requires a session but none is present." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nimport { AuthSessionMissingError } from '@supabase/auth-js'\n\nthrow new AuthSessionMissingError()\n```" } ] } ] }, "children": [ { "id": 1709, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 121, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L121" } ], "signatures": [ { "id": 1710, "name": "AuthSessionMissingError", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 121, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L121" } ], "type": { "type": "reference", "target": 1708, "name": "AuthSessionMissingError", "package": "@supabase/auth-js" }, "overwrites": { "type": "reference", "target": 1698, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", "target": 1697, "name": "CustomAuthError.constructor" } }, { "id": 1713, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " }, { "kind": "inline-tag", "tag": "@link", "text": "#status" }, { "kind": "text", "text": " will also be undefined." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 21, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L21" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "target": { "sourceFileName": "src/lib/error-codes.ts", "qualifiedName": "ErrorCode" }, "name": "ErrorCode", "package": "@supabase/auth-js" }, { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reflection", "declaration": { "id": 1714, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {} } } ] } ] }, "inheritedFrom": { "type": "reference", "target": 1705, "name": "CustomAuthError.code" } }, { "id": 1711, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 100, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L100" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 1703, "name": "CustomAuthError.name" } }, { "id": 1712, "name": "status", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "HTTP status code that caused the error." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 101, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L101" } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 1704, "name": "CustomAuthError.status" } } ], "groups": [ { "title": "Constructors", "children": [1709] }, { "title": "Properties", "children": [1713, 1711, 1712] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 120, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L120" } ], "extendedTypes": [ { "type": "reference", "target": 1696, "name": "CustomAuthError", "package": "@supabase/auth-js" } ] }, { "id": 1686, "name": "AuthUnknownError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Wraps non-standard errors so callers can inspect the root cause." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nimport { AuthUnknownError } from '@supabase/auth-js'\n\ntry {\n await someAuthCall()\n} catch (err) {\n throw new AuthUnknownError('Auth failed', err)\n}\n```" } ] } ] }, "children": [ { "id": 1687, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 82, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L82" } ], "signatures": [ { "id": 1688, "name": "AuthUnknownError", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 82, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L82" } ], "parameters": [ { "id": 1689, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1690, "name": "originalError", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "target": 1686, "name": "AuthUnknownError", "package": "@supabase/auth-js" }, "overwrites": { "type": "reference", "target": 1668, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", "target": 1667, "name": "AuthError.constructor" } }, { "id": 1692, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " }, { "kind": "inline-tag", "tag": "@link", "text": "#status" }, { "kind": "text", "text": " will also be undefined." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 21, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L21" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "target": { "sourceFileName": "src/lib/error-codes.ts", "qualifiedName": "ErrorCode" }, "name": "ErrorCode", "package": "@supabase/auth-js" }, { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reflection", "declaration": { "id": 1693, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {} } } ] } ] }, "inheritedFrom": { "type": "reference", "target": 1672, "name": "AuthError.code" } }, { "id": 1691, "name": "originalError", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 80, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L80" } ], "type": { "type": "intrinsic", "name": "unknown" } }, { "id": 1694, "name": "status", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "HTTP status code that caused the error." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 24, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L24" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] }, "inheritedFrom": { "type": "reference", "target": 1674, "name": "AuthError.status" } } ], "groups": [ { "title": "Constructors", "children": [1687] }, { "title": "Properties", "children": [1692, 1691, 1694] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 79, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L79" } ], "extendedTypes": [ { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } ] }, { "id": 1805, "name": "AuthWeakPasswordError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when a supplied password is considered weak." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nimport { AuthWeakPasswordError } from '@supabase/auth-js'\n\nthrow new AuthWeakPasswordError('Password too short', 400, ['min_length'])\n```" } ] } ] }, "children": [ { "id": 1806, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 299, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L299" } ], "signatures": [ { "id": 1807, "name": "AuthWeakPasswordError", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 299, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L299" } ], "parameters": [ { "id": 1808, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1809, "name": "status", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "number" } }, { "id": 1810, "name": "reasons", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "array", "elementType": { "type": "union", "types": [ { "type": "literal", "value": "length" }, { "type": "literal", "value": "characters" }, { "type": "literal", "value": "pwned" } ] } } } ], "type": { "type": "reference", "target": 1805, "name": "AuthWeakPasswordError", "package": "@supabase/auth-js" }, "overwrites": { "type": "reference", "target": 1698, "name": "CustomAuthError.constructor" } } ], "overwrites": { "type": "reference", "target": 1697, "name": "CustomAuthError.constructor" } }, { "id": 1814, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " }, { "kind": "inline-tag", "tag": "@link", "text": "#status" }, { "kind": "text", "text": " will also be undefined." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 21, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L21" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "target": { "sourceFileName": "src/lib/error-codes.ts", "qualifiedName": "ErrorCode" }, "name": "ErrorCode", "package": "@supabase/auth-js" }, { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reflection", "declaration": { "id": 1815, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {} } } ] } ] }, "inheritedFrom": { "type": "reference", "target": 1705, "name": "CustomAuthError.code" } }, { "id": 1812, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 100, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L100" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 1703, "name": "CustomAuthError.name" } }, { "id": 1811, "name": "reasons", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Reasons why the password is deemed weak." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 297, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L297" } ], "type": { "type": "array", "elementType": { "type": "union", "types": [ { "type": "literal", "value": "length" }, { "type": "literal", "value": "characters" }, { "type": "literal", "value": "pwned" } ] } } }, { "id": 1813, "name": "status", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "HTTP status code that caused the error." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 101, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L101" } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 1704, "name": "CustomAuthError.status" } } ], "groups": [ { "title": "Constructors", "children": [1806] }, { "title": "Properties", "children": [1814, 1812, 1811, 1813] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 293, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L293" } ], "extendedTypes": [ { "type": "reference", "target": 1696, "name": "CustomAuthError", "package": "@supabase/auth-js" } ] }, { "id": 1696, "name": "CustomAuthError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Flexible error class used to create named auth errors at runtime." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nimport { CustomAuthError } from '@supabase/auth-js'\n\nthrow new CustomAuthError('My custom auth error', 'MyAuthError', 400, 'custom_code')\n```" } ] } ] }, "children": [ { "id": 1697, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 103, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L103" } ], "signatures": [ { "id": 1698, "name": "CustomAuthError", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 103, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L103" } ], "parameters": [ { "id": 1699, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1700, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1701, "name": "status", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "number" } }, { "id": 1702, "name": "code", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "type": { "type": "reference", "target": 1696, "name": "CustomAuthError", "package": "@supabase/auth-js" }, "overwrites": { "type": "reference", "target": 1668, "name": "AuthError.constructor" } } ], "overwrites": { "type": "reference", "target": 1667, "name": "AuthError.constructor" } }, { "id": 1705, "name": "code", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Error code associated with the error. Most errors coming from\nHTTP responses will have a code, though some errors that occur\nbefore a response is received will not have one present. In that\ncase " }, { "kind": "inline-tag", "tag": "@link", "text": "#status" }, { "kind": "text", "text": " will also be undefined." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 21, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L21" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "reference", "target": { "sourceFileName": "src/lib/error-codes.ts", "qualifiedName": "ErrorCode" }, "name": "ErrorCode", "package": "@supabase/auth-js" }, { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reflection", "declaration": { "id": 1706, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {} } } ] } ] }, "inheritedFrom": { "type": "reference", "target": 1672, "name": "AuthError.code" } }, { "id": 1703, "name": "name", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 100, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L100" } ], "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "target": -1, "name": "AuthError.name" } }, { "id": 1704, "name": "status", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "HTTP status code that caused the error." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 101, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L101" } ], "type": { "type": "intrinsic", "name": "number" }, "overwrites": { "type": "reference", "target": 1674, "name": "AuthError.status" } } ], "groups": [ { "title": "Constructors", "children": [1697] }, { "title": "Properties", "children": [1705, 1703, 1704] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 99, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L99" } ], "extendedTypes": [ { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } ], "extendedBy": [ { "type": "reference", "target": 1708, "name": "AuthSessionMissingError" }, { "type": "reference", "target": 1716, "name": "AuthInvalidTokenResponseError" }, { "type": "reference", "target": 1724, "name": "AuthInvalidCredentialsError" }, { "type": "reference", "target": 1733, "name": "AuthImplicitGrantRedirectError" }, { "type": "reference", "target": 1760, "name": "AuthPKCEGrantCodeExchangeError" }, { "type": "reference", "target": 1787, "name": "AuthPKCECodeVerifierMissingError" }, { "type": "reference", "target": 1795, "name": "AuthRetryableFetchError" }, { "type": "reference", "target": 1805, "name": "AuthWeakPasswordError" }, { "type": "reference", "target": 1817, "name": "AuthInvalidJwtError" } ] }, { "id": 1, "name": "GoTrueAdminApi", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { "id": 2, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 70, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L70" } ], "signatures": [ { "id": 3, "name": "GoTrueAdminApi", "variant": "signature", "kind": 16384, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates an admin API client that can be used to manage users and OAuth clients." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nimport { GoTrueAdminApi } from '@supabase/auth-js'\n\nconst admin = new GoTrueAdminApi({\n url: 'https://xyzcompany.supabase.co/auth/v1',\n headers: { Authorization: `Bearer ${process.env.SUPABASE_SERVICE_ROLE_KEY}` },\n})\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 70, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L70" } ], "parameters": [ { "id": 4, "name": "__namedParameters", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 5, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 11, "name": "fetch", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 79, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L79" } ], "type": { "type": "reflection", "declaration": { "id": 12, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 }, { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "signatures": [ { "id": 13, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 } ], "parameters": [ { "id": 14, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInfo" }, "name": "RequestInfo", "package": "typescript" } ] } }, { "id": 15, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } }, { "id": 16, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "parameters": [ { "id": 17, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Request" }, "name": "Request", "package": "typescript" } ] } }, { "id": 18, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 7, "name": "headers", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 76, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L76" } ], "type": { "type": "reflection", "declaration": { "id": 8, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 76, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L76" } ], "indexSignatures": [ { "id": 9, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 77, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L77" } ], "parameters": [ { "id": 10, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } }, "defaultValue": "{}" }, { "id": 6, "name": "url", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 75, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L75" } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "''" } ], "groups": [ { "title": "Properties", "children": [11, 7, 6] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 74, "character": 5, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L74" } ] } } } ], "type": { "type": "reference", "target": 1, "name": "GoTrueAdminApi", "package": "@supabase/auth-js", "qualifiedName": "default" } } ] }, { "id": 21, "name": "customProviders", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Contains all custom OIDC/OAuth provider administration methods." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 49, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L49" } ], "type": { "type": "reference", "target": 1573, "name": "GoTrueAdminCustomProvidersApi", "package": "@supabase/auth-js" } }, { "id": 19, "name": "mfa", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Contains all MFA administration methods." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 40, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L40" } ], "type": { "type": "reference", "target": 1329, "name": "GoTrueAdminMFAApi", "package": "@supabase/auth-js" } }, { "id": 20, "name": "oauth", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Contains all OAuth client administration methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 46, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L46" } ], "type": { "type": "reference", "target": 1458, "name": "GoTrueAdminOAuthApi", "package": "@supabase/auth-js" } }, { "id": 52, "name": "createUser", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 452, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L452" } ], "signatures": [ { "id": 53, "name": "createUser", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates a new user.\nThis function should only be called on a server. Never expose your " }, { "kind": "code", "text": "`service_role`" }, { "kind": "text", "text": " key in the browser." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- To confirm the user's email address or phone number, set " }, { "kind": "code", "text": "`email_confirm`" }, { "kind": "text", "text": " or " }, { "kind": "code", "text": "`phone_confirm`" }, { "kind": "text", "text": " to true. Both arguments default to false.\n- " }, { "kind": "code", "text": "`createUser()`" }, { "kind": "text", "text": " will not send a confirmation email to the user. You can use [" }, { "kind": "code", "text": "`inviteUserByEmail()`" }, { "kind": "text", "text": "](/docs/reference/javascript/auth-admin-inviteuserbyemail) if you want to send them an email invite instead.\n- If you are sure that the created user's email or phone number is legitimate and verified, you can set the " }, { "kind": "code", "text": "`email_confirm`" }, { "kind": "text", "text": " or " }, { "kind": "code", "text": "`phone_confirm`" }, { "kind": "text", "text": " param to " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": "." } ] }, { "tag": "@example", "name": "With custom user metadata", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n email: 'user@email.com',\n password: 'password',\n user_metadata: { name: 'Yoda' }\n})\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With custom user metadata\n" }, { "kind": "code", "text": "```json\n{\n data: {\n user: {\n id: '1',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {},\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"1\",\n \"user_id\": \"1\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"1\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n }\n }\n error: null\n}\n```" } ] }, { "tag": "@example", "name": "Auto-confirm the user's email", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n email: 'user@email.com',\n email_confirm: true\n})\n```" } ] }, { "tag": "@example", "name": "Auto-confirm the user's phone number", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.admin.createUser({\n phone: '1234567890',\n phone_confirm: true\n})\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 452, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L452" } ], "parameters": [ { "id": 54, "name": "attributes", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 927, "name": "AdminUserAttributes", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 844, "name": "UserResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 76, "name": "deleteUser", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 802, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L802" } ], "signatures": [ { "id": 77, "name": "deleteUser", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Delete a user. Requires a " }, { "kind": "code", "text": "`service_role`" }, { "kind": "text", "text": " key." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- The " }, { "kind": "code", "text": "`deleteUser()`" }, { "kind": "text", "text": " method requires the user's ID, which maps to the " }, { "kind": "code", "text": "`auth.users.id`" }, { "kind": "text", "text": " column." } ] }, { "tag": "@example", "name": "Removes a user", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.admin.deleteUser(\n '715ed5db-f090-4b8c-a067-640ecee36aa0'\n)\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Removes a user\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"user\": {}\n },\n \"error\": null\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 802, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L802" } ], "parameters": [ { "id": 78, "name": "id", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The user id you want to remove." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 79, "name": "shouldSoftDelete", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "If true, then the user will be soft-deleted from the auth schema. Soft deletion allows user identification from the hashed user ID but is not reversible.\nDefaults to false for backward compatibility.\n\nThis function should only be called on a server. Never expose your " }, { "kind": "code", "text": "`service_role`" }, { "kind": "text", "text": " key in the browser." } ] }, "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 844, "name": "UserResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 49, "name": "generateLink", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 343, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L343" } ], "signatures": [ { "id": 50, "name": "generateLink", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Generates email links and OTPs to be sent via a custom email provider." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- The following types can be passed into " }, { "kind": "code", "text": "`generateLink()`" }, { "kind": "text", "text": ": " }, { "kind": "code", "text": "`signup`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`magiclink`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`invite`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`recovery`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`email_change_current`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`email_change_new`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`phone_change`" }, { "kind": "text", "text": ".\n- " }, { "kind": "code", "text": "`generateLink()`" }, { "kind": "text", "text": " only generates the email link for " }, { "kind": "code", "text": "`email_change_email`" }, { "kind": "text", "text": " if the **Secure email change** is enabled in your project's [email auth provider settings](/dashboard/project/_/auth/providers).\n- " }, { "kind": "code", "text": "`generateLink()`" }, { "kind": "text", "text": " handles the creation of the user for " }, { "kind": "code", "text": "`signup`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`invite`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`magiclink`" }, { "kind": "text", "text": "." } ] }, { "tag": "@example", "name": "Generate a signup link", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'signup',\n email: 'email@example.com',\n password: 'secret'\n})\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Generate a signup link\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"properties\": {\n \"action_link\": \"\",\n \"email_otp\": \"999999\",\n \"hashed_token\": \"\",\n \"verification_type\": \"signup\"\n },\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"email@example.com\",\n \"phone\": \"\",\n \"confirmation_sent_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"email@example.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@example", "name": "Generate an invite link", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'invite',\n email: 'email@example.com'\n})\n```" } ] }, { "tag": "@example", "name": "Generate a magic link", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'magiclink',\n email: 'email@example.com'\n})\n```" } ] }, { "tag": "@example", "name": "Generate a recovery link", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'recovery',\n email: 'email@example.com'\n})\n```" } ] }, { "tag": "@example", "name": "Generate links to change current email address", "content": [ { "kind": "code", "text": "```js\n// generate an email change link to be sent to the current email address\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'email_change_current',\n email: 'current.email@example.com',\n newEmail: 'new.email@example.com'\n})\n\n// generate an email change link to be sent to the new email address\nconst { data, error } = await supabase.auth.admin.generateLink({\n type: 'email_change_new',\n email: 'current.email@example.com',\n newEmail: 'new.email@example.com'\n})\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 343, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L343" } ], "parameters": [ { "id": 51, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1138, "name": "GenerateLinkParams", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1139, "name": "GenerateLinkResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 69, "name": "getUserById", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 593, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L593" } ], "signatures": [ { "id": 70, "name": "getUserById", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Get user by id." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Fetches the user object from the database based on the user's id.\n- The " }, { "kind": "code", "text": "`getUserById()`" }, { "kind": "text", "text": " method requires the user's id which maps to the " }, { "kind": "code", "text": "`auth.users.id`" }, { "kind": "text", "text": " column." } ] }, { "tag": "@example", "name": "Fetch the user object using the access_token jwt", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.admin.getUserById(1)\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Fetch the user object using the access_token jwt\n" }, { "kind": "code", "text": "```json\n{\n data: {\n user: {\n id: '1',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {},\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"1\",\n \"user_id\": \"1\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"1\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n }\n }\n error: null\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 593, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L593" } ], "parameters": [ { "id": 71, "name": "uid", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The user's unique identifier\n\nThis function should only be called on a server. Never expose your " }, { "kind": "code", "text": "`service_role`" }, { "kind": "text", "text": " key in the browser." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 844, "name": "UserResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 42, "name": "inviteUserByEmail", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 201, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L201" } ], "signatures": [ { "id": 43, "name": "inviteUserByEmail", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Sends an invite link to an email address." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Sends an invite link to the user's email address.\n- The " }, { "kind": "code", "text": "`inviteUserByEmail()`" }, { "kind": "text", "text": " method is typically used by administrators to invite users to join the application.\n- Note that PKCE is not supported when using " }, { "kind": "code", "text": "`inviteUserByEmail`" }, { "kind": "text", "text": ". This is because the browser initiating the invite is often different from the browser accepting the invite which makes it difficult to provide the security guarantees required of the PKCE flow." } ] }, { "tag": "@example", "name": "Invite a user", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.admin.inviteUserByEmail('email@example.com')\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Invite a user\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"invited_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmation_sent_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 201, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L201" } ], "parameters": [ { "id": 44, "name": "email", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The email address of the user." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 45, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Additional options to be included when inviting." } ] }, "type": { "type": "reflection", "declaration": { "id": 46, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 47, "name": "data", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A custom data object to store additional metadata about the user. This maps to the " }, { "kind": "code", "text": "`auth.users.user_metadata`" }, { "kind": "text", "text": " column." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 205, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L205" } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 48, "name": "redirectTo", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The URL which will be appended to the email link sent to the user's email address. Once clicked the user will end up on this URL." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 208, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L208" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [47, 48] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 203, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L203" } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 844, "name": "UserResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 55, "name": "listUsers", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 492, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L492" } ], "signatures": [ { "id": 56, "name": "listUsers", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Get a list of users.\n\nThis function should only be called on a server. Never expose your " }, { "kind": "code", "text": "`service_role`" }, { "kind": "text", "text": " key in the browser." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Defaults to return 50 users per page." } ] }, { "tag": "@example", "name": "Get a page of users", "content": [ { "kind": "code", "text": "```js\nconst { data: { users }, error } = await supabase.auth.admin.listUsers()\n```" } ] }, { "tag": "@example", "name": "Paginated list of users", "content": [ { "kind": "code", "text": "```js\nconst { data: { users }, error } = await supabase.auth.admin.listUsers({\n page: 1,\n perPage: 1000\n})\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 492, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L492" } ], "parameters": [ { "id": 57, "name": "params", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "An object which supports " }, { "kind": "code", "text": "`page`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`perPage`" }, { "kind": "text", "text": " as numbers, to alter the paginated results." } ] }, "type": { "type": "reference", "target": 1350, "name": "PageParams", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 58, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 59, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 495, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L495" } ], "type": { "type": "intersection", "types": [ { "type": "reflection", "declaration": { "id": 60, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 62, "name": "aud", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 495, "character": 31, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L495" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 61, "name": "users", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 495, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L495" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 893, "name": "User", "package": "@supabase/auth-js" } } } ], "groups": [ { "title": "Properties", "children": [62, 61] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 495, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L495" } ] } }, { "type": "reference", "target": 1343, "name": "Pagination", "package": "@supabase/auth-js" } ] } }, { "id": 63, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 495, "character": 59, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L495" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [59, 63] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 495, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L495" } ] } }, { "type": "reflection", "declaration": { "id": 64, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 65, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 496, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L496" } ], "type": { "type": "reflection", "declaration": { "id": 66, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 67, "name": "users", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 496, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L496" } ], "type": { "type": "tuple" } } ], "groups": [ { "title": "Properties", "children": [67] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 496, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L496" } ] } } }, { "id": 68, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 496, "character": 29, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L496" } ], "type": { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [65, 68] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 496, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L496" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 35, "name": "signOut", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 112, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L112" } ], "signatures": [ { "id": 36, "name": "signOut", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Removes a logged-in session." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 112, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L112" } ], "parameters": [ { "id": 37, "name": "jwt", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "A valid, logged-in JWT." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 38, "name": "scope", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The logout sope." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": "global" }, { "type": "literal", "value": "local" }, { "type": "literal", "value": "others" } ] }, "defaultValue": "..." } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reflection", "declaration": { "id": 39, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 40, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 115, "character": 15, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L115" } ], "type": { "type": "literal", "value": null } }, { "id": 41, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 115, "character": 27, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L115" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } ] } } ], "groups": [ { "title": "Properties", "children": [40, 41] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 115, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L115" } ] } } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 72, "name": "updateUserById", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 753, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L753" } ], "signatures": [ { "id": 73, "name": "updateUserById", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Updates the user data. Changes are applied directly without confirmation flows." } ], "blockTags": [ { "tag": "@remarks", "content": [ { "kind": "text", "text": "**Important:** This is a server-side operation and does **not** trigger client-side\n" }, { "kind": "code", "text": "`onAuthStateChange`" }, { "kind": "text", "text": " listeners. The admin API has no connection to client state.\n\nTo sync changes to the client after calling this method:\n1. On the client, call " }, { "kind": "code", "text": "`supabase.auth.refreshSession()`" }, { "kind": "text", "text": " to fetch the updated user data\n2. This will trigger the " }, { "kind": "code", "text": "`TOKEN_REFRESHED`" }, { "kind": "text", "text": " event and notify all listeners" } ] }, { "tag": "@example", "content": [ { "kind": "code", "text": "```typescript\n// Server-side (Edge Function)\nconst { data, error } = await supabase.auth.admin.updateUserById(\n userId,\n { user_metadata: { preferences: { theme: 'dark' } } }\n)\n\n// Client-side (to sync the changes)\nconst { data, error } = await supabase.auth.refreshSession()\n// onAuthStateChange listeners will now be notified with updated user\n```" } ] }, { "tag": "@see", "content": [ { "kind": "text", "text": " - " }, { "kind": "inline-tag", "tag": "@link", "text": "GoTrueClient.refreshSession", "target": 398 }, { "kind": "text", "text": " for syncing admin changes to the client" }, { "kind": "text", "text": "\n" }, { "kind": "text", "text": " - " }, { "kind": "inline-tag", "tag": "@link", "text": "GoTrueClient.updateUser", "target": 374 }, { "kind": "text", "text": " for client-side user updates (triggers listeners automatically)" }, { "kind": "text", "text": "\n" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@example", "name": "Updates a user's email", "content": [ { "kind": "code", "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '11111111-1111-1111-1111-111111111111',\n { email: 'new@email.com' }\n)\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Updates a user's email\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"new@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"recovery_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@example", "name": "Updates a user's password", "content": [ { "kind": "code", "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { password: 'new_password' }\n)\n```" } ] }, { "tag": "@example", "name": "Updates a user's metadata", "content": [ { "kind": "code", "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { user_metadata: { hello: 'world' } }\n)\n```" } ] }, { "tag": "@example", "name": "Updates a user's app_metadata", "content": [ { "kind": "code", "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { app_metadata: { plan: 'trial' } }\n)\n```" } ] }, { "tag": "@example", "name": "Confirms a user's email address", "content": [ { "kind": "code", "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { email_confirm: true }\n)\n```" } ] }, { "tag": "@example", "name": "Confirms a user's phone number", "content": [ { "kind": "code", "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { phone_confirm: true }\n)\n```" } ] }, { "tag": "@example", "name": "Ban a user for 100 years", "content": [ { "kind": "code", "text": "```js\nconst { data: user, error } = await supabase.auth.admin.updateUserById(\n '6aa5d0d4-2a9f-4483-b6c8-0cf4c6c98ac4',\n { ban_duration: '876000h' }\n)\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 753, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L753" } ], "parameters": [ { "id": 74, "name": "uid", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The user's unique identifier" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 75, "name": "attributes", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The data you want to update.\n\nThis function should only be called on a server. Never expose your " }, { "kind": "code", "text": "`service_role`" }, { "kind": "text", "text": " key in the browser." } ] }, "type": { "type": "reference", "target": 927, "name": "AdminUserAttributes", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 844, "name": "UserResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] } ], "groups": [ { "title": "Constructors", "children": [2] }, { "title": "Properties", "children": [21, 19, 20] }, { "title": "Methods", "children": [52, 76, 49, 69, 42, 55, 35, 72] } ], "categories": [ { "title": "Auth", "children": [52, 76, 49, 69, 42, 55, 35, 72] }, { "title": "Other", "children": [2, 21, 19, 20] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueAdminApi.ts", "line": 38, "character": 21, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueAdminApi.ts#L38" } ] }, { "id": 127, "name": "GoTrueClient", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { "id": 129, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 299, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L299" } ], "signatures": [ { "id": 130, "name": "GoTrueClient", "variant": "signature", "kind": 16384, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Create a new client for use in the browser." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nimport { GoTrueClient } from '@supabase/auth-js'\n\nconst auth = new GoTrueClient({\n url: 'https://xyzcompany.supabase.co/auth/v1',\n headers: { apikey: 'public-anon-key' },\n storageKey: 'supabase-auth',\n})\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 299, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L299" } ], "parameters": [ { "id": 131, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 746, "name": "GoTrueClientOptions", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": 127, "name": "GoTrueClient", "package": "@supabase/auth-js", "qualifiedName": "default" } } ] }, { "id": 133, "name": "admin", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Namespace for the GoTrue admin methods.\nThese methods should only be used in a trusted server-side environment." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 204, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L204" } ], "type": { "type": "reference", "target": 1, "name": "GoTrueAdminApi", "package": "@supabase/auth-js", "qualifiedName": "default" } }, { "id": 134, "name": "mfa", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Namespace for the MFA methods." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 208, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L208" } ], "type": { "type": "reference", "target": 1198, "name": "GoTrueMFAApi", "package": "@supabase/auth-js" } }, { "id": 135, "name": "oauth", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Namespace for the OAuth 2.1 authorization server methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\nUsed to implement the authorization code flow on the consent page." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 214, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L214" } ], "type": { "type": "reference", "target": 1622, "name": "AuthOAuthServerApi", "package": "@supabase/auth-js" } }, { "id": 230, "name": "exchangeCodeForSession", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 1351, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L1351" } ], "signatures": [ { "id": 231, "name": "exchangeCodeForSession", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Log in an existing user by exchanging an Auth Code issued during the PKCE flow." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Used when " }, { "kind": "code", "text": "`flowType`" }, { "kind": "text", "text": " is set to " }, { "kind": "code", "text": "`pkce`" }, { "kind": "text", "text": " in client options." } ] }, { "tag": "@example", "name": "Exchange Auth Code", "content": [ { "kind": "code", "text": "```js\nsupabase.auth.exchangeCodeForSession('34e770dd-9ff9-416c-87fa-43b31d7ef225')\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Exchange Auth Code\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n session: {\n access_token: '',\n token_type: 'bearer',\n expires_in: 3600,\n expires_at: 1700000000,\n refresh_token: '',\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com'\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n \"provider\": \"email\",\n \"providers\": [\n \"email\",\n \"\"\n ]\n },\n user_metadata: {\n email: 'email@email.com',\n email_verified: true,\n full_name: 'User Name',\n iss: '',\n name: 'User Name',\n phone_verified: false,\n provider_id: '',\n sub: ''\n },\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n {\n \"identity_id\": \"33333333-3333-3333-3333-333333333333\",\n \"id\": \"\",\n \"user_id\": \"\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"full_name\": \"User Name\",\n \"iss\": \"\",\n \"name\": \"User Name\",\n \"phone_verified\": false,\n \"provider_id\": \"\",\n \"sub\": \"\"\n },\n \"provider\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false\n },\n provider_token: '',\n provider_refresh_token: ''\n },\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n provider: 'email',\n providers: [\n \"email\",\n \"\"\n ]\n },\n user_metadata: {\n email: 'email@email.com',\n email_verified: true,\n full_name: 'User Name',\n iss: '',\n name: 'User Name',\n phone_verified: false,\n provider_id: '',\n sub: ''\n },\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n {\n \"identity_id\": \"33333333-3333-3333-3333-333333333333\",\n \"id\": \"\",\n \"user_id\": \"\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"full_name\": \"User Name\",\n \"iss\": \"\",\n \"name\": \"User Name\",\n \"phone_verified\": false,\n \"provider_id\": \"\",\n \"sub\": \"\"\n },\n \"provider\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false\n },\n redirectType: null\n },\n \"error\": null\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 1351, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L1351" } ], "parameters": [ { "id": 232, "name": "authCode", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 819, "name": "AuthTokenResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 685, "name": "getClaims", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 5793, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L5793" } ], "signatures": [ { "id": 686, "name": "getClaims", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Extracts the JWT claims present in the access token by first verifying the\nJWT against the server's JSON Web Key Set endpoint\n" }, { "kind": "code", "text": "`/.well-known/jwks.json`" }, { "kind": "text", "text": " which is often cached, resulting in significantly\nfaster responses. Prefer this method over " }, { "kind": "inline-tag", "tag": "@link", "text": "#getUser" }, { "kind": "text", "text": " which always\nsends a request to the Auth server for each JWT.\n\nIf the project is not using an asymmetric JWT signing key (like ECC or\nRSA) it always sends a request to the Auth server (similar to " }, { "kind": "inline-tag", "tag": "@link", "text": "#getUser" }, { "kind": "text", "text": ") to verify the JWT." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Parses the user's [access token](/docs/guides/auth/sessions#access-token-jwt-claims) as a [JSON Web Token (JWT)](/docs/guides/auth/jwts) and returns its components if valid and not expired.\n- If your project is using asymmetric JWT signing keys, then the verification is done locally usually without a network request using the [WebCrypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API).\n- A network request is sent to your project's JWT signing key discovery endpoint " }, { "kind": "code", "text": "`https://project-id.supabase.co/auth/v1/.well-known/jwks.json`" }, { "kind": "text", "text": ", which is cached locally. If your environment is ephemeral, such as a Lambda function that is destroyed after every request, a network request will be sent for each new invocation. Supabase provides a network-edge cache providing fast responses for these situations.\n- If the user's access token is about to expire when calling this function, the user's session will first be refreshed before validating the JWT.\n- If your project is using a symmetric secret to sign the JWT, it always sends a request similar to " }, { "kind": "code", "text": "`getUser()`" }, { "kind": "text", "text": " to validate the JWT at the server before returning the decoded token. This is also used if the WebCrypto API is not available in the environment. Make sure you polyfill it in such situations.\n- The returned claims can be customized per project using the [Custom Access Token Hook](/docs/guides/auth/auth-hooks/custom-access-token-hook)." } ] }, { "tag": "@example", "name": "Get JWT claims, header and signature", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.getClaims()\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Get JWT claims, header and signature\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"claims\": {\n \"aal\": \"aal1\",\n \"amr\": [{\n \"method\": \"email\",\n \"timestamp\": 1715766000\n }],\n \"app_metadata\": {},\n \"aud\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"exp\": 1715769600,\n \"iat\": 1715766000,\n \"is_anonymous\": false,\n \"iss\": \"https://project-id.supabase.co/auth/v1\",\n \"phone\": \"+13334445555\",\n \"role\": \"authenticated\",\n \"session_id\": \"11111111-1111-1111-1111-111111111111\",\n \"sub\": \"11111111-1111-1111-1111-111111111111\",\n \"user_metadata\": {}\n },\n \"header\": {\n \"alg\": \"RS256\",\n \"typ\": \"JWT\",\n \"kid\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"signature\": [/** Uint8Array */],\n },\n \"error\": null\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 5793, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L5793" } ], "parameters": [ { "id": 687, "name": "jwt", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "An optional specific JWT you wish to verify, not the one you\n can obtain from " }, { "kind": "inline-tag", "tag": "@link", "text": "#getSession" }, { "kind": "text", "text": "." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 688, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Various additional options that allow you to customize the\n behavior of this method." } ] }, "type": { "type": "reflection", "declaration": { "id": 689, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 691, "name": "allowExpired", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If set to " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": " the " }, { "kind": "code", "text": "`exp`" }, { "kind": "text", "text": " claim will not be validated against the current time." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 5802, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L5802" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 692, "name": "jwks", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If set, this JSON Web Key Set is going to have precedence over the cached value available on the server." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 5805, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L5805" } ], "type": { "type": "reflection", "declaration": { "id": 693, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 694, "name": "keys", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 5805, "character": 15, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L5805" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 1398, "name": "JWK", "package": "@supabase/auth-js" } } } ], "groups": [ { "title": "Properties", "children": [694] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 5805, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L5805" } ] } } }, { "id": 690, "name": "keys", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", "text": "Please use options.jwks instead." } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 5799, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L5799" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 1398, "name": "JWK", "package": "@supabase/auth-js" } } } ], "groups": [ { "title": "Properties", "children": [691, 692, 690] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 5795, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L5795" } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 695, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 696, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 5809, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L5809" } ], "type": { "type": "reflection", "declaration": { "id": 697, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 698, "name": "claims", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 5809, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L5809" } ], "type": { "type": "reference", "target": 1378, "name": "JwtPayload", "package": "@supabase/auth-js" } }, { "id": 699, "name": "header", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 5809, "character": 36, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L5809" } ], "type": { "type": "reference", "target": 1363, "name": "JwtHeader", "package": "@supabase/auth-js" } }, { "id": 700, "name": "signature", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 5809, "character": 55, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L5809" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Uint8Array" }, "name": "Uint8Array", "package": "typescript" } } ], "groups": [ { "title": "Properties", "children": [698, 699, 700] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 5809, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L5809" } ] } } }, { "id": 701, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 5810, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L5810" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [696, 701] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 5808, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L5808" } ] } }, { "type": "reflection", "declaration": { "id": 702, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 703, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 5812, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L5812" } ], "type": { "type": "literal", "value": null } }, { "id": 704, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 5812, "character": 20, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L5812" } ], "type": { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [703, 704] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 5812, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L5812" } ] } }, { "type": "reflection", "declaration": { "id": 705, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 706, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 5813, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L5813" } ], "type": { "type": "literal", "value": null } }, { "id": 707, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 5813, "character": 20, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L5813" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [706, 707] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 5813, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L5813" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 305, "name": "getSession", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2604, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2604" } ], "signatures": [ { "id": 306, "name": "getSession", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Returns the session, refreshing it if necessary.\n\nThe session returned can be null if the session is not detected which can happen in the event a user is not signed-in or has logged out.\n\n**IMPORTANT:** This method loads values directly from the storage attached\nto the client. If that storage is based on request cookies for example,\nthe values in it may not be authentic and therefore it's strongly advised\nagainst using this method and its results in such circumstances. A warning\nwill be emitted if this is detected. Use " }, { "kind": "inline-tag", "tag": "@link", "text": "#getUser()" }, { "kind": "text", "text": " instead." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Since the introduction of [asymmetric JWT signing keys](/docs/guides/auth/signing-keys), this method is considered low-level and we encourage you to use " }, { "kind": "code", "text": "`getClaims()`" }, { "kind": "text", "text": " or " }, { "kind": "code", "text": "`getUser()`" }, { "kind": "text", "text": " instead.\n- Retrieves the current [user session](/docs/guides/auth/sessions) from the storage medium (local storage, cookies).\n- The session contains an access token (signed JWT), a refresh token and the user object.\n- If the session's access token is expired or is about to expire, this method will use the refresh token to refresh the session.\n- When using in a browser, or you've called " }, { "kind": "code", "text": "`startAutoRefresh()`" }, { "kind": "text", "text": " in your environment (React Native, etc.) this function always returns a valid access token without refreshing the session itself, as this is done in the background. This function returns very fast.\n- **IMPORTANT SECURITY NOTICE:** If using an insecure storage medium, such as cookies or request headers, the user object returned by this function **must not be trusted**. Always verify the JWT using " }, { "kind": "code", "text": "`getClaims()`" }, { "kind": "text", "text": " or your own JWT verification library to securely establish the user's identity and access. You can also use " }, { "kind": "code", "text": "`getUser()`" }, { "kind": "text", "text": " to fetch the user object directly from the Auth server for this purpose.\n- When using in a browser, this function is synchronized across all tabs using the [LockManager](https://developer.mozilla.org/en-US/docs/Web/API/LockManager) API. In other environments make sure you've defined a proper " }, { "kind": "code", "text": "`lock`" }, { "kind": "text", "text": " property, if necessary, to make sure there are no race conditions while the session is being refreshed." } ] }, { "tag": "@example", "name": "Get the session data", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.getSession()\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Get the session data\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n }\n },\n \"error\": null\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2604, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2604" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 307, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 308, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2697, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2697" } ], "type": { "type": "reflection", "declaration": { "id": 309, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 310, "name": "session", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2698, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2698" } ], "type": { "type": "reference", "target": 847, "name": "Session", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [310] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2697, "character": 18, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2697" } ] } } }, { "id": 311, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2700, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2700" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [308, 311] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2696, "character": 10, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2696" } ] } }, { "type": "reflection", "declaration": { "id": 312, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 313, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2703, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2703" } ], "type": { "type": "reflection", "declaration": { "id": 314, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 315, "name": "session", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2704, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2704" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [315] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2703, "character": 18, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2703" } ] } } }, { "id": 316, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2706, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2706" } ], "type": { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [313, 316] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2702, "character": 10, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2702" } ] } }, { "type": "reflection", "declaration": { "id": 317, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 318, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2709, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2709" } ], "type": { "type": "reflection", "declaration": { "id": 319, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 320, "name": "session", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2710, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2710" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [320] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2709, "character": 18, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2709" } ] } } }, { "id": 321, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2712, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2712" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [318, 321] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2708, "character": 10, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2708" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 368, "name": "getUser", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2915, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2915" } ], "signatures": [ { "id": 369, "name": "getUser", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Gets the current user details if there is an existing session. This method\nperforms a network request to the Supabase Auth server, so the returned\nvalue is authentic and can be used to base authorization rules on." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- This method fetches the user object from the database instead of local session.\n- This method is useful for checking if the user is authorized because it validates the user's access token JWT on the server.\n- Should always be used when checking for user authorization on the server. On the client, you can instead use " }, { "kind": "code", "text": "`getSession().session.user`" }, { "kind": "text", "text": " for faster results. " }, { "kind": "code", "text": "`getSession`" }, { "kind": "text", "text": " is insecure on the server." } ] }, { "tag": "@example", "name": "Get the logged in user with the current existing session", "content": [ { "kind": "code", "text": "```js\nconst { data: { user } } = await supabase.auth.getUser()\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Get the logged in user with the current existing session\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@example", "name": "Get the logged in user with a custom access token jwt", "content": [ { "kind": "code", "text": "```js\nconst { data: { user } } = await supabase.auth.getUser(jwt)\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2915, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2915" } ], "parameters": [ { "id": 370, "name": "jwt", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 844, "name": "UserResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 487, "name": "getUserIdentities", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4166, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4166" } ], "signatures": [ { "id": 488, "name": "getUserIdentities", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Gets all the identities linked to a user." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- The user needs to be signed in to call " }, { "kind": "code", "text": "`getUserIdentities()`" }, { "kind": "text", "text": "." } ] }, { "tag": "@example", "name": "Returns a list of identities linked to the user", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.getUserIdentities()\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Returns a list of identities linked to the user\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"2024-01-01T00:00:00Z\",\n \"user_id\": \"2024-01-01T00:00:00Z\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ]\n },\n \"error\": null\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4166, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4166" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 489, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 490, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4168, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4168" } ], "type": { "type": "reflection", "declaration": { "id": 491, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 492, "name": "identities", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4169, "character": 10, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4169" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 861, "name": "UserIdentity", "package": "@supabase/auth-js" } } } ], "groups": [ { "title": "Properties", "children": [492] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4168, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4168" } ] } } }, { "id": 493, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4171, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4171" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [490, 493] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4167, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4167" } ] } }, { "type": "reflection", "declaration": { "id": 494, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 495, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4173, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4173" } ], "type": { "type": "literal", "value": null } }, { "id": 496, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4173, "character": 20, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4173" } ], "type": { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [495, 496] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4173, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4173" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 214, "name": "initialize", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 461, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L461" } ], "signatures": [ { "id": 215, "name": "initialize", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Initializes the client session either from the url or from storage.\nThis method is automatically called when instantiating the client, but should also be called\nmanually when checking for an error from an auth redirect (oauth, magiclink, password recovery, etc)." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 461, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L461" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1339, "name": "InitializeResult", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 201, "name": "isThrowOnErrorEnabled", "variant": "declaration", "kind": 2048, "flags": { "isPublic": true }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 423, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L423" } ], "signatures": [ { "id": 202, "name": "isThrowOnErrorEnabled", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Returns whether error throwing mode is enabled for this client." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 423, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L423" } ], "type": { "type": "intrinsic", "name": "boolean" } } ] }, { "id": 497, "name": "linkIdentity", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- The **Enable Manual Linking** option must be enabled from your [project's authentication settings](/dashboard/project/_/auth/providers).\n- The user needs to be signed in to call " }, { "kind": "code", "text": "`linkIdentity()`" }, { "kind": "text", "text": ".\n- If the candidate identity is already linked to the existing user or another user, " }, { "kind": "code", "text": "`linkIdentity()`" }, { "kind": "text", "text": " will fail.\n- If " }, { "kind": "code", "text": "`linkIdentity`" }, { "kind": "text", "text": " is run in the browser, the user is automatically redirected to the returned URL. On the server, you should handle the redirect." } ] }, { "tag": "@example", "name": "Link an identity to a user", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.linkIdentity({\n provider: 'github'\n})\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Link an identity to a user\n" }, { "kind": "code", "text": "```json\n{\n data: {\n provider: 'github',\n url: \n },\n error: null\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4191, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4191" }, { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4196, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4196" }, { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4225, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4225" } ], "signatures": [ { "id": 498, "name": "linkIdentity", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Links an oauth identity to an existing user.\nThis method supports the PKCE flow." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4191, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4191" } ], "parameters": [ { "id": 499, "name": "credentials", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 988, "name": "SignInWithOAuthCredentials", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 828, "name": "OAuthResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } }, { "id": 500, "name": "linkIdentity", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Links an OIDC identity to an existing user." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4196, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4196" } ], "parameters": [ { "id": 501, "name": "credentials", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1000, "name": "SignInWithIdTokenCredentials", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 819, "name": "AuthTokenResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 449, "name": "onAuthStateChange", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Subscribes to important events occurring on the user's session.\n- Use on the frontend/client. It is less useful on the server.\n- Events are emitted across tabs to keep your application's UI up-to-date. Some events can fire very frequently, based on the number of tabs open. Use a quick and efficient callback function, and defer or debounce as many operations as you can to be performed outside of the callback.\n- **Important:** A callback can be an " }, { "kind": "code", "text": "`async`" }, { "kind": "text", "text": " function and it runs synchronously during the processing of the changes causing the event. You can easily create a dead-lock by using " }, { "kind": "code", "text": "`await`" }, { "kind": "text", "text": " on a call to another method of the Supabase library.\n - Avoid using " }, { "kind": "code", "text": "`async`" }, { "kind": "text", "text": " functions as callbacks.\n - Limit the number of " }, { "kind": "code", "text": "`await`" }, { "kind": "text", "text": " calls in " }, { "kind": "code", "text": "`async`" }, { "kind": "text", "text": " callbacks.\n - Do not use other Supabase functions in the callback function. If you must, dispatch the functions once the callback has finished executing. Use this as a quick way to achieve this:\n " }, { "kind": "code", "text": "```js\n supabase.auth.onAuthStateChange((event, session) => {\n setTimeout(async () => {\n // await on other Supabase function here\n // this runs right after the callback has finished\n }, 0)\n })\n ```" }, { "kind": "text", "text": "\n- Emitted events:\n - " }, { "kind": "code", "text": "`INITIAL_SESSION`" }, { "kind": "text", "text": "\n - Emitted right after the Supabase client is constructed and the initial session from storage is loaded.\n - " }, { "kind": "code", "text": "`SIGNED_IN`" }, { "kind": "text", "text": "\n - Emitted each time a user session is confirmed or re-established, including on user sign in and when refocusing a tab.\n - Avoid making assumptions as to when this event is fired, this may occur even when the user is already signed in. Instead, check the user object attached to the event to see if a new user has signed in and update your application's UI.\n - This event can fire very frequently depending on the number of tabs open in your application.\n - " }, { "kind": "code", "text": "`SIGNED_OUT`" }, { "kind": "text", "text": "\n - Emitted when the user signs out. This can be after:\n - A call to " }, { "kind": "code", "text": "`supabase.auth.signOut()`" }, { "kind": "text", "text": ".\n - After the user's session has expired for any reason:\n - User has signed out on another device.\n - The session has reached its timebox limit or inactivity timeout.\n - User has signed in on another device with single session per user enabled.\n - Check the [User Sessions](/docs/guides/auth/sessions) docs for more information.\n - Use this to clean up any local storage your application has associated with the user.\n - " }, { "kind": "code", "text": "`TOKEN_REFRESHED`" }, { "kind": "text", "text": "\n - Emitted each time a new access and refresh token are fetched for the signed in user.\n - It's best practice and highly recommended to extract the access token (JWT) and store it in memory for further use in your application.\n - Avoid frequent calls to " }, { "kind": "code", "text": "`supabase.auth.getSession()`" }, { "kind": "text", "text": " for the same purpose.\n - There is a background process that keeps track of when the session should be refreshed so you will always receive valid tokens by listening to this event.\n - The frequency of this event is related to the JWT expiry limit configured on your project.\n - " }, { "kind": "code", "text": "`USER_UPDATED`" }, { "kind": "text", "text": "\n - Emitted each time the " }, { "kind": "code", "text": "`supabase.auth.updateUser()`" }, { "kind": "text", "text": " method finishes successfully. Listen to it to update your application's UI based on new profile information.\n - " }, { "kind": "code", "text": "`PASSWORD_RECOVERY`" }, { "kind": "text", "text": "\n - Emitted instead of the " }, { "kind": "code", "text": "`SIGNED_IN`" }, { "kind": "text", "text": " event when the user lands on a page that includes a password recovery link in the URL.\n - Use it to show a UI to the user where they can [reset their password](/docs/guides/auth/passwords#resetting-a-users-password-forgot-password)." } ] }, { "tag": "@example", "name": "Listen to auth changes", "content": [ { "kind": "code", "text": "```js\nconst { data } = supabase.auth.onAuthStateChange((event, session) => {\n console.log(event, session)\n\n if (event === 'INITIAL_SESSION') {\n // handle initial session\n } else if (event === 'SIGNED_IN') {\n // handle sign in event\n } else if (event === 'SIGNED_OUT') {\n // handle sign out event\n } else if (event === 'PASSWORD_RECOVERY') {\n // handle password recovery event\n } else if (event === 'TOKEN_REFRESHED') {\n // handle token refreshed event\n } else if (event === 'USER_UPDATED') {\n // handle user updated event\n }\n})\n\n// call unsubscribe to remove the callback\ndata.subscription.unsubscribe()\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Listen to sign out\nMake sure you clear out any local data, such as local and session storage, after the client library has detected the user's sign out." } ] }, { "tag": "@example", "name": "Listen to sign out", "content": [ { "kind": "code", "text": "```js\nsupabase.auth.onAuthStateChange((event, session) => {\n if (event === 'SIGNED_OUT') {\n console.log('SIGNED_OUT', session)\n\n // clear local and session storage\n [\n window.localStorage,\n window.sessionStorage,\n ].forEach((storage) => {\n Object.entries(storage)\n .forEach(([key]) => {\n storage.removeItem(key)\n })\n })\n }\n})\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Store OAuth provider tokens on sign in\nWhen using [OAuth (Social Login)](/docs/guides/auth/social-login) you sometimes wish to get access to the provider's access token and refresh token, in order to call provider APIs in the name of the user.\n\nFor example, if you are using [Sign in with Google](/docs/guides/auth/social-login/auth-google) you may want to use the provider token to call Google APIs on behalf of the user. Supabase Auth does not keep track of the provider access and refresh token, but does return them for you once, immediately after sign in. You can use the " }, { "kind": "code", "text": "`onAuthStateChange`" }, { "kind": "text", "text": " method to listen for the presence of the provider tokens and store them in local storage. You can further send them to your server's APIs for use on the backend.\n\nFinally, make sure you remove them from local storage on the " }, { "kind": "code", "text": "`SIGNED_OUT`" }, { "kind": "text", "text": " event. If the OAuth provider supports token revocation, make sure you call those APIs either from the frontend or schedule them to be called on the backend." } ] }, { "tag": "@example", "name": "Store OAuth provider tokens on sign in", "content": [ { "kind": "code", "text": "```js\n// Register this immediately after calling createClient!\n// Because signInWithOAuth causes a redirect, you need to fetch the\n// provider tokens from the callback.\nsupabase.auth.onAuthStateChange((event, session) => {\n if (session && session.provider_token) {\n window.localStorage.setItem('oauth_provider_token', session.provider_token)\n }\n\n if (session && session.provider_refresh_token) {\n window.localStorage.setItem('oauth_provider_refresh_token', session.provider_refresh_token)\n }\n\n if (event === 'SIGNED_OUT') {\n window.localStorage.removeItem('oauth_provider_token')\n window.localStorage.removeItem('oauth_provider_refresh_token')\n }\n})\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Use React Context for the User's session\nInstead of relying on " }, { "kind": "code", "text": "`supabase.auth.getSession()`" }, { "kind": "text", "text": " within your React components, you can use a [React Context](https://react.dev/reference/react/createContext) to store the latest session information from the " }, { "kind": "code", "text": "`onAuthStateChange`" }, { "kind": "text", "text": " callback and access it that way." } ] }, { "tag": "@example", "name": "Use React Context for the User's session", "content": [ { "kind": "code", "text": "```js\nconst SessionContext = React.createContext(null)\n\nfunction main() {\n const [session, setSession] = React.useState(null)\n\n React.useEffect(() => {\n const {data: { subscription }} = supabase.auth.onAuthStateChange(\n (event, session) => {\n if (event === 'SIGNED_OUT') {\n setSession(null)\n } else if (session) {\n setSession(session)\n }\n })\n\n return () => {\n subscription.unsubscribe()\n }\n }, [])\n\n return (\n \n \n \n )\n}\n```" } ] }, { "tag": "@example", "name": "Listen to password recovery events", "content": [ { "kind": "code", "text": "```js\nsupabase.auth.onAuthStateChange((event, session) => {\n if (event === 'PASSWORD_RECOVERY') {\n console.log('PASSWORD_RECOVERY', session)\n // show screen to update user's password\n showPasswordResetScreen(true)\n }\n})\n```" } ] }, { "tag": "@example", "name": "Listen to sign in", "content": [ { "kind": "code", "text": "```js\nsupabase.auth.onAuthStateChange((event, session) => {\n if (event === 'SIGNED_IN') console.log('SIGNED_IN', session)\n})\n```" } ] }, { "tag": "@example", "name": "Listen to token refresh", "content": [ { "kind": "code", "text": "```js\nsupabase.auth.onAuthStateChange((event, session) => {\n if (event === 'TOKEN_REFRESHED') console.log('TOKEN_REFRESHED', session)\n})\n```" } ] }, { "tag": "@example", "name": "Listen to user updates", "content": [ { "kind": "code", "text": "```js\nsupabase.auth.onAuthStateChange((event, session) => {\n if (event === 'USER_UPDATED') console.log('USER_UPDATED', session)\n})\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3759, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3759" }, { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3775, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3775" }, { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3966, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3966" } ], "signatures": [ { "id": 450, "name": "onAuthStateChange", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Receive a notification every time an auth event happens.\nSafe to use without an async function as callback." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3759, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3759" } ], "parameters": [ { "id": 451, "name": "callback", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "A callback function to be invoked when an auth event happens." } ] }, "type": { "type": "reflection", "declaration": { "id": 452, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3759, "character": 30, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3759" } ], "signatures": [ { "id": 453, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3759, "character": 30, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3759" } ], "parameters": [ { "id": 454, "name": "event", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 736, "name": "AuthChangeEvent", "package": "@supabase/auth-js" } }, { "id": 455, "name": "session", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": 847, "name": "Session", "package": "@supabase/auth-js" } ] } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "type": { "type": "reflection", "declaration": { "id": 456, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 457, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3760, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3760" } ], "type": { "type": "reflection", "declaration": { "id": 458, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 459, "name": "subscription", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3760, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3760" } ], "type": { "type": "reference", "target": 941, "name": "Subscription", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [459] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3760, "character": 10, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3760" } ] } } } ], "groups": [ { "title": "Properties", "children": [457] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3759, "character": 90, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3759" } ] } } }, { "id": 460, "name": "onAuthStateChange", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Avoid using an async function inside " }, { "kind": "code", "text": "`onAuthStateChange`" }, { "kind": "text", "text": " as you might end\nup with a deadlock. The callback function runs inside an exclusive lock,\nso calling other Supabase Client APIs that also try to acquire the\nexclusive lock, might cause a deadlock. This behavior is observable across\ntabs. In the next major library version, this behavior will not be supported.\n\nReceive a notification every time an auth event happens." } ], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", "text": "Due to the possibility of deadlocks with async functions as callbacks, use the version without an async function." } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3775, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3775" } ], "parameters": [ { "id": 461, "name": "callback", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "A callback function to be invoked when an auth event happens." } ] }, "type": { "type": "reflection", "declaration": { "id": 462, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3775, "character": 30, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3775" } ], "signatures": [ { "id": 463, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3775, "character": 30, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3775" } ], "parameters": [ { "id": 464, "name": "event", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 736, "name": "AuthChangeEvent", "package": "@supabase/auth-js" } }, { "id": 465, "name": "session", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": 847, "name": "Session", "package": "@supabase/auth-js" } ] } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] } } } ], "type": { "type": "reflection", "declaration": { "id": 466, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 467, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3776, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3776" } ], "type": { "type": "reflection", "declaration": { "id": 468, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 469, "name": "subscription", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3776, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3776" } ], "type": { "type": "reference", "target": 941, "name": "Subscription", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [469] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3776, "character": 10, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3776" } ] } } } ], "groups": [ { "title": "Properties", "children": [467] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3775, "character": 99, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3775" } ] } } } ] }, { "id": 298, "name": "reauthenticate", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2387, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2387" } ], "signatures": [ { "id": 299, "name": "reauthenticate", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Sends a reauthentication OTP to the user's email or phone number.\nRequires the user to be signed-in." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- This method is used together with " }, { "kind": "code", "text": "`updateUser()`" }, { "kind": "text", "text": " when a user's password needs to be updated.\n- If you require your user to reauthenticate before updating their password, you need to enable the **Secure password change** option in your [project's email provider settings](/dashboard/project/_/auth/providers).\n- A user is only require to reauthenticate before updating their password if **Secure password change** is enabled and the user **hasn't recently signed in**. A user is deemed recently signed in if the session was created in the last 24 hours.\n- This method will send a nonce to the user's email. If the user doesn't have a confirmed email address, the method will send the nonce to the user's confirmed phone number instead.\n- After receiving the OTP, include it as the " }, { "kind": "code", "text": "`nonce`" }, { "kind": "text", "text": " in your " }, { "kind": "code", "text": "`updateUser()`" }, { "kind": "text", "text": " call to finalize the password change." } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Send reauthentication nonce\nSends a reauthentication nonce to the user's email or phone number." } ] }, { "tag": "@example", "name": "Send reauthentication nonce", "content": [ { "kind": "code", "text": "```js\nconst { error } = await supabase.auth.reauthenticate()\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2387, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2387" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 805, "name": "AuthResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 398, "name": "refreshSession", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3476, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3476" } ], "signatures": [ { "id": 399, "name": "refreshSession", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Returns a new session, regardless of expiry status.\nTakes in an optional current session. If not passed in, then refreshSession() will attempt to retrieve it from getSession().\nIf the current session's refresh token is invalid, an error will be thrown." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- This method will refresh and return a new session whether the current one is expired or not." } ] }, { "tag": "@example", "name": "Refresh session using the current session", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.refreshSession()\nconst { session, user } = data\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Refresh session using the current session\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n }\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@example", "name": "Refresh session using a refresh token", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.refreshSession({ refresh_token })\nconst { session, user } = data\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3476, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3476" } ], "parameters": [ { "id": 400, "name": "currentSession", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The current session. If passed in, it must contain a refresh token." } ] }, "type": { "type": "reflection", "declaration": { "id": 401, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 402, "name": "refresh_token", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3476, "character": 42, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3476" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [402] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3476, "character": 40, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3476" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 805, "name": "AuthResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 302, "name": "resend", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2478, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2478" } ], "signatures": [ { "id": 303, "name": "resend", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Resends an existing signup confirmation email, email change email, SMS OTP or phone change OTP." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Resends a signup confirmation, email change or phone change email to the user.\n- Passwordless sign-ins can be resent by calling the " }, { "kind": "code", "text": "`signInWithOtp()`" }, { "kind": "text", "text": " method again.\n- Password recovery emails can be resent by calling the " }, { "kind": "code", "text": "`resetPasswordForEmail()`" }, { "kind": "text", "text": " method again.\n- This method will only resend an email or phone OTP to the user if there was an initial signup, email change or phone change request being made(note: For existing users signing in with OTP, you should use " }, { "kind": "code", "text": "`signInWithOtp()`" }, { "kind": "text", "text": " again to resend the OTP).\n- You can specify a redirect url when you resend an email link using the " }, { "kind": "code", "text": "`emailRedirectTo`" }, { "kind": "text", "text": " option." } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Resend an email signup confirmation\nResends the email signup confirmation to the user" } ] }, { "tag": "@example", "name": "Resend an email signup confirmation", "content": [ { "kind": "code", "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'signup',\n email: 'email@example.com',\n options: {\n emailRedirectTo: 'https://example.com/welcome'\n }\n})\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Resend a phone signup confirmation\nResends the phone signup confirmation email to the user" } ] }, { "tag": "@example", "name": "Resend a phone signup confirmation", "content": [ { "kind": "code", "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'sms',\n phone: '1234567890'\n})\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Resend email change email\nResends the email change email to the user" } ] }, { "tag": "@example", "name": "Resend email change email", "content": [ { "kind": "code", "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'email_change',\n email: 'email@example.com'\n})\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Resend phone change OTP\nResends the phone change OTP to the user" } ] }, { "tag": "@example", "name": "Resend phone change OTP", "content": [ { "kind": "code", "text": "```js\nconst { error } = await supabase.auth.resend({\n type: 'phone_change',\n phone: '1234567890'\n})\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2478, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2478" } ], "parameters": [ { "id": 304, "name": "credentials", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1084, "name": "ResendParams", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 814, "name": "AuthOtpResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 473, "name": "resetPasswordForEmail", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4082, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4082" } ], "signatures": [ { "id": 474, "name": "resetPasswordForEmail", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Sends a password reset request to an email address. This method supports the PKCE flow." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- The password reset flow consist of 2 broad steps: (i) Allow the user to login via the password reset link; (ii) Update the user's password.\n- The " }, { "kind": "code", "text": "`resetPasswordForEmail()`" }, { "kind": "text", "text": " only sends a password reset link to the user's email.\nTo update the user's password, see [" }, { "kind": "code", "text": "`updateUser()`" }, { "kind": "text", "text": "](/docs/reference/javascript/auth-updateuser).\n- A " }, { "kind": "code", "text": "`PASSWORD_RECOVERY`" }, { "kind": "text", "text": " event will be emitted when the password recovery link is clicked.\nYou can use [" }, { "kind": "code", "text": "`onAuthStateChange()`" }, { "kind": "text", "text": "](/docs/reference/javascript/auth-onauthstatechange) to listen and invoke a callback function on these events.\n- When the user clicks the reset link in the email they are redirected back to your application.\nYou can configure the URL that the user is redirected to with the " }, { "kind": "code", "text": "`redirectTo`" }, { "kind": "text", "text": " parameter.\nSee [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project.\n- After the user has been redirected successfully, prompt them for a new password and call " }, { "kind": "code", "text": "`updateUser()`" }, { "kind": "text", "text": ":\n" }, { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n password: new_password\n})\n```" } ] }, { "tag": "@example", "name": "Reset password", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.resetPasswordForEmail(email, {\n redirectTo: 'https://example.com/update-password',\n})\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Reset password\n" }, { "kind": "code", "text": "```json\n{\n data: {}\n error: null\n}\n```" } ] }, { "tag": "@example", "name": "Reset password (React)", "content": [ { "kind": "code", "text": "```js\n/**\n * Step 1: Send the user an email to get a password reset token.\n * This email contains a link which sends the user back to your application.\n */\nconst { data, error } = await supabase.auth\n .resetPasswordForEmail('user@email.com')\n\n/**\n * Step 2: Once the user is redirected back to your application,\n * ask the user to reset their password.\n */\n useEffect(() => {\n supabase.auth.onAuthStateChange(async (event, session) => {\n if (event == \"PASSWORD_RECOVERY\") {\n const newPassword = prompt(\"What would you like your new password to be?\");\n const { data, error } = await supabase.auth\n .updateUser({ password: newPassword })\n\n if (data) alert(\"Password updated successfully!\")\n if (error) alert(\"There was an error updating your password.\")\n }\n })\n }, [])\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4082, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4082" } ], "parameters": [ { "id": 475, "name": "email", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The email address of the user." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 476, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 477, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 479, "name": "captchaToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Verification token received when the user completes the captcha on the site." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4086, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4086" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 478, "name": "redirectTo", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The URL to send the user to after they click the password reset link." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4085, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4085" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [479, 478] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4084, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4084" } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 480, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 481, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4090, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4090" } ], "type": { "type": "reflection", "declaration": { "id": 482, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {} } } }, { "id": 483, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4091, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4091" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [481, 483] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4089, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4089" } ] } }, { "type": "reflection", "declaration": { "id": 484, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 485, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4093, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4093" } ], "type": { "type": "literal", "value": null } }, { "id": 486, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4093, "character": 20, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4093" } ], "type": { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [485, 486] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4093, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4093" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 386, "name": "setSession", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3282, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3282" } ], "signatures": [ { "id": 387, "name": "setSession", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Sets the session data from the current session. If the current session is expired, setSession will take care of refreshing it to obtain a new session.\nIf the refresh token or access token in the current session is invalid, an error will be thrown." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- This method sets the session using an " }, { "kind": "code", "text": "`access_token`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`refresh_token`" }, { "kind": "text", "text": ".\n- If successful, a " }, { "kind": "code", "text": "`SIGNED_IN`" }, { "kind": "text", "text": " event is emitted." } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Set the session\nSets the session data from an access_token and refresh_token, then returns an auth response or error." } ] }, { "tag": "@example", "name": "Set the session", "content": [ { "kind": "code", "text": "```js\n const { data, error } = await supabase.auth.setSession({\n access_token,\n refresh_token\n })\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Set the session\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"session\": {\n \"access_token\": \"\",\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"11111111-1111-1111-1111-111111111111\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"2024-01-01T00:00:00Z\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"token_type\": \"bearer\",\n \"expires_in\": 3500,\n \"expires_at\": 1700000000\n }\n },\n \"error\": null\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3282, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3282" } ], "parameters": [ { "id": 388, "name": "currentSession", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The current session that minimally contains an access token and refresh token." } ] }, "type": { "type": "reflection", "declaration": { "id": 389, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 390, "name": "access_token", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3283, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3283" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 391, "name": "refresh_token", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3284, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3284" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [390, 391] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3282, "character": 35, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3282" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 805, "name": "AuthResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 218, "name": "signInAnonymously", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 635, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L635" } ], "signatures": [ { "id": 219, "name": "signInAnonymously", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates a new anonymous user." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "A session where the is_anonymous claim in the access token JWT set to true" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Returns an anonymous user\n- It is recommended to set up captcha for anonymous sign-ins to prevent abuse. You can pass in the captcha token in the " }, { "kind": "code", "text": "`options`" }, { "kind": "text", "text": " param." } ] }, { "tag": "@example", "name": "Create an anonymous user", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.signInAnonymously({\n options: {\n captchaToken\n }\n});\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Create an anonymous user\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {},\n \"user_metadata\": {},\n \"identities\": [],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": true\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {},\n \"user_metadata\": {},\n \"identities\": [],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": true\n }\n }\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@example", "name": "Create an anonymous user with custom user metadata", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.signInAnonymously({\n options: {\n data\n }\n})\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 635, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L635" } ], "parameters": [ { "id": 220, "name": "credentials", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 951, "name": "SignInAnonymouslyCredentials", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 805, "name": "AuthResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 286, "name": "signInWithIdToken", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 1920, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L1920" } ], "signatures": [ { "id": 287, "name": "signInWithIdToken", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Allows signing in with an OIDC ID token. The authentication provider used\nshould be enabled and configured." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Use an ID token to sign in.\n- Especially useful when implementing sign in using native platform dialogs in mobile or desktop apps using Sign in with Apple or Sign in with Google on iOS and Android.\n- You can also use Google's [One Tap](https://developers.google.com/identity/gsi/web/guides/display-google-one-tap) and [Automatic sign-in](https://developers.google.com/identity/gsi/web/guides/automatic-sign-in-sign-out) via this API." } ] }, { "tag": "@example", "name": "Sign In using ID Token", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.signInWithIdToken({\n provider: 'google',\n token: 'your-id-token'\n})\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Sign In using ID Token\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n ...\n },\n \"user_metadata\": {\n ...\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"provider\": \"google\",\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n ...\n },\n \"user_metadata\": {\n ...\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"provider\": \"google\",\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n }\n }\n },\n \"error\": null\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 1920, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L1920" } ], "parameters": [ { "id": 288, "name": "credentials", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1000, "name": "SignInWithIdTokenCredentials", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 819, "name": "AuthTokenResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 227, "name": "signInWithOAuth", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 1172, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L1172" } ], "signatures": [ { "id": 228, "name": "signInWithOAuth", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Log in an existing user via a third-party provider.\nThis method supports the PKCE flow." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- This method is used for signing in using [Social Login (OAuth) providers](/docs/guides/auth#configure-third-party-providers).\n- It works by redirecting your application to the provider's authorization screen, before bringing back the user to your app." } ] }, { "tag": "@example", "name": "Sign in using a third-party provider", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.signInWithOAuth({\n provider: 'github'\n})\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Sign in using a third-party provider\n" }, { "kind": "code", "text": "```json\n{\n data: {\n provider: 'github',\n url: \n },\n error: null\n}\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Sign in using a third-party provider with redirect\n- When the OAuth provider successfully authenticates the user, they are redirected to the URL specified in the " }, { "kind": "code", "text": "`redirectTo`" }, { "kind": "text", "text": " parameter. This parameter defaults to the [" }, { "kind": "code", "text": "`SITE_URL`" }, { "kind": "text", "text": "](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls). It does not redirect the user immediately after invoking this method.\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project." } ] }, { "tag": "@example", "name": "Sign in using a third-party provider with redirect", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.signInWithOAuth({\n provider: 'github',\n options: {\n redirectTo: 'https://example.com/welcome'\n }\n})\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Sign in with scopes and access provider tokens\nIf you need additional access from an OAuth provider, in order to access provider specific APIs in the name of the user, you can do this by passing in the scopes the user should authorize for your application. Note that the " }, { "kind": "code", "text": "`scopes`" }, { "kind": "text", "text": " option takes in **a space-separated list** of scopes.\n\nBecause OAuth sign-in often includes redirects, you should register an " }, { "kind": "code", "text": "`onAuthStateChange`" }, { "kind": "text", "text": " callback immediately after you create the Supabase client. This callback will listen for the presence of " }, { "kind": "code", "text": "`provider_token`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`provider_refresh_token`" }, { "kind": "text", "text": " properties on the " }, { "kind": "code", "text": "`session`" }, { "kind": "text", "text": " object and store them in local storage. The client library will emit these values **only once** immediately after the user signs in. You can then access them by looking them up in local storage, or send them to your backend servers for further processing.\n\nFinally, make sure you remove them from local storage on the " }, { "kind": "code", "text": "`SIGNED_OUT`" }, { "kind": "text", "text": " event. If the OAuth provider supports token revocation, make sure you call those APIs either from the frontend or schedule them to be called on the backend." } ] }, { "tag": "@example", "name": "Sign in with scopes and access provider tokens", "content": [ { "kind": "code", "text": "```js\n// Register this immediately after calling createClient!\n// Because signInWithOAuth causes a redirect, you need to fetch the\n// provider tokens from the callback.\nsupabase.auth.onAuthStateChange((event, session) => {\n if (session && session.provider_token) {\n window.localStorage.setItem('oauth_provider_token', session.provider_token)\n }\n\n if (session && session.provider_refresh_token) {\n window.localStorage.setItem('oauth_provider_refresh_token', session.provider_refresh_token)\n }\n\n if (event === 'SIGNED_OUT') {\n window.localStorage.removeItem('oauth_provider_token')\n window.localStorage.removeItem('oauth_provider_refresh_token')\n }\n})\n\n// Call this on your Sign in with GitHub button to initiate OAuth\n// with GitHub with the requested elevated scopes.\nawait supabase.auth.signInWithOAuth({\n provider: 'github',\n options: {\n scopes: 'repo gist notifications'\n }\n})\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 1172, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L1172" } ], "parameters": [ { "id": 229, "name": "credentials", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 988, "name": "SignInWithOAuthCredentials", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 828, "name": "OAuthResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 289, "name": "signInWithOtp", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2033, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2033" } ], "signatures": [ { "id": 290, "name": "signInWithOtp", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Log in a user using magiclink or a one-time password (OTP).\n\nIf the " }, { "kind": "code", "text": "`{{ .ConfirmationURL }}`" }, { "kind": "text", "text": " variable is specified in the email template, a magiclink will be sent.\nIf the " }, { "kind": "code", "text": "`{{ .Token }}`" }, { "kind": "text", "text": " variable is specified in the email template, an OTP will be sent.\nIf you're using phone sign-ins, only an OTP will be sent. You won't be able to send a magiclink for phone sign-ins.\n\nBe aware that you may get back an error message that will not distinguish\nbetween the cases where the account does not exist or, that the account\ncan only be accessed via social login.\n\nDo note that you will need to configure a Whatsapp sender on Twilio\nif you are using phone sign in with the 'whatsapp' channel. The whatsapp\nchannel is not supported on other providers\nat this time.\nThis method supports PKCE when an email is passed." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Requires either an email or phone number.\n- This method is used for passwordless sign-ins where a OTP is sent to the user's email or phone number.\n- If the user doesn't exist, " }, { "kind": "code", "text": "`signInWithOtp()`" }, { "kind": "text", "text": " will signup the user instead. To restrict this behavior, you can set " }, { "kind": "code", "text": "`shouldCreateUser`" }, { "kind": "text", "text": " in " }, { "kind": "code", "text": "`SignInWithPasswordlessCredentials.options`" }, { "kind": "text", "text": " to " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ".\n- If you're using an email, you can configure whether you want the user to receive a magiclink or a OTP.\n- If you're using phone, you can configure whether you want the user to receive a OTP.\n- The magic link's destination URL is determined by the [" }, { "kind": "code", "text": "`SITE_URL`" }, { "kind": "text", "text": "](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls).\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project.\n- Magic links and OTPs share the same implementation. To send users a one-time code instead of a magic link, [modify the magic link email template](/dashboard/project/_/auth/templates) to include " }, { "kind": "code", "text": "`{{ .Token }}`" }, { "kind": "text", "text": " instead of " }, { "kind": "code", "text": "`{{ .ConfirmationURL }}`" }, { "kind": "text", "text": ".\n- See our [Twilio Phone Auth Guide](/docs/guides/auth/phone-login?showSMSProvider=Twilio) for details about configuring WhatsApp sign in." } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Sign in with email\nThe user will be sent an email which contains either a magiclink or a OTP or both. By default, a given user can only request a OTP once every 60 seconds." } ] }, { "tag": "@example", "name": "Sign in with email", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.signInWithOtp({\n email: 'example@email.com',\n options: {\n emailRedirectTo: 'https://example.com/welcome'\n }\n})\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Sign in with email\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"user\": null,\n \"session\": null\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Sign in with SMS OTP\nThe user will be sent a SMS which contains a OTP. By default, a given user can only request a OTP once every 60 seconds." } ] }, { "tag": "@example", "name": "Sign in with SMS OTP", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.signInWithOtp({\n phone: '+13334445555',\n})\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Sign in with WhatsApp OTP\nThe user will be sent a WhatsApp message which contains a OTP. By default, a given user can only request a OTP once every 60 seconds. Note that a user will need to have a valid WhatsApp account that is linked to Twilio in order to use this feature." } ] }, { "tag": "@example", "name": "Sign in with WhatsApp OTP", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.signInWithOtp({\n phone: '+13334445555',\n options: {\n channel:'whatsapp',\n }\n})\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2033, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2033" } ], "parameters": [ { "id": 291, "name": "credentials", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 970, "name": "SignInWithPasswordlessCredentials", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 814, "name": "AuthOtpResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 224, "name": "signInWithPassword", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 1033, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L1033" } ], "signatures": [ { "id": 225, "name": "signInWithPassword", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Log in an existing user with an email and password or phone and password.\n\nBe aware that you may get back an error message that will not distinguish\nbetween the cases where the account does not exist or that the\nemail/phone and password combination is wrong or that the account can only\nbe accessed via social login." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Requires either an email and password or a phone number and password." } ] }, { "tag": "@example", "name": "Sign in with email and password", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.signInWithPassword({\n email: 'example@email.com',\n password: 'example-password',\n})\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Sign in with email and password\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n }\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@example", "name": "Sign in with phone and password", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.signInWithPassword({\n phone: '+13334445555',\n password: 'some-password',\n})\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 1033, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L1033" } ], "parameters": [ { "id": 226, "name": "credentials", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 965, "name": "SignInWithPasswordCredentials", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 823, "name": "AuthTokenResponsePassword", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 295, "name": "signInWithSSO", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2324, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2324" } ], "signatures": [ { "id": 296, "name": "signInWithSSO", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Attempts a single-sign on using an enterprise Identity Provider. A\nsuccessful SSO attempt will redirect the current page to the identity\nprovider authorization page. The redirect URL is implementation and SSO\nprotocol specific.\n\nYou can use it by providing a SSO domain. Typically you can extract this\ndomain by asking users for their email address. If this domain is\nregistered on the Auth instance the redirect will use that organization's\ncurrently active SSO Identity Provider for the login.\n\nIf you have built an organization-specific login page, you can use the\norganization's SSO Identity Provider UUID directly instead." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Before you can call this method you need to [establish a connection](/docs/guides/auth/sso/auth-sso-saml#managing-saml-20-connections) to an identity provider. Use the [CLI commands](/docs/reference/cli/supabase-sso) to do this.\n- If you've associated an email domain to the identity provider, you can use the " }, { "kind": "code", "text": "`domain`" }, { "kind": "text", "text": " property to start a sign-in flow.\n- In case you need to use a different way to start the authentication flow with an identity provider, you can use the " }, { "kind": "code", "text": "`providerId`" }, { "kind": "text", "text": " property. For example:\n - Mapping specific user email addresses with an identity provider.\n - Using different hints to identity the identity provider to be used by the user, like a company-specific page, IP address or other tracking information." } ] }, { "tag": "@example", "name": "Sign in with email domain", "content": [ { "kind": "code", "text": "```js\n // You can extract the user's email domain and use it to trigger the\n // authentication flow with the correct identity provider.\n\n const { data, error } = await supabase.auth.signInWithSSO({\n domain: 'company.com'\n })\n\n if (data?.url) {\n // redirect the user to the identity provider's authentication flow\n window.location.href = data.url\n }\n```" } ] }, { "tag": "@example", "name": "Sign in with provider UUID", "content": [ { "kind": "code", "text": "```js\n // Useful when you need to map a user's sign in request according\n // to different rules that can't use email domains.\n\n const { data, error } = await supabase.auth.signInWithSSO({\n providerId: '21648a9d-8d5a-4555-a9d1-d6375dc14e92'\n })\n\n if (data?.url) {\n // redirect the user to the identity provider's authentication flow\n window.location.href = data.url\n }\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2324, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2324" } ], "parameters": [ { "id": 297, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1098, "name": "SignInWithSSO", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 841, "name": "SSOResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 233, "name": "signInWithWeb3", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 1447, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L1447" } ], "signatures": [ { "id": 234, "name": "signInWithWeb3", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Signs in a user by verifying a message signed by the user's private key.\nSupports Ethereum (via Sign-In-With-Ethereum) & Solana (Sign-In-With-Solana) standards,\nboth of which derive from the EIP-4361 standard\nWith slight variation on Solana's side." } ], "blockTags": [ { "tag": "@reference", "content": [ { "kind": "text", "text": "https://eips.ethereum.org/EIPS/eip-4361" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Uses a Web3 (Ethereum, Solana) wallet to sign a user in.\n- Read up on the [potential for abuse](/docs/guides/auth/auth-web3#potential-for-abuse) before using it." } ] }, { "tag": "@example", "name": "Sign in with Solana or Ethereum (Window API)", "content": [ { "kind": "code", "text": "```js\n // uses window.ethereum for the wallet\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'ethereum',\n statement: 'I accept the Terms of Service at https://example.com/tos'\n })\n\n // uses window.solana for the wallet\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'solana',\n statement: 'I accept the Terms of Service at https://example.com/tos'\n })\n```" } ] }, { "tag": "@example", "name": "Sign in with Ethereum (Message and Signature)", "content": [ { "kind": "code", "text": "```js\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'ethereum',\n message: '',\n signature: '',\n })\n```" } ] }, { "tag": "@example", "name": "Sign in with Solana (Brave)", "content": [ { "kind": "code", "text": "```js\n const { data, error } = await supabase.auth.signInWithWeb3({\n chain: 'solana',\n statement: 'I accept the Terms of Service at https://example.com/tos',\n wallet: window.braveSolana\n })\n```" } ] }, { "tag": "@example", "name": "Sign in with Solana (Wallet Adapter)", "content": [ { "kind": "code", "text": "```jsx\n function SignInButton() {\n const wallet = useWallet()\n\n return (\n <>\n {wallet.connected ? (\n {\n supabase.auth.signInWithWeb3({\n chain: 'solana',\n statement: 'I accept the Terms of Service at https://example.com/tos',\n wallet,\n })\n }}\n >\n Sign in with Solana\n \n ) : (\n \n )}\n \n )\n}\n\nfunction App() {\n const endpoint = clusterApiUrl('devnet')\n const wallets = useMemo(() => [], [])\n\n return (\n \n \n \n \n \n \n \n )\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 1447, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L1447" } ], "parameters": [ { "id": 235, "name": "credentials", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1061, "name": "Web3Credentials", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 236, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 237, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 1449, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L1449" } ], "type": { "type": "reflection", "declaration": { "id": 238, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 239, "name": "session", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 1449, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L1449" } ], "type": { "type": "reference", "target": 847, "name": "Session", "package": "@supabase/auth-js" } }, { "id": 240, "name": "user", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 1449, "character": 34, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L1449" } ], "type": { "type": "reference", "target": 893, "name": "User", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [239, 240] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 1449, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L1449" } ] } } }, { "id": 241, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 1450, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L1450" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [237, 241] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 1448, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L1448" } ] } }, { "type": "reflection", "declaration": { "id": 242, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 243, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 1452, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L1452" } ], "type": { "type": "reflection", "declaration": { "id": 244, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 245, "name": "session", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 1452, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L1452" } ], "type": { "type": "literal", "value": null } }, { "id": 246, "name": "user", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 1452, "character": 31, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L1452" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [245, 246] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 1452, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L1452" } ] } } }, { "id": 247, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 1452, "character": 45, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L1452" } ], "type": { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [243, 247] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 1452, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L1452" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 439, "name": "signOut", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3712, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3712" } ], "signatures": [ { "id": 440, "name": "signOut", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Inside a browser context, " }, { "kind": "code", "text": "`signOut()`" }, { "kind": "text", "text": " will remove the logged in user from the browser session and log them out - removing all items from localstorage and then trigger a " }, { "kind": "code", "text": "`\"SIGNED_OUT\"`" }, { "kind": "text", "text": " event.\n\nFor server-side management, you can revoke all refresh tokens for a user by passing a user's JWT through to " }, { "kind": "code", "text": "`auth.api.signOut(JWT: string)`" }, { "kind": "text", "text": ".\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\nIf using " }, { "kind": "code", "text": "`others`" }, { "kind": "text", "text": " scope, no " }, { "kind": "code", "text": "`SIGNED_OUT`" }, { "kind": "text", "text": " event is fired!" } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- In order to use the " }, { "kind": "code", "text": "`signOut()`" }, { "kind": "text", "text": " method, the user needs to be signed in first.\n- By default, " }, { "kind": "code", "text": "`signOut()`" }, { "kind": "text", "text": " uses the global scope, which signs out all other sessions that the user is logged into as well. Customize this behavior by passing a scope parameter.\n- Since Supabase Auth uses JWTs for authentication, the access token JWT will be valid until it's expired. When the user signs out, Supabase revokes the refresh token and deletes the JWT from the client-side. This does not revoke the JWT and it will still be valid until it expires." } ] }, { "tag": "@example", "name": "Sign out (all sessions)", "content": [ { "kind": "code", "text": "```js\nconst { error } = await supabase.auth.signOut()\n```" } ] }, { "tag": "@example", "name": "Sign out (current session)", "content": [ { "kind": "code", "text": "```js\nconst { error } = await supabase.auth.signOut({ scope: 'local' })\n```" } ] }, { "tag": "@example", "name": "Sign out (other sessions)", "content": [ { "kind": "code", "text": "```js\nconst { error } = await supabase.auth.signOut({ scope: 'others' })\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3712, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3712" } ], "parameters": [ { "id": 441, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1354, "name": "SignOut", "package": "@supabase/auth-js" }, "defaultValue": "..." } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reflection", "declaration": { "id": 442, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 443, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3712, "character": 67, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3712" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } ] } } ], "groups": [ { "title": "Properties", "children": [443] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3712, "character": 65, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3712" } ] } } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 221, "name": "signUp", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 845, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L845" } ], "signatures": [ { "id": 222, "name": "signUp", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates a new user.\n\nBe aware that if a user account exists in the system you may get back an\nerror message that attempts to hide this information from the user.\nThis method has support for PKCE via email signups. The PKCE flow cannot be used when autoconfirm is enabled." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "A logged-in session if the server has \"autoconfirm\" ON" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "A user if the server has \"autoconfirm\" OFF" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- By default, the user needs to verify their email address before logging in. To turn this off, disable **Confirm email** in [your project](/dashboard/project/_/auth/providers).\n- **Confirm email** determines if users need to confirm their email address after signing up.\n - If **Confirm email** is enabled, a " }, { "kind": "code", "text": "`user`" }, { "kind": "text", "text": " is returned but " }, { "kind": "code", "text": "`session`" }, { "kind": "text", "text": " is null.\n - If **Confirm email** is disabled, both a " }, { "kind": "code", "text": "`user`" }, { "kind": "text", "text": " and a " }, { "kind": "code", "text": "`session`" }, { "kind": "text", "text": " are returned.\n- When the user confirms their email address, they are redirected to the [" }, { "kind": "code", "text": "`SITE_URL`" }, { "kind": "text", "text": "](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) by default. You can modify your " }, { "kind": "code", "text": "`SITE_URL`" }, { "kind": "text", "text": " or add additional redirect URLs in [your project](/dashboard/project/_/auth/url-configuration).\n- If signUp() is called for an existing confirmed user:\n - When both **Confirm email** and **Confirm phone** (even when phone provider is disabled) are enabled in [your project](/dashboard/project/_/auth/providers), an obfuscated/fake user object is returned.\n - When either **Confirm email** or **Confirm phone** (even when phone provider is disabled) is disabled, the error message, " }, { "kind": "code", "text": "`User already registered`" }, { "kind": "text", "text": " is returned.\n- To fetch the currently logged-in user, refer to [" }, { "kind": "code", "text": "`getUser()`" }, { "kind": "text", "text": "](/docs/reference/javascript/auth-getuser)." } ] }, { "tag": "@example", "name": "Sign up with an email and password", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.signUp({\n email: 'example@email.com',\n password: 'example-password',\n})\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Sign up with an email and password\n" }, { "kind": "code", "text": "```json\n// Some fields may be null if \"confirm email\" is enabled.\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {},\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n }\n }\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@example", "name": "Sign up with a phone number and password (SMS)", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.signUp({\n phone: '123456789',\n password: 'example-password',\n options: {\n channel: 'sms'\n }\n})\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Sign up with a phone number and password (whatsapp)\nThe user will be sent a WhatsApp message which contains a OTP. By default, a given user can only request a OTP once every 60 seconds. Note that a user will need to have a valid WhatsApp account that is linked to Twilio in order to use this feature." } ] }, { "tag": "@example", "name": "Sign up with a phone number and password (whatsapp)", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.signUp({\n phone: '123456789',\n password: 'example-password',\n options: {\n channel: 'whatsapp'\n }\n})\n```" } ] }, { "tag": "@example", "name": "Sign up with additional user metadata", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.signUp(\n {\n email: 'example@email.com',\n password: 'example-password',\n options: {\n data: {\n first_name: 'John',\n age: 27,\n }\n }\n }\n)\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Sign up with a redirect URL\n- See [redirect URLs and wildcards](/docs/guides/auth/redirect-urls#use-wildcards-in-redirect-urls) to add additional redirect URLs to your project." } ] }, { "tag": "@example", "name": "Sign up with a redirect URL", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.signUp(\n {\n email: 'example@email.com',\n password: 'example-password',\n options: {\n emailRedirectTo: 'https://example.com/welcome'\n }\n }\n)\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 845, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L845" } ], "parameters": [ { "id": 223, "name": "credentials", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 957, "name": "SignUpWithPasswordCredentials", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 805, "name": "AuthResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 563, "name": "startAutoRefresh", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4866, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4866" } ], "signatures": [ { "id": 564, "name": "startAutoRefresh", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Starts an auto-refresh process in the background. The session is checked\nevery few seconds. Close to the time of expiration a process is started to\nrefresh the session. If refreshing fails it will be retried for as long as\nnecessary.\n\nIf you set the " }, { "kind": "inline-tag", "tag": "@link", "text": "GoTrueClientOptions#autoRefreshToken", "target": 762 }, { "kind": "text", "text": " you don't need\nto call this function, it will be called for you.\n\nOn browsers the refresh process works only when the tab/window is in the\nforeground to conserve resources as well as prevent race conditions and\nflooding auth with requests. If you call this method any managed\nvisibility change callback will be removed and you must manage visibility\nchanges on your own.\n\nOn non-browser platforms the refresh process works *continuously* in the\nbackground, which may not be desirable. You should hook into your\nplatform's foreground indication mechanism and call these methods\nappropriately to conserve resources.\n\n" }, { "kind": "inline-tag", "tag": "@see", "text": "#stopAutoRefresh" } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Only useful in non-browser environments such as React Native or Electron.\n- The Supabase Auth library automatically starts and stops proactively refreshing the session when a tab is focused or not.\n- On non-browser platforms, such as mobile or desktop apps built with web technologies, the library is not able to effectively determine whether the application is _focused_ or not.\n- To give this hint to the application, you should be calling this method when the app is in focus and calling " }, { "kind": "code", "text": "`supabase.auth.stopAutoRefresh()`" }, { "kind": "text", "text": " when it's out of focus." } ] }, { "tag": "@example", "name": "Start and stop auto refresh in React Native", "content": [ { "kind": "code", "text": "```js\nimport { AppState } from 'react-native'\n\n// make sure you register this only once!\nAppState.addEventListener('change', (state) => {\n if (state === 'active') {\n supabase.auth.startAutoRefresh()\n } else {\n supabase.auth.stopAutoRefresh()\n }\n})\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4866, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4866" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 565, "name": "stopAutoRefresh", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4901, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4901" } ], "signatures": [ { "id": 566, "name": "stopAutoRefresh", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Stops an active auto refresh process running in the background (if any).\n\nIf you call this method any managed visibility change callback will be\nremoved and you must manage visibility changes on your own.\n\nSee " }, { "kind": "inline-tag", "tag": "@link", "text": "#startAutoRefresh" }, { "kind": "text", "text": " for more details." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Only useful in non-browser environments such as React Native or Electron.\n- The Supabase Auth library automatically starts and stops proactively refreshing the session when a tab is focused or not.\n- On non-browser platforms, such as mobile or desktop apps built with web technologies, the library is not able to effectively determine whether the application is _focused_ or not.\n- When your application goes in the background or out of focus, call this method to stop the proactive refreshing of the session." } ] }, { "tag": "@example", "name": "Start and stop auto refresh in React Native", "content": [ { "kind": "code", "text": "```js\nimport { AppState } from 'react-native'\n\n// make sure you register this only once!\nAppState.addEventListener('change', (state) => {\n if (state === 'active') {\n supabase.auth.startAutoRefresh()\n } else {\n supabase.auth.stopAutoRefresh()\n }\n})\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4901, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4901" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", "name": "void" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 508, "name": "unlinkIdentity", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4345, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4345" } ], "signatures": [ { "id": 509, "name": "unlinkIdentity", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Unlinks an identity from a user by deleting it. The user will no longer be able to sign in with that identity once it's unlinked." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- The **Enable Manual Linking** option must be enabled from your [project's authentication settings](/dashboard/project/_/auth/providers).\n- The user needs to be signed in to call " }, { "kind": "code", "text": "`unlinkIdentity()`" }, { "kind": "text", "text": ".\n- The user must have at least 2 identities in order to unlink an identity.\n- The identity to be unlinked must belong to the user." } ] }, { "tag": "@example", "name": "Unlink an identity", "content": [ { "kind": "code", "text": "```js\n// retrieve all identities linked to a user\nconst identities = await supabase.auth.getUserIdentities()\n\n// find the google identity\nconst googleIdentity = identities.find(\n identity => identity.provider === 'google'\n)\n\n// unlink the google identity\nconst { error } = await supabase.auth.unlinkIdentity(googleIdentity)\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4345, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4345" } ], "parameters": [ { "id": 510, "name": "identity", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 861, "name": "UserIdentity", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 511, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 512, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4347, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4347" } ], "type": { "type": "reflection", "declaration": { "id": 513, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {} } } }, { "id": 514, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4348, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4348" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [512, 514] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4346, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4346" } ] } }, { "type": "reflection", "declaration": { "id": 515, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 516, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4350, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4350" } ], "type": { "type": "literal", "value": null } }, { "id": 517, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4350, "character": 20, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4350" } ], "type": { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [516, 517] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 4350, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L4350" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 374, "name": "updateUser", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3091, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3091" } ], "signatures": [ { "id": 375, "name": "updateUser", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Updates user data for a logged in user." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- In order to use the " }, { "kind": "code", "text": "`updateUser()`" }, { "kind": "text", "text": " method, the user needs to be signed in first.\n- By default, email updates sends a confirmation link to both the user's current and new email.\nTo only send a confirmation link to the user's new email, disable **Secure email change** in your project's [email auth provider settings](/dashboard/project/_/auth/providers)." } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Update the email for an authenticated user\nSends a \"Confirm Email Change\" email to the new address. If **Secure Email Change** is enabled (default), confirmation is also required from the **old email** before the change is applied. To skip dual confirmation and apply the change after only the new email is verified, disable **Secure Email Change** in the [Email Auth Provider settings](/dashboard/project/_/auth/providers?provider=Email)." } ] }, { "tag": "@example", "name": "Update the email for an authenticated user", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n email: 'new@email.com'\n})\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Update the email for an authenticated user\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"new_email\": \"new@email.com\",\n \"email_change_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Update the phone number for an authenticated user\nSends a one-time password (OTP) to the new phone number." } ] }, { "tag": "@example", "name": "Update the phone number for an authenticated user", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n phone: '123456789'\n})\n```" } ] }, { "tag": "@example", "name": "Update the password for an authenticated user", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n password: 'new password'\n})\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Update the user's metadata\nUpdates the user's custom metadata.\n\n**Note**: The " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " field maps to the " }, { "kind": "code", "text": "`auth.users.raw_user_meta_data`" }, { "kind": "text", "text": " column in your Supabase database. When calling " }, { "kind": "code", "text": "`getUser()`" }, { "kind": "text", "text": ", the data will be available as " }, { "kind": "code", "text": "`user.user_metadata`" }, { "kind": "text", "text": "." } ] }, { "tag": "@example", "name": "Update the user's metadata", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n data: { hello: 'world' }\n})\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Update the user's password with a nonce\nIf **Secure password change** is enabled in your [project's email provider settings](/dashboard/project/_/auth/providers), updating the user's password would require a nonce if the user **hasn't recently signed in**. The nonce is sent to the user's email or phone number. A user is deemed recently signed in if the session was created in the last 24 hours." } ] }, { "tag": "@example", "name": "Update the user's password with a nonce", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.updateUser({\n password: 'new password',\n nonce: '123456'\n})\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3091, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3091" } ], "parameters": [ { "id": 376, "name": "attributes", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 920, "name": "UserAttributes", "package": "@supabase/auth-js" } }, { "id": 377, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 378, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 379, "name": "emailRedirectTo", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3094, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3094" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [379] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 3093, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L3093" } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 844, "name": "UserResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 292, "name": "verifyOtp", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2224, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2224" } ], "signatures": [ { "id": 293, "name": "verifyOtp", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Log in a user given a User supplied OTP or TokenHash received through mobile or email." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- The " }, { "kind": "code", "text": "`verifyOtp`" }, { "kind": "text", "text": " method takes in different verification types.\n- If a phone number is used, the type can either be:\n 1. " }, { "kind": "code", "text": "`sms`" }, { "kind": "text", "text": " – Used when verifying a one-time password (OTP) sent via SMS during sign-up or sign-in.\n 2. " }, { "kind": "code", "text": "`phone_change`" }, { "kind": "text", "text": " – Used when verifying an OTP sent to a new phone number during a phone number update process.\n- If an email address is used, the type can be one of the following (note: " }, { "kind": "code", "text": "`signup`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`magiclink`" }, { "kind": "text", "text": " types are deprecated):\n 1. " }, { "kind": "code", "text": "`email`" }, { "kind": "text", "text": " – Used when verifying an OTP sent to the user's email during sign-up or sign-in.\n 2. " }, { "kind": "code", "text": "`recovery`" }, { "kind": "text", "text": " – Used when verifying an OTP sent for account recovery, typically after a password reset request.\n 3. " }, { "kind": "code", "text": "`invite`" }, { "kind": "text", "text": " – Used when verifying an OTP sent as part of an invitation to join a project or organization.\n 4. " }, { "kind": "code", "text": "`email_change`" }, { "kind": "text", "text": " – Used when verifying an OTP sent to a new email address during an email update process.\n- The verification type used should be determined based on the corresponding auth method called before " }, { "kind": "code", "text": "`verifyOtp`" }, { "kind": "text", "text": " to sign up / sign-in a user.\n- The " }, { "kind": "code", "text": "`TokenHash`" }, { "kind": "text", "text": " is contained in the [email templates](/docs/guides/auth/auth-email-templates) and can be used to sign in. You may wish to use the hash for the PKCE flow for Server Side Auth. Read [the Password-based Auth guide](/docs/guides/auth/passwords) for more details." } ] }, { "tag": "@example", "name": "Verify Signup One-Time Password (OTP)", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.verifyOtp({ email, token, type: 'email'})\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Verify Signup One-Time Password (OTP)\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"recovery_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n },\n \"session\": {\n \"access_token\": \"\",\n \"token_type\": \"bearer\",\n \"expires_in\": 3600,\n \"expires_at\": 1700000000,\n \"refresh_token\": \"\",\n \"user\": {\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"aud\": \"authenticated\",\n \"role\": \"authenticated\",\n \"email\": \"example@email.com\",\n \"email_confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"phone\": \"\",\n \"confirmed_at\": \"2024-01-01T00:00:00Z\",\n \"recovery_sent_at\": \"2024-01-01T00:00:00Z\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"app_metadata\": {\n \"provider\": \"email\",\n \"providers\": [\n \"email\"\n ]\n },\n \"user_metadata\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"identities\": [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": false,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"example@email.com\"\n }\n ],\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"is_anonymous\": false\n }\n }\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@example", "name": "Verify SMS One-Time Password (OTP)", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.verifyOtp({ phone, token, type: 'sms'})\n```" } ] }, { "tag": "@example", "name": "Verify Email Auth (Token Hash)", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.verifyOtp({ token_hash: tokenHash, type: 'email'})\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 2224, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L2224" } ], "parameters": [ { "id": 294, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1062, "name": "VerifyOtpParams", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 805, "name": "AuthResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] } ], "groups": [ { "title": "Constructors", "children": [129] }, { "title": "Properties", "children": [133, 134, 135] }, { "title": "Methods", "children": [ 230, 685, 305, 368, 487, 214, 201, 497, 449, 298, 398, 302, 473, 386, 218, 286, 227, 289, 224, 295, 233, 439, 221, 563, 565, 508, 374, 292 ] } ], "categories": [ { "title": "Auth", "children": [ 230, 685, 305, 368, 487, 214, 497, 449, 298, 398, 302, 473, 386, 218, 286, 227, 289, 224, 295, 233, 439, 221, 563, 565, 508, 374, 292 ] }, { "title": "Other", "children": [129, 133, 134, 135, 201] } ], "sources": [ { "fileName": "packages/core/auth-js/src/GoTrueClient.ts", "line": 195, "character": 21, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/GoTrueClient.ts#L195" } ] }, { "id": 718, "name": "NavigatorLockAcquireTimeoutError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error thrown when the browser Navigator Lock API fails to acquire a lock." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nimport { NavigatorLockAcquireTimeoutError } from '@supabase/auth-js'\n\nthrow new NavigatorLockAcquireTimeoutError('Lock timed out')\n```" } ] } ] }, "children": [ { "id": 719, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/locks.ts", "line": 37, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/locks.ts#L37" } ], "signatures": [ { "id": 720, "name": "NavigatorLockAcquireTimeoutError", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/locks.ts", "line": 37, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/locks.ts#L37" } ], "parameters": [ { "id": 721, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": 718, "name": "NavigatorLockAcquireTimeoutError", "package": "@supabase/auth-js" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "LockAcquireTimeoutError.constructor" } } ], "inheritedFrom": { "type": "reference", "target": -1, "name": "LockAcquireTimeoutError.constructor" } }, { "id": 722, "name": "isAcquireTimeout", "variant": "declaration", "kind": 1024, "flags": { "isPublic": true, "isReadonly": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/locks.ts", "line": 35, "character": 18, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/locks.ts#L35" } ], "type": { "type": "literal", "value": true }, "defaultValue": "true", "inheritedFrom": { "type": "reference", "target": -1, "name": "LockAcquireTimeoutError.isAcquireTimeout" } } ], "groups": [ { "title": "Constructors", "children": [719] }, { "title": "Properties", "children": [722] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/locks.ts", "line": 52, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/locks.ts#L52" } ], "extendedTypes": [ { "type": "reference", "target": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "LockAcquireTimeoutError" }, "name": "LockAcquireTimeoutError", "package": "@supabase/auth-js" } ] }, { "id": 927, "name": "AdminUserAttributes", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 929, "name": "app_metadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A custom data object to store the user's application specific metadata. This maps to the " }, { "kind": "code", "text": "`auth.users.app_metadata`" }, { "kind": "text", "text": " column.\n\nOnly a service role can modify.\n\nThe " }, { "kind": "code", "text": "`app_metadata`" }, { "kind": "text", "text": " should be a JSON object that includes app-specific info, such as identity providers, roles, and other\naccess control information." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 528, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L528" } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 932, "name": "ban_duration", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Determines how long a user is banned for.\n\nThe format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.\nValid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".\n\nFor example, some possible durations include: '300ms', '2h45m'.\n\nSetting the ban duration to 'none' lifts the ban on the user." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 554, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L554" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 940, "name": "current_password", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "The user's current password\n\nThis is only ever present when the user is resetting\ntheir password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 474, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L474" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "Omit.current_password" } }, { "id": 938, "name": "email", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "The user's email." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 479, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L479" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "Omit.email" } }, { "id": 930, "name": "email_confirm", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Sets the user's email as confirmed when true, or unconfirmed when false.\n\nOnly a service role can modify." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 535, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L535" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 935, "name": "id", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The " }, { "kind": "code", "text": "`id`" }, { "kind": "text", "text": " for the user.\n\nAllows you to overwrite the default " }, { "kind": "code", "text": "`id`" }, { "kind": "text", "text": " set for the user." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 579, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L579" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 936, "name": "nonce", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 496, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L496" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "Omit.nonce" } }, { "id": 939, "name": "password", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "The user's password." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 489, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L489" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "Omit.password" } }, { "id": 934, "name": "password_hash", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The " }, { "kind": "code", "text": "`password_hash`" }, { "kind": "text", "text": " for the user's password.\n\nAllows you to specify a password hash for the user. This is useful for migrating a user's password hash from another service.\n\nSupports bcrypt, scrypt (firebase), and argon2 password hashes." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 572, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L572" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 937, "name": "phone", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true, "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "The user's phone." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 484, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L484" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "Omit.phone" } }, { "id": 931, "name": "phone_confirm", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Sets the user's phone as confirmed when true, or unconfirmed when false.\n\nOnly a service role can modify." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 542, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L542" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 933, "name": "role", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The " }, { "kind": "code", "text": "`role`" }, { "kind": "text", "text": " claim set in the user's access token JWT.\n\nWhen a user signs up, this role is set to " }, { "kind": "code", "text": "`authenticated`" }, { "kind": "text", "text": " by default. You should only modify the " }, { "kind": "code", "text": "`role`" }, { "kind": "text", "text": " if you need to provision several levels of admin access that have different permissions on individual columns in your database.\n\nSetting this role to " }, { "kind": "code", "text": "`service_role`" }, { "kind": "text", "text": " is not recommended as it grants the user admin privileges." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 563, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L563" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 928, "name": "user_metadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A custom data object to store the user's metadata. This maps to the " }, { "kind": "code", "text": "`auth.users.raw_user_meta_data`" }, { "kind": "text", "text": " column.\n\n\nThe " }, { "kind": "code", "text": "`user_metadata`" }, { "kind": "text", "text": " should be a JSON object that includes user-specific info, such as their first and last name.\n\nNote: When using the GoTrueAdminApi and wanting to modify a user's metadata,\nthis attribute is used instead of UserAttributes data." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 518, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L518" } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Properties", "children": [929, 932, 940, 938, 930, 935, 936, 939, 934, 937, 931, 933, 928] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 507, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L507" } ], "extendedTypes": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Omit" }, "typeArguments": [ { "type": "reference", "target": 920, "name": "UserAttributes", "package": "@supabase/auth-js" }, { "type": "literal", "value": "data" } ], "name": "Omit", "package": "typescript" } ] }, { "id": 858, "name": "AMREntry", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "An authentication method reference (AMR) entry.\n\nAn entry designates what method was used by the user to verify their\nidentity and at what time.\n\nNote: Custom access token hooks can return AMR claims as either:\n- An array of AMREntry objects (detailed format with timestamps)\n- An array of strings (RFC-8176 compliant format)" } ], "blockTags": [ { "tag": "@see", "content": [ { "kind": "inline-tag", "tag": "@link", "text": "GoTrueMFAApi#getAuthenticatorAssuranceLevel", "target": 1312 }, { "kind": "text", "text": "." } ] } ] }, "children": [ { "id": 859, "name": "method", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Authentication method name." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 353, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L353" } ], "type": { "type": "reference", "target": 856, "name": "AMRMethod", "package": "@supabase/auth-js" } }, { "id": 860, "name": "timestamp", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Timestamp when the method was successfully used. Represents number of\nseconds since 1st January 1970 (UNIX epoch) in UTC." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 359, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L359" } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "children": [859, 860] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 351, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L351" } ] }, { "id": 1622, "name": "AuthOAuthServerApi", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Contains all OAuth 2.1 authorization server user-facing methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThese methods are used to implement the consent page." } ] }, "children": [ { "id": 1626, "name": "approveAuthorization", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2590, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2590" } ], "signatures": [ { "id": 1627, "name": "approveAuthorization", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Approves an OAuth authorization request.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nAfter approval, the user's consent is stored and an authorization code is generated.\nThe response contains a complete redirect URL with the authorization code and state." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "Redirect URL to send the user back to the OAuth client with authorization code" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2590, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2590" } ], "parameters": [ { "id": 1628, "name": "authorizationId", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The authorization ID to approve" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1629, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional parameters" } ] }, "type": { "type": "reflection", "declaration": { "id": 1630, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1631, "name": "skipBrowserRedirect", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If false (default), automatically redirects the browser to the OAuth client. If true, returns the redirect_url without automatic redirect (useful for custom handling)." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2592, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2592" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [1631] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2592, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2592" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1613, "name": "AuthOAuthConsentResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1632, "name": "denyAuthorization", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2609, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2609" } ], "signatures": [ { "id": 1633, "name": "denyAuthorization", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Denies an OAuth authorization request.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nAfter denial, the response contains a redirect URL with an OAuth error\n(access_denied) to inform the OAuth client that the user rejected the request." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "Redirect URL to send the user back to the OAuth client with error information" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2609, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2609" } ], "parameters": [ { "id": 1634, "name": "authorizationId", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The authorization ID to deny" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1635, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional parameters" } ] }, "type": { "type": "reflection", "declaration": { "id": 1636, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1637, "name": "skipBrowserRedirect", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If false (default), automatically redirects the browser to the OAuth client. If true, returns the redirect_url without automatic redirect (useful for custom handling)." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2611, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2611" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [1637] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2611, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2611" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1613, "name": "AuthOAuthConsentResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1623, "name": "getAuthorizationDetails", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2574, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2574" } ], "signatures": [ { "id": 1624, "name": "getAuthorizationDetails", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Retrieves details about an OAuth authorization request.\nUsed to display consent information to the user.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis method returns one of two response types:\n- " }, { "kind": "code", "text": "`OAuthAuthorizationDetails`" }, { "kind": "text", "text": ": User needs to consent - show consent page with client info\n- " }, { "kind": "code", "text": "`OAuthRedirect`" }, { "kind": "text", "text": ": User already consented - redirect immediately to the OAuth client\n\nUse type narrowing to distinguish between the responses:\n" }, { "kind": "code", "text": "```typescript\nif ('authorization_id' in data) {\n // Show consent page\n} else {\n // Redirect to data.redirect_url\n}\n```" } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "Authorization details or redirect URL depending on consent status" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2574, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2574" } ], "parameters": [ { "id": 1625, "name": "authorizationId", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The authorization ID from the authorization request" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1612, "name": "AuthOAuthAuthorizationDetailsResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1638, "name": "listGrants", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2622, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2622" } ], "signatures": [ { "id": 1639, "name": "listGrants", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Lists all OAuth grants that the authenticated user has authorized.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "Response with array of OAuth grants with client information and granted scopes" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2622, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2622" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1619, "name": "AuthOAuthGrantsResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1640, "name": "revokeGrant", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2637, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2637" } ], "signatures": [ { "id": 1641, "name": "revokeGrant", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Revokes a user's OAuth grant for a specific client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nRevocation marks consent as revoked, deletes active sessions for that OAuth client,\nand invalidates associated refresh tokens." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "Empty response on successful revocation" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2637, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2637" } ], "parameters": [ { "id": 1642, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Revocation options" } ] }, "type": { "type": "reflection", "declaration": { "id": 1643, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1644, "name": "clientId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The OAuth client identifier (UUID) to revoke access for" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2637, "character": 25, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2637" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1644] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2637, "character": 23, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2637" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1620, "name": "AuthOAuthRevokeGrantResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] } ], "groups": [ { "title": "Methods", "children": [1626, 1632, 1623, 1638, 1640] } ], "categories": [ { "title": "Auth", "children": [1626, 1632, 1623, 1638, 1640] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2550, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2550" } ] }, { "id": 1135, "name": "GenerateLinkOptions", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 1136, "name": "data", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A custom data object to store the user's metadata. This maps to the " }, { "kind": "code", "text": "`auth.users.raw_user_meta_data`" }, { "kind": "text", "text": " column.\n\nThe " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " should be a JSON object that includes user-specific info, such as their first and last name." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 933, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L933" } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 1137, "name": "redirectTo", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The URL which will be appended to the email link generated." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 935, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L935" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1136, 1137] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 927, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L927" } ] }, { "id": 1573, "name": "GoTrueAdminCustomProvidersApi", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Contains all custom OIDC/OAuth provider administration methods." } ] }, "children": [ { "id": 1577, "name": "createProvider", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2393, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2393" } ], "signatures": [ { "id": 1578, "name": "createProvider", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates a new custom OIDC/OAuth provider.\n\nFor OIDC providers, the server fetches and validates the OpenID Connect discovery document\nfrom the issuer's well-known endpoint (or the provided " }, { "kind": "code", "text": "`discovery_url`" }, { "kind": "text", "text": ") at creation time.\nThis may return a validation error (" }, { "kind": "code", "text": "`error_code: \"validation_failed\"`" }, { "kind": "text", "text": ") if the discovery\ndocument is unreachable, not valid JSON, missing required fields, or if the issuer\nin the document does not match the expected issuer.\n\nThis function should only be called on a server. Never expose your " }, { "kind": "code", "text": "`service_role`" }, { "kind": "text", "text": " key in the browser." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2393, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2393" } ], "parameters": [ { "id": 1579, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1518, "name": "CreateCustomProviderParams", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1561, "name": "CustomProviderResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1587, "name": "deleteProvider", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2422, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2422" } ], "signatures": [ { "id": 1588, "name": "deleteProvider", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Deletes a custom provider.\n\nThis function should only be called on a server. Never expose your " }, { "kind": "code", "text": "`service_role`" }, { "kind": "text", "text": " key in the browser." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2422, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2422" } ], "parameters": [ { "id": 1589, "name": "identifier", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reflection", "declaration": { "id": 1590, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1591, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2422, "character": 48, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2422" } ], "type": { "type": "literal", "value": null } }, { "id": 1592, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2422, "character": 60, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2422" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } ] } } ], "groups": [ { "title": "Properties", "children": [1591, 1592] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2422, "character": 46, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2422" } ] } } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1580, "name": "getProvider", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2400, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2400" } ], "signatures": [ { "id": 1581, "name": "getProvider", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Gets details of a specific custom provider by identifier.\n\nThis function should only be called on a server. Never expose your " }, { "kind": "code", "text": "`service_role`" }, { "kind": "text", "text": " key in the browser." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2400, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2400" } ], "parameters": [ { "id": 1582, "name": "identifier", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1561, "name": "CustomProviderResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1574, "name": "listProviders", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2380, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2380" } ], "signatures": [ { "id": 1575, "name": "listProviders", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Lists all custom providers with optional type filter.\n\nThis function should only be called on a server. Never expose your " }, { "kind": "code", "text": "`service_role`" }, { "kind": "text", "text": " key in the browser." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2380, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2380" } ], "parameters": [ { "id": 1576, "name": "params", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 1558, "name": "ListCustomProvidersParams", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1562, "name": "CustomProviderListResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1583, "name": "updateProvider", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2412, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2412" } ], "signatures": [ { "id": 1584, "name": "updateProvider", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Updates an existing custom provider.\n\nWhen " }, { "kind": "code", "text": "`issuer`" }, { "kind": "text", "text": " or " }, { "kind": "code", "text": "`discovery_url`" }, { "kind": "text", "text": " is changed on an OIDC provider, the server re-fetches and\nvalidates the discovery document before persisting. This may return a validation error\n(" }, { "kind": "code", "text": "`error_code: \"validation_failed\"`" }, { "kind": "text", "text": ") if the discovery document is unreachable, invalid, or\nthe issuer does not match.\n\nThis function should only be called on a server. Never expose your " }, { "kind": "code", "text": "`service_role`" }, { "kind": "text", "text": " key in the browser." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2412, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2412" } ], "parameters": [ { "id": 1585, "name": "identifier", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1586, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1539, "name": "UpdateCustomProviderParams", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1561, "name": "CustomProviderResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] } ], "groups": [ { "title": "Methods", "children": [1577, 1587, 1580, 1574, 1583] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2374, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2374" } ] }, { "id": 1329, "name": "GoTrueAdminMFAApi", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Contains the full multi-factor authentication administration API." } ], "blockTags": [ { "tag": "@expermental", "content": [] } ] }, "children": [ { "id": 1333, "name": "deleteFactor", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1771, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1771" } ], "signatures": [ { "id": 1334, "name": "deleteFactor", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Deletes a factor on a user. This will log the user out of all active\nsessions if the deleted factor was verified." } ], "blockTags": [ { "tag": "@see", "content": [ { "kind": "inline-tag", "tag": "@link", "text": "GoTrueMFAApi#unenroll", "target": 1301 } ] }, { "tag": "@expermental", "content": [] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@example", "name": "Delete a factor for a user", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.admin.mfa.deleteFactor({\n id: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n userId: 'a89baba7-b1b7-440f-b4bb-91026967f66b',\n})\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Delete a factor for a user\n" }, { "kind": "code", "text": "```json\n{\n data: {\n id: '34e770dd-9ff9-416c-87fa-43b31d7ef225'\n },\n error: null\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1771, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1771" } ], "parameters": [ { "id": 1335, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1319, "name": "AuthMFAAdminDeleteFactorParams", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1316, "name": "AuthMFAAdminDeleteFactorResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1330, "name": "listFactors", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1741, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1741" } ], "signatures": [ { "id": 1331, "name": "listFactors", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Lists all factors associated to a user." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@example", "name": "List all factors for a user", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.admin.mfa.listFactors()\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "List all factors for a user\n" }, { "kind": "code", "text": "```json\n{\n data: {\n factors: Factor[\n {\n id: '',\n friendly_name: 'Auth App Factor',\n factor_type: 'totp',\n status: 'verified',\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z'\n }\n ]\n },\n error: null\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1741, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1741" } ], "parameters": [ { "id": 1332, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1326, "name": "AuthMFAAdminListFactorsParams", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1323, "name": "AuthMFAAdminListFactorsResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] } ], "groups": [ { "title": "Methods", "children": [1333, 1330] } ], "categories": [ { "title": "Auth", "children": [1333, 1330] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1710, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1710" } ] }, { "id": 1458, "name": "GoTrueAdminOAuthApi", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Contains all OAuth client administration methods.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." } ] }, "children": [ { "id": 1462, "name": "createClient", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2133, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2133" } ], "signatures": [ { "id": 1463, "name": "createClient", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates a new OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " }, { "kind": "code", "text": "`service_role`" }, { "kind": "text", "text": " key in the browser." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2133, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2133" } ], "parameters": [ { "id": 1464, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1428, "name": "CreateOAuthClientParams", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1445, "name": "OAuthClientResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1472, "name": "deleteClient", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2163, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2163" } ], "signatures": [ { "id": 1473, "name": "deleteClient", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Deletes an OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " }, { "kind": "code", "text": "`service_role`" }, { "kind": "text", "text": " key in the browser." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2163, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2163" } ], "parameters": [ { "id": 1474, "name": "clientId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reflection", "declaration": { "id": 1475, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1476, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2163, "character": 44, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2163" } ], "type": { "type": "literal", "value": null } }, { "id": 1477, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2163, "character": 56, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2163" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } ] } } ], "groups": [ { "title": "Properties", "children": [1476, 1477] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2163, "character": 42, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2163" } ] } } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1465, "name": "getClient", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2143, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2143" } ], "signatures": [ { "id": 1466, "name": "getClient", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Gets details of a specific OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " }, { "kind": "code", "text": "`service_role`" }, { "kind": "text", "text": " key in the browser." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2143, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2143" } ], "parameters": [ { "id": 1467, "name": "clientId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1445, "name": "OAuthClientResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1459, "name": "listClients", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2123, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2123" } ], "signatures": [ { "id": 1460, "name": "listClients", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Lists all OAuth clients with optional pagination.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " }, { "kind": "code", "text": "`service_role`" }, { "kind": "text", "text": " key in the browser." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2123, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2123" } ], "parameters": [ { "id": 1461, "name": "params", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 1350, "name": "PageParams", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1446, "name": "OAuthClientListResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1478, "name": "regenerateClientSecret", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2173, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2173" } ], "signatures": [ { "id": 1479, "name": "regenerateClientSecret", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Regenerates the secret for an OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " }, { "kind": "code", "text": "`service_role`" }, { "kind": "text", "text": " key in the browser." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2173, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2173" } ], "parameters": [ { "id": 1480, "name": "clientId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1445, "name": "OAuthClientResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1468, "name": "updateClient", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2153, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2153" } ], "signatures": [ { "id": 1469, "name": "updateClient", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Updates an existing OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis function should only be called on a server. Never expose your " }, { "kind": "code", "text": "`service_role`" }, { "kind": "text", "text": " key in the browser." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2153, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2153" } ], "parameters": [ { "id": 1470, "name": "clientId", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1471, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1437, "name": "UpdateOAuthClientParams", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1445, "name": "OAuthClientResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] } ], "groups": [ { "title": "Methods", "children": [1462, 1472, 1465, 1459, 1478, 1468] } ], "categories": [ { "title": "Auth", "children": [1462, 1472, 1465, 1459, 1478, 1468] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2114, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2114" } ] }, { "id": 1198, "name": "GoTrueMFAApi", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Contains the full multi-factor authentication API." } ] }, "children": [ { "id": 1315, "name": "webauthn", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1668, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1668" } ], "type": { "type": "reference", "target": { "sourceFileName": "src/lib/webauthn.ts", "qualifiedName": "WebAuthnApi" }, "name": "WebAuthnApi", "package": "@supabase/auth-js" } }, { "id": 1219, "name": "challenge", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1406, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1406" }, { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1407, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1407" }, { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1408, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1408" }, { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1409, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1409" } ], "signatures": [ { "id": 1220, "name": "challenge", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Prepares a challenge used to verify that a user has access to a MFA\nfactor." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- An [enrolled factor](/docs/reference/javascript/auth-mfa-enroll) is required before creating a challenge.\n- To verify a challenge, see [" }, { "kind": "code", "text": "`mfa.verify()`" }, { "kind": "text", "text": "](/docs/reference/javascript/auth-mfa-verify).\n- A phone factor sends a code to the user upon challenge. The channel defaults to " }, { "kind": "code", "text": "`sms`" }, { "kind": "text", "text": " unless otherwise specified." } ] }, { "tag": "@example", "name": "Create a challenge for a factor", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.mfa.challenge({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225'\n})\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Create a challenge for a factor\n" }, { "kind": "code", "text": "```json\n{\n data: {\n id: '',\n type: 'totp',\n expires_at: 1700000000\n },\n error: null\n}\n```" } ] }, { "tag": "@example", "name": "Create a challenge for a phone factor", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.mfa.challenge({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n})\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Create a challenge for a phone factor\n" }, { "kind": "code", "text": "```json\n{\n data: {\n id: '',\n type: 'phone',\n expires_at: 1700000000\n },\n error: null\n}\n```" } ] }, { "tag": "@example", "name": "Create a challenge for a phone factor (WhatsApp)", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.mfa.challenge({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n channel: 'whatsapp',\n})\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Create a challenge for a phone factor (WhatsApp)\n" }, { "kind": "code", "text": "```json\n{\n data: {\n id: '',\n expires_at: 1700000000\n },\n error: null\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1406, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1406" } ], "parameters": [ { "id": 1221, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1222, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1223, "name": "factorId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ID of the factor to be challenged. Returned in enroll()." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1041, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1041" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1223] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 191, "character": 51, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L191" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 1224, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1225, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 209, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L209" } ], "type": { "type": "literal", "value": null } }, { "id": 1226, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 210, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L210" } ], "type": { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [1225, 1226] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 191, "character": 51, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L191" } ] } }, { "type": "reflection", "declaration": { "id": 1227, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1228, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 205, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L205" } ], "type": { "type": "reflection", "declaration": { "id": 1229, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1232, "name": "expires_at", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Timestamp in UNIX seconds when this challenge will no longer be usable." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1137, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1137" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1230, "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ID of the newly created challenge." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1131, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1131" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1231, "name": "type", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Factor Type which generated the challenge" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1134, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1134" } ], "type": { "type": "literal", "value": "totp" } } ], "groups": [ { "title": "Properties", "children": [1232, 1230, 1231] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 191, "character": 51, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L191" } ] } } }, { "id": 1233, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 206, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L206" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [1228, 1233] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 191, "character": 51, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L191" } ] } } ] } ], "name": "Promise", "package": "typescript" } }, { "id": 1234, "name": "challenge", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1407, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1407" } ], "parameters": [ { "id": 1235, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1236, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1238, "name": "channel", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Messaging channel to use (e.g. whatsapp or sms). Only relevant for phone factors" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1051, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1051" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "sms" }, { "type": "literal", "value": "whatsapp" } ] } }, { "id": 1237, "name": "factorId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ID of the factor to be challenged. Returned in enroll()." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1041, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1041" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1238, 1237] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 191, "character": 51, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L191" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 1239, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1240, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 209, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L209" } ], "type": { "type": "literal", "value": null } }, { "id": 1241, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 210, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L210" } ], "type": { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [1240, 1241] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 191, "character": 51, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L191" } ] } }, { "type": "reflection", "declaration": { "id": 1242, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1243, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 205, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L205" } ], "type": { "type": "reflection", "declaration": { "id": 1244, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1247, "name": "expires_at", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Timestamp in UNIX seconds when this challenge will no longer be usable." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1137, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1137" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1245, "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ID of the newly created challenge." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1131, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1131" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1246, "name": "type", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Factor Type which generated the challenge" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1134, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1134" } ], "type": { "type": "literal", "value": "phone" } } ], "groups": [ { "title": "Properties", "children": [1247, 1245, 1246] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 191, "character": 51, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L191" } ] } } }, { "id": 1248, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 206, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L206" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [1243, 1248] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 191, "character": 51, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L191" } ] } } ] } ], "name": "Promise", "package": "typescript" } }, { "id": 1249, "name": "challenge", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1408, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1408" } ], "parameters": [ { "id": 1250, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1251, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1252, "name": "factorId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ID of the factor to be challenged. Returned in enroll()." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1041, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1041" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1253, "name": "webauthn", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1060, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1060" } ], "type": { "type": "reflection", "declaration": { "id": 1254, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1255, "name": "rpId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Relying party ID" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1062, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1062" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1256, "name": "rpOrigins", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Relying party origins" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1064, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1064" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } ], "groups": [ { "title": "Properties", "children": [1255, 1256] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1060, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1060" } ] } } } ], "groups": [ { "title": "Properties", "children": [1252, 1253] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 191, "character": 51, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L191" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 1257, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1258, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 209, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L209" } ], "type": { "type": "literal", "value": null } }, { "id": 1259, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 210, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L210" } ], "type": { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [1258, 1259] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 191, "character": 51, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L191" } ] } }, { "type": "reflection", "declaration": { "id": 1260, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1261, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 205, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L205" } ], "type": { "type": "reflection", "declaration": { "id": 1262, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1265, "name": "expires_at", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Timestamp in UNIX seconds when this challenge will no longer be usable." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1137, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1137" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1263, "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ID of the newly created challenge." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1131, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1131" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1264, "name": "type", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Factor Type which generated the challenge" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1134, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1134" } ], "type": { "type": "literal", "value": "webauthn" } }, { "id": 1266, "name": "webauthn", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1157, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1157" } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 1267, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1269, "name": "credential_options", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1160, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1160" } ], "type": { "type": "reflection", "declaration": { "id": 1270, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1271, "name": "publicKey", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1160, "character": 30, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1160" } ], "type": { "type": "reference", "target": { "sourceFileName": "src/lib/webauthn.dom.ts", "qualifiedName": "PublicKeyCredentialCreationOptionsFuture" }, "name": "PublicKeyCredentialCreationOptionsFuture", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [1271] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1160, "character": 28, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1160" } ] } } }, { "id": 1268, "name": "type", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1159, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1159" } ], "type": { "type": "literal", "value": "create" } } ], "groups": [ { "title": "Properties", "children": [1269, 1268] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1158, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1158" } ] } }, { "type": "reflection", "declaration": { "id": 1272, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1274, "name": "credential_options", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1164, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1164" } ], "type": { "type": "reflection", "declaration": { "id": 1275, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1276, "name": "publicKey", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1164, "character": 30, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1164" } ], "type": { "type": "reference", "target": { "sourceFileName": "src/lib/webauthn.dom.ts", "qualifiedName": "PublicKeyCredentialRequestOptionsFuture" }, "name": "PublicKeyCredentialRequestOptionsFuture", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [1276] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1164, "character": 28, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1164" } ] } } }, { "id": 1273, "name": "type", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1163, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1163" } ], "type": { "type": "literal", "value": "request" } } ], "groups": [ { "title": "Properties", "children": [1274, 1273] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1162, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1162" } ] } } ] } } ], "groups": [ { "title": "Properties", "children": [1265, 1263, 1264, 1266] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 191, "character": 51, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L191" } ] } } }, { "id": 1277, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 206, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L206" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [1261, 1277] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 191, "character": 51, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L191" } ] } } ] } ], "name": "Promise", "package": "typescript" } }, { "id": 1278, "name": "challenge", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1409, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1409" } ], "parameters": [ { "id": 1279, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1168, "name": "MFAChallengeParams", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1187, "name": "AuthMFAChallengeResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1304, "name": "challengeAndVerify", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1598, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1598" } ], "signatures": [ { "id": 1305, "name": "challengeAndVerify", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is\nprovided by the user by entering a code seen in their authenticator app." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Intended for use with only TOTP factors.\n- An [enrolled factor](/docs/reference/javascript/auth-mfa-enroll) is required before invoking " }, { "kind": "code", "text": "`challengeAndVerify()`" }, { "kind": "text", "text": ".\n- Executes [" }, { "kind": "code", "text": "`mfa.challenge()`" }, { "kind": "text", "text": "](/docs/reference/javascript/auth-mfa-challenge) and [" }, { "kind": "code", "text": "`mfa.verify()`" }, { "kind": "text", "text": "](/docs/reference/javascript/auth-mfa-verify) in a single step." } ] }, { "tag": "@example", "name": "Create and verify a challenge for a factor", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.mfa.challengeAndVerify({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n code: '123456'\n})\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Create and verify a challenge for a factor\n" }, { "kind": "code", "text": "```json\n{\n data: {\n access_token: '',\n token_type: 'Bearer',\n expires_in: 3600,\n refresh_token: '',\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n provider: 'email',\n providers: [\n \"email\",\n ]\n },\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n factors: [\n \"id\": '',\n \"friendly_name\": 'Important Auth App',\n \"factor_type\": 'totp',\n \"status\": 'verified',\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n ]\n }\n }\n error: null\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1598, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1598" } ], "parameters": [ { "id": 1306, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1307, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1309, "name": "code", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Verification code provided by the user." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 995, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L995" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1308, "name": "factorId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ID of the factor being verified. Returned in enroll()." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 988, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L988" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1309, 1308] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 191, "character": 51, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L191" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1177, "name": "AuthMFAVerifyResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1199, "name": "enroll", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1333, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1333" }, { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1334, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1334" }, { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1335, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1335" }, { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1336, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1336" } ], "signatures": [ { "id": 1200, "name": "enroll", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Starts the enrollment process for a new Multi-Factor Authentication (MFA)\nfactor. This method creates a new " }, { "kind": "code", "text": "`unverified`" }, { "kind": "text", "text": " factor.\nTo verify a factor, present the QR code or secret to the user and ask them to add it to their\nauthenticator app.\nThe user has to enter the code from their authenticator app to verify it.\n\nUpon verifying a factor, all other sessions are logged out and the current session's authenticator level is promoted to " }, { "kind": "code", "text": "`aal2`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Use " }, { "kind": "code", "text": "`totp`" }, { "kind": "text", "text": " or " }, { "kind": "code", "text": "`phone`" }, { "kind": "text", "text": " as the " }, { "kind": "code", "text": "`factorType`" }, { "kind": "text", "text": " and use the returned " }, { "kind": "code", "text": "`id`" }, { "kind": "text", "text": " to create a challenge.\n- To create a challenge, see [" }, { "kind": "code", "text": "`mfa.challenge()`" }, { "kind": "text", "text": "](/docs/reference/javascript/auth-mfa-challenge).\n- To verify a challenge, see [" }, { "kind": "code", "text": "`mfa.verify()`" }, { "kind": "text", "text": "](/docs/reference/javascript/auth-mfa-verify).\n- To create and verify a TOTP challenge in a single step, see [" }, { "kind": "code", "text": "`mfa.challengeAndVerify()`" }, { "kind": "text", "text": "](/docs/reference/javascript/auth-mfa-challengeandverify).\n- To generate a QR code for the " }, { "kind": "code", "text": "`totp`" }, { "kind": "text", "text": " secret in Next.js, you can do the following:\n" }, { "kind": "code", "text": "```html\n{data.totp.uri}\n```" }, { "kind": "text", "text": "\n- The " }, { "kind": "code", "text": "`challenge`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`verify`" }, { "kind": "text", "text": " steps are separated when using Phone factors as the user will need time to receive and input the code obtained from the SMS in challenge." } ] }, { "tag": "@example", "name": "Enroll a time-based, one-time password (TOTP) factor", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.mfa.enroll({\n factorType: 'totp',\n friendlyName: 'your_friendly_name'\n})\n\n// Use the id to create a challenge.\n// The challenge can be verified by entering the code generated from the authenticator app.\n// The code will be generated upon scanning the qr_code or entering the secret into the authenticator app.\nconst { id, type, totp: { qr_code, secret, uri }, friendly_name } = data\nconst challenge = await supabase.auth.mfa.challenge({ factorId: id });\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Enroll a time-based, one-time password (TOTP) factor\n" }, { "kind": "code", "text": "```json\n{\n data: {\n id: '',\n type: 'totp'\n totp: {\n qr_code: '',\n secret: '',\n uri: '',\n }\n friendly_name?: 'Important app'\n },\n error: null\n}\n```" } ] }, { "tag": "@example", "name": "Enroll a Phone Factor", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.mfa.enroll({\n factorType: 'phone',\n friendlyName: 'your_friendly_name',\n phone: '+12345678',\n})\n\n// Use the id to create a challenge and send an SMS with a code to the user.\nconst { id, type, friendly_name, phone } = data\n\nconst challenge = await supabase.auth.mfa.challenge({ factorId: id });\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Enroll a Phone Factor\n" }, { "kind": "code", "text": "```json\n{\n data: {\n id: '',\n type: 'phone',\n friendly_name?: 'Important app',\n phone: '+5787123456'\n },\n error: null\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1333, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1333" } ], "parameters": [ { "id": 1201, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1202, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1203, "name": "factorType", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The type of factor being enrolled." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1830, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1830" } ], "type": { "type": "literal", "value": "totp" } }, { "id": 1204, "name": "friendlyName", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Human readable name assigned to the factor." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1832, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1832" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1205, "name": "issuer", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Domain which the user is enrolled with." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1837, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1837" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1203, 1204, 1205] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 191, "character": 51, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L191" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1360, "name": "AuthMFAEnrollTOTPResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } }, { "id": 1206, "name": "enroll", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1334, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1334" } ], "parameters": [ { "id": 1207, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1208, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1209, "name": "factorType", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The type of factor being enrolled." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1830, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1830" } ], "type": { "type": "literal", "value": "phone" } }, { "id": 1210, "name": "friendlyName", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Human readable name assigned to the factor." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1832, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1832" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1211, "name": "phone", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Phone number associated with a factor. Number should conform to E.164 format" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1844, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1844" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1209, 1210, 1211] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 191, "character": 51, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L191" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1361, "name": "AuthMFAEnrollPhoneResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } }, { "id": 1212, "name": "enroll", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1335, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1335" } ], "parameters": [ { "id": 1213, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1214, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1215, "name": "factorType", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The type of factor being enrolled." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1830, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1830" } ], "type": { "type": "literal", "value": "webauthn" } }, { "id": 1216, "name": "friendlyName", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Human readable name assigned to the factor." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1832, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1832" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1215, 1216] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 191, "character": 51, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L191" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1362, "name": "AuthMFAEnrollWebauthnResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } }, { "id": 1217, "name": "enroll", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1336, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1336" } ], "parameters": [ { "id": 1218, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1151, "name": "MFAEnrollParams", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1178, "name": "AuthMFAEnrollResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1312, "name": "getAuthenticatorAssuranceLevel", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1663, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1663" } ], "signatures": [ { "id": 1313, "name": "getAuthenticatorAssuranceLevel", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Returns the Authenticator Assurance Level (AAL) for the active session.\n\n- " }, { "kind": "code", "text": "`aal1`" }, { "kind": "text", "text": " (or " }, { "kind": "code", "text": "`null`" }, { "kind": "text", "text": ") means that the user's identity has been verified only\nwith a conventional login (email+password, OTP, magic link, social login,\netc.).\n- " }, { "kind": "code", "text": "`aal2`" }, { "kind": "text", "text": " means that the user's identity has been verified both with a conventional login and at least one MFA factor.\n\nWhen called without a JWT parameter, this method is fairly quick (microseconds)\nand rarely uses the network. When a JWT is provided (useful in server-side\nenvironments like Edge Functions where no session is stored), this method\nwill make a network request to validate the user and fetch their MFA factors." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Authenticator Assurance Level (AAL) is the measure of the strength of an authentication mechanism.\n- In Supabase, having an AAL of " }, { "kind": "code", "text": "`aal1`" }, { "kind": "text", "text": " refers to having the 1st factor of authentication such as an email and password or OAuth sign-in while " }, { "kind": "code", "text": "`aal2`" }, { "kind": "text", "text": " refers to the 2nd factor of authentication such as a time-based, one-time-password (TOTP) or Phone factor.\n- If the user has a verified factor, the " }, { "kind": "code", "text": "`nextLevel`" }, { "kind": "text", "text": " field will return " }, { "kind": "code", "text": "`aal2`" }, { "kind": "text", "text": ", else, it will return " }, { "kind": "code", "text": "`aal1`" }, { "kind": "text", "text": ".\n- An optional " }, { "kind": "code", "text": "`jwt`" }, { "kind": "text", "text": " parameter can be passed to check the AAL level of a specific JWT instead of the current session." } ] }, { "tag": "@example", "name": "Get the AAL details of a session", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.mfa.getAuthenticatorAssuranceLevel()\nconst { currentLevel, nextLevel, currentAuthenticationMethods } = data\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Get the AAL details of a session\n" }, { "kind": "code", "text": "```json\n{\n data: {\n currentLevel: 'aal1',\n nextLevel: 'aal2',\n currentAuthenticationMethods: [\n {\n method: 'password',\n timestamp: 1700000000\n }\n ]\n }\n error: null\n}\n```" } ] }, { "tag": "@example", "name": "Get the AAL details for a specific JWT", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.mfa.getAuthenticatorAssuranceLevel(jwt)\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1663, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1663" } ], "parameters": [ { "id": 1314, "name": "jwt", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Takes in an optional access token JWT. If no JWT is provided, the JWT from the current session is used." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1193, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1310, "name": "listFactors", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1610, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1610" } ], "signatures": [ { "id": 1311, "name": "listFactors", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Returns the list of MFA factors enabled for this user." } ], "blockTags": [ { "tag": "@see", "content": [ { "kind": "text", "text": " - " }, { "kind": "inline-tag", "tag": "@link", "text": "GoTrueMFAApi#enroll", "target": 1199 }, { "kind": "text", "text": "\n" }, { "kind": "text", "text": " - " }, { "kind": "inline-tag", "tag": "@link", "text": "GoTrueMFAApi#getAuthenticatorAssuranceLevel", "target": 1312 }, { "kind": "text", "text": "\n" }, { "kind": "text", "text": " - " }, { "kind": "inline-tag", "tag": "@link", "text": "GoTrueClient#getUser", "target": 368 }, { "kind": "text", "text": "\n" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1610, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1610" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1188, "typeArguments": [ { "type": "typeOperator", "operator": "readonly", "target": { "type": "tuple", "elements": [ { "type": "literal", "value": "totp" }, { "type": "literal", "value": "phone" }, { "type": "literal", "value": "webauthn" } ] } } ], "name": "AuthMFAListFactorsResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1301, "name": "unenroll", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1517, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1517" } ], "signatures": [ { "id": 1302, "name": "unenroll", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Unenroll removes a MFA factor.\nA user has to have an " }, { "kind": "code", "text": "`aal2`" }, { "kind": "text", "text": " authenticator level in order to unenroll a " }, { "kind": "code", "text": "`verified`" }, { "kind": "text", "text": " factor." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@example", "name": "Unenroll a factor", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.mfa.unenroll({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n})\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Unenroll a factor\n" }, { "kind": "code", "text": "```json\n{\n data: {\n id: ''\n },\n error: null\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1517, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1517" } ], "parameters": [ { "id": 1303, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1152, "name": "MFAUnenrollParams", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1179, "name": "AuthMFAUnenrollResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 1280, "name": "verify", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1489, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1489" }, { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1490, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1490" }, { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1491, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1491" }, { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1492, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1492" } ], "signatures": [ { "id": 1281, "name": "verify", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Verifies a code against a challenge. The verification code is\nprovided by the user by entering a code seen in their authenticator app." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Auth" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- To verify a challenge, please [create a challenge](/docs/reference/javascript/auth-mfa-challenge) first." } ] }, { "tag": "@example", "name": "Verify a challenge for a factor", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase.auth.mfa.verify({\n factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',\n challengeId: '4034ae6f-a8ce-4fb5-8ee5-69a5863a7c15',\n code: '123456'\n})\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Verify a challenge for a factor\n" }, { "kind": "code", "text": "```json\n{\n data: {\n access_token: '',\n token_type: 'Bearer',\n expires_in: 3600,\n refresh_token: '',\n user: {\n id: '11111111-1111-1111-1111-111111111111',\n aud: 'authenticated',\n role: 'authenticated',\n email: 'example@email.com',\n email_confirmed_at: '2024-01-01T00:00:00Z',\n phone: '',\n confirmation_sent_at: '2024-01-01T00:00:00Z',\n confirmed_at: '2024-01-01T00:00:00Z',\n last_sign_in_at: '2024-01-01T00:00:00Z',\n app_metadata: {\n provider: 'email',\n providers: [\n \"email\",\n ]\n },\n user_metadata: {},\n identities: [\n {\n \"identity_id\": \"22222222-2222-2222-2222-222222222222\",\n \"id\": \"11111111-1111-1111-1111-111111111111\",\n \"user_id\": \"11111111-1111-1111-1111-111111111111\",\n \"identity_data\": {\n \"email\": \"example@email.com\",\n \"email_verified\": true,\n \"phone_verified\": false,\n \"sub\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"provider\": \"email\",\n \"last_sign_in_at\": \"2024-01-01T00:00:00Z\",\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\",\n \"email\": \"email@example.com\"\n },\n ],\n created_at: '2024-01-01T00:00:00Z',\n updated_at: '2024-01-01T00:00:00Z',\n is_anonymous: false,\n factors: [\n \"id\": '',\n \"friendly_name\": 'Important Auth App',\n \"factor_type\": 'totp',\n \"status\": 'verified',\n \"created_at\": \"2024-01-01T00:00:00Z\",\n \"updated_at\": \"2024-01-01T00:00:00Z\"\n ]\n }\n }\n error: null\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1489, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1489" } ], "parameters": [ { "id": 1282, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1283, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1285, "name": "challengeId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ID of the challenge being verified. Returned in challenge()." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 990, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L990" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1286, "name": "code", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Verification code provided by the user." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 995, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L995" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1284, "name": "factorId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ID of the factor being verified. Returned in enroll()." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 988, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L988" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1285, 1286, 1284] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 191, "character": 51, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L191" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1177, "name": "AuthMFAVerifyResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } }, { "id": 1287, "name": "verify", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1490, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1490" } ], "parameters": [ { "id": 1288, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1289, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1291, "name": "challengeId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ID of the challenge being verified. Returned in challenge()." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 990, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L990" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1292, "name": "code", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Verification code provided by the user." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 995, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L995" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1290, "name": "factorId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ID of the factor being verified. Returned in enroll()." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 988, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L988" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1291, 1292, 1290] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 191, "character": 51, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L191" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1177, "name": "AuthMFAVerifyResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } }, { "id": 1293, "name": "verify", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1491, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1491" } ], "parameters": [ { "id": 1294, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1295, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1297, "name": "challengeId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ID of the challenge being verified. Returned in challenge()." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 990, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L990" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1296, "name": "factorId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ID of the factor being verified. Returned in enroll()." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 988, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L988" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1298, "name": "webauthn", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1025, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1025" } ], "type": { "type": "intersection", "types": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAVerifyWebauthnParamFieldsBase" }, "name": "MFAVerifyWebauthnParamFieldsBase", "package": "@supabase/auth-js" }, { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAVerifyWebauthnCredentialParamFields" }, "typeArguments": [ { "type": "union", "types": [ { "type": "literal", "value": "create" }, { "type": "literal", "value": "request" } ] } ], "name": "MFAVerifyWebauthnCredentialParamFields", "package": "@supabase/auth-js" } ] } } ], "groups": [ { "title": "Properties", "children": [1297, 1296, 1298] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 191, "character": 51, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L191" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1177, "name": "AuthMFAVerifyResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } }, { "id": 1299, "name": "verify", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1492, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1492" } ], "parameters": [ { "id": 1300, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1163, "name": "MFAVerifyParams", "package": "@supabase/auth-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1177, "name": "AuthMFAVerifyResponse", "package": "@supabase/auth-js" } ], "name": "Promise", "package": "typescript" } } ] } ], "groups": [ { "title": "Properties", "children": [1315] }, { "title": "Methods", "children": [1219, 1304, 1199, 1312, 1310, 1301, 1280] } ], "categories": [ { "title": "Auth", "children": [1219, 1304, 1199, 1312, 1310, 1301, 1280] }, { "title": "Other", "children": [1315] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1252, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1252" } ] }, { "id": 1398, "name": "JWK", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 1401, "name": "alg", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1973, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1973" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1400, "name": "key_ops", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1972, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1972" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 1402, "name": "kid", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1974, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1974" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1399, "name": "kty", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1971, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1971" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "RSA" }, { "type": "literal", "value": "EC" }, { "type": "literal", "value": "oct" } ] } } ], "groups": [ { "title": "Properties", "children": [1401, 1400, 1402, 1399] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1970, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1970" } ], "indexSignatures": [ { "id": 1403, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1975, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1975" } ], "parameters": [ { "id": 1404, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } ] }, { "id": 1378, "name": "JwtPayload", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "JWT Payload containing claims for Supabase authentication tokens.\n\nRequired claims (iss, aud, exp, iat, sub, role, aal, session_id) are inherited from RequiredClaims.\nAll other claims are optional as they can be customized via Custom Access Token Hooks." } ], "blockTags": [ { "tag": "@see", "content": [ { "kind": "text", "text": "https://supabase.com/docs/guides/auth/jwt-fields" } ] } ] }, "children": [ { "id": 1394, "name": "aal", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1932, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1932" } ], "type": { "type": "reference", "target": 1192, "name": "AuthenticatorAssuranceLevels", "package": "@supabase/auth-js" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RequiredClaims.aal" } }, { "id": 1386, "name": "amr", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Authentication Method References.\nSupports both RFC-8176 compliant format (string[]) and detailed format (AMREntry[]).\n- String format: ['password', 'otp'] - RFC-8176 compliant\n- Object format: [{ method: 'password', timestamp: 1234567890 }] - includes timestamps" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1961, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1961" } ], "type": { "type": "union", "types": [ { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } }, { "type": "array", "elementType": { "type": "reference", "target": 858, "name": "AMREntry", "package": "@supabase/auth-js" } } ] } }, { "id": 1384, "name": "app_metadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1953, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1953" } ], "type": { "type": "reference", "target": 885, "name": "UserAppMetadata", "package": "@supabase/auth-js" } }, { "id": 1390, "name": "aud", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1928, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1928" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } ] }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RequiredClaims.aud" } }, { "id": 1379, "name": "email", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1946, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1946" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1391, "name": "exp", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1929, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1929" } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RequiredClaims.exp" } }, { "id": 1392, "name": "iat", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1930, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1930" } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RequiredClaims.iat" } }, { "id": 1381, "name": "is_anonymous", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1948, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1948" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1388, "name": "iss", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1926, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1926" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RequiredClaims.iss" } }, { "id": 1382, "name": "jti", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1951, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1951" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1383, "name": "nbf", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1952, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1952" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1380, "name": "phone", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1947, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1947" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1387, "name": "ref", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1964, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1964" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1393, "name": "role", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1931, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1931" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RequiredClaims.role" } }, { "id": 1395, "name": "session_id", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1933, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1933" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RequiredClaims.session_id" } }, { "id": 1389, "name": "sub", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1927, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1927" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "RequiredClaims.sub" } }, { "id": 1385, "name": "user_metadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1954, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1954" } ], "type": { "type": "reference", "target": 890, "name": "UserMetadata", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [ 1394, 1386, 1384, 1390, 1379, 1391, 1392, 1381, 1388, 1382, 1383, 1380, 1387, 1393, 1395, 1389, 1385 ] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1944, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1944" } ], "indexSignatures": [ { "id": 1396, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1967, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1967" } ], "parameters": [ { "id": 1397, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } ], "extendedTypes": [ { "type": "reference", "target": 1368, "name": "RequiredClaims", "package": "@supabase/auth-js" } ] }, { "id": 847, "name": "Session", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 850, "name": "access_token", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The access token jwt. It is recommended to set the JWT_EXPIRY to a shorter expiry value." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 301, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L301" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 853, "name": "expires_at", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A timestamp of when the token will expire. Returned when a login is confirmed." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 313, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L313" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 852, "name": "expires_in", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The number of seconds until the token expires (since it was issued). Returned when a login is confirmed." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 309, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L309" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 849, "name": "provider_refresh_token", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The oauth provider refresh token. If present, this can be used to refresh the provider_token via the oauth provider's API.\nNot all oauth providers return a provider refresh token. If the provider_refresh_token is missing, please refer to the oauth provider's documentation for information on how to obtain the provider refresh token." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 297, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L297" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 848, "name": "provider_token", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The oauth provider token. If present, this can be used to make external API requests to the oauth provider used." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 292, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L292" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 851, "name": "refresh_token", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "A one-time used refresh token that never expires." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 305, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L305" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 854, "name": "token_type", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 314, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L314" } ], "type": { "type": "literal", "value": "bearer" } }, { "id": 855, "name": "user", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "When using a separate user storage, accessing properties of this object will throw an error." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 319, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L319" } ], "type": { "type": "reference", "target": 893, "name": "User", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [850, 853, 852, 849, 848, 851, 854, 855] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 288, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L288" } ] }, { "id": 941, "name": "Subscription", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 943, "name": "callback", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The function to call every time there is an event. eg: (eventName) => {}" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 592, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L592" } ], "type": { "type": "reflection", "declaration": { "id": 944, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 592, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L592" } ], "signatures": [ { "id": 945, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 592, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L592" } ], "parameters": [ { "id": 946, "name": "event", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 736, "name": "AuthChangeEvent", "package": "@supabase/auth-js" } }, { "id": 947, "name": "session", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": 847, "name": "Session", "package": "@supabase/auth-js" } ] } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } }, { "id": 942, "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "A unique identifier for this subscription, set by the client.\nThis is an internal identifier used for managing callbacks and should not be\nrelied upon by application code. Use the unsubscribe() method to remove listeners." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 588, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L588" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "symbol" } ] } }, { "id": 948, "name": "unsubscribe", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Call this to remove the listener." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 596, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L596" } ], "type": { "type": "reflection", "declaration": { "id": 949, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 596, "character": 15, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L596" } ], "signatures": [ { "id": 950, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 596, "character": 15, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L596" } ], "type": { "type": "intrinsic", "name": "void" } } ] } } } ], "groups": [ { "title": "Properties", "children": [943, 942, 948] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 582, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L582" } ] }, { "id": 893, "name": "User", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 904, "name": "action_link", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 448, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L448" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 895, "name": "app_metadata", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 439, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L439" } ], "type": { "type": "reference", "target": 885, "name": "UserAppMetadata", "package": "@supabase/auth-js" } }, { "id": 897, "name": "aud", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 441, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L441" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 919, "name": "banned_until", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 463, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L463" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 898, "name": "confirmation_sent_at", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 442, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L442" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 908, "name": "confirmed_at", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 452, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L452" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 907, "name": "created_at", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 451, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L451" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 918, "name": "deleted_at", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 462, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L462" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 905, "name": "email", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 449, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L449" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 900, "name": "email_change_sent_at", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 444, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L444" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 909, "name": "email_confirmed_at", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 453, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L453" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 917, "name": "factors", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 461, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L461" } ], "type": { "type": "array", "elementType": { "type": "union", "types": [ { "type": "reference", "target": 874, "typeArguments": [ { "type": "union", "types": [ { "type": "literal", "value": "totp" }, { "type": "literal", "value": "phone" }, { "type": "literal", "value": "webauthn" } ] }, { "type": "literal", "value": "verified" } ], "name": "Factor", "package": "@supabase/auth-js" }, { "type": "reference", "target": 874, "typeArguments": [ { "type": "union", "types": [ { "type": "literal", "value": "totp" }, { "type": "literal", "value": "phone" }, { "type": "literal", "value": "webauthn" } ] }, { "type": "literal", "value": "unverified" } ], "name": "Factor", "package": "@supabase/auth-js" } ] } } }, { "id": 894, "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 438, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L438" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 914, "name": "identities", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 458, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L458" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 861, "name": "UserIdentity", "package": "@supabase/auth-js" } } }, { "id": 903, "name": "invited_at", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 447, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L447" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 915, "name": "is_anonymous", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 459, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L459" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 916, "name": "is_sso_user", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 460, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L460" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 911, "name": "last_sign_in_at", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 455, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L455" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 901, "name": "new_email", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 445, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L445" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 902, "name": "new_phone", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 446, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L446" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 906, "name": "phone", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 450, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L450" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 910, "name": "phone_confirmed_at", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 454, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L454" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 899, "name": "recovery_sent_at", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 443, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L443" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 912, "name": "role", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 456, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L456" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 913, "name": "updated_at", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 457, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L457" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 896, "name": "user_metadata", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 440, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L440" } ], "type": { "type": "reference", "target": 890, "name": "UserMetadata", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [ 904, 895, 897, 919, 898, 908, 907, 918, 905, 900, 909, 917, 894, 914, 903, 915, 916, 911, 901, 902, 906, 910, 899, 912, 913, 896 ] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 437, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L437" } ] }, { "id": 885, "name": "UserAppMetadata", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 886, "name": "provider", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The first provider that the user used to sign up with." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 425, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L425" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 887, "name": "providers", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A list of all providers that the user has linked to their account." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 429, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L429" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } ], "groups": [ { "title": "Properties", "children": [886, 887] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 421, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L421" } ], "indexSignatures": [ { "id": 888, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 430, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L430" } ], "parameters": [ { "id": 889, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } ] }, { "id": 920, "name": "UserAttributes", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 921, "name": "current_password", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The user's current password\n\nThis is only ever present when the user is resetting\ntheir password and GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD is true." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 474, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L474" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 926, "name": "data", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A custom data object to store the user's metadata. This maps to the " }, { "kind": "code", "text": "`auth.users.raw_user_meta_data`" }, { "kind": "text", "text": " column.\n\nThe " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " should be a JSON object that includes user-specific info, such as their first and last name." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 504, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L504" } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 922, "name": "email", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The user's email." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 479, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L479" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 925, "name": "nonce", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The nonce sent for reauthentication if the user's password is to be updated.\n\nCall reauthenticate() to obtain the nonce first." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 496, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L496" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 924, "name": "password", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The user's password." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 489, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L489" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 923, "name": "phone", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The user's phone." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 484, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L484" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [921, 926, 922, 925, 924, 923] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 466, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L466" } ] }, { "id": 861, "name": "UserIdentity", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 870, "name": "created_at", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 370, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L370" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 862, "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 363, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L363" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 864, "name": "identity_data", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 365, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L365" } ], "type": { "type": "reflection", "declaration": { "id": 865, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 365, "character": 18, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L365" } ], "indexSignatures": [ { "id": 866, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 366, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L366" } ], "parameters": [ { "id": 867, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } ] } } }, { "id": 868, "name": "identity_id", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 368, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L368" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 871, "name": "last_sign_in_at", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 371, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L371" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 869, "name": "provider", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 369, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L369" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 872, "name": "updated_at", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 372, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L372" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 863, "name": "user_id", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 364, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L364" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [870, 862, 864, 868, 871, 869, 872, 863] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 362, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L362" } ] }, { "id": 890, "name": "UserMetadata", "variant": "declaration", "kind": 256, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 433, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L433" } ], "indexSignatures": [ { "id": 891, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 434, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L434" } ], "parameters": [ { "id": 892, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } ] }, { "id": 1071, "name": "VerifyEmailOtpParams", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 1072, "name": "email", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The user's email address." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 811, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L811" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1075, "name": "options", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 816, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L816" } ], "type": { "type": "reflection", "declaration": { "id": 1076, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1078, "name": "captchaToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Verification token received when the user completes the captcha on the site." } ], "blockTags": [ { "tag": "@deprecated", "content": [] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 824, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L824" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1077, "name": "redirectTo", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A URL to send the user to after they are confirmed." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 818, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L818" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1078, 1077] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 816, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L816" } ] } } }, { "id": 1073, "name": "token", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The otp sent to the user's email address." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 813, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L813" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1074, "name": "type", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The user's verification type." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 815, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L815" } ], "type": { "type": "reference", "target": 1083, "name": "EmailOtpType", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [1072, 1075, 1073, 1074] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 809, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L809" } ] }, { "id": 1063, "name": "VerifyMobileOtpParams", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 1067, "name": "options", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 797, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L797" } ], "type": { "type": "reflection", "declaration": { "id": 1068, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1070, "name": "captchaToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Verification token received when the user completes the captcha on the site." } ], "blockTags": [ { "tag": "@deprecated", "content": [] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 806, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L806" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1069, "name": "redirectTo", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A URL to send the user to after they are confirmed." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 799, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L799" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1070, 1069] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 797, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L797" } ] } } }, { "id": 1064, "name": "phone", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The user's phone number." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 792, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L792" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1065, "name": "token", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The otp sent to the user's phone number." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 794, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L794" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1066, "name": "type", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The user's verification type." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 796, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L796" } ], "type": { "type": "reference", "target": 1082, "name": "MobileOtpType", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [1067, 1064, 1065, 1066] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 790, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L790" } ] }, { "id": 1079, "name": "VerifyTokenHashParams", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 1080, "name": "token_hash", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The token hash used in an email link" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 830, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L830" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1081, "name": "type", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The user's verification type." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 833, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L833" } ], "type": { "type": "reference", "target": 1083, "name": "EmailOtpType", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [1080, 1081] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 828, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L828" } ] }, { "id": 856, "name": "AMRMethod", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 337, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L337" } ], "type": { "type": "union", "types": [ { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "number" }, "objectType": { "type": "query", "queryType": { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AMRMethods" }, "name": "AMRMethods", "package": "@supabase/auth-js", "preferValues": true } } }, { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reflection", "declaration": { "id": 857, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 337, "character": 64, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L337" } ] } } ] } ] } }, { "id": 736, "name": "AuthChangeEvent", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 48, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L48" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "INITIAL_SESSION" }, { "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": "reference", "target": 735, "name": "AuthChangeEventMFA", "package": "@supabase/auth-js" } ] } }, { "id": 735, "name": "AuthChangeEventMFA", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 46, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L46" } ], "type": { "type": "literal", "value": "MFA_CHALLENGE_VERIFIED" } }, { "id": 1192, "name": "AuthenticatorAssuranceLevels", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1222, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1222" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "aal1" }, { "type": "literal", "value": "aal2" } ] } }, { "id": 987, "name": "AuthFlowType", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 671, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L671" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "implicit" }, { "type": "literal", "value": "pkce" } ] } }, { "id": 1319, "name": "AuthMFAAdminDeleteFactorParams", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@expermental", "content": [] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1681, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1681" } ], "type": { "type": "reflection", "declaration": { "id": 1320, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1321, "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ID of the MFA factor to delete." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1683, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1683" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1322, "name": "userId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ID of the user whose factor is being deleted." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1686, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1686" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1321, 1322] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1681, "character": 45, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1681" } ] } } }, { "id": 1316, "name": "AuthMFAAdminDeleteFactorResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@expermental", "content": [] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1674, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1674" } ], "type": { "type": "reference", "target": 788, "typeArguments": [ { "type": "reflection", "declaration": { "id": 1317, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1318, "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ID of the factor that was successfully deleted." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1676, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1676" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1318] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1674, "character": 61, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1674" } ] } } ], "name": "RequestResult", "package": "@supabase/auth-js" } }, { "id": 1326, "name": "AuthMFAAdminListFactorsParams", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@expermental", "content": [] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1700, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1700" } ], "type": { "type": "reflection", "declaration": { "id": 1327, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1328, "name": "userId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ID of the user." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1702, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1702" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1328] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1700, "character": 44, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1700" } ] } } }, { "id": 1323, "name": "AuthMFAAdminListFactorsResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@expermental", "content": [] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1692, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1692" } ], "type": { "type": "reference", "target": 788, "typeArguments": [ { "type": "reflection", "declaration": { "id": 1324, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1325, "name": "factors", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "All factors attached to the user." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1694, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1694" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 874, "name": "Factor", "package": "@supabase/auth-js" } } } ], "groups": [ { "title": "Properties", "children": [1325] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1692, "character": 60, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1692" } ] } } ], "name": "RequestResult", "package": "@supabase/auth-js" } }, { "id": 1183, "name": "AuthMFAChallengePhoneResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1152, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1152" } ], "type": { "type": "reference", "target": 788, "typeArguments": [ { "type": "reference", "target": 783, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAChallengeResponseBase" }, "typeArguments": [ { "type": "literal", "value": "phone" } ], "name": "AuthMFAChallengeResponseBase", "package": "@supabase/auth-js" }, { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAChallengePhoneResponseFields" }, "name": "AuthMFAChallengePhoneResponseFields", "package": "@supabase/auth-js" } ] } ], "name": "Prettify", "package": "@supabase/auth-js" } ], "name": "RequestResult", "package": "@supabase/auth-js" } }, { "id": 1187, "name": "AuthMFAChallengeResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1204, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1204" } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 1182, "name": "AuthMFAChallengeTOTPResponse", "package": "@supabase/auth-js" }, { "type": "reference", "target": 1183, "name": "AuthMFAChallengePhoneResponse", "package": "@supabase/auth-js" }, { "type": "reference", "target": 1184, "name": "AuthMFAChallengeWebauthnResponse", "package": "@supabase/auth-js" } ] } }, { "id": 1182, "name": "AuthMFAChallengeTOTPResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1144, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1144" } ], "type": { "type": "reference", "target": 788, "typeArguments": [ { "type": "reference", "target": 783, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAChallengeResponseBase" }, "typeArguments": [ { "type": "literal", "value": "totp" } ], "name": "AuthMFAChallengeResponseBase", "package": "@supabase/auth-js" }, { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAChallengeTOTPResponseFields" }, "name": "AuthMFAChallengeTOTPResponseFields", "package": "@supabase/auth-js" } ] } ], "name": "Prettify", "package": "@supabase/auth-js" } ], "name": "RequestResult", "package": "@supabase/auth-js" } }, { "id": 1184, "name": "AuthMFAChallengeWebauthnResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Response type for WebAuthn MFA challenge.\nContains credential creation or request options from the server." } ], "blockTags": [ { "tag": "@see", "content": [ { "kind": "inline-tag", "tag": "@link", "text": "W3C WebAuthn Spec - Credential Creation", "target": "https://w3c.github.io/webauthn/#sctn-credential-creation" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1173, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1173" } ], "type": { "type": "reference", "target": 788, "typeArguments": [ { "type": "reference", "target": 783, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAChallengeResponseBase" }, "typeArguments": [ { "type": "literal", "value": "webauthn" } ], "name": "AuthMFAChallengeResponseBase", "package": "@supabase/auth-js" }, { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAChallengeWebauthnResponseFields" }, "name": "AuthMFAChallengeWebauthnResponseFields", "package": "@supabase/auth-js" } ] } ], "name": "Prettify", "package": "@supabase/auth-js" } ], "name": "RequestResult", "package": "@supabase/auth-js" } }, { "id": 1185, "name": "AuthMFAChallengeWebauthnResponseDataJSON", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "JSON-serializable version of WebAuthn challenge response.\nUsed for server communication with base64url-encoded binary fields." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1193, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1193" } ], "type": { "type": "reference", "target": 783, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAChallengeResponseBase" }, "typeArguments": [ { "type": "literal", "value": "webauthn" } ], "name": "AuthMFAChallengeResponseBase", "package": "@supabase/auth-js" }, { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAChallengeWebauthnResponseFieldsJSON" }, "name": "AuthMFAChallengeWebauthnResponseFieldsJSON", "package": "@supabase/auth-js" } ] } ], "name": "Prettify", "package": "@supabase/auth-js" } }, { "id": 1186, "name": "AuthMFAChallengeWebauthnServerResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Server response type for WebAuthn MFA challenge.\nContains JSON-formatted WebAuthn options ready for browser API." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1201, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1201" } ], "type": { "type": "reference", "target": 788, "typeArguments": [ { "type": "reference", "target": 1185, "name": "AuthMFAChallengeWebauthnResponseDataJSON", "package": "@supabase/auth-js" } ], "name": "RequestResult", "package": "@supabase/auth-js" } }, { "id": 1361, "name": "AuthMFAEnrollPhoneResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1902, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1902" } ], "type": { "type": "reference", "target": 788, "typeArguments": [ { "type": "reference", "target": 783, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAEnrollResponseBase" }, "typeArguments": [ { "type": "literal", "value": "phone" } ], "name": "AuthMFAEnrollResponseBase", "package": "@supabase/auth-js" }, { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAEnrollPhoneResponseFields" }, "name": "AuthMFAEnrollPhoneResponseFields", "package": "@supabase/auth-js" } ] } ], "name": "Prettify", "package": "@supabase/auth-js" } ], "name": "RequestResult", "package": "@supabase/auth-js" } }, { "id": 1178, "name": "AuthMFAEnrollResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1119, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1119" } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 1360, "name": "AuthMFAEnrollTOTPResponse", "package": "@supabase/auth-js" }, { "type": "reference", "target": 1361, "name": "AuthMFAEnrollPhoneResponse", "package": "@supabase/auth-js" }, { "type": "reference", "target": 1362, "name": "AuthMFAEnrollWebauthnResponse", "package": "@supabase/auth-js" } ] } }, { "id": 1360, "name": "AuthMFAEnrollTOTPResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1893, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1893" } ], "type": { "type": "reference", "target": 788, "typeArguments": [ { "type": "reference", "target": 783, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAEnrollResponseBase" }, "typeArguments": [ { "type": "literal", "value": "totp" } ], "name": "AuthMFAEnrollResponseBase", "package": "@supabase/auth-js" }, { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAEnrollTOTPResponseFields" }, "name": "AuthMFAEnrollTOTPResponseFields", "package": "@supabase/auth-js" } ] } ], "name": "Prettify", "package": "@supabase/auth-js" } ], "name": "RequestResult", "package": "@supabase/auth-js" } }, { "id": 1362, "name": "AuthMFAEnrollWebauthnResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Response type for WebAuthn factor enrollment.\nReturns the enrolled factor ID and metadata." } ], "blockTags": [ { "tag": "@see", "content": [ { "kind": "inline-tag", "tag": "@link", "text": "W3C WebAuthn Spec - Registering a New Credential", "target": "https://w3c.github.io/webauthn/#sctn-registering-a-new-credential" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1915, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1915" } ], "type": { "type": "reference", "target": 788, "typeArguments": [ { "type": "reference", "target": 783, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAEnrollResponseBase" }, "typeArguments": [ { "type": "literal", "value": "webauthn" } ], "name": "AuthMFAEnrollResponseBase", "package": "@supabase/auth-js" }, { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAEnrollWebauthnFields" }, "name": "AuthMFAEnrollWebauthnFields", "package": "@supabase/auth-js" } ] } ], "name": "Prettify", "package": "@supabase/auth-js" } ], "name": "RequestResult", "package": "@supabase/auth-js" } }, { "id": 1193, "name": "AuthMFAGetAuthenticatorAssuranceLevelResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1224, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1224" } ], "type": { "type": "reference", "target": 788, "typeArguments": [ { "type": "reflection", "declaration": { "id": 1194, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1197, "name": "currentAuthenticationMethods", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "A list of all authentication methods attached to this session. Use\nthe information here to detect the last time a user verified a\nfactor, for example if implementing a step-up scenario.\n\nSupports both RFC-8176 compliant format (string[]) and detailed format (AMREntry[]).\n- String format: ['password', 'otp'] - RFC-8176 compliant\n- Object format: [{ method: 'password', timestamp: 1234567890 }] - includes timestamps" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1245, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1245" } ], "type": { "type": "union", "types": [ { "type": "array", "elementType": { "type": "reference", "target": 858, "name": "AMREntry", "package": "@supabase/auth-js" } }, { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } ] } }, { "id": 1195, "name": "currentLevel", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Current AAL level of the session." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1226, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1226" } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 1192, "name": "AuthenticatorAssuranceLevels", "package": "@supabase/auth-js" }, { "type": "literal", "value": null } ] } }, { "id": 1196, "name": "nextLevel", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Next possible AAL level for the session. If the next level is higher\nthan the current one, the user should go through MFA." } ], "blockTags": [ { "tag": "@see", "content": [ { "kind": "inline-tag", "tag": "@link", "text": "GoTrueMFAApi#challenge", "target": 1219 } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1234, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1234" } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 1192, "name": "AuthenticatorAssuranceLevels", "package": "@supabase/auth-js" }, { "type": "literal", "value": null } ] } } ], "groups": [ { "title": "Properties", "children": [1197, 1195, 1196] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1224, "character": 74, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1224" } ] } } ], "name": "RequestResult", "package": "@supabase/auth-js" } }, { "id": 1188, "name": "AuthMFAListFactorsResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "response of ListFactors, which should contain all the types of factors that are available, this ensures we always include all" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1210, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1210" } ], "typeParameters": [ { "id": 1191, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "query", "queryType": { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FactorTypes" }, "name": "FactorTypes", "package": "@supabase/auth-js", "preferValues": true } }, "default": { "type": "query", "queryType": { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FactorTypes" }, "name": "FactorTypes", "package": "@supabase/auth-js", "preferValues": true } } } ], "type": { "type": "reference", "target": 788, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reflection", "declaration": { "id": 1189, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1190, "name": "all", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "All available factors (verified and unverified)." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1214, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1214" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 783, "typeArguments": [ { "type": "reference", "target": 874, "name": "Factor", "package": "@supabase/auth-js" } ], "name": "Prettify", "package": "@supabase/auth-js" } } } ], "groups": [ { "title": "Properties", "children": [1190] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1212, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1212" } ] } }, { "type": "mapped", "parameter": "K", "parameterType": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "number" }, "objectType": { "type": "reference", "target": 1191, "name": "T", "package": "@supabase/auth-js", "refersToTypeParameter": true } }, "templateType": { "type": "array", "elementType": { "type": "reference", "target": 783, "typeArguments": [ { "type": "reference", "target": 874, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "K" }, "name": "K", "package": "@supabase/auth-js", "refersToTypeParameter": true }, { "type": "literal", "value": "verified" } ], "name": "Factor", "package": "@supabase/auth-js" } ], "name": "Prettify", "package": "@supabase/auth-js" } } } ] } ], "name": "RequestResult", "package": "@supabase/auth-js" } }, { "id": 1179, "name": "AuthMFAUnenrollResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1124, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1124" } ], "type": { "type": "reference", "target": 788, "typeArguments": [ { "type": "reflection", "declaration": { "id": 1180, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1181, "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ID of the factor that was successfully unenrolled." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1126, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1126" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1181] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1124, "character": 52, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1124" } ] } } ], "name": "RequestResult", "package": "@supabase/auth-js" } }, { "id": 1177, "name": "AuthMFAVerifyResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Response type for MFA verification operations.\nReturns session tokens on successful verification." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1117, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1117" } ], "type": { "type": "reference", "target": 788, "typeArguments": [ { "type": "reference", "target": 1170, "name": "AuthMFAVerifyResponseData", "package": "@supabase/auth-js" } ], "name": "RequestResult", "package": "@supabase/auth-js" } }, { "id": 1170, "name": "AuthMFAVerifyResponseData", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Data returned after successful MFA verification.\nContains new session tokens and updated user information." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1096, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1096" } ], "type": { "type": "reflection", "declaration": { "id": 1171, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1172, "name": "access_token", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "New access token (JWT) after successful verification." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1098, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1098" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1174, "name": "expires_in", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Number of seconds in which the access token will expire." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1104, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1104" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1175, "name": "refresh_token", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Refresh token you can use to obtain new access tokens when expired." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1107, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1107" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1173, "name": "token_type", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Type of token, always " }, { "kind": "code", "text": "`bearer`" }, { "kind": "text", "text": "." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1101, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1101" } ], "type": { "type": "literal", "value": "bearer" } }, { "id": 1176, "name": "user", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Updated user profile." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1110, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1110" } ], "type": { "type": "reference", "target": 893, "name": "User", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [1172, 1174, 1175, 1173, 1176] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1096, "character": 40, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1096" } ] } } }, { "id": 1612, "name": "AuthOAuthAuthorizationDetailsResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Response type for getting OAuth authorization details.\nReturns either full authorization details (if consent needed) or redirect URL (if already consented).\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```typescript\nconst { data, error } = await supabase.auth.oauth.getAuthorizationDetails(authorizationId)\n\nif (error) {\n console.error('Error:', error)\n} else if ('authorization_id' in data) {\n // User needs to provide consent - show consent page\n console.log('Client:', data.client.name)\n console.log('Scopes:', data.scope)\n console.log('Redirect URI:', data.redirect_uri)\n} else {\n // User already consented - redirect immediately\n window.location.href = data.redirect_url\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2509, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2509" } ], "type": { "type": "reference", "target": 788, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "target": 1599, "name": "OAuthAuthorizationDetails", "package": "@supabase/auth-js" }, { "type": "reference", "target": 1609, "name": "OAuthRedirect", "package": "@supabase/auth-js" } ] } ], "name": "RequestResult", "package": "@supabase/auth-js" } }, { "id": 1613, "name": "AuthOAuthConsentResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Response type for OAuth consent decision (approve/deny).\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2517, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2517" } ], "type": { "type": "reference", "target": 788, "typeArguments": [ { "type": "reference", "target": 1609, "name": "OAuthRedirect", "package": "@supabase/auth-js" } ], "name": "RequestResult", "package": "@supabase/auth-js" } }, { "id": 1619, "name": "AuthOAuthGrantsResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Response type for listing user's OAuth grants.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2536, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2536" } ], "type": { "type": "reference", "target": 788, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "target": 1614, "name": "OAuthGrant", "package": "@supabase/auth-js" } } ], "name": "RequestResult", "package": "@supabase/auth-js" } }, { "id": 1620, "name": "AuthOAuthRevokeGrantResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Response type for revoking an OAuth grant.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2542, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2542" } ], "type": { "type": "reference", "target": 788, "typeArguments": [ { "type": "reflection", "declaration": { "id": 1621, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2542, "character": 57, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2542" } ] } } ], "name": "RequestResult", "package": "@supabase/auth-js" } }, { "id": 814, "name": "AuthOtpResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "AuthOtpResponse is returned when OTP is used.\n\n" }, { "kind": "inline-tag", "tag": "@see", "text": "AuthResponse" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 240, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L240" } ], "type": { "type": "reference", "target": 797, "typeArguments": [ { "type": "reflection", "declaration": { "id": 815, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 818, "name": "messageId", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 243, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L243" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "literal", "value": null } ] } }, { "id": 817, "name": "session", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 242, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L242" } ], "type": { "type": "literal", "value": null } }, { "id": 816, "name": "user", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 241, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L241" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [818, 817, 816] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 240, "character": 59, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L240" } ] } } ], "name": "RequestResultSafeDestructure", "package": "@supabase/auth-js" } }, { "id": 805, "name": "AuthResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 224, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L224" } ], "type": { "type": "reference", "target": 797, "typeArguments": [ { "type": "reflection", "declaration": { "id": 806, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 808, "name": "session", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 226, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L226" } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 847, "name": "Session", "package": "@supabase/auth-js" }, { "type": "literal", "value": null } ] } }, { "id": 807, "name": "user", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 225, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L225" } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 893, "name": "User", "package": "@supabase/auth-js" }, { "type": "literal", "value": null } ] } } ], "groups": [ { "title": "Properties", "children": [808, 807] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 224, "character": 56, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L224" } ] } } ], "name": "RequestResultSafeDestructure", "package": "@supabase/auth-js" } }, { "id": 809, "name": "AuthResponsePassword", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 229, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L229" } ], "type": { "type": "reference", "target": 797, "typeArguments": [ { "type": "reflection", "declaration": { "id": 810, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 812, "name": "session", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 231, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L231" } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 847, "name": "Session", "package": "@supabase/auth-js" }, { "type": "literal", "value": null } ] } }, { "id": 811, "name": "user", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 230, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L230" } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 893, "name": "User", "package": "@supabase/auth-js" }, { "type": "literal", "value": null } ] } }, { "id": 813, "name": "weak_password", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 232, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L232" } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 779, "name": "WeakPassword", "package": "@supabase/auth-js" }, { "type": "literal", "value": null } ] } } ], "groups": [ { "title": "Properties", "children": [812, 811, 813] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 229, "character": 64, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L229" } ] } } ], "name": "RequestResultSafeDestructure", "package": "@supabase/auth-js" } }, { "id": 819, "name": "AuthTokenResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 246, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L246" } ], "type": { "type": "reference", "target": 797, "typeArguments": [ { "type": "reflection", "declaration": { "id": 820, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 822, "name": "session", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 248, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L248" } ], "type": { "type": "reference", "target": 847, "name": "Session", "package": "@supabase/auth-js" } }, { "id": 821, "name": "user", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 247, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L247" } ], "type": { "type": "reference", "target": 893, "name": "User", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [822, 821] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 246, "character": 61, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L246" } ] } } ], "name": "RequestResultSafeDestructure", "package": "@supabase/auth-js" } }, { "id": 823, "name": "AuthTokenResponsePassword", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 251, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L251" } ], "type": { "type": "reference", "target": 797, "typeArguments": [ { "type": "reflection", "declaration": { "id": 824, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 826, "name": "session", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 253, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L253" } ], "type": { "type": "reference", "target": 847, "name": "Session", "package": "@supabase/auth-js" } }, { "id": 825, "name": "user", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 252, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L252" } ], "type": { "type": "reference", "target": 893, "name": "User", "package": "@supabase/auth-js" } }, { "id": 827, "name": "weakPassword", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 254, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L254" } ], "type": { "type": "reference", "target": 779, "name": "WeakPassword", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [826, 825, 827] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 251, "character": 69, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L251" } ] } } ], "name": "RequestResultSafeDestructure", "package": "@supabase/auth-js" } }, { "id": 1342, "name": "CallRefreshTokenResult", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1798, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1798" } ], "type": { "type": "reference", "target": 788, "typeArguments": [ { "type": "reference", "target": 847, "name": "Session", "package": "@supabase/auth-js" } ], "name": "RequestResult", "package": "@supabase/auth-js" } }, { "id": 1518, "name": "CreateCustomProviderParams", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Parameters for creating a new custom provider." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2262, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2262" } ], "type": { "type": "reflection", "declaration": { "id": 1519, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1525, "name": "acceptable_client_ids", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Additional client IDs accepted during token validation" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2274, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2274" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 1528, "name": "attribute_mapping", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Mapping of provider attributes to Supabase user attributes" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2280, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2280" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } }, { "id": 1529, "name": "authorization_params", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Additional parameters sent with the authorization request" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2282, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2282" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "name": "Record", "package": "typescript" } }, { "id": 1535, "name": "authorization_url", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "OAuth2 authorization URL" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2294, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2294" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1523, "name": "client_id", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "OAuth client ID" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2270, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2270" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1524, "name": "client_secret", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "OAuth client secret (write-only, not returned in responses)" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2272, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2272" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1533, "name": "discovery_url", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "OIDC discovery URL" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2290, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2290" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1531, "name": "email_optional", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether email is optional for this provider" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2286, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2286" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1530, "name": "enabled", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the provider is enabled" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2284, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2284" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1521, "name": "identifier", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Provider identifier (e.g. " }, { "kind": "code", "text": "`custom:mycompany`" }, { "kind": "text", "text": ")" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2266, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2266" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1532, "name": "issuer", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "OIDC issuer URL" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2288, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2288" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1538, "name": "jwks_uri", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "JWKS URI for token verification" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2300, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2300" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1522, "name": "name", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Human-readable name" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2268, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2268" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1527, "name": "pkce_enabled", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether PKCE is enabled" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2278, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2278" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1520, "name": "provider_type", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Provider type" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2264, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2264" } ], "type": { "type": "reference", "target": 1481, "name": "CustomProviderType", "package": "@supabase/auth-js" } }, { "id": 1526, "name": "scopes", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "OAuth scopes requested during authorization" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2276, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2276" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 1534, "name": "skip_nonce_check", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether to skip nonce check (OIDC)" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2292, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2292" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1536, "name": "token_url", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "OAuth2 token URL" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2296, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2296" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1537, "name": "userinfo_url", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "OAuth2 userinfo URL" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2298, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2298" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 1525, 1528, 1529, 1535, 1523, 1524, 1533, 1531, 1530, 1521, 1532, 1538, 1522, 1527, 1520, 1526, 1534, 1536, 1537 ] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2262, "character": 41, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2262" } ] } } }, { "id": 1428, "name": "CreateOAuthClientParams", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Parameters for creating a new OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2053, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2053" } ], "type": { "type": "reflection", "declaration": { "id": 1429, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1430, "name": "client_name", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Human-readable name of the OAuth client" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2055, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2055" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1431, "name": "client_uri", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "URI of the OAuth client" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2057, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2057" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1433, "name": "grant_types", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Array of allowed grant types (optional, defaults to authorization_code and refresh_token)" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2061, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2061" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 1407, "name": "OAuthClientGrantType", "package": "@supabase/auth-js" } } }, { "id": 1432, "name": "redirect_uris", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Array of allowed redirect URIs" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2059, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2059" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 1434, "name": "response_types", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Array of allowed response types (optional, defaults to code)" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2063, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2063" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 1408, "name": "OAuthClientResponseType", "package": "@supabase/auth-js" } } }, { "id": 1435, "name": "scope", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Scope of the OAuth client" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2065, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2065" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1436, "name": "token_endpoint_auth_method", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Token endpoint authentication method (defaults to server default if not specified)" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2067, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2067" } ], "type": { "type": "reference", "target": 1411, "name": "OAuthClientTokenEndpointAuthMethod", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [1430, 1431, 1433, 1432, 1434, 1435, 1436] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2053, "character": 38, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2053" } ] } } }, { "id": 1494, "name": "CustomOAuthProvider", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Custom OAuth/OIDC provider object returned from the admin API." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2212, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2212" } ], "type": { "type": "reflection", "declaration": { "id": 1495, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1501, "name": "acceptable_client_ids", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Additional client IDs accepted during token validation" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2224, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2224" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 1504, "name": "attribute_mapping", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Mapping of provider attributes to Supabase user attributes" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2230, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2230" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } }, { "id": 1505, "name": "authorization_params", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Additional parameters sent with the authorization request" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2232, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2232" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "name": "Record", "package": "typescript" } }, { "id": 1511, "name": "authorization_url", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "OAuth2 authorization URL" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2244, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2244" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1500, "name": "client_id", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "OAuth client ID" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2222, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2222" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1516, "name": "created_at", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Timestamp when the provider was created" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2254, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2254" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1515, "name": "discovery_document", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "OIDC discovery document (OIDC providers only)" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2252, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2252" } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 1482, "name": "OIDCDiscoveryDocument", "package": "@supabase/auth-js" }, { "type": "literal", "value": null } ] } }, { "id": 1509, "name": "discovery_url", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "OIDC discovery URL" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2240, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2240" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1507, "name": "email_optional", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether email is optional for this provider" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2236, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2236" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1506, "name": "enabled", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the provider is enabled" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2234, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2234" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1496, "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Unique identifier (UUID)" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2214, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2214" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1498, "name": "identifier", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Provider identifier (e.g. " }, { "kind": "code", "text": "`custom:mycompany`" }, { "kind": "text", "text": ")" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2218, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2218" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1508, "name": "issuer", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "OIDC issuer URL" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2238, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2238" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1514, "name": "jwks_uri", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "JWKS URI for token verification" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2250, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2250" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1499, "name": "name", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Human-readable name" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2220, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2220" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1503, "name": "pkce_enabled", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether PKCE is enabled" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2228, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2228" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1497, "name": "provider_type", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Provider type" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2216, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2216" } ], "type": { "type": "reference", "target": 1481, "name": "CustomProviderType", "package": "@supabase/auth-js" } }, { "id": 1502, "name": "scopes", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "OAuth scopes requested during authorization" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2226, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2226" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 1510, "name": "skip_nonce_check", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether to skip nonce check (OIDC)" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2242, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2242" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1512, "name": "token_url", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "OAuth2 token URL" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2246, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2246" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1517, "name": "updated_at", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Timestamp when the provider was last updated" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2256, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2256" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1513, "name": "userinfo_url", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "OAuth2 userinfo URL" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2248, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2248" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 1501, 1504, 1505, 1511, 1500, 1516, 1515, 1509, 1507, 1506, 1496, 1498, 1508, 1514, 1499, 1503, 1497, 1502, 1510, 1512, 1517, 1513 ] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2212, "character": 34, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2212" } ] } } }, { "id": 1562, "name": "CustomProviderListResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Response type for listing custom providers." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2361, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2361" } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 1563, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1564, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2363, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2363" } ], "type": { "type": "reflection", "declaration": { "id": 1565, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1566, "name": "providers", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2363, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2363" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 1494, "name": "CustomOAuthProvider", "package": "@supabase/auth-js" } } } ], "groups": [ { "title": "Properties", "children": [1566] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2363, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2363" } ] } } }, { "id": 1567, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2364, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2364" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [1564, 1567] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2362, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2362" } ] } }, { "type": "reflection", "declaration": { "id": 1568, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1569, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2367, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2367" } ], "type": { "type": "reflection", "declaration": { "id": 1570, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1571, "name": "providers", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2367, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2367" } ], "type": { "type": "tuple" } } ], "groups": [ { "title": "Properties", "children": [1571] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2367, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2367" } ] } } }, { "id": 1572, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2368, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2368" } ], "type": { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [1569, 1572] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2366, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2366" } ] } } ] } }, { "id": 1561, "name": "CustomProviderResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Response type for custom provider operations." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2356, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2356" } ], "type": { "type": "reference", "target": 788, "typeArguments": [ { "type": "reference", "target": 1494, "name": "CustomOAuthProvider", "package": "@supabase/auth-js" } ], "name": "RequestResult", "package": "@supabase/auth-js" } }, { "id": 1481, "name": "CustomProviderType", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Type of custom identity provider." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2179, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2179" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "oauth2" }, { "type": "literal", "value": "oidc" } ] } }, { "id": 1083, "name": "EmailOtpType", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 837, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L837" } ], "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" }, { "type": "literal", "value": "email" } ] } }, { "id": 1043, "name": "EthereumWallet", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 748, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L748" } ], "type": { "type": "reference", "target": { "sourceFileName": "src/lib/web3/ethereum.ts", "qualifiedName": "EIP1193Provider" }, "name": "EIP1193Provider", "package": "@supabase/auth-js" } }, { "id": 1044, "name": "EthereumWeb3Credentials", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 750, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L750" } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 1045, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1046, "name": "chain", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 752, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L752" } ], "type": { "type": "literal", "value": "ethereum" } }, { "id": 1049, "name": "options", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 760, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L760" } ], "type": { "type": "reflection", "declaration": { "id": 1050, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1052, "name": "captchaToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Verification token received when the user completes the captcha on the site." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 765, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L765" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1053, "name": "signInWithEthereum", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 767, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L767" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Partial" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Omit" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "src/lib/web3/ethereum.ts", "qualifiedName": "EthereumSignInInput" }, "name": "EthereumSignInInput", "package": "@supabase/auth-js" }, { "type": "union", "types": [ { "type": "literal", "value": "version" }, { "type": "literal", "value": "domain" }, { "type": "literal", "value": "uri" }, { "type": "literal", "value": "statement" } ] } ], "name": "Omit", "package": "typescript" } ], "name": "Partial", "package": "typescript" } }, { "id": 1051, "name": "url", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 762, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L762" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1052, 1053, 1051] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 760, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L760" } ] } } }, { "id": 1048, "name": "statement", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional statement to include in the Sign in with Ethereum message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 758, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L758" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1047, "name": "wallet", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Wallet interface to use. If not specified will default to " }, { "kind": "code", "text": "`window.ethereum`" }, { "kind": "text", "text": "." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 755, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L755" } ], "type": { "type": "reference", "target": 1043, "name": "EthereumWallet", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [1046, 1049, 1048, 1047] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 751, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L751" } ] } }, { "type": "reflection", "declaration": { "id": 1054, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1055, "name": "chain", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 773, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L773" } ], "type": { "type": "literal", "value": "ethereum" } }, { "id": 1056, "name": "message", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Sign in with Ethereum compatible message. Must include " }, { "kind": "code", "text": "`Issued At`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`URI`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`Version`" }, { "kind": "text", "text": "." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 776, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L776" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1058, "name": "options", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 781, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L781" } ], "type": { "type": "reflection", "declaration": { "id": 1059, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1060, "name": "captchaToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Verification token received when the user completes the captcha on the site." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 783, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L783" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1060] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 781, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L781" } ] } } }, { "id": 1057, "name": "signature", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Ethereum curve (secp256k1) signature of the message." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 779, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L779" } ], "type": { "type": "reference", "target": { "sourceFileName": "src/lib/web3/ethereum.ts", "qualifiedName": "Hex" }, "name": "Hex", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [1055, 1056, 1058, 1057] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 772, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L772" } ] } } ] } }, { "id": 874, "name": "Factor", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "A MFA factor." } ], "blockTags": [ { "tag": "@see", "content": [ { "kind": "text", "text": " - " }, { "kind": "inline-tag", "tag": "@link", "text": "GoTrueMFAApi#enroll", "target": 1199 }, { "kind": "text", "text": "\n" }, { "kind": "text", "text": " - " }, { "kind": "inline-tag", "tag": "@link", "text": "GoTrueMFAApi#listFactors", "target": 1310 }, { "kind": "text", "text": "\n" }, { "kind": "text", "text": " - " }, { "kind": "inline-tag", "tag": "@link", "text": "GoTrueMFAAdminApi#listFactors" }, { "kind": "text", "text": "\n" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 396, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L396" } ], "typeParameters": [ { "id": 883, "name": "Type", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": 873, "name": "FactorType", "package": "@supabase/auth-js" }, "default": { "type": "reference", "target": 873, "name": "FactorType", "package": "@supabase/auth-js" } }, { "id": 884, "name": "Status", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FactorVerificationStatus" }, "name": "FactorVerificationStatus", "package": "@supabase/auth-js" }, "default": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "number" }, "objectType": { "type": "query", "queryType": { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FactorVerificationStatuses" }, "name": "FactorVerificationStatuses", "package": "@supabase/auth-js", "preferValues": true } } } } ], "type": { "type": "reflection", "declaration": { "id": 875, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 880, "name": "created_at", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 416, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L416" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 878, "name": "factor_type", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Type of factor. " }, { "kind": "code", "text": "`totp`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`phone`" }, { "kind": "text", "text": " supported with this version" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 409, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L409" } ], "type": { "type": "reference", "target": 883, "name": "Type", "package": "@supabase/auth-js", "refersToTypeParameter": true } }, { "id": 877, "name": "friendly_name", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Friendly name of the factor, useful to disambiguate between multiple factors." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 404, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L404" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 876, "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ID of the factor." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 401, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L401" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 882, "name": "last_challenged_at", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 418, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L418" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 879, "name": "status", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The verification status of the factor, default is " }, { "kind": "code", "text": "`unverified`" }, { "kind": "text", "text": " after " }, { "kind": "code", "text": "`.enroll()`" }, { "kind": "text", "text": ", then " }, { "kind": "code", "text": "`verified`" }, { "kind": "text", "text": " after the user verifies it with " }, { "kind": "code", "text": "`.verify()`" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 414, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L414" } ], "type": { "type": "reference", "target": 884, "name": "Status", "package": "@supabase/auth-js", "refersToTypeParameter": true } }, { "id": 881, "name": "updated_at", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 417, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L417" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [880, 878, 877, 876, 882, 879, 881] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 399, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L399" } ] } } }, { "id": 873, "name": "FactorType", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Type of factor. " }, { "kind": "code", "text": "`totp`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`phone`" }, { "kind": "text", "text": " supported with this version" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 380, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L380" } ], "type": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "number" }, "objectType": { "type": "query", "queryType": { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FactorTypes" }, "name": "FactorTypes", "package": "@supabase/auth-js", "preferValues": true } } } }, { "id": 1129, "name": "GenerateEmailChangeLinkParams", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 916, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L916" } ], "type": { "type": "reflection", "declaration": { "id": 1130, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1132, "name": "email", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The user's email" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 919, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L919" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1133, "name": "newEmail", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The user's new email. Only required if type is 'email_change_current' or 'email_change_new'." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 923, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L923" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1134, "name": "options", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 924, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L924" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Pick" }, "typeArguments": [ { "type": "reference", "target": 1135, "name": "GenerateLinkOptions", "package": "@supabase/auth-js" }, { "type": "literal", "value": "redirectTo" } ], "name": "Pick", "package": "typescript" } }, { "id": 1131, "name": "type", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 917, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L917" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "email_change_current" }, { "type": "literal", "value": "email_change_new" } ] } } ], "groups": [ { "title": "Properties", "children": [1132, 1133, 1134, 1131] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 916, "character": 44, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L916" } ] } } }, { "id": 1119, "name": "GenerateInviteOrMagiclinkParams", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 902, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L902" } ], "type": { "type": "reflection", "declaration": { "id": 1120, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1122, "name": "email", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The user's email" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 905, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L905" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1123, "name": "options", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 906, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L906" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Pick" }, "typeArguments": [ { "type": "reference", "target": 1135, "name": "GenerateLinkOptions", "package": "@supabase/auth-js" }, { "type": "union", "types": [ { "type": "literal", "value": "data" }, { "type": "literal", "value": "redirectTo" } ] } ], "name": "Pick", "package": "typescript" } }, { "id": 1121, "name": "type", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 903, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L903" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "invite" }, { "type": "literal", "value": "magiclink" } ] } } ], "groups": [ { "title": "Properties", "children": [1122, 1123, 1121] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 902, "character": 46, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L902" } ] } } }, { "id": 1138, "name": "GenerateLinkParams", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 938, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L938" } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 1113, "name": "GenerateSignupLinkParams", "package": "@supabase/auth-js" }, { "type": "reference", "target": 1119, "name": "GenerateInviteOrMagiclinkParams", "package": "@supabase/auth-js" }, { "type": "reference", "target": 1124, "name": "GenerateRecoveryLinkParams", "package": "@supabase/auth-js" }, { "type": "reference", "target": 1129, "name": "GenerateEmailChangeLinkParams", "package": "@supabase/auth-js" } ] } }, { "id": 1143, "name": "GenerateLinkProperties", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The properties related to the email link generated" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 950, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L950" } ], "type": { "type": "reflection", "declaration": { "id": 1144, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1145, "name": "action_link", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The email link to send to the user.\nThe action_link follows the following format: auth/v1/verify?type={verification_type}&token={hashed_token}&redirect_to={redirect_to}" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 955, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L955" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1146, "name": "email_otp", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The raw email OTP.\nYou should send this in the email if you want your users to verify using an OTP instead of the action link." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 960, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L960" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1147, "name": "hashed_token", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The hashed token appended to the action link." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 964, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L964" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1148, "name": "redirect_to", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The URL appended to the action link." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 966, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L966" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1149, "name": "verification_type", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The verification type that the email link is associated to." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 968, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L968" } ], "type": { "type": "reference", "target": 1150, "name": "GenerateLinkType", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [1145, 1146, 1147, 1148, 1149] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 950, "character": 37, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L950" } ] } } }, { "id": 1139, "name": "GenerateLinkResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 944, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L944" } ], "type": { "type": "reference", "target": 797, "typeArguments": [ { "type": "reflection", "declaration": { "id": 1140, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1141, "name": "properties", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 945, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L945" } ], "type": { "type": "reference", "target": 1143, "name": "GenerateLinkProperties", "package": "@supabase/auth-js" } }, { "id": 1142, "name": "user", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 946, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L946" } ], "type": { "type": "reference", "target": 893, "name": "User", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [1141, 1142] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 944, "character": 64, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L944" } ] } } ], "name": "RequestResultSafeDestructure", "package": "@supabase/auth-js" } }, { "id": 1150, "name": "GenerateLinkType", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 971, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L971" } ], "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": 1124, "name": "GenerateRecoveryLinkParams", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 909, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L909" } ], "type": { "type": "reflection", "declaration": { "id": 1125, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1127, "name": "email", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The user's email" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 912, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L912" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1128, "name": "options", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 913, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L913" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Pick" }, "typeArguments": [ { "type": "reference", "target": 1135, "name": "GenerateLinkOptions", "package": "@supabase/auth-js" }, { "type": "literal", "value": "redirectTo" } ], "name": "Pick", "package": "typescript" } }, { "id": 1126, "name": "type", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 910, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L910" } ], "type": { "type": "literal", "value": "recovery" } } ], "groups": [ { "title": "Properties", "children": [1127, 1128, 1126] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 909, "character": 41, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L909" } ] } } }, { "id": 1113, "name": "GenerateSignupLinkParams", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 895, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L895" } ], "type": { "type": "reflection", "declaration": { "id": 1114, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1116, "name": "email", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 897, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L897" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1118, "name": "options", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 899, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L899" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Pick" }, "typeArguments": [ { "type": "reference", "target": 1135, "name": "GenerateLinkOptions", "package": "@supabase/auth-js" }, { "type": "union", "types": [ { "type": "literal", "value": "data" }, { "type": "literal", "value": "redirectTo" } ] } ], "name": "Pick", "package": "typescript" } }, { "id": 1117, "name": "password", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 898, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L898" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1115, "name": "type", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 896, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L896" } ], "type": { "type": "literal", "value": "signup" } } ], "groups": [ { "title": "Properties", "children": [1116, 1118, 1117, 1115] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 895, "character": 39, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L895" } ] } } }, { "id": 746, "name": "GoTrueClientOptions", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 74, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L74" } ], "type": { "type": "reflection", "declaration": { "id": 747, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 762, "name": "autoRefreshToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 103, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L103" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 768, "name": "debug", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 121, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L121" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "boolean" }, { "type": "reflection", "declaration": { "id": 769, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 121, "character": 21, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L121" } ], "signatures": [ { "id": 770, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 771, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 772, "name": "args", "variant": "param", "kind": 32768, "flags": { "isRest": true }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "any" } } } ], "type": { "type": "intrinsic", "name": "void" } } ] } } ] } }, { "id": 754, "name": "detectSessionInUrl", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Set to \"true\" if you want to automatically detect OAuth grants in the URL and sign in the user.\nSet to \"false\" to disable automatic detection.\nSet to a function to provide custom logic for determining if a URL contains a Supabase auth callback.\nThe function receives the current URL and parsed parameters, and should return true if the URL\nshould be processed as a Supabase auth callback, or false to ignore it.\n\nThis is useful when your app uses other OAuth providers (e.g., Facebook Login) that also return\naccess_token in the URL fragment, which would otherwise be incorrectly intercepted by Supabase Auth." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\ndetectSessionInUrl: (url, params) => {\n // Ignore Facebook OAuth redirects\n if (url.pathname === '/facebook/redirect') return false\n // Use default detection for other URLs\n return Boolean(params.access_token || params.error_description)\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 101, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L101" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "boolean" }, { "type": "reflection", "declaration": { "id": 755, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 101, "character": 34, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L101" } ], "signatures": [ { "id": 756, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 757, "name": "url", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" } }, { "id": 758, "name": "params", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 759, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 101, "character": 53, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L101" } ], "indexSignatures": [ { "id": 760, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 101, "character": 55, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L101" } ], "parameters": [ { "id": 761, "name": "parameter", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } } ], "type": { "type": "intrinsic", "name": "boolean" } } ] } } ] } }, { "id": 766, "name": "fetch", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 117, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L117" } ], "type": { "type": "reference", "target": { "sourceFileName": "src/lib/fetch.ts", "qualifiedName": "Fetch" }, "name": "Fetch", "package": "@supabase/auth-js" } }, { "id": 767, "name": "flowType", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 119, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L119" } ], "type": { "type": "reference", "target": 987, "name": "AuthFlowType", "package": "@supabase/auth-js" } }, { "id": 774, "name": "hasCustomAuthorizationHeader", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Set to \"true\" if there is a custom authorization header set globally." } ], "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 135, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L135" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 749, "name": "headers", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 78, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L78" } ], "type": { "type": "reflection", "declaration": { "id": 750, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 78, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L78" } ], "indexSignatures": [ { "id": 751, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 78, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L78" } ], "parameters": [ { "id": 752, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } }, { "id": 773, "name": "lock", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Provide your own locking mechanism based on the environment. By default,\n" }, { "kind": "code", "text": "`navigatorLock`" }, { "kind": "text", "text": " (Web Locks API) is used in browser environments when\n" }, { "kind": "code", "text": "`persistSession`" }, { "kind": "text", "text": " is true. Falls back to an in-process lock for non-browser\nenvironments (e.g. React Native)." } ], "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 130, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L130" } ], "type": { "type": "reference", "target": 737, "name": "LockFunc", "package": "@supabase/auth-js" } }, { "id": 776, "name": "lockAcquireTimeout", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The maximum time in milliseconds to wait for acquiring a cross-tab synchronization lock.\n\nWhen multiple browser tabs or windows use the auth client simultaneously, they coordinate\nvia the Web Locks API to prevent race conditions during session refresh and other operations.\nThis timeout controls how long to wait before attempting lock recovery.\n\n- **Positive value**: Wait up to this many milliseconds. If the lock is still held, attempt\n automatic recovery by stealing it (the previous holder is evicted, its callback continues\n to completion without exclusive access). This recovers from orphaned locks caused by\n React Strict Mode double-mount, storage API hangs, or aborted operations.\n- **Zero (0)**: Fail immediately if the lock is unavailable; throws " }, { "kind": "code", "text": "`LockAcquireTimeoutError`" }, { "kind": "text", "text": "\n (check " }, { "kind": "code", "text": "`error.isAcquireTimeout === true`" }, { "kind": "text", "text": ").\n- **Negative value**: Wait indefinitely — can cause permanent deadlocks if the lock is orphaned." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\n5000\n```" } ] }, { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nconst client = createClient(url, key, {\n auth: {\n lockAcquireTimeout: 5000, // 5 seconds, then steal orphaned lock\n },\n})\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 167, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L167" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 763, "name": "persistSession", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 105, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L105" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 777, "name": "skipAutoInitialize", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If true, skips automatic initialization in constructor. Useful for SSR\ncontexts where initialization timing must be controlled to prevent race\nconditions with HTTP response generation." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\nfalse\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 176, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L176" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 764, "name": "storage", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 107, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L107" } ], "type": { "type": "reference", "target": 1336, "name": "SupportedStorage", "package": "@supabase/auth-js" } }, { "id": 753, "name": "storageKey", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 80, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L80" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 775, "name": "throwOnError", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If there is an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 140, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L140" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 748, "name": "url", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 76, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L76" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 765, "name": "userStorage", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Stores the user object in a separate storage location from the rest of the session data. When non-null, " }, { "kind": "code", "text": "`storage`" }, { "kind": "text", "text": " will only store a JSON object containing the access and refresh token and some adjacent metadata, while " }, { "kind": "code", "text": "`userStorage`" }, { "kind": "text", "text": " will only contain the user object under the key " }, { "kind": "code", "text": "`storageKey + '-user'`" }, { "kind": "text", "text": ".\n\nWhen this option is set and cookie storage is used, " }, { "kind": "code", "text": "`getSession()`" }, { "kind": "text", "text": " and other functions that load a session from the cookie store might not return back a user. It's very important to always use " }, { "kind": "code", "text": "`getUser()`" }, { "kind": "text", "text": " to fetch a user object in those scenarios." } ], "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 115, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L115" } ], "type": { "type": "reference", "target": 1336, "name": "SupportedStorage", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [ 762, 768, 754, 766, 767, 774, 749, 773, 776, 763, 777, 764, 753, 775, 748, 765 ] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 74, "character": 34, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L74" } ] } } }, { "id": 1339, "name": "InitializeResult", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1796, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1796" } ], "type": { "type": "reflection", "declaration": { "id": 1340, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1341, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1796, "character": 33, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1796" } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" }, { "type": "literal", "value": null } ] } } ], "groups": [ { "title": "Properties", "children": [1341] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1796, "character": 31, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1796" } ] } } }, { "id": 1363, "name": "JwtHeader", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1919, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1919" } ], "type": { "type": "reflection", "declaration": { "id": 1364, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1365, "name": "alg", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1920, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1920" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "RS256" }, { "type": "literal", "value": "ES256" }, { "type": "literal", "value": "HS256" } ] } }, { "id": 1366, "name": "kid", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1921, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1921" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1367, "name": "typ", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1922, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1922" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1365, 1366, 1367] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1919, "character": 24, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1919" } ] } } }, { "id": 1558, "name": "ListCustomProvidersParams", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Parameters for listing custom providers." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2348, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2348" } ], "type": { "type": "reflection", "declaration": { "id": 1559, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1560, "name": "type", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Filter by provider type" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2350, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2350" } ], "type": { "type": "reference", "target": 1481, "name": "CustomProviderType", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [1560] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2348, "character": 40, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2348" } ] } } }, { "id": 737, "name": "LockFunc", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Provide your own global lock implementation instead of the default\nimplementation. The function should acquire a lock for the duration of the\n" }, { "kind": "code", "text": "`fn`" }, { "kind": "text", "text": " async function, such that no other client instances will be able to\nhold it at the same time." } ], "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 72, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L72" } ], "type": { "type": "reflection", "declaration": { "id": 738, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 72, "character": 23, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L72" } ], "signatures": [ { "id": 739, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "typeParameters": [ { "id": 745, "name": "R", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 740, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Name of the lock to be acquired." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 741, "name": "acquireTimeout", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "If negative, no timeout should occur. If positive it\n should throw an Error with an " }, { "kind": "code", "text": "`isAcquireTimeout`" }, { "kind": "text", "text": "\n property set to true if the operation fails to be\n acquired after this much time (ms)." } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 742, "name": "fn", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The operation to execute when the lock is acquired." } ] }, "type": { "type": "reflection", "declaration": { "id": 743, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 72, "character": 69, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L72" } ], "signatures": [ { "id": 744, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 745, "name": "R", "package": "@supabase/auth-js", "refersToTypeParameter": true } ], "name": "Promise", "package": "typescript" } } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 745, "name": "R", "package": "@supabase/auth-js", "refersToTypeParameter": true } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 1169, "name": "MFAChallengeAndVerifyParams", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1090, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1090" } ], "type": { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAChallengeAndVerifyTOTPParams" }, "name": "MFAChallengeAndVerifyTOTPParams", "package": "@supabase/auth-js" } }, { "id": 1168, "name": "MFAChallengeParams", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1077, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1077" } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 1165, "name": "MFAChallengeTOTPParams", "package": "@supabase/auth-js" }, { "type": "reference", "target": 1166, "name": "MFAChallengePhoneParams", "package": "@supabase/auth-js" }, { "type": "reference", "target": 1167, "name": "MFAChallengeWebauthnParams", "package": "@supabase/auth-js" } ] } }, { "id": 1166, "name": "MFAChallengePhoneParams", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1054, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1054" } ], "type": { "type": "reference", "target": 783, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAChallengeParamsBase" }, "name": "MFAChallengeParamsBase", "package": "@supabase/auth-js" }, { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAChallengePhoneParamFields" }, "name": "MFAChallengePhoneParamFields", "package": "@supabase/auth-js" } ] } ], "name": "Prettify", "package": "@supabase/auth-js" } }, { "id": 1165, "name": "MFAChallengeTOTPParams", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1047, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1047" } ], "type": { "type": "reference", "target": 783, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAChallengeParamsBase" }, "name": "MFAChallengeParamsBase", "package": "@supabase/auth-js" } ], "name": "Prettify", "package": "@supabase/auth-js" } }, { "id": 1167, "name": "MFAChallengeWebauthnParams", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Parameters for initiating a WebAuthn MFA challenge.\nIncludes Relying Party information needed for WebAuthn ceremonies." } ], "blockTags": [ { "tag": "@see", "content": [ { "kind": "inline-tag", "tag": "@link", "text": "W3C WebAuthn Spec - Relying Party Operations", "target": "https://w3c.github.io/webauthn/#sctn-rp-operations" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1073, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1073" } ], "type": { "type": "reference", "target": 783, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAChallengeParamsBase" }, "name": "MFAChallengeParamsBase", "package": "@supabase/auth-js" }, { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAChallengeWebauthnParamFields" }, "name": "MFAChallengeWebauthnParamFields", "package": "@supabase/auth-js" } ] } ], "name": "Prettify", "package": "@supabase/auth-js" } }, { "id": 1151, "name": "MFAEnrollParams", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 979, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L979" } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 1357, "name": "MFAEnrollTOTPParams", "package": "@supabase/auth-js" }, { "type": "reference", "target": 1358, "name": "MFAEnrollPhoneParams", "package": "@supabase/auth-js" }, { "type": "reference", "target": 1359, "name": "MFAEnrollWebauthnParams", "package": "@supabase/auth-js" } ] } }, { "id": 1358, "name": "MFAEnrollPhoneParams", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1846, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1846" } ], "type": { "type": "reference", "target": 783, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAEnrollParamsBase" }, "typeArguments": [ { "type": "literal", "value": "phone" } ], "name": "MFAEnrollParamsBase", "package": "@supabase/auth-js" }, { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAEnrollPhoneParamFields" }, "name": "MFAEnrollPhoneParamFields", "package": "@supabase/auth-js" } ] } ], "name": "Prettify", "package": "@supabase/auth-js" } }, { "id": 1357, "name": "MFAEnrollTOTPParams", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1840, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1840" } ], "type": { "type": "reference", "target": 783, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAEnrollParamsBase" }, "typeArguments": [ { "type": "literal", "value": "totp" } ], "name": "MFAEnrollParamsBase", "package": "@supabase/auth-js" }, { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAEnrollTOTPParamFields" }, "name": "MFAEnrollTOTPParamFields", "package": "@supabase/auth-js" } ] } ], "name": "Prettify", "package": "@supabase/auth-js" } }, { "id": 1359, "name": "MFAEnrollWebauthnParams", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Parameters for enrolling a WebAuthn factor.\nCreates an unverified WebAuthn factor that must be verified with a credential." } ], "blockTags": [ { "tag": "@see", "content": [ { "kind": "inline-tag", "tag": "@link", "text": "W3C WebAuthn Spec - Registering a New Credential", "target": "https://w3c.github.io/webauthn/#sctn-registering-a-new-credential" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1859, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1859" } ], "type": { "type": "reference", "target": 783, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAEnrollParamsBase" }, "typeArguments": [ { "type": "literal", "value": "webauthn" } ], "name": "MFAEnrollParamsBase", "package": "@supabase/auth-js" }, { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAEnrollWebauthnFields" }, "name": "MFAEnrollWebauthnFields", "package": "@supabase/auth-js" } ] } ], "name": "Prettify", "package": "@supabase/auth-js" } }, { "id": 1164, "name": "MFATOTPChannel", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1045, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1045" } ], "type": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "number" }, "objectType": { "type": "query", "queryType": { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFATOTPChannels" }, "name": "MFATOTPChannels", "package": "@supabase/auth-js", "preferValues": true } } } }, { "id": 1152, "name": "MFAUnenrollParams", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 981, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L981" } ], "type": { "type": "reflection", "declaration": { "id": 1153, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1154, "name": "factorId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ID of the factor being unenrolled." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 983, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L983" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1154] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 981, "character": 32, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L981" } ] } } }, { "id": 1163, "name": "MFAVerifyParams", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1037, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1037" } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 1155, "name": "MFAVerifyTOTPParams", "package": "@supabase/auth-js" }, { "type": "reference", "target": 1156, "name": "MFAVerifyPhoneParams", "package": "@supabase/auth-js" }, { "type": "reference", "target": 1161, "name": "MFAVerifyWebauthnParams", "package": "@supabase/auth-js" } ] } }, { "id": 1156, "name": "MFAVerifyPhoneParams", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1002, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1002" } ], "type": { "type": "reference", "target": 783, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAVerifyParamsBase" }, "name": "MFAVerifyParamsBase", "package": "@supabase/auth-js" }, { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAVerifyPhoneParamFields" }, "name": "MFAVerifyPhoneParamFields", "package": "@supabase/auth-js" } ] } ], "name": "Prettify", "package": "@supabase/auth-js" } }, { "id": 1155, "name": "MFAVerifyTOTPParams", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 998, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L998" } ], "type": { "type": "reference", "target": 783, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAVerifyParamsBase" }, "name": "MFAVerifyParamsBase", "package": "@supabase/auth-js" }, { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAVerifyTOTPParamFields" }, "name": "MFAVerifyTOTPParamFields", "package": "@supabase/auth-js" } ] } ], "name": "Prettify", "package": "@supabase/auth-js" } }, { "id": 1157, "name": "MFAVerifyWebauthnParamFields", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "WebAuthn-specific fields for MFA verification.\nSupports both credential creation (registration) and request (authentication) flows." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1024, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1024" } ], "typeParameters": [ { "id": 1160, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Type of WebAuthn operation: 'create' for registration, 'request' for authentication" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": "create" }, { "type": "literal", "value": "request" } ] }, "default": { "type": "union", "types": [ { "type": "literal", "value": "create" }, { "type": "literal", "value": "request" } ] } } ], "type": { "type": "reflection", "declaration": { "id": 1158, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1159, "name": "webauthn", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1025, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1025" } ], "type": { "type": "intersection", "types": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAVerifyWebauthnParamFieldsBase" }, "name": "MFAVerifyWebauthnParamFieldsBase", "package": "@supabase/auth-js" }, { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAVerifyWebauthnCredentialParamFields" }, "typeArguments": [ { "type": "reference", "target": 1160, "name": "T", "package": "@supabase/auth-js", "refersToTypeParameter": true } ], "name": "MFAVerifyWebauthnCredentialParamFields", "package": "@supabase/auth-js" } ] } } ], "groups": [ { "title": "Properties", "children": [1159] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1024, "character": 98, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1024" } ] } } }, { "id": 1161, "name": "MFAVerifyWebauthnParams", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Parameters for WebAuthn MFA verification.\nUsed to verify WebAuthn credentials after challenge." } ], "blockTags": [ { "tag": "@see", "content": [ { "kind": "inline-tag", "tag": "@link", "text": "W3C WebAuthn Spec - Verifying an Authentication Assertion", "target": "https://w3c.github.io/webauthn/#sctn-verifying-assertion" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1034, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1034" } ], "typeParameters": [ { "id": 1162, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Type of WebAuthn operation: 'create' for registration, 'request' for authentication" } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": "create" }, { "type": "literal", "value": "request" } ] }, "default": { "type": "union", "types": [ { "type": "literal", "value": "create" }, { "type": "literal", "value": "request" } ] } } ], "type": { "type": "reference", "target": 783, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAVerifyParamsBase" }, "name": "MFAVerifyParamsBase", "package": "@supabase/auth-js" }, { "type": "reference", "target": 1157, "typeArguments": [ { "type": "reference", "target": 1162, "name": "T", "package": "@supabase/auth-js", "refersToTypeParameter": true } ], "name": "MFAVerifyWebauthnParamFields", "package": "@supabase/auth-js" } ] } ], "name": "Prettify", "package": "@supabase/auth-js" } }, { "id": 1082, "name": "MobileOtpType", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 836, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L836" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "sms" }, { "type": "literal", "value": "phone_change" } ] } }, { "id": 1593, "name": "OAuthAuthorizationClient", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "OAuth client details in an authorization request.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2429, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2429" } ], "type": { "type": "reflection", "declaration": { "id": 1594, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1595, "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Unique identifier for the OAuth client (UUID)" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2431, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2431" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1598, "name": "logo_uri", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "URI of the OAuth client's logo" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2437, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2437" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1596, "name": "name", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Human-readable name of the OAuth client" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2433, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2433" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1597, "name": "uri", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "URI of the OAuth client's website" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2435, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2435" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1595, 1598, 1596, 1597] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2429, "character": 39, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2429" } ] } } }, { "id": 1599, "name": "OAuthAuthorizationDetails", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "OAuth authorization details when user needs to provide consent.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis response includes all information needed to display a consent page:\nclient details, user info, requested scopes, and where the user will be redirected.\n\nNote: " }, { "kind": "code", "text": "`redirect_uri`" }, { "kind": "text", "text": " is the base URI (e.g., \"https://app.com/callback\") without\nquery parameters. After consent, you'll receive a complete " }, { "kind": "code", "text": "`redirect_url`" }, { "kind": "text", "text": " with\nthe authorization code and state parameters appended." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2451, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2451" } ], "type": { "type": "reflection", "declaration": { "id": 1600, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1601, "name": "authorization_id", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The authorization ID used to approve or deny the request" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2453, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2453" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1603, "name": "client", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "OAuth client requesting authorization" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2457, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2457" } ], "type": { "type": "reference", "target": 1593, "name": "OAuthAuthorizationClient", "package": "@supabase/auth-js" } }, { "id": 1602, "name": "redirect_uri", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The OAuth client's registered redirect URI (base URI without query parameters)" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2455, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2455" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1608, "name": "scope", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Space-separated list of requested scopes (e.g., \"openid profile email\")" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2466, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2466" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1604, "name": "user", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "User object associated with the authorization" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2459, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2459" } ], "type": { "type": "reflection", "declaration": { "id": 1605, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1607, "name": "email", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "User email" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2463, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2463" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1606, "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "User ID (UUID)" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2461, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2461" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1607, 1606] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2459, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2459" } ] } } } ], "groups": [ { "title": "Properties", "children": [1601, 1603, 1602, 1608, 1604] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2451, "character": 40, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2451" } ] } } }, { "id": 1412, "name": "OAuthClient", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "OAuth client object returned from the OAuth 2.1 server.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2018, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2018" } ], "type": { "type": "reflection", "declaration": { "id": 1413, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1414, "name": "client_id", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Unique identifier for the OAuth client" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2020, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2020" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1415, "name": "client_name", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Human-readable name of the OAuth client" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2022, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2022" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1416, "name": "client_secret", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Client secret (only returned on registration and regeneration)" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2024, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2024" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1417, "name": "client_type", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Type of OAuth client" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2026, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2026" } ], "type": { "type": "reference", "target": 1409, "name": "OAuthClientType", "package": "@supabase/auth-js" } }, { "id": 1420, "name": "client_uri", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "URI of the OAuth client" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2032, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2032" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1426, "name": "created_at", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Timestamp when the client was created" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2044, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2044" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1423, "name": "grant_types", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Array of allowed grant types" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2038, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2038" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 1407, "name": "OAuthClientGrantType", "package": "@supabase/auth-js" } } }, { "id": 1421, "name": "logo_uri", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "URI of the OAuth client's logo" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2034, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2034" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1422, "name": "redirect_uris", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Array of allowed redirect URIs" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2036, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2036" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 1419, "name": "registration_type", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Registration type of the client" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2030, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2030" } ], "type": { "type": "reference", "target": 1410, "name": "OAuthClientRegistrationType", "package": "@supabase/auth-js" } }, { "id": 1424, "name": "response_types", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Array of allowed response types" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2040, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2040" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 1408, "name": "OAuthClientResponseType", "package": "@supabase/auth-js" } } }, { "id": 1425, "name": "scope", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Scope of the OAuth client" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2042, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2042" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1418, "name": "token_endpoint_auth_method", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Token endpoint authentication method" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2028, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2028" } ], "type": { "type": "reference", "target": 1411, "name": "OAuthClientTokenEndpointAuthMethod", "package": "@supabase/auth-js" } }, { "id": 1427, "name": "updated_at", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Timestamp when the client was last updated" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2046, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2046" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 1414, 1415, 1416, 1417, 1420, 1426, 1423, 1421, 1422, 1419, 1424, 1425, 1418, 1427 ] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2018, "character": 26, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2018" } ] } } }, { "id": 1407, "name": "OAuthClientGrantType", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "OAuth client grant types supported by the OAuth 2.1 server.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1985, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1985" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "authorization_code" }, { "type": "literal", "value": "refresh_token" } ] } }, { "id": 1446, "name": "OAuthClientListResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Response type for listing OAuth clients.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2100, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2100" } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 1447, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1448, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2102, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2102" } ], "type": { "type": "intersection", "types": [ { "type": "reflection", "declaration": { "id": 1449, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1451, "name": "aud", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2102, "character": 38, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2102" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1450, "name": "clients", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2102, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2102" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 1412, "name": "OAuthClient", "package": "@supabase/auth-js" } } } ], "groups": [ { "title": "Properties", "children": [1451, 1450] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2102, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2102" } ] } }, { "type": "reference", "target": 1343, "name": "Pagination", "package": "@supabase/auth-js" } ] } }, { "id": 1452, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2103, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2103" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [1448, 1452] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2101, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2101" } ] } }, { "type": "reflection", "declaration": { "id": 1453, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1454, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2106, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2106" } ], "type": { "type": "reflection", "declaration": { "id": 1455, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1456, "name": "clients", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2106, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2106" } ], "type": { "type": "tuple" } } ], "groups": [ { "title": "Properties", "children": [1456] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2106, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2106" } ] } } }, { "id": 1457, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2107, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2107" } ], "type": { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [1454, 1457] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2105, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2105" } ] } } ] } }, { "id": 1410, "name": "OAuthClientRegistrationType", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "OAuth client registration type.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2003, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2003" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "dynamic" }, { "type": "literal", "value": "manual" } ] } }, { "id": 1445, "name": "OAuthClientResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Response type for OAuth client operations.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2094, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2094" } ], "type": { "type": "reference", "target": 788, "typeArguments": [ { "type": "reference", "target": 1412, "name": "OAuthClient", "package": "@supabase/auth-js" } ], "name": "RequestResult", "package": "@supabase/auth-js" } }, { "id": 1408, "name": "OAuthClientResponseType", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "OAuth client response types supported by the OAuth 2.1 server.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1991, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1991" } ], "type": { "type": "literal", "value": "code" } }, { "id": 1411, "name": "OAuthClientTokenEndpointAuthMethod", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "OAuth client token endpoint authentication method.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2009, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2009" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "none" }, { "type": "literal", "value": "client_secret_basic" }, { "type": "literal", "value": "client_secret_post" } ] } }, { "id": 1409, "name": "OAuthClientType", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "OAuth client type indicating whether the client can keep credentials confidential.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1997, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1997" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "public" }, { "type": "literal", "value": "confidential" } ] } }, { "id": 1614, "name": "OAuthGrant", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "An OAuth grant representing a user's authorization of an OAuth client.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2523, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2523" } ], "type": { "type": "reflection", "declaration": { "id": 1615, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1616, "name": "client", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "OAuth client information" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2525, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2525" } ], "type": { "type": "reference", "target": 1593, "name": "OAuthAuthorizationClient", "package": "@supabase/auth-js" } }, { "id": 1618, "name": "granted_at", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Timestamp when the grant was created (ISO 8601 date-time)" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2529, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2529" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1617, "name": "scopes", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Array of scopes granted to this client" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2527, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2527" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } ], "groups": [ { "title": "Properties", "children": [1616, 1618, 1617] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2523, "character": 25, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2523" } ] } } }, { "id": 1609, "name": "OAuthRedirect", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "OAuth redirect response when user has already consented or after consent decision.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth.\n\nThis response is returned in three scenarios:\n1. User already consented to these scopes (auto-approved)\n2. User just approved the authorization request\n3. User just denied the authorization request\n\nThe " }, { "kind": "code", "text": "`redirect_url`" }, { "kind": "text", "text": " is a complete URL ready for redirecting the user back to the\nOAuth client, including authorization code (on success) or error (on denial) in\nquery parameters, along with the state parameter if one was provided." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2482, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2482" } ], "type": { "type": "reflection", "declaration": { "id": 1610, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1611, "name": "redirect_url", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Complete redirect URL with authorization code and state parameters (e.g., \"https://app.com/callback?code=xxx&state=yyy\")" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2484, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2484" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1611] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2482, "character": 28, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2482" } ] } } }, { "id": 828, "name": "OAuthResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 257, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L257" } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 829, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 830, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 259, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L259" } ], "type": { "type": "reflection", "declaration": { "id": 831, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 832, "name": "provider", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 260, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L260" } ], "type": { "type": "reference", "target": 734, "name": "Provider", "package": "@supabase/auth-js" } }, { "id": 833, "name": "url", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 261, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L261" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [832, 833] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 259, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L259" } ] } } }, { "id": 834, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 263, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L263" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [830, 834] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 258, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L258" } ] } }, { "type": "reflection", "declaration": { "id": 835, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 836, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 266, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L266" } ], "type": { "type": "reflection", "declaration": { "id": 837, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 838, "name": "provider", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 267, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L267" } ], "type": { "type": "reference", "target": 734, "name": "Provider", "package": "@supabase/auth-js" } }, { "id": 839, "name": "url", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 268, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L268" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [838, 839] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 266, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L266" } ] } } }, { "id": 840, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 270, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L270" } ], "type": { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [836, 840] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 265, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L265" } ] } } ] } }, { "id": 1482, "name": "OIDCDiscoveryDocument", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "OIDC discovery document fields.\nPopulated when the server successfully fetches and validates the\nprovider's OpenID Connect discovery document." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2186, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2186" } ], "type": { "type": "reflection", "declaration": { "id": 1483, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1485, "name": "authorization_endpoint", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "URL of the authorization endpoint" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2190, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2190" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1484, "name": "issuer", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The issuer identifier" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2188, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2188" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1487, "name": "jwks_uri", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "URL of the JSON Web Key Set" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2194, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2194" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1489, "name": "revocation_endpoint", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "URL of the revocation endpoint" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2198, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2198" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1493, "name": "supported_id_token_signing_algs", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "List of supported ID token signing algorithms" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2206, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2206" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 1491, "name": "supported_response_types", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "List of supported response types" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2202, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2202" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 1490, "name": "supported_scopes", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "List of supported scopes" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2200, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2200" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 1492, "name": "supported_subject_types", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "List of supported subject types" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2204, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2204" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 1486, "name": "token_endpoint", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "URL of the token endpoint" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2192, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2192" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1488, "name": "userinfo_endpoint", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "URL of the userinfo endpoint" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2196, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2196" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1485, 1484, 1487, 1489, 1493, 1491, 1490, 1492, 1486, 1488] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2186, "character": 36, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2186" } ] } } }, { "id": 1350, "name": "PageParams", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1807, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1807" } ], "type": { "type": "reflection", "declaration": { "id": 1351, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1352, "name": "page", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The page number" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1809, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1809" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1353, "name": "perPage", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Number of items returned per page" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1811, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1811" } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "children": [1352, 1353] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1807, "character": 25, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1807" } ] } } }, { "id": 1343, "name": "Pagination", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1800, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1800" } ], "type": { "type": "reflection", "declaration": { "id": 1344, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1346, "name": "lastPage", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1803, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1803" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1345, "name": "nextPage", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1802, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1802" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "number" }, { "type": "literal", "value": null } ] } }, { "id": 1347, "name": "total", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1804, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1804" } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "children": [1346, 1345, 1347] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1800, "character": 25, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1800" } ], "indexSignatures": [ { "id": 1348, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1801, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1801" } ], "parameters": [ { "id": 1349, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } ] } } }, { "id": 783, "name": "Prettify", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Resolve mapped types and show the derived keys and their types when hovering in\nVS Code, instead of just showing the names those mapped types are defined with." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 191, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L191" } ], "typeParameters": [ { "id": 784, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} } ], "type": { "type": "conditional", "checkType": { "type": "reference", "target": 784, "name": "T", "package": "@supabase/auth-js", "refersToTypeParameter": true }, "extendsType": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Function" }, "name": "Function", "package": "typescript" }, "trueType": { "type": "reference", "target": 784, "name": "T", "package": "@supabase/auth-js", "refersToTypeParameter": true }, "falseType": { "type": "mapped", "parameter": "K", "parameterType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "target": 784, "name": "T", "package": "@supabase/auth-js", "refersToTypeParameter": true } }, "templateType": { "type": "indexedAccess", "indexType": { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "K" }, "name": "K", "package": "@supabase/auth-js", "refersToTypeParameter": true }, "objectType": { "type": "reference", "target": 784, "name": "T", "package": "@supabase/auth-js", "refersToTypeParameter": true } } } } }, { "id": 734, "name": "Provider", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "One of the providers supported by GoTrue. Use the " }, { "kind": "code", "text": "`custom:`" }, { "kind": "text", "text": " prefix for custom OIDC providers (e.g. " }, { "kind": "code", "text": "`custom:my-oidc-provider`" }, { "kind": "text", "text": ")." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 18, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L18" } ], "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": "figma" }, { "type": "literal", "value": "github" }, { "type": "literal", "value": "gitlab" }, { "type": "literal", "value": "google" }, { "type": "literal", "value": "kakao" }, { "type": "literal", "value": "keycloak" }, { "type": "literal", "value": "linkedin" }, { "type": "literal", "value": "linkedin_oidc" }, { "type": "literal", "value": "notion" }, { "type": "literal", "value": "slack" }, { "type": "literal", "value": "slack_oidc" }, { "type": "literal", "value": "spotify" }, { "type": "literal", "value": "twitch" }, { "type": "literal", "value": "twitter" }, { "type": "literal", "value": "x" }, { "type": "literal", "value": "workos" }, { "type": "literal", "value": "zoom" }, { "type": "literal", "value": "fly" }, { "type": "templateLiteral", "head": "custom:", "tail": [ [ { "type": "intrinsic", "name": "string" }, "" ] ] } ], "elementSummaries": [ [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [], [ { "kind": "text", "text": "Uses OAuth 1.0a" } ], [ { "kind": "text", "text": "Uses OAuth 2.0" } ], [], [], [], [] ] } }, { "id": 788, "name": "RequestResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "a shared result type that encapsulates errors instead of throwing them, allows you to optionally specify the ErrorType" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 203, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L203" } ], "typeParameters": [ { "id": 795, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} }, { "id": 796, "name": "ErrorType", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Error" }, "name": "Error", "package": "typescript" }, "default": { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 789, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 790, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 205, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L205" } ], "type": { "type": "reference", "target": 795, "name": "T", "package": "@supabase/auth-js", "refersToTypeParameter": true } }, { "id": 791, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 206, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L206" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [790, 791] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 204, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L204" } ] } }, { "type": "reflection", "declaration": { "id": 792, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 793, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 209, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L209" } ], "type": { "type": "literal", "value": null } }, { "id": 794, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 210, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L210" } ], "type": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Error" }, "name": "Error", "package": "typescript" }, "extendsType": { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" }, "trueType": { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" }, "falseType": { "type": "reference", "target": 796, "name": "ErrorType", "package": "@supabase/auth-js", "refersToTypeParameter": true } } } ], "groups": [ { "title": "Properties", "children": [793, 794] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 208, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L208" } ] } } ] } }, { "id": 797, "name": "RequestResultSafeDestructure", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "similar to RequestResult except it allows you to destructure the possible shape of the success response\n " }, { "kind": "inline-tag", "tag": "@see", "text": "RequestResult" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 217, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L217" } ], "typeParameters": [ { "id": 804, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 798, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 799, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 218, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L218" } ], "type": { "type": "reference", "target": 804, "name": "T", "package": "@supabase/auth-js", "refersToTypeParameter": true } }, { "id": 800, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 218, "character": 15, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L218" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [799, 800] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 218, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L218" } ] } }, { "type": "reflection", "declaration": { "id": 801, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 802, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 220, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L220" } ], "type": { "type": "conditional", "checkType": { "type": "reference", "target": 804, "name": "T", "package": "@supabase/auth-js", "refersToTypeParameter": true }, "extendsType": { "type": "intrinsic", "name": "object" }, "trueType": { "type": "mapped", "parameter": "K", "parameterType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "target": 804, "name": "T", "package": "@supabase/auth-js", "refersToTypeParameter": true } }, "templateType": { "type": "literal", "value": null } }, "falseType": { "type": "literal", "value": null } } }, { "id": 803, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 221, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L221" } ], "type": { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [802, 803] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 219, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L219" } ] } } ] } }, { "id": 1368, "name": "RequiredClaims", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1925, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1925" } ], "type": { "type": "reflection", "declaration": { "id": 1369, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1376, "name": "aal", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1932, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1932" } ], "type": { "type": "reference", "target": 1192, "name": "AuthenticatorAssuranceLevels", "package": "@supabase/auth-js" } }, { "id": 1372, "name": "aud", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1928, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1928" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } ] } }, { "id": 1373, "name": "exp", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1929, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1929" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1374, "name": "iat", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1930, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1930" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1370, "name": "iss", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1926, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1926" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1375, "name": "role", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1931, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1931" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1377, "name": "session_id", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1933, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1933" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1371, "name": "sub", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1927, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1927" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1376, 1372, 1373, 1374, 1370, 1375, 1377, 1371] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1925, "character": 29, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1925" } ] } }, "extendedBy": [ { "type": "reference", "target": 1378, "name": "JwtPayload" } ] }, { "id": 1084, "name": "ResendParams", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 839, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L839" } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 1085, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1087, "name": "email", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 842, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L842" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1088, "name": "options", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 843, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L843" } ], "type": { "type": "reflection", "declaration": { "id": 1089, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1091, "name": "captchaToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Verification token received when the user completes the captcha on the site." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 847, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L847" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1090, "name": "emailRedirectTo", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A URL to send the user to after they have signed-in." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 845, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L845" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1091, 1090] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 843, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L843" } ] } } }, { "id": 1086, "name": "type", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 841, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L841" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Extract" }, "typeArguments": [ { "type": "reference", "target": 1083, "name": "EmailOtpType", "package": "@supabase/auth-js" }, { "type": "union", "types": [ { "type": "literal", "value": "signup" }, { "type": "literal", "value": "email_change" } ] } ], "name": "Extract", "package": "typescript" } } ], "groups": [ { "title": "Properties", "children": [1087, 1088, 1086] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 840, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L840" } ] } }, { "type": "reflection", "declaration": { "id": 1092, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1095, "name": "options", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 853, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L853" } ], "type": { "type": "reflection", "declaration": { "id": 1096, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1097, "name": "captchaToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Verification token received when the user completes the captcha on the site." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 855, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L855" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1097] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 853, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L853" } ] } } }, { "id": 1094, "name": "phone", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 852, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L852" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1093, "name": "type", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 851, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L851" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Extract" }, "typeArguments": [ { "type": "reference", "target": 1082, "name": "MobileOtpType", "package": "@supabase/auth-js" }, { "type": "union", "types": [ { "type": "literal", "value": "sms" }, { "type": "literal", "value": "phone_change" } ] } ], "name": "Extract", "package": "typescript" } } ], "groups": [ { "title": "Properties", "children": [1095, 1094, 1093] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 850, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L850" } ] } } ] } }, { "id": 951, "name": "SignInAnonymouslyCredentials", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 599, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L599" } ], "type": { "type": "reflection", "declaration": { "id": 952, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 953, "name": "options", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 600, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L600" } ], "type": { "type": "reflection", "declaration": { "id": 954, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 956, "name": "captchaToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Verification token received when the user completes the captcha on the site." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 608, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L608" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 955, "name": "data", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A custom data object to store the user's metadata. This maps to the " }, { "kind": "code", "text": "`auth.users.raw_user_meta_data`" }, { "kind": "text", "text": " column.\n\nThe " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " should be a JSON object that includes user-specific info, such as their first and last name." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 606, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L606" } ], "type": { "type": "intrinsic", "name": "object" } } ], "groups": [ { "title": "Properties", "children": [956, 955] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 600, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L600" } ] } } } ], "groups": [ { "title": "Properties", "children": [953] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 599, "character": 43, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L599" } ] } } }, { "id": 1000, "name": "SignInWithIdTokenCredentials", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 687, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L687" } ], "type": { "type": "reflection", "declaration": { "id": 1001, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1005, "name": "access_token", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If the ID token contains an " }, { "kind": "code", "text": "`at_hash`" }, { "kind": "text", "text": " claim, then the hash of this value is compared to the value in the ID token." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 693, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L693" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1006, "name": "nonce", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If the ID token contains a " }, { "kind": "code", "text": "`nonce`" }, { "kind": "text", "text": " claim, then the hash of this value is compared to the value in the ID token." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 695, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L695" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1007, "name": "options", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 696, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L696" } ], "type": { "type": "reflection", "declaration": { "id": 1008, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1009, "name": "captchaToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Verification token received when the user completes the captcha on the site." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 698, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L698" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1009] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 696, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L696" } ] } } }, { "id": 1002, "name": "provider", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Provider name or OIDC " }, { "kind": "code", "text": "`iss`" }, { "kind": "text", "text": " value identifying which provider should be used to verify the provided token. Supported names: " }, { "kind": "code", "text": "`google`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`apple`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`azure`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`facebook`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`kakao`" }, { "kind": "text", "text": ". Use the " }, { "kind": "code", "text": "`custom:`" }, { "kind": "text", "text": " prefix for custom OIDC providers (e.g. " }, { "kind": "code", "text": "`custom:my-oidc-provider`" }, { "kind": "text", "text": ")." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 689, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L689" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "google" }, { "type": "literal", "value": "apple" }, { "type": "literal", "value": "azure" }, { "type": "literal", "value": "facebook" }, { "type": "literal", "value": "kakao" }, { "type": "templateLiteral", "head": "custom:", "tail": [ [ { "type": "intrinsic", "name": "string" }, "" ] ] }, { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reflection", "declaration": { "id": 1003, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 689, "character": 97, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L689" } ] } } ] } ] } }, { "id": 1004, "name": "token", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "OIDC ID token issued by the specified provider. The " }, { "kind": "code", "text": "`iss`" }, { "kind": "text", "text": " claim in the ID token must match the supplied provider. Some ID tokens contain an " }, { "kind": "code", "text": "`at_hash`" }, { "kind": "text", "text": " which require that you provide an " }, { "kind": "code", "text": "`access_token`" }, { "kind": "text", "text": " value to be accepted properly. If the token contains a " }, { "kind": "code", "text": "`nonce`" }, { "kind": "text", "text": " claim you must supply the nonce used to obtain the ID token." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 691, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L691" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1005, 1006, 1007, 1002, 1004] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 687, "character": 43, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L687" } ] } } }, { "id": 988, "name": "SignInWithOAuthCredentials", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 672, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L672" } ], "type": { "type": "reflection", "declaration": { "id": 989, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 991, "name": "options", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 675, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L675" } ], "type": { "type": "reflection", "declaration": { "id": 992, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 995, "name": "queryParams", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "An object of query params" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 681, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L681" } ], "type": { "type": "reflection", "declaration": { "id": 996, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 681, "character": 18, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L681" } ], "indexSignatures": [ { "id": 997, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 681, "character": 20, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L681" } ], "parameters": [ { "id": 998, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } }, { "id": 993, "name": "redirectTo", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A URL to send the user to after they are confirmed." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 677, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L677" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 994, "name": "scopes", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A space-separated list of scopes granted to the OAuth application." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 679, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L679" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 999, "name": "skipBrowserRedirect", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If set to true does not immediately redirect the current browser context to visit the OAuth authorization page for the provider." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 683, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L683" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [995, 993, 994, 999] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 675, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L675" } ] } } }, { "id": 990, "name": "provider", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "One of the providers supported by GoTrue." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 674, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L674" } ], "type": { "type": "reference", "target": 734, "name": "Provider", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [991, 990] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 672, "character": 41, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L672" } ] } } }, { "id": 965, "name": "SignInWithPasswordCredentials", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 627, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L627" } ], "type": { "type": "intersection", "types": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "PasswordCredentialsBase" }, "name": "PasswordCredentialsBase", "package": "@supabase/auth-js" }, { "type": "reflection", "declaration": { "id": 966, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 967, "name": "options", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 628, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L628" } ], "type": { "type": "reflection", "declaration": { "id": 968, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 969, "name": "captchaToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 629, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L629" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [969] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 628, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L628" } ] } } } ], "groups": [ { "title": "Properties", "children": [967] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 627, "character": 70, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L627" } ] } } ] } }, { "id": 970, "name": "SignInWithPasswordlessCredentials", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 633, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L633" } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 971, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 972, "name": "email", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The user's email address." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 636, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L636" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 973, "name": "options", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 637, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L637" } ], "type": { "type": "reflection", "declaration": { "id": 974, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 978, "name": "captchaToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Verification token received when the user completes the captcha on the site." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 649, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L649" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 977, "name": "data", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A custom data object to store the user's metadata. This maps to the " }, { "kind": "code", "text": "`auth.users.raw_user_meta_data`" }, { "kind": "text", "text": " column.\n\nThe " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " should be a JSON object that includes user-specific info, such as their first and last name." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 647, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L647" } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 975, "name": "emailRedirectTo", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The redirect url embedded in the email link" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 639, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L639" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 976, "name": "shouldCreateUser", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If set to false, this method will not create a new user. Defaults to true." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 641, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L641" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [978, 977, 975, 976] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 637, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L637" } ] } } } ], "groups": [ { "title": "Properties", "children": [972, 973] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 634, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L634" } ] } }, { "type": "reflection", "declaration": { "id": 979, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 981, "name": "options", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 655, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L655" } ], "type": { "type": "reflection", "declaration": { "id": 982, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 985, "name": "captchaToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Verification token received when the user completes the captcha on the site." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 665, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L665" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 986, "name": "channel", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Messaging channel to use (e.g. whatsapp or sms)" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 667, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L667" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "sms" }, { "type": "literal", "value": "whatsapp" } ] } }, { "id": 984, "name": "data", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A custom data object to store the user's metadata. This maps to the " }, { "kind": "code", "text": "`auth.users.raw_user_meta_data`" }, { "kind": "text", "text": " column.\n\nThe " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " should be a JSON object that includes user-specific info, such as their first and last name." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 663, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L663" } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 983, "name": "shouldCreateUser", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If set to false, this method will not create a new user. Defaults to true." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 657, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L657" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [985, 986, 984, 983] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 655, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L655" } ] } } }, { "id": 980, "name": "phone", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The user's phone number." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 654, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L654" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [981, 980] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 652, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L652" } ] } } ] } }, { "id": 1098, "name": "SignInWithSSO", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 859, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L859" } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 1099, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1101, "name": "options", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 864, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L864" } ], "type": { "type": "reflection", "declaration": { "id": 1102, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1104, "name": "captchaToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Verification token received when the user completes the captcha on the site." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 868, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L868" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1103, "name": "redirectTo", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A URL to send the user to after they have signed-in." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 866, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L866" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1105, "name": "skipBrowserRedirect", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If set to true, the redirect will not happen on the client side.\nThis parameter is used when you wish to handle the redirect yourself.\nDefaults to false." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 874, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L874" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [1104, 1103, 1105] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 864, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L864" } ] } } }, { "id": 1100, "name": "providerId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "UUID of the SSO provider to invoke single-sign on to." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 862, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L862" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1101, 1100] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 860, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L860" } ] } }, { "type": "reflection", "declaration": { "id": 1106, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1107, "name": "domain", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Domain name of the organization for which to invoke single-sign on." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 879, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L879" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1108, "name": "options", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 881, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L881" } ], "type": { "type": "reflection", "declaration": { "id": 1109, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1111, "name": "captchaToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Verification token received when the user completes the captcha on the site." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 885, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L885" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1110, "name": "redirectTo", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "A URL to send the user to after they have signed-in." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 883, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L883" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1112, "name": "skipBrowserRedirect", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If set to true, the redirect will not happen on the client side.\nThis parameter is used when you wish to handle the redirect yourself.\nDefaults to false." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 891, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L891" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [1111, 1110, 1112] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 881, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L881" } ] } } } ], "groups": [ { "title": "Properties", "children": [1107, 1108] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 877, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L877" } ] } } ] } }, { "id": 1354, "name": "SignOut", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1814, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1814" } ], "type": { "type": "reflection", "declaration": { "id": 1355, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1356, "name": "scope", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Determines which sessions should be\nlogged out. Global means all\nsessions by this account. Local\nmeans only this session. Others\nmeans all other sessions except the\ncurrent one. When using others,\nthere is no sign-out event fired on\nthe current session!" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1825, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1825" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "global" }, { "type": "literal", "value": "local" }, { "type": "literal", "value": "others" } ] } } ], "groups": [ { "title": "Properties", "children": [1356] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1814, "character": 22, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1814" } ] } } }, { "id": 1406, "name": "SignOutScope", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1979, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1979" } ], "type": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "number" }, "objectType": { "type": "query", "queryType": { "type": "reference", "target": 1405, "name": "SIGN_OUT_SCOPES", "package": "@supabase/auth-js" } } } }, { "id": 957, "name": "SignUpWithPasswordCredentials", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 612, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L612" } ], "type": { "type": "reference", "target": 783, "typeArguments": [ { "type": "intersection", "types": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "PasswordCredentialsBase" }, "name": "PasswordCredentialsBase", "package": "@supabase/auth-js" }, { "type": "reflection", "declaration": { "id": 958, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 959, "name": "options", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 614, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L614" } ], "type": { "type": "reflection", "declaration": { "id": 960, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 963, "name": "captchaToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 617, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L617" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 964, "name": "channel", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 618, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L618" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "sms" }, { "type": "literal", "value": "whatsapp" } ] } }, { "id": 962, "name": "data", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 616, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L616" } ], "type": { "type": "intrinsic", "name": "object" } }, { "id": 961, "name": "emailRedirectTo", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 615, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L615" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [963, 964, 962, 961] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 614, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L614" } ] } } } ], "groups": [ { "title": "Properties", "children": [959] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 613, "character": 28, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L613" } ] } } ] } ], "name": "Prettify", "package": "@supabase/auth-js" } }, { "id": 1010, "name": "SolanaWallet", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 702, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L702" } ], "type": { "type": "reflection", "declaration": { "id": 1011, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1016, "name": "publicKey", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 704, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L704" } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 1017, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1018, "name": "toBase58", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 705, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L705" } ], "type": { "type": "reflection", "declaration": { "id": 1019, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 705, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L705" } ], "signatures": [ { "id": 1020, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ] } } } ], "groups": [ { "title": "Properties", "children": [1018] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 704, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L704" } ] } }, { "type": "literal", "value": null } ] } }, { "id": 1012, "name": "signIn", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 703, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L703" } ], "type": { "type": "reflection", "declaration": { "id": 1013, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 703, "character": 11, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L703" } ], "signatures": [ { "id": 1014, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 1015, "name": "inputs", "variant": "param", "kind": 32768, "flags": { "isRest": true }, "type": { "type": "array", "elementType": { "type": "reference", "target": { "sourceFileName": "src/lib/web3/solana.ts", "qualifiedName": "SolanaSignInInput" }, "name": "SolanaSignInInput", "package": "@supabase/auth-js" } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "src/lib/web3/solana.ts", "qualifiedName": "SolanaSignInOutput" }, "name": "SolanaSignInOutput", "package": "@supabase/auth-js" }, { "type": "array", "elementType": { "type": "reference", "target": { "sourceFileName": "src/lib/web3/solana.ts", "qualifiedName": "SolanaSignInOutput" }, "name": "SolanaSignInOutput", "package": "@supabase/auth-js" } } ] } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 1021, "name": "signMessage", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 708, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L708" } ], "type": { "type": "reflection", "declaration": { "id": 1022, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 708, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L708" } ], "signatures": [ { "id": 1023, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { "id": 1024, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Uint8Array" }, "name": "Uint8Array", "package": "typescript" } }, { "id": 1025, "name": "encoding", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": "utf8" }, { "type": "intrinsic", "name": "string" } ] } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Uint8Array" }, "name": "Uint8Array", "package": "typescript" } ], "name": "Promise", "package": "typescript" }, { "type": "intrinsic", "name": "undefined" } ] } } ] } } } ], "groups": [ { "title": "Properties", "children": [1016, 1012, 1021] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 702, "character": 27, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L702" } ] } } }, { "id": 1026, "name": "SolanaWeb3Credentials", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 711, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L711" } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 1027, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1028, "name": "chain", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 713, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L713" } ], "type": { "type": "literal", "value": "solana" } }, { "id": 1031, "name": "options", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 721, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L721" } ], "type": { "type": "reflection", "declaration": { "id": 1032, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1034, "name": "captchaToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Verification token received when the user completes the captcha on the site." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 726, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L726" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1035, "name": "signInWithSolana", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 728, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L728" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Partial" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Omit" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "src/lib/web3/solana.ts", "qualifiedName": "SolanaSignInInput" }, "name": "SolanaSignInInput", "package": "@supabase/auth-js" }, { "type": "union", "types": [ { "type": "literal", "value": "version" }, { "type": "literal", "value": "chain" }, { "type": "literal", "value": "domain" }, { "type": "literal", "value": "uri" }, { "type": "literal", "value": "statement" } ] } ], "name": "Omit", "package": "typescript" } ], "name": "Partial", "package": "typescript" } }, { "id": 1033, "name": "url", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "URL to use with the wallet interface. Some wallets do not allow signing a message for URLs different from the current page." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 723, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L723" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1034, 1035, 1033] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 721, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L721" } ] } } }, { "id": 1030, "name": "statement", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional statement to include in the Sign in with Solana message. Must not include new line characters. Most wallets like Phantom **require specifying a statement!**" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 719, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L719" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1029, "name": "wallet", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Wallet interface to use. If not specified will default to " }, { "kind": "code", "text": "`window.solana`" }, { "kind": "text", "text": "." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 716, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L716" } ], "type": { "type": "reference", "target": 1010, "name": "SolanaWallet", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [1028, 1031, 1030, 1029] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 712, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L712" } ] } }, { "type": "reflection", "declaration": { "id": 1036, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1037, "name": "chain", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 734, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L734" } ], "type": { "type": "literal", "value": "solana" } }, { "id": 1038, "name": "message", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Sign in with Solana compatible message. Must include " }, { "kind": "code", "text": "`Issued At`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`URI`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`Version`" }, { "kind": "text", "text": "." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 737, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L737" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1040, "name": "options", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 742, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L742" } ], "type": { "type": "reflection", "declaration": { "id": 1041, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1042, "name": "captchaToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Verification token received when the user completes the captcha on the site." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 744, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L744" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1042] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 742, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L742" } ] } } }, { "id": 1039, "name": "signature", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Ed25519 signature of the message." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 740, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L740" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Uint8Array" }, "name": "Uint8Array", "package": "typescript" } } ], "groups": [ { "title": "Properties", "children": [1037, 1038, 1040, 1039] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 733, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L733" } ] } } ] } }, { "id": 841, "name": "SSOResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 273, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L273" } ], "type": { "type": "reference", "target": 788, "typeArguments": [ { "type": "reflection", "declaration": { "id": 842, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 843, "name": "url", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "URL to open in a browser which will complete the sign-in flow by\ntaking the user to the identity provider's authentication flow.\n\nOn browsers you can set the URL to " }, { "kind": "code", "text": "`window.location.href`" }, { "kind": "text", "text": " to take\nthe user to the authentication flow." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 281, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L281" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [843] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 273, "character": 40, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L273" } ] } } ], "name": "RequestResult", "package": "@supabase/auth-js" } }, { "id": 785, "name": "StrictOmit", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "A stricter version of TypeScript's Omit that only allows omitting keys that actually exist.\nThis prevents typos and ensures type safety at compile time.\nUnlike regular Omit, this will error if you try to omit a non-existent key." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 198, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L198" } ], "typeParameters": [ { "id": 786, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} }, { "id": 787, "name": "K", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "target": 786, "name": "T", "package": "@supabase/auth-js", "refersToTypeParameter": true } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Omit" }, "typeArguments": [ { "type": "reference", "target": 786, "name": "T", "package": "@supabase/auth-js", "refersToTypeParameter": true }, { "type": "reference", "target": 787, "name": "K", "package": "@supabase/auth-js", "refersToTypeParameter": true } ], "name": "Omit", "package": "typescript" } }, { "id": 1336, "name": "SupportedStorage", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1783, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1783" } ], "type": { "type": "intersection", "types": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "PromisifyMethods" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Pick" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Storage" }, "name": "Storage", "package": "typescript" }, { "type": "union", "types": [ { "type": "literal", "value": "getItem" }, { "type": "literal", "value": "setItem" }, { "type": "literal", "value": "removeItem" } ] } ], "name": "Pick", "package": "typescript" } ], "name": "PromisifyMethods", "package": "@supabase/auth-js" }, { "type": "reflection", "declaration": { "id": 1337, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1338, "name": "isServer", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If set to " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": " signals to the library that the storage medium is used\non a server and the values may not be authentic, such as reading from\nrequest cookies. Implementations should not set this to true if the client\nis used on a server that reads storage information from authenticated\nsources, such as a secure database or file." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1793, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1793" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [1338] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1785, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1785" } ] } } ] } }, { "id": 1539, "name": "UpdateCustomProviderParams", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Parameters for updating an existing custom provider.\nAll fields are optional. Only provided fields will be updated.\n" }, { "kind": "code", "text": "`provider_type`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`identifier`" }, { "kind": "text", "text": " are immutable and cannot be changed." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2308, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2308" } ], "type": { "type": "reflection", "declaration": { "id": 1540, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1544, "name": "acceptable_client_ids", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Additional client IDs accepted during token validation" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2316, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2316" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 1547, "name": "attribute_mapping", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Mapping of provider attributes to Supabase user attributes" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2322, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2322" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } }, { "id": 1548, "name": "authorization_params", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Additional parameters sent with the authorization request" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2324, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2324" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "name": "Record", "package": "typescript" } }, { "id": 1554, "name": "authorization_url", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "OAuth2 authorization URL" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2336, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2336" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1542, "name": "client_id", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "OAuth client ID" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2312, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2312" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1543, "name": "client_secret", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "OAuth client secret (write-only, not returned in responses)" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2314, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2314" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1552, "name": "discovery_url", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "OIDC discovery URL" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2332, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2332" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1550, "name": "email_optional", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether email is optional for this provider" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2328, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2328" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1549, "name": "enabled", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether the provider is enabled" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2326, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2326" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1551, "name": "issuer", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "OIDC issuer URL" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2330, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2330" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1557, "name": "jwks_uri", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "JWKS URI for token verification" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2342, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2342" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1541, "name": "name", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Human-readable name" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2310, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2310" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1546, "name": "pkce_enabled", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether PKCE is enabled" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2320, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2320" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1545, "name": "scopes", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "OAuth scopes requested during authorization" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2318, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2318" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 1553, "name": "skip_nonce_check", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether to skip nonce check (OIDC)" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2334, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2334" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1555, "name": "token_url", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "OAuth2 token URL" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2338, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2338" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1556, "name": "userinfo_url", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "OAuth2 userinfo URL" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2340, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2340" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [ 1544, 1547, 1548, 1554, 1542, 1543, 1552, 1550, 1549, 1551, 1557, 1541, 1546, 1545, 1553, 1555, 1556 ] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2308, "character": 41, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2308" } ] } } }, { "id": 1437, "name": "UpdateOAuthClientParams", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Parameters for updating an existing OAuth client.\nAll fields are optional. Only provided fields will be updated.\nOnly relevant when the OAuth 2.1 server is enabled in Supabase Auth." } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2075, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2075" } ], "type": { "type": "reflection", "declaration": { "id": 1438, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1439, "name": "client_name", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Human-readable name of the OAuth client" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2077, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2077" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1440, "name": "client_uri", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "URI of the OAuth client" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2079, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2079" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1443, "name": "grant_types", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Array of allowed grant types" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2085, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2085" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 1407, "name": "OAuthClientGrantType", "package": "@supabase/auth-js" } } }, { "id": 1441, "name": "logo_uri", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "URI of the OAuth client's logo" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2081, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2081" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1442, "name": "redirect_uris", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Array of allowed redirect URIs" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2083, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2083" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 1444, "name": "token_endpoint_auth_method", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Token endpoint authentication method" } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2087, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2087" } ], "type": { "type": "reference", "target": 1411, "name": "OAuthClientTokenEndpointAuthMethod", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [1439, 1440, 1443, 1441, 1442, 1444] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 2075, "character": 38, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L2075" } ] } } }, { "id": 844, "name": "UserResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 284, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L284" } ], "type": { "type": "reference", "target": 797, "typeArguments": [ { "type": "reflection", "declaration": { "id": 845, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 846, "name": "user", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 285, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L285" } ], "type": { "type": "reference", "target": 893, "name": "User", "package": "@supabase/auth-js" } } ], "groups": [ { "title": "Properties", "children": [846] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 284, "character": 56, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L284" } ] } } ], "name": "RequestResultSafeDestructure", "package": "@supabase/auth-js" } }, { "id": 1062, "name": "VerifyOtpParams", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 789, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L789" } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 1063, "name": "VerifyMobileOtpParams", "package": "@supabase/auth-js" }, { "type": "reference", "target": 1071, "name": "VerifyEmailOtpParams", "package": "@supabase/auth-js" }, { "type": "reference", "target": 1079, "name": "VerifyTokenHashParams", "package": "@supabase/auth-js" } ] } }, { "id": 779, "name": "WeakPassword", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 182, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L182" } ], "type": { "type": "reflection", "declaration": { "id": 780, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 782, "name": "message", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 184, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L184" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 781, "name": "reasons", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 183, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L183" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 778, "name": "WeakPasswordReasons", "package": "@supabase/auth-js" } } } ], "groups": [ { "title": "Properties", "children": [782, 781] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 182, "character": 27, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L182" } ] } } }, { "id": 778, "name": "WeakPasswordReasons", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 181, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L181" } ], "type": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "number" }, "objectType": { "type": "query", "queryType": { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "WeakPasswordReasons" }, "name": "WeakPasswordReasons", "package": "@supabase/auth-js", "preferValues": true } } } }, { "id": 1061, "name": "Web3Credentials", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 787, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L787" } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 1026, "name": "SolanaWeb3Credentials", "package": "@supabase/auth-js" }, { "type": "reference", "target": 1044, "name": "EthereumWeb3Credentials", "package": "@supabase/auth-js" } ] } }, { "id": 708, "name": "AuthAdminApi", "variant": "declaration", "kind": 32, "flags": { "isConst": true }, "sources": [ { "fileName": "packages/core/auth-js/src/AuthAdminApi.ts", "line": 3, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/AuthAdminApi.ts#L3" } ], "type": { "type": "query", "queryType": { "type": "reference", "target": 1, "name": "default", "package": "@supabase/auth-js" } }, "defaultValue": "GoTrueAdminApi" }, { "id": 709, "name": "AuthClient", "variant": "declaration", "kind": 32, "flags": { "isConst": true }, "sources": [ { "fileName": "packages/core/auth-js/src/AuthClient.ts", "line": 3, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/AuthClient.ts#L3" } ], "type": { "type": "query", "queryType": { "type": "reference", "target": 127, "name": "default", "package": "@supabase/auth-js" } }, "defaultValue": "GoTrueClient" }, { "id": 723, "name": "lockInternals", "variant": "declaration", "kind": 32, "flags": { "isConst": true }, "comment": { "summary": [], "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/locks.ts", "line": 6, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/locks.ts#L6" } ], "type": { "type": "reflection", "declaration": { "id": 724, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 725, "name": "debug", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [], "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/locks.ts", "line": 10, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/locks.ts#L10" } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "..." } ], "groups": [ { "title": "Properties", "children": [725] } ], "sources": [ { "fileName": "packages/core/auth-js/src/lib/locks.ts", "line": 6, "character": 25, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/locks.ts#L6" } ] } }, "defaultValue": "..." }, { "id": 1405, "name": "SIGN_OUT_SCOPES", "variant": "declaration", "kind": 32, "flags": { "isConst": true }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/types.ts", "line": 1978, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/types.ts#L1978" } ], "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "tuple", "elements": [ { "type": "literal", "value": "global" }, { "type": "literal", "value": "local" }, { "type": "literal", "value": "others" } ] } }, "defaultValue": "..." }, { "id": 1648, "name": "isAuthApiError", "variant": "declaration", "kind": 64, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 61, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L61" } ], "signatures": [ { "id": 1649, "name": "isAuthApiError", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 61, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L61" } ], "parameters": [ { "id": 1650, "name": "error", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "predicate", "name": "error", "asserts": false, "targetType": { "type": "reference", "target": 1676, "name": "AuthApiError", "package": "@supabase/auth-js" } } } ] }, { "id": 1645, "name": "isAuthError", "variant": "declaration", "kind": 64, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 36, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L36" } ], "signatures": [ { "id": 1646, "name": "isAuthError", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 36, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L36" } ], "parameters": [ { "id": 1647, "name": "error", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "predicate", "name": "error", "asserts": false, "targetType": { "type": "reference", "target": 1666, "name": "AuthError", "package": "@supabase/auth-js" } } } ] }, { "id": 1654, "name": "isAuthImplicitGrantRedirectError", "variant": "declaration", "kind": 64, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 192, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L192" } ], "signatures": [ { "id": 1655, "name": "isAuthImplicitGrantRedirectError", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 192, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L192" } ], "parameters": [ { "id": 1656, "name": "error", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "predicate", "name": "error", "asserts": false, "targetType": { "type": "reference", "target": 1733, "name": "AuthImplicitGrantRedirectError", "package": "@supabase/auth-js" } } } ] }, { "id": 1657, "name": "isAuthPKCECodeVerifierMissingError", "variant": "declaration", "kind": 64, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 252, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L252" } ], "signatures": [ { "id": 1658, "name": "isAuthPKCECodeVerifierMissingError", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 252, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L252" } ], "parameters": [ { "id": 1659, "name": "error", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "predicate", "name": "error", "asserts": false, "targetType": { "type": "reference", "target": 1787, "name": "AuthPKCECodeVerifierMissingError", "package": "@supabase/auth-js" } } } ] }, { "id": 1660, "name": "isAuthRetryableFetchError", "variant": "declaration", "kind": 64, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 274, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L274" } ], "signatures": [ { "id": 1661, "name": "isAuthRetryableFetchError", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 274, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L274" } ], "parameters": [ { "id": 1662, "name": "error", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "predicate", "name": "error", "asserts": false, "targetType": { "type": "reference", "target": 1795, "name": "AuthRetryableFetchError", "package": "@supabase/auth-js" } } } ] }, { "id": 1651, "name": "isAuthSessionMissingError", "variant": "declaration", "kind": 64, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 126, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L126" } ], "signatures": [ { "id": 1652, "name": "isAuthSessionMissingError", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 126, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L126" } ], "parameters": [ { "id": 1653, "name": "error", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "predicate", "name": "error", "asserts": false, "targetType": { "type": "reference", "target": 1708, "name": "AuthSessionMissingError", "package": "@supabase/auth-js" } } } ] }, { "id": 1663, "name": "isAuthWeakPasswordError", "variant": "declaration", "kind": 64, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 306, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L306" } ], "signatures": [ { "id": 1664, "name": "isAuthWeakPasswordError", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/errors.ts", "line": 306, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/errors.ts#L306" } ], "parameters": [ { "id": 1665, "name": "error", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "predicate", "name": "error", "asserts": false, "targetType": { "type": "reference", "target": 1805, "name": "AuthWeakPasswordError", "package": "@supabase/auth-js" } } } ] }, { "id": 710, "name": "navigatorLock", "variant": "declaration", "kind": 64, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/locks.ts", "line": 96, "character": 22, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/locks.ts#L96" } ], "signatures": [ { "id": 711, "name": "navigatorLock", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Implements a global exclusive lock using the Navigator LockManager API. It\nis available on all browsers released after 2022-03-15 with Safari being the\nlast one to release support. If the API is not available, this function will\nthrow. Make sure you check availablility before configuring " }, { "kind": "inline-tag", "tag": "@link", "text": "GoTrueClient", "target": 127 }, { "kind": "text", "text": ".\n\nYou can turn on debugging by setting the " }, { "kind": "code", "text": "`supabase.gotrue-js.locks.debug`" }, { "kind": "text", "text": "\nlocal storage item to " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ".\n\nInternals:\n\nSince the LockManager API does not preserve stack traces for the async\nfunction passed in the " }, { "kind": "code", "text": "`request`" }, { "kind": "text", "text": " method, a trick is used where acquiring the\nlock releases a previously started promise to run the operation in the " }, { "kind": "code", "text": "`fn`" }, { "kind": "text", "text": "\nfunction. The lock waits for that promise to finish (with or without error),\nwhile the function will finally wait for the result anyway." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nawait navigatorLock('sync-user', 1000, async () => {\n await refreshSession()\n})\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/locks.ts", "line": 96, "character": 22, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/locks.ts#L96" } ], "typeParameters": [ { "id": 712, "name": "R", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 713, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Name of the lock to be acquired." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 714, "name": "acquireTimeout", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has " }, { "kind": "code", "text": "`isAcquireTimeout`" }, { "kind": "text", "text": " set to true." } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 715, "name": "fn", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The operation to run once the lock is acquired." } ] }, "type": { "type": "reflection", "declaration": { "id": 716, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/locks.ts", "line": 99, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/locks.ts#L99" } ], "signatures": [ { "id": 717, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/locks.ts", "line": 99, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/locks.ts#L99" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 712, "name": "R", "package": "@supabase/auth-js", "refersToTypeParameter": true } ], "name": "Promise", "package": "typescript" } } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 712, "name": "R", "package": "@supabase/auth-js", "refersToTypeParameter": true } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 726, "name": "processLock", "variant": "declaration", "kind": 64, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/locks.ts", "line": 323, "character": 22, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/locks.ts#L323" } ], "signatures": [ { "id": 727, "name": "processLock", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Implements a global exclusive lock that works only in the current process.\nUseful for environments like React Native or other non-browser\nsingle-process (i.e. no concept of \"tabs\") environments.\n\nUse " }, { "kind": "inline-tag", "tag": "@link", "text": "#navigatorLock" }, { "kind": "text", "text": " in browser environments." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nawait processLock('migrate', 5000, async () => {\n await runMigration()\n})\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/auth-js/src/lib/locks.ts", "line": 323, "character": 22, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/locks.ts#L323" } ], "typeParameters": [ { "id": 728, "name": "R", "variant": "typeParam", "kind": 131072, "flags": {} } ], "parameters": [ { "id": 729, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Name of the lock to be acquired." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 730, "name": "acquireTimeout", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "If negative, no timeout. If 0 an error is thrown if\n the lock can't be acquired without waiting. If positive, the lock acquire\n will time out after so many milliseconds. An error is\n a timeout if it has " }, { "kind": "code", "text": "`isAcquireTimeout`" }, { "kind": "text", "text": " set to true." } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 731, "name": "fn", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The operation to run once the lock is acquired." } ] }, "type": { "type": "reflection", "declaration": { "id": 732, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/locks.ts", "line": 326, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/locks.ts#L326" } ], "signatures": [ { "id": 733, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/auth-js/src/lib/locks.ts", "line": 326, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/auth-js/src/lib/locks.ts#L326" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 728, "name": "R", "package": "@supabase/auth-js", "refersToTypeParameter": true } ], "name": "Promise", "package": "typescript" } } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 728, "name": "R", "package": "@supabase/auth-js", "refersToTypeParameter": true } ], "name": "Promise", "package": "typescript" } } ] } ], "groups": [ { "title": "Classes", "children": [ 1676, 1666, 1733, 1724, 1817, 1716, 1787, 1760, 1795, 1708, 1686, 1805, 1696, 1, 127, 718 ] }, { "title": "Interfaces", "children": [ 927, 858, 1622, 1135, 1573, 1329, 1458, 1198, 1398, 1378, 847, 941, 893, 885, 920, 861, 890, 1071, 1063, 1079 ] }, { "title": "Type Aliases", "children": [ 856, 736, 735, 1192, 987, 1319, 1316, 1326, 1323, 1183, 1187, 1182, 1184, 1185, 1186, 1361, 1178, 1360, 1362, 1193, 1188, 1179, 1177, 1170, 1612, 1613, 1619, 1620, 814, 805, 809, 819, 823, 1342, 1518, 1428, 1494, 1562, 1561, 1481, 1083, 1043, 1044, 874, 873, 1129, 1119, 1138, 1143, 1139, 1150, 1124, 1113, 746, 1339, 1363, 1558, 737, 1169, 1168, 1166, 1165, 1167, 1151, 1358, 1357, 1359, 1164, 1152, 1163, 1156, 1155, 1157, 1161, 1082, 1593, 1599, 1412, 1407, 1446, 1410, 1445, 1408, 1411, 1409, 1614, 1609, 828, 1482, 1350, 1343, 783, 734, 788, 797, 1368, 1084, 951, 1000, 988, 965, 970, 1098, 1354, 1406, 957, 1010, 1026, 841, 785, 1336, 1539, 1437, 844, 1062, 779, 778, 1061 ] }, { "title": "Variables", "children": [708, 709, 723, 1405] }, { "title": "Functions", "children": [1648, 1645, 1654, 1657, 1660, 1651, 1663, 710, 726] } ], "packageName": "@supabase/auth-js", "readme": [ { "kind": "text", "text": "
\n

\n \n \n \n \n \"Supabase\n \n \n\n

Supabase Auth JS SDK

\n\n

An isomorphic JavaScript SDK for the Supabase Auth API.

\n\n

\n Guides\n ·\n Reference Docs\n ·\n TypeDoc\n

\n

\n\n
\n\n[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[![Package](https://img.shields.io/npm/v/@supabase/auth-js)](https://www.npmjs.com/package/@supabase/auth-js)\n[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license)\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/auth-js)](https://pkg.pr.new/~/supabase/auth-js)\n\n
\n\n## Requirements\n\n- **Node.js 20 or later** (Node.js 18 support dropped as of October 31, 2025)\n- For browser support, all modern browsers are supported\n\n> ⚠️ **Node.js 18 Deprecation Notice**\n>\n> Node.js 18 reached end-of-life on April 30, 2025. As announced in [our deprecation notice](https://github.com/orgs/supabase/discussions/37217), support for Node.js 18 was dropped on October 31, 2025.\n\n## Quick start\n\nInstall\n\n" }, { "kind": "code", "text": "```bash\nnpm install --save @supabase/auth-js\n```" }, { "kind": "text", "text": "\n\nUsage\n\n" }, { "kind": "code", "text": "```js\nimport { AuthClient } from '@supabase/auth-js'\n\nconst GOTRUE_URL = 'http://localhost:9999'\n\nconst auth = new AuthClient({ url: GOTRUE_URL })\n```" }, { "kind": "text", "text": "\n\n- " }, { "kind": "code", "text": "`signUp()`" }, { "kind": "text", "text": ": https://supabase.com/docs/reference/javascript/auth-signup\n- " }, { "kind": "code", "text": "`signIn()`" }, { "kind": "text", "text": ": https://supabase.com/docs/reference/javascript/auth-signin\n- " }, { "kind": "code", "text": "`signOut()`" }, { "kind": "text", "text": ": https://supabase.com/docs/reference/javascript/auth-signout\n\n### Custom " }, { "kind": "code", "text": "`fetch`" }, { "kind": "text", "text": " implementation\n\n" }, { "kind": "code", "text": "`auth-js`" }, { "kind": "text", "text": " uses the [" }, { "kind": "code", "text": "`cross-fetch`" }, { "kind": "text", "text": "](https://www.npmjs.com/package/cross-fetch) library to make HTTP requests, but an alternative " }, { "kind": "code", "text": "`fetch`" }, { "kind": "text", "text": " implementation can be provided as an option. This is most useful in environments where " }, { "kind": "code", "text": "`cross-fetch`" }, { "kind": "text", "text": " is not compatible, for instance Cloudflare Workers:\n\n" }, { "kind": "code", "text": "```js\nimport { AuthClient } from '@supabase/auth-js'\n\nconst AUTH_URL = 'http://localhost:9999'\n\nconst auth = new AuthClient({ url: AUTH_URL, fetch: fetch })\n```" }, { "kind": "text", "text": "\n\n## Development\n\nThis package is part of the [Supabase JavaScript monorepo](https://github.com/supabase/supabase-js). To work on this package:\n\n### Building\n\n" }, { "kind": "code", "text": "```bash\n# Complete build (from monorepo root)\nnpx nx build auth-js\n\n# Build with watch mode for development\nnpx nx build auth-js --watch\n\n# Individual build targets\nnpx nx build:main auth-js # CommonJS build (dist/main/)\nnpx nx build:module auth-js # ES Modules build (dist/module/)\n\n# Other useful commands\nnpx nx lint auth-js # Run ESLint\nnpx nx typecheck auth-js # TypeScript type checking\nnpx nx docs auth-js # Generate documentation\n```" }, { "kind": "text", "text": "\n\n#### Build Outputs\n\n- **CommonJS (" }, { "kind": "code", "text": "`dist/main/`" }, { "kind": "text", "text": ")** - For Node.js environments\n- **ES Modules (" }, { "kind": "code", "text": "`dist/module/`" }, { "kind": "text", "text": ")** - For modern bundlers (Webpack, Vite, Rollup)\n- **TypeScript definitions (" }, { "kind": "code", "text": "`dist/module/index.d.ts`" }, { "kind": "text", "text": ")** - Type definitions for TypeScript projects\n\n### Testing\n\nThe auth-js package has two test suites:\n\n1. **CLI Tests** - Main test suite using Supabase CLI (331 tests)\n2. **Docker Tests** - Edge case tests requiring specific GoTrue configurations (11 tests)\n\n#### Prerequisites\n\n- **Supabase CLI** - Required for main test suite ([installation guide](https://supabase.com/docs/guides/cli))\n- **Docker** - Required for edge case tests\n\n#### Running Tests\n\n" }, { "kind": "code", "text": "```bash\n# Run main test suite with Supabase CLI (recommended)\nnpx nx test:auth auth-js\n\n# Run Docker-only edge case tests\nnpx nx test:docker auth-js\n\n# Run both test suites\nnpx nx test:auth auth-js && npx nx test:docker auth-js\n```" }, { "kind": "text", "text": "\n\n#### Main Test Suite (Supabase CLI)\n\nThe " }, { "kind": "code", "text": "`test:auth`" }, { "kind": "text", "text": " command automatically:\n\n1. Stops any existing Supabase instance\n2. Starts a local Supabase instance via CLI\n3. Runs the test suite (excludes " }, { "kind": "code", "text": "`docker-tests/`" }, { "kind": "text", "text": " folder)\n4. Cleans up after tests complete\n\n" }, { "kind": "code", "text": "```bash\n# Individual commands for manual control\nnpx nx test:infra auth-js # Start Supabase CLI\nnpx nx test:suite auth-js # Run tests only\nnpx nx test:clean-post auth-js # Stop Supabase CLI\n```" }, { "kind": "text", "text": "\n\n#### Docker Tests (Edge Cases)\n\nThe " }, { "kind": "code", "text": "`test:docker`" }, { "kind": "text", "text": " target runs tests that require specific GoTrue configurations not possible with a single Supabase CLI instance:\n\n- **Signup disabled** - Tests for disabled signup functionality\n- **Asymmetric JWT (RS256)** - Tests for RS256 JWT verification\n- **Phone OTP / SMS** - Tests requiring Twilio SMS provider\n- **Anonymous sign-in disabled** - Tests for disabled anonymous auth\n\nThese tests are located in " }, { "kind": "code", "text": "`test/docker-tests/`" }, { "kind": "text", "text": " and use the Docker Compose setup in " }, { "kind": "code", "text": "`infra/docker-compose.yml`" }, { "kind": "text", "text": ".\n\n" }, { "kind": "code", "text": "```bash\n# Individual commands for manual control\nnpx nx test:docker:infra auth-js # Start Docker containers\nnpx nx test:docker:suite auth-js # Run Docker tests only\nnpx nx test:docker:clean-post auth-js # Stop Docker containers\n```" }, { "kind": "text", "text": "\n\n#### Development Testing\n\nFor actively developing and debugging tests:\n\n" }, { "kind": "code", "text": "```bash\n# Start Supabase CLI once\nnpx nx test:infra auth-js\n\n# Run tests multiple times (faster since instance stays up)\nnpx nx test:suite auth-js\n\n# Clean up when done\nnpx nx test:clean-post auth-js\n```" }, { "kind": "text", "text": "\n\n#### Test Infrastructure\n\n| Suite | Infrastructure | Configuration |\n| ------------ | -------------- | --------------------------- |\n| CLI Tests | Supabase CLI | " }, { "kind": "code", "text": "`test/supabase/config.toml`" }, { "kind": "text", "text": " |\n| Docker Tests | Docker Compose | " }, { "kind": "code", "text": "`infra/docker-compose.yml`" }, { "kind": "text", "text": " |\n\n### Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](" }, { "kind": "relative-link", "text": "../../../CONTRIBUTING.md", "target": 2 }, { "kind": "text", "text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes." } ], "symbolIdMap": { "0": { "sourceFileName": "src/index.ts", "qualifiedName": "" }, "1": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "default" }, "2": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "default.__constructor" }, "3": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "default" }, "4": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__0" }, "5": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type" }, "6": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type.url" }, "7": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type.headers" }, "8": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type" }, "9": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type.__index" }, "11": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type.fetch" }, "12": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "13": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "14": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "input" }, "15": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "init" }, "16": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "fetch" }, "17": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "input" }, "18": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "init" }, "19": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "default.mfa" }, "20": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "default.oauth" }, "21": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "default.customProviders" }, "35": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "default.signOut" }, "36": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "default.signOut" }, "37": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "jwt" }, "38": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "scope" }, "39": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type" }, "40": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type.data" }, "41": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type.error" }, "42": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "default.inviteUserByEmail" }, "43": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "default.inviteUserByEmail" }, "44": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "email" }, "45": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "options" }, "46": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type" }, "47": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type.data" }, "48": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type.redirectTo" }, "49": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "default.generateLink" }, "50": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "default.generateLink" }, "51": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "params" }, "52": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "default.createUser" }, "53": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "default.createUser" }, "54": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "attributes" }, "55": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "default.listUsers" }, "56": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "default.listUsers" }, "57": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "params" }, "58": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type" }, "59": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type.data" }, "60": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type" }, "61": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type.users" }, "62": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type.aud" }, "63": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type.error" }, "64": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type" }, "65": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type.data" }, "66": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type" }, "67": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type.users" }, "68": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "__type.error" }, "69": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "default.getUserById" }, "70": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "default.getUserById" }, "71": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "uid" }, "72": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "default.updateUserById" }, "73": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "default.updateUserById" }, "74": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "uid" }, "75": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "attributes" }, "76": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "default.deleteUser" }, "77": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "default.deleteUser" }, "78": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "id" }, "79": { "sourceFileName": "src/GoTrueAdminApi.ts", "qualifiedName": "shouldSoftDelete" }, "127": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default" }, "129": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.__constructor" }, "130": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default" }, "131": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "options" }, "133": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.admin" }, "134": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.mfa" }, "135": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.oauth" }, "201": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.isThrowOnErrorEnabled" }, "202": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.isThrowOnErrorEnabled" }, "214": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.initialize" }, "215": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.initialize" }, "218": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.signInAnonymously" }, "219": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.signInAnonymously" }, "220": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "credentials" }, "221": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.signUp" }, "222": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.signUp" }, "223": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "credentials" }, "224": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.signInWithPassword" }, "225": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.signInWithPassword" }, "226": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "credentials" }, "227": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.signInWithOAuth" }, "228": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.signInWithOAuth" }, "229": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "credentials" }, "230": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.exchangeCodeForSession" }, "231": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.exchangeCodeForSession" }, "232": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "authCode" }, "233": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.signInWithWeb3" }, "234": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.signInWithWeb3" }, "235": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "credentials" }, "236": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "237": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.data" }, "238": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "239": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.session" }, "240": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.user" }, "241": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.error" }, "242": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "243": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.data" }, "244": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "245": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.session" }, "246": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.user" }, "247": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.error" }, "286": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.signInWithIdToken" }, "287": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.signInWithIdToken" }, "288": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "credentials" }, "289": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.signInWithOtp" }, "290": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.signInWithOtp" }, "291": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "credentials" }, "292": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.verifyOtp" }, "293": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.verifyOtp" }, "294": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "params" }, "295": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.signInWithSSO" }, "296": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.signInWithSSO" }, "297": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "params" }, "298": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.reauthenticate" }, "299": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.reauthenticate" }, "302": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.resend" }, "303": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.resend" }, "304": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "credentials" }, "305": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.getSession" }, "306": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.getSession" }, "307": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "308": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.data" }, "309": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "310": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.session" }, "311": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.error" }, "312": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "313": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.data" }, "314": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "315": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.session" }, "316": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.error" }, "317": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "318": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.data" }, "319": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "320": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.session" }, "321": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.error" }, "368": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.getUser" }, "369": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.getUser" }, "370": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "jwt" }, "374": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.updateUser" }, "375": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.updateUser" }, "376": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "attributes" }, "377": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "options" }, "378": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "379": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.emailRedirectTo" }, "386": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.setSession" }, "387": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.setSession" }, "388": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "currentSession" }, "389": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "390": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.access_token" }, "391": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.refresh_token" }, "398": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.refreshSession" }, "399": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.refreshSession" }, "400": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "currentSession" }, "401": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "402": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.refresh_token" }, "439": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.signOut" }, "440": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.signOut" }, "441": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "options" }, "442": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "443": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.error" }, "449": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.onAuthStateChange" }, "450": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.onAuthStateChange" }, "451": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "callback" }, "452": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "453": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "454": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "event" }, "455": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "session" }, "456": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "457": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.data" }, "458": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "459": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.subscription" }, "460": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.onAuthStateChange" }, "461": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "callback" }, "462": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "463": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "464": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "event" }, "465": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "session" }, "466": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "467": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.data" }, "468": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "469": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.subscription" }, "473": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.resetPasswordForEmail" }, "474": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.resetPasswordForEmail" }, "475": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "email" }, "476": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "options" }, "477": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "478": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.redirectTo" }, "479": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.captchaToken" }, "480": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "481": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.data" }, "482": { "sourceFileName": "", "qualifiedName": "__type" }, "483": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.error" }, "484": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "485": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.data" }, "486": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.error" }, "487": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.getUserIdentities" }, "488": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.getUserIdentities" }, "489": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "490": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.data" }, "491": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "492": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.identities" }, "493": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.error" }, "494": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "495": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.data" }, "496": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.error" }, "497": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.linkIdentity" }, "498": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.linkIdentity" }, "499": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "credentials" }, "500": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.linkIdentity" }, "501": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "credentials" }, "508": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.unlinkIdentity" }, "509": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.unlinkIdentity" }, "510": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "identity" }, "511": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "512": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.data" }, "513": { "sourceFileName": "", "qualifiedName": "__type" }, "514": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.error" }, "515": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "516": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.data" }, "517": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.error" }, "563": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.startAutoRefresh" }, "564": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.startAutoRefresh" }, "565": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.stopAutoRefresh" }, "566": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.stopAutoRefresh" }, "685": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.getClaims" }, "686": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "default.getClaims" }, "687": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "jwt" }, "688": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "options" }, "689": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "690": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.keys" }, "691": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.allowExpired" }, "692": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.jwks" }, "693": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "694": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.keys" }, "695": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "696": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.data" }, "697": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "698": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.claims" }, "699": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.header" }, "700": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.signature" }, "701": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.error" }, "702": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "703": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.data" }, "704": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.error" }, "705": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type" }, "706": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.data" }, "707": { "sourceFileName": "src/GoTrueClient.ts", "qualifiedName": "__type.error" }, "708": { "sourceFileName": "src/AuthAdminApi.ts", "qualifiedName": "AuthAdminApi" }, "709": { "sourceFileName": "src/AuthClient.ts", "qualifiedName": "AuthClient" }, "710": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "navigatorLock" }, "711": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "navigatorLock" }, "712": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "R" }, "713": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "name" }, "714": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "acquireTimeout" }, "715": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "fn" }, "716": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "__type" }, "717": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "__type" }, "718": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "NavigatorLockAcquireTimeoutError" }, "719": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "LockAcquireTimeoutError.__constructor" }, "720": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "NavigatorLockAcquireTimeoutError" }, "721": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "message" }, "722": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "LockAcquireTimeoutError.isAcquireTimeout" }, "723": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "internals" }, "724": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "__object" }, "725": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "__object.debug" }, "726": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "processLock" }, "727": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "processLock" }, "728": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "R" }, "729": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "name" }, "730": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "acquireTimeout" }, "731": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "fn" }, "732": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "__type" }, "733": { "sourceFileName": "src/lib/locks.ts", "qualifiedName": "__type" }, "734": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Provider" }, "735": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthChangeEventMFA" }, "736": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthChangeEvent" }, "737": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "LockFunc" }, "738": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "739": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "740": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "name" }, "741": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "acquireTimeout" }, "742": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "fn" }, "743": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "744": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "745": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "R" }, "746": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueClientOptions" }, "747": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "748": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.url" }, "749": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.headers" }, "750": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "751": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.__index" }, "753": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.storageKey" }, "754": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.detectSessionInUrl" }, "755": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "756": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "757": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "url" }, "758": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "759": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "760": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.__index" }, "762": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.autoRefreshToken" }, "763": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.persistSession" }, "764": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.storage" }, "765": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.userStorage" }, "766": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.fetch" }, "767": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.flowType" }, "768": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.debug" }, "769": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "770": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "771": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "message" }, "772": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "args" }, "773": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.lock" }, "774": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.hasCustomAuthorizationHeader" }, "775": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.throwOnError" }, "776": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.lockAcquireTimeout" }, "777": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.skipAutoInitialize" }, "778": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "WeakPasswordReasons" }, "779": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "WeakPassword" }, "780": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "781": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.reasons" }, "782": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.message" }, "783": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Prettify" }, "784": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "T" }, "785": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "StrictOmit" }, "786": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "T" }, "787": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "K" }, "788": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "RequestResult" }, "789": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "790": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.data" }, "791": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.error" }, "792": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "793": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.data" }, "794": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.error" }, "795": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "T" }, "796": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ErrorType" }, "797": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "RequestResultSafeDestructure" }, "798": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "799": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.data" }, "800": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.error" }, "801": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "802": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.data" }, "803": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.error" }, "804": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "T" }, "805": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthResponse" }, "806": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "807": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.user" }, "808": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.session" }, "809": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthResponsePassword" }, "810": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "811": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.user" }, "812": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.session" }, "813": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.weak_password" }, "814": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthOtpResponse" }, "815": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "816": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.user" }, "817": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.session" }, "818": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.messageId" }, "819": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthTokenResponse" }, "820": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "821": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.user" }, "822": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.session" }, "823": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthTokenResponsePassword" }, "824": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "825": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.user" }, "826": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.session" }, "827": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.weakPassword" }, "828": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "OAuthResponse" }, "829": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "830": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.data" }, "831": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "832": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.provider" }, "833": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.url" }, "834": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.error" }, "835": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "836": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.data" }, "837": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "838": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.provider" }, "839": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.url" }, "840": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.error" }, "841": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SSOResponse" }, "842": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "843": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.url" }, "844": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserResponse" }, "845": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "846": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.user" }, "847": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Session" }, "848": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Session.provider_token" }, "849": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Session.provider_refresh_token" }, "850": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Session.access_token" }, "851": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Session.refresh_token" }, "852": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Session.expires_in" }, "853": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Session.expires_at" }, "854": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Session.token_type" }, "855": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Session.user" }, "856": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AMRMethod" }, "857": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "858": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AMREntry" }, "859": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AMREntry.method" }, "860": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AMREntry.timestamp" }, "861": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserIdentity" }, "862": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserIdentity.id" }, "863": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserIdentity.user_id" }, "864": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserIdentity.identity_data" }, "865": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "866": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.__index" }, "868": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserIdentity.identity_id" }, "869": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserIdentity.provider" }, "870": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserIdentity.created_at" }, "871": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserIdentity.last_sign_in_at" }, "872": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserIdentity.updated_at" }, "873": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FactorType" }, "874": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Factor" }, "875": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "876": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.id" }, "877": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.friendly_name" }, "878": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.factor_type" }, "879": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.status" }, "880": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.created_at" }, "881": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.updated_at" }, "882": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.last_challenged_at" }, "883": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Type" }, "884": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Status" }, "885": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserAppMetadata" }, "886": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserAppMetadata.provider" }, "887": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserAppMetadata.providers" }, "888": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserAppMetadata.__index" }, "890": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserMetadata" }, "891": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserMetadata.__index" }, "893": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User" }, "894": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.id" }, "895": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.app_metadata" }, "896": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.user_metadata" }, "897": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.aud" }, "898": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.confirmation_sent_at" }, "899": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.recovery_sent_at" }, "900": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.email_change_sent_at" }, "901": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.new_email" }, "902": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.new_phone" }, "903": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.invited_at" }, "904": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.action_link" }, "905": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.email" }, "906": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.phone" }, "907": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.created_at" }, "908": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.confirmed_at" }, "909": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.email_confirmed_at" }, "910": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.phone_confirmed_at" }, "911": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.last_sign_in_at" }, "912": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.role" }, "913": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.updated_at" }, "914": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.identities" }, "915": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.is_anonymous" }, "916": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.is_sso_user" }, "917": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.factors" }, "918": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.deleted_at" }, "919": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "User.banned_until" }, "920": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserAttributes" }, "921": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserAttributes.current_password" }, "922": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserAttributes.email" }, "923": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserAttributes.phone" }, "924": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserAttributes.password" }, "925": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserAttributes.nonce" }, "926": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UserAttributes.data" }, "927": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AdminUserAttributes" }, "928": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AdminUserAttributes.user_metadata" }, "929": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AdminUserAttributes.app_metadata" }, "930": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AdminUserAttributes.email_confirm" }, "931": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AdminUserAttributes.phone_confirm" }, "932": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AdminUserAttributes.ban_duration" }, "933": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AdminUserAttributes.role" }, "934": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AdminUserAttributes.password_hash" }, "935": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AdminUserAttributes.id" }, "936": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "nonce" }, "937": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "phone" }, "938": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "email" }, "939": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "password" }, "940": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "current_password" }, "941": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Subscription" }, "942": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Subscription.id" }, "943": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Subscription.callback" }, "944": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "945": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "946": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "event" }, "947": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "session" }, "948": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Subscription.unsubscribe" }, "949": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "950": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "951": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SignInAnonymouslyCredentials" }, "952": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "953": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.options" }, "954": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "955": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.data" }, "956": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.captchaToken" }, "957": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SignUpWithPasswordCredentials" }, "958": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "959": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.options" }, "960": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "961": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.emailRedirectTo" }, "962": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.data" }, "963": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.captchaToken" }, "964": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.channel" }, "965": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SignInWithPasswordCredentials" }, "966": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "967": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.options" }, "968": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "969": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.captchaToken" }, "970": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SignInWithPasswordlessCredentials" }, "971": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "972": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.email" }, "973": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.options" }, "974": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "975": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.emailRedirectTo" }, "976": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.shouldCreateUser" }, "977": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.data" }, "978": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.captchaToken" }, "979": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "980": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.phone" }, "981": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.options" }, "982": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "983": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.shouldCreateUser" }, "984": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.data" }, "985": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.captchaToken" }, "986": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.channel" }, "987": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthFlowType" }, "988": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SignInWithOAuthCredentials" }, "989": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "990": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.provider" }, "991": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.options" }, "992": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "993": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.redirectTo" }, "994": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.scopes" }, "995": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.queryParams" }, "996": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "997": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.__index" }, "999": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.skipBrowserRedirect" }, "1000": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SignInWithIdTokenCredentials" }, "1001": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1002": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.provider" }, "1003": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1004": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.token" }, "1005": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.access_token" }, "1006": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.nonce" }, "1007": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.options" }, "1008": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1009": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.captchaToken" }, "1010": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SolanaWallet" }, "1011": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1012": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.signIn" }, "1013": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1014": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1015": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "inputs" }, "1016": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.publicKey" }, "1017": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1018": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.toBase58" }, "1019": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1020": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1021": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.signMessage" }, "1022": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1023": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1024": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "message" }, "1025": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "encoding" }, "1026": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SolanaWeb3Credentials" }, "1027": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1028": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.chain" }, "1029": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.wallet" }, "1030": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.statement" }, "1031": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.options" }, "1032": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1033": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.url" }, "1034": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.captchaToken" }, "1035": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.signInWithSolana" }, "1036": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1037": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.chain" }, "1038": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.message" }, "1039": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.signature" }, "1040": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.options" }, "1041": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1042": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.captchaToken" }, "1043": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "EthereumWallet" }, "1044": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "EthereumWeb3Credentials" }, "1045": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1046": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.chain" }, "1047": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.wallet" }, "1048": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.statement" }, "1049": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.options" }, "1050": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1051": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.url" }, "1052": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.captchaToken" }, "1053": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.signInWithEthereum" }, "1054": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1055": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.chain" }, "1056": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.message" }, "1057": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.signature" }, "1058": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.options" }, "1059": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1060": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.captchaToken" }, "1061": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Web3Credentials" }, "1062": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VerifyOtpParams" }, "1063": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VerifyMobileOtpParams" }, "1064": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VerifyMobileOtpParams.phone" }, "1065": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VerifyMobileOtpParams.token" }, "1066": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VerifyMobileOtpParams.type" }, "1067": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VerifyMobileOtpParams.options" }, "1068": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1069": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.redirectTo" }, "1070": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.captchaToken" }, "1071": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VerifyEmailOtpParams" }, "1072": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VerifyEmailOtpParams.email" }, "1073": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VerifyEmailOtpParams.token" }, "1074": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VerifyEmailOtpParams.type" }, "1075": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VerifyEmailOtpParams.options" }, "1076": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1077": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.redirectTo" }, "1078": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.captchaToken" }, "1079": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VerifyTokenHashParams" }, "1080": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VerifyTokenHashParams.token_hash" }, "1081": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VerifyTokenHashParams.type" }, "1082": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MobileOtpType" }, "1083": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "EmailOtpType" }, "1084": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ResendParams" }, "1085": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1086": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.type" }, "1087": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.email" }, "1088": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.options" }, "1089": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1090": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.emailRedirectTo" }, "1091": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.captchaToken" }, "1092": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1093": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.type" }, "1094": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.phone" }, "1095": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.options" }, "1096": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1097": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.captchaToken" }, "1098": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SignInWithSSO" }, "1099": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1100": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.providerId" }, "1101": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.options" }, "1102": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1103": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.redirectTo" }, "1104": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.captchaToken" }, "1105": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.skipBrowserRedirect" }, "1106": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1107": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.domain" }, "1108": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.options" }, "1109": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1110": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.redirectTo" }, "1111": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.captchaToken" }, "1112": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.skipBrowserRedirect" }, "1113": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GenerateSignupLinkParams" }, "1114": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1115": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.type" }, "1116": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.email" }, "1117": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.password" }, "1118": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.options" }, "1119": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GenerateInviteOrMagiclinkParams" }, "1120": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1121": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.type" }, "1122": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.email" }, "1123": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.options" }, "1124": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GenerateRecoveryLinkParams" }, "1125": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1126": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.type" }, "1127": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.email" }, "1128": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.options" }, "1129": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GenerateEmailChangeLinkParams" }, "1130": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1131": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.type" }, "1132": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.email" }, "1133": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.newEmail" }, "1134": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.options" }, "1135": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GenerateLinkOptions" }, "1136": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GenerateLinkOptions.data" }, "1137": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GenerateLinkOptions.redirectTo" }, "1138": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GenerateLinkParams" }, "1139": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GenerateLinkResponse" }, "1140": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1141": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.properties" }, "1142": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.user" }, "1143": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GenerateLinkProperties" }, "1144": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1145": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.action_link" }, "1146": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.email_otp" }, "1147": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.hashed_token" }, "1148": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.redirect_to" }, "1149": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.verification_type" }, "1150": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GenerateLinkType" }, "1151": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAEnrollParams" }, "1152": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAUnenrollParams" }, "1153": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1154": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.factorId" }, "1155": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAVerifyTOTPParams" }, "1156": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAVerifyPhoneParams" }, "1157": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAVerifyWebauthnParamFields" }, "1158": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1159": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.webauthn" }, "1160": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "T" }, "1161": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAVerifyWebauthnParams" }, "1162": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "T" }, "1163": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAVerifyParams" }, "1164": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFATOTPChannel" }, "1165": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAChallengeTOTPParams" }, "1166": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAChallengePhoneParams" }, "1167": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAChallengeWebauthnParams" }, "1168": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAChallengeParams" }, "1169": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAChallengeAndVerifyParams" }, "1170": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAVerifyResponseData" }, "1171": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1172": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.access_token" }, "1173": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.token_type" }, "1174": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.expires_in" }, "1175": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.refresh_token" }, "1176": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.user" }, "1177": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAVerifyResponse" }, "1178": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAEnrollResponse" }, "1179": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAUnenrollResponse" }, "1180": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1181": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.id" }, "1182": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAChallengeTOTPResponse" }, "1183": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAChallengePhoneResponse" }, "1184": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAChallengeWebauthnResponse" }, "1185": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAChallengeWebauthnResponseDataJSON" }, "1186": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAChallengeWebauthnServerResponse" }, "1187": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAChallengeResponse" }, "1188": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAListFactorsResponse" }, "1189": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1190": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.all" }, "1191": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "T" }, "1192": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthenticatorAssuranceLevels" }, "1193": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAGetAuthenticatorAssuranceLevelResponse" }, "1194": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1195": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.currentLevel" }, "1196": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.nextLevel" }, "1197": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.currentAuthenticationMethods" }, "1198": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi" }, "1199": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.enroll" }, "1200": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.enroll" }, "1201": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "1202": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1203": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "factorType" }, "1204": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "friendlyName" }, "1205": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "issuer" }, "1206": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.enroll" }, "1207": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "1208": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1209": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "factorType" }, "1210": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "friendlyName" }, "1211": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "phone" }, "1212": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.enroll" }, "1213": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "1214": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1215": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "factorType" }, "1216": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "friendlyName" }, "1217": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.enroll" }, "1218": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "1219": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.challenge" }, "1220": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.challenge" }, "1221": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "1222": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1223": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "factorId" }, "1224": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1225": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "data" }, "1226": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "error" }, "1227": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1228": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "data" }, "1229": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1230": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "id" }, "1231": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "type" }, "1232": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "expires_at" }, "1233": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "error" }, "1234": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.challenge" }, "1235": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "1236": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1237": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "factorId" }, "1238": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "channel" }, "1239": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1240": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "data" }, "1241": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "error" }, "1242": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1243": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "data" }, "1244": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1245": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "id" }, "1246": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "type" }, "1247": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "expires_at" }, "1248": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "error" }, "1249": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.challenge" }, "1250": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "1251": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1252": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "factorId" }, "1253": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "webauthn" }, "1254": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1255": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.rpId" }, "1256": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.rpOrigins" }, "1257": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1258": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "data" }, "1259": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "error" }, "1260": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1261": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "data" }, "1262": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1263": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "id" }, "1264": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "type" }, "1265": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "expires_at" }, "1266": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "webauthn" }, "1267": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1268": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.type" }, "1269": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.credential_options" }, "1270": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1271": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.publicKey" }, "1272": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1273": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.type" }, "1274": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.credential_options" }, "1275": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1276": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.publicKey" }, "1277": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "error" }, "1278": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.challenge" }, "1279": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "1280": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.verify" }, "1281": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.verify" }, "1282": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "1283": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1284": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "factorId" }, "1285": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "challengeId" }, "1286": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "code" }, "1287": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.verify" }, "1288": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "1289": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1290": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "factorId" }, "1291": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "challengeId" }, "1292": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "code" }, "1293": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.verify" }, "1294": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "1295": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1296": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "factorId" }, "1297": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "challengeId" }, "1298": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "webauthn" }, "1299": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.verify" }, "1300": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "1301": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.unenroll" }, "1302": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.unenroll" }, "1303": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "1304": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.challengeAndVerify" }, "1305": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.challengeAndVerify" }, "1306": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "1307": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1308": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "factorId" }, "1309": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "code" }, "1310": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.listFactors" }, "1311": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.listFactors" }, "1312": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.getAuthenticatorAssuranceLevel" }, "1313": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.getAuthenticatorAssuranceLevel" }, "1314": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "jwt" }, "1315": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueMFAApi.webauthn" }, "1316": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAAdminDeleteFactorResponse" }, "1317": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1318": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.id" }, "1319": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAAdminDeleteFactorParams" }, "1320": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1321": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.id" }, "1322": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.userId" }, "1323": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAAdminListFactorsResponse" }, "1324": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1325": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.factors" }, "1326": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAAdminListFactorsParams" }, "1327": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1328": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.userId" }, "1329": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminMFAApi" }, "1330": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminMFAApi.listFactors" }, "1331": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminMFAApi.listFactors" }, "1332": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "1333": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminMFAApi.deleteFactor" }, "1334": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminMFAApi.deleteFactor" }, "1335": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "1336": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SupportedStorage" }, "1337": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1338": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.isServer" }, "1339": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "InitializeResult" }, "1340": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1341": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.error" }, "1342": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "CallRefreshTokenResult" }, "1343": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Pagination" }, "1344": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1345": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.nextPage" }, "1346": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.lastPage" }, "1347": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.total" }, "1348": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.__index" }, "1350": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "PageParams" }, "1351": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1352": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.page" }, "1353": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.perPage" }, "1354": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SignOut" }, "1355": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1356": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.scope" }, "1357": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAEnrollTOTPParams" }, "1358": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAEnrollPhoneParams" }, "1359": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MFAEnrollWebauthnParams" }, "1360": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAEnrollTOTPResponse" }, "1361": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAEnrollPhoneResponse" }, "1362": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthMFAEnrollWebauthnResponse" }, "1363": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "JwtHeader" }, "1364": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1365": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.alg" }, "1366": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.kid" }, "1367": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.typ" }, "1368": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "RequiredClaims" }, "1369": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1370": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.iss" }, "1371": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.sub" }, "1372": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.aud" }, "1373": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.exp" }, "1374": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.iat" }, "1375": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.role" }, "1376": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.aal" }, "1377": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.session_id" }, "1378": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "JwtPayload" }, "1379": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "JwtPayload.email" }, "1380": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "JwtPayload.phone" }, "1381": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "JwtPayload.is_anonymous" }, "1382": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "JwtPayload.jti" }, "1383": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "JwtPayload.nbf" }, "1384": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "JwtPayload.app_metadata" }, "1385": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "JwtPayload.user_metadata" }, "1386": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "JwtPayload.amr" }, "1387": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "JwtPayload.ref" }, "1388": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.iss" }, "1389": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.sub" }, "1390": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.aud" }, "1391": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.exp" }, "1392": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.iat" }, "1393": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.role" }, "1394": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.aal" }, "1395": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.session_id" }, "1396": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "JwtPayload.__index" }, "1398": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "JWK" }, "1399": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "JWK.kty" }, "1400": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "JWK.key_ops" }, "1401": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "JWK.alg" }, "1402": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "JWK.kid" }, "1403": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "JWK.__index" }, "1405": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SIGN_OUT_SCOPES" }, "1406": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SignOutScope" }, "1407": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "OAuthClientGrantType" }, "1408": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "OAuthClientResponseType" }, "1409": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "OAuthClientType" }, "1410": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "OAuthClientRegistrationType" }, "1411": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "OAuthClientTokenEndpointAuthMethod" }, "1412": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "OAuthClient" }, "1413": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1414": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.client_id" }, "1415": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.client_name" }, "1416": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.client_secret" }, "1417": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.client_type" }, "1418": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.token_endpoint_auth_method" }, "1419": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.registration_type" }, "1420": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.client_uri" }, "1421": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.logo_uri" }, "1422": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.redirect_uris" }, "1423": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.grant_types" }, "1424": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.response_types" }, "1425": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.scope" }, "1426": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.created_at" }, "1427": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.updated_at" }, "1428": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "CreateOAuthClientParams" }, "1429": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1430": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.client_name" }, "1431": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.client_uri" }, "1432": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.redirect_uris" }, "1433": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.grant_types" }, "1434": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.response_types" }, "1435": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.scope" }, "1436": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.token_endpoint_auth_method" }, "1437": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UpdateOAuthClientParams" }, "1438": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1439": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.client_name" }, "1440": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.client_uri" }, "1441": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.logo_uri" }, "1442": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.redirect_uris" }, "1443": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.grant_types" }, "1444": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.token_endpoint_auth_method" }, "1445": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "OAuthClientResponse" }, "1446": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "OAuthClientListResponse" }, "1447": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1448": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.data" }, "1449": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1450": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.clients" }, "1451": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.aud" }, "1452": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.error" }, "1453": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1454": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.data" }, "1455": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1456": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.clients" }, "1457": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.error" }, "1458": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminOAuthApi" }, "1459": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminOAuthApi.listClients" }, "1460": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminOAuthApi.listClients" }, "1461": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "1462": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminOAuthApi.createClient" }, "1463": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminOAuthApi.createClient" }, "1464": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "1465": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminOAuthApi.getClient" }, "1466": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminOAuthApi.getClient" }, "1467": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "clientId" }, "1468": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminOAuthApi.updateClient" }, "1469": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminOAuthApi.updateClient" }, "1470": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "clientId" }, "1471": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "1472": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminOAuthApi.deleteClient" }, "1473": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminOAuthApi.deleteClient" }, "1474": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "clientId" }, "1475": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1476": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.data" }, "1477": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.error" }, "1478": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminOAuthApi.regenerateClientSecret" }, "1479": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminOAuthApi.regenerateClientSecret" }, "1480": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "clientId" }, "1481": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "CustomProviderType" }, "1482": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "OIDCDiscoveryDocument" }, "1483": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1484": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.issuer" }, "1485": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.authorization_endpoint" }, "1486": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.token_endpoint" }, "1487": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.jwks_uri" }, "1488": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.userinfo_endpoint" }, "1489": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.revocation_endpoint" }, "1490": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.supported_scopes" }, "1491": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.supported_response_types" }, "1492": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.supported_subject_types" }, "1493": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.supported_id_token_signing_algs" }, "1494": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "CustomOAuthProvider" }, "1495": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1496": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.id" }, "1497": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.provider_type" }, "1498": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.identifier" }, "1499": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.name" }, "1500": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.client_id" }, "1501": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.acceptable_client_ids" }, "1502": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.scopes" }, "1503": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.pkce_enabled" }, "1504": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.attribute_mapping" }, "1505": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.authorization_params" }, "1506": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.enabled" }, "1507": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.email_optional" }, "1508": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.issuer" }, "1509": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.discovery_url" }, "1510": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.skip_nonce_check" }, "1511": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.authorization_url" }, "1512": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.token_url" }, "1513": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.userinfo_url" }, "1514": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.jwks_uri" }, "1515": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.discovery_document" }, "1516": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.created_at" }, "1517": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.updated_at" }, "1518": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "CreateCustomProviderParams" }, "1519": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1520": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.provider_type" }, "1521": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.identifier" }, "1522": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.name" }, "1523": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.client_id" }, "1524": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.client_secret" }, "1525": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.acceptable_client_ids" }, "1526": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.scopes" }, "1527": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.pkce_enabled" }, "1528": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.attribute_mapping" }, "1529": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.authorization_params" }, "1530": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.enabled" }, "1531": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.email_optional" }, "1532": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.issuer" }, "1533": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.discovery_url" }, "1534": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.skip_nonce_check" }, "1535": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.authorization_url" }, "1536": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.token_url" }, "1537": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.userinfo_url" }, "1538": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.jwks_uri" }, "1539": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "UpdateCustomProviderParams" }, "1540": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1541": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.name" }, "1542": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.client_id" }, "1543": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.client_secret" }, "1544": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.acceptable_client_ids" }, "1545": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.scopes" }, "1546": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.pkce_enabled" }, "1547": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.attribute_mapping" }, "1548": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.authorization_params" }, "1549": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.enabled" }, "1550": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.email_optional" }, "1551": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.issuer" }, "1552": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.discovery_url" }, "1553": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.skip_nonce_check" }, "1554": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.authorization_url" }, "1555": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.token_url" }, "1556": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.userinfo_url" }, "1557": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.jwks_uri" }, "1558": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListCustomProvidersParams" }, "1559": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1560": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.type" }, "1561": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "CustomProviderResponse" }, "1562": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "CustomProviderListResponse" }, "1563": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1564": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.data" }, "1565": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1566": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.providers" }, "1567": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.error" }, "1568": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1569": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.data" }, "1570": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1571": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.providers" }, "1572": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.error" }, "1573": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminCustomProvidersApi" }, "1574": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminCustomProvidersApi.listProviders" }, "1575": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminCustomProvidersApi.listProviders" }, "1576": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "1577": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminCustomProvidersApi.createProvider" }, "1578": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminCustomProvidersApi.createProvider" }, "1579": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "1580": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminCustomProvidersApi.getProvider" }, "1581": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminCustomProvidersApi.getProvider" }, "1582": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "identifier" }, "1583": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminCustomProvidersApi.updateProvider" }, "1584": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminCustomProvidersApi.updateProvider" }, "1585": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "identifier" }, "1586": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "params" }, "1587": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminCustomProvidersApi.deleteProvider" }, "1588": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GoTrueAdminCustomProvidersApi.deleteProvider" }, "1589": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "identifier" }, "1590": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1591": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.data" }, "1592": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.error" }, "1593": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "OAuthAuthorizationClient" }, "1594": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1595": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.id" }, "1596": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.name" }, "1597": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.uri" }, "1598": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.logo_uri" }, "1599": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "OAuthAuthorizationDetails" }, "1600": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1601": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.authorization_id" }, "1602": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.redirect_uri" }, "1603": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.client" }, "1604": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.user" }, "1605": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1606": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.id" }, "1607": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.email" }, "1608": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.scope" }, "1609": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "OAuthRedirect" }, "1610": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1611": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.redirect_url" }, "1612": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthOAuthAuthorizationDetailsResponse" }, "1613": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthOAuthConsentResponse" }, "1614": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "OAuthGrant" }, "1615": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1616": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.client" }, "1617": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.scopes" }, "1618": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.granted_at" }, "1619": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthOAuthGrantsResponse" }, "1620": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthOAuthRevokeGrantResponse" }, "1621": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1622": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthOAuthServerApi" }, "1623": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthOAuthServerApi.getAuthorizationDetails" }, "1624": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthOAuthServerApi.getAuthorizationDetails" }, "1625": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "authorizationId" }, "1626": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthOAuthServerApi.approveAuthorization" }, "1627": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthOAuthServerApi.approveAuthorization" }, "1628": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "authorizationId" }, "1629": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "options" }, "1630": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1631": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.skipBrowserRedirect" }, "1632": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthOAuthServerApi.denyAuthorization" }, "1633": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthOAuthServerApi.denyAuthorization" }, "1634": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "authorizationId" }, "1635": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "options" }, "1636": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1637": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.skipBrowserRedirect" }, "1638": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthOAuthServerApi.listGrants" }, "1639": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthOAuthServerApi.listGrants" }, "1640": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthOAuthServerApi.revokeGrant" }, "1641": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AuthOAuthServerApi.revokeGrant" }, "1642": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "options" }, "1643": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1644": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.clientId" }, "1645": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "isAuthError" }, "1646": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "isAuthError" }, "1647": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "error" }, "1648": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "isAuthApiError" }, "1649": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "isAuthApiError" }, "1650": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "error" }, "1651": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "isAuthSessionMissingError" }, "1652": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "isAuthSessionMissingError" }, "1653": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "error" }, "1654": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "isAuthImplicitGrantRedirectError" }, "1655": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "isAuthImplicitGrantRedirectError" }, "1656": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "error" }, "1657": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "isAuthPKCECodeVerifierMissingError" }, "1658": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "isAuthPKCECodeVerifierMissingError" }, "1659": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "error" }, "1660": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "isAuthRetryableFetchError" }, "1661": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "isAuthRetryableFetchError" }, "1662": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "error" }, "1663": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "isAuthWeakPasswordError" }, "1664": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "isAuthWeakPasswordError" }, "1665": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "error" }, "1666": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthError" }, "1667": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthError.__constructor" }, "1668": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthError" }, "1669": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "message" }, "1670": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "status" }, "1671": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "code" }, "1672": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthError.code" }, "1673": { "sourceFileName": "", "qualifiedName": "__type" }, "1674": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthError.status" }, "1676": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthApiError" }, "1677": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthApiError.__constructor" }, "1678": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthApiError" }, "1679": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "message" }, "1680": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "status" }, "1681": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "code" }, "1682": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthApiError.status" }, "1683": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthError.code" }, "1684": { "sourceFileName": "", "qualifiedName": "__type" }, "1686": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthUnknownError" }, "1687": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthUnknownError.__constructor" }, "1688": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthUnknownError" }, "1689": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "message" }, "1690": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "originalError" }, "1691": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthUnknownError.originalError" }, "1692": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthError.code" }, "1693": { "sourceFileName": "", "qualifiedName": "__type" }, "1694": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthError.status" }, "1696": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError" }, "1697": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError.__constructor" }, "1698": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError" }, "1699": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "message" }, "1700": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "name" }, "1701": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "status" }, "1702": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "code" }, "1703": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError.name" }, "1704": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError.status" }, "1705": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthError.code" }, "1706": { "sourceFileName": "", "qualifiedName": "__type" }, "1708": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthSessionMissingError" }, "1709": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthSessionMissingError.__constructor" }, "1710": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthSessionMissingError" }, "1711": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError.name" }, "1712": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError.status" }, "1713": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthError.code" }, "1714": { "sourceFileName": "", "qualifiedName": "__type" }, "1716": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthInvalidTokenResponseError" }, "1717": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthInvalidTokenResponseError.__constructor" }, "1718": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthInvalidTokenResponseError" }, "1719": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError.name" }, "1720": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError.status" }, "1721": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthError.code" }, "1722": { "sourceFileName": "", "qualifiedName": "__type" }, "1724": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthInvalidCredentialsError" }, "1725": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthInvalidCredentialsError.__constructor" }, "1726": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthInvalidCredentialsError" }, "1727": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "message" }, "1728": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError.name" }, "1729": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError.status" }, "1730": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthError.code" }, "1731": { "sourceFileName": "", "qualifiedName": "__type" }, "1733": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthImplicitGrantRedirectError" }, "1734": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthImplicitGrantRedirectError.__constructor" }, "1735": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthImplicitGrantRedirectError" }, "1736": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "message" }, "1737": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "details" }, "1738": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__type" }, "1739": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__type.error" }, "1740": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__type.code" }, "1741": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthImplicitGrantRedirectError.details" }, "1742": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__type" }, "1743": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__type.error" }, "1744": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__type.code" }, "1745": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthImplicitGrantRedirectError.toJSON" }, "1746": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthImplicitGrantRedirectError.toJSON" }, "1747": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__object" }, "1748": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__object.name" }, "1749": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__object.message" }, "1750": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__object.status" }, "1751": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__object.details" }, "1752": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__type" }, "1753": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__type.error" }, "1754": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__type.code" }, "1755": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError.name" }, "1756": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError.status" }, "1757": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthError.code" }, "1758": { "sourceFileName": "", "qualifiedName": "__type" }, "1760": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthPKCEGrantCodeExchangeError" }, "1761": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthPKCEGrantCodeExchangeError.__constructor" }, "1762": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthPKCEGrantCodeExchangeError" }, "1763": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "message" }, "1764": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "details" }, "1765": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__type" }, "1766": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__type.error" }, "1767": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__type.code" }, "1768": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthPKCEGrantCodeExchangeError.details" }, "1769": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__type" }, "1770": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__type.error" }, "1771": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__type.code" }, "1772": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthPKCEGrantCodeExchangeError.toJSON" }, "1773": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthPKCEGrantCodeExchangeError.toJSON" }, "1774": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__object" }, "1775": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__object.name" }, "1776": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__object.message" }, "1777": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__object.status" }, "1778": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__object.details" }, "1779": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__type" }, "1780": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__type.error" }, "1781": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "__type.code" }, "1782": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError.name" }, "1783": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError.status" }, "1784": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthError.code" }, "1785": { "sourceFileName": "", "qualifiedName": "__type" }, "1787": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthPKCECodeVerifierMissingError" }, "1788": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthPKCECodeVerifierMissingError.__constructor" }, "1789": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthPKCECodeVerifierMissingError" }, "1790": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError.name" }, "1791": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError.status" }, "1792": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthError.code" }, "1793": { "sourceFileName": "", "qualifiedName": "__type" }, "1795": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthRetryableFetchError" }, "1796": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthRetryableFetchError.__constructor" }, "1797": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthRetryableFetchError" }, "1798": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "message" }, "1799": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "status" }, "1800": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError.name" }, "1801": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError.status" }, "1802": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthError.code" }, "1803": { "sourceFileName": "", "qualifiedName": "__type" }, "1805": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthWeakPasswordError" }, "1806": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthWeakPasswordError.__constructor" }, "1807": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthWeakPasswordError" }, "1808": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "message" }, "1809": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "status" }, "1810": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "reasons" }, "1811": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthWeakPasswordError.reasons" }, "1812": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError.name" }, "1813": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError.status" }, "1814": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthError.code" }, "1815": { "sourceFileName": "", "qualifiedName": "__type" }, "1817": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthInvalidJwtError" }, "1818": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthInvalidJwtError.__constructor" }, "1819": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthInvalidJwtError" }, "1820": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "message" }, "1821": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError.name" }, "1822": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "CustomAuthError.status" }, "1823": { "sourceFileName": "src/lib/errors.ts", "qualifiedName": "AuthError.code" }, "1824": { "sourceFileName": "", "qualifiedName": "__type" } }, "files": { "entries": { "1": "src/index.ts", "2": "../../../CONTRIBUTING.md" }, "reflections": { "1": 0 } } }